annotate lib/openat-proc.c @ 17160:72f4bab621be

fts: introduce FTS_VERBATIM This gives clients the option to disable stripping of trailing slashes from input path names during fts_open initialization. The recent change v0.0-7611-g3a9002d that made fts_open strip trailing slashes from input path names had a negative impact on findutils that relies on the old fts_open behavior to implement POSIX requirement that each path operand of the find utility shall be evaluated unaltered as it was provided, including all trailing slash characters. * lib/fts_.h (FTS_VERBATIM): New bit flag. (FTS_OPTIONMASK, FTS_NAMEONLY, FTS_STOP): Adjust. * lib/fts.c (fts_open): Honor it.
author Dmitry V. Levin <ldv@altlinux.org>
date Sun, 18 Nov 2012 04:40:18 +0400
parents 8250f2777afc
children e542fd46ad6f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
1 /* Create /proc/self/fd-related names for subfiles of open directories.
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
2
16201
8250f2777afc maint: update all copyright year number ranges
Jim Meyering <meyering@redhat.com>
parents: 14722
diff changeset
3 Copyright (C) 2006, 2009-2012 Free Software Foundation, Inc.
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
4
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7863
diff changeset
5 This program is free software: you can redistribute it and/or modify
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7863
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7863
diff changeset
8 (at your option) any later version.
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
9
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
13 GNU General Public License for more details.
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
14
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7863
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
17
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
18 /* Written by Paul Eggert. */
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
19
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
20 #include <config.h>
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
21
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
22 #include "openat-priv.h"
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
23
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
24 #include <sys/types.h>
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
25 #include <sys/stat.h>
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
26 #include <fcntl.h>
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
27
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
28 #include <stdio.h>
14167
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
29 #include <stdlib.h>
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
30 #include <string.h>
12501
747078ee6551 openat: Fix warning.
Bruno Haible <bruno@clisp.org>
parents: 12421
diff changeset
31 #include <unistd.h>
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
33 #include "intprops.h"
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
34
7863
cb2590895141 New module 'fchdir'.
Bruno Haible <bruno@clisp.org>
parents: 7389
diff changeset
35 /* The results of open() in this file are not used with fchdir,
11938
7cbcde229d97 backupfile, chdir-long, fts, savedir: make safer
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
36 and we do not leak fds to any single-threaded code that could use stdio,
7cbcde229d97 backupfile, chdir-long, fts, savedir: make safer
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
37 therefore save some unnecessary work in fchdir.c.
7cbcde229d97 backupfile, chdir-long, fts, savedir: make safer
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
38 FIXME - if the kernel ever adds support for multi-thread safety for
7cbcde229d97 backupfile, chdir-long, fts, savedir: make safer
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
39 avoiding standard fds, then we should use open_safer. */
7863
cb2590895141 New module 'fchdir'.
Bruno Haible <bruno@clisp.org>
parents: 7389
diff changeset
40 #undef open
cb2590895141 New module 'fchdir'.
Bruno Haible <bruno@clisp.org>
parents: 7389
diff changeset
41 #undef close
cb2590895141 New module 'fchdir'.
Bruno Haible <bruno@clisp.org>
parents: 7389
diff changeset
42
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
43 #define PROC_SELF_FD_FORMAT "/proc/self/fd/%d/%s"
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
44
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
45 #define PROC_SELF_FD_NAME_SIZE_BOUND(len) \
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
46 (sizeof PROC_SELF_FD_FORMAT - sizeof "%d%s" \
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
47 + INT_STRLEN_BOUND (int) + (len) + 1)
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
48
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
49
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
50 /* Set BUF to the expansion of PROC_SELF_FD_FORMAT, using FD and FILE
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
51 respectively for %d and %s. If successful, return BUF if the
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
52 result fits in BUF, dynamically allocated memory otherwise. But
14167
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
53 return NULL if /proc is not reliable, either because the operating
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
54 system support is lacking or because memory is low. */
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
55 char *
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
56 openat_proc_name (char buf[OPENAT_BUFFER_SIZE], int fd, char const *file)
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
57 {
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
58 static int proc_status = 0;
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
59
11950
bc28631dbf94 openat: fail with ENOENT on empty name
Eric Blake <ebb9@byu.net>
parents: 11938
diff changeset
60 /* Make sure the caller gets ENOENT when appropriate. */
bc28631dbf94 openat: fail with ENOENT on empty name
Eric Blake <ebb9@byu.net>
parents: 11938
diff changeset
61 if (!*file)
bc28631dbf94 openat: fail with ENOENT on empty name
Eric Blake <ebb9@byu.net>
parents: 11938
diff changeset
62 {
bc28631dbf94 openat: fail with ENOENT on empty name
Eric Blake <ebb9@byu.net>
parents: 11938
diff changeset
63 buf[0] = '\0';
bc28631dbf94 openat: fail with ENOENT on empty name
Eric Blake <ebb9@byu.net>
parents: 11938
diff changeset
64 return buf;
bc28631dbf94 openat: fail with ENOENT on empty name
Eric Blake <ebb9@byu.net>
parents: 11938
diff changeset
65 }
bc28631dbf94 openat: fail with ENOENT on empty name
Eric Blake <ebb9@byu.net>
parents: 11938
diff changeset
66
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
67 if (! proc_status)
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
68 {
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
69 /* Set PROC_STATUS to a positive value if /proc/self/fd is
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
70 reliable, and a negative value otherwise. Solaris 10
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
71 /proc/self/fd mishandles "..", and any file name might expand
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
72 to ".." after symbolic link expansion, so avoid /proc/self/fd
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
73 if it mishandles "..". Solaris 10 has openat, but this
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
74 problem is exhibited on code that built on Solaris 8 and
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
75 running on Solaris 10. */
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
76
14720
2663098d5483 openat: reduce syscalls in first probe of /proc
Eric Blake <eblake@redhat.com>
parents: 14389
diff changeset
77 int proc_self_fd = open ("/proc/self/fd",
2663098d5483 openat: reduce syscalls in first probe of /proc
Eric Blake <eblake@redhat.com>
parents: 14389
diff changeset
78 O_SEARCH | O_DIRECTORY | O_NOCTTY | O_NONBLOCK);
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
79 if (proc_self_fd < 0)
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
80 proc_status = -1;
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
81 else
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
82 {
14722
06595c2be4df openat: correct new comment
Bastien Roucariès <roucaries.bastien@gmail.com>
parents: 14721
diff changeset
83 /* Detect whether /proc/self/fd/%i/../fd exists, where %i is the
06595c2be4df openat: correct new comment
Bastien Roucariès <roucaries.bastien@gmail.com>
parents: 14721
diff changeset
84 number of a file descriptor open on /proc/self/fd. On Linux,
06595c2be4df openat: correct new comment
Bastien Roucariès <roucaries.bastien@gmail.com>
parents: 14721
diff changeset
85 that name resolves to /proc/self/fd, which was opened above.
06595c2be4df openat: correct new comment
Bastien Roucariès <roucaries.bastien@gmail.com>
parents: 14721
diff changeset
86 However, on Solaris, it may resolve to /proc/self/fd/fd, which
06595c2be4df openat: correct new comment
Bastien Roucariès <roucaries.bastien@gmail.com>
parents: 14721
diff changeset
87 cannot exist, since all names in /proc/self/fd are numeric. */
14720
2663098d5483 openat: reduce syscalls in first probe of /proc
Eric Blake <eblake@redhat.com>
parents: 14389
diff changeset
88 char dotdot_buf[PROC_SELF_FD_NAME_SIZE_BOUND (sizeof "../fd" - 1)];
2663098d5483 openat: reduce syscalls in first probe of /proc
Eric Blake <eblake@redhat.com>
parents: 14389
diff changeset
89 sprintf (dotdot_buf, PROC_SELF_FD_FORMAT, proc_self_fd, "../fd");
2663098d5483 openat: reduce syscalls in first probe of /proc
Eric Blake <eblake@redhat.com>
parents: 14389
diff changeset
90 proc_status = access (dotdot_buf, F_OK) ? -1 : 1;
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
91 close (proc_self_fd);
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 11950
diff changeset
92 }
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
93 }
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
94
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
95 if (proc_status < 0)
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
96 return NULL;
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
97 else
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
98 {
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
99 size_t bufsize = PROC_SELF_FD_NAME_SIZE_BOUND (strlen (file));
14167
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
100 char *result = buf;
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
101 if (OPENAT_BUFFER_SIZE < bufsize)
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
102 {
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
103 result = malloc (bufsize);
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
104 if (! result)
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
105 return NULL;
7e8e0e534d32 openat, save-cwd: avoid xmalloc
Paul Eggert <eggert@cs.ucla.edu>
parents: 14079
diff changeset
106 }
7389
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
107 sprintf (result, PROC_SELF_FD_FORMAT, fd, file);
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
108 return result;
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
109 }
0f8d70c02f29 [lib/ChangeLog]
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
110 }