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 = ((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 %d\n", code, 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 */
231 ReadVolumeHeader(count)
234 struct volumeHeader vh;
235 int code, i, done, entries;
238 /* memset(&vh, 0, sizeof(vh)); */
245 vh.volumeId = ntohl(readvalue(4));
249 ntohl(readvalue(4)); /* version stamp - ignore */
253 for (i = 0, c = 'a'; c != '\0'; i++) {
254 vh.volumeName[i] = c = readchar();
256 vh.volumeName[i] = c;
260 vh.inService = ntohl(readvalue(1));
264 vh.blessed = ntohl(readvalue(1));
268 vh.uniquifier = ntohl(readvalue(4));
272 vh.volType = ntohl(readvalue(1));
276 vh.parentVol = ntohl(readvalue(4));
280 vh.cloneId = ntohl(readvalue(4));
284 vh.maxQuota = ntohl(readvalue(4));
288 vh.minQuota = ntohl(readvalue(4));
292 vh.diskUsed = ntohl(readvalue(4));
296 vh.fileCount = ntohl(readvalue(4));
300 vh.accountNumber = ntohl(readvalue(4));
304 vh.owner = ntohl(readvalue(4));
308 vh.creationDate = ntohl(readvalue(4));
312 vh.accessDate = ntohl(readvalue(4));
316 vh.updateDate = ntohl(readvalue(4));
320 vh.expirationDate = ntohl(readvalue(4));
324 vh.backupDate = ntohl(readvalue(4));
328 for (i = 0, c = 'a'; c != '\0'; i++) {
329 vh.message[i] = c = readchar();
331 vh.volumeName[i] = c;
335 vh.weekCount = ntohl(readvalue(2));
336 for (i = 0; i < vh.weekCount; i++) {
337 vh.weekUse[i] = ntohl(readvalue(4));
342 for (i = 0, c = 'a'; c != '\0'; i++) {
343 vh.motd[i] = c = readchar();
348 vh.dayUseDate = ntohl(readvalue(4));
352 vh.dayUse = ntohl(readvalue(4));
361 return ((afs_int32) tag);
366 afs_int32 uniquifier;
369 afs_int32 dataVersion;
370 afs_int32 unixModTime;
371 afs_int32 servModTime;
379 struct acl_accessList {
380 int size; /*size of this access list in bytes, including MySize itself */
381 int version; /*to deal with upward compatibility ; <= ACL_ACLVERSION */
383 int positive; /* number of positive entries */
384 int negative; /* number of minus entries */
385 struct acl_accessEntry {
386 int id; /*internally-used ID of user or group */
387 int rights; /*mask */
394 #define MAXNAMELEN 256
401 int code, i, done, entries;
403 char dirname[MAXNAMELEN], linkname[MAXNAMELEN], lname[MAXNAMELEN];
404 char parentdir[MAXNAMELEN], vflink[MAXNAMELEN];
405 char filename[MAXNAMELEN], fname[MAXNAMELEN];
410 /* memset(&vn, 0, sizeof(vn)); */
416 vn.vnode = ntohl(readvalue(4));
417 vn.uniquifier = ntohl(readvalue(4));
424 vn.type = ntohl(readvalue(1));
428 vn.linkCount = ntohl(readvalue(2));
432 vn.dataVersion = ntohl(readvalue(4));
436 vn.unixModTime = ntohl(readvalue(4));
440 vn.servModTime = ntohl(readvalue(4));
444 vn.author = ntohl(readvalue(4));
448 vn.owner = ntohl(readvalue(4));
452 vn.group = ntohl(readvalue(4));
456 vn.modebits = ntohl(readvalue(2));
460 vn.parent = ntohl(readvalue(4));
464 readdata(vn.acl, 192); /* Skip ACL data */
468 vn.dataSize = ntohl(readvalue(4));
470 /* parentdir is the name of this dir's vnode-file-link
471 * or this file's parent vnode-file-link.
472 * "./AFSDir-<#>". It's a symbolic link to its real dir.
473 * The parent dir and symbolic link to it must exist.
475 vnode = ((vn.type == 2) ? vn.vnode : vn.parent);
477 strncpy(parentdir, rootdir, sizeof parentdir);
479 afs_snprintf(parentdir, sizeof parentdir, "%s/%s%d", rootdir,
482 len = readlink(parentdir, linkname, MAXNAMELEN);
484 /* parentdir does not exist. So create an orphan dir.
485 * and then link the parentdir to the orphaned dir.
487 afs_snprintf(linkname, sizeof linkname, "%s/%s%d",
488 rootdir, ODIR, vnode);
489 code = mkdir(linkname, 0777);
490 if ((code < 0) && (errno != EEXIST)) {
492 "Error creating directory %s code=%d;%d\n",
493 linkname, code, errno);
496 /* Link the parentdir to it - now parentdir exists */
497 afs_snprintf(linkname, sizeof linkname, "%s%d/", ODIR,
499 code = symlink(linkname, parentdir);
502 "Error creating symlink %s -> %s code=%d;%d\n",
503 parentdir, linkname, code, errno);
510 /* We read the directory entries. If the entry is a
511 * directory, the subdir is created and the root dir
512 * will contain a link to it. If its a file, we only
513 * create a symlink in the dir to the file name.
532 unsigned short pgcount;
540 struct Pageheader header;
542 unsigned short hashTable[128];
546 struct DirHeader header;
547 struct DirEntry entry[1];
552 buffer = (char *)malloc(vn.dataSize);
554 readdata(buffer, vn.dataSize);
555 page0 = (struct Page0 *)buffer;
557 /* Step through each bucket in the hash table, i,
558 * and follow each element in the hash chain, j.
559 * This gives us each entry of the dir.
561 for (i = 0; i < 128; i++) {
562 for (j = ntohs(page0->header.hashTable[i]); j;
563 j = ntohs(page0->entry[j].next)) {
565 this_vn = ntohl(page0->entry[j].fid.vnode);
566 this_name = page0->entry[j].name;
568 if ((strcmp(this_name, ".") == 0)
569 || (strcmp(this_name, "..") == 0))
570 continue; /* Skip these */
572 /* For a directory entry, create it. Then create the
573 * link (from the rootdir) to this directory.
577 /* dirname is the directory to create.
578 * vflink is what will link to it.
580 afs_snprintf(dirname, sizeof dirname, "%s/%s",
581 parentdir, this_name);
582 afs_snprintf(vflink, sizeof vflink, "%s/%s%d",
583 rootdir, ADIR, this_vn);
585 /* The link and directory may already exist */
586 len = readlink(vflink, linkname, MAXNAMELEN);
588 /* Doesn't already exist - so create the directory.
589 * umask will pare the mode bits down.
591 code = mkdir(dirname, 0777);
592 if ((code < 0) && (errno != EEXIST)) {
594 "Error creating directory %s code=%d;%d\n",
595 dirname, code, errno);
598 /* Does already exist - so move the directory.
599 * It was created originally as orphaned.
601 linkname[len - 1] = '\0'; /* remove '/' at end */
602 afs_snprintf(lname, sizeof lname, "%s/%s",
604 code = rename(lname, dirname);
607 "Error renaming %s to %s code=%d;%d\n",
608 lname, dirname, code, errno);
612 /* Now create/update the link to the new/moved directory */
614 afs_snprintf(dirname, sizeof dirname, "%s/",
617 afs_snprintf(dirname, sizeof dirname,
618 "%s%d/%s/", ADIR, vn.vnode,
621 code = symlink(dirname, vflink);
624 "Error creating symlink %s -> %s code=%d;%d\n",
625 vflink, dirname, code, errno);
629 /* For a file entry, we remember the name of the file
630 * by creating a link within the directory. Restoring
631 * the file will later remove the link.
634 /*AFILEENTRY*/ afs_snprintf(vflink,
636 "%s/%s%d", parentdir,
639 code = symlink(this_name, vflink);
640 if ((code < 0) && (errno != EEXIST)) {
642 "Error creating symlink %s -> %s code=%d;%d\n",
643 vflink, page0->entry[j].name, code,
652 else if (vn.type == 1) {
654 /* A file vnode. So create it into the desired directory. A
655 * link should exist in the directory naming the file.
661 /* Check if its vnode-file-link exists. If not,
662 * then the file will be an orphaned file.
665 afs_snprintf(filename, sizeof filename, "%s/%s%d", parentdir,
667 len = readlink(filename, fname, MAXNAMELEN);
669 afs_snprintf(filename, sizeof filename, "%s/%s%d",
670 rootdir, OFILE, vn.vnode);
671 lfile = 0; /* no longer a linked file; a direct path */
674 /* Create a mode for the file. Use the owner bits and
675 * duplicate them across group and other. The umask
676 * will remove what we don't want.
678 mode = (vn.modebits >> 6) & 0x7;
679 mode |= (mode << 6) | (mode << 3);
681 /* Write the file out */
682 fid = open(filename, (O_CREAT | O_WRONLY | O_TRUNC), mode);
685 s = ((size > BUFSIZE) ? BUFSIZE : size);
686 code = fread(buf, 1, s, dumpfile);
688 (void)write(fid, buf, code);
693 fprintf(stderr, "Code = %d; Errno = %d\n", code,
697 (void)afs_snprintf(tmp, sizeof tmp,
698 "Read %llu bytes out of %llu",
699 (afs_uintmax_t) (vn.dataSize -
701 (afs_uintmax_t) vn.dataSize);
702 fprintf(stderr, "%s\n", tmp);
709 fprintf(stderr, " File %s (%s) is incomplete\n",
713 /* Remove the link to the file */
719 else if (vn.type == 3) {
721 /* A symlink vnode. So read it into the desired directory. This could
722 * also be a mount point. If the volume is being restored to AFS, this
723 * will become a mountpoint. If not, it becomes a symlink to no-where.
728 /* Check if its vnode-file-link exists and create pathname
729 * of the symbolic link. If it doesn't exist,
730 * then the link will be an orphaned link.
732 afs_snprintf(linkname, sizeof linkname, "%s/%s%d", parentdir,
734 len = readlink(linkname, fname, MAXNAMELEN);
736 afs_snprintf(filename, sizeof filename, "%s/%s%d",
737 rootdir, OFILE, vn.vnode);
740 afs_snprintf(filename, sizeof filename, "%s/%s",
744 /* Read the link in, delete it, and then create it */
745 readdata(buf, vn.dataSize);
747 /* If a mountpoint, change its link path to mountroot */
749 if (((buf[0] == '%') || (buf[0] == '#'))
750 && (buf[s - 1] == '.')) {
751 /* This is a symbolic link */
752 buf[s - 1] = 0; /* Remove prefix '.' */
753 strcpy(lname, &buf[1]); /* Remove postfix '#' or '%' */
754 strcpy(buf, mntroot);
759 code = symlink(buf, filename);
762 "Error creating symlink %s -> %s code=%d;%d\n",
763 filename, buf, code, errno);
766 /* Remove the symbolic link */
771 fprintf(stderr, "Unknown Vnode block\n");
783 return ((afs_int32) tag);
787 struct cmd_syndesc *as;
790 int code = 0, c, len;
791 afs_int32 type, count, vcount;
793 struct dirent *dirE, *dirF;
794 char fname[MAXNAMELEN], name[MAXNAMELEN], lname[MAXNAMELEN],
796 char thisdir[MAXPATHLEN], *t;
797 struct DumpHeader dh; /* Defined in dump.h */
798 #if 0/*ndef HAVE_GETCWD*/ /* XXX enable when autoconf happens */
799 extern char *getwd();
800 #define getcwd(x,y) getwd(x)
803 if (as->parms[0].items) { /* -file <dumpfile> */
804 dumpfile = fopen(as->parms[0].items->data, "r");
806 fprintf(stderr, "Cannot open '%s'. Code = %d\n",
807 as->parms[0].items->data, errno);
811 dumpfile = (FILE *) stdin; /* use stdin */
814 /* Read the dump header. From it we get the volume name */
815 type = ntohl(readvalue(1));
817 fprintf(stderr, "Expected DumpHeader\n");
821 type = ReadDumpHeader(&dh);
823 /* Get the root directory we restore to */
824 if (as->parms[1].items) { /* -dir <rootdir> */
825 strcpy(rootdir, as->parms[1].items->data);
827 strcpy(rootdir, ".");
829 strcat(rootdir, "/");
831 /* Append the RW volume name to the root directory */
832 strcat(rootdir, dh.volumeName);
833 len = strlen(rootdir);
834 if (strcmp(".backup", rootdir + len - 7) == 0) {
835 rootdir[len - 7] = 0;
836 } else if (strcmp(".readonly", rootdir + len - 9) == 0) {
837 rootdir[len - 9] = 0;
840 /* Append the extension we asked for */
841 if (as->parms[2].items) {
842 strcat(rootdir, as->parms[2].items->data); /* -extension <ext> */
845 /* The mountpoint root is either specifid in -mountpoint
846 * or -dir or the current working dir.
848 if ((as->parms[3].items) || (as->parms[1].items)) { /* -mountpoint or -dir */
849 t = (char *)getcwd(thisdir, MAXPATHLEN); /* remember current dir */
852 "Cannot get pathname of current working directory: %s\n",
857 /* Change to the mount point dir */
859 chdir((as->parms[3].items ? as->parms[3].items->data : as->
860 parms[1].items->data));
862 fprintf(stderr, "Mount point directory not found: Error = %d\n",
866 t = (char *)getcwd(mntroot, MAXPATHLEN); /* get its full pathname */
869 "Cannot determine pathname of mount point root directory: %s\n",
874 strcat(mntroot, "/"); /* append '/' to end of it */
875 code = chdir(thisdir); /* return to original working dir */
877 fprintf(stderr, "Cannot find working directory: Error = %d\n",
881 } else { /* use current directory */
882 t = (char *)getcwd(mntroot, MAXPATHLEN); /* get full pathname of current dir */
885 "Cannot determine pathname of current working directory: %s\n",
891 strcat(mntroot, "/"); /* append '/' to end of it */
893 /* Set the umask for the restore */
894 if (as->parms[4].items) { /* -umask */
896 mask = strtol(as->parms[4].items->data, 0, 8);
897 fprintf(stderr, "Umask set to 0%03o\n", mask);
901 fprintf(stderr, "Restoring volume dump of '%s' to directory '%s'.\n",
902 dh.volumeName, rootdir);
903 code = mkdir(rootdir, 0777);
904 if ((code < 0) && (errno != EEXIST)) {
905 fprintf(stderr, "Error creating directory %s code=%d;%d\n", rootdir,
909 for (count = 1; type == 2; count++) {
910 type = ReadVolumeHeader(count);
911 for (vcount = 1; type == 3; vcount++)
912 type = ReadVNode(vcount);
916 fprintf(stderr, "Expected End-of-Dump\n");
922 /* For incremental restores, Follow each directory link and
923 * remove an "AFSFile" links.
926 fprintf(stderr, "An incremental dump.\n");
927 dirP = opendir(rootdir);
928 while (dirP && (dirE = readdir(dirP))) {
929 if (strncmp(dirE->d_name, ADIR, strlen(ADIR)) == 0) {
930 afs_snprintf(name, sizeof name, "%s/%s", rootdir,
932 dirQ = opendir(name);
933 while (dirQ && (dirF = readdir(dirQ))) {
934 if (strncmp(dirF->d_name, AFILE, strlen(AFILE)) == 0) {
935 afs_snprintf(name, sizeof name, "%s/%s/%s", rootdir,
936 dirE->d_name, dirF->d_name);
941 } else if (strncmp(dirE->d_name, AFILE, strlen(AFILE)) == 0) {
942 afs_snprintf(name, sizeof name, "%s/%s", rootdir,
950 /* Now go through and remove all the directory links */
951 dirP = opendir(rootdir);
952 while (dirP && (dirE = readdir(dirP))) {
953 if (strncmp(dirE->d_name, ADIR, strlen(ADIR)) == 0) {
954 afs_snprintf(name, sizeof name, "%s/%s", rootdir, dirE->d_name);
967 struct cmd_syndesc *ts;
972 ts = cmd_CreateSyntax(NULL, WorkerBee, NULL, "vldb check");
973 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "dump file");
974 cmd_AddParm(ts, "-dir", CMD_SINGLE, CMD_OPTIONAL, "restore dir");
975 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL, "name extension");
976 cmd_AddParm(ts, "-mountpoint", CMD_SINGLE, CMD_OPTIONAL,
978 cmd_AddParm(ts, "-umask", CMD_SINGLE, CMD_OPTIONAL, "mode mask");
980 return cmd_Dispatch(argc, argv);