1/* Copyright (C) 1991-2021 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, see
16 <https://www.gnu.org/licenses/>. */
17
18#include <dirent.h>
19#include <fcntl.h>
20#include <errno.h>
21#include <stdio.h> /* For BUFSIZ. */
22#include <sys/param.h> /* For MIN and MAX. */
23
24#include <not-cancel.h>
25
26enum {
27 opendir_oflags = O_RDONLY|O_NDELAY|O_DIRECTORY|O_LARGEFILE|O_CLOEXEC
28};
29
30static bool
31invalid_name (const char *name)
32{
33 if (__glibc_unlikely (name[0] == '\0'))
34 {
35 /* POSIX.1-1990 says an empty name gets ENOENT;
36 but `open' might like it fine. */
37 __set_errno (ENOENT);
38 return true;
39 }
40 return false;
41}
42
43static DIR *
44opendir_tail (int fd)
45{
46 if (__glibc_unlikely (fd < 0))
47 return NULL;
48
49 /* Now make sure this really is a directory and nothing changed since the
50 `stat' call. The S_ISDIR check is superfluous if O_DIRECTORY works,
51 but it's cheap and we need the stat call for st_blksize anyway. */
52 struct stat64 statbuf;
53 if (__glibc_unlikely (__fstat64 (fd, &statbuf) < 0))
54 goto lose;
55 if (__glibc_unlikely (! S_ISDIR (statbuf.st_mode)))
56 {
57 __set_errno (ENOTDIR);
58 lose:
59 __close_nocancel_nostatus (fd);
60 return NULL;
61 }
62
63 return __alloc_dir (fd, true, 0, &statbuf);
64}
65
66
67#if IS_IN (libc)
68DIR *
69__opendirat (int dfd, const char *name)
70{
71 if (__glibc_unlikely (invalid_name (name)))
72 return NULL;
73
74 return opendir_tail (__openat_nocancel (dfd, name, opendir_oflags));
75}
76#endif
77
78
79/* Open a directory stream on NAME. */
80DIR *
81__opendir (const char *name)
82{
83 if (__glibc_unlikely (invalid_name (name)))
84 return NULL;
85
86 return opendir_tail (__open_nocancel (name, opendir_oflags));
87}
88weak_alias (__opendir, opendir)
89
90DIR *
91__alloc_dir (int fd, bool close_fd, int flags, const struct stat64 *statp)
92{
93 /* We have to set the close-on-exit flag if the user provided the
94 file descriptor. */
95 if (!close_fd
96 && __glibc_unlikely (__fcntl64_nocancel (fd, F_SETFD, FD_CLOEXEC) < 0))
97 return NULL;
98
99 /* The st_blksize value of the directory is used as a hint for the
100 size of the buffer which receives struct dirent values from the
101 kernel. st_blksize is limited to max_buffer_size, in case the
102 file system provides a bogus value. */
103 enum { max_buffer_size = 1048576 };
104
105 const size_t allocation_size = 32768;
106 _Static_assert (allocation_size >= sizeof (struct dirent64),
107 "allocation_size < sizeof (struct dirent64)");
108
109 /* Increase allocation if requested, but not if the value appears to
110 be bogus. It will be between 32Kb and 1Mb. */
111 size_t allocation = MIN (MAX ((size_t) statp->st_blksize, allocation_size),
112 max_buffer_size);
113
114 DIR *dirp = (DIR *) malloc (sizeof (DIR) + allocation);
115 if (dirp == NULL)
116 {
117 if (close_fd)
118 __close_nocancel_nostatus (fd);
119 return NULL;
120 }
121
122 dirp->fd = fd;
123#if IS_IN (libc)
124 __libc_lock_init (dirp->lock);
125#endif
126 dirp->allocation = allocation;
127 dirp->size = 0;
128 dirp->offset = 0;
129 dirp->filepos = 0;
130 dirp->errcode = 0;
131
132 return dirp;
133}
134