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