namei: Remove extraneous rmdir
[openafs.git] / src / vol / namei_ops.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /* I/O operations for the Unix open by name (namei) interface. */
11
12 #include <afsconfig.h>
13 #include <afs/param.h>
14
15 #include <roken.h>
16
17
18 #ifdef AFS_NAMEI_ENV
19
20 #ifdef HAVE_SYS_FILE_H
21 # include <sys/file.h>
22 #endif
23
24 #ifdef AFS_NT40_ENV
25 #define DELETE_ZLC
26 #include <windows.h>
27 #include <winnt.h>
28 #include <winbase.h>
29 #include <direct.h>
30 #endif
31
32 #include <lock.h>
33 #include <afs/afsutil.h>
34 #include <lwp.h>
35 #include "nfs.h"
36 #include <afs/afsint.h>
37 #include "ihandle.h"
38 #include "vnode.h"
39 #include "volume.h"
40 #include "viceinode.h"
41 #include "voldefs.h"
42 #include "partition.h"
43 #include "fssync.h"
44 #include "volume_inline.h"
45 #include "common.h"
46 #include <afs/errors.h>
47
48 #ifdef AFS_NT40_ENV
49 #include <afs/errmap_nt.h>
50 #endif
51
52 #ifndef LOCK_SH
53 #define   LOCK_SH   1    /* shared lock */
54 #define   LOCK_EX   2    /* exclusive lock */
55 #define   LOCK_NB   4    /* don't block when locking */
56 #define   LOCK_UN   8    /* unlock */
57 #endif
58
59 #ifdef AFS_SALSRV_ENV
60 #include <pthread.h>
61 #include <afs/work_queue.h>
62 #include <afs/thread_pool.h>
63 #include <vol/vol-salvage.h>
64 #endif
65
66 int Testing=0;
67
68
69 afs_sfsize_t
70 namei_iread(IHandle_t * h, afs_foff_t offset, char *buf, afs_fsize_t size)
71 {
72     afs_sfsize_t nBytes;
73     FdHandle_t *fdP;
74
75     fdP = IH_OPEN(h);
76     if (fdP == NULL)
77         return -1;
78
79     nBytes = FDH_PREAD(fdP, buf, size, offset);
80     FDH_CLOSE(fdP);
81     return nBytes;
82 }
83
84 afs_sfsize_t
85 namei_iwrite(IHandle_t * h, afs_foff_t offset, char *buf, afs_fsize_t size)
86 {
87     afs_sfsize_t nBytes;
88     FdHandle_t *fdP;
89
90     fdP = IH_OPEN(h);
91     if (fdP == NULL)
92         return -1;
93
94     nBytes = FDH_PWRITE(fdP, buf, size, offset);
95     FDH_CLOSE(fdP);
96     return nBytes;
97 }
98
99 #ifdef AFS_NT40_ENV
100 /* Inode number format:
101  * low 32 bits - if a regular file or directory, the vnode; else the type.
102  * 32-36 - uniquifier tag and index into counts array for this vnode. Only
103  *         two of the available bits are currently used. The rest are
104  *         present in case we ever increase the number of types of volumes
105  *         in the volume group.
106  * bit 37 : 1  == special, 0 == regular
107  */
108 # define NAMEI_VNODEMASK    0x00ffffffff
109 # define NAMEI_TAGSHIFT     32
110 # define NAMEI_INODESPECIAL 0x2000000000
111 # define NAMEI_SPECDIR "R"
112 # define NAMEI_SPECDIRC 'R'
113 #else /* !AFS_NT40_ENV */
114 /* Inode number format:
115  * low 26 bits - vnode number - all 1's if volume special file.
116  * next 3 bits - tag
117  * next 3 bits spare (0's)
118  * high 32 bits - uniquifier (regular) or type if spare
119  */
120 # define NAMEI_VNODEMASK    0x003ffffff
121 # define NAMEI_TAGSHIFT     26
122 # define NAMEI_UNIQMASK     0xffffffff
123 # define NAMEI_UNIQSHIFT    32
124 # define NAMEI_INODESPECIAL ((Inode)NAMEI_VNODEMASK)
125 /* dir1 is the high 8 bits of the 26 bit vnode */
126 # define VNO_DIR1(vno) ((vno >> 14) & 0xff)
127 /* dir2 is the next 9 bits */
128 # define VNO_DIR2(vno) ((vno >> 9) & 0x1ff)
129 /* "name" is the low 9 bits of the vnode, the 3 bit tag and the uniq */
130 # define NAMEI_SPECDIR "special"
131 #endif /* !AFS_NT40_ENV */
132 #define NAMEI_TAGMASK      0x7
133 #define NAMEI_VNODESPECIAL NAMEI_VNODEMASK
134
135 #define NAMEI_SPECDIRLEN (sizeof(NAMEI_SPECDIR)-1)
136
137 #define NAMEI_MAXVOLS 5         /* Maximum supported number of volumes per volume
138                                  * group, not counting temporary (move) volumes.
139                                  * This is the number of separate files, all having
140                                  * the same vnode number, which can occur in a volume
141                                  * group at once.
142                                  */
143
144 #ifndef AFS_NT40_ENV
145 typedef struct {
146     int ogm_owner;
147     int ogm_group;
148     int ogm_mode;
149 } namei_ogm_t;
150 #endif
151
152 static int GetFreeTag(IHandle_t * ih, int vno);
153
154 /* namei_HandleToInodeDir
155  *
156  * Construct the path name of the directory holding the inode data.
157  * Format: /<vicepx>/INODEDIR
158  *
159  */
160 #ifdef AFS_NT40_ENV
161 static void
162 namei_HandleToInodeDir(namei_t * name, IHandle_t * ih)
163 {
164     memset(name, '\0', sizeof(*name));
165     nt_DevToDrive(name->n_drive, ih->ih_dev);
166     strlcpy(name->n_path, name->n_drive, sizeof(name->n_path));
167 }
168
169 #else
170 /* Format: /<vicepx>/INODEDIR */
171 #define PNAME_BLEN 64
172 static void
173 namei_HandleToInodeDir(namei_t * name, IHandle_t * ih)
174 {
175     size_t offset;
176
177     memset(name, '\0', sizeof(*name));
178
179     /*
180      * Add the /vicepXX string to the start of name->n_base and then calculate
181      * offset as the number of bytes we know we added.
182      *
183      * FIXME: This embeds knowledge of the vice partition naming scheme and
184      * mapping from device numbers.  There needs to be an API that tells us
185      * this offset.
186      */
187     volutil_PartitionName_r(ih->ih_dev, name->n_base, sizeof(name->n_base));
188     offset = VICE_PREFIX_SIZE + (ih->ih_dev > 25 ? 2 : 1);
189     name->n_base[offset] = OS_DIRSEPC;
190     offset++;
191     strlcpy(name->n_base + offset, INODEDIR, sizeof(name->n_base) - offset);
192     strlcpy(name->n_path, name->n_base, sizeof(name->n_path));
193 }
194 #endif
195
196 #define addtoname(N, C)                                         \
197 do {                                                            \
198     if ((N)->n_path[strlen((N)->n_path)-1] != OS_DIRSEPC)       \
199         strlcat((N)->n_path, OS_DIRSEP, sizeof((N)->n_path));   \
200     strlcat((N)->n_path, (C), sizeof((N)->n_path));             \
201 } while(0)
202
203
204 #ifdef AFS_NT40_ENV
205 static void
206 namei_HandleToVolDir(namei_t * name, IHandle_t * ih)
207 {
208     /* X:\Vol_XXXXXXX.data */
209     b32_string_t str1;
210     char *namep;
211
212     namei_HandleToInodeDir(name, ih);
213     /* nt_drive added to name by namei_HandleToInodeDir() */
214     namep = name->n_voldir;
215     (void)memcpy(namep, "\\Vol_", 5);
216     namep += 5;
217     (void)strcpy(namep, int_to_base32(str1, ih->ih_vid));
218     namep += strlen(namep);
219     memcpy(namep, ".data", 5);
220     namep += 5;
221     *namep = '\0';
222     addtoname(name, name->n_voldir);
223 }
224 #else
225 static void
226 namei_HandleToVolDir(namei_t * name, IHandle_t * ih)
227 {
228     lb64_string_t tmp;
229
230     namei_HandleToInodeDir(name, ih);
231     (void)int32_to_flipbase64(tmp, (int64_t) (ih->ih_vid & 0xff));
232     strlcpy(name->n_voldir1, tmp, sizeof(name->n_voldir1));
233     addtoname(name, name->n_voldir1);
234     (void)int32_to_flipbase64(tmp, (int64_t) ih->ih_vid);
235     strlcpy(name->n_voldir2, tmp, sizeof(name->n_voldir2));
236     addtoname(name, name->n_voldir2);
237 }
238 #endif
239
240 /* namei_HandleToName
241  *
242  * Constructs a file name for the fully qualified handle.
243  */
244 #ifdef AFS_NT40_ENV
245 /* Note that special files end up in X:\Vol_XXXXXXX.data\R */
246 void
247 namei_HandleToName(namei_t * name, IHandle_t * ih)
248 {
249     int vno = (int)(ih->ih_ino & NAMEI_VNODEMASK);
250     int special = (ih->ih_ino & NAMEI_INODESPECIAL)?1:0;
251     int tag = (int)((ih->ih_ino >> NAMEI_TAGSHIFT) & NAMEI_TAGMASK);
252     b32_string_t str1;
253     char *namep;
254     namei_HandleToVolDir(name, ih);
255
256     if (special) {
257         name->n_dir[0] = NAMEI_SPECDIRC;
258     } else {
259         if (vno & 0x1)
260             name->n_dir[0] = 'Q';
261         else
262             name->n_dir[0] = ((vno & 0x1f) >> 1) + 'A';
263
264     }
265     name->n_dir[1] = '\0';
266     addtoname(name, name->n_dir);
267     /* X:\Vol_XXXXXXX.data\X\V_XXXXXXX.XXX */
268     namep = name->n_inode;
269     (void)memcpy(namep, "\\V_", 3);
270     namep += 3;
271     (void)strcpy(namep, int_to_base32(str1, vno));
272     namep += strlen(namep);
273     *(namep++) = '.';
274     (void)strcpy(namep, int_to_base32(str1, tag));
275     namep += strlen(namep);
276     addtoname(name, name->n_inode);
277 }
278 #else
279 /* Note that special files end up in /vicepX/InodeDir/Vxx/V*.data/special */
280 void
281 namei_HandleToName(namei_t * name, IHandle_t * ih)
282 {
283     int vno = (int)(ih->ih_ino & NAMEI_VNODEMASK);
284     lb64_string_t str;
285
286     namei_HandleToVolDir(name, ih);
287
288     if (vno == NAMEI_VNODESPECIAL) {
289         strlcpy(name->n_dir1, NAMEI_SPECDIR, sizeof(name->n_dir1));
290         addtoname(name, name->n_dir1);
291         name->n_dir2[0] = '\0';
292     } else {
293         (void)int32_to_flipbase64(str, VNO_DIR1(vno));
294         strlcpy(name->n_dir1, str, sizeof(name->n_dir1));
295         addtoname(name, name->n_dir1);
296         (void)int32_to_flipbase64(str, VNO_DIR2(vno));
297         strlcpy(name->n_dir2, str, sizeof(name->n_dir2));
298         addtoname(name, name->n_dir2);
299     }
300     (void)int64_to_flipbase64(str, (int64_t) ih->ih_ino);
301     strlcpy(name->n_inode, str, sizeof(name->n_inode));
302     addtoname(name, name->n_inode);
303 }
304 #endif
305
306 #ifndef AFS_NT40_ENV
307 /* The following is a warning to tell sys-admins to not muck about in this
308  * name space.
309  */
310 #define VICE_README "These files and directories are a part of the AFS \
311 namespace. Modifying them\nin any way will result in loss of AFS data,\n\
312 ownership and permissions included.\n"
313 int
314 namei_ViceREADME(char *partition)
315 {
316     char filename[32];
317     int fd;
318
319     /* Create the inode directory if we're starting for the first time */
320     snprintf(filename, sizeof filename, "%s" OS_DIRSEP "%s", partition,
321              INODEDIR);
322     mkdir(filename, 0700);
323
324     snprintf(filename, sizeof filename,
325              "%s" OS_DIRSEP "%s" OS_DIRSEP "README",
326              partition, INODEDIR);
327     fd = OS_OPEN(filename, O_WRONLY | O_CREAT | O_TRUNC, 0444);
328     if (fd != INVALID_FD) {
329         (void)OS_WRITE(fd, VICE_README, strlen(VICE_README));
330         OS_CLOSE(fd);
331     }
332     return (errno);
333 }
334 #endif
335
336 /* namei_CreateDataDirectories
337  *
338  * If creating the file failed because of ENOENT or ENOTDIR, try
339  * creating all the directories first.
340  */
341 #ifdef AFS_NT40_ENV
342 static int
343 namei_CreateDataDirectories(namei_t * name, int *created)
344 {
345     char tmp[256];
346     char *s;
347     int i;
348
349     *created = 0;
350     snprintf(tmp, 256, "%s" OS_DIRSEP "%s", name->n_drive, name->n_voldir);
351
352     if (mkdir(tmp) < 0) {
353         if (errno != EEXIST)
354             return -1;
355     } else
356         *created = 1;
357
358     s = tmp;
359     s += strlen(tmp);
360
361     *s++ = OS_DIRSEPC;
362     *(s + 1) = '\0';
363     for (i = 'A'; i <= NAMEI_SPECDIRC; i++) {
364         *s = (char)i;
365         if (mkdir(tmp) < 0 && errno != EEXIST)
366             return -1;
367     }
368     return 0;
369 }
370 #else
371 #define create_dir() \
372 do { \
373     if (mkdir(tmp, 0700)<0) { \
374         if (errno != EEXIST) \
375             return -1; \
376     } \
377     else { \
378         *created = 1; \
379     } \
380 } while (0)
381
382 #define create_nextdir(A) \
383 do { \
384          strcat(tmp, OS_DIRSEP); strcat(tmp, A); create_dir();  \
385 } while(0)
386
387 static int
388 namei_CreateDataDirectories(namei_t * name, int *created)
389 {
390     char tmp[256];
391
392     *created = 0;
393
394     strlcpy(tmp, name->n_base, sizeof(tmp));
395     create_dir();
396
397     create_nextdir(name->n_voldir1);
398     create_nextdir(name->n_voldir2);
399     create_nextdir(name->n_dir1);
400     if (name->n_dir2[0]) {
401         create_nextdir(name->n_dir2);
402     }
403     return 0;
404 }
405 #endif
406
407 #ifndef AFS_NT40_ENV
408 /* delTree(): Deletes an entire tree of directories (no files)
409  * Input:
410  *   root : Full path to the subtree. Should be big enough for PATH_MAX
411  *   tree : the subtree to be deleted is rooted here. Specifies only the
412  *          subtree beginning at tree (not the entire path). It should be
413  *          a pointer into the "root" buffer.
414  * Output:
415  *  errp : errno of the first error encountered during the directory cleanup.
416  *         *errp should have been initialized to 0.
417  *
418  * Return Values:
419  *  -1  : If errors were encountered during cleanup and error is set to
420  *        the first errno.
421  *   0  : Success.
422  *
423  * If there are errors, we try to work around them and delete as many
424  * directories as possible. We don't attempt to remove directories that still
425  * have non-dir entries in them.
426  */
427 static int
428 delTree(char *root, char *tree, int *errp)
429 {
430     char *cp;
431     DIR *ds;
432     struct dirent *dirp;
433     struct afs_stat st;
434
435     if (*tree) {
436         /* delete the children first */
437         cp = strchr(tree, OS_DIRSEPC);
438         if (cp) {
439             delTree(root, cp + 1, errp);
440             *cp = '\0';
441         } else
442             cp = tree + strlen(tree);   /* move cp to the end of string tree */
443
444         /* now delete all entries in this dir */
445         if ((ds = opendir(root)) != (DIR *) NULL) {
446             errno = 0;
447             while ((dirp = readdir(ds))) {
448                 /* ignore . and .. */
449                 if (!strcmp(dirp->d_name, ".") || !strcmp(dirp->d_name, ".."))
450                     continue;
451                 /* since root is big enough, we reuse the space to
452                  * concatenate the dirname to the current tree
453                  */
454                 strcat(root, OS_DIRSEP);
455                 strcat(root, dirp->d_name);
456                 if (afs_stat(root, &st) == 0 && S_ISDIR(st.st_mode)) {
457                     /* delete this subtree */
458                     delTree(root, cp + 1, errp);
459                 } else
460                     *errp = *errp ? *errp : errno;
461
462                 /* recover path to our cur tree by truncating it to
463                  * its original len
464                  */
465                 *cp = 0;
466             }
467             /* if (!errno) -- closedir not implicit if we got an error */
468             closedir(ds);
469         }
470
471         /* finally axe the current dir */
472         if (rmdir(root))
473             *errp = *errp ? *errp : errno;
474
475 #ifndef AFS_PTHREAD_ENV         /* let rx get some work done */
476         IOMGR_Poll();
477 #endif /* !AFS_PTHREAD_ENV */
478
479     }
480
481     /* if valid tree */
482     /* if we encountered errors during cleanup, we return a -1 */
483     if (*errp)
484         return -1;
485
486     return 0;
487
488 }
489 #endif
490
491 /* namei_RemoveDataDirectories
492  * Return Values:
493  * Returns 0 on success.
494  * Returns -1 on error. Typically, callers ignore this error because we
495  * can continue running if the removes fail. The salvage process will
496  * finish tidying up for us.
497  */
498
499 #ifdef AFS_NT40_ENV
500 static int
501 namei_RemoveDataDirectories(namei_t * name)
502 {
503     int code = 0;
504     char *path;
505     char tmp[256];
506     int i;
507
508     snprintf(tmp, 256, "%s" OS_DIRSEP "%s", name->n_drive, name->n_voldir);
509
510     path = tmp;
511     path += strlen(path);
512     *path++ = OS_DIRSEPC;
513     *(path + 1) = '\0';
514     for (i = 'A'; i <= NAMEI_SPECDIRC; i++) {
515         *path = (char)i;
516         if (rmdir(name->n_path) < 0 && errno != ENOENT)
517             code = -1;
518     }
519
520     if (!code) {
521         /* Delete the Vol_NNNNNN.data directory. */
522         path--;
523         *path = '\0';
524         if (rmdir(name->n_path) < 0 && errno != ENOENT) {
525             code = -1;
526         }
527     }
528     return code;
529 }
530 #else
531 /*
532  * We only use the n_base and n_voldir1 entries
533  * and only do rmdir's.
534  */
535 static int
536 namei_RemoveDataDirectories(namei_t * name)
537 {
538     int code = 0;
539     char *path;
540     int prefixlen = strlen(name->n_base), err = 0;
541     int vollen = strlen(name->n_voldir1);
542     char pbuf[MAXPATHLEN];
543
544     path = pbuf;
545
546     strlcpy(path, name->n_path, sizeof(pbuf));
547
548     /* move past the prefix and n_voldir1 */
549     path = path + prefixlen + 1 + vollen + 1;   /* skip over the trailing / */
550
551     /* now delete all dirs upto path */
552     code = delTree(pbuf, path, &err);
553
554     /* We've now deleted everything under /n_base/n_voldir1/n_voldir2 that
555      * we could. Do not delete /n_base/n_voldir1, since doing such might
556      * interrupt another thread trying to create a volume. We could introduce
557      * some locking to make this safe (or only remove it for whole-partition
558      * salvages), but by not deleting it we only leave behind a maximum of
559      * 256 empty directories. So at least for now, don't bother. */
560     return code;
561 }
562 #endif
563
564 /* Create the file in the name space.
565  *
566  * Parameters stored as follows:
567  * Regular files:
568  * p1 - volid - implied in containing directory.
569  * p2 - vnode - name is <vno:31-23>/<vno:22-15>/<vno:15-0><uniq:31-5><tag:2-0>
570  * p3 - uniq -- bits 4-0 are in mode bits 4-0
571  * p4 - dv ---- dv:15-0 in uid, dv:29-16 in gid, dv:31-30 in mode:6-5
572  * Special files:
573  * p1 - volid - creation time - dwHighDateTime
574  * p2 - vnode - -1 means special, file goes in "S" subdirectory.
575  * p3 - type -- name is <type>.<tag> where tag is a file name unqiquifier.
576  * p4 - parid - parent volume id - implied in containing directory.
577  *
578  * Return value is the inode number or (Inode)-1 if error.
579  * We "know" there is only one link table, so return EEXIST if there already
580  * is a link table. It's up to the calling code to test errno and increment
581  * the link count.
582  */
583
584 /* namei_MakeSpecIno
585  *
586  * This function is called by VCreateVolume to hide the implementation
587  * details of the inode numbers. This only allows for 7 volume special
588  * types, but if we get that far, this could should be dead by then.
589  */
590 Inode
591 namei_MakeSpecIno(int volid, int type)
592 {
593     Inode ino;
594     ino = NAMEI_INODESPECIAL;
595 #ifdef AFS_NT40_ENV
596     ino |= type;
597     /* tag is always 0 for special */
598 #else
599     type &= NAMEI_TAGMASK;
600     ino |= ((Inode) type) << NAMEI_TAGSHIFT;
601     ino |= ((Inode) volid) << NAMEI_UNIQSHIFT;
602 #endif
603     return ino;
604 }
605
606 #ifdef AFS_NT40_ENV
607 /* SetOGM */
608 static int
609 SetOGM(FD_t fd, int parm, int tag)
610 {
611     return -1;
612 }
613
614 static int
615 CheckOGM(namei_t *name, FdHandle_t *fdP, int p1)
616 {
617     WIN32_FIND_DATA info;
618     HANDLE dirH;
619
620     dirH =
621         FindFirstFileEx(name->n_path, FindExInfoStandard, &info,
622                         FindExSearchNameMatch, NULL,
623                         FIND_FIRST_EX_CASE_SENSITIVE);
624
625     if (!dirH)
626         return -1;          /* Can't get info, leave alone */
627
628     FindClose(dirH);
629
630     if (info.ftCreationTime.dwHighDateTime != (unsigned int)p1)
631         return -1;
632
633     return 0;
634 }
635 #else /* AFS_NT40_ENV */
636 /* SetOGM - set owner group and mode bits from parm and tag */
637 static int
638 SetOGM(FD_t fd, int parm, int tag)
639 {
640 /*
641  * owner - low 15 bits of parm.
642  * group - next 15 bits of parm.
643  * mode - 2 bits of parm, then lowest = 3 bits of tag.
644  */
645     int owner, group, mode;
646
647     owner = parm & 0x7fff;
648     group = (parm >> 15) & 0x7fff;
649     if (fchown(fd, owner, group) < 0)
650         return -1;
651
652     mode = (parm >> 27) & 0x18;
653     mode |= tag & 0x7;
654     if (fchmod(fd, mode) < 0)
655         return -1;
656     return 0;
657 }
658
659 /* GetOGM - get parm and tag from owner, group and mode bits. */
660 static void
661 GetOGMFromStat(struct afs_stat_st *status, int *parm, int *tag)
662 {
663     *parm = status->st_uid | (status->st_gid << 15);
664     *parm |= (status->st_mode & 0x18) << 27;
665     *tag = status->st_mode & 0x7;
666 }
667
668 static int
669 CheckOGM(namei_t *name, FdHandle_t *fdP, int p1)
670 {
671     struct afs_stat_st status;
672     int parm, tag;
673     if (afs_fstat(fdP->fd_fd, &status) < 0)
674         return -1;
675
676     GetOGMFromStat(&status, &parm, &tag);
677     if (parm != p1)
678         return -1;
679
680     return 0;
681 }
682 #endif /* !AFS_NT40_ENV */
683
684 int big_vno = 0;                /* Just in case we ever do 64 bit vnodes. */
685
686 /* Derive the name and create it O_EXCL. If that fails we have an error.
687  * Get the tag from a free column in the link table.
688  */
689 #ifdef AFS_NT40_ENV
690 Inode
691 namei_icreate(IHandle_t * lh, char *part, afs_uint32 p1, afs_uint32 p2, afs_uint32 p3, afs_uint32 p4)
692 {
693     namei_t name;
694     FD_t fd = INVALID_FD;
695     int code = 0;
696     int created_dir = 0;
697     IHandle_t tmp;
698     FdHandle_t *fdP;
699     FdHandle_t tfd;
700     int type, tag;
701     FILETIME ftime;
702     char *p;
703     b32_string_t str1;
704
705     memset((void *)&tmp, 0, sizeof(IHandle_t));
706     memset(&tfd, 0, sizeof(FdHandle_t));
707
708     tmp.ih_dev = nt_DriveToDev(part);
709     if (tmp.ih_dev == -1) {
710         errno = EINVAL;
711         return -1;
712     }
713
714     if (p2 == INODESPECIAL) {
715         /* Parameters for special file:
716          * p1 - volume id - goes into owner/group/mode
717          * p2 - vnode == INODESPECIAL
718          * p3 - type
719          * p4 - parent volume id
720          */
721         ftime.dwHighDateTime = p1;
722         ftime.dwLowDateTime = p2;
723         type = p3;
724         tmp.ih_vid = p4;        /* Use parent volume id, where this file will be. */
725         tmp.ih_ino = namei_MakeSpecIno(p1, p3);
726     } else {
727         int vno = p2 & NAMEI_VNODEMASK;
728         /* Parameters for regular file:
729          * p1 - volume id
730          * p2 - vnode
731          * p3 - uniq
732          * p4 - dv
733          */
734
735         if (vno != p2) {
736             big_vno++;
737             errno = EINVAL;
738             return -1;
739         }
740
741         tmp.ih_vid = p1;
742         tmp.ih_ino = (Inode) p2;
743         ftime.dwHighDateTime = p3;
744         ftime.dwLowDateTime = p4;
745     }
746
747     namei_HandleToName(&name, &tmp);
748     p = strrchr((char *)&name.n_path, '.');
749     p++;
750     for (tag = 0; tag < NAMEI_MAXVOLS; tag++) {
751         *p = *int_to_base32(str1, tag);
752         fd = OS_OPEN((char *)&name.n_path, O_CREAT | O_RDWR | O_EXCL, 0666);
753         if (fd == INVALID_FD) {
754             if (errno == ENOTDIR || errno == ENOENT) {
755                 if (namei_CreateDataDirectories(&name, &created_dir) == 0)
756                     fd = OS_OPEN((char *)&name.n_path, O_CREAT | O_RDWR | O_EXCL, 0666);
757             }
758         }
759
760         if (fd != INVALID_FD)
761             break;
762         if (p2 == INODESPECIAL && p3 == VI_LINKTABLE)
763             break;
764     }
765     if (fd == INVALID_FD) {
766         code = -1;
767         goto bad;
768     }
769     tmp.ih_ino &= ~(((Inode) NAMEI_TAGMASK) << NAMEI_TAGSHIFT);
770     tmp.ih_ino |= (((Inode) tag) << NAMEI_TAGSHIFT);
771
772     if (!code) {
773         if (!SetFileTime((HANDLE) fd, &ftime, NULL, NULL)) {
774             errno = OS_ERROR(EBADF);
775             code = -1;
776         }
777     }
778
779     if (!code) {
780         if (p2 != INODESPECIAL) {
781             if (fd == INVALID_FD) {
782                 errno = ENOENT;
783                 code = nt_unlink((char *)&name.n_path);
784                 code = -1;
785                 goto bad;
786             }
787             fdP = IH_OPEN(lh);
788             if (fdP == NULL) {
789                 code = -1;
790                 goto bad;
791             }
792             code = namei_SetLinkCount(fdP, tmp.ih_ino, 1, 0);
793             FDH_CLOSE(fdP);
794         } else if (p2 == INODESPECIAL && p3 == VI_LINKTABLE) {
795             if (fd == INVALID_FD)
796                 goto bad;
797             /* hack at tmp to setup for set link count call. */
798             tfd.fd_fd = fd;
799             code = namei_SetLinkCount(&tfd, (Inode) 0, 1, 0);
800         }
801     }
802
803 bad:
804     if (fd != INVALID_FD)
805         OS_CLOSE(fd);
806
807     if (code || (fd == INVALID_FD)) {
808         if (p2 != INODESPECIAL) {
809             fdP = IH_OPEN(lh);
810             if (fdP) {
811                 namei_SetLinkCount(fdP, tmp.ih_ino, 0, 0);
812                 FDH_CLOSE(fdP);
813             }
814         }
815
816         if (created_dir) {
817             int save_errno = errno;
818             namei_RemoveDataDirectories(&name);
819             errno = save_errno;
820         }
821     }
822     return (code || (fd == INVALID_FD)) ? (Inode) -1 : tmp.ih_ino;
823 }
824 #else /* !AFS_NT40_ENV */
825 Inode
826 namei_icreate(IHandle_t * lh, char *part, afs_uint32 p1, afs_uint32 p2, afs_uint32 p3, afs_uint32 p4)
827 {
828     namei_t name;
829     int fd = INVALID_FD;
830     int code = 0;
831     int created_dir = 0;
832     IHandle_t tmp;
833     FdHandle_t *fdP;
834     FdHandle_t tfd;
835     int tag;
836     int ogm_parm;
837
838     memset((void *)&tmp, 0, sizeof(IHandle_t));
839     memset(&tfd, 0, sizeof(FdHandle_t));
840
841     tmp.ih_dev = volutil_GetPartitionID(part);
842     if (tmp.ih_dev == -1) {
843         errno = EINVAL;
844         return -1;
845     }
846
847     if (p2 == -1) {
848         /* Parameters for special file:
849          * p1 - volume id - goes into owner/group/mode
850          * p2 - vnode == -1
851          * p3 - type
852          * p4 - parent volume id
853          */
854         ogm_parm = p1;
855
856         tag = p3;
857         tmp.ih_vid = p4;        /* Use parent volume id, where this file will be. */
858         tmp.ih_ino = namei_MakeSpecIno(p1, p3);
859     } else {
860         int vno = p2 & NAMEI_VNODEMASK;
861         /* Parameters for regular file:
862          * p1 - volume id
863          * p2 - vnode
864          * p3 - uniq
865          * p4 - dv
866          */
867
868         if (vno != p2) {
869             big_vno++;
870             errno = EINVAL;
871             return -1;
872         }
873         /* If GetFreeTag succeeds, it atomically sets link count to 1. */
874         tag = GetFreeTag(lh, p2);
875         if (tag < 0)
876             goto bad;
877
878         tmp.ih_vid = p1;
879         tmp.ih_ino = (Inode) p2;
880         /* name is <uniq(p3)><tag><vno(p2)> */
881         tmp.ih_ino |= ((Inode) tag) << NAMEI_TAGSHIFT;
882         tmp.ih_ino |= ((Inode) p3) << NAMEI_UNIQSHIFT;
883
884         ogm_parm = p4;
885     }
886
887     namei_HandleToName(&name, &tmp);
888     fd = OS_OPEN(name.n_path, O_CREAT | O_EXCL | O_RDWR, 0);
889     if (fd == INVALID_FD) {
890         if (errno == ENOTDIR || errno == ENOENT) {
891             if (namei_CreateDataDirectories(&name, &created_dir) < 0)
892                 goto bad;
893             fd = OS_OPEN(name.n_path, O_CREAT | O_EXCL | O_RDWR,
894                           0);
895             if (fd == INVALID_FD)
896                 goto bad;
897         } else {
898             goto bad;
899         }
900     }
901     if (SetOGM(fd, ogm_parm, tag) < 0) {
902         OS_CLOSE(fd);
903         fd = INVALID_FD;
904         goto bad;
905     }
906
907     if (p2 == (afs_uint32)-1 && p3 == VI_LINKTABLE) {
908         /* hack at tmp to setup for set link count call. */
909         memset((void *)&tfd, 0, sizeof(FdHandle_t));    /* minimalistic still, but a little cleaner */
910         tfd.fd_ih = &tmp;
911         tfd.fd_fd = fd;
912         code = namei_SetLinkCount(&tfd, (Inode) 0, 1, 0);
913     }
914
915   bad:
916     if (fd != INVALID_FD)
917         OS_CLOSE(fd);
918
919
920     if (code || (fd == INVALID_FD)) {
921         if (p2 != -1) {
922             fdP = IH_OPEN(lh);
923             if (fdP) {
924                 namei_SetLinkCount(fdP, tmp.ih_ino, 0, 0);
925                 FDH_CLOSE(fdP);
926             }
927         }
928     }
929     return (code || (fd == INVALID_FD)) ? (Inode) - 1 : tmp.ih_ino;
930 }
931 #endif
932
933 /* namei_iopen */
934 FD_t
935 namei_iopen(IHandle_t * h)
936 {
937     FD_t fd;
938     namei_t name;
939
940     /* Convert handle to file name. */
941     namei_HandleToName(&name, h);
942     fd = OS_OPEN((char *)&name.n_path, O_RDWR, 0666);
943     return fd;
944 }
945
946 /* Need to detect vol special file and just unlink. In those cases, the
947  * handle passed in _is_ for the inode. We only check p1 for the special
948  * files.
949  */
950 int
951 namei_dec(IHandle_t * ih, Inode ino, int p1)
952 {
953     int count = 0;
954     namei_t name;
955     int code = 0;
956     FdHandle_t *fdP;
957
958     if ((ino & NAMEI_INODESPECIAL) == NAMEI_INODESPECIAL) {
959         IHandle_t *tmp;
960         int type = (int)((ino >> NAMEI_TAGSHIFT) & NAMEI_TAGMASK);
961
962         /* Verify this is the right file. */
963         IH_INIT(tmp, ih->ih_dev, ih->ih_vid, ino);
964
965         namei_HandleToName(&name, tmp);
966
967         fdP = IH_OPEN(tmp);
968         if (fdP == NULL) {
969             IH_RELEASE(tmp);
970             errno = OS_ERROR(ENOENT);
971             return -1;
972         }
973
974         if (CheckOGM(&name, fdP, p1) < 0) {
975             FDH_REALLYCLOSE(fdP);
976             IH_RELEASE(tmp);
977             errno = OS_ERROR(EINVAL);
978             return -1;
979         }
980
981         /* If it's the link table itself, decrement the link count. */
982         if (type == VI_LINKTABLE) {
983           if ((count = namei_GetLinkCount(fdP, (Inode) 0, 1, 0, 1)) < 0) {
984                 FDH_REALLYCLOSE(fdP);
985                 IH_RELEASE(tmp);
986                 return -1;
987             }
988
989             count--;
990             if (namei_SetLinkCount(fdP, (Inode) 0, count < 0 ? 0 : count, 1) <
991                 0) {
992                 FDH_REALLYCLOSE(fdP);
993                 IH_RELEASE(tmp);
994                 return -1;
995             }
996
997             if (count > 0) {
998                 FDH_CLOSE(fdP);
999                 IH_RELEASE(tmp);
1000                 return 0;
1001             }
1002         }
1003
1004         if ((code = OS_UNLINK(name.n_path)) == 0) {
1005             if (type == VI_LINKTABLE) {
1006                 /* Try to remove directory. If it fails, that's ok.
1007                  * Salvage will clean up.
1008                  */
1009                 char *slash = strrchr(name.n_path, OS_DIRSEPC);
1010                 if (slash) {
1011                     /* avoid an rmdir() on the file we just unlinked */
1012                     *slash = '\0';
1013                 }
1014                 (void)namei_RemoveDataDirectories(&name);
1015             }
1016         }
1017         FDH_REALLYCLOSE(fdP);
1018         IH_RELEASE(tmp);
1019     } else {
1020         /* Get a file descriptor handle for this Inode */
1021         fdP = IH_OPEN(ih);
1022         if (fdP == NULL) {
1023             return -1;
1024         }
1025
1026         if ((count = namei_GetLinkCount(fdP, ino, 1, 0, 1)) < 0) {
1027             FDH_REALLYCLOSE(fdP);
1028             return -1;
1029         }
1030
1031         count--;
1032         if (count >= 0) {
1033             if (namei_SetLinkCount(fdP, ino, count, 1) < 0) {
1034                 FDH_REALLYCLOSE(fdP);
1035                 return -1;
1036             }
1037         } else {
1038             IHandle_t *th;
1039             IH_INIT(th, ih->ih_dev, ih->ih_vid, ino);
1040             Log("Warning: Lost ref on ihandle dev %d vid %d ino %lld\n",
1041                 th->ih_dev, th->ih_vid, (afs_int64)th->ih_ino);
1042             IH_RELEASE(th);
1043
1044             /* If we're less than 0, someone presumably unlinked;
1045                don't bother setting count to 0, but we need to drop a lock */
1046             if (namei_SetLinkCount(fdP, ino, 0, 1) < 0) {
1047                 FDH_REALLYCLOSE(fdP);
1048                 return -1;
1049             }
1050         }
1051         if (count == 0) {
1052             IHandle_t *th;
1053             IH_INIT(th, ih->ih_dev, ih->ih_vid, ino);
1054
1055             namei_HandleToName(&name, th);
1056             IH_RELEASE(th);
1057             code = OS_UNLINK(name.n_path);
1058         }
1059         FDH_CLOSE(fdP);
1060     }
1061
1062     return code;
1063 }
1064
1065 int
1066 namei_inc(IHandle_t * h, Inode ino, int p1)
1067 {
1068     int count;
1069     int code = 0;
1070     FdHandle_t *fdP;
1071
1072     if ((ino & NAMEI_INODESPECIAL) == NAMEI_INODESPECIAL) {
1073         int type = (int)((ino >> NAMEI_TAGSHIFT) & NAMEI_TAGMASK);
1074         if (type != VI_LINKTABLE)
1075             return 0;
1076         ino = (Inode) 0;
1077     }
1078
1079     /* Get a file descriptor handle for this Inode */
1080     fdP = IH_OPEN(h);
1081     if (fdP == NULL) {
1082         return -1;
1083     }
1084
1085     if ((count = namei_GetLinkCount(fdP, ino, 1, 0, 1)) < 0)
1086         code = -1;
1087     else {
1088         count++;
1089         if (count > 7) {
1090             errno = OS_ERROR(EINVAL);
1091             code = -1;
1092             count = 7;
1093         }
1094         if (namei_SetLinkCount(fdP, ino, count, 1) < 0)
1095             code = -1;
1096     }
1097     if (code) {
1098         FDH_REALLYCLOSE(fdP);
1099     } else {
1100         FDH_CLOSE(fdP);
1101     }
1102     return code;
1103 }
1104
1105 #ifndef AFS_NT40_ENV
1106 int
1107 namei_replace_file_by_hardlink(IHandle_t *hLink, IHandle_t *hTarget)
1108 {
1109     afs_int32 code;
1110     namei_t nameLink;
1111     namei_t nameTarget;
1112
1113     /* Convert handle to file name. */
1114     namei_HandleToName(&nameLink, hLink);
1115     namei_HandleToName(&nameTarget, hTarget);
1116
1117     OS_UNLINK(nameLink.n_path);
1118     code = link(nameTarget.n_path, nameLink.n_path);
1119     return code;
1120 }
1121
1122 int
1123 namei_copy_on_write(IHandle_t *h)
1124 {
1125     afs_int32 code = 0;
1126     FD_t fd;
1127     namei_t name;
1128     FdHandle_t *fdP;
1129     struct afs_stat_st tstat;
1130     afs_foff_t offset;
1131
1132     namei_HandleToName(&name, h);
1133     if (afs_stat(name.n_path, &tstat) < 0)
1134         return EIO;
1135     if (tstat.st_nlink > 1) {                   /* do a copy on write */
1136         char path[259];
1137         char *buf;
1138         afs_size_t size;
1139         ssize_t tlen;
1140
1141         fdP = IH_OPEN(h);
1142         if (!fdP)
1143             return EIO;
1144         snprintf(path, sizeof(path), "%s-tmp", name.n_path);
1145         fd = OS_OPEN(path, O_CREAT | O_EXCL | O_RDWR, 0);
1146         if (fd == INVALID_FD) {
1147             FDH_CLOSE(fdP);
1148             return EIO;
1149         }
1150         buf = malloc(8192);
1151         if (!buf) {
1152             OS_CLOSE(fd);
1153             OS_UNLINK(path);
1154             FDH_CLOSE(fdP);
1155             return ENOMEM;
1156         }
1157         size = tstat.st_size;
1158         offset = 0;
1159         while (size) {
1160             tlen = size > 8192 ? 8192 : size;
1161             if (FDH_PREAD(fdP, buf, tlen, offset) != tlen)
1162                 break;
1163             if (OS_WRITE(fd, buf, tlen) != tlen)
1164                 break;
1165             size -= tlen;
1166             offset += tlen;
1167         }
1168         OS_CLOSE(fd);
1169         FDH_REALLYCLOSE(fdP);
1170         free(buf);
1171         if (size)
1172             code = EIO;
1173         else {
1174             OS_UNLINK(name.n_path);
1175             code = rename(path, name.n_path);
1176         }
1177     }
1178     return code;
1179 }
1180 #endif
1181
1182 /************************************************************************
1183  * File Name Structure
1184  ************************************************************************
1185  *
1186  * Each AFS file needs a unique name and it needs to be findable with
1187  * minimal lookup time. Note that the constraint on the number of files and
1188  * directories in a volume is the size of the vnode index files and the
1189  * max file size AFS supports (for internal files) of 2^31. Since a record
1190  * in the small vnode index file is 64 bytes long, we can have at most
1191  * (2^31)/64 or 33554432 files. A record in the large index file is
1192  * 256 bytes long, giving a maximum of (2^31)/256 = 8388608 directories.
1193  * Another layout parameter is that there is roughly a 16 to 1 ratio between
1194  * the number of files and the number of directories.
1195  *
1196  * Using this information we can see that a layout of 256 directories, each
1197  * with 512 subdirectories and each of those having 512 files gives us
1198  * 256*512*512 = 67108864 AFS files and directories.
1199  *
1200  * The volume, vnode, uniquifier and data version, as well as the tag
1201  * are required, either for finding the file or for salvaging. It's best to
1202  * restrict the name to something that can be mapped into 64 bits so the
1203  * "Inode" is easily comparable (using "==") to other "Inodes". The tag
1204  * is used to distinguish between different versions of the same file
1205  * which are currently in the RW and clones of a volume. See "Link Table
1206  * Organization" below for more information on the tag. The tag is
1207  * required in the name of the file to ensure a unique name.
1208  *
1209  * ifdef AFS_NT40_ENV
1210  * The data for each volume group is in a separate directory. The name of the
1211  * volume is of the form: Vol_NNNNNN.data, where NNNNNN is a base 32
1212  * representation of the RW volume ID (even where the RO is the only volume
1213  * on the partition). Below that are separate subdirectories for the
1214  * AFS directories and special files. There are also 16 directories for files,
1215  * hashed on the low 5 bits (recall bit0 is always 0) of the vnode number.
1216  * These directories are named:
1217  * A - P - 16 file directories.
1218  * Q ----- data directory
1219  * R ----- special files directory
1220  *
1221  * The vnode is hashed into the directory using the low bits of the
1222  * vnode number.
1223  *
1224  * The format of a file name for a regular file is:
1225  * Y:\Vol_NNNNNN.data\X\V_IIIIII.J
1226  * Y - partition encoded as drive letter, starting with D
1227  * NNNNNN - base 32 encoded volume number of RW volume
1228  * X - hash directory, as above
1229  * IIIIII - base 32 encoded vnode number
1230  * J - base 32 encoded tag
1231  *
1232  * uniq is stored in the dwHighDateTime creation time field
1233  * dv is stored in the dwLowDateTime creation time field
1234  *
1235  * Special inodes are always in the R directory, as above, and are
1236  * encoded:
1237  * True child volid is stored in the dwHighDateTime creation time field
1238  * vnode number is always -1 (Special)
1239  * type is the IIIIII part of the filename
1240  * uniq is the J part of the filename
1241  * parent volume id is implied in the containing directory
1242  *
1243  * else
1244  * We can store data in the uid, gid and mode bits of the files, provided
1245  * the directories have root only access. This gives us 15 bits for each
1246  * of uid and gid (GNU chown considers 65535 to mean "don't change").
1247  * There are 9 available mode bits. Adn we need to store a total of
1248  * 32 (volume id) + 26 (vnode) + 32 (uniquifier) + 32 (data-version) + 3 (tag)
1249  * or 131 bits somewhere.
1250  *
1251  * The format of a file name for a regular file is:
1252  * /vicepX/AFSIDat/V1/V2/AA/BB/<tag><uniq><vno>
1253  * V1 - low 8 bits of RW volume id
1254  * V2 - all bits of RW volume id
1255  * AA - high 8 bits of vnode number.
1256  * BB - next 9 bits of vnode number.
1257  * <tag><uniq><vno> - file name
1258  *
1259  * Volume special files are stored in a separate directory:
1260  * /vicepX/AFSIDat/V1/V2/special/<tag><uniq><vno>
1261  *
1262  *
1263  * The vnode is hashed into the directory using the high bits of the
1264  * vnode number. This is so that consecutively created vnodes are in
1265  * roughly the same area on the disk. This will at least be optimal if
1266  * the user is creating many files in the same AFS directory. The name
1267  * should be formed so that the leading characters are different as quickly
1268  * as possible, leading to faster discards of incorrect matches in the
1269  * lookup code.
1270  *
1271  * endif
1272  *
1273  */
1274
1275
1276 /************************************************************************
1277  *  Link Table Organization
1278  ************************************************************************
1279  *
1280  * The link table volume special file is used to hold the link counts that
1281  * are held in the inodes in inode based AFS vice filesystems. For user
1282  * space access, the link counts are being kept in a separate
1283  * volume special file. The file begins with the usual version stamp
1284  * information and is then followed by one row per vnode number. vnode 0
1285  * is used to hold the link count of the link table itself. That is because
1286  * the same link table is shared among all the volumes of the volume group
1287  * and is deleted only when the last volume of a volume group is deleted.
1288  *
1289  * Within each row, the columns are 3 bits wide. They can each hold a 0 based
1290  * link count from 0 through 7. Each colume represents a unique instance of
1291  * that vnode. Say we have a file shared between the RW and a RO and a
1292  * different version of the file (or a different uniquifer) for the BU volume.
1293  * Then one column would be holding the link count of 2 for the RW and RO
1294  * and a different column would hold the link count of 1 for the BU volume.
1295  * # ifdef AFS_NT40_ENV
1296  * The column used is determined for NT by the uniquifier tag applied to
1297  * generate a unique file name in the NTFS namespace. The file name is
1298  * of the form "V_<vno>.<tag>" . And the <tag> is also the column number
1299  * in the link table.
1300  * # else
1301  * Note that we allow only 5 volumes per file, giving 15 bits used in the
1302  * short.
1303  * # endif
1304  */
1305 #define LINKTABLE_WIDTH 2
1306 #define LINKTABLE_SHIFT 1       /* log 2 = 1 */
1307
1308 /**
1309  * compute namei link table file and bit offset from inode number.
1310  *
1311  * @param[in]   ino     inode number
1312  * @param[out]  offset  link table file offset
1313  * @param[out]  index   bit offset within 2-byte record
1314  *
1315  * @internal
1316  */
1317 static void
1318 namei_GetLCOffsetAndIndexFromIno(Inode ino, afs_foff_t * offset, int *index)
1319 {
1320     int toff = (int)(ino & NAMEI_VNODEMASK);
1321     int tindex = (int)((ino >> NAMEI_TAGSHIFT) & NAMEI_TAGMASK);
1322
1323     *offset = (afs_foff_t) ((toff << LINKTABLE_SHIFT) + 8);     /* * 2 + sizeof stamp */
1324     *index = (tindex << 1) + tindex;
1325 }
1326
1327 #ifdef AFS_PTHREAD_ENV
1328 /* XXX do static initializers work for WINNT/pthread? */
1329 pthread_mutex_t _namei_glc_lock = PTHREAD_MUTEX_INITIALIZER;
1330 #define NAMEI_GLC_LOCK MUTEX_ENTER(&_namei_glc_lock)
1331 #define NAMEI_GLC_UNLOCK MUTEX_EXIT(&_namei_glc_lock)
1332 #else /* !AFS_PTHREAD_ENV */
1333 #define NAMEI_GLC_LOCK
1334 #define NAMEI_GLC_UNLOCK
1335 #endif /* !AFS_PTHREAD_ENV */
1336
1337 /**
1338  * get the link count of an inode.
1339  *
1340  * @param[in]  h        namei link count table file handle
1341  * @param[in]  ino      inode number for which we are requesting a link count
1342  * @param[in]  lockit   if asserted, return with lock held on link table file
1343  * @param[in]  fixup    if asserted, write 1 to link count when read() returns
1344  *                      zero (at EOF)
1345  * @param[in]  nowrite  return success on zero byte read or ZLC
1346  *
1347  * @post if lockit asserted and lookup was successful, will return with write
1348  *       lock on link table file descriptor
1349  *
1350  * @return link count
1351  *    @retval -1 namei link table i/o error
1352  *
1353  * @internal
1354  */
1355 int
1356 namei_GetLinkCount(FdHandle_t * h, Inode ino, int lockit, int fixup, int nowrite)
1357 {
1358     unsigned short row = 0;
1359     afs_foff_t offset;
1360     ssize_t rc;
1361     int index;
1362
1363     /* there's no linktable yet. the salvager will create one later */
1364     if (h->fd_fd == INVALID_FD && fixup)
1365        return 1;
1366     namei_GetLCOffsetAndIndexFromIno(ino, &offset, &index);
1367
1368     if (lockit) {
1369         if (FDH_LOCKFILE(h, offset) != 0)
1370             return -1;
1371     }
1372
1373     rc = FDH_PREAD(h, (char*)&row, sizeof(row), offset);
1374     if ((rc == 0 || !((row >> index) & NAMEI_TAGMASK)) && fixup && nowrite)
1375         return 1;
1376     if (rc == 0 && fixup) {
1377         /*
1378          * extend link table and write a link count of 1 for ino
1379          *
1380          * in order to make MT-safe, truncation (extension really)
1381          * must happen under a mutex
1382          */
1383         NAMEI_GLC_LOCK;
1384         if (FDH_SIZE(h) >= offset+sizeof(row)) {
1385             NAMEI_GLC_UNLOCK;
1386             goto bad_getLinkByte;
1387         }
1388         FDH_TRUNC(h, offset+sizeof(row));
1389         row = 1 << index;
1390         rc = FDH_PWRITE(h, (char *)&row, sizeof(row), offset);
1391         NAMEI_GLC_UNLOCK;
1392     }
1393     if (rc != sizeof(row)) {
1394         goto bad_getLinkByte;
1395     }
1396
1397     if (fixup && !((row >> index) & NAMEI_TAGMASK)) {
1398         /*
1399          * fix up zlc
1400          *
1401          * in order to make this mt-safe, we need to do the read-modify-write
1402          * under a mutex.  thus, we repeat the read inside the lock.
1403          */
1404         NAMEI_GLC_LOCK;
1405         rc = FDH_PREAD(h, (char *)&row, sizeof(row), offset);
1406         if (rc == sizeof(row)) {
1407             row |= 1<<index;
1408             rc = FDH_PWRITE(h, (char *)&row, sizeof(row), offset);
1409         }
1410         NAMEI_GLC_UNLOCK;
1411         if (rc != sizeof(row))
1412             goto bad_getLinkByte;
1413     }
1414
1415     return (int)((row >> index) & NAMEI_TAGMASK);
1416
1417   bad_getLinkByte:
1418     if (lockit)
1419         FDH_UNLOCKFILE(h, offset);
1420     return -1;
1421 }
1422
1423 int
1424 namei_SetNonZLC(FdHandle_t * h, Inode ino)
1425 {
1426     return namei_GetLinkCount(h, ino, 0, 1, 0);
1427 }
1428
1429 /* Return a free column index for this vnode. */
1430 static int
1431 GetFreeTag(IHandle_t * ih, int vno)
1432 {
1433     FdHandle_t *fdP;
1434     afs_foff_t offset;
1435     int col;
1436     int coldata;
1437     short row;
1438     ssize_t nBytes;
1439
1440
1441     fdP = IH_OPEN(ih);
1442     if (fdP == NULL)
1443         return -1;
1444
1445     /* Only one manipulates at a time. */
1446     if (FDH_LOCKFILE(fdP, offset) != 0) {
1447         FDH_REALLYCLOSE(fdP);
1448         return -1;
1449     }
1450
1451     offset = (vno << LINKTABLE_SHIFT) + 8;      /* * 2 + sizeof stamp */
1452
1453     nBytes = FDH_PREAD(fdP, (char *)&row, sizeof(row), offset);
1454     if (nBytes != sizeof(row)) {
1455         if (nBytes != 0)
1456             goto badGetFreeTag;
1457         row = 0;
1458     }
1459
1460     /* Now find a free column in this row and claim it. */
1461     for (col = 0; col < NAMEI_MAXVOLS; col++) {
1462         coldata = 7 << (col * 3);
1463         if ((row & coldata) == 0)
1464             break;
1465     }
1466     if (col >= NAMEI_MAXVOLS) {
1467         errno = ENOSPC;
1468         goto badGetFreeTag;
1469     }
1470
1471     coldata = 1 << (col * 3);
1472     row |= coldata;
1473
1474     if (FDH_PWRITE(fdP, (char *)&row, sizeof(row), offset) != sizeof(row)) {
1475         goto badGetFreeTag;
1476     }
1477     FDH_SYNC(fdP);
1478     FDH_UNLOCKFILE(fdP, offset);
1479     FDH_CLOSE(fdP);
1480     return col;
1481
1482   badGetFreeTag:
1483     FDH_UNLOCKFILE(fdP, offset);
1484     FDH_REALLYCLOSE(fdP);
1485     return -1;
1486 }
1487
1488
1489
1490 /* namei_SetLinkCount
1491  * If locked is set, assume file is locked. Otherwise, lock file before
1492  * proceeding to modify it.
1493  */
1494 int
1495 namei_SetLinkCount(FdHandle_t * fdP, Inode ino, int count, int locked)
1496 {
1497     afs_foff_t offset;
1498     int index;
1499     unsigned short row;
1500     int bytesRead;
1501     ssize_t nBytes = -1;
1502
1503     namei_GetLCOffsetAndIndexFromIno(ino, &offset, &index);
1504
1505     if (!locked) {
1506         if (FDH_LOCKFILE(fdP, offset) != 0) {
1507             return -1;
1508         }
1509     }
1510
1511     nBytes = FDH_PREAD(fdP, (char *)&row, sizeof(row), offset);
1512     if (nBytes != sizeof(row)) {
1513         if (nBytes != 0) {
1514             errno = OS_ERROR(EBADF);
1515             goto bad_SetLinkCount;
1516         }
1517         row = 0;
1518     }
1519
1520     bytesRead = 7 << index;
1521     count <<= index;
1522     row &= (unsigned short)~bytesRead;
1523     row |= (unsigned short)count;
1524
1525     if (FDH_PWRITE(fdP, (char *)&row, sizeof(short), offset) != sizeof(short)) {
1526         errno = OS_ERROR(EBADF);
1527         goto bad_SetLinkCount;
1528     }
1529     FDH_SYNC(fdP);
1530
1531     nBytes = 0;
1532
1533
1534   bad_SetLinkCount:
1535     FDH_UNLOCKFILE(fdP, offset);
1536
1537     /* disallowed above 7, so... */
1538     return (int)nBytes;
1539 }
1540
1541
1542 /* ListViceInodes - write inode data to a results file. */
1543 static int DecodeInode(char *dpath, char *name, struct ViceInodeInfo *info,
1544                        unsigned int volid);
1545 static int DecodeVolumeName(char *name, unsigned int *vid);
1546 static int namei_ListAFSSubDirs(IHandle_t * dirIH,
1547                                 int (*write_fun) (FD_t,
1548                                                   struct ViceInodeInfo *,
1549                                                   char *, char *), FD_t fp,
1550                                 int (*judgeFun) (struct ViceInodeInfo *,
1551                                                  afs_uint32 vid, void *),
1552                                 afs_uint32 singleVolumeNumber, void *rock);
1553
1554
1555 /* WriteInodeInfo
1556  *
1557  * Write the inode data to the results file.
1558  *
1559  * Returns -2 on error, 0 on success.
1560  *
1561  * This is written as a callback simply so that other listing routines
1562  * can use the same inode reading code.
1563  */
1564 static int
1565 WriteInodeInfo(FD_t fp, struct ViceInodeInfo *info, char *dir, char *name)
1566 {
1567     size_t n;
1568     n = OS_WRITE(fp, info, sizeof(*info));
1569     return (n == sizeof(*info)) ? 0 : -2;
1570 }
1571
1572
1573 int mode_errors;                /* Number of errors found in mode bits on directories. */
1574 void
1575 VerifyDirPerms(char *path)
1576 {
1577     struct afs_stat_st status;
1578
1579     if (afs_stat(path, &status) < 0) {
1580         Log("Unable to stat %s. Please manually verify mode bits for this"
1581             " directory\n", path);
1582     } else {
1583         if (((status.st_mode & 0777) != 0700) || (status.st_uid != 0))
1584             mode_errors++;
1585     }
1586 }
1587
1588 /**
1589  * Fill the results file with the requested inode information.
1590  *
1591  * This code optimizes single volume salvages by just looking at that one
1592  * volume's directory.
1593  *
1594  * @param[in]   devname             device name string
1595  * @param[in]   moutnedOn           vice partition mount point
1596  * @param[in]   resultFile          result file in which to write inode
1597  *                                  metadata.  If NULL, write routine is not
1598  *                                  called.
1599  * @param[in]   judgeInode          filter function pointer.  if not NULL, only
1600  *                                  inodes for which this routine returns non-
1601  *                                  zero will be written to the results file.
1602  * @param[in]   singleVolumeNumber  volume id filter
1603  * @param[out]  forcep              always set to 0 for namei impl
1604  * @param[in]   forceR              not used by namei impl
1605  * @param[in]   wpath               not used by namei impl
1606  * @param[in]   rock                opaque pointer passed to judgeInode
1607  *
1608  * @return operation status
1609  *    @retval 0   success
1610  *    @retval -1  complete failure, salvage should terminate.
1611  *    @retval -2  not enough space on partition, salvager has error message
1612  *                for this.
1613  */
1614 int
1615 ListViceInodes(char *devname, char *mountedOn, FD_t inodeFile,
1616                int (*judgeInode) (struct ViceInodeInfo * info, afs_uint32 vid, void *rock),
1617                afs_uint32 singleVolumeNumber, int *forcep, int forceR, char *wpath,
1618                void *rock)
1619 {
1620     int ninodes;
1621
1622     *forcep = 0; /* no need to salvage until further notice */
1623
1624     /* Verify protections on directories. */
1625     mode_errors = 0;
1626     VerifyDirPerms(mountedOn);
1627
1628     ninodes =
1629         namei_ListAFSFiles(mountedOn, WriteInodeInfo, inodeFile, judgeInode,
1630                            singleVolumeNumber, rock);
1631
1632     if (inodeFile == INVALID_FD)
1633         return ninodes;
1634
1635     if (ninodes < 0) {
1636         return ninodes;
1637     }
1638
1639     if (OS_SYNC(inodeFile) == -1) {
1640         Log("Unable to successfully fsync inode file for %s\n", mountedOn);
1641         return -2;
1642     }
1643
1644     /*
1645      * Paranoia:  check that the file is really the right size
1646      */
1647     if (OS_SIZE(inodeFile) != ninodes * sizeof(struct ViceInodeInfo)) {
1648         Log("Wrong size (%d instead of %lu) in inode file for %s\n",
1649             (int) OS_SIZE(inodeFile),
1650             (long unsigned int) ninodes * sizeof(struct ViceInodeInfo),
1651             mountedOn);
1652         return -2;
1653     }
1654     return 0;
1655 }
1656
1657
1658 /**
1659  * Collect all the matching AFS files on the drive.
1660  * If singleVolumeNumber is non-zero, just return files for that volume.
1661  *
1662  * @param[in] dev                 vice partition path
1663  * @param[in] writeFun            function pointer to a function which
1664  *                                writes inode information to FILE fp
1665  * @param[in] fp                  file stream where inode metadata is sent
1666  * @param[in] judgeFun            filter function pointer.  if not NULL,
1667  *                                only entries for which a non-zero value
1668  *                                is returned are written to fp
1669  * @param[in] singleVolumeNumber  volume id filter.  if nonzero, only
1670  *                                process files for that specific volume id
1671  * @param[in] rock                opaque pointer passed into writeFun and
1672  *                                judgeFun
1673  *
1674  * @return operation status
1675  *    @retval <0 error
1676  *    @retval >=0 number of matching files found
1677  */
1678 int
1679 namei_ListAFSFiles(char *dev,
1680                    int (*writeFun) (FD_t, struct ViceInodeInfo *, char *,
1681                                     char *),
1682                    FD_t fp,
1683                    int (*judgeFun) (struct ViceInodeInfo *, afs_uint32, void *),
1684                    afs_uint32 singleVolumeNumber, void *rock)
1685 {
1686     IHandle_t ih;
1687     namei_t name;
1688     int ninodes = 0;
1689     DIR *dirp1;
1690     struct dirent *dp1;
1691 #ifndef AFS_NT40_ENV
1692     DIR *dirp2;
1693     struct dirent *dp2;
1694     char path2[512];
1695 #endif
1696 #ifdef DELETE_ZLC
1697     static void FreeZLCList(void);
1698 #endif
1699
1700     memset((void *)&ih, 0, sizeof(IHandle_t));
1701 #ifdef AFS_NT40_ENV
1702     ih.ih_dev = nt_DriveToDev(dev);
1703 #else
1704     ih.ih_dev = volutil_GetPartitionID(dev);
1705 #endif
1706
1707     if (singleVolumeNumber) {
1708         ih.ih_vid = singleVolumeNumber;
1709         namei_HandleToVolDir(&name, &ih);
1710         ninodes =
1711             namei_ListAFSSubDirs(&ih, writeFun, fp, judgeFun,
1712                                  singleVolumeNumber, rock);
1713         if (ninodes < 0)
1714             return ninodes;
1715     } else {
1716         /* Find all volume data directories and descend through them. */
1717         namei_HandleToInodeDir(&name, &ih);
1718         ninodes = 0;
1719         dirp1 = opendir(name.n_path);
1720         if (!dirp1)
1721             return 0;
1722         while ((dp1 = readdir(dirp1))) {
1723 #ifdef AFS_NT40_ENV
1724             /* Heirarchy is one level on Windows */
1725             if (!DecodeVolumeName(dp1->d_name, &ih.ih_vid)) {
1726                 ninodes +=
1727                     namei_ListAFSSubDirs(&ih, writeFun, fp, judgeFun,
1728                                          0, rock);
1729             }
1730 #else
1731             if (*dp1->d_name == '.')
1732                 continue;
1733             snprintf(path2, sizeof(path2), "%s" OS_DIRSEP "%s", name.n_path,
1734                      dp1->d_name);
1735             dirp2 = opendir(path2);
1736             if (dirp2) {
1737                 while ((dp2 = readdir(dirp2))) {
1738                     if (*dp2->d_name == '.')
1739                         continue;
1740                     if (!DecodeVolumeName(dp2->d_name, &ih.ih_vid)) {
1741                         ninodes +=
1742                             namei_ListAFSSubDirs(&ih, writeFun, fp, judgeFun,
1743                                                  0, rock);
1744                     }
1745                 }
1746                 closedir(dirp2);
1747             }
1748 #endif
1749         }
1750         closedir(dirp1);
1751     }
1752 #ifdef DELETE_ZLC
1753     FreeZLCList();
1754 #endif
1755     return ninodes;
1756 }
1757
1758 #ifdef DELETE_ZLC
1759 static void AddToZLCDeleteList(char dir, char *name);
1760 static void DeleteZLCFiles(char *path);
1761 #endif
1762
1763 /**
1764  * examine a namei volume special file.
1765  *
1766  * @param[in] path1               volume special directory path
1767  * @param[in] dname               directory entry name
1768  * @param[in] myIH                inode handle to volume directory
1769  * @param[out] linkHandle         namei link count fd handle.  if
1770  *                                the inode in question is the link
1771  *                                table, then the FdHandle is populated
1772  * @param[in] writeFun            metadata write function pointer
1773  * @param[in] fp                  file pointer where inode metadata
1774  *                                is written by (*writeFun)()
1775  * @param[in] judgeFun            inode filter function pointer.  if
1776  *                                not NULL, only inodes for which this
1777  *                                function returns non-zero are recorded
1778  *                                into fp by writeFun
1779  * @param[in] singleVolumeNumer   volume id filter.  if non-zero, only
1780  *                                inodes associated with this volume id
1781  *                                are recorded by writeFun
1782  * @param[in] rock                opaque pointer passed to writeFun and
1783  *                                judgeFun
1784  *
1785  * @return operation status
1786  *    @retval 1 count this inode
1787  *    @retval 0 don't count this inode
1788  *    @retval -1 failure
1789  *
1790  * @internal
1791  */
1792 static int
1793 _namei_examine_special(char * path1,
1794                        char * dname,
1795                        IHandle_t * myIH,
1796                        FdHandle_t * linkHandle,
1797                        int (*writeFun) (FD_t, struct ViceInodeInfo *, char *,
1798                                         char *),
1799                        FD_t fp,
1800                        int (*judgeFun) (struct ViceInodeInfo *, afs_uint32, void *),
1801                        int singleVolumeNumber,
1802                        void *rock)
1803 {
1804     int ret = 0;
1805     struct ViceInodeInfo info;
1806     afs_uint32 inode_vgid;
1807
1808     if (DecodeInode(path1, dname, &info, myIH->ih_vid) < 0) {
1809         ret = 0;
1810         goto error;
1811     }
1812
1813 #ifdef AFS_NT40_ENV
1814     inode_vgid = myIH->ih_vid;
1815 #else
1816     inode_vgid = (info.inodeNumber >> NAMEI_UNIQSHIFT) & NAMEI_UNIQMASK;
1817 #endif
1818
1819     if (info.u.param[2] != VI_LINKTABLE) {
1820         info.linkCount = 1;
1821     } else if ((info.u.param[0] != myIH->ih_vid) ||
1822                (inode_vgid != myIH->ih_vid)) {
1823         /* VGID encoded in linktable filename and/or OGM data isn't
1824          * consistent with VGID encoded in namei path */
1825         Log("namei_ListAFSSubDirs: warning: inconsistent linktable "
1826             "filename \"%s" OS_DIRSEP "%s\"; salvager will delete it "
1827             "(dir_vgid=%u, inode_vgid=%u, ogm_vgid=%u)\n",
1828             path1, dname, myIH->ih_vid,
1829             (unsigned int)inode_vgid,
1830             info.u.param[0]);
1831     } else {
1832         char path2[512];
1833         /* Open this handle */
1834         snprintf(path2, sizeof(path2),
1835                  "%s" OS_DIRSEP "%s", path1, dname);
1836         linkHandle->fd_fd = OS_OPEN(path2, Testing ? O_RDONLY : O_RDWR, 0666);
1837         info.linkCount =
1838             namei_GetLinkCount(linkHandle, (Inode) 0, 1, 1, Testing);
1839     }
1840
1841     if (!judgeFun ||
1842         (*judgeFun) (&info, singleVolumeNumber, rock)) {
1843         ret = (*writeFun) (fp, &info, path1, dname);
1844         if (ret < 0) {
1845             Log("_namei_examine_special: writeFun returned %d\n", ret);
1846             ret = -1;
1847         } else {
1848             ret = 1;
1849         }
1850     }
1851
1852  error:
1853     return ret;
1854 }
1855
1856 /**
1857  * examine a namei file.
1858  *
1859  * @param[in] path3               volume special directory path
1860  * @param[in] dname               directory entry name
1861  * @param[in] myIH                inode handle to volume directory
1862  * @param[in] linkHandle          namei link count fd handle.
1863  * @param[in] writeFun            metadata write function pointer
1864  * @param[in] fp                  file pointer where inode metadata
1865  *                                is written by (*writeFun)()
1866  * @param[in] judgeFun            inode filter function pointer.  if
1867  *                                not NULL, only inodes for which this
1868  *                                function returns non-zero are recorded
1869  *                                into fp by writeFun
1870  * @param[in] singleVolumeNumer   volume id filter.  if non-zero, only
1871  *                                inodes associated with this volume id
1872  *                                are recorded by writeFun
1873  * @param[in] rock                opaque pointer passed to writeFun and
1874  *                                judgeFun
1875  *
1876  * @return operation status
1877  *    @retval 1 count this inode
1878  *    @retval 0 don't count this inode
1879  *    @retval -1 failure
1880  *    @retval -2 request ZLC delete
1881  *
1882  * @internal
1883  */
1884 static int
1885 _namei_examine_reg(char * path3,
1886                    char * dname,
1887                    IHandle_t * myIH,
1888                    FdHandle_t * linkHandle,
1889                    int (*writeFun) (FD_t, struct ViceInodeInfo *, char *,
1890                                     char *),
1891                    FD_t fp,
1892                    int (*judgeFun) (struct ViceInodeInfo *, afs_uint32, void *),
1893                    int singleVolumeNumber,
1894                    void *rock)
1895 {
1896     int ret = 0;
1897     struct ViceInodeInfo info;
1898 #ifdef DELETE_ZLC
1899     int dirl; /* Windows-only (one level hash dir) */
1900 #endif
1901
1902     if (DecodeInode(path3, dname, &info, myIH->ih_vid) < 0) {
1903         goto error;
1904     }
1905
1906     info.linkCount =
1907         namei_GetLinkCount(linkHandle,
1908                             info.inodeNumber, 1, 1, Testing);
1909     if (info.linkCount == 0) {
1910 #ifdef DELETE_ZLC
1911         Log("Found 0 link count file %s" OS_DIRSEP "%s, deleting it.\n", path3, dname);
1912 #ifdef AFS_SALSRV_ENV
1913         /* defer -- the AddToZLCDeleteList() interface is not MT-safe */
1914         ret = -2;
1915 #else /* !AFS_SALSRV_ENV */
1916         dirl = path3[strlen(path3)-1];
1917         AddToZLCDeleteList((char)dirl, dname);
1918 #endif /* !AFS_SALSRV_ENV */
1919 #else /* !DELETE_ZLC */
1920         Log("Found 0 link count file %s" OS_DIRSEP "%s.\n", path3,
1921             dname);
1922 #endif
1923         goto error;
1924     }
1925
1926     if (!judgeFun ||
1927         (*judgeFun) (&info, singleVolumeNumber, rock)) {
1928         ret = (*writeFun) (fp, &info, path3, dname);
1929         if (ret < 0) {
1930             Log("_namei_examine_reg: writeFun returned %d\n", ret);
1931             ret = -1;
1932         } else {
1933             ret = 1;
1934         }
1935     }
1936
1937  error:
1938     return ret;
1939 }
1940
1941 /**
1942  * listsubdirs work queue node.
1943  */
1944 struct listsubdirs_work_node {
1945 #ifdef AFS_SALSRV_ENV
1946     int *error;                         /**< *error set if an error was
1947                                          *   encountered in any listsubdirs
1948                                          *   thread. */
1949 #endif
1950
1951     IHandle_t * IH;                     /**< volume directory handle */
1952     FdHandle_t *linkHandle;             /**< namei link count fd handle. when
1953                                          *   examinining the link table special
1954                                          *   inode, this will be pointed at the
1955                                          *   link table
1956                                          */
1957     FD_t fp;                            /**< file pointer for writeFun */
1958
1959     /** function which will write inode metadata to fp */
1960     int (*writeFun) (FD_t, struct ViceInodeInfo *, char *, char *);
1961
1962     /** inode filter function */
1963     int (*judgeFun) (struct ViceInodeInfo *, afs_uint32, void *);
1964     int singleVolumeNumber;             /**< volume id filter */
1965     void * rock;                        /**< pointer passed to writeFun and judgeFun */
1966     int code;                           /**< return code from examine function */
1967     int special;                        /**< asserted when this is a volume
1968                                          *   special file */
1969 };
1970
1971 /**
1972  * simple wrapper around _namei_examine_special and _namei_examine_reg.
1973  *
1974  * @param[in] work  the struct listsubdirs_work_node for the associated
1975  *                  "list subdirs" job
1976  * @param[in] dir   the directory to examine
1977  * @param[in] filename  the filename in 'dir' to examine
1978  *
1979  * @return operation status
1980  *   @retval 1  count this inode
1981  *   @retval 0  don't count this inode
1982  *   @retval -1 failure
1983  */
1984 static_inline int
1985 _namei_examine_file(const struct listsubdirs_work_node *work, char *dir,
1986                     char *filename)
1987 {
1988     if (work->special) {
1989         return _namei_examine_special(dir, filename, work->IH,
1990                                       work->linkHandle, work->writeFun, work->fp,
1991                                       work->judgeFun, work->singleVolumeNumber,
1992                                       work->rock);
1993     } else {
1994         return _namei_examine_reg(dir, filename, work->IH,
1995                                   work->linkHandle, work->writeFun, work->fp,
1996                                   work->judgeFun, work->singleVolumeNumber,
1997                                   work->rock);
1998     }
1999 }
2000
2001
2002 #ifdef AFS_SALSRV_ENV
2003 /** @addtogroup afs_vol_salsrv_pario */
2004 /*@{*/
2005
2006 /**
2007  * arguments for the _namei_examine_file_cbk callback function.
2008  */
2009 struct listsubdirs_args {
2010     const struct listsubdirs_work_node *work; /**< arguments that are the same
2011                                                *   for all invocations of
2012                                                *   _namei_examine_file_cbk, in
2013                                                *   threads */
2014     int *result;        /**< where we can store the return code of _namei_examine_file */
2015
2016     char dir[512];      /**< directory to examine */
2017     char filename[256]; /**< filename in 'dir' to examine */
2018 };
2019
2020 /**
2021  * a node in the list of results of listsubdir jobs.
2022  */
2023 struct listsubdirs_result {
2024     struct rx_queue q;
2025     int inodes;        /**< return value from _namei_examine_file */
2026 };
2027
2028 /**
2029  * clean up a list of 'struct listsubdirs_result's and interpret the results.
2030  *
2031  * @param[in] resultlist  a list of 'struct listsubdirs_result's
2032  *
2033  * @return number of inodes found
2034  *   @retval -1  error
2035  */
2036 static int
2037 _namei_listsubdirs_cleanup_results(struct rx_queue *resultlist)
2038 {
2039     struct listsubdirs_result *res, *nres;
2040     int ret = 0;
2041
2042     for(queue_Scan(resultlist, res, nres, listsubdirs_result)) {
2043         if (ret < 0) {
2044             /* noop, retain erroneous error code */
2045         } else if (res->inodes < 0) {
2046             ret = -1;
2047         } else {
2048             ret += res->inodes;
2049         }
2050
2051         queue_Remove(res);
2052         free(res);
2053         res = NULL;
2054     }
2055
2056     return ret;
2057 }
2058
2059 /**
2060  * wait for the spawned listsubdirs jobs to finish, and return how many inodes
2061  * they found.
2062  *
2063  * @param[in] queue    queue to wait to finish
2064  * @param[in] resultlist list of 'struct listsubdirs_result's that the queued
2065  *                       jobs are storing their results in
2066  *
2067  * @return number of inodes found
2068  *   @retval -1  error
2069  */
2070 static int
2071 _namei_listsubdirs_wait(struct afs_work_queue *queue, struct rx_queue *resultlist)
2072 {
2073     int code;
2074
2075     code = afs_wq_wait_all(queue);
2076     if (code) {
2077         return -1;
2078     }
2079
2080     return _namei_listsubdirs_cleanup_results(resultlist);
2081 }
2082
2083 /**
2084  * work queue entry point for examining namei files.
2085  *
2086  * @param[in] queue        pointer to struct Vwork_queue
2087  * @param[in] node         pointer to struct Vwork_queue_node
2088  * @param[in] queue_rock   opaque pointer to struct salsrv_pool_state
2089  * @param[in] node_rock    opaque pointer to struct listsubdirs_work_node
2090  * @param[in] caller_rock  opaque pointer to struct salsrv_worker_thread_state
2091  *
2092  * @return operation status
2093  *
2094  * @see Vwork_queue_callback_func_t
2095  *
2096  * @internal
2097  */
2098 static int
2099 _namei_examine_file_cbk(struct afs_work_queue *queue,
2100                         struct afs_work_queue_node *node,
2101                         void *queue_rock,
2102                         void *node_rock,
2103                         void *caller_rock)
2104 {
2105     int code;
2106     struct listsubdirs_args *args = node_rock;
2107     const struct listsubdirs_work_node * work = args->work;
2108     char *dir = args->dir;
2109     char *filename = args->filename;
2110
2111     code = _namei_examine_file(work, dir, filename);
2112
2113     *(args->result) = code;
2114
2115     if (code < 0) {
2116         *(work->error) = 1;
2117         /* we've errored, so no point in letting more jobs continue */
2118         afs_wq_shutdown(queue);
2119     }
2120
2121     return 0;
2122 }
2123
2124 static pthread_once_t wq_once = PTHREAD_ONCE_INIT;
2125 static pthread_key_t wq_key;
2126
2127 /**
2128  * create the wq_key key for storing a work queue.
2129  */
2130 static void
2131 _namei_wq_keycreate(void)
2132 {
2133     osi_Assert(pthread_key_create(&wq_key, NULL) == 0);
2134 }
2135
2136 /**
2137  * set the work queue for this thread to use for backgrounding namei ops.
2138  *
2139  * The work queue will be used in ListAFSSubdirs (called indirectly by
2140  * ListViceInodes) to examine files in parallel.
2141  *
2142  * @param[in] wq  the work queue to use
2143  */
2144 void
2145 namei_SetWorkQueue(struct afs_work_queue *wq)
2146 {
2147     osi_Assert(pthread_once(&wq_once, _namei_wq_keycreate) == 0);
2148
2149     osi_Assert(pthread_setspecific(wq_key, wq) == 0);
2150 }
2151
2152 /**
2153  * enqueue an examine file work unit.
2154  *
2155  * @param[in] work     the _namei_examine_file arguments that are common to
2156  *                     all callers within the same ListAFSFiles operation
2157  * @param[in] dir      the specific directory to look at (string will be
2158  *                     copied; can be stack/temporary memory)
2159  * @param[in] filename the filename to look at (string will be copied; can be
2160  *                     stack/temporary memory)
2161  * @param[in] wq       work queue to enqueue this work unit to
2162  * @param[in] resultlist the list to append the 'struct listsubdirs_result' to
2163  *                       for the enqueued work unit
2164  *
2165  * @return operation status
2166  *    @retval 0 success
2167  *    @retval -1 fatal error
2168  *
2169  * @note errors MUST be indicated by a -1 error code and nothing else, to be
2170  *       compatible with _namei_examine_reg and _namei_examine_special
2171  *
2172  * @internal
2173  */
2174 static int
2175 _namei_examine_file_spawn(const struct listsubdirs_work_node *work,
2176                           const char *dir, const char *filename,
2177                           struct afs_work_queue *wq,
2178                           struct rx_queue *resultlist)
2179 {
2180     int code, ret = 0;
2181     struct listsubdirs_args *args = NULL;
2182     struct listsubdirs_result *result = NULL;
2183     struct afs_work_queue_node *node = NULL;
2184     struct afs_work_queue_add_opts opts;
2185
2186     args = malloc(sizeof(*args));
2187     if (args == NULL) {
2188         ret = -1;
2189         goto error;
2190     }
2191
2192     result = malloc(sizeof(*result));
2193     if (result == NULL) {
2194         ret = -1;
2195         goto error;
2196     }
2197
2198     code = afs_wq_node_alloc(&node);
2199     if (code) {
2200         ret = -1;
2201         goto error;
2202     }
2203     code = afs_wq_node_set_detached(node);
2204     if (code) {
2205         ret = -1;
2206         goto error;
2207     }
2208
2209     args->work = work;
2210     args->result = &result->inodes;
2211     strlcpy(args->dir, dir, sizeof(args->dir));
2212     strlcpy(args->filename, filename, sizeof(args->filename));
2213
2214     code = afs_wq_node_set_callback(node,
2215                                          &_namei_examine_file_cbk,
2216                                          args, &free);
2217     if (code) {
2218         ret = -1;
2219         goto error;
2220     }
2221     args = NULL;
2222
2223     afs_wq_add_opts_init(&opts);
2224     opts.donate = 1;
2225
2226     code = afs_wq_add(wq, node, &opts);
2227     if (code) {
2228         ret = -1;
2229         goto error;
2230     }
2231     node = NULL;
2232
2233     queue_Append(resultlist, result);
2234     result = NULL;
2235
2236  error:
2237     if (node) {
2238         afs_wq_node_put(node);
2239         node = NULL;
2240     }
2241     if (args) {
2242         free(args);
2243         args = NULL;
2244     }
2245     if (result) {
2246         free(result);
2247         result = NULL;
2248     }
2249
2250     return ret;
2251 }
2252
2253 /*@}*/
2254 #else /* !AFS_SALSRV_ENV */
2255 # define _namei_examine_file_spawn(work, dir, file, wq, resultlist) \
2256          _namei_examine_file(work, dir, file)
2257 #endif /* !AFS_SALSRV_ENV */
2258
2259 /**
2260  * traverse and check inodes.
2261  *
2262  * @param[in] dirIH               volume group directory handle
2263  * @param[in] writeFun            function pointer which will write inode
2264  *                                metadata to FILE stream fp
2265  * @param[in] fp                  file stream where inode metadata gets
2266  *                                written
2267  * @param[in] judgeFun            inode filter function.  if not NULL, only
2268  *                                inodes for which the filter returns non-zero
2269  *                                will be written out by writeFun
2270  * @param[in] singleVolumeNumber  volume id filter.  only inodes matching this
2271  *                                filter are written out by writeFun
2272  * @param[in] rock                opaque pointer passed to judgeFun and writeFun
2273  *
2274  * @return operation status
2275  *    @retval <0 error
2276  *    @retval >=0 number of matching inodes found
2277  *
2278  * @todo the salsrv implementation may consume a lot of
2279  *       memory for a large volume.  at some point we should
2280  *       probably write a background thread to asynchronously
2281  *       clean up the resultlist nodes to reduce memory footprint
2282  *
2283  * @internal
2284  */
2285 static int
2286 namei_ListAFSSubDirs(IHandle_t * dirIH,
2287                      int (*writeFun) (FD_t, struct ViceInodeInfo *, char *,
2288                                       char *),
2289                      FD_t fp,
2290                      int (*judgeFun) (struct ViceInodeInfo *, afs_uint32, void *),
2291                      afs_uint32 singleVolumeNumber, void *rock)
2292 {
2293     int code = 0, ret = 0;
2294     IHandle_t myIH = *dirIH;
2295     namei_t name;
2296     char path1[512], path3[512];
2297     DIR *dirp1, *dirp3;
2298 #ifndef AFS_NT40_ENV
2299     DIR *dirp2;
2300     struct dirent *dp2;
2301     char path2[512];
2302 #endif
2303     struct dirent *dp1, *dp3;
2304     FdHandle_t linkHandle;
2305     int ninodes = 0;
2306     struct listsubdirs_work_node work;
2307 #ifdef AFS_SALSRV_ENV
2308     int error = 0;
2309     struct afs_work_queue *wq;
2310     int wq_up = 0;
2311     struct rx_queue resultlist;
2312 #endif
2313
2314     namei_HandleToVolDir(&name, &myIH);
2315     strlcpy(path1, name.n_path, sizeof(path1));
2316
2317     /* Do the directory containing the special files first to pick up link
2318      * counts.
2319      */
2320     (void)strcat(path1, OS_DIRSEP);
2321     (void)strcat(path1, NAMEI_SPECDIR);
2322
2323     linkHandle.fd_fd = INVALID_FD;
2324 #ifdef AFS_SALSRV_ENV
2325     osi_Assert(pthread_once(&wq_once, _namei_wq_keycreate) == 0);
2326
2327     wq = pthread_getspecific(wq_key);
2328     if (!wq) {
2329         ret = -1;
2330         goto error;
2331     }
2332     wq_up = 1;
2333     queue_Init(&resultlist);
2334 #endif
2335
2336     memset(&work, 0, sizeof(work));
2337     work.linkHandle = &linkHandle;
2338     work.IH = &myIH;
2339     work.fp = fp;
2340     work.writeFun = writeFun;
2341     work.judgeFun = judgeFun;
2342     work.singleVolumeNumber = singleVolumeNumber;
2343     work.rock = rock;
2344     work.special = 1;
2345 #ifdef AFS_SALSRV_ENV
2346     work.error = &error;
2347 #endif
2348
2349     dirp1 = opendir(path1);
2350     if (dirp1) {
2351         while ((dp1 = readdir(dirp1))) {
2352             if (*dp1->d_name == '.')
2353                 continue;
2354
2355 #ifdef AFS_SALSRV_ENV
2356             if (error) {
2357                 closedir(dirp1);
2358                 ret = -1;
2359                 goto error;
2360             }
2361 #endif /* AFS_SALSRV_ENV */
2362
2363             code = _namei_examine_file_spawn(&work, path1, dp1->d_name, wq, &resultlist);
2364
2365             switch (code) {
2366             case -1:
2367                 /* fatal error */
2368                 closedir(dirp1);
2369                 ret = -1;
2370                 goto error;
2371
2372             case 1:
2373                 /* count this inode */
2374 #ifndef AFS_SALSRV_ENV
2375                 ninodes++;
2376 #endif
2377                 break;
2378             }
2379         }
2380         closedir(dirp1);
2381     }
2382
2383 #ifdef AFS_SALSRV_ENV
2384     /* effectively a barrier */
2385     code = _namei_listsubdirs_wait(wq, &resultlist);
2386     if (code < 0 || error) {
2387         ret = -1;
2388         goto error;
2389     }
2390     error = 0;
2391     ninodes += code;
2392 #endif
2393
2394     if (linkHandle.fd_fd == INVALID_FD) {
2395         Log("namei_ListAFSSubDirs: warning: VG %u does not have a link table; "
2396             "salvager will recreate it.\n", dirIH->ih_vid);
2397     }
2398
2399     /* Now run through all the other subdirs */
2400     namei_HandleToVolDir(&name, &myIH);
2401     strlcpy(path1, name.n_path, sizeof(path1));
2402
2403     work.special = 0;
2404
2405     dirp1 = opendir(path1);
2406     if (dirp1) {
2407         while ((dp1 = readdir(dirp1))) {
2408 #ifndef AFS_NT40_ENV
2409             if (*dp1->d_name == '.')
2410                 continue;
2411 #endif
2412             if (!strcmp(dp1->d_name, NAMEI_SPECDIR))
2413                 continue;
2414
2415 #ifndef AFS_NT40_ENV /* This level missing on Windows */
2416             /* Now we've got a next level subdir. */
2417             snprintf(path2, sizeof(path2), "%s" OS_DIRSEP "%s",
2418                      path1, dp1->d_name);
2419             dirp2 = opendir(path2);
2420             if (dirp2) {
2421                 while ((dp2 = readdir(dirp2))) {
2422                     if (*dp2->d_name == '.')
2423                         continue;
2424
2425                     /* Now we've got to the actual data */
2426                     snprintf(path3, sizeof(path3), "%s" OS_DIRSEP "%s",
2427                              path2, dp2->d_name);
2428 #else
2429                     /* Now we've got to the actual data */
2430                     snprintf(path3, sizeof(path3), "%s" OS_DIRSEP "%s",
2431                              path1, dp1->d_name);
2432 #endif
2433                     dirp3 = opendir(path3);
2434                     if (dirp3) {
2435                         while ((dp3 = readdir(dirp3))) {
2436 #ifndef AFS_NT40_ENV
2437                             if (*dp3->d_name == '.')
2438                                 continue;
2439 #endif
2440
2441 #ifdef AFS_SALSRV_ENV
2442                             if (error) {
2443                                 closedir(dirp3);
2444 #ifndef AFS_NT40_ENV
2445                                 closedir(dirp2);
2446 #endif
2447                                 closedir(dirp1);
2448                                 ret = -1;
2449                                 goto error;
2450                             }
2451 #endif /* AFS_SALSRV_ENV */
2452
2453                             code = _namei_examine_file_spawn(&work, path3,
2454                                                              dp3->d_name, wq,
2455                                                              &resultlist);
2456
2457                             switch (code) {
2458                             case -1:
2459                                 closedir(dirp3);
2460 #ifndef AFS_NT40_ENV
2461                                 closedir(dirp2);
2462 #endif
2463                                 closedir(dirp1);
2464                                 ret = -1;
2465                                 goto error;
2466
2467                             case 1:
2468 #ifndef AFS_SALSRV_ENV
2469                                 ninodes++;
2470 #endif
2471                                 break;
2472                             }
2473                         }
2474                         closedir(dirp3);
2475                     }
2476 #ifndef AFS_NT40_ENV /* This level missing on Windows */
2477                 }
2478                 closedir(dirp2);
2479             }
2480 #endif
2481         }
2482         closedir(dirp1);
2483     }
2484
2485 #ifdef AFS_SALSRV_ENV
2486     /* effectively a barrier */
2487     code = _namei_listsubdirs_wait(wq, &resultlist);
2488     if (code < 0 || error) {
2489         ret = -1;
2490         goto error;
2491     }
2492     error = 0;
2493     ninodes += code;
2494     wq_up = 0;
2495 #endif
2496
2497     if (!ninodes) {
2498         /* Then why does this directory exist? Blow it away. */
2499         namei_HandleToVolDir(&name, dirIH);
2500         namei_RemoveDataDirectories(&name);
2501     }
2502
2503  error:
2504 #ifdef AFS_SALSRV_ENV
2505     if (wq_up) {
2506         afs_wq_wait_all(wq);
2507     }
2508     _namei_listsubdirs_cleanup_results(&resultlist);
2509 #endif
2510     if (linkHandle.fd_fd != INVALID_FD)
2511         OS_CLOSE(linkHandle.fd_fd);
2512
2513     if (!ret) {
2514         ret = ninodes;
2515     }
2516     return ret;
2517 }
2518
2519 /*@}*/
2520
2521 #ifdef AFS_NT40_ENV
2522 static int
2523 DecodeVolumeName(char *name, unsigned int *vid)
2524 {
2525     /* Name begins with "Vol_" and ends with .data.  See nt_HandleToVolDir() */
2526     char stmp[32];
2527     size_t len;
2528
2529     len = strlen(name);
2530     if (len <= 9)
2531         return -1;
2532     if (strncmp(name, "Vol_", 4))
2533         return -1;
2534     if (strcmp(name + len - 5, ".data"))
2535         return -1;
2536     strcpy(stmp, name);
2537     stmp[len - 5] = '\0';
2538     *vid = base32_to_int(stmp + 4);
2539     return 0;
2540 }
2541 #else
2542 static int
2543 DecodeVolumeName(char *name, unsigned int *vid)
2544 {
2545     if (strlen(name) < 1)
2546         return -1;
2547     *vid = (unsigned int)flipbase64_to_int64(name);
2548     return 0;
2549 }
2550 #endif
2551
2552
2553 /* DecodeInode
2554  *
2555  * Get the inode number from the name.
2556  *
2557  */
2558 #ifdef AFS_NT40_ENV
2559 static int
2560 DecodeInode(char *dpath, char *name, struct ViceInodeInfo *info,
2561             unsigned int volid)
2562 {
2563     char fpath[512];
2564     int tag, vno;
2565     WIN32_FIND_DATA data;
2566     HANDLE dirH;
2567     char *s, *t;
2568     char stmp[16];
2569     FdHandle_t linkHandle;
2570     char dirl;
2571
2572     snprintf(fpath, sizeof(fpath), "%s" OS_DIRSEP "%s", dpath, name);
2573
2574     dirH = FindFirstFileEx(fpath, FindExInfoStandard, &data,
2575                            FindExSearchNameMatch, NULL,
2576                            FIND_FIRST_EX_CASE_SENSITIVE);
2577     if (dirH == INVALID_HANDLE_VALUE)
2578         return -1;
2579
2580     (void)strcpy(stmp, name);
2581     s = strrchr(stmp, '_');
2582     if (!s)
2583         return -1;
2584     s++;
2585     t = strrchr(s, '.');
2586     if (!t)
2587         return -1;
2588
2589     *t = '\0';
2590     vno = base32_to_int(s);     /* type for special files */
2591     tag = base32_to_int(t+1);
2592     info->inodeNumber = ((Inode) tag) << NAMEI_TAGSHIFT;
2593     info->inodeNumber |= vno;
2594     info->byteCount = data.nFileSizeLow;
2595
2596     dirl = dpath[strlen(dpath)-1];
2597     if (dirl == NAMEI_SPECDIRC) { /* Special inode. */
2598         info->inodeNumber |= NAMEI_INODESPECIAL;
2599         info->u.param[0] = data.ftCreationTime.dwHighDateTime;
2600         info->u.param[1] = data.ftCreationTime.dwLowDateTime;
2601         info->u.param[2] = vno; /* type */
2602         info->u.param[3] = volid;
2603         if (vno != VI_LINKTABLE)
2604             info->linkCount = 1;
2605         else {
2606             /* Open this handle */
2607             char lpath[1024];
2608             (void)sprintf(lpath, "%s" OS_DIRSEP "%s", fpath, data.cFileName);
2609             linkHandle.fd_fd = OS_OPEN(lpath, O_RDONLY, 0666);
2610             info->linkCount =
2611                 namei_GetLinkCount(&linkHandle, (Inode) 0, 0, 0, 0);
2612         }
2613     } else {
2614         info->linkCount =
2615             namei_GetLinkCount(&linkHandle, info->inodeNumber, 0, 0, 0);
2616         if (info->linkCount == 0) {
2617 #ifdef DELETE_ZLC
2618             Log("Found 0 link count file %s" OS_DIRSEP "%s, deleting it.\n",
2619                 fpath, data.cFileName);
2620             AddToZLCDeleteList(dirl, data.cFileName);
2621 #else
2622             Log("Found 0 link count file %s" OS_DIRSEP "%s.\n", path,
2623                 data.cFileName);
2624 #endif
2625         } else {
2626             info->u.param[2] = data.ftCreationTime.dwHighDateTime;
2627             info->u.param[3] = data.ftCreationTime.dwLowDateTime;
2628             info->u.param[1] = vno;
2629             info->u.param[0] = volid;
2630         }
2631     }
2632     return 0;
2633 }
2634 #else
2635 static int
2636 DecodeInode(char *dpath, char *name, struct ViceInodeInfo *info,
2637             unsigned int volid)
2638 {
2639     char fpath[512];
2640     struct afs_stat_st status;
2641     int parm, tag;
2642     lb64_string_t check;
2643
2644     snprintf(fpath, sizeof(fpath), "%s" OS_DIRSEP "%s", dpath, name);
2645
2646     if (afs_stat(fpath, &status) < 0) {
2647         return -1;
2648     }
2649
2650     info->byteCount = status.st_size;
2651     info->inodeNumber = (Inode) flipbase64_to_int64(name);
2652
2653     int64_to_flipbase64(check, info->inodeNumber);
2654     if (strcmp(name, check))
2655         return -1;
2656
2657     GetOGMFromStat(&status, &parm, &tag);
2658     if ((info->inodeNumber & NAMEI_INODESPECIAL) == NAMEI_INODESPECIAL) {
2659         /* p1 - vid, p2 - -1, p3 - type, p4 - rwvid */
2660         info->u.param[0] = parm;
2661         info->u.param[1] = -1;
2662         info->u.param[2] = tag;
2663         info->u.param[3] = volid;
2664     } else {
2665         /* p1 - vid, p2 - vno, p3 - uniq, p4 - dv */
2666         info->u.param[0] = volid;
2667         info->u.param[1] = (int)(info->inodeNumber & NAMEI_VNODEMASK);
2668         info->u.param[2] = (int)((info->inodeNumber >> NAMEI_UNIQSHIFT)
2669                                  & (Inode) NAMEI_UNIQMASK);
2670         info->u.param[3] = parm;
2671     }
2672     return 0;
2673 }
2674 #endif
2675
2676 /*
2677  * Convert the VolumeInfo file from RO to RW
2678  * this routine is called by namei_convertROtoRWvolume()
2679  */
2680
2681 #ifdef FSSYNC_BUILD_CLIENT
2682 static afs_int32
2683 convertVolumeInfo(FD_t fdr, FD_t fdw, afs_uint32 vid)
2684 {
2685     struct VolumeDiskData vd;
2686     char *p;
2687
2688     if (OS_READ(fdr, &vd, sizeof(struct VolumeDiskData)) !=
2689         sizeof(struct VolumeDiskData)) {
2690         Log("1 convertVolumeInfo: read failed for %lu with code %d\n",
2691             afs_printable_uint32_lu(vid),
2692             errno);
2693         return -1;
2694     }
2695     vd.restoredFromId = vd.id;  /* remember the RO volume here */
2696     vd.cloneId = vd.id;
2697     vd.id = vd.parentId;
2698     vd.type = RWVOL;
2699     vd.dontSalvage = 0;
2700     vd.inUse = 0;
2701     vd.uniquifier += 5000;      /* just in case there are still file copies from
2702                                  * the old RW volume around */
2703
2704     /* For ROs, the copyDate contains the time that the RO volume was actually
2705      * created, and the creationDate just contains the last time the RO was
2706      * copied from the RW data. So, make the new RW creationDate more accurate
2707      * by setting it to copyDate, if copyDate is older. Since, we know the
2708      * volume is at least as old as copyDate. */
2709     if (vd.copyDate < vd.creationDate) {
2710         vd.creationDate = vd.copyDate;
2711     } else {
2712         /* If copyDate is newer, just make copyDate and creationDate the same,
2713          * for consistency with other RWs */
2714         vd.copyDate = vd.creationDate;
2715     }
2716
2717     p = strrchr(vd.name, '.');
2718     if (p && !strcmp(p, ".readonly")) {
2719         memset(p, 0, 9);
2720     }
2721     if (OS_WRITE(fdw, &vd, sizeof(struct VolumeDiskData)) !=
2722         sizeof(struct VolumeDiskData)) {
2723         Log("1 convertVolumeInfo: write failed for %lu with code %d\n",
2724             afs_printable_uint32_lu(vid),
2725             errno);
2726         return -1;
2727     }
2728     return 0;
2729 }
2730 #endif
2731
2732 /*
2733  * Convert a RO-volume into a RW-volume
2734  *
2735  * This function allows to recover very fast from the loss of a partition
2736  * from RO-copies if all RO-Copies exist on another partition.
2737  * Then these RO-volumes can be made to the new RW-volumes.
2738  * Backup of RW-volumes then consists in "vos release".
2739  *
2740  * We must make sure in this partition exists only the RO-volume which
2741  * is typical for remote replicas.
2742  *
2743  * Then the linktable is already ok,
2744  *      the vnode files need to be renamed
2745  *      the volinfo file needs to be replaced by another one with
2746  *                      slightly different contents and new name.
2747  * The volume header file of the RO-volume in the /vicep<x> directory
2748  * is destroyed by this call. A new header file for the RW-volume must
2749  * be created after return from this routine.
2750  */
2751
2752 int
2753 namei_ConvertROtoRWvolume(char *pname, afs_uint32 volumeId)
2754 {
2755     int code = 0;
2756 #ifdef FSSYNC_BUILD_CLIENT
2757     namei_t n;
2758     char dir_name[512], oldpath[512], newpath[512];
2759     char smallName[64];
2760     char largeName[64];
2761     char infoName[64];
2762     IHandle_t t_ih;
2763     IHandle_t *ih;
2764     char infoSeen = 0;
2765     char smallSeen = 0;
2766     char largeSeen = 0;
2767     char linkSeen = 0;
2768     FD_t fd, fd2;
2769     char *p;
2770     DIR *dirp;
2771     Inode ino;
2772     struct dirent *dp;
2773     struct DiskPartition64 *partP;
2774     struct ViceInodeInfo info;
2775     struct VolumeDiskHeader h;
2776 # ifdef AFS_DEMAND_ATTACH_FS
2777     int locktype = 0;
2778 # endif /* AFS_DEMAND_ATTACH_FS */
2779
2780     for (partP = DiskPartitionList; partP && strcmp(partP->name, pname);
2781          partP = partP->next);
2782     if (!partP) {
2783         Log("1 namei_ConvertROtoRWvolume: Couldn't find DiskPartition for %s\n", pname);
2784         code = EIO;
2785         goto done;
2786     }
2787
2788 # ifdef AFS_DEMAND_ATTACH_FS
2789     locktype = VVolLockType(V_VOLUPD, 1);
2790     code = VLockVolumeByIdNB(volumeId, partP, locktype);
2791     if (code) {
2792         locktype = 0;
2793         code = EIO;
2794         goto done;
2795     }
2796 # endif /* AFS_DEMAND_ATTACH_FS */
2797
2798     if (VReadVolumeDiskHeader(volumeId, partP, &h)) {
2799         Log("1 namei_ConvertROtoRWvolume: Couldn't read header for RO-volume %lu.\n",
2800             afs_printable_uint32_lu(volumeId));
2801         code = EIO;
2802         goto done;
2803     }
2804
2805     FSYNC_VolOp(volumeId, pname, FSYNC_VOL_BREAKCBKS, 0, NULL);
2806
2807     ino = namei_MakeSpecIno(h.parent, VI_LINKTABLE);
2808     IH_INIT(ih, partP->device, h.parent, ino);
2809
2810     namei_HandleToName(&n, ih);
2811     strlcpy(dir_name, n.n_path, sizeof(dir_name));
2812     p = strrchr(dir_name, OS_DIRSEPC);
2813     *p = 0;
2814     dirp = opendir(dir_name);
2815     if (!dirp) {
2816         Log("1 namei_ConvertROtoRWvolume: Could not opendir(%s)\n", dir_name);
2817         code = EIO;
2818         goto done;
2819     }
2820
2821     while ((dp = readdir(dirp))) {
2822         /* struct ViceInodeInfo info; */
2823 #ifndef AFS_NT40_ENV
2824         if (*dp->d_name == '.')
2825             continue;
2826 #endif
2827         if (DecodeInode(dir_name, dp->d_name, &info, ih->ih_vid) < 0) {
2828             Log("1 namei_ConvertROtoRWvolume: DecodeInode failed for %s" OS_DIRSEP "%s\n",
2829                 dir_name, dp->d_name);
2830             closedir(dirp);
2831             code = -1;
2832             goto done;
2833         }
2834         if (info.u.param[1] != -1) {
2835             Log("1 namei_ConvertROtoRWvolume: found other than volume special file %s" OS_DIRSEP "%s\n", dir_name, dp->d_name);
2836             closedir(dirp);
2837             code = -1;
2838             goto done;
2839         }
2840         if (info.u.param[0] != volumeId) {
2841             if (info.u.param[0] == ih->ih_vid) {
2842                 if (info.u.param[2] == VI_LINKTABLE) {  /* link table */
2843                     linkSeen = 1;
2844                     continue;
2845                 }
2846             }
2847             Log("1 namei_ConvertROtoRWvolume: found special file %s" OS_DIRSEP "%s"
2848                 " for volume %lu\n", dir_name, dp->d_name,
2849                 afs_printable_uint32_lu(info.u.param[0]));
2850             closedir(dirp);
2851             code = VVOLEXISTS;
2852             goto done;
2853         }
2854         if (info.u.param[2] == VI_VOLINFO) {    /* volume info file */
2855             strlcpy(infoName, dp->d_name, sizeof(infoName));
2856             infoSeen = 1;
2857         } else if (info.u.param[2] == VI_SMALLINDEX) {  /* small vnodes file */
2858             strlcpy(smallName, dp->d_name, sizeof(smallName));
2859             smallSeen = 1;
2860         } else if (info.u.param[2] == VI_LARGEINDEX) {  /* large vnodes file */
2861             strlcpy(largeName, dp->d_name, sizeof(largeName));
2862             largeSeen = 1;
2863         } else {
2864             closedir(dirp);
2865             Log("1 namei_ConvertROtoRWvolume: unknown type %d of special file found : %s" OS_DIRSEP "%s\n", info.u.param[2], dir_name, dp->d_name);
2866             code = -1;
2867             goto done;
2868         }
2869     }
2870     closedir(dirp);
2871
2872     if (!infoSeen || !smallSeen || !largeSeen || !linkSeen) {
2873         Log("1 namei_ConvertROtoRWvolume: not all special files found in %s\n", dir_name);
2874         code = -1;
2875         goto done;
2876     }
2877
2878     /*
2879      * If we come here then there was only a RO-volume and we can safely
2880      * proceed.
2881      */
2882
2883     memset(&t_ih, 0, sizeof(t_ih));
2884     t_ih.ih_dev = ih->ih_dev;
2885     t_ih.ih_vid = ih->ih_vid;
2886
2887     snprintf(oldpath, sizeof oldpath, "%s" OS_DIRSEP "%s", dir_name,
2888              infoName);
2889     fd = OS_OPEN(oldpath, O_RDWR, 0);
2890     if (fd == INVALID_FD) {
2891         Log("1 namei_ConvertROtoRWvolume: could not open RO info file: %s\n",
2892             oldpath);
2893         code = -1;
2894         goto done;
2895     }
2896     t_ih.ih_ino = namei_MakeSpecIno(ih->ih_vid, VI_VOLINFO);
2897     namei_HandleToName(&n, &t_ih);
2898     fd2 = OS_OPEN(n.n_path, O_CREAT | O_EXCL | O_RDWR, 0);
2899     if (fd2 == INVALID_FD) {
2900         Log("1 namei_ConvertROtoRWvolume: could not create RW info file: %s\n", n.n_path);
2901         OS_CLOSE(fd);
2902         code = -1;
2903         goto done;
2904     }
2905     code = convertVolumeInfo(fd, fd2, ih->ih_vid);
2906     OS_CLOSE(fd);
2907     if (code) {
2908         OS_CLOSE(fd2);
2909         OS_UNLINK(n.n_path);
2910         code = -1;
2911         goto done;
2912     }
2913     SetOGM(fd2, ih->ih_vid, 1);
2914     OS_CLOSE(fd2);
2915
2916     t_ih.ih_ino = namei_MakeSpecIno(ih->ih_vid, VI_SMALLINDEX);
2917     namei_HandleToName(&n, &t_ih);
2918     snprintf(newpath, sizeof newpath, "%s" OS_DIRSEP "%s", dir_name,
2919              smallName);
2920     fd = OS_OPEN(newpath, O_RDWR, 0);
2921     if (fd == INVALID_FD) {
2922         Log("1 namei_ConvertROtoRWvolume: could not open SmallIndex file: %s\n", newpath);
2923         code = -1;
2924         goto done;
2925     }
2926     SetOGM(fd, ih->ih_vid, 2);
2927     OS_CLOSE(fd);
2928 #ifdef AFS_NT40_ENV
2929     MoveFileEx(n.n_path, newpath, MOVEFILE_WRITE_THROUGH);
2930 #else
2931     link(newpath, n.n_path);
2932     OS_UNLINK(newpath);
2933 #endif
2934
2935     t_ih.ih_ino = namei_MakeSpecIno(ih->ih_vid, VI_LARGEINDEX);
2936     namei_HandleToName(&n, &t_ih);
2937     snprintf(newpath, sizeof newpath, "%s" OS_DIRSEP "%s", dir_name,
2938              largeName);
2939     fd = OS_OPEN(newpath, O_RDWR, 0);
2940     if (fd == INVALID_FD) {
2941         Log("1 namei_ConvertROtoRWvolume: could not open LargeIndex file: %s\n", newpath);
2942         code = -1;
2943         goto done;
2944     }
2945     SetOGM(fd, ih->ih_vid, 3);
2946     OS_CLOSE(fd);
2947 #ifdef AFS_NT40_ENV
2948     MoveFileEx(n.n_path, newpath, MOVEFILE_WRITE_THROUGH);
2949 #else
2950     link(newpath, n.n_path);
2951     OS_UNLINK(newpath);
2952 #endif
2953
2954     OS_UNLINK(oldpath);
2955
2956     h.id = h.parent;
2957     h.volumeInfo_hi = h.id;
2958     h.smallVnodeIndex_hi = h.id;
2959     h.largeVnodeIndex_hi = h.id;
2960     h.linkTable_hi = h.id;
2961
2962     if (VCreateVolumeDiskHeader(&h, partP)) {
2963         Log("1 namei_ConvertROtoRWvolume: Couldn't write header for RW-volume %lu\n",
2964             afs_printable_uint32_lu(h.id));
2965         code = EIO;
2966         goto done;
2967     }
2968
2969     if (VDestroyVolumeDiskHeader(partP, volumeId, h.parent)) {
2970         Log("1 namei_ConvertROtoRWvolume: Couldn't unlink header for RO-volume %lu\n",
2971             afs_printable_uint32_lu(volumeId));
2972     }
2973
2974     FSYNC_VolOp(volumeId, pname, FSYNC_VOL_DONE, 0, NULL);
2975     FSYNC_VolOp(h.id, pname, FSYNC_VOL_ON, 0, NULL);
2976
2977  done:
2978 # ifdef AFS_DEMAND_ATTACH_FS
2979     if (locktype) {
2980         VUnlockVolumeById(volumeId, partP);
2981     }
2982 # endif /* AFS_DEMAND_ATTACH_FS */
2983 #endif
2984
2985     return code;
2986 }
2987
2988 /* PrintInode
2989  *
2990  * returns a static string used to print either 32 or 64 bit inode numbers.
2991  */
2992 char *
2993 PrintInode(char *s, Inode ino)
2994 {
2995     static afs_ino_str_t result;
2996     if (!s)
2997         s = result;
2998
2999     snprintf(s, sizeof(afs_ino_str_t), "%llu", (afs_uintmax_t) ino);
3000
3001     return s;
3002 }
3003
3004
3005 #ifdef DELETE_ZLC
3006 /* Routines to facilitate removing zero link count files. */
3007 #define MAX_ZLC_NAMES 32
3008 #define MAX_ZLC_NAMELEN 16
3009 typedef struct zlcList_s {
3010     struct zlcList_s *zlc_next;
3011     int zlc_n;
3012     char zlc_names[MAX_ZLC_NAMES][MAX_ZLC_NAMELEN];
3013 } zlcList_t;
3014
3015 static zlcList_t *zlcAnchor = NULL;
3016 static zlcList_t *zlcCur = NULL;
3017
3018 static void
3019 AddToZLCDeleteList(char dir, char *name)
3020 {
3021     osi_Assert(strlen(name) <= MAX_ZLC_NAMELEN - 3);
3022
3023     if (!zlcCur || zlcCur->zlc_n >= MAX_ZLC_NAMES) {
3024         if (zlcCur && zlcCur->zlc_next)
3025             zlcCur = zlcCur->zlc_next;
3026         else {
3027             zlcList_t *tmp = (zlcList_t *) malloc(sizeof(zlcList_t));
3028             if (!tmp)
3029                 return;
3030             if (!zlcAnchor) {
3031                 zlcAnchor = tmp;
3032             } else {
3033                 zlcCur->zlc_next = tmp;
3034             }
3035             zlcCur = tmp;
3036             zlcCur->zlc_n = 0;
3037             zlcCur->zlc_next = NULL;
3038         }
3039     }
3040
3041     if (dir)
3042         (void)sprintf(zlcCur->zlc_names[zlcCur->zlc_n], "%c" OS_DIRSEP "%s", dir, name);
3043     else
3044         (void)sprintf(zlcCur->zlc_names[zlcCur->zlc_n], "%s", name);
3045
3046     zlcCur->zlc_n++;
3047 }
3048
3049 static void
3050 DeleteZLCFiles(char *path)
3051 {
3052     zlcList_t *z;
3053     int i;
3054     char fname[1024];
3055
3056     for (z = zlcAnchor; z; z = z->zlc_next) {
3057         for (i = 0; i < z->zlc_n; i++) {
3058             if (path)
3059                 (void)sprintf(fname, "%s" OS_DIRSEP "%s", path, z->zlc_names[i]);
3060             else
3061                 (void)sprintf(fname, "%s", z->zlc_names[i]);
3062             if (namei_unlink(fname) < 0) {
3063                 Log("ZLC: Can't unlink %s, dos error = %d\n", fname,
3064                     GetLastError());
3065             }
3066         }
3067         z->zlc_n = 0;           /* Can reuse space. */
3068     }
3069     zlcCur = zlcAnchor;
3070 }
3071
3072 static void
3073 FreeZLCList(void)
3074 {
3075     zlcList_t *tnext;
3076     zlcList_t *i;
3077
3078     i = zlcAnchor;
3079     while (i) {
3080         tnext = i->zlc_next;
3081         free(i);
3082         i = tnext;
3083     }
3084     zlcCur = zlcAnchor = NULL;
3085 }
3086 #endif
3087
3088 #endif /* AFS_NAMEI_ENV */