src/vol/namei_ops.c

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