openat: test for fstatat (AT_FDCWD, ..., 0) bug
[gnulib.git] / lib / fstatat.c
1 /* Work around an fstatat bug on Solaris 9.
2
3    Copyright (C) 2006, 2009-2011 Free Software Foundation, Inc.
4
5    This program is free software: you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 3 of the License, or
8    (at your option) any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
17
18 /* Written by Paul Eggert and Jim Meyering.  */
19
20 /* If the user's config.h happens to include <sys/stat.h>, let it include only
21    the system's <sys/stat.h> here, so that orig_fstatat doesn't recurse to
22    rpl_fstatat.  */
23 #define __need_system_sys_stat_h
24 #include <config.h>
25
26 /* Get the original definition of fstatat.  It might be defined as a macro.  */
27 #include <sys/types.h>
28 #include <sys/stat.h>
29 #undef __need_system_sys_stat_h
30
31 #if HAVE_FSTATAT
32 static inline int
33 orig_fstatat (int fd, char const *filename, struct stat *buf, int flags)
34 {
35   return fstatat (fd, filename, buf, flags);
36 }
37 #endif
38
39 #include <sys/stat.h>
40
41 #include <errno.h>
42 #include <fcntl.h>
43 #include <string.h>
44
45 #if HAVE_FSTATAT
46
47 # undef fstatat
48
49 # ifndef FSTATAT_AT_FDCWD_0_BROKEN
50 #  define FSTATAT_AT_FDCWD_0_BROKEN 0
51 # endif
52
53 # ifndef LSTAT_FOLLOWS_SLASHED_SYMLINK
54 #  define LSTAT_FOLLOWS_SLASHED_SYMLINK 0
55 # endif
56
57 /* fstatat should always follow symbolic links that end in /, but on
58    Solaris 9 it doesn't if AT_SYMLINK_NOFOLLOW is specified.
59    Likewise, trailing slash on a non-directory should be an error.
60    These are the same problems that lstat.c and stat.c address, so
61    solve it in a similar way.
62
63    AIX 7.1 fstatat (AT_FDCWD, ..., 0) always fails, which is a bug.
64    Work around this bug if FSTATAT_AT_FDCWD_0_BROKEN is nonzero.  */
65
66 int
67 rpl_fstatat (int fd, char const *file, struct stat *st, int flag)
68 {
69   int result =
70     (FSTATAT_AT_FDCWD_0_BROKEN && fd == AT_FDCWD && flag == 0
71      ? stat (file, st)
72      : orig_fstatat (fd, file, st, flag));
73   size_t len;
74
75   if (LSTAT_FOLLOWS_SLASHED_SYMLINK || result != 0)
76     return result;
77   len = strlen (file);
78   if (flag & AT_SYMLINK_NOFOLLOW)
79     {
80       /* Fix lstat behavior.  */
81       if (file[len - 1] != '/' || S_ISDIR (st->st_mode))
82         return 0;
83       if (!S_ISLNK (st->st_mode))
84         {
85           errno = ENOTDIR;
86           return -1;
87         }
88       result = fstatat (fd, file, st, flag & ~AT_SYMLINK_NOFOLLOW);
89     }
90   /* Fix stat behavior.  */
91   if (result == 0 && !S_ISDIR (st->st_mode) && file[len - 1] == '/')
92     {
93       errno = ENOTDIR;
94       return -1;
95     }
96   return result;
97 }
98
99 #else /* !HAVE_FSTATAT */
100
101 /* On mingw, the gnulib <sys/stat.h> defines `stat' as a function-like
102    macro; but using it in AT_FUNC_F2 causes compilation failure
103    because the preprocessor sees a use of a macro that requires two
104    arguments but is only given one.  Hence, we need an inline
105    forwarder to get past the preprocessor.  */
106 static inline int
107 stat_func (char const *name, struct stat *st)
108 {
109   return stat (name, st);
110 }
111
112 /* Likewise, if there is no native `lstat', then the gnulib
113    <sys/stat.h> defined it as stat, which also needs adjustment.  */
114 # if !HAVE_LSTAT
115 #  undef lstat
116 #  define lstat stat_func
117 # endif
118
119 /* Replacement for Solaris' function by the same name.
120    <http://www.google.com/search?q=fstatat+site:docs.sun.com>
121    First, try to simulate it via l?stat ("/proc/self/fd/FD/FILE").
122    Failing that, simulate it via save_cwd/fchdir/(stat|lstat)/restore_cwd.
123    If either the save_cwd or the restore_cwd fails (relatively unlikely),
124    then give a diagnostic and exit nonzero.
125    Otherwise, this function works just like Solaris' fstatat.  */
126
127 # define AT_FUNC_NAME fstatat
128 # define AT_FUNC_F1 lstat
129 # define AT_FUNC_F2 stat_func
130 # define AT_FUNC_USE_F1_COND AT_SYMLINK_NOFOLLOW
131 # define AT_FUNC_POST_FILE_PARAM_DECLS , struct stat *st, int flag
132 # define AT_FUNC_POST_FILE_ARGS        , st
133 # include "at-func.c"
134 # undef AT_FUNC_NAME
135 # undef AT_FUNC_F1
136 # undef AT_FUNC_F2
137 # undef AT_FUNC_USE_F1_COND
138 # undef AT_FUNC_POST_FILE_PARAM_DECLS
139 # undef AT_FUNC_POST_FILE_ARGS
140
141 #endif /* !HAVE_FSTATAT */