xref: /freebsd/lib/libc/gen/scandir.c (revision b0b1dbdd)
1 /*
2  * Copyright (c) 1983, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #if defined(LIBC_SCCS) && !defined(lint)
31 static char sccsid[] = "@(#)scandir.c	8.3 (Berkeley) 1/2/94";
32 #endif /* LIBC_SCCS and not lint */
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 /*
37  * Scan the directory dirname calling select to make a list of selected
38  * directory entries then sort using qsort and compare routine dcomp.
39  * Returns the number of entries and a pointer to a list of pointers to
40  * struct dirent (through namelist). Returns -1 if there were any errors.
41  */
42 
43 #include "namespace.h"
44 #include <dirent.h>
45 #include <stdlib.h>
46 #include <string.h>
47 #include "un-namespace.h"
48 
49 #ifdef	I_AM_SCANDIR_B
50 #include "block_abi.h"
51 #define	SELECT(x)	CALL_BLOCK(select, x)
52 #ifndef __BLOCKS__
53 void
54 qsort_b(void *, size_t, size_t, void*);
55 #endif
56 #else
57 #define	SELECT(x)	select(x)
58 #endif
59 
60 static int alphasort_thunk(void *thunk, const void *p1, const void *p2);
61 
62 /*
63  * The DIRSIZ macro is the minimum record length which will hold the directory
64  * entry.  This requires the amount of space in struct dirent without the
65  * d_name field, plus enough space for the name and a terminating nul byte
66  * (dp->d_namlen + 1), rounded up to a 4 byte boundary.
67  */
68 #undef DIRSIZ
69 #define DIRSIZ(dp)							\
70 	((sizeof(struct dirent) - sizeof(dp)->d_name) +			\
71 	    (((dp)->d_namlen + 1 + 3) &~ 3))
72 
73 int
74 #ifdef I_AM_SCANDIR_B
75 scandir_b(const char *dirname, struct dirent ***namelist,
76     DECLARE_BLOCK(int, select, const struct dirent *),
77     DECLARE_BLOCK(int, dcomp, const struct dirent **, const struct dirent **))
78 #else
79 scandir(const char *dirname, struct dirent ***namelist,
80     int (*select)(const struct dirent *), int (*dcomp)(const struct dirent **,
81 	const struct dirent **))
82 #endif
83 {
84 	struct dirent *d, *p, **names = NULL;
85 	size_t numitems;
86 	long arraysz;
87 	DIR *dirp;
88 
89 	if ((dirp = opendir(dirname)) == NULL)
90 		return(-1);
91 
92 	arraysz = 32;	/* initial estimate of the array size */
93 	names = (struct dirent **)malloc(arraysz * sizeof(struct dirent *));
94 	if (names == NULL)
95 		goto fail;
96 
97 	numitems = 0;
98 	while ((d = readdir(dirp)) != NULL) {
99 		if (select != NULL && !SELECT(d))
100 			continue;	/* just selected names */
101 		/*
102 		 * Make a minimum size copy of the data
103 		 */
104 		p = (struct dirent *)malloc(DIRSIZ(d));
105 		if (p == NULL)
106 			goto fail;
107 		p->d_fileno = d->d_fileno;
108 		p->d_type = d->d_type;
109 		p->d_reclen = d->d_reclen;
110 		p->d_namlen = d->d_namlen;
111 		bcopy(d->d_name, p->d_name, p->d_namlen + 1);
112 		/*
113 		 * Check to make sure the array has space left and
114 		 * realloc the maximum size.
115 		 */
116 		if (numitems >= arraysz) {
117 			struct dirent **names2;
118 
119 			names2 = reallocarray(names, arraysz,
120 			    2 * sizeof(struct dirent *));
121 			if (names2 == NULL) {
122 				free(p);
123 				goto fail;
124 			}
125 			names = names2;
126 			arraysz *= 2;
127 		}
128 		names[numitems++] = p;
129 	}
130 	closedir(dirp);
131 	if (numitems && dcomp != NULL)
132 #ifdef I_AM_SCANDIR_B
133 		qsort_b(names, numitems, sizeof(struct dirent *), (void*)dcomp);
134 #else
135 		qsort_r(names, numitems, sizeof(struct dirent *),
136 		    &dcomp, alphasort_thunk);
137 #endif
138 	*namelist = names;
139 	return (numitems);
140 
141 fail:
142 	while (numitems > 0)
143 		free(names[--numitems]);
144 	free(names);
145 	closedir(dirp);
146 	return (-1);
147 }
148 
149 /*
150  * Alphabetic order comparison routine for those who want it.
151  * POSIX 2008 requires that alphasort() uses strcoll().
152  */
153 int
154 alphasort(const struct dirent **d1, const struct dirent **d2)
155 {
156 
157 	return (strcoll((*d1)->d_name, (*d2)->d_name));
158 }
159 
160 static int
161 alphasort_thunk(void *thunk, const void *p1, const void *p2)
162 {
163 	int (*dc)(const struct dirent **, const struct dirent **);
164 
165 	dc = *(int (**)(const struct dirent **, const struct dirent **))thunk;
166 	return (dc((const struct dirent **)p1, (const struct dirent **)p2));
167 }
168