Import upstream version 1.28
[debian/tar] / gnu / openat-proc.c
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* Create /proc/self/fd-related names for subfiles of open directories.
4
5    Copyright (C) 2006, 2009-2014 Free Software Foundation, Inc.
6
7    This program is free software: you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 /* Written by Paul Eggert.  */
21
22 #include <config.h>
23
24 #include "openat-priv.h"
25
26 #include <sys/types.h>
27 #include <sys/stat.h>
28 #include <fcntl.h>
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <unistd.h>
34
35 #include "intprops.h"
36
37 /* The results of open() in this file are not used with fchdir,
38    and we do not leak fds to any single-threaded code that could use stdio,
39    therefore save some unnecessary work in fchdir.c.
40    FIXME - if the kernel ever adds support for multi-thread safety for
41    avoiding standard fds, then we should use open_safer.  */
42 #undef open
43 #undef close
44
45 #define PROC_SELF_FD_FORMAT "/proc/self/fd/%d/%s"
46
47 #define PROC_SELF_FD_NAME_SIZE_BOUND(len) \
48   (sizeof PROC_SELF_FD_FORMAT - sizeof "%d%s" \
49    + INT_STRLEN_BOUND (int) + (len) + 1)
50
51
52 /* Set BUF to the expansion of PROC_SELF_FD_FORMAT, using FD and FILE
53    respectively for %d and %s.  If successful, return BUF if the
54    result fits in BUF, dynamically allocated memory otherwise.  But
55    return NULL if /proc is not reliable, either because the operating
56    system support is lacking or because memory is low.  */
57 char *
58 openat_proc_name (char buf[OPENAT_BUFFER_SIZE], int fd, char const *file)
59 {
60   static int proc_status = 0;
61
62   /* Make sure the caller gets ENOENT when appropriate.  */
63   if (!*file)
64     {
65       buf[0] = '\0';
66       return buf;
67     }
68
69   if (! proc_status)
70     {
71       /* Set PROC_STATUS to a positive value if /proc/self/fd is
72          reliable, and a negative value otherwise.  Solaris 10
73          /proc/self/fd mishandles "..", and any file name might expand
74          to ".." after symbolic link expansion, so avoid /proc/self/fd
75          if it mishandles "..".  Solaris 10 has openat, but this
76          problem is exhibited on code that built on Solaris 8 and
77          running on Solaris 10.  */
78
79       int proc_self_fd = open ("/proc/self/fd",
80                                O_SEARCH | O_DIRECTORY | O_NOCTTY | O_NONBLOCK);
81       if (proc_self_fd < 0)
82         proc_status = -1;
83       else
84         {
85           /* Detect whether /proc/self/fd/%i/../fd exists, where %i is the
86              number of a file descriptor open on /proc/self/fd.  On Linux,
87              that name resolves to /proc/self/fd, which was opened above.
88              However, on Solaris, it may resolve to /proc/self/fd/fd, which
89              cannot exist, since all names in /proc/self/fd are numeric.  */
90           char dotdot_buf[PROC_SELF_FD_NAME_SIZE_BOUND (sizeof "../fd" - 1)];
91           sprintf (dotdot_buf, PROC_SELF_FD_FORMAT, proc_self_fd, "../fd");
92           proc_status = access (dotdot_buf, F_OK) ? -1 : 1;
93           close (proc_self_fd);
94         }
95     }
96
97   if (proc_status < 0)
98     return NULL;
99   else
100     {
101       size_t bufsize = PROC_SELF_FD_NAME_SIZE_BOUND (strlen (file));
102       char *result = buf;
103       if (OPENAT_BUFFER_SIZE < bufsize)
104         {
105           result = malloc (bufsize);
106           if (! result)
107             return NULL;
108         }
109       sprintf (result, PROC_SELF_FD_FORMAT, fd, file);
110       return result;
111     }
112 }