openat: test for fstatat (..., 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 && !FSTATAT_ZERO_FLAG_BROKEN
46
47 # ifndef LSTAT_FOLLOWS_SLASHED_SYMLINK
48 #  define LSTAT_FOLLOWS_SLASHED_SYMLINK 0
49 # endif
50
51 /* fstatat should always follow symbolic links that end in /, but on
52    Solaris 9 it doesn't if AT_SYMLINK_NOFOLLOW is specified.
53    Likewise, trailing slash on a non-directory should be an error.
54    These are the same problems that lstat.c and stat.c address, so
55    solve it in a similar way.
56
57    AIX 7.1 fstatat (AT_FDCWD, ..., 0) always fails, which is a bug.
58    Work around this bug if FSTATAT_AT_FDCWD_0_BROKEN is nonzero.  */
59
60 int
61 rpl_fstatat (int fd, char const *file, struct stat *st, int flag)
62 {
63   int result = orig_fstatat (fd, file, st, flag);
64   size_t len;
65
66   if (LSTAT_FOLLOWS_SLASHED_SYMLINK || result != 0)
67     return result;
68   len = strlen (file);
69   if (flag & AT_SYMLINK_NOFOLLOW)
70     {
71       /* Fix lstat behavior.  */
72       if (file[len - 1] != '/' || S_ISDIR (st->st_mode))
73         return 0;
74       if (!S_ISLNK (st->st_mode))
75         {
76           errno = ENOTDIR;
77           return -1;
78         }
79       result = orig_fstatat (fd, file, st, flag & ~AT_SYMLINK_NOFOLLOW);
80     }
81   /* Fix stat behavior.  */
82   if (result == 0 && !S_ISDIR (st->st_mode) && file[len - 1] == '/')
83     {
84       errno = ENOTDIR;
85       return -1;
86     }
87   return result;
88 }
89
90 #else /* !HAVE_FSTATAT || FSTATAT_ZERO_FLAG_BROKEN */
91
92 /* On mingw, the gnulib <sys/stat.h> defines `stat' as a function-like
93    macro; but using it in AT_FUNC_F2 causes compilation failure
94    because the preprocessor sees a use of a macro that requires two
95    arguments but is only given one.  Hence, we need an inline
96    forwarder to get past the preprocessor.  */
97 static inline int
98 stat_func (char const *name, struct stat *st)
99 {
100   return stat (name, st);
101 }
102
103 /* Likewise, if there is no native `lstat', then the gnulib
104    <sys/stat.h> defined it as stat, which also needs adjustment.  */
105 # if !HAVE_LSTAT
106 #  undef lstat
107 #  define lstat stat_func
108 # endif
109
110 /* Replacement for Solaris' function by the same name.
111    <http://www.google.com/search?q=fstatat+site:docs.sun.com>
112    First, try to simulate it via l?stat ("/proc/self/fd/FD/FILE").
113    Failing that, simulate it via save_cwd/fchdir/(stat|lstat)/restore_cwd.
114    If either the save_cwd or the restore_cwd fails (relatively unlikely),
115    then give a diagnostic and exit nonzero.
116    Otherwise, this function works just like Solaris' fstatat.  */
117
118 # if FSTATAT_ZERO_FLAG_BROKEN
119 #  define AT_FUNC_NAME rpl_fstatat
120 # else
121 #  define AT_FUNC_NAME fstatat
122 # endif
123 # define AT_FUNC_F1 lstat
124 # define AT_FUNC_F2 stat_func
125 # define AT_FUNC_USE_F1_COND AT_SYMLINK_NOFOLLOW
126 # define AT_FUNC_POST_FILE_PARAM_DECLS , struct stat *st, int flag
127 # define AT_FUNC_POST_FILE_ARGS        , st
128 # include "at-func.c"
129 # undef AT_FUNC_NAME
130 # undef AT_FUNC_F1
131 # undef AT_FUNC_F2
132 # undef AT_FUNC_USE_F1_COND
133 # undef AT_FUNC_POST_FILE_PARAM_DECLS
134 # undef AT_FUNC_POST_FILE_ARGS
135
136 #endif /* !HAVE_FSTATAT */