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
13 Institution: The Information Technology Center, Carnegie-Mellon University
17 #include <afsconfig.h>
18 #include <afs/param.h>
20 #ifdef IGNORE_SOME_GCC_WARNINGS
21 # pragma GCC diagnostic warning "-Wformat"
34 #include <sys/param.h>
41 #include <afs/afsint.h>
43 #include <afs/errors.h>
46 #include <afs/afssyscalls.h>
47 #include <afs/ihandle.h>
48 #include <afs/vnode.h>
49 #include <afs/volume.h>
50 #include <afs/partition.h>
51 #include <afs/viceinode.h>
52 #include <afs/afssyscalls.h>
55 #include <afs/com_err.h>
79 #define putint32(p, v) *p++ = v>>24, *p++ = v>>16, *p++ = v>>8, *p++ = v
80 #define putshort(p, v) *p++ = v>>8, *p++ = v
83 #define afs_stat stat64
84 #define afs_fstat fstat64
85 #define afs_open open64
86 #else /* !O_LARGEFILE */
88 #define afs_fstat fstat
90 #endif /* !O_LARGEFILE */
92 int VolumeChanged; /* needed by physio - leave alone */
95 /* Forward Declarations */
96 void HandleVolume(struct DiskPartition64 *partP, char *name, char *filename, int fromtime);
97 Volume *AttachVolume(struct DiskPartition64 *dp, char *volname,
98 register struct VolumeHeader *header);
99 static void DoMyVolDump(Volume * vp, struct DiskPartition64 *dp,
100 char *dumpfile, int fromtime);
103 #include "AFS_component_version_number.c"
106 char name[VMAXPATHLEN];
110 ReadHdr1(IHandle_t * ih, char *to, int size, u_int magic, u_int version)
114 code = IH_IREAD(ih, 0, to, size);
123 AttachVolume(struct DiskPartition64 * dp, char *volname,
124 register struct VolumeHeader * header)
129 vp = (Volume *) calloc(1, sizeof(Volume));
130 vp->specialStatus = 0;
131 vp->device = dp->device;
133 IH_INIT(vp->vnodeIndex[vLarge].handle, dp->device, header->parent,
134 header->largeVnodeIndex);
135 IH_INIT(vp->vnodeIndex[vSmall].handle, dp->device, header->parent,
136 header->smallVnodeIndex);
137 IH_INIT(vp->diskDataHandle, dp->device, header->parent,
139 IH_INIT(V_linkHandle(vp), dp->device, header->parent, header->linkTable);
140 vp->cacheCheck = 0; /* XXXX */
141 vp->shuttingDown = 0;
142 vp->goingOffline = 0;
144 vp->header = (struct volHeader *)calloc(1, sizeof(*vp->header));
145 ec = ReadHdr1(V_diskDataHandle(vp), (char *)&V_disk(vp),
146 sizeof(V_disk(vp)), VOLUMEINFOMAGIC, VOLUMEINFOVERSION);
148 struct IndexFileHeader iHead;
149 ec = ReadHdr1(vp->vnodeIndex[vSmall].handle, (char *)&iHead,
150 sizeof(iHead), SMALLINDEXMAGIC, SMALLINDEXVERSION);
153 struct IndexFileHeader iHead;
154 ec = ReadHdr1(vp->vnodeIndex[vLarge].handle, (char *)&iHead,
155 sizeof(iHead), LARGEINDEXMAGIC, LARGEINDEXVERSION);
159 struct versionStamp stamp;
160 ec = ReadHdr1(V_linkHandle(vp), (char *)&stamp, sizeof(stamp),
161 LINKTABLEMAGIC, LINKTABLEVERSION);
171 handleit(struct cmd_syndesc *as, void *arock)
173 register struct cmd_item *ti;
175 afs_uint32 volumeId = 0;
177 char *fileName = NULL;
178 struct DiskPartition64 *partP = NULL;
180 char tmpPartName[20];
187 if (geteuid() != 0) {
188 fprintf(stderr, "voldump must be run as root; sorry\n");
194 if ((ti = as->parms[0].items))
196 if ((ti = as->parms[1].items))
197 volumeId = (afs_uint32)atoi(ti->data);
198 if ((ti = as->parms[2].items))
200 if ((ti = as->parms[3].items))
202 if (as->parms[4].items && strcmp(as->parms[4].items->data, "0")) {
203 code = ktime_DateToInt32(as->parms[4].items->data, &fromtime);
205 fprintf(STDERR, "failed to parse date '%s' (error=%d))\n",
206 as->parms[4].items->data, code);
213 err = VAttachPartitions();
215 fprintf(stderr, "%d partitions had errors during attach.\n", err);
219 if (strlen(partName) == 1) {
220 if (partName[0] >= 'a' && partName[0] <= 'z') {
221 strcpy(tmpPartName, "/vicepa");
222 tmpPartName[6] = partName[0];
223 partP = VGetPartition(tmpPartName, 0);
226 partP = VGetPartition(partName, 0);
230 "%s is not an AFS partition name on this server.\n",
237 fprintf(stderr, "Must specify volume id!\n");
242 fprintf(stderr, "must specify vice partition.\n");
246 (void)afs_snprintf(name1, sizeof name1, VFORMAT, (unsigned long)volumeId);
247 HandleVolume(partP, name1, fileName, fromtime);
252 HandleVolume(struct DiskPartition64 *dp, char *name, char *filename, int fromtime)
254 struct VolumeHeader header;
255 struct VolumeDiskHeader diskHeader;
256 struct afs_stat status;
259 char headerName[1024];
263 (void)afs_snprintf(headerName, sizeof headerName, "%s/%s",
264 VPartitionPath(dp), name);
265 if ((fd = afs_open(headerName, O_RDONLY)) == -1
266 || afs_fstat(fd, &status) == -1) {
267 fprintf(stderr, "Cannot read volume header %s\n", name);
271 n = read(fd, &diskHeader, sizeof(diskHeader));
273 if (n != sizeof(diskHeader)
274 || diskHeader.stamp.magic != VOLUMEHEADERMAGIC) {
275 fprintf(stderr, "Error reading volume header %s\n", name);
278 if (diskHeader.stamp.version != VOLUMEHEADERVERSION) {
280 "Volume %s, version number is incorrect; volume needs salvage\n",
284 DiskToVolumeHeader(&header, &diskHeader);
287 vp = AttachVolume(dp, name, &header);
289 fprintf(stderr, "Error attaching volume header %s\n", name);
293 DoMyVolDump(vp, dp, filename, fromtime);
298 main(int argc, char **argv)
300 register struct cmd_syndesc *ts;
303 VInitVolumePackage(volumeUtility, 5, 5, DONT_CONNECT_FS, 0);
305 ts = cmd_CreateSyntax(NULL, handleit, NULL,
306 "Dump a volume to a 'vos dump' format file without using volserver");
307 cmd_AddParm(ts, "-part", CMD_LIST, CMD_OPTIONAL, "AFS partition name");
308 cmd_AddParm(ts, "-volumeid", CMD_LIST, CMD_OPTIONAL, "Volume id");
309 cmd_AddParm(ts, "-file", CMD_LIST, CMD_OPTIONAL, "Dump filename");
310 cmd_AddParm(ts, "-verbose", CMD_FLAG, CMD_OPTIONAL,
311 "Trace dump progress (very verbose)");
312 cmd_AddParm(ts, "-time", CMD_SINGLE, CMD_OPTIONAL, "dump from time");
313 code = cmd_Dispatch(argc, argv);
321 DumpDouble(int dumpfd, char tag, register afs_uint32 value1,
322 register afs_uint32 value2)
326 register byte *p = (unsigned char *)tbuffer;
331 res = write(dumpfd, tbuffer, 9);
332 return ((res == 9) ? 0 : VOLSERDUMPERROR);
336 DumpInt32(int dumpfd, char tag, register afs_uint32 value)
339 register byte *p = (unsigned char *)tbuffer;
342 return ((write(dumpfd, tbuffer, 5) == 5) ? 0 : VOLSERDUMPERROR);
346 DumpString(int dumpfd, char tag, register char *s)
350 code = write(dumpfd, &tag, 1);
352 return VOLSERDUMPERROR;
354 code = write(dumpfd, s, n);
356 return VOLSERDUMPERROR;
362 DumpArrayInt32(int dumpfd, char tag, register afs_uint32 * array,
366 register afs_uint32 v;
368 register byte *p = (unsigned char *)tbuffer;
371 code = write(dumpfd, tbuffer, 3);
373 return VOLSERDUMPERROR;
375 p = (unsigned char *)tbuffer;
376 v = *array++; /*this was register */
379 code = write(dumpfd, tbuffer, 4);
381 return VOLSERDUMPERROR;
390 DumpDumpHeader(int dumpfd, register Volume * vp, afs_int32 fromtime)
393 afs_int32 dumpTimes[2];
396 fprintf(stderr, "dumping dump header\n");
399 code = DumpDouble(dumpfd, D_DUMPHEADER, DUMPBEGINMAGIC, DUMPVERSION);
402 code = DumpInt32(dumpfd, 'v', V_id(vp));
405 code = DumpString(dumpfd, 'n', V_name(vp));
407 dumpTimes[0] = fromtime;
408 dumpTimes[1] = V_backupDate(vp); /* Until the time the clone was made */
410 code = DumpArrayInt32(dumpfd, 't', (afs_uint32 *) dumpTimes, 2);
419 return (DumpInt32(dumpfd, D_DUMPEND, DUMPENDMAGIC));
423 DumpByte(int dumpfd, char tag, byte value)
426 register byte *p = (unsigned char *)tbuffer;
429 return ((write(dumpfd, tbuffer, 2) == 2) ? 0 : VOLSERDUMPERROR);
433 DumpTag(int dumpfd, register int tag)
438 return ((write(dumpfd, &p, 1) == 1) ? 0 : VOLSERDUMPERROR);
443 DumpBool(int dumpfd, char tag, unsigned int value)
446 register byte *p = (unsigned char *)tbuffer;
449 return ((write(dumpfd, tbuffer, 2) == 2) ? 0 : VOLSERDUMPERROR);
455 DumpVolumeHeader(int dumpfd, register Volume * vp)
460 fprintf(stderr, "dumping volume header\n");
463 code = DumpTag(dumpfd, D_VOLUMEHEADER);
465 code = DumpInt32(dumpfd, 'i', V_id(vp));
467 code = DumpInt32(dumpfd, 'v', V_stamp(vp).version);
469 code = DumpString(dumpfd, 'n', V_name(vp));
471 code = DumpBool(dumpfd, 's', V_inService(vp));
473 code = DumpBool(dumpfd, 'b', V_blessed(vp));
475 code = DumpInt32(dumpfd, 'u', V_uniquifier(vp));
477 code = DumpByte(dumpfd, 't', (byte) V_type(vp));
479 code = DumpInt32(dumpfd, 'p', V_parentId(vp));
481 code = DumpInt32(dumpfd, 'c', V_cloneId(vp));
483 code = DumpInt32(dumpfd, 'q', V_maxquota(vp));
485 code = DumpInt32(dumpfd, 'm', V_minquota(vp));
487 code = DumpInt32(dumpfd, 'd', V_diskused(vp));
489 code = DumpInt32(dumpfd, 'f', V_filecount(vp));
491 code = DumpInt32(dumpfd, 'a', V_accountNumber(vp));
493 code = DumpInt32(dumpfd, 'o', V_owner(vp));
495 code = DumpInt32(dumpfd, 'C', V_creationDate(vp)); /* Rw volume creation date */
497 code = DumpInt32(dumpfd, 'A', V_accessDate(vp));
499 code = DumpInt32(dumpfd, 'U', V_updateDate(vp));
501 code = DumpInt32(dumpfd, 'E', V_expirationDate(vp));
503 code = DumpInt32(dumpfd, 'B', V_backupDate(vp)); /* Rw volume backup clone date */
505 code = DumpString(dumpfd, 'O', V_offlineMessage(vp));
508 * We do NOT dump the detailed volume statistics residing in the old
509 * motd field, since we cannot tell from the info in a dump whether
510 * statistics data has been put there. Instead, we dump a null string,
511 * just as if that was what the motd contained.
514 code = DumpString(dumpfd, 'M', "");
517 DumpArrayInt32(dumpfd, 'W', (afs_uint32 *) V_weekUse(vp),
518 sizeof(V_weekUse(vp)) / sizeof(V_weekUse(vp)[0]));
520 code = DumpInt32(dumpfd, 'D', V_dayUseDate(vp));
522 code = DumpInt32(dumpfd, 'Z', V_dayUse(vp));
527 DumpShort(int dumpfd, char tag, unsigned int value)
530 register byte *p = (unsigned char *)tbuffer;
534 return ((write(dumpfd, tbuffer, 3) == 3) ? 0 : VOLSERDUMPERROR);
538 DumpByteString(int dumpfd, char tag, register byte * bs, register int nbytes)
542 code = write(dumpfd, &tag, 1);
544 return VOLSERDUMPERROR;
545 code = write(dumpfd, (char *)bs, nbytes);
547 return VOLSERDUMPERROR;
553 DumpFile(int dumpfd, int vnode, FdHandle_t * handleP, struct VnodeDiskObject *v)
555 int code = 0, failed_seek = 0, failed_write = 0;
557 afs_int32 offset = 0;
558 afs_sfsize_t n, nbytes, howMany, howBig;
561 struct afs_stat status;
565 #include <sys/statfs.h>
566 struct statfs tstatfs;
570 fprintf(stderr, "dumping file for vnode %d\n", vnode);
573 howBig = _filelength(handleP->fd_fd);
577 afs_fstat(handleP->fd_fd, &status);
578 howBig = status.st_size;
581 /* Unfortunately in AIX valuable fields such as st_blksize are
582 * gone from the stat structure.
584 fstatfs(handleP->fd_fd, &tstatfs);
585 howMany = tstatfs.f_bsize;
587 howMany = status.st_blksize;
588 #endif /* AFS_AIX_ENV */
589 #endif /* AFS_NT40_ENV */
592 size = FDH_SIZE(handleP);
595 fprintf(stderr, " howBig = %u, howMany = %u, fdh size = %u\n",
596 (unsigned int) howBig, (unsigned int) howMany,
597 (unsigned int) size);
599 #ifdef AFS_LARGEFILE_ENV
602 SplitInt64(size, hi, lo);
604 code = DumpInt32(dumpfd, 'f', lo);
606 code = DumpDouble(dumpfd, 'h', hi, lo);
609 #else /* !AFS_LARGEFILE_ENV */
610 code = DumpInt32(dumpfd, 'f', size);
611 #endif /* !AFS_LARGEFILE_ENV */
613 return VOLSERDUMPERROR;
616 p = (unsigned char *)malloc(howMany);
618 fprintf(stderr, "out of memory!\n");
619 return VOLSERDUMPERROR;
622 /* loop through whole file, while we still have bytes left, and no errors, in chunks of howMany bytes */
623 for (nbytes = size; (nbytes && !failed_write); nbytes -= howMany) {
624 if (nbytes < howMany)
627 /* Read the data - unless we know we can't */
628 n = (failed_seek ? 0 : FDH_READ(handleP, p, howMany));
630 /* If read any good data and we null padded previously, log the
631 * amount that we had null padded.
633 if ((n > 0) && pad) {
634 fprintf(stderr, "Null padding file %d bytes at offset %u\n", pad,
639 /* If didn't read enough data, null padd the rest of the buffer. This
640 * can happen if, for instance, the media has some bad spots. We don't
641 * want to quit the dump, so we start null padding.
645 if (verbose) fprintf(stderr, " read %u instead of %u bytes.\n", n, howMany);
647 /* Record the read error */
650 fprintf(stderr, "Error %d reading inode %s for vnode %d\n",
651 errno, PrintInode(NULL, handleP->fd_ih->ih_ino),
654 fprintf(stderr, "Error reading inode %s for vnode %d\n",
655 PrintInode(NULL, handleP->fd_ih->ih_ino), vnode);
658 /* Pad the rest of the buffer with zeros. Remember offset we started
659 * padding. Keep total tally of padding.
661 memset(p + n, 0, howMany - n);
663 offset = (howBig - nbytes) + n;
664 pad += (howMany - n);
666 /* Now seek over the data we could not get. An error here means we
667 * can't do the next read.
669 failed_seek = FDH_SEEK(handleP, ((size - nbytes) + howMany), SEEK_SET);
670 if (failed_seek != ((size - nbytes) + howMany)) {
671 if (failed_seek < 0) {
673 "Error %d seeking in inode %s for vnode %d\n",
674 errno, PrintInode(NULL, handleP->fd_ih->ih_ino),
678 "Error seeking in inode %s for vnode %d\n",
679 PrintInode(NULL, handleP->fd_ih->ih_ino), vnode);
687 /* Now write the data out */
688 if (write(dumpfd, (char *)p, howMany) != howMany)
689 failed_write = VOLSERDUMPERROR;
692 if (pad) { /* Any padding we hadn't reported yet */
693 fprintf(stderr, "Null padding file: %d bytes at offset %u\n", pad,
703 DumpVnode(int dumpfd, struct VnodeDiskObject *v, int volid, int vnodeNumber,
704 int dumpEverything, struct Volume *vp)
711 fprintf(stderr, "dumping vnode %d\n", vnodeNumber);
713 if (!v || v->type == vNull)
716 code = DumpDouble(dumpfd, D_VNODE, vnodeNumber, v->uniquifier);
720 code = DumpByte(dumpfd, 't', (byte) v->type);
722 code = DumpShort(dumpfd, 'l', v->linkCount); /* May not need this */
724 code = DumpInt32(dumpfd, 'v', v->dataVersion);
726 code = DumpInt32(dumpfd, 'm', v->unixModifyTime);
728 code = DumpInt32(dumpfd, 'a', v->author);
730 code = DumpInt32(dumpfd, 'o', v->owner);
731 if (!code && v->group)
732 code = DumpInt32(dumpfd, 'g', v->group); /* default group is 0 */
734 code = DumpShort(dumpfd, 'b', v->modeBits);
736 code = DumpInt32(dumpfd, 'p', v->parent);
738 code = DumpInt32(dumpfd, 's', v->serverModifyTime);
739 if (v->type == vDirectory) {
740 acl_HtonACL(VVnodeDiskACL(v));
743 DumpByteString(dumpfd, 'A', (byte *) VVnodeDiskACL(v),
747 if (VNDISK_GET_INO(v)) {
748 IH_INIT(ihP, V_device(vp), V_parentId(vp), VNDISK_GET_INO(v));
752 "Unable to open inode %s for vnode %u (volume %i); not dumped, error %d\n",
753 PrintInode(NULL, VNDISK_GET_INO(v)), vnodeNumber, volid,
759 fprintf(stderr, "about to dump inode %s for vnode %u\n",
760 PrintInode(NULL, VNDISK_GET_INO(v)), vnodeNumber);
761 code = DumpFile(dumpfd, vnodeNumber, fdP, v);
768 fprintf(stderr, "done dumping vnode %d\n", vnodeNumber);
774 DumpVnodeIndex(int dumpfd, Volume * vp, VnodeClass class, afs_int32 fromtime,
777 register int code = 0;
778 register struct VnodeClassInfo *vcp = &VnodeClassInfo[class];
779 char buf[SIZEOF_LARGEDISKVNODE];
780 struct VnodeDiskObject *vnode = (struct VnodeDiskObject *)buf;
781 StreamHandle_t *file;
786 register int vnodeIndex, nVnodes = 0;
788 fdP = IH_OPEN(vp->vnodeIndex[class].handle);
789 file = FDH_FDOPEN(fdP, "r+");
790 size = OS_SIZE(fdP->fd_fd);
791 nVnodes = (size / vcp->diskSize) - 1;
794 STREAM_SEEK(file, vcp->diskSize, 0);
798 nVnodes && STREAM_READ(vnode, vcp->diskSize, 1, file) == 1 && !code;
799 nVnodes--, vnodeIndex++, offset += vcp->diskSize) {
800 flag = forcedump || (vnode->serverModifyTime >= fromtime);
801 /* Note: the >= test is very important since some old volumes may not have
802 * a serverModifyTime. For an epoch dump, this results in 0>=0 test, which
803 * does dump the file! */
805 fprintf(stderr, "about to dump %s vnode %u (vnode offset = %u)\n",
806 class == vSmall ? "vSmall" : "vLarge",
807 bitNumberToVnodeNumber(vnodeIndex, class), offset);
810 DumpVnode(dumpfd, vnode, V_id(vp),
811 bitNumberToVnodeNumber(vnodeIndex, class), flag,
821 /* A partial dump (no dump header) */
823 DumpPartial(int dumpfd, register Volume * vp, afs_int32 fromtime,
829 fprintf(stderr, "about to dump the volume header\n");
831 code = DumpVolumeHeader(dumpfd, vp);
834 fprintf(stderr, "about to dump the large vnode index\n");
836 code = DumpVnodeIndex(dumpfd, vp, vLarge, fromtime, dumpAllDirs);
839 fprintf(stderr, "about to dump the small vnode index\n");
841 code = DumpVnodeIndex(dumpfd, vp, vSmall, fromtime, 0);
848 DoMyVolDump(Volume * vp, struct DiskPartition64 *dp, char *dumpfile, int fromtime)
857 afs_open(dumpfile, O_CREAT | O_WRONLY | O_TRUNC, S_IRUSR | S_IWUSR);
859 fprintf(stderr, "Failed to open dump file: %s. Exiting.\n",
860 afs_error_message(errno));
864 dumpfd = 1; /* stdout */
868 fprintf(stderr, "about to dump the dump header\n");
870 code = DumpDumpHeader(dumpfd, vp, fromtime);
873 fprintf(stderr, "about to dump volume contents\n");
875 code = DumpPartial(dumpfd, vp, fromtime, dumpAllDirs);
878 fprintf(stderr, "about to dump the dump postamble\n");
880 code = DumpEnd(dumpfd);
883 fprintf(stderr, "finished dump\n");
884 close(dumpfd); /* might be closing stdout, no harm */