2938c67e4a12e8ee77c4a2cab1b94084b490bc3c
[kopensolaris-gnu/glibc.git] / sysdeps / unix / opendir.c
1 /* Copyright (C) 1991-1996,98,2000-2002, 2003 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Lesser General Public
6    License as published by the Free Software Foundation; either
7    version 2.1 of the License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Lesser General Public License for more details.
13
14    You should have received a copy of the GNU Lesser General Public
15    License along with the GNU C Library; if not, write to the Free
16    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17    02111-1307 USA.  */
18
19 #include <errno.h>
20 #include <limits.h>
21 #include <stddef.h>
22 #include <stdlib.h>
23 #include <dirent.h>
24 #include <fcntl.h>
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 #include <unistd.h>
28 #include <stdio.h>
29
30 #include <dirstream.h>
31 #include <not-cancel.h>
32
33
34 /* opendir() must not accidentally open something other than a directory.
35    Some OS's have kernel support for that, some don't.  In the worst
36    case we have to stat() before the open() AND fstat() after.
37
38    We have to test at runtime for kernel support since libc may have
39    been compiled with different headers to the kernel it's running on.
40    This test can't be done reliably in the general case.  We'll use
41    /dev/null, which if it's not a device lots of stuff will break, as
42    a guinea pig.  It may be missing in chroot environments, so we
43    make sure to fail safe. */
44 #ifdef O_DIRECTORY
45 # ifdef O_DIRECTORY_WORKS
46 #  define o_directory_works 1
47 #  define tryopen_o_directory() while (1) /* This must not be called.  */
48 # else
49 static int o_directory_works;
50
51 static void
52 tryopen_o_directory (void)
53 {
54   int serrno = errno;
55   int x = open_not_cancel_2 ("/dev/null", O_RDONLY|O_NDELAY|O_DIRECTORY);
56
57   if (x >= 0)
58     {
59       close_not_cancel_no_status (x);
60       o_directory_works = -1;
61     }
62   else if (errno != ENOTDIR)
63     o_directory_works = -1;
64   else
65     o_directory_works = 1;
66
67   __set_errno (serrno);
68 }
69 # endif
70 # define EXTRA_FLAGS O_DIRECTORY
71 #else
72 # define EXTRA_FLAGS 0
73 #endif
74
75
76 /* Open a directory stream on NAME.  */
77 DIR *
78 __opendir (const char *name)
79 {
80   DIR *dirp;
81   struct stat64 statbuf;
82   int fd;
83   size_t allocation;
84   int save_errno;
85
86   if (__builtin_expect (name[0], '\1') == '\0')
87     {
88       /* POSIX.1-1990 says an empty name gets ENOENT;
89          but `open' might like it fine.  */
90       __set_errno (ENOENT);
91       return NULL;
92     }
93
94 #ifdef O_DIRECTORY
95   /* Test whether O_DIRECTORY works.  */
96   if (o_directory_works == 0)
97     tryopen_o_directory ();
98
99   /* We can skip the expensive `stat' call if O_DIRECTORY works.  */
100   if (o_directory_works < 0)
101 #endif
102     {
103       /* We first have to check whether the name is for a directory.  We
104          cannot do this after the open() call since the open/close operation
105          performed on, say, a tape device might have undesirable effects.  */
106       if (__builtin_expect (__xstat64 (_STAT_VER, name, &statbuf), 0) < 0)
107         return NULL;
108       if (__builtin_expect (! S_ISDIR (statbuf.st_mode), 0))
109         {
110           __set_errno (ENOTDIR);
111           return NULL;
112          }
113     }
114
115   fd = open_not_cancel_2 (name, O_RDONLY|O_NDELAY|EXTRA_FLAGS|O_LARGEFILE);
116   if (__builtin_expect (fd, 0) < 0)
117     return NULL;
118
119   /* Now make sure this really is a directory and nothing changed since
120      the `stat' call.  We do not have to perform the test for the
121      descriptor being associated with a directory if we know the
122      O_DIRECTORY flag is honored by the kernel.  */
123   if (__builtin_expect (__fxstat64 (_STAT_VER, fd, &statbuf), 0) < 0)
124     goto lose;
125 #ifdef O_DIRECTORY
126   if (o_directory_works <= 0)
127 #endif
128     {
129       if (__builtin_expect (! S_ISDIR (statbuf.st_mode), 0))
130         {
131           save_errno = ENOTDIR;
132           goto lose;
133         }
134     }
135
136   if (__builtin_expect (__fcntl (fd, F_SETFD, FD_CLOEXEC), 0) < 0)
137     goto lose;
138
139 #ifdef _STATBUF_ST_BLKSIZE
140   if (__builtin_expect ((size_t) statbuf.st_blksize >= sizeof (struct dirent64),
141                         1))
142     allocation = statbuf.st_blksize;
143   else
144 #endif
145     allocation = (BUFSIZ < sizeof (struct dirent64)
146                   ? sizeof (struct dirent64) : BUFSIZ);
147
148   const int pad = -sizeof (DIR) % __alignof__ (struct dirent64);
149
150   dirp = (DIR *) malloc (sizeof (DIR) + allocation + pad);
151   if (dirp == NULL)
152   lose:
153     {
154       save_errno = errno;
155       close_not_cancel_no_status (fd);
156       __set_errno (save_errno);
157       return NULL;
158     }
159   memset (dirp, '\0', sizeof (DIR));
160   dirp->data = (char *) (dirp + 1) + pad;
161   dirp->allocation = allocation;
162   dirp->fd = fd;
163
164   __libc_lock_init (dirp->lock);
165
166   return dirp;
167 }
168 weak_alias (__opendir, opendir)