walk.c revision 1.20 1 /* $NetBSD: walk.c,v 1.20 2006/10/10 01:39:10 dbj Exp $ */
2
3 /*
4 * Copyright (c) 2001 Wasabi Systems, Inc.
5 * All rights reserved.
6 *
7 * Written by Luke Mewburn for Wasabi Systems, Inc.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed for the NetBSD Project by
20 * Wasabi Systems, Inc.
21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
22 * or promote products derived from this software without specific prior
23 * written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38 #if HAVE_NBTOOL_CONFIG_H
39 #include "nbtool_config.h"
40 #endif
41
42 #include <sys/cdefs.h>
43 #if defined(__RCSID) && !defined(__lint)
44 __RCSID("$NetBSD: walk.c,v 1.20 2006/10/10 01:39:10 dbj Exp $");
45 #endif /* !__lint */
46
47 #include <sys/param.h>
48
49 #include <assert.h>
50 #include <errno.h>
51 #include <fcntl.h>
52 #include <stdio.h>
53 #include <dirent.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include <unistd.h>
57 #include <sys/stat.h>
58
59 #include "makefs.h"
60 #include "mtree.h"
61
62 static void apply_specdir(const char *, NODE *, fsnode *);
63 static void apply_specentry(const char *, NODE *, fsnode *);
64 static fsnode *create_fsnode(const char *, struct stat *);
65 static fsinode *link_check(fsinode *);
66
67
68 /*
69 * walk_dir --
70 * build a tree of fsnodes from `dir', with a parent fsnode of `parent'
71 * (which may be NULL for the root of the tree).
72 * each "level" is a directory, with the "." entry guaranteed to be
73 * at the start of the list, and without ".." entries.
74 */
75 fsnode *
76 walk_dir(const char *dir, fsnode *parent)
77 {
78 fsnode *first, *cur, *prev;
79 DIR *dirp;
80 struct dirent *dent;
81 char path[MAXPATHLEN + 1];
82 struct stat stbuf;
83
84 assert(dir != NULL);
85
86 if (debug & DEBUG_WALK_DIR)
87 printf("walk_dir: %s %p\n", dir, parent);
88 if ((dirp = opendir(dir)) == NULL)
89 err(1, "Can't opendir `%s'", dir);
90 first = prev = NULL;
91 while ((dent = readdir(dirp)) != NULL) {
92 if (strcmp(dent->d_name, "..") == 0)
93 continue;
94 if (debug & DEBUG_WALK_DIR_NODE)
95 printf("scanning %s/%s\n", dir, dent->d_name);
96 if (snprintf(path, sizeof(path), "%s/%s", dir, dent->d_name)
97 >= sizeof(path))
98 errx(1, "Pathname too long.");
99 if (lstat(path, &stbuf) == -1)
100 err(1, "Can't lstat `%s'", path);
101 #ifdef S_ISSOCK
102 if (S_ISSOCK(stbuf.st_mode & S_IFMT)) {
103 if (debug & DEBUG_WALK_DIR_NODE)
104 printf(" skipping socket %s\n", path);
105 continue;
106 }
107 #endif
108
109 cur = create_fsnode(dent->d_name, &stbuf);
110 cur->parent = parent;
111 if (strcmp(dent->d_name, ".") == 0) {
112 /* ensure "." is at the start of the list */
113 cur->next = first;
114 first = cur;
115 if (! prev)
116 prev = cur;
117 } else { /* not "." */
118 if (prev)
119 prev->next = cur;
120 prev = cur;
121 if (!first)
122 first = cur;
123 if (S_ISDIR(cur->type)) {
124 cur->child = walk_dir(path, cur);
125 continue;
126 }
127 }
128 if (stbuf.st_nlink > 1) {
129 fsinode *curino;
130
131 curino = link_check(cur->inode);
132 if (curino != NULL) {
133 free(cur->inode);
134 cur->inode = curino;
135 cur->inode->nlink++;
136 if (debug & DEBUG_WALK_DIR_LINKCHECK)
137 printf("link_check: found [%u, %llu]\n",
138 curino->st.st_dev,
139 (unsigned long long)curino->st.st_ino);
140 }
141 }
142 if (S_ISLNK(cur->type)) {
143 char slink[PATH_MAX+1];
144 int llen;
145
146 llen = readlink(path, slink, sizeof(slink) - 1);
147 if (llen == -1)
148 err(1, "Readlink `%s'", path);
149 slink[llen] = '\0';
150 if ((cur->symlink = strdup(slink)) == NULL)
151 err(1, "Memory allocation error");
152 }
153 }
154 for (cur = first; cur != NULL; cur = cur->next)
155 cur->first = first;
156 if (closedir(dirp) == -1)
157 err(1, "Can't closedir `%s'", dir);
158 return (first);
159 }
160
161 static fsnode *
162 create_fsnode(const char *name, struct stat *stbuf)
163 {
164 fsnode *cur;
165
166 if ((cur = calloc(1, sizeof(fsnode))) == NULL ||
167 (cur->name = strdup(name)) == NULL ||
168 (cur->inode = calloc(1, sizeof(fsinode))) == NULL)
169 err(1, "Memory allocation error");
170 cur->type = stbuf->st_mode & S_IFMT;
171 cur->inode->nlink = 1;
172 cur->inode->st = *stbuf;
173 return (cur);
174 }
175
176 /*
177 * apply_specfile --
178 * read in the mtree(8) specfile, and apply it to the tree
179 * at dir,parent. parameters in parent on equivalent types
180 * will be changed to those found in specfile, and missing
181 * entries will be added.
182 */
183 void
184 apply_specfile(const char *specfile, const char *dir, fsnode *parent)
185 {
186 struct timeval start;
187 FILE *fp;
188 NODE *root;
189
190 assert(specfile != NULL);
191 assert(parent != NULL);
192
193 if (debug & DEBUG_APPLY_SPECFILE)
194 printf("apply_specfile: %s, %s %p\n", specfile, dir, parent);
195
196 /* read in the specfile */
197 if ((fp = fopen(specfile, "r")) == NULL)
198 err(1, "Can't open `%s'", specfile);
199 TIMER_START(start);
200 root = spec(fp);
201 TIMER_RESULTS(start, "spec");
202 if (fclose(fp) == EOF)
203 err(1, "Can't close `%s'", specfile);
204
205 /* perform some sanity checks */
206 if (root == NULL)
207 errx(1, "Specfile `%s' did not contain a tree", specfile);
208 assert(strcmp(root->name, ".") == 0);
209 assert(root->type == F_DIR);
210
211 /* merge in the changes */
212 apply_specdir(dir, root, parent);
213 }
214
215 static void
216 apply_specdir(const char *dir, NODE *specnode, fsnode *dirnode)
217 {
218 char path[MAXPATHLEN + 1];
219 NODE *curnode;
220 fsnode *curfsnode;
221
222 assert(specnode != NULL);
223 assert(dirnode != NULL);
224
225 if (debug & DEBUG_APPLY_SPECFILE)
226 printf("apply_specdir: %s %p %p\n", dir, specnode, dirnode);
227
228 if (specnode->type != F_DIR)
229 errx(1, "Specfile node `%s/%s' is not a directory",
230 dir, specnode->name);
231 if (dirnode->type != S_IFDIR)
232 errx(1, "Directory node `%s/%s' is not a directory",
233 dir, dirnode->name);
234
235 apply_specentry(dir, specnode, dirnode);
236
237 /* now walk specnode->child matching up with dirnode */
238 for (curnode = specnode->child; curnode != NULL;
239 curnode = curnode->next) {
240 if (debug & DEBUG_APPLY_SPECENTRY)
241 printf("apply_specdir: spec %s\n",
242 curnode->name);
243 for (curfsnode = dirnode->next; curfsnode != NULL;
244 curfsnode = curfsnode->next) {
245 #if 0 /* too verbose for now */
246 if (debug & DEBUG_APPLY_SPECENTRY)
247 printf("apply_specdir: dirent %s\n",
248 curfsnode->name);
249 #endif
250 if (strcmp(curnode->name, curfsnode->name) == 0)
251 break;
252 }
253 if (snprintf(path, sizeof(path), "%s/%s",
254 dir, curnode->name) >= sizeof(path))
255 errx(1, "Pathname too long.");
256 if (curfsnode == NULL) { /* need new entry */
257 struct stat stbuf;
258
259 /*
260 * don't add optional spec entries
261 * that lack an existing fs entry
262 */
263 if ((curnode->flags & F_OPT) &&
264 lstat(path, &stbuf) == -1)
265 continue;
266
267 /* check that enough info is provided */
268 #define NODETEST(t, m) \
269 if (!(t)) \
270 errx(1, "`%s': %s not provided", path, m)
271 NODETEST(curnode->flags & F_TYPE, "type");
272 NODETEST(curnode->flags & F_MODE, "mode");
273 /* XXX: require F_TIME ? */
274 NODETEST(curnode->flags & F_GID ||
275 curnode->flags & F_GNAME, "group");
276 NODETEST(curnode->flags & F_UID ||
277 curnode->flags & F_UNAME, "user");
278 if (curnode->type == F_BLOCK || curnode->type == F_CHAR)
279 NODETEST(curnode->flags & F_DEV,
280 "device number");
281 #undef NODETEST
282
283 if (debug & DEBUG_APPLY_SPECFILE)
284 printf("apply_specdir: adding %s\n",
285 curnode->name);
286 /* build minimal fsnode */
287 memset(&stbuf, 0, sizeof(stbuf));
288 stbuf.st_mode = nodetoino(curnode->type);
289 stbuf.st_nlink = 1;
290 stbuf.st_mtime = stbuf.st_atime =
291 stbuf.st_ctime = start_time.tv_sec;
292 #if HAVE_STRUCT_STAT_ST_MTIMENSEC
293 stbuf.st_mtimensec = stbuf.st_atimensec =
294 stbuf.st_ctimensec = start_time.tv_nsec;
295 #endif
296 curfsnode = create_fsnode(curnode->name, &stbuf);
297 curfsnode->parent = dirnode->parent;
298 curfsnode->first = dirnode;
299 curfsnode->next = dirnode->next;
300 dirnode->next = curfsnode;
301 if (curfsnode->type == S_IFDIR) {
302 /* for dirs, make "." entry as well */
303 curfsnode->child = create_fsnode(".", &stbuf);
304 curfsnode->child->parent = curfsnode;
305 curfsnode->child->first = curfsnode->child;
306 }
307 if (curfsnode->type == S_IFLNK) {
308 assert(curnode->slink != NULL);
309 /* for symlinks, copy the target */
310 if ((curfsnode->symlink =
311 strdup(curnode->slink)) == NULL)
312 err(1, "Memory allocation error");
313 }
314 }
315 apply_specentry(dir, curnode, curfsnode);
316 if (curnode->type == F_DIR) {
317 if (curfsnode->type != S_IFDIR)
318 errx(1, "`%s' is not a directory", path);
319 assert (curfsnode->child != NULL);
320 apply_specdir(path, curnode, curfsnode->child);
321 }
322 }
323 }
324
325 static void
326 apply_specentry(const char *dir, NODE *specnode, fsnode *dirnode)
327 {
328
329 assert(specnode != NULL);
330 assert(dirnode != NULL);
331
332 if (nodetoino(specnode->type) != dirnode->type)
333 errx(1, "`%s/%s' type mismatch: specfile %s, tree %s",
334 dir, specnode->name, inode_type(nodetoino(specnode->type)),
335 inode_type(dirnode->type));
336
337 if (debug & DEBUG_APPLY_SPECENTRY)
338 printf("apply_specentry: %s/%s\n", dir, dirnode->name);
339
340 #define ASEPRINT(t, b, o, n) \
341 if (debug & DEBUG_APPLY_SPECENTRY) \
342 printf("\t\t\tchanging %s from " b " to " b "\n", \
343 t, o, n)
344
345 if (specnode->flags & (F_GID | F_GNAME)) {
346 ASEPRINT("gid", "%d",
347 dirnode->inode->st.st_gid, specnode->st_gid);
348 dirnode->inode->st.st_gid = specnode->st_gid;
349 }
350 if (specnode->flags & F_MODE) {
351 ASEPRINT("mode", "%#o",
352 dirnode->inode->st.st_mode & ALLPERMS, specnode->st_mode);
353 dirnode->inode->st.st_mode &= ~ALLPERMS;
354 dirnode->inode->st.st_mode |= (specnode->st_mode & ALLPERMS);
355 }
356 /* XXX: ignoring F_NLINK for now */
357 if (specnode->flags & F_SIZE) {
358 ASEPRINT("size", "%lld",
359 (long long)dirnode->inode->st.st_size,
360 (long long)specnode->st_size);
361 dirnode->inode->st.st_size = specnode->st_size;
362 }
363 if (specnode->flags & F_SLINK) {
364 assert(dirnode->symlink != NULL);
365 assert(specnode->slink != NULL);
366 ASEPRINT("symlink", "%s", dirnode->symlink, specnode->slink);
367 free(dirnode->symlink);
368 if ((dirnode->symlink = strdup(specnode->slink)) == NULL)
369 err(1, "Memory allocation error");
370 }
371 if (specnode->flags & F_TIME) {
372 ASEPRINT("time", "%ld",
373 (long)dirnode->inode->st.st_mtime,
374 (long)specnode->st_mtimespec.tv_sec);
375 dirnode->inode->st.st_mtime = specnode->st_mtimespec.tv_sec;
376 dirnode->inode->st.st_atime = specnode->st_mtimespec.tv_sec;
377 dirnode->inode->st.st_ctime = start_time.tv_sec;
378 #if HAVE_STRUCT_STAT_ST_MTIMENSEC
379 dirnode->inode->st.st_mtimensec = specnode->st_mtimespec.tv_nsec;
380 dirnode->inode->st.st_atimensec = specnode->st_mtimespec.tv_nsec;
381 dirnode->inode->st.st_ctimensec = start_time.tv_nsec;
382 #endif
383 }
384 if (specnode->flags & (F_UID | F_UNAME)) {
385 ASEPRINT("uid", "%d",
386 dirnode->inode->st.st_uid, specnode->st_uid);
387 dirnode->inode->st.st_uid = specnode->st_uid;
388 }
389 #if HAVE_STRUCT_STAT_ST_FLAGS
390 if (specnode->flags & F_FLAGS) {
391 ASEPRINT("flags", "%#lX",
392 (unsigned long)dirnode->inode->st.st_flags,
393 (unsigned long)specnode->st_flags);
394 dirnode->inode->st.st_flags = specnode->st_flags;
395 }
396 #endif
397 if (specnode->flags & F_DEV) {
398 ASEPRINT("rdev", "%#x",
399 dirnode->inode->st.st_rdev, specnode->st_rdev);
400 dirnode->inode->st.st_rdev = specnode->st_rdev;
401 }
402 #undef ASEPRINT
403
404 dirnode->flags |= FSNODE_F_HASSPEC;
405 }
406
407
408 /*
409 * dump_fsnodes --
410 * dump the fsnodes from `cur', based in the directory `dir'
411 */
412 void
413 dump_fsnodes(const char *dir, fsnode *root)
414 {
415 fsnode *cur;
416 char path[MAXPATHLEN + 1];
417
418 assert (dir != NULL);
419 printf("dump_fsnodes: %s %p\n", dir, root);
420 for (cur = root; cur != NULL; cur = cur->next) {
421 if (snprintf(path, sizeof(path), "%s/%s", dir, cur->name)
422 >= sizeof(path))
423 errx(1, "Pathname too long.");
424
425 if (debug & DEBUG_DUMP_FSNODES_VERBOSE)
426 printf("cur=%8p parent=%8p first=%8p ",
427 cur, cur->parent, cur->first);
428 printf("%7s: %s", inode_type(cur->type), path);
429 if (S_ISLNK(cur->type)) {
430 assert(cur->symlink != NULL);
431 printf(" -> %s", cur->symlink);
432 } else {
433 assert (cur->symlink == NULL);
434 }
435 if (cur->inode->nlink > 1)
436 printf(", nlinks=%d", cur->inode->nlink);
437 putchar('\n');
438
439 if (cur->child) {
440 assert (cur->type == S_IFDIR);
441 dump_fsnodes(path, cur->child);
442 }
443 }
444 printf("dump_fsnodes: finished %s\n", dir);
445 }
446
447
448 /*
449 * inode_type --
450 * for a given inode type `mode', return a descriptive string.
451 * for most cases, uses inotype() from mtree/misc.c
452 */
453 const char *
454 inode_type(mode_t mode)
455 {
456
457 if (S_ISLNK(mode))
458 return ("symlink"); /* inotype() returns "link"... */
459 return (inotype(mode));
460 }
461
462
463 /*
464 * link_check --
465 * return pointer to fsinode matching `entry's st_ino & st_dev if it exists,
466 * otherwise add `entry' to table and return NULL
467 */
468 /* This was borrowed from du.c and tweaked to keep an fsnode
469 * pointer instead. -- dbj (at) netbsd.org
470 */
471 static fsinode *
472 link_check(fsinode *entry)
473 {
474 static struct entry {
475 fsinode *data;
476 } *htable;
477 static int htshift; /* log(allocated size) */
478 static int htmask; /* allocated size - 1 */
479 static int htused; /* 2*number of insertions */
480 int h, h2;
481 uint64_t tmp;
482 /* this constant is (1<<64)/((1+sqrt(5))/2)
483 * aka (word size)/(golden ratio)
484 */
485 const uint64_t HTCONST = 11400714819323198485ULL;
486 const int HTBITS = 64;
487
488 /* Never store zero in hashtable */
489 assert(entry);
490
491 /* Extend hash table if necessary, keep load under 0.5 */
492 if (htused<<1 >= htmask) {
493 struct entry *ohtable;
494
495 if (!htable)
496 htshift = 10; /* starting hashtable size */
497 else
498 htshift++; /* exponential hashtable growth */
499
500 htmask = (1 << htshift) - 1;
501 htused = 0;
502
503 ohtable = htable;
504 htable = calloc(htmask+1, sizeof(*htable));
505 if (!htable)
506 err(1, "Memory allocation error");
507
508 /* populate newly allocated hashtable */
509 if (ohtable) {
510 int i;
511 for (i = 0; i <= htmask>>1; i++)
512 if (ohtable[i].data)
513 link_check(ohtable[i].data);
514 free(ohtable);
515 }
516 }
517
518 /* multiplicative hashing */
519 tmp = entry->st.st_dev;
520 tmp <<= HTBITS>>1;
521 tmp |= entry->st.st_ino;
522 tmp *= HTCONST;
523 h = tmp >> (HTBITS - htshift);
524 h2 = 1 | ( tmp >> (HTBITS - (htshift<<1) - 1)); /* must be odd */
525
526 /* open address hashtable search with double hash probing */
527 while (htable[h].data) {
528 if ((htable[h].data->st.st_ino == entry->st.st_ino) &&
529 (htable[h].data->st.st_dev == entry->st.st_dev)) {
530 return htable[h].data;
531 }
532 h = (h + h2) & htmask;
533 }
534
535 /* Insert the current entry into hashtable */
536 htable[h].data = entry;
537 htused++;
538 return NULL;
539 }
540