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>
70 char rootdir[MAXPATHLEN];
71 char mntroot[MAXPATHLEN];
72 #define ADIR "AFSDir-"
73 #define AFILE "AFSFile-"
74 #define ODIR "__ORPHANEDIR__."
75 #define OFILE "__ORPHANFILE__."
90 s = sizeof(value) - size;
92 fprintf(stderr, "Too much data in afs_int32\n");
96 code = fread(&ptr[s], 1, size, dumpfile);
98 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
111 code = fread(&value, 1, 1, dumpfile);
113 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
118 #define BUFSIZE 16384
122 readdata(buffer, size)
131 s = (afs_int32) ((size > BUFSIZE) ? BUFSIZE : size);
132 code = fread(buf, 1, s, dumpfile);
134 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
138 code = fread(buffer, 1, size, dumpfile);
141 fprintf(stderr, "Code = %d; Errno = %d\n", code, errno);
143 fprintf(stderr, "Read %d bytes out of %lld\n", code, (afs_uintmax_t)size);
145 if ((code >= 0) && (code < BUFSIZE))
146 buffer[size] = 0; /* Add null char at end */
152 struct DumpHeader *dh; /* Defined in dump.h */
158 /* memset(&dh, 0, sizeof(dh)); */
160 magic = ntohl(readvalue(4));
161 dh->version = ntohl(readvalue(4));
168 dh->volumeId = ntohl(readvalue(4));
172 for (i = 0, c = 'a'; c != '\0'; i++) {
173 dh->volumeName[i] = c = readchar();
175 dh->volumeName[i] = c;
179 dh->nDumpTimes = ntohl(readvalue(2)) >> 1;
180 for (i = 0; i < dh->nDumpTimes; i++) {
181 dh->dumpTimes[i].from = ntohl(readvalue(4));
182 dh->dumpTimes[i].to = ntohl(readvalue(4));
192 return ((afs_int32) tag);
195 struct volumeHeader {
197 char volumeName[100];
199 afs_int32 uniquifier;
206 afs_int32 accountNumber;
208 afs_int32 creationDate;
209 afs_int32 accessDate;
210 afs_int32 updateDate;
211 afs_int32 expirationDate;
212 afs_int32 backupDate;
213 afs_int32 dayUseDate;
216 afs_int32 weekUse[100]; /* weekCount of these */
221 afs_int32 volUpdateCounter;
225 ReadVolumeHeader(count)
228 struct volumeHeader vh;
229 int code, i, done, entries;
232 /* memset(&vh, 0, sizeof(vh)); */
239 vh.volumeId = ntohl(readvalue(4));
243 ntohl(readvalue(4)); /* version stamp - ignore */
247 for (i = 0, c = 'a'; c != '\0'; i++) {
248 vh.volumeName[i] = c = readchar();
250 vh.volumeName[i] = c;
254 vh.inService = ntohl(readvalue(1));
258 vh.blessed = ntohl(readvalue(1));
262 vh.uniquifier = ntohl(readvalue(4));
266 vh.volType = ntohl(readvalue(1));
270 vh.parentVol = ntohl(readvalue(4));
274 vh.cloneId = ntohl(readvalue(4));
278 vh.maxQuota = ntohl(readvalue(4));
282 vh.minQuota = ntohl(readvalue(4));
286 vh.diskUsed = ntohl(readvalue(4));
290 vh.fileCount = ntohl(readvalue(4));
294 vh.accountNumber = ntohl(readvalue(4));
298 vh.owner = ntohl(readvalue(4));
302 vh.creationDate = ntohl(readvalue(4));
306 vh.accessDate = ntohl(readvalue(4));
310 vh.updateDate = ntohl(readvalue(4));
314 vh.expirationDate = ntohl(readvalue(4));
318 vh.backupDate = ntohl(readvalue(4));
322 for (i = 0, c = 'a'; c != '\0'; i++) {
323 vh.message[i] = c = readchar();
325 vh.volumeName[i] = c;
329 vh.weekCount = ntohl(readvalue(2));
330 for (i = 0; i < vh.weekCount; i++) {
331 vh.weekUse[i] = ntohl(readvalue(4));
336 for (i = 0, c = 'a'; c != '\0'; i++) {
337 vh.motd[i] = c = readchar();
342 vh.dayUseDate = ntohl(readvalue(4));
346 vh.dayUse = ntohl(readvalue(4));
349 vh.volUpdateCounter = ntohl(readvalue(4));
358 return ((afs_int32) tag);
363 afs_int32 uniquifier;
366 afs_int32 dataVersion;
367 afs_int32 unixModTime;
368 afs_int32 servModTime;
376 struct acl_accessList {
377 int size; /*size of this access list in bytes, including MySize itself */
378 int version; /*to deal with upward compatibility ; <= ACL_ACLVERSION */
380 int positive; /* number of positive entries */
381 int negative; /* number of minus entries */
382 struct acl_accessEntry {
383 int id; /*internally-used ID of user or group */
384 int rights; /*mask */
388 afs_sfsize_t dataSize;
391 #define MAXNAMELEN 256
398 int code, i, done, entries;
400 char dirname[MAXNAMELEN], linkname[MAXNAMELEN], lname[MAXNAMELEN];
401 char parentdir[MAXNAMELEN], vflink[MAXNAMELEN];
402 char filename[MAXNAMELEN], fname[MAXNAMELEN];
407 /* memset(&vn, 0, sizeof(vn)); */
413 vn.vnode = ntohl(readvalue(4));
414 vn.uniquifier = ntohl(readvalue(4));
421 vn.type = ntohl(readvalue(1));
425 vn.linkCount = ntohl(readvalue(2));
429 vn.dataVersion = ntohl(readvalue(4));
433 vn.unixModTime = ntohl(readvalue(4));
437 vn.servModTime = ntohl(readvalue(4));
441 vn.author = ntohl(readvalue(4));
445 vn.owner = ntohl(readvalue(4));
449 vn.group = ntohl(readvalue(4));
453 vn.modebits = ntohl(readvalue(2));
457 vn.parent = ntohl(readvalue(4));
461 readdata(vn.acl, 192); /* Skip ACL data */
464 #ifdef AFS_LARGEFILE_ENV
468 hi = ntohl(readvalue(4));
469 lo = ntohl(readvalue(4));
470 FillInt64(vn.dataSize, hi, lo);
473 #endif /* !AFS_LARGEFILE_ENV */
476 vn.dataSize = ntohl(readvalue(4));
479 /* parentdir is the name of this dir's vnode-file-link
480 * or this file's parent vnode-file-link.
481 * "./AFSDir-<#>". It's a symbolic link to its real dir.
482 * The parent dir and symbolic link to it must exist.
484 vnode = ((vn.type == 2) ? vn.vnode : vn.parent);
486 strncpy(parentdir, rootdir, sizeof parentdir);
488 afs_snprintf(parentdir, sizeof parentdir, "%s/%s%d", rootdir,
491 len = readlink(parentdir, linkname, MAXNAMELEN);
493 /* parentdir does not exist. So create an orphan dir.
494 * and then link the parentdir to the orphaned dir.
496 afs_snprintf(linkname, sizeof linkname, "%s/%s%d",
497 rootdir, ODIR, vnode);
498 code = mkdir(linkname, 0777);
499 if ((code < 0) && (errno != EEXIST)) {
501 "Error creating directory %s code=%d;%d\n",
502 linkname, code, errno);
505 /* Link the parentdir to it - now parentdir exists */
506 afs_snprintf(linkname, sizeof linkname, "%s%d/", ODIR,
508 code = symlink(linkname, parentdir);
511 "Error creating symlink %s -> %s code=%d;%d\n",
512 parentdir, linkname, code, errno);
519 /* We read the directory entries. If the entry is a
520 * directory, the subdir is created and the root dir
521 * will contain a link to it. If its a file, we only
522 * create a symlink in the dir to the file name.
541 unsigned short pgcount;
549 struct Pageheader header;
551 unsigned short hashTable[128];
555 struct DirHeader header;
556 struct DirEntry entry[1];
561 buffer = (char *)malloc(vn.dataSize);
563 readdata(buffer, vn.dataSize);
564 page0 = (struct Page0 *)buffer;
566 /* Step through each bucket in the hash table, i,
567 * and follow each element in the hash chain, j.
568 * This gives us each entry of the dir.
570 for (i = 0; i < 128; i++) {
571 for (j = ntohs(page0->header.hashTable[i]); j;
572 j = ntohs(page0->entry[j].next)) {
574 this_vn = ntohl(page0->entry[j].fid.vnode);
575 this_name = page0->entry[j].name;
577 if ((strcmp(this_name, ".") == 0)
578 || (strcmp(this_name, "..") == 0))
579 continue; /* Skip these */
581 /* For a directory entry, create it. Then create the
582 * link (from the rootdir) to this directory.
586 /* dirname is the directory to create.
587 * vflink is what will link to it.
589 afs_snprintf(dirname, sizeof dirname, "%s/%s",
590 parentdir, this_name);
591 afs_snprintf(vflink, sizeof vflink, "%s/%s%d",
592 rootdir, ADIR, this_vn);
594 /* The link and directory may already exist */
595 len = readlink(vflink, linkname, MAXNAMELEN);
597 /* Doesn't already exist - so create the directory.
598 * umask will pare the mode bits down.
600 code = mkdir(dirname, 0777);
601 if ((code < 0) && (errno != EEXIST)) {
603 "Error creating directory %s code=%d;%d\n",
604 dirname, code, errno);
607 /* Does already exist - so move the directory.
608 * It was created originally as orphaned.
610 linkname[len - 1] = '\0'; /* remove '/' at end */
611 afs_snprintf(lname, sizeof lname, "%s/%s",
613 code = rename(lname, dirname);
616 "Error renaming %s to %s code=%d;%d\n",
617 lname, dirname, code, errno);
621 /* Now create/update the link to the new/moved directory */
623 afs_snprintf(dirname, sizeof dirname, "%s/",
626 afs_snprintf(dirname, sizeof dirname,
627 "%s%d/%s/", ADIR, vn.vnode,
630 code = symlink(dirname, vflink);
633 "Error creating symlink %s -> %s code=%d;%d\n",
634 vflink, dirname, code, errno);
638 /* For a file entry, we remember the name of the file
639 * by creating a link within the directory. Restoring
640 * the file will later remove the link.
643 /*AFILEENTRY*/ afs_snprintf(vflink,
645 "%s/%s%d", parentdir,
648 code = symlink(this_name, vflink);
649 if ((code < 0) && (errno != EEXIST)) {
651 "Error creating symlink %s -> %s code=%d;%d\n",
652 vflink, page0->entry[j].name, code,
661 else if (vn.type == 1) {
663 /* A file vnode. So create it into the desired directory. A
664 * link should exist in the directory naming the file.
668 afs_sfsize_t size, s;
670 /* Check if its vnode-file-link exists. If not,
671 * then the file will be an orphaned file.
674 afs_snprintf(filename, sizeof filename, "%s/%s%d", parentdir,
676 len = readlink(filename, fname, MAXNAMELEN);
678 afs_snprintf(filename, sizeof filename, "%s/%s%d",
679 rootdir, OFILE, vn.vnode);
680 lfile = 0; /* no longer a linked file; a direct path */
683 /* Create a mode for the file. Use the owner bits and
684 * duplicate them across group and other. The umask
685 * will remove what we don't want.
687 mode = (vn.modebits >> 6) & 0x7;
688 mode |= (mode << 6) | (mode << 3);
690 /* Write the file out */
691 fid = open(filename, (O_CREAT | O_WRONLY | O_TRUNC), mode);
694 s = (afs_int32) ((size > BUFSIZE) ? BUFSIZE : size);
695 code = fread(buf, 1, s, dumpfile);
697 (void)write(fid, buf, code);
702 fprintf(stderr, "Code = %d; Errno = %d\n", code,
706 (void)afs_snprintf(tmp, sizeof tmp,
707 "Read %llu bytes out of %llu",
708 (afs_uintmax_t) (vn.dataSize -
710 (afs_uintmax_t) vn.dataSize);
711 fprintf(stderr, "%s\n", tmp);
718 fprintf(stderr, " File %s (%s) is incomplete\n",
722 /* Remove the link to the file */
728 else if (vn.type == 3) {
730 /* A symlink vnode. So read it into the desired directory. This could
731 * also be a mount point. If the volume is being restored to AFS, this
732 * will become a mountpoint. If not, it becomes a symlink to no-where.
737 /* Check if its vnode-file-link exists and create pathname
738 * of the symbolic link. If it doesn't exist,
739 * then the link will be an orphaned link.
741 afs_snprintf(linkname, sizeof linkname, "%s/%s%d", parentdir,
743 len = readlink(linkname, fname, MAXNAMELEN);
745 afs_snprintf(filename, sizeof filename, "%s/%s%d",
746 rootdir, OFILE, vn.vnode);
749 afs_snprintf(filename, sizeof filename, "%s/%s",
753 /* Read the link in, delete it, and then create it */
754 readdata(buf, vn.dataSize);
756 /* If a mountpoint, change its link path to mountroot */
758 if (((buf[0] == '%') || (buf[0] == '#'))
759 && (buf[s - 1] == '.')) {
760 /* This is a symbolic link */
761 buf[s - 1] = 0; /* Remove prefix '.' */
762 strcpy(lname, &buf[1]); /* Remove postfix '#' or '%' */
763 strcpy(buf, mntroot);
768 code = symlink(buf, filename);
771 "Error creating symlink %s -> %s code=%d;%d\n",
772 filename, buf, code, errno);
775 /* Remove the symbolic link */
780 fprintf(stderr, "Unknown Vnode block\n");
792 return ((afs_int32) tag);
796 WorkerBee(struct cmd_syndesc *as, void *arock)
798 int code = 0, c, len;
799 afs_int32 type, count, vcount;
801 struct dirent *dirE, *dirF;
802 char fname[MAXNAMELEN], name[MAXNAMELEN], lname[MAXNAMELEN],
804 char thisdir[MAXPATHLEN], *t;
805 struct DumpHeader dh; /* Defined in dump.h */
806 #if 0/*ndef HAVE_GETCWD*/ /* XXX enable when autoconf happens */
807 extern char *getwd();
808 #define getcwd(x,y) getwd(x)
811 if (as->parms[0].items) { /* -file <dumpfile> */
812 dumpfile = fopen(as->parms[0].items->data, "r");
814 fprintf(stderr, "Cannot open '%s'. Code = %d\n",
815 as->parms[0].items->data, errno);
819 dumpfile = (FILE *) stdin; /* use stdin */
822 /* Read the dump header. From it we get the volume name */
823 type = ntohl(readvalue(1));
825 fprintf(stderr, "Expected DumpHeader\n");
829 type = ReadDumpHeader(&dh);
831 /* Get the root directory we restore to */
832 if (as->parms[1].items) { /* -dir <rootdir> */
833 strcpy(rootdir, as->parms[1].items->data);
835 strcpy(rootdir, ".");
837 strcat(rootdir, "/");
839 /* Append the RW volume name to the root directory */
840 strcat(rootdir, dh.volumeName);
841 len = strlen(rootdir);
842 if (strcmp(".backup", rootdir + len - 7) == 0) {
843 rootdir[len - 7] = 0;
844 } else if (strcmp(".readonly", rootdir + len - 9) == 0) {
845 rootdir[len - 9] = 0;
848 /* Append the extension we asked for */
849 if (as->parms[2].items) {
850 strcat(rootdir, as->parms[2].items->data); /* -extension <ext> */
853 /* The mountpoint root is either specifid in -mountpoint
854 * or -dir or the current working dir.
856 if ((as->parms[3].items) || (as->parms[1].items)) { /* -mountpoint or -dir */
857 t = (char *)getcwd(thisdir, MAXPATHLEN); /* remember current dir */
860 "Cannot get pathname of current working directory: %s\n",
865 /* Change to the mount point dir */
867 chdir((as->parms[3].items ? as->parms[3].items->data : as->
868 parms[1].items->data));
870 fprintf(stderr, "Mount point directory not found: Error = %d\n",
874 t = (char *)getcwd(mntroot, MAXPATHLEN); /* get its full pathname */
877 "Cannot determine pathname of mount point root directory: %s\n",
882 strcat(mntroot, "/"); /* append '/' to end of it */
883 code = chdir(thisdir); /* return to original working dir */
885 fprintf(stderr, "Cannot find working directory: Error = %d\n",
889 } else { /* use current directory */
890 t = (char *)getcwd(mntroot, MAXPATHLEN); /* get full pathname of current dir */
893 "Cannot determine pathname of current working directory: %s\n",
899 strcat(mntroot, "/"); /* append '/' to end of it */
901 /* Set the umask for the restore */
902 if (as->parms[4].items) { /* -umask */
904 mask = strtol(as->parms[4].items->data, 0, 8);
905 fprintf(stderr, "Umask set to 0%03o\n", mask);
909 fprintf(stderr, "Restoring volume dump of '%s' to directory '%s'.\n",
910 dh.volumeName, rootdir);
911 code = mkdir(rootdir, 0777);
912 if ((code < 0) && (errno != EEXIST)) {
913 fprintf(stderr, "Error creating directory %s code=%d;%d\n", rootdir,
917 for (count = 1; type == 2; count++) {
918 type = ReadVolumeHeader(count);
919 for (vcount = 1; type == 3; vcount++)
920 type = ReadVNode(vcount);
924 fprintf(stderr, "Expected End-of-Dump\n");
930 /* For incremental restores, Follow each directory link and
931 * remove an "AFSFile" links.
934 fprintf(stderr, "An incremental dump.\n");
935 dirP = opendir(rootdir);
936 while (dirP && (dirE = readdir(dirP))) {
937 if (strncmp(dirE->d_name, ADIR, strlen(ADIR)) == 0) {
938 afs_snprintf(name, sizeof name, "%s/%s", rootdir,
940 dirQ = opendir(name);
941 while (dirQ && (dirF = readdir(dirQ))) {
942 if (strncmp(dirF->d_name, AFILE, strlen(AFILE)) == 0) {
943 afs_snprintf(name, sizeof name, "%s/%s/%s", rootdir,
944 dirE->d_name, dirF->d_name);
949 } else if (strncmp(dirE->d_name, AFILE, strlen(AFILE)) == 0) {
950 afs_snprintf(name, sizeof name, "%s/%s", rootdir,
958 /* Now go through and remove all the directory links */
959 dirP = opendir(rootdir);
960 while (dirP && (dirE = readdir(dirP))) {
961 if (strncmp(dirE->d_name, ADIR, strlen(ADIR)) == 0) {
962 afs_snprintf(name, sizeof name, "%s/%s", rootdir, dirE->d_name);
975 struct cmd_syndesc *ts;
980 ts = cmd_CreateSyntax(NULL, WorkerBee, NULL, "vldb check");
981 cmd_AddParm(ts, "-file", CMD_SINGLE, CMD_OPTIONAL, "dump file");
982 cmd_AddParm(ts, "-dir", CMD_SINGLE, CMD_OPTIONAL, "restore dir");
983 cmd_AddParm(ts, "-extension", CMD_SINGLE, CMD_OPTIONAL, "name extension");
984 cmd_AddParm(ts, "-mountpoint", CMD_SINGLE, CMD_OPTIONAL,
986 cmd_AddParm(ts, "-umask", CMD_SINGLE, CMD_OPTIONAL, "mode mask");
988 return cmd_Dispatch(argc, argv);