2 * Copyright 2000, International Business Machines Corporation and others.
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
11 * Read a vos dump and recreate the tree.
13 * restorevol [-file <dump file>]
14 * [-dir <restore dir>]
15 * [-extension <name extension>]
16 * [-mountpoint <mount point root>]
17 * [-umask <mode mask>]
19 * 1. The dump file will be restored within the current or that specified with -dir.
20 * 2. Within this dir, a subdir is created. It's name is the RW volume name
21 * that was dumped. An extension can be appended to this directory name
23 * 3. All mountpoints will appear as symbolic links to the volume. The
24 * pathname to the volume will be either that in -mountpoint, or -dir.
25 * Symbolic links remain untouched.
26 * 4. You can change your umask during the restore with -umask. Otherwise, it
27 * uses your current umask. Mode bits for directories are 0777 (then
28 * AND'ed with the umask). Mode bits for files are the owner mode bits
29 * duplicated accross group and user (then AND'ed with the umask).
30 * 5. For restores of full dumps, if a directory says it has a file and
31 * the file is not found, then a symbolic link "AFSFile-<#>" will
32 * appear in that restored tree. Restores of incremental dumps remove
33 * all these files at the end (expensive because it is a tree search).
34 * 6. If a file or directory was found in the dump but found not to be
35 * connected to the hierarchical tree, then the file or directory
36 * will be connected at the root of the tree as "__ORPHANEDIR__.<#>"
37 * or "__ORPHANFILE__.<#>".
38 * 7. ACLs are not restored.
42 #include <afsconfig.h>
43 #include <afs/param.h>
48 #include <afs/afsint.h>
51 #include <afs/ihandle.h>
52 #include <afs/vnode.h>
53 #include <afs/volume.h>
58 #include <sys/param.h>
59 #include <sys/types.h>
63 #include <netinet/in.h>
77 char rootdir[MAXPATHLEN];
78 char mntroot[MAXPATHLEN];
79 #define ADIR "AFSDir-"
80 #define AFILE "AFSFile-"
81 #define ODIR "__ORPHANEDIR__."
82 #define OFILE "__ORPHANFILE__."
97 s = sizeof(value) - size;
99 fprintf(stderr, "Too much data in afs_int32\n");
103 code = fread(&ptr[s], 1, size, dumpfile);
105 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
118 code = fread(&value, 1, 1, dumpfile);
120 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
125 #define BUFSIZE 16384
129 readdata(buffer, size)
138 s = (afs_int32) ((size > BUFSIZE) ? BUFSIZE : size);
139 code = fread(buf, 1, s, dumpfile);
141 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
145 code = fread(buffer, 1, size, dumpfile);
148 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
150 fprintf(stderr, "Read %d bytes out of %lld\n", code, (afs_uintmax_t)size);
152 if ((code >= 0) && (code < BUFSIZE))
153 buffer[size] = 0; /* Add null char at end */
159 struct DumpHeader *dh; /* Defined in dump.h */
165 /* memset(&dh, 0, sizeof(dh)); */
167 magic = ntohl(readvalue(4));
168 dh->version = ntohl(readvalue(4));
175 dh->volumeId = ntohl(readvalue(4));
179 for (i = 0, c = 'a'; c != '\0'; i++) {
180 dh->volumeName[i] = c = readchar();
182 dh->volumeName[i] = c;
186 dh->nDumpTimes = ntohl(readvalue(2)) >> 1;
187 for (i = 0; i < dh->nDumpTimes; i++) {
188 dh->dumpTimes[i].from = ntohl(readvalue(4));
189 dh->dumpTimes[i].to = ntohl(readvalue(4));
199 return ((afs_int32) tag);
202 struct volumeHeader {
204 char volumeName[100];
206 afs_int32 uniquifier;
213 afs_int32 accountNumber;
215 afs_int32 creationDate;
216 afs_int32 accessDate;
217 afs_int32 updateDate;
218 afs_int32 expirationDate;
219 afs_int32 backupDate;
220 afs_int32 dayUseDate;
223 afs_int32 weekUse[100]; /* weekCount of these */
228 afs_int32 volUpdateCounter;
232 ReadVolumeHeader(count)
235 struct volumeHeader vh;
236 int code, i, done, entries;
239 /* memset(&vh, 0, sizeof(vh)); */
246 vh.volumeId = ntohl(readvalue(4));
250 ntohl(readvalue(4)); /* version stamp - ignore */
254 for (i = 0, c = 'a'; c != '\0'; i++) {
255 vh.volumeName[i] = c = readchar();
257 vh.volumeName[i] = c;
261 vh.inService = ntohl(readvalue(1));
265 vh.blessed = ntohl(readvalue(1));
269 vh.uniquifier = ntohl(readvalue(4));
273 vh.volType = ntohl(readvalue(1));
277 vh.parentVol = ntohl(readvalue(4));
281 vh.cloneId = ntohl(readvalue(4));
285 vh.maxQuota = ntohl(readvalue(4));
289 vh.minQuota = ntohl(readvalue(4));
293 vh.diskUsed = ntohl(readvalue(4));
297 vh.fileCount = ntohl(readvalue(4));
301 vh.accountNumber = ntohl(readvalue(4));
305 vh.owner = ntohl(readvalue(4));
309 vh.creationDate = ntohl(readvalue(4));
313 vh.accessDate = ntohl(readvalue(4));
317 vh.updateDate = ntohl(readvalue(4));
321 vh.expirationDate = ntohl(readvalue(4));
325 vh.backupDate = ntohl(readvalue(4));
329 for (i = 0, c = 'a'; c != '\0'; i++) {
330 vh.message[i] = c = readchar();
332 vh.volumeName[i] = c;
336 vh.weekCount = ntohl(readvalue(2));
337 for (i = 0; i < vh.weekCount; i++) {
338 vh.weekUse[i] = ntohl(readvalue(4));
343 for (i = 0, c = 'a'; c != '\0'; i++) {
344 vh.motd[i] = c = readchar();
349 vh.dayUseDate = ntohl(readvalue(4));
353 vh.dayUse = ntohl(readvalue(4));
356 vh.volUpdateCounter = ntohl(readvalue(4));
365 return ((afs_int32) tag);
370 afs_int32 uniquifier;
373 afs_int32 dataVersion;
374 afs_int32 unixModTime;
375 afs_int32 servModTime;
383 struct acl_accessList {
384 int size; /*size of this access list in bytes, including MySize itself */
385 int version; /*to deal with upward compatibility ; <= ACL_ACLVERSION */
387 int positive; /* number of positive entries */
388 int negative; /* number of minus entries */
389 struct acl_accessEntry {
390 int id; /*internally-used ID of user or group */
391 int rights; /*mask */
395 afs_sfsize_t dataSize;
398 #define MAXNAMELEN 256
405 int code, i, done, entries;
407 char dirname[MAXNAMELEN], linkname[MAXNAMELEN], lname[MAXNAMELEN];
408 char parentdir[MAXNAMELEN], vflink[MAXNAMELEN];
409 char filename[MAXNAMELEN], fname[MAXNAMELEN];
414 /* memset(&vn, 0, sizeof(vn)); */
420 vn.vnode = ntohl(readvalue(4));
421 vn.uniquifier = ntohl(readvalue(4));
428 vn.type = ntohl(readvalue(1));
432 vn.linkCount = ntohl(readvalue(2));
436 vn.dataVersion = ntohl(readvalue(4));
440 vn.unixModTime = ntohl(readvalue(4));
444 vn.servModTime = ntohl(readvalue(4));
448 vn.author = ntohl(readvalue(4));
452 vn.owner = ntohl(readvalue(4));
456 vn.group = ntohl(readvalue(4));
460 vn.modebits = ntohl(readvalue(2));
464 vn.parent = ntohl(readvalue(4));
468 readdata(vn.acl, 192); /* Skip ACL data */
471 #ifdef AFS_LARGEFILE_ENV
475 hi = ntohl(readvalue(4));
476 lo = ntohl(readvalue(4));
477 FillInt64(vn.dataSize, hi, lo);
480 #endif /* !AFS_LARGEFILE_ENV */
483 vn.dataSize = ntohl(readvalue(4));
486 /* parentdir is the name of this dir's vnode-file-link
487 * or this file's parent vnode-file-link.
488 * "./AFSDir-<#>". It's a symbolic link to its real dir.
489 * The parent dir and symbolic link to it must exist.
491 vnode = ((vn.type == 2) ? vn.vnode : vn.parent);
493 strncpy(parentdir, rootdir, sizeof parentdir);
495 afs_snprintf(parentdir, sizeof parentdir, "%s/%s%d", rootdir,
498 len = readlink(parentdir, linkname, MAXNAMELEN);
500 /* parentdir does not exist. So create an orphan dir.
501 * and then link the parentdir to the orphaned dir.
503 afs_snprintf(linkname, sizeof linkname, "%s/%s%d",
504 rootdir, ODIR, vnode);
505 code = mkdir(linkname, 0777);
506 if ((code < 0) && (errno != EEXIST)) {
508 "Error creating directory %s code=%d;%d\n",
509 linkname, code, errno);
512 /* Link the parentdir to it - now parentdir exists */
513 afs_snprintf(linkname, sizeof linkname, "%s%d/", ODIR,
515 code = symlink(linkname, parentdir);
518 "Error creating symlink %s -> %s code=%d;%d\n",
519 parentdir, linkname, code, errno);
526 /* We read the directory entries. If the entry is a
527 * directory, the subdir is created and the root dir
528 * will contain a link to it. If its a file, we only
529 * create a symlink in the dir to the file name.
548 unsigned short pgcount;
556 struct Pageheader header;
558 unsigned short hashTable[128];
562 struct DirHeader header;
563 struct DirEntry entry[1];
568 buffer = (char *)malloc(vn.dataSize);
570 readdata(buffer, vn.dataSize);
571 page0 = (struct Page0 *)buffer;
573 /* Step through each bucket in the hash table, i,
574 * and follow each element in the hash chain, j.
575 * This gives us each entry of the dir.
577 for (i = 0; i < 128; i++) {
578 for (j = ntohs(page0->header.hashTable[i]); j;
579 j = ntohs(page0->entry[j].next)) {
581 this_vn = ntohl(page0->entry[j].fid.vnode);
582 this_name = page0->entry[j].name;
584 if ((strcmp(this_name, ".") == 0)
585 || (strcmp(this_name, "..") == 0))
586 continue; /* Skip these */
588 /* For a directory entry, create it. Then create the
589 * link (from the rootdir) to this directory.
593 /* dirname is the directory to create.
594 * vflink is what will link to it.
596 afs_snprintf(dirname, sizeof dirname, "%s/%s",
597 parentdir, this_name);
598 afs_snprintf(vflink, sizeof vflink, "%s/%s%d",
599 rootdir, ADIR, this_vn);
601 /* The link and directory may already exist */
602 len = readlink(vflink, linkname, MAXNAMELEN);
604 /* Doesn't already exist - so create the directory.
605 * umask will pare the mode bits down.
607 code = mkdir(dirname, 0777);
608 if ((code < 0) && (errno != EEXIST)) {
610 "Error creating directory %s code=%d;%d\n",
611 dirname, code, errno);
614 /* Does already exist - so move the directory.
615 * It was created originally as orphaned.
617 linkname[len - 1] = '\0'; /* remove '/' at end */
618 afs_snprintf(lname, sizeof lname, "%s/%s",
620 code = rename(lname, dirname);
623 "Error renaming %s to %s code=%d;%d\n",
624 lname, dirname, code, errno);
628 /* Now create/update the link to the new/moved directory */
630 afs_snprintf(dirname, sizeof dirname, "%s/",
633 afs_snprintf(dirname, sizeof dirname,
634 "%s%d/%s/", ADIR, vn.vnode,
637 code = symlink(dirname, vflink);
640 "Error creating symlink %s -> %s code=%d;%d\n",
641 vflink, dirname, code, errno);
645 /* For a file entry, we remember the name of the file
646 * by creating a link within the directory. Restoring
647 * the file will later remove the link.
650 /*AFILEENTRY*/ afs_snprintf(vflink,
652 "%s/%s%d", parentdir,
655 code = symlink(this_name, vflink);
656 if ((code < 0) && (errno != EEXIST)) {
658 "Error creating symlink %s -> %s code=%d;%d\n",
659 vflink, page0->entry[j].name, code,
668 else if (vn.type == 1) {
670 /* A file vnode. So create it into the desired directory. A
671 * link should exist in the directory naming the file.
675 afs_sfsize_t size, s;
677 /* Check if its vnode-file-link exists. If not,
678 * then the file will be an orphaned file.
681 afs_snprintf(filename, sizeof filename, "%s/%s%d", parentdir,
683 len = readlink(filename, fname, MAXNAMELEN);
685 afs_snprintf(filename, sizeof filename, "%s/%s%d",
686 rootdir, OFILE, vn.vnode);
687 lfile = 0; /* no longer a linked file; a direct path */
690 /* Create a mode for the file. Use the owner bits and
691 * duplicate them across group and other. The umask
692 * will remove what we don't want.
694 mode = (vn.modebits >> 6) & 0x7;
695 mode |= (mode << 6) | (mode << 3);
697 /* Write the file out */
698 fid = open(filename, (O_CREAT | O_WRONLY | O_TRUNC), mode);
701 s = (afs_int32) ((size > BUFSIZE) ? BUFSIZE : size);
702 code = fread(buf, 1, s, dumpfile);
704 (void)write(fid, buf, code);
709 fprintf(stderr, "Code = %d; Errno = %d\n", code,
713 (void)afs_snprintf(tmp, sizeof tmp,
714 "Read %llu bytes out of %llu",
715 (afs_uintmax_t) (vn.dataSize -
717 (afs_uintmax_t) vn.dataSize);
718 fprintf(stderr, "%s\n", tmp);
725 fprintf(stderr, " File %s (%s) is incomplete\n",
729 /* Remove the link to the file */
735 else if (vn.type == 3) {
737 /* A symlink vnode. So read it into the desired directory. This could
738 * also be a mount point. If the volume is being restored to AFS, this
739 * will become a mountpoint. If not, it becomes a symlink to no-where.
744 /* Check if its vnode-file-link exists and create pathname
745 * of the symbolic link. If it doesn't exist,
746 * then the link will be an orphaned link.
748 afs_snprintf(linkname, sizeof linkname, "%s/%s%d", parentdir,
750 len = readlink(linkname, fname, MAXNAMELEN);
752 afs_snprintf(filename, sizeof filename, "%s/%s%d",
753 rootdir, OFILE, vn.vnode);
756 afs_snprintf(filename, sizeof filename, "%s/%s",
760 /* Read the link in, delete it, and then create it */
761 readdata(buf, vn.dataSize);
763 /* If a mountpoint, change its link path to mountroot */
765 if (((buf[0] == '%') || (buf[0] == '#'))
766 && (buf[s - 1] == '.')) {
767 /* This is a symbolic link */
768 buf[s - 1] = 0; /* Remove prefix '.' */
769 strcpy(lname, &buf[1]); /* Remove postfix '#' or '%' */
770 strcpy(buf, mntroot);
775 code = symlink(buf, filename);
778 "Error creating symlink %s -> %s code=%d;%d\n",
779 filename, buf, code, errno);
782 /* Remove the symbolic link */
787 fprintf(stderr, "Unknown Vnode block\n");
799 return ((afs_int32) tag);
803 struct cmd_syndesc *as;
806 int code = 0, c, len;
807 afs_int32 type, count, vcount;
809 struct dirent *dirE, *dirF;
810 char fname[MAXNAMELEN], name[MAXNAMELEN], lname[MAXNAMELEN],
812 char thisdir[MAXPATHLEN], *t;
813 struct DumpHeader dh; /* Defined in dump.h */
814 #if 0/*ndef HAVE_GETCWD*/ /* XXX enable when autoconf happens */
815 extern char *getwd();
816 #define getcwd(x,y) getwd(x)
819 if (as->parms[0].items) { /* -file <dumpfile> */
820 dumpfile = fopen(as->parms[0].items->data, "r");
822 fprintf(stderr, "Cannot open '%s'. Code = %d\n",
823 as->parms[0].items->data, errno);
827 dumpfile = (FILE *) stdin; /* use stdin */
830 /* Read the dump header. From it we get the volume name */
831 type = ntohl(readvalue(1));
833 fprintf(stderr, "Expected DumpHeader\n");
837 type = ReadDumpHeader(&dh);
839 /* Get the root directory we restore to */
840 if (as->parms[1].items) { /* -dir <rootdir> */
841 strcpy(rootdir, as->parms[1].items->data);
843 strcpy(rootdir, ".");
845 strcat(rootdir, "/");
847 /* Append the RW volume name to the root directory */
848 strcat(rootdir, dh.volumeName);
849 len = strlen(rootdir);
850 if (strcmp(".backup", rootdir + len - 7) == 0) {
851 rootdir[len - 7] = 0;
852 } else if (strcmp(".readonly", rootdir + len - 9) == 0) {
853 rootdir[len - 9] = 0;
856 /* Append the extension we asked for */
857 if (as->parms[2].items) {
858 strcat(rootdir, as->parms[2].items->data); /* -extension <ext> */
861 /* The mountpoint root is either specifid in -mountpoint
862 * or -dir or the current working dir.
864 if ((as->parms[3].items) || (as->parms[1].items)) { /* -mountpoint or -dir */
865 t = (char *)getcwd(thisdir, MAXPATHLEN); /* remember current dir */
868 "Cannot get pathname of current working directory: %s\n",
873 /* Change to the mount point dir */
875 chdir((as->parms[3].items ? as->parms[3].items->data : as->
876 parms[1].items->data));
878 fprintf(stderr, "Mount point directory not found: Error = %d\n",
882 t = (char *)getcwd(mntroot, MAXPATHLEN); /* get its full pathname */
885 "Cannot determine pathname of mount point root directory: %s\n",
890 strcat(mntroot, "/"); /* append '/' to end of it */
891 code = chdir(thisdir); /* return to original working dir */
893 fprintf(stderr, "Cannot find working directory: Error = %d\n",
897 } else { /* use current directory */
898 t = (char *)getcwd(mntroot, MAXPATHLEN); /* get full pathname of current dir */
901 "Cannot determine pathname of current working directory: %s\n",
907 strcat(mntroot, "/"); /* append '/' to end of it */
909 /* Set the umask for the restore */
910 if (as->parms[4].items) { /* -umask */
912 mask = strtol(as->parms[4].items->data, 0, 8);
913 fprintf(stderr, "Umask set to 0%03o\n", mask);
917 fprintf(stderr, "Restoring volume dump of '%s' to directory '%s'.\n",
918 dh.volumeName, rootdir);
919 code = mkdir(rootdir, 0777);
920 if ((code < 0) && (errno != EEXIST)) {
921 fprintf(stderr, "Error creating directory %s code=%d;%d\n", rootdir,
925 for (count = 1; type == 2; count++) {
926 type = ReadVolumeHeader(count);
927 for (vcount = 1; type == 3; vcount++)
928 type = ReadVNode(vcount);
932 fprintf(stderr, "Expected End-of-Dump\n");
938 /* For incremental restores, Follow each directory link and
939 * remove an "AFSFile" links.
942 fprintf(stderr, "An incremental dump.\n");
943 dirP = opendir(rootdir);
944 while (dirP && (dirE = readdir(dirP))) {
945 if (strncmp(dirE->d_name, ADIR, strlen(ADIR)) == 0) {
946 afs_snprintf(name, sizeof name, "%s/%s", rootdir,
948 dirQ = opendir(name);
949 while (dirQ && (dirF = readdir(dirQ))) {
950 if (strncmp(dirF->d_name, AFILE, strlen(AFILE)) == 0) {
951 afs_snprintf(name, sizeof name, "%s/%s/%s", rootdir,
952 dirE->d_name, dirF->d_name);
957 } else if (strncmp(dirE->d_name, AFILE, strlen(AFILE)) == 0) {
958 afs_snprintf(name, sizeof name, "%s/%s", rootdir,
966 /* Now go through and remove all the directory links */
967 dirP = opendir(rootdir);
968 while (dirP && (dirE = readdir(dirP))) {
969 if (strncmp(dirE->d_name, ADIR, strlen(ADIR)) == 0) {
970 afs_snprintf(name, sizeof name, "%s/%s", rootdir, dirE->d_name);
983 struct cmd_syndesc *ts;
988 ts = cmd_CreateSyntax(NULL, WorkerBee, NULL, "vldb check");
989 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "dump file");
990 cmd_AddParm(ts, "-dir", CMD_SINGLE, CMD_OPTIONAL, "restore dir");
991 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL, "name extension");
992 cmd_AddParm(ts, "-mountpoint", CMD_SINGLE, CMD_OPTIONAL,
994 cmd_AddParm(ts, "-umask", CMD_SINGLE, CMD_OPTIONAL, "mode mask");
996 return cmd_Dispatch(argc, argv);