2 * Copyright (c) 2003-2004 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * This is a new directory-walking system that addresses a number
29 * of problems I've had with fts(3). In particular, it has no
30 * pathname-length limits (other than the size of 'int'), handles
31 * deep logical traversals, uses considerably less memory, and has
32 * an opaque interface (easier to modify in the future).
34 * Internally, it keeps a single list of "tree_entry" items that
35 * represent filesystem objects that require further attention.
36 * Non-directories are not kept in memory: they are pulled from
37 * readdir(), returned to the client, then freed as soon as possible.
38 * Any directory entry to be traversed gets pushed onto the stack.
40 * There is surprisingly little information that needs to be kept for
41 * each item on the stack. Just the name, depth (represented here as the
42 * string length of the parent directory's pathname), and some markers
43 * indicating how to get back to the parent (via chdir("..") for a
44 * regular dir or via fchdir(2) for a symlink).
46 #include "bsdtar_platform.h"
47 __FBSDID("$FreeBSD: src/usr.bin/tar/tree.c,v 1.1 2005/04/24 05:53:37 kientzle Exp $");
62 * 3) Arbitrary logical traversals by closing/reopening intermediate fds.
66 struct tree_entry
*next
;
67 struct tree_entry
*parent
;
69 size_t dirname_length
;
76 /* Definitions for tree_entry.flags bitmap. */
77 #define isDir 1 /* This entry is a regular directory. */
78 #define isDirLink 2 /* This entry is a symbolic link to a directory. */
79 #define needsPreVisit 4 /* This entry needs to be previsited. */
80 #define needsPostVisit 8 /* This entry needs to be postvisited. */
83 * Local data for this package.
86 struct tree_entry
*stack
;
87 struct tree_entry
*current
;
92 int tree_errno
; /* Error code from last failed operation. */
98 size_t dirname_length
;
108 /* Definitions for tree.flags bitmap. */
109 #define needsReturn 8 /* Marks first entry as not having been returned yet. */
110 #define hasStat 16 /* The st entry is set. */
111 #define hasLstat 32 /* The lst entry is set. */
114 #ifdef HAVE_DIRENT_D_NAMLEN
115 /* BSD extension; avoids need for a strlen() call. */
116 #define D_NAMELEN(dp) (dp)->d_namlen
118 #define D_NAMELEN(dp) (strlen((dp)->d_name))
124 tree_dump(struct tree
*t
, FILE *out
)
126 struct tree_entry
*te
;
128 fprintf(out
, "\tdepth: %d\n", t
->depth
);
129 fprintf(out
, "\tbuff: %s\n", t
->buff
);
130 fprintf(out
, "\tpwd: "); fflush(stdout
); system("pwd");
131 fprintf(out
, "\taccess: %s\n", t
->basename
);
132 fprintf(out
, "\tstack:\n");
133 for(te
= t
->stack
; te
!= NULL
; te
= te
->next
) {
134 fprintf(out
, "\t\tte->name: %s%s%s\n", te
->name
,
135 te
->flags
& needsPreVisit
? "" : " *",
136 t
->current
== te
? " (current)" : "");
142 * Add a directory path to the current stack.
145 tree_push(struct tree
*t
, const char *path
)
147 struct tree_entry
*te
;
149 te
= malloc(sizeof(*te
));
150 memset(te
, 0, sizeof(*te
));
154 te
->name
= strdup(path
);
155 te
->flags
= needsPreVisit
| needsPostVisit
;
156 te
->dirname_length
= t
->dirname_length
;
160 * Append a name to the current path.
163 tree_append(struct tree
*t
, const char *name
, size_t name_length
)
168 t
->buff
[t
->dirname_length
] = '\0';
169 /* Strip trailing '/' from name, unless entire name is "/". */
170 while (name_length
> 1 && name
[name_length
- 1] == '/')
173 /* Resize pathname buffer as needed. */
174 while (name_length
+ 1 + t
->dirname_length
>= t
->buff_length
) {
176 if (t
->buff_length
< 1024)
177 t
->buff_length
= 1024;
178 t
->buff
= realloc(t
->buff
, t
->buff_length
);
180 p
= t
->buff
+ t
->dirname_length
;
181 t
->path_length
= t
->dirname_length
+ name_length
;
182 /* Add a separating '/' if it's needed. */
183 if (t
->dirname_length
> 0 && p
[-1] != '/') {
187 strncpy(p
, name
, name_length
);
188 p
[name_length
] = '\0';
193 * Open a directory tree for traversal.
196 tree_open(const char *path
)
200 t
= malloc(sizeof(*t
));
201 memset(t
, 0, sizeof(*t
));
202 tree_append(t
, path
, strlen(path
));
203 t
->initialDirFd
= open(".", O_RDONLY
);
205 * During most of the traversal, items are set up and then
206 * returned immediately from tree_next(). That doesn't work
207 * for the very first entry, so we set a flag for this special
210 t
->flags
= needsReturn
;
215 * We've finished a directory; ascend back to the parent.
218 tree_ascend(struct tree
*t
)
220 struct tree_entry
*te
;
224 if (te
->flags
& isDirLink
) {
234 * Pop the working stack.
237 tree_pop(struct tree
*t
)
239 struct tree_entry
*te
;
241 t
->buff
[t
->dirname_length
] = '\0';
242 if (t
->stack
== t
->current
&& t
->current
!= NULL
)
243 t
->current
= t
->current
->parent
;
246 t
->dirname_length
= te
->dirname_length
;
247 t
->basename
= t
->buff
+ t
->dirname_length
;
248 /* Special case: starting dir doesn't skip leading '/'. */
249 if (t
->dirname_length
> 0)
256 * Get the next item in the tree traversal.
259 tree_next(struct tree
*t
)
261 struct dirent
*de
= NULL
;
263 /* Handle the startup case by returning the initial entry. */
264 if (t
->flags
& needsReturn
) {
265 t
->flags
&= ~needsReturn
;
266 return (t
->visit_type
= TREE_REGULAR
);
269 while (t
->stack
!= NULL
) {
270 /* If there's an open dir, get the next entry from there. */
271 while (t
->d
!= NULL
) {
276 } else if (de
->d_name
[0] == '.'
277 && de
->d_name
[1] == '\0') {
279 } else if (de
->d_name
[0] == '.'
280 && de
->d_name
[1] == '.'
281 && de
->d_name
[2] == '\0') {
285 * Append the path to the current path
288 tree_append(t
, de
->d_name
, D_NAMELEN(de
));
289 t
->flags
&= ~hasLstat
;
290 t
->flags
&= ~hasStat
;
291 return (t
->visit_type
= TREE_REGULAR
);
295 /* If the current dir needs to be visited, set it up. */
296 if (t
->stack
->flags
& needsPreVisit
) {
297 t
->current
= t
->stack
;
298 tree_append(t
, t
->stack
->name
, strlen(t
->stack
->name
));
299 t
->stack
->flags
&= ~needsPreVisit
;
300 /* If it is a link, set up fd for the ascent. */
301 if (t
->stack
->flags
& isDirLink
) {
302 t
->stack
->fd
= open(".", O_RDONLY
);
304 if (t
->openCount
> t
->maxOpenCount
)
305 t
->maxOpenCount
= t
->openCount
;
307 t
->dirname_length
= t
->path_length
;
308 if (chdir(t
->stack
->name
) != 0) {
309 /* chdir() failed; return error */
311 t
->tree_errno
= errno
;
312 return (t
->visit_type
= TREE_ERROR
);
317 t
->tree_errno
= errno
;
318 return (t
->visit_type
= TREE_ERROR
);
321 t
->flags
&= ~hasLstat
;
322 t
->flags
&= ~hasStat
;
324 return (t
->visit_type
= TREE_POSTDESCENT
);
327 /* We've done everything necessary for the top stack entry. */
328 if (t
->stack
->flags
& needsPostVisit
) {
331 t
->flags
&= ~hasLstat
;
332 t
->flags
&= ~hasStat
;
333 return (t
->visit_type
= TREE_POSTASCENT
);
336 return (t
->visit_type
= 0);
343 tree_errno(struct tree
*t
)
345 return (t
->tree_errno
);
349 * Called by the client to mark the directory just returned from
350 * tree_next() as needing to be visited.
353 tree_descend(struct tree
*t
)
355 if (t
->visit_type
!= TREE_REGULAR
)
358 if (tree_current_is_physical_dir(t
)) {
359 tree_push(t
, t
->basename
);
360 t
->stack
->flags
|= isDir
;
361 } else if (tree_current_is_dir(t
)) {
362 tree_push(t
, t
->basename
);
363 t
->stack
->flags
|= isDirLink
;
368 * Get the stat() data for the entry just returned from tree_next().
371 tree_current_stat(struct tree
*t
)
373 if (!(t
->flags
& hasStat
)) {
374 if (stat(t
->basename
, &t
->st
) != 0)
382 * Get the lstat() data for the entry just returned from tree_next().
385 tree_current_lstat(struct tree
*t
)
387 if (!(t
->flags
& hasLstat
)) {
388 if (lstat(t
->basename
, &t
->lst
) != 0)
390 t
->flags
|= hasLstat
;
396 * Test whether current entry is a dir or dir link.
399 tree_current_is_dir(struct tree
*t
)
401 /* If we've already pulled stat(), just use that. */
402 if (t
->flags
& hasStat
)
403 return (S_ISDIR(tree_current_stat(t
)->st_mode
));
405 /* If we've already pulled lstat(), we may be able to use that. */
406 if (t
->flags
& hasLstat
) {
407 /* If lstat() says it's a dir, it must be a dir. */
408 if (S_ISDIR(tree_current_lstat(t
)->st_mode
))
410 /* If it's not a dir and not a link, we're done. */
411 if (!S_ISLNK(tree_current_lstat(t
)->st_mode
))
414 * If the above two tests fail, then it's a link, but
415 * we don't know whether it's a link to a dir or a
420 /* TODO: Use a more efficient mechanism when available. */
421 return (S_ISDIR(tree_current_stat(t
)->st_mode
));
425 * Test whether current entry is a physical directory.
428 tree_current_is_physical_dir(struct tree
*t
)
430 /* If we've already pulled lstat(), just use that. */
431 if (t
->flags
& hasLstat
)
432 return (S_ISDIR(tree_current_lstat(t
)->st_mode
));
434 /* TODO: Use a more efficient mechanism when available. */
435 return (S_ISDIR(tree_current_lstat(t
)->st_mode
));
439 * Test whether current entry is a symbolic link.
442 tree_current_is_physical_link(struct tree
*t
)
444 /* If we've already pulled lstat(), just use that. */
445 if (t
->flags
& hasLstat
)
446 return (S_ISLNK(tree_current_lstat(t
)->st_mode
));
448 /* TODO: Use a more efficient mechanism when available. */
449 return (S_ISLNK(tree_current_lstat(t
)->st_mode
));
453 * Return the access path for the entry just returned from tree_next().
456 tree_current_access_path(struct tree
*t
)
458 return (t
->basename
);
462 * Return the full path for the entry just returned from tree_next().
465 tree_current_path(struct tree
*t
)
471 * Return the length of the path for the entry just returned from tree_next().
474 tree_current_pathlen(struct tree
*t
)
476 return (t
->path_length
);
480 * Return the nesting depth of the entry just returned from tree_next().
483 tree_current_depth(struct tree
*t
)
489 * Terminate the traversal and release any resources.
492 tree_close(struct tree
*t
)
494 /* Release anything remaining in the stack. */
495 while (t
->stack
!= NULL
)
499 /* chdir() back to where we started. */
500 if (t
->initialDirFd
>= 0) {
501 fchdir(t
->initialDirFd
);
502 close(t
->initialDirFd
);
503 t
->initialDirFd
= -1;