xref: /freebsd/lib/libc/gen/readdir.c (revision 1d6b6ea2d0e617d29681da3cf121abec309d272f)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1983, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include "namespace.h"
33 #include <sys/param.h>
34 #include <dirent.h>
35 #include <errno.h>
36 #include <string.h>
37 #include <pthread.h>
38 #include "un-namespace.h"
39 
40 #include "libc_private.h"
41 #include "gen-private.h"
42 #include "telldir.h"
43 
44 #include "gen-compat.h"
45 
46 /*
47  * get next entry in a directory.
48  */
49 struct dirent *
50 _readdir_unlocked(DIR *dirp, int flags)
51 {
52 	struct dirent *dp;
53 	off_t initial_seek;
54 	size_t initial_loc = 0;
55 	ssize_t ret;
56 
57 	for (;;) {
58 		if (dirp->dd_loc >= dirp->dd_size) {
59 			if (dirp->dd_flags & __DTF_READALL)
60 				return (NULL);
61 			initial_loc = dirp->dd_loc;
62 			dirp->dd_flags &= ~__DTF_SKIPREAD;
63 			dirp->dd_loc = 0;
64 		}
65 		if (dirp->dd_loc == 0 &&
66 		    !(dirp->dd_flags & (__DTF_READALL | __DTF_SKIPREAD))) {
67 			dirp->dd_size = 0;
68 			initial_seek = dirp->dd_seek;
69 			ret = _getdirentries(dirp->dd_fd,
70 			    dirp->dd_buf, dirp->dd_len, &dirp->dd_seek);
71 			if (ret <= 0)
72 				return (NULL);
73 			dirp->dd_size = (size_t)ret;
74 			_fixtelldir(dirp, initial_seek, initial_loc);
75 		}
76 		dirp->dd_flags &= ~__DTF_SKIPREAD;
77 		dp = (struct dirent *)(dirp->dd_buf + dirp->dd_loc);
78 		if ((long)dp & 03L)	/* bogus pointer check */
79 			return (NULL);
80 		if (dp->d_reclen <= 0 ||
81 		    dp->d_reclen > dirp->dd_len + 1 - dirp->dd_loc)
82 			return (NULL);
83 		dirp->dd_loc += dp->d_reclen;
84 		if (dp->d_ino == 0 && (flags & RDU_SKIP) != 0)
85 			continue;
86 		if (dp->d_type == DT_WHT && (dirp->dd_flags & DTF_HIDEW))
87 			continue;
88 		if (dp->d_namlen >= sizeof(dp->d_name) &&
89 		    (flags & RDU_SHORT) != 0)
90 			continue;
91 		return (dp);
92 	}
93 }
94 
95 struct dirent *
96 readdir(DIR *dirp)
97 {
98 	struct dirent *dp;
99 
100 	if (__isthreaded)
101 		_pthread_mutex_lock(&dirp->dd_lock);
102 	dp = _readdir_unlocked(dirp, RDU_SKIP);
103 	if (__isthreaded)
104 		_pthread_mutex_unlock(&dirp->dd_lock);
105 	return (dp);
106 }
107 
108 int
109 freebsd15_readdir_r(DIR *dirp, struct dirent *entry, struct dirent **result)
110 {
111 	struct dirent *dp;
112 	int saved_errno;
113 
114 	saved_errno = errno;
115 	errno = 0;
116 	if (__isthreaded)
117 		_pthread_mutex_lock(&dirp->dd_lock);
118 	dp = _readdir_unlocked(dirp, RDU_SKIP | RDU_SHORT);
119 	if (dp != NULL)
120 		memcpy(entry, dp, _GENERIC_DIRSIZ(dp));
121 	if (__isthreaded)
122 		_pthread_mutex_unlock(&dirp->dd_lock);
123 
124 	if (errno != 0) {
125 		if (dp == NULL)
126 			return (errno);
127 	} else
128 		errno = saved_errno;
129 
130 	if (dp != NULL)
131 		*result = entry;
132 	else
133 		*result = NULL;
134 
135 	return (0);
136 }
137 
138 __sym_compat(readdir_r, freebsd15_readdir_r, FBSD_1.5);
139