2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char sccsid
[] = "@(#)glob.c 8.3 (Berkeley) 10/13/93";
35 #endif /* LIBC_SCCS and not lint */
36 #include <sys/cdefs.h>
37 //__FBSDID("$FreeBSD: src/lib/libc/gen/glob.c,v 1.27 2008/06/26 07:12:35 mtm Exp $");
40 * glob(3) -- a superset of the one defined in POSIX 1003.2.
42 * The [!...] convention to negate a range is supported (SysV, Posix, ksh).
44 * Optional extra services, controlled by flags not defined by POSIX:
47 * Escaping convention: \ inhibits any special meaning the following
48 * character might have (except \ at end of string is retained).
50 * Set in gl_flags if pattern contained a globbing character.
52 * Same as GLOB_NOCHECK, but it will only append pattern if it did
53 * not contain any magic characters. [Used in csh style globbing]
55 * Use alternately specified directory access functions.
57 * expand ~user/foo to the /home/dir/of/user/foo
59 * expand {1,2}{a,b} to 1a 1b 2a 2b
61 * Number of matches in the current invocation of glob.
65 * Some notes on multibyte character support:
66 * 1. Patterns with illegal byte sequences match nothing - even if
67 * GLOB_NOCHECK is specified.
68 * 2. Illegal byte sequences in filenames are handled by treating them as
69 * single-byte characters with a value of the first byte of the sequence
71 * 3. State-dependent encodings are not currently supported.
74 #include <sys/param.h>
89 #include <errno_private.h>
90 #include <wchar_private.h>
108 #define UNDERSCORE '_'
116 #define M_QUOTE 0x8000000000ULL
117 #define M_PROTECT 0x4000000000ULL
118 #define M_MASK 0xffffffffffULL
119 #define M_CHAR 0x00ffffffffULL
121 typedef uint_fast64_t Char
;
126 #define M_PROTECT 0x40
135 #define CHAR(c) ((Char)((c)&M_CHAR))
136 #define META(c) ((Char)((c)|M_QUOTE))
137 #define M_ALL META('*')
138 #define M_END META(']')
139 #define M_NOT META('!')
140 #define M_ONE META('?')
141 #define M_RNG META('-')
142 #define M_SET META('[')
143 #define ismeta(c) (((c)&M_QUOTE) != 0)
146 static int compare(const void *, const void *);
147 static int g_Ctoc(const Char
*, char *, size_t);
148 static int g_lstat(Char
*, struct stat
*, glob_t
*);
149 static DIR *g_opendir(Char
*, glob_t
*);
150 static const Char
*g_strchr(const Char
*, wchar_t);
152 static Char
*g_strcat(Char
*, const Char
*);
154 static int g_stat(Char
*, struct stat
*, glob_t
*);
155 static int glob0(const Char
*, glob_t
*, size_t *);
156 static int glob1(Char
*, glob_t
*, size_t *);
157 static int glob2(Char
*, Char
*, Char
*, Char
*, glob_t
*, size_t *);
158 static int glob3(Char
*, Char
*, Char
*, Char
*, Char
*, glob_t
*, size_t *);
159 static int globextend(const Char
*, glob_t
*, size_t *);
161 globtilde(const Char
*, Char
*, size_t, glob_t
*);
162 static int globexp1(const Char
*, glob_t
*, size_t *);
163 static int globexp2(const Char
*, const Char
*, glob_t
*, int *, size_t *);
164 static int match(Char
*, Char
*, Char
*);
166 static void qprintf(const char *, Char
*);
172 glob(const char *pattern
, int flags
, int (*errfunc
)(const char *, int), glob_t
*pglob
)
176 Char
*bufnext
, *bufend
, patbuf
[MAXPATHLEN
], prot
;
182 if (!(flags
& GLOB_APPEND
)) {
184 pglob
->gl_pathv
= NULL
;
185 if (!(flags
& GLOB_DOOFFS
))
188 if (flags
& GLOB_LIMIT
) {
189 limit
= pglob
->gl_matchc
;
194 pglob
->gl_flags
= flags
& ~GLOB_MAGCHAR
;
195 pglob
->gl_errfunc
= errfunc
;
196 pglob
->gl_matchc
= 0;
199 bufend
= bufnext
+ MAXPATHLEN
- 1;
200 if (flags
& GLOB_NOESCAPE
) {
201 memset(&mbs
, 0, sizeof(mbs
));
202 while (bufend
- bufnext
>= MB_CUR_MAX
) {
203 clen
= __mbrtowc(&wc
, patnext
, MB_LEN_MAX
, &mbs
);
204 if (clen
== (size_t)-1 || clen
== (size_t)-2)
205 return (GLOB_NOMATCH
);
212 /* Protect the quoted characters. */
213 memset(&mbs
, 0, sizeof(mbs
));
214 while (bufend
- bufnext
>= MB_CUR_MAX
) {
215 if (*patnext
== QUOTE
) {
216 if (*++patnext
== EOS
) {
217 *bufnext
++ = QUOTE
| M_PROTECT
;
223 clen
= __mbrtowc(&wc
, patnext
, MB_LEN_MAX
, &mbs
);
224 if (clen
== (size_t)-1 || clen
== (size_t)-2)
225 return (GLOB_NOMATCH
);
228 *bufnext
++ = wc
| prot
;
234 if (flags
& GLOB_BRACE
)
235 return globexp1(patbuf
, pglob
, &limit
);
237 return glob0(patbuf
, pglob
, &limit
);
241 * Expand recursively a glob {} pattern. When there is no more expansion
242 * invoke the standard globbing routine to glob the rest of the magic
246 globexp1(const Char
*pattern
, glob_t
*pglob
, size_t *limit
)
248 const Char
* ptr
= pattern
;
251 /* Protect a single {}, for find(1), like csh */
252 if (pattern
[0] == LBRACE
&& pattern
[1] == RBRACE
&& pattern
[2] == EOS
)
253 return glob0(pattern
, pglob
, limit
);
255 while ((ptr
= g_strchr(ptr
, LBRACE
)) != NULL
)
256 if (!globexp2(ptr
, pattern
, pglob
, &rv
, limit
))
259 return glob0(pattern
, pglob
, limit
);
264 * Recursive brace globbing helper. Tries to expand a single brace.
265 * If it succeeds then it invokes globexp1 with the new pattern.
266 * If it fails then it tries to glob the rest of the pattern and returns.
269 globexp2(const Char
*ptr
, const Char
*pattern
, glob_t
*pglob
, int *rv
, size_t *limit
)
273 const Char
*pe
, *pm
, *pm1
, *pl
;
274 Char patbuf
[MAXPATHLEN
];
276 /* copy part up to the brace */
277 for (lm
= patbuf
, pm
= pattern
; pm
!= ptr
; *lm
++ = *pm
++)
282 /* Find the balanced brace */
283 for (i
= 0, pe
= ++ptr
; *pe
; pe
++)
284 if (*pe
== LBRACKET
) {
285 /* Ignore everything between [] */
286 for (pm
= pe
++; *pe
!= RBRACKET
&& *pe
!= EOS
; pe
++)
290 * We could not find a matching RBRACKET.
291 * Ignore and just look for RBRACE
296 else if (*pe
== LBRACE
)
298 else if (*pe
== RBRACE
) {
304 /* Non matching braces; just glob the pattern */
305 if (i
!= 0 || *pe
== EOS
) {
306 *rv
= glob0(patbuf
, pglob
, limit
);
310 for (i
= 0, pl
= pm
= ptr
; pm
<= pe
; pm
++)
313 /* Ignore everything between [] */
314 for (pm1
= pm
++; *pm
!= RBRACKET
&& *pm
!= EOS
; pm
++)
318 * We could not find a matching RBRACKET.
319 * Ignore and just look for RBRACE
336 if (i
&& *pm
== COMMA
)
339 /* Append the current string */
340 for (lm
= ls
; (pl
< pm
); *lm
++ = *pl
++)
343 * Append the rest of the pattern after the
346 for (pl
= pe
+ 1; (*lm
++ = *pl
++) != EOS
;)
349 /* Expand the current pattern */
351 qprintf("globexp2:", patbuf
);
353 *rv
= globexp1(patbuf
, pglob
, limit
);
355 /* move after the comma, to the next string */
370 * expand tilde from the passwd file.
373 globtilde(const Char
*pattern
, Char
*patbuf
, size_t patbuf_len
, glob_t
*pglob
)
380 if (*pattern
!= TILDE
|| !(pglob
->gl_flags
& GLOB_TILDE
))
384 * Copy up to the end of the string or /
386 eb
= &patbuf
[patbuf_len
- 1];
387 for (p
= pattern
+ 1, h
= (char *) patbuf
;
388 h
< (char *)eb
&& *p
&& *p
!= SLASH
; *h
++ = *p
++)
393 if (((char *) patbuf
)[0] == EOS
) {
395 * handle a plain ~ or ~/ by expanding $HOME first (iff
396 * we're not running setuid or setgid) and then trying
403 (h
= getenv("HOME")) == NULL
) {
404 if (((h
= getlogin()) != NULL
&&
405 (pwd
= getpwnam(h
)) != NULL
) ||
406 (pwd
= getpwuid(getuid())) != NULL
)
416 if ((pwd
= getpwnam((char*) patbuf
)) == NULL
)
422 /* Copy the home directory */
423 for (b
= patbuf
; b
< eb
&& *h
; *b
++ = *h
++)
426 /* Append the rest of the pattern */
427 while (b
< eb
&& (*b
++ = *p
++) != EOS
)
436 * The main glob() routine: compiles the pattern (optionally processing
437 * quotes), calls glob1() to do the real pattern matching, and finally
438 * sorts the list (unless unsorted operation is requested). Returns 0
439 * if things went well, nonzero if errors occurred.
442 glob0(const Char
*pattern
, glob_t
*pglob
, size_t *limit
)
444 const Char
*qpatnext
;
447 Char
*bufnext
, patbuf
[MAXPATHLEN
];
449 qpatnext
= globtilde(pattern
, patbuf
, MAXPATHLEN
, pglob
);
450 oldpathc
= pglob
->gl_pathc
;
453 /* We don't need to check for buffer overflow any more. */
454 while ((c
= *qpatnext
++) != EOS
) {
460 if (*qpatnext
== EOS
||
461 g_strchr(qpatnext
+1, RBRACKET
) == NULL
) {
462 *bufnext
++ = LBRACKET
;
472 *bufnext
++ = CHAR(c
);
473 if (*qpatnext
== RANGE
&&
474 (c
= qpatnext
[1]) != RBRACKET
) {
476 *bufnext
++ = CHAR(c
);
479 } while ((c
= *qpatnext
++) != RBRACKET
);
480 pglob
->gl_flags
|= GLOB_MAGCHAR
;
484 pglob
->gl_flags
|= GLOB_MAGCHAR
;
488 pglob
->gl_flags
|= GLOB_MAGCHAR
;
489 /* collapse adjacent stars to one,
490 * to avoid exponential behavior
492 if (bufnext
== patbuf
|| bufnext
[-1] != M_ALL
)
496 *bufnext
++ = CHAR(c
);
502 qprintf("glob0:", patbuf
);
505 if ((err
= glob1(patbuf
, pglob
, limit
)) != 0)
509 * If there was no match we are going to append the pattern
510 * if GLOB_NOCHECK was specified or if GLOB_NOMAGIC was specified
511 * and the pattern did not contain any magic characters
512 * GLOB_NOMAGIC is there just for compatibility with csh.
514 if (pglob
->gl_pathc
== oldpathc
) {
515 if (((pglob
->gl_flags
& GLOB_NOCHECK
) ||
516 ((pglob
->gl_flags
& GLOB_NOMAGIC
) &&
517 !(pglob
->gl_flags
& GLOB_MAGCHAR
))))
518 return(globextend(pattern
, pglob
, limit
));
520 return(GLOB_NOMATCH
);
522 if (!(pglob
->gl_flags
& GLOB_NOSORT
))
523 qsort(pglob
->gl_pathv
+ pglob
->gl_offs
+ oldpathc
,
524 pglob
->gl_pathc
- oldpathc
, sizeof(char *), compare
);
529 compare(const void *p
, const void *q
)
531 return(strcmp(*(char **)p
, *(char **)q
));
535 glob1(Char
*pattern
, glob_t
*pglob
, size_t *limit
)
537 Char pathbuf
[MAXPATHLEN
];
539 /* A null pathname is invalid -- POSIX 1003.1 sect. 2.4. */
542 return(glob2(pathbuf
, pathbuf
, pathbuf
+ MAXPATHLEN
- 1,
543 pattern
, pglob
, limit
));
547 * The functions glob2 and glob3 are mutually recursive; there is one level
548 * of recursion for each segment in the pattern that contains one or more
552 glob2(Char
*pathbuf
, Char
*pathend
, Char
*pathend_last
, Char
*pattern
,
553 glob_t
*pglob
, size_t *limit
)
560 * Loop over pattern segments until end of pattern or until
561 * segment with meta character found.
563 for (anymeta
= 0;;) {
564 if (*pattern
== EOS
) { /* End of pattern? */
566 if (g_lstat(pathbuf
, &sb
, pglob
))
569 if (((pglob
->gl_flags
& GLOB_MARK
) &&
570 pathend
[-1] != SEP
) && (S_ISDIR(sb
.st_mode
)
571 || (S_ISLNK(sb
.st_mode
) &&
572 (g_stat(pathbuf
, &sb
, pglob
) == 0) &&
573 S_ISDIR(sb
.st_mode
)))) {
574 if (pathend
+ 1 > pathend_last
)
575 return (GLOB_ABORTED
);
580 return(globextend(pathbuf
, pglob
, limit
));
583 /* Find end of next segment, copy tentatively to pathend. */
586 while (*p
!= EOS
&& *p
!= SEP
) {
589 if (q
+ 1 > pathend_last
)
590 return (GLOB_ABORTED
);
594 if (!anymeta
) { /* No expansion, do next segment. */
597 while (*pattern
== SEP
) {
598 if (pathend
+ 1 > pathend_last
)
599 return (GLOB_ABORTED
);
600 *pathend
++ = *pattern
++;
602 } else /* Need expansion, recurse. */
603 return(glob3(pathbuf
, pathend
, pathend_last
, pattern
, p
,
610 glob3(Char
*pathbuf
, Char
*pathend
, Char
*pathend_last
,
611 Char
*pattern
, Char
*restpattern
,
612 glob_t
*pglob
, size_t *limit
)
617 char buf
[MAXPATHLEN
];
620 * The readdirfunc declaration can't be prototyped, because it is
621 * assigned, below, to two functions which are prototyped in glob.h
622 * and dirent.h as taking pointers to differently typed opaque
625 struct dirent
*(*readdirfunc
)();
627 if (pathend
> pathend_last
)
628 return (GLOB_ABORTED
);
632 if ((dirp
= g_opendir(pathbuf
, pglob
)) == NULL
) {
633 /* TODO: don't call for ENOENT or ENOTDIR? */
634 if (pglob
->gl_errfunc
) {
635 if (g_Ctoc(pathbuf
, buf
, sizeof(buf
)))
636 return (GLOB_ABORTED
);
637 if (pglob
->gl_errfunc(buf
, errno
) ||
638 pglob
->gl_flags
& GLOB_ERR
)
639 return (GLOB_ABORTED
);
646 /* Search directory for matching names. */
647 if (pglob
->gl_flags
& GLOB_ALTDIRFUNC
)
648 readdirfunc
= pglob
->gl_readdir
;
650 readdirfunc
= readdir
;
651 while ((dp
= (*readdirfunc
)(dirp
))) {
658 /* Initial DOT must be matched literally. */
659 if (dp
->d_name
[0] == DOT
&& *pattern
!= DOT
)
661 memset(&mbs
, 0, sizeof(mbs
));
664 while (dc
< pathend_last
) {
665 clen
= __mbrtowc(&wc
, sc
, MB_LEN_MAX
, &mbs
);
666 if (clen
== (size_t)-1 || clen
== (size_t)-2) {
669 memset(&mbs
, 0, sizeof(mbs
));
671 if ((*dc
++ = wc
) == EOS
)
675 if (!match(pathend
, pattern
, restpattern
)) {
679 err
= glob2(pathbuf
, --dc
, pathend_last
, restpattern
,
685 if (pglob
->gl_flags
& GLOB_ALTDIRFUNC
)
686 (*pglob
->gl_closedir
)(dirp
);
694 * Extend the gl_pathv member of a glob_t structure to accomodate a new item,
695 * add the new item, and update gl_pathc.
697 * This assumes the BSD realloc, which only copies the block when its size
698 * crosses a power-of-two boundary; for v7 realloc, this would cause quadratic
701 * Return 0 if new item added, error code if memory couldn't be allocated.
703 * Invariant of the glob_t structure:
704 * Either gl_pathc is zero and gl_pathv is NULL; or gl_pathc > 0 and
705 * gl_pathv points to (gl_offs + gl_pathc + 1) items.
708 globextend(const Char
*path
, glob_t
*pglob
, size_t *limit
)
711 size_t i
, newsize
, len
;
715 if (*limit
&& pglob
->gl_pathc
> *limit
) {
717 return (GLOB_NOSPACE
);
720 newsize
= sizeof(*pathv
) * (2 + pglob
->gl_pathc
+ pglob
->gl_offs
);
721 pathv
= pglob
->gl_pathv
?
722 realloc((char *)pglob
->gl_pathv
, newsize
) :
725 if (pglob
->gl_pathv
) {
726 free(pglob
->gl_pathv
);
727 pglob
->gl_pathv
= NULL
;
729 return(GLOB_NOSPACE
);
732 if (pglob
->gl_pathv
== NULL
&& pglob
->gl_offs
> 0) {
733 /* first time around -- clear initial gl_offs items */
734 pathv
+= pglob
->gl_offs
;
735 for (i
= pglob
->gl_offs
+ 1; --i
> 0; )
738 pglob
->gl_pathv
= pathv
;
740 for (p
= path
; *p
++;)
742 len
= MB_CUR_MAX
* (size_t)(p
- path
); /* XXX overallocation */
743 if ((copy
= malloc(len
)) != NULL
) {
744 if (g_Ctoc(path
, copy
, len
)) {
746 return (GLOB_NOSPACE
);
748 pathv
[pglob
->gl_offs
+ pglob
->gl_pathc
++] = copy
;
750 pathv
[pglob
->gl_offs
+ pglob
->gl_pathc
] = NULL
;
751 return(copy
== NULL
? GLOB_NOSPACE
: 0);
755 * pattern matching function for filenames. Each occurrence of the *
756 * pattern causes a recursion level.
759 match(Char
*name
, Char
*pat
, Char
*patend
)
761 int ok
, negate_range
;
764 while (pat
< patend
) {
766 switch (c
& M_MASK
) {
771 if (match(name
, pat
, patend
))
773 while (*name
++ != EOS
);
781 if ((k
= *name
++) == EOS
)
783 if ((negate_range
= ((*pat
& M_MASK
) == M_NOT
)) != EOS
)
785 while (((c
= *pat
++) & M_MASK
) != M_END
)
786 if ((*pat
& M_MASK
) == M_RNG
) {
789 __collate_load_error
?
791 CHAR(c
) <= CHAR(k
) && CHAR(k
) <= CHAR(pat
[1])
794 __collate_range_cmp(CHAR(c
), CHAR(k
)) <= 0
795 && __collate_range_cmp(CHAR(k
), CHAR(pat
[1])) <= 0
802 if (ok
== negate_range
)
811 return(*name
== EOS
);
814 /* Free allocated data belonging to a glob_t structure. */
816 globfree(glob_t
*pglob
)
821 if (pglob
->gl_pathv
!= NULL
) {
822 pp
= pglob
->gl_pathv
+ pglob
->gl_offs
;
823 for (i
= pglob
->gl_pathc
; i
--; ++pp
)
826 free(pglob
->gl_pathv
);
827 pglob
->gl_pathv
= NULL
;
832 g_opendir(Char
*str
, glob_t
*pglob
)
834 char buf
[MAXPATHLEN
];
839 if (g_Ctoc(str
, buf
, sizeof(buf
)))
843 if (pglob
->gl_flags
& GLOB_ALTDIRFUNC
)
844 return((*pglob
->gl_opendir
)(buf
));
846 return(opendir(buf
));
850 g_lstat(Char
*fn
, struct stat
*sb
, glob_t
*pglob
)
852 char buf
[MAXPATHLEN
];
854 if (g_Ctoc(fn
, buf
, sizeof(buf
))) {
855 __set_errno(ENAMETOOLONG
);
858 if (pglob
->gl_flags
& GLOB_ALTDIRFUNC
)
859 return((*pglob
->gl_lstat
)(buf
, sb
));
860 return(lstat(buf
, sb
));
864 g_stat(Char
*fn
, struct stat
*sb
, glob_t
*pglob
)
866 char buf
[MAXPATHLEN
];
868 if (g_Ctoc(fn
, buf
, sizeof(buf
))) {
869 __set_errno(ENAMETOOLONG
);
872 if (pglob
->gl_flags
& GLOB_ALTDIRFUNC
)
873 return((*pglob
->gl_stat
)(buf
, sb
));
874 return(stat(buf
, sb
));
878 g_strchr(const Char
*str
, wchar_t ch
)
889 g_Ctoc(const Char
*str
, char *buf
, size_t len
)
894 memset(&mbs
, 0, sizeof(mbs
));
895 while (len
>= MB_CUR_MAX
) {
896 clen
= __wcrtomb(buf
, *str
, &mbs
);
897 if (clen
== (size_t)-1)
910 qprintf(const char *str
, Char
*s
)
914 (void)printf("%s:\n", str
);
916 (void)printf("%c", CHAR(*p
));
919 (void)printf("%c", *p
& M_PROTECT
? '"' : ' ');
922 (void)printf("%c", ismeta(*p
) ? '_' : ' ');