Libc-1353.11.2.tar.gz

[apple/libc.git] / gen / FreeBSD / opendir.c

diff --git a/gen/FreeBSD/opendir.c b/gen/FreeBSD/opendir.c
index 9148240d7f3fc41ac45e64215d7ee52254fdc414..844a7e88cbe044f1bbb1fd3f84a48a5b540c3313 100644 (file)
--- a/gen/FreeBSD/opendir.c
+++ b/gen/FreeBSD/opendir.c
@@ -1,4 +1,4 @@
-/*
+/*-

  * Copyright (c) 1983, 1993
  *     The Regents of the University of California.  All rights reserved.
  *
  * Copyright (c) 1983, 1993
  *     The Regents of the University of California.  All rights reserved.
  *


@@ -10,10 +10,6 @@
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.

- * 3. All advertising materials mentioning features or use of this software
- *    must display the following acknowledgement:
- *     This product includes software developed by the University of
- *     California, Berkeley and its contributors.

  * 4. Neither the name of the University nor the names of its contributors
  *    may be used to endorse or promote products derived from this software
  *    without specific prior written permission.
  * 4. Neither the name of the University nor the names of its contributors
  *    may be used to endorse or promote products derived from this software
  *    without specific prior written permission.


@@ -35,12 +31,13 @@
 static char sccsid[] = "@(#)opendir.c  8.8 (Berkeley) 5/1/95";
 #endif /* LIBC_SCCS and not lint */
 #include <sys/cdefs.h>
 static char sccsid[] = "@(#)opendir.c  8.8 (Berkeley) 5/1/95";
 #endif /* LIBC_SCCS and not lint */
 #include <sys/cdefs.h>

-__FBSDID("$FreeBSD: src/lib/libc/gen/opendir.c,v 1.22 2004/08/14 17:46:10 stefanf Exp $");
+__FBSDID("$FreeBSD$");

 
 #include "namespace.h"
 #include <sys/param.h>
 #include <sys/mount.h>
 #include <sys/stat.h>
 
 #include "namespace.h"
 #include <sys/param.h>
 #include <sys/mount.h>
 #include <sys/stat.h>

+#include <sys/sysctl.h>

 
 #include <dirent.h>
 #include <errno.h>
 
 #include <dirent.h>
 #include <errno.h>


@@ -48,58 +45,122 @@ __FBSDID("$FreeBSD: src/lib/libc/gen/opendir.c,v 1.22 2004/08/14 17:46:10 stefan
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>

+#include <pthread.h>

 #include "un-namespace.h"
 
 #include "telldir.h"
 #include "un-namespace.h"
 
 #include "telldir.h"

+
+static bool
+__kernel_supports_unionfs(void)
+{
+       static int8_t kernel_supports_unionfs = -1;
+       if (kernel_supports_unionfs == -1) {
+               int value = 0;
+               size_t len = sizeof(value);
+               sysctlbyname("kern.secure_kernel", &value, &len, NULL, 0);
+               kernel_supports_unionfs = !value;
+       }
+       return kernel_supports_unionfs;
+}
+
+static int
+__fd_is_on_union_mount(int fd)
+{
+       struct statfs stbuf;
+       int rc;
+
+       rc = fstatfs(fd, &stbuf);
+       if (rc < 0) {
+               return rc;
+       }
+       return (stbuf.f_flags & MNT_UNION) != 0;
+}
+
+static DIR * __opendir_common(int, int, bool);
+

 /*
  * Open a directory.
  */
 DIR *
 /*
  * Open a directory.
  */
 DIR *

-opendir(name)
-       const char *name;
+opendir(const char *name)

 {
 
        return (__opendir2(name, DTF_HIDEW|DTF_NODUP));
 }
 
 {
 
        return (__opendir2(name, DTF_HIDEW|DTF_NODUP));
 }
 

+/*
+ * Open a directory with existing file descriptor.
+ */

 DIR *
 DIR *

-__opendir2(name, flags)
-       const char *name;
-       int flags;
+fdopendir(int fd)

 {
 {

-       DIR *dirp;
-       int fd;
-       int incr;
-       int saved_errno;
-       int unionstack;

        struct stat statb;
 
        struct stat statb;
 

-       /*
-        * stat() before _open() because opening of special files may be
-        * harmful.  _fstat() after open because the file may have changed.
-        */
-       if (stat(name, &statb) != 0)
+       /* Check that fd is associated with a directory. */
+       if (_fstat(fd, &statb) != 0)

                return (NULL);
        if (!S_ISDIR(statb.st_mode)) {
                errno = ENOTDIR;
                return (NULL);
        }
                return (NULL);
        if (!S_ISDIR(statb.st_mode)) {
                errno = ENOTDIR;
                return (NULL);
        }

-       if ((fd = _open(name, O_RDONLY | O_NONBLOCK)) == -1)
+       /* Make sure CLOEXEC is set on the fd */
+       if (_fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)

                return (NULL);
                return (NULL);

-       dirp = NULL;
-       if (_fstat(fd, &statb) != 0)
-               goto fail;
-       if (!S_ISDIR(statb.st_mode)) {
-               errno = ENOTDIR;
-               goto fail;
+       return (__opendir_common(fd, DTF_HIDEW|DTF_NODUP, true));
+}
+
+DIR *
+__opendir2(const char *name, int flags)
+{
+       int fd;
+       DIR *dir;
+       int saved_errno;
+
+       if ((flags & (__DTF_READALL | __DTF_SKIPREAD)) != 0)
+               return (NULL);
+       if ((fd = _open(name,
+           O_RDONLY | O_NONBLOCK | O_DIRECTORY | O_CLOEXEC)) == -1)
+               return (NULL);
+
+       dir = __opendir_common(fd, flags, false);
+       if (dir == NULL) {
+               saved_errno = errno;
+               _close(fd);
+               errno = saved_errno;

        }
        }

-       if (_fcntl(fd, F_SETFD, FD_CLOEXEC) == -1 ||
-           (dirp = malloc(sizeof(DIR) + sizeof(struct _telldir))) == NULL)
-               goto fail;
+       return (dir);
+}

 
 

-       dirp->dd_td = (struct _telldir *)((char *)dirp + sizeof(DIR));
-       LIST_INIT(&dirp->dd_td->td_locq);
-       dirp->dd_td->td_loccnt = 0;
+static int
+opendir_compar(const void *p1, const void *p2)
+{
+
+       return (strcmp((*(const struct dirent **)p1)->d_name,
+           (*(const struct dirent **)p2)->d_name));
+}
+
+/*
+ * For a directory at the top of a unionfs stack, the entire directory's
+ * contents are read and cached locally until the next call to rewinddir().
+ * For the fdopendir() case, the initial seek position must be preserved.
+ * For rewinddir(), the full directory should always be re-read from the
+ * beginning.
+ *
+ * If an error occurs, the existing buffer and state of 'dirp' is left
+ * unchanged.
+ */
+bool
+_filldir(DIR *dirp, bool use_current_pos)
+{
+       struct dirent **dpv;
+       char *buf, *ddptr, *ddeptr;
+       off_t pos;
+       int fd2, incr, len, n, saved_errno, space;
+       
+       len = 0;
+       space = 0;
+       buf = NULL;
+       ddptr = NULL;

 
        /*
         * Use the system page size if that is a multiple of DIRBLKSIZ.
 
        /*
         * Use the system page size if that is a multiple of DIRBLKSIZ.


@@ -111,177 +172,250 @@ __opendir2(name, flags)
                incr = DIRBLKSIZ;
 
        /*
                incr = DIRBLKSIZ;
 
        /*

-        * Determine whether this directory is the top of a union stack.
+        * The strategy here is to read all the directory
+        * entries into a buffer, sort the buffer, and
+        * remove duplicate entries by setting the inode
+        * number to zero.
+        *
+        * We reopen the directory because _getdirentries()
+        * on a MNT_UNION mount modifies the open directory,
+        * making it refer to the lower directory after the
+        * upper directory's entries are exhausted.
+        * This would otherwise break software that uses
+        * the directory descriptor for fchdir or *at
+        * functions, such as fts.c.

         */
         */

-       if (flags & DTF_NODUP) {
-               struct statfs sfb;
+       if ((fd2 = openat(dirp->dd_fd, ".", O_RDONLY | O_CLOEXEC)) == -1)
+               return (false);

 
 

-               if (_fstatfs(fd, &sfb) < 0)
-                       goto fail;
-               unionstack = !strcmp(sfb.f_fstypename, "unionfs")
-                   || (sfb.f_flags & MNT_UNION);
-       } else {
-               unionstack = 0;
+       if (use_current_pos) {
+               pos = lseek(dirp->dd_fd, 0, SEEK_CUR);
+               if (pos == -1 || lseek(fd2, pos, SEEK_SET) == -1) {
+                       saved_errno = errno;
+                       _close(fd2);
+                       errno = saved_errno;
+                       return (false);
+               }

        }
 
        }
 

-       if (unionstack) {
-               int len = 0;
-               int space = 0;
-               char *buf = 0;
-               char *ddptr = 0;
-               char *ddeptr;
-               int n;
-               struct dirent **dpv;
-
+       do {

                /*
                /*

-                * The strategy here is to read all the directory
-                * entries into a buffer, sort the buffer, and
-                * remove duplicate entries by setting the inode
-                * number to zero.
+                * Always make at least DIRBLKSIZ bytes
+                * available to _getdirentries

                 */
                 */

-
-               do {
-                       /*
-                        * Always make at least DIRBLKSIZ bytes
-                        * available to _getdirentries
-                        */
-                       if (space < DIRBLKSIZ) {
-                               space += incr;
-                               len += incr;
-                               buf = reallocf(buf, len);
-                               if (buf == NULL)
-                                       goto fail;
-                               ddptr = buf + (len - space);
+               if (space < DIRBLKSIZ) {
+                       space += incr;
+                       len += incr;
+                       buf = reallocf(buf, len);
+                       if (buf == NULL) {
+                               saved_errno = errno;
+                               _close(fd2);
+                               errno = saved_errno;
+                               return (false);

                        }
                        }

+                       ddptr = buf + (len - space);
+               }

 
 

-                       n = _getdirentries(fd, ddptr, space, &dirp->dd_seek);
-                       if (n > 0) {
-                               ddptr += n;
-                               space -= n;
-                       }
-               } while (n > 0);
+#if __DARWIN_64_BIT_INO_T
+               n = (int)__getdirentries64(fd2, ddptr, space, &dirp->dd_td->seekoff);
+#else /* !__DARWIN_64_BIT_INO_T */
+               n = _getdirentries(fd2, ddptr, space, &dirp->dd_seek);
+#endif /* __DARWIN_64_BIT_INO_T */
+               if (n > 0) {
+                       ddptr += n;
+                       space -= n;
+               }
+               if (n < 0) {
+                       saved_errno = errno;
+                       _close(fd2);
+                       errno = saved_errno;
+                       return (false);
+               }
+       } while (n > 0);
+       _close(fd2);

 
 

-               ddeptr = ddptr;
-               flags |= __DTF_READALL;
+       ddeptr = ddptr;

 
 

-               /*
-                * Re-open the directory.
-                * This has the effect of rewinding back to the
-                * top of the union stack and is needed by
-                * programs which plan to fchdir to a descriptor
-                * which has also been read -- see fts.c.
-                */
-               if (flags & DTF_REWIND) {
-                       (void)_close(fd);
-                       if ((fd = _open(name, O_RDONLY)) == -1) {
-                               saved_errno = errno;
-                               free(buf);
-                               free(dirp);
-                               errno = saved_errno;
-                               return (NULL);
+       /*
+        * There is now a buffer full of (possibly) duplicate
+        * names.
+        */
+       dirp->dd_buf = buf;
+
+       /*
+        * Go round this loop twice...
+        *
+        * Scan through the buffer, counting entries.
+        * On the second pass, save pointers to each one.
+        * Then sort the pointers and remove duplicate names.
+        */
+       for (dpv = NULL;;) {
+               n = 0;
+               ddptr = buf;
+               while (ddptr < ddeptr) {
+                       struct dirent *dp;
+
+                       dp = (struct dirent *) ddptr;
+                       if ((long)dp & 03L)
+                               break;
+                       if ((dp->d_reclen <= 0) ||
+                           (dp->d_reclen > (ddeptr + 1 - ddptr)))
+                               break;
+                       ddptr += dp->d_reclen;
+                       if (dp->d_fileno) {
+                               if (dpv)
+                                       dpv[n] = dp;
+                               n++;

                        }
                }
 
                        }
                }
 

-               /*
-                * There is now a buffer full of (possibly) duplicate
-                * names.
-                */
-               dirp->dd_buf = buf;
+               if (dpv) {
+                       struct dirent *xp;

 
 

-               /*
-                * Go round this loop twice...
-                *
-                * Scan through the buffer, counting entries.
-                * On the second pass, save pointers to each one.
-                * Then sort the pointers and remove duplicate names.
-                */
-               for (dpv = 0;;) {
-                       n = 0;
-                       ddptr = buf;
-                       while (ddptr < ddeptr) {
-                               struct dirent *dp;
-
-                               dp = (struct dirent *) ddptr;
-                               if ((long)dp & 03L)
-                                       break;
-                               if ((dp->d_reclen <= 0) ||
-                                   (dp->d_reclen > (ddeptr + 1 - ddptr)))
-                                       break;
-                               ddptr += dp->d_reclen;
-                               if (dp->d_fileno) {
-                                       if (dpv)
-                                               dpv[n] = dp;
-                                       n++;
-                               }
-                       }
+                       /*
+                        * This sort must be stable.
+                        */
+                       mergesort(dpv, n, sizeof(*dpv), opendir_compar);

 
 

-                       if (dpv) {
-                               struct dirent *xp;
-
-                               /*
-                                * This sort must be stable.
-                                */
-                               mergesort(dpv, n, sizeof(*dpv), alphasort);
-
-                               dpv[n] = NULL;
-                               xp = NULL;
-
-                               /*
-                                * Scan through the buffer in sort order,
-                                * zapping the inode number of any
-                                * duplicate names.
-                                */
-                               for (n = 0; dpv[n]; n++) {
-                                       struct dirent *dp = dpv[n];
-
-                                       if ((xp == NULL) ||
-                                           strcmp(dp->d_name, xp->d_name)) {
-                                               xp = dp;
-                                       } else {
-                                               dp->d_fileno = 0;
-                                       }
-                                       if (dp->d_type == DT_WHT &&
-                                           (flags & DTF_HIDEW))
-                                               dp->d_fileno = 0;
+                       dpv[n] = NULL;
+                       xp = NULL;
+
+                       /*
+                        * Scan through the buffer in sort order,
+                        * zapping the inode number of any
+                        * duplicate names.
+                        */
+                       for (n = 0; dpv[n]; n++) {
+                               struct dirent *dp = dpv[n];
+
+                               if ((xp == NULL) ||
+                                   strcmp(dp->d_name, xp->d_name)) {
+                                       xp = dp;
+                               } else {
+                                       dp->d_fileno = 0;

                                }
                                }

+                               if (dp->d_type == DT_WHT &&
+                                   (dirp->dd_flags & DTF_HIDEW))
+                                       dp->d_fileno = 0;
+                       }

 
 

-                               free(dpv);
+                       free(dpv);
+                       break;
+               } else {
+                       dpv = malloc((n+1) * sizeof(struct dirent *));
+                       if (dpv == NULL)

                                break;
                                break;

-                       } else {
-                               dpv = malloc((n+1) * sizeof(struct dirent *));
-                               if (dpv == NULL)
-                                       break;
-                       }

                }
                }

-
-               dirp->dd_len = len;
-               dirp->dd_size = ddptr - dirp->dd_buf;
-       } else {
-               dirp->dd_len = incr;
-               dirp->dd_size = 0;
-               dirp->dd_buf = malloc(dirp->dd_len);
-               if (dirp->dd_buf == NULL)
-                       goto fail;
-               dirp->dd_seek = 0;
-               flags &= ~DTF_REWIND;

        }
 
        }
 

-       dirp->dd_loc = 0;
+       dirp->dd_len = len;
+       dirp->dd_size = ddptr - dirp->dd_buf;
+       return (true);
+}
+
+
+/*
+ * Common routine for opendir(3), __opendir2(3) and fdopendir(3).
+ */
+static DIR *
+__opendir_common(int fd, int flags, bool use_current_pos)
+{
+       DIR *dirp;
+       int saved_errno;
+       int unionstack;
+
+       if ((dirp = malloc(sizeof(DIR) + sizeof(struct _telldir))) == NULL)
+               return (NULL);
+
+       dirp->dd_buf = NULL;

        dirp->dd_fd = fd;
        dirp->dd_flags = flags;
        dirp->dd_fd = fd;
        dirp->dd_flags = flags;

-       dirp->dd_lock = NULL;
+       dirp->dd_loc = 0;
+       dirp->dd_lock = (pthread_mutex_t)PTHREAD_MUTEX_INITIALIZER;
+       dirp->dd_td = (struct _telldir *)((char *)dirp + sizeof(DIR));
+       LIST_INIT(&dirp->dd_td->td_locq);
+       dirp->dd_td->td_loccnt = 0;

 
        /*
 
        /*

-        * Set up seek point for rewinddir.
+        * Determine whether this directory is the top of a union stack.

         */
         */

-       dirp->dd_rewind = telldir(dirp);
+       if ((flags & DTF_NODUP) && __kernel_supports_unionfs()) {
+               unionstack = __fd_is_on_union_mount(fd);
+               if (unionstack < 0)
+                       goto fail;
+       } else {
+               unionstack = 0;
+       }
+
+       if (unionstack) {
+               if (!_filldir(dirp, use_current_pos))
+                       goto fail;
+               dirp->dd_flags |= __DTF_READALL;
+       } else {
+               /*
+                * Start with a small-ish size to avoid allocating full pages.
+                * readdir() will allocate a larger buffer if it didn't fit
+                * to stay fast for large directories.
+                */
+               _Static_assert(GETDIRENTRIES64_EXTENDED_BUFSIZE <= READDIR_INITIAL_SIZE,
+                   "Make sure we'll get extended metadata");
+               dirp->dd_len = READDIR_INITIAL_SIZE;
+               dirp->dd_buf = malloc(dirp->dd_len);
+               if (dirp->dd_buf == NULL)
+                       goto fail;
+               if (use_current_pos) {
+                       /*
+                        * Read the first batch of directory entries
+                        * to prime dd_seek.  This also checks if the
+                        * fd passed to fdopendir() is a directory.
+                        */
+#if __DARWIN_64_BIT_INO_T
+                       /*
+                        * sufficiently recent kernels when the buffer is large enough,
+                        * will use the last bytes of the buffer to return status.
+                        *
+                        * To support older kernels:
+                        * - make sure it's 0 initialized
+                        * - make sure it's past `dd_size` before reading it
+                        */
+                       getdirentries64_flags_t *gdeflags =
+                           (getdirentries64_flags_t *)(dirp->dd_buf + dirp->dd_len -
+                           sizeof(getdirentries64_flags_t));
+                       *gdeflags = 0;
+                       dirp->dd_size = (long)__getdirentries64(dirp->dd_fd,
+                           dirp->dd_buf, dirp->dd_len, &dirp->dd_td->seekoff);
+                       if (dirp->dd_size >= 0 &&
+                           dirp->dd_size <= dirp->dd_len - sizeof(getdirentries64_flags_t)) {
+                               if (*gdeflags & GETDIRENTRIES64_EOF) {
+                                       dirp->dd_flags |= __DTF_ATEND;
+                               }
+                       }
+#else /* !__DARWIN_64_BIT_INO_T */
+                       dirp->dd_size = _getdirentries(dirp->dd_fd,
+                           dirp->dd_buf, dirp->dd_len, &dirp->dd_seek);
+#endif /* __DARWIN_64_BIT_INO_T */
+                       if (dirp->dd_size < 0) {
+                               if (errno == EINVAL)
+                                       errno = ENOTDIR;
+                               goto fail;
+                       }
+                       dirp->dd_flags |= __DTF_SKIPREAD;
+               } else {
+                       dirp->dd_size = 0;
+#if __DARWIN_64_BIT_INO_T
+                       dirp->dd_td->seekoff = 0;
+#else /* !__DARWIN_64_BIT_INO_T */
+                       dirp->dd_seek = 0;
+#endif /* __DARWIN_64_BIT_INO_T */
+               }
+       }

 
        return (dirp);
 
 fail:
        saved_errno = errno;
 
        return (dirp);
 
 fail:
        saved_errno = errno;

+       free(dirp->dd_buf);

        free(dirp);
        free(dirp);

-       (void)_close(fd);

        errno = saved_errno;
        return (NULL);
 }
        errno = saved_errno;
        return (NULL);
 }