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 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 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
)
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" OS_DIRSEP
"%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 struct cmd_syndesc
*ts
;
302 VolumePackageOptions opts
;
304 VOptDefaults(volumeUtility
, &opts
);
305 if (VInitVolumePackage2(volumeUtility
, &opts
)) {
306 fprintf(stderr
, "errors encountered initializing volume package, but "
307 "trying to continue anyway\n");
310 ts
= cmd_CreateSyntax(NULL
, handleit
, NULL
,
311 "Dump a volume to a 'vos dump' format file without using volserver");
312 cmd_AddParm(ts
, "-part", CMD_LIST
, CMD_OPTIONAL
, "AFS partition name");
313 cmd_AddParm(ts
, "-volumeid", CMD_LIST
, CMD_OPTIONAL
, "Volume id");
314 cmd_AddParm(ts
, "-file", CMD_LIST
, CMD_OPTIONAL
, "Dump filename");
315 cmd_AddParm(ts
, "-verbose", CMD_FLAG
, CMD_OPTIONAL
,
316 "Trace dump progress (very verbose)");
317 cmd_AddParm(ts
, "-time", CMD_SINGLE
, CMD_OPTIONAL
, "dump from time");
318 code
= cmd_Dispatch(argc
, argv
);
326 DumpDouble(int dumpfd
, char tag
, afs_uint32 value1
,
331 byte
*p
= (unsigned char *)tbuffer
;
336 res
= write(dumpfd
, tbuffer
, 9);
337 return ((res
== 9) ? 0 : VOLSERDUMPERROR
);
341 DumpInt32(int dumpfd
, char tag
, afs_uint32 value
)
344 byte
*p
= (unsigned char *)tbuffer
;
347 return ((write(dumpfd
, tbuffer
, 5) == 5) ? 0 : VOLSERDUMPERROR
);
351 DumpString(int dumpfd
, char tag
, char *s
)
355 code
= write(dumpfd
, &tag
, 1);
357 return VOLSERDUMPERROR
;
359 code
= write(dumpfd
, s
, n
);
361 return VOLSERDUMPERROR
;
367 DumpArrayInt32(int dumpfd
, char tag
, afs_uint32
* array
,
373 byte
*p
= (unsigned char *)tbuffer
;
376 code
= write(dumpfd
, tbuffer
, 3);
378 return VOLSERDUMPERROR
;
380 p
= (unsigned char *)tbuffer
;
381 v
= *array
++; /*this was register */
384 code
= write(dumpfd
, tbuffer
, 4);
386 return VOLSERDUMPERROR
;
395 DumpDumpHeader(int dumpfd
, Volume
* vp
, afs_int32 fromtime
)
398 afs_int32 dumpTimes
[2];
401 fprintf(stderr
, "dumping dump header\n");
404 code
= DumpDouble(dumpfd
, D_DUMPHEADER
, DUMPBEGINMAGIC
, DUMPVERSION
);
407 code
= DumpInt32(dumpfd
, 'v', V_id(vp
));
410 code
= DumpString(dumpfd
, 'n', V_name(vp
));
412 dumpTimes
[0] = fromtime
;
413 switch (V_type(vp
)) {
414 case readwriteVolume
:
415 dumpTimes
[1] = V_updateDate(vp
); /* until last update */
418 dumpTimes
[1] = V_creationDate(vp
); /* until clone was updated */
421 /* until backup was made */
422 dumpTimes
[1] = V_backupDate(vp
) != 0 ? V_backupDate(vp
) :
429 code
= DumpArrayInt32(dumpfd
, 't', (afs_uint32
*) dumpTimes
, 2);
438 return (DumpInt32(dumpfd
, D_DUMPEND
, DUMPENDMAGIC
));
442 DumpByte(int dumpfd
, char tag
, byte value
)
445 byte
*p
= (unsigned char *)tbuffer
;
448 return ((write(dumpfd
, tbuffer
, 2) == 2) ? 0 : VOLSERDUMPERROR
);
452 DumpTag(int dumpfd
, int tag
)
457 return ((write(dumpfd
, &p
, 1) == 1) ? 0 : VOLSERDUMPERROR
);
462 DumpBool(int dumpfd
, char tag
, unsigned int value
)
465 byte
*p
= (unsigned char *)tbuffer
;
468 return ((write(dumpfd
, tbuffer
, 2) == 2) ? 0 : VOLSERDUMPERROR
);
474 DumpVolumeHeader(int dumpfd
, Volume
* vp
)
479 fprintf(stderr
, "dumping volume header\n");
482 code
= DumpTag(dumpfd
, D_VOLUMEHEADER
);
484 code
= DumpInt32(dumpfd
, 'i', V_id(vp
));
486 code
= DumpInt32(dumpfd
, 'v', V_stamp(vp
).version
);
488 code
= DumpString(dumpfd
, 'n', V_name(vp
));
490 code
= DumpBool(dumpfd
, 's', V_inService(vp
));
492 code
= DumpBool(dumpfd
, 'b', V_blessed(vp
));
494 code
= DumpInt32(dumpfd
, 'u', V_uniquifier(vp
));
496 code
= DumpByte(dumpfd
, 't', (byte
) V_type(vp
));
498 code
= DumpInt32(dumpfd
, 'p', V_parentId(vp
));
500 code
= DumpInt32(dumpfd
, 'c', V_cloneId(vp
));
502 code
= DumpInt32(dumpfd
, 'q', V_maxquota(vp
));
504 code
= DumpInt32(dumpfd
, 'm', V_minquota(vp
));
506 code
= DumpInt32(dumpfd
, 'd', V_diskused(vp
));
508 code
= DumpInt32(dumpfd
, 'f', V_filecount(vp
));
510 code
= DumpInt32(dumpfd
, 'a', V_accountNumber(vp
));
512 code
= DumpInt32(dumpfd
, 'o', V_owner(vp
));
514 code
= DumpInt32(dumpfd
, 'C', V_creationDate(vp
)); /* Rw volume creation date */
516 code
= DumpInt32(dumpfd
, 'A', V_accessDate(vp
));
518 code
= DumpInt32(dumpfd
, 'U', V_updateDate(vp
));
520 code
= DumpInt32(dumpfd
, 'E', V_expirationDate(vp
));
522 code
= DumpInt32(dumpfd
, 'B', V_backupDate(vp
)); /* Rw volume backup clone date */
524 code
= DumpString(dumpfd
, 'O', V_offlineMessage(vp
));
527 * We do NOT dump the detailed volume statistics residing in the old
528 * motd field, since we cannot tell from the info in a dump whether
529 * statistics data has been put there. Instead, we dump a null string,
530 * just as if that was what the motd contained.
533 code
= DumpString(dumpfd
, 'M', "");
536 DumpArrayInt32(dumpfd
, 'W', (afs_uint32
*) V_weekUse(vp
),
537 sizeof(V_weekUse(vp
)) / sizeof(V_weekUse(vp
)[0]));
539 code
= DumpInt32(dumpfd
, 'D', V_dayUseDate(vp
));
541 code
= DumpInt32(dumpfd
, 'Z', V_dayUse(vp
));
546 DumpShort(int dumpfd
, char tag
, unsigned int value
)
549 byte
*p
= (unsigned char *)tbuffer
;
553 return ((write(dumpfd
, tbuffer
, 3) == 3) ? 0 : VOLSERDUMPERROR
);
557 DumpByteString(int dumpfd
, char tag
, byte
* bs
, int nbytes
)
561 code
= write(dumpfd
, &tag
, 1);
563 return VOLSERDUMPERROR
;
564 code
= write(dumpfd
, (char *)bs
, nbytes
);
566 return VOLSERDUMPERROR
;
572 DumpFile(int dumpfd
, int vnode
, FdHandle_t
* handleP
, struct VnodeDiskObject
*v
)
574 int code
= 0, failed_seek
= 0, failed_write
= 0;
576 afs_foff_t offset
= 0;
577 afs_sfsize_t nbytes
, howBig
;
580 afs_foff_t howFar
= 0;
585 struct afs_stat status
;
589 #include <sys/statfs.h>
590 struct statfs tstatfs
;
594 fprintf(stderr
, "dumping file for vnode %d\n", vnode
);
597 howBig
= _filelength(handleP
->fd_fd
);
601 afs_fstat(handleP
->fd_fd
, &status
);
602 howBig
= status
.st_size
;
605 /* Unfortunately in AIX valuable fields such as st_blksize are
606 * gone from the stat structure.
608 fstatfs(handleP
->fd_fd
, &tstatfs
);
609 howMany
= tstatfs
.f_bsize
;
611 howMany
= status
.st_blksize
;
612 #endif /* AFS_AIX_ENV */
613 #endif /* AFS_NT40_ENV */
616 size
= FDH_SIZE(handleP
);
619 fprintf(stderr
, " howBig = %u, howMany = %u, fdh size = %u\n",
620 (unsigned int) howBig
, (unsigned int) howMany
,
621 (unsigned int) size
);
623 SplitInt64(size
, hi
, lo
);
625 code
= DumpInt32(dumpfd
, 'f', lo
);
627 code
= DumpDouble(dumpfd
, 'h', hi
, lo
);
631 return VOLSERDUMPERROR
;
634 p
= (unsigned char *)malloc(howMany
);
636 fprintf(stderr
, "out of memory!\n");
637 return VOLSERDUMPERROR
;
640 /* loop through whole file, while we still have bytes left, and no errors, in chunks of howMany bytes */
641 for (nbytes
= size
; (nbytes
&& !failed_write
); nbytes
-= howMany
) {
642 if (nbytes
< howMany
)
645 /* Read the data - unless we know we can't */
646 n
= (failed_seek
? 0 : FDH_PREAD(handleP
, p
, howMany
, howFar
));
649 /* If read any good data and we null padded previously, log the
650 * amount that we had null padded.
652 if ((n
> 0) && pad
) {
653 fprintf(stderr
, "Null padding file %d bytes at offset %lld\n", pad
,
658 /* If didn't read enough data, null padd the rest of the buffer. This
659 * can happen if, for instance, the media has some bad spots. We don't
660 * want to quit the dump, so we start null padding.
664 if (verbose
) fprintf(stderr
, " read %u instead of %u bytes.\n", (unsigned)n
, (unsigned)howMany
);
666 /* Record the read error */
669 fprintf(stderr
, "Error %d reading inode %s for vnode %d\n",
670 errno
, PrintInode(stmp
, handleP
->fd_ih
->ih_ino
),
673 fprintf(stderr
, "Error reading inode %s for vnode %d\n",
674 PrintInode(stmp
, handleP
->fd_ih
->ih_ino
), vnode
);
677 /* Pad the rest of the buffer with zeros. Remember offset we started
678 * padding. Keep total tally of padding.
680 memset(p
+ n
, 0, howMany
- n
);
682 offset
= (howBig
- nbytes
) + n
;
683 pad
+= (howMany
- n
);
685 /* Now seek over the data we could not get. An error here means we
686 * can't do the next read.
688 howFar
= ((size
- nbytes
) + howMany
);
691 /* Now write the data out */
692 if (write(dumpfd
, (char *)p
, howMany
) != howMany
)
693 failed_write
= VOLSERDUMPERROR
;
696 if (pad
) { /* Any padding we hadn't reported yet */
697 fprintf(stderr
, "Null padding file: %d bytes at offset %lld\n", pad
,
707 DumpVnode(int dumpfd
, struct VnodeDiskObject
*v
, int volid
, int vnodeNumber
,
708 int dumpEverything
, struct Volume
*vp
)
716 fprintf(stderr
, "dumping vnode %d\n", vnodeNumber
);
718 if (!v
|| v
->type
== vNull
)
721 code
= DumpDouble(dumpfd
, D_VNODE
, vnodeNumber
, v
->uniquifier
);
725 code
= DumpByte(dumpfd
, 't', (byte
) v
->type
);
727 code
= DumpShort(dumpfd
, 'l', v
->linkCount
); /* May not need this */
729 code
= DumpInt32(dumpfd
, 'v', v
->dataVersion
);
731 code
= DumpInt32(dumpfd
, 'm', v
->unixModifyTime
);
733 code
= DumpInt32(dumpfd
, 'a', v
->author
);
735 code
= DumpInt32(dumpfd
, 'o', v
->owner
);
736 if (!code
&& v
->group
)
737 code
= DumpInt32(dumpfd
, 'g', v
->group
); /* default group is 0 */
739 code
= DumpShort(dumpfd
, 'b', v
->modeBits
);
741 code
= DumpInt32(dumpfd
, 'p', v
->parent
);
743 code
= DumpInt32(dumpfd
, 's', v
->serverModifyTime
);
744 if (v
->type
== vDirectory
) {
745 code
= acl_HtonACL(VVnodeDiskACL(v
));
747 fprintf(stderr
, "Skipping invalid acl in vnode %u (volume %i)\n",
752 DumpByteString(dumpfd
, 'A', (byte
*) VVnodeDiskACL(v
),
756 if (VNDISK_GET_INO(v
)) {
757 IH_INIT(ihP
, V_device(vp
), V_parentId(vp
), VNDISK_GET_INO(v
));
761 "Unable to open inode %s for vnode %u (volume %i); not dumped, error %d\n",
762 PrintInode(stmp
, VNDISK_GET_INO(v
)), vnodeNumber
, volid
,
768 fprintf(stderr
, "about to dump inode %s for vnode %u\n",
769 PrintInode(stmp
, VNDISK_GET_INO(v
)), vnodeNumber
);
770 code
= DumpFile(dumpfd
, vnodeNumber
, fdP
, v
);
777 fprintf(stderr
, "done dumping vnode %d\n", vnodeNumber
);
783 DumpVnodeIndex(int dumpfd
, Volume
* vp
, VnodeClass
class, afs_int32 fromtime
,
787 struct VnodeClassInfo
*vcp
= &VnodeClassInfo
[class];
788 char buf
[SIZEOF_LARGEDISKVNODE
];
789 struct VnodeDiskObject
*vnode
= (struct VnodeDiskObject
*)buf
;
790 StreamHandle_t
*file
;
794 afs_foff_t offset
= 0;
795 int vnodeIndex
, nVnodes
= 0;
797 fdP
= IH_OPEN(vp
->vnodeIndex
[class].handle
);
798 file
= FDH_FDOPEN(fdP
, "r+");
799 size
= OS_SIZE(fdP
->fd_fd
);
800 nVnodes
= (size
/ vcp
->diskSize
) - 1;
803 STREAM_ASEEK(file
, vcp
->diskSize
);
807 nVnodes
&& STREAM_READ(vnode
, vcp
->diskSize
, 1, file
) == 1 && !code
;
808 nVnodes
--, vnodeIndex
++, offset
+= vcp
->diskSize
) {
809 flag
= forcedump
|| (vnode
->serverModifyTime
>= fromtime
);
810 /* Note: the >= test is very important since some old volumes may not have
811 * a serverModifyTime. For an epoch dump, this results in 0>=0 test, which
812 * does dump the file! */
814 fprintf(stderr
, "about to dump %s vnode %u (vnode offset = %lld)\n",
815 class == vSmall
? "vSmall" : "vLarge",
816 bitNumberToVnodeNumber(vnodeIndex
, class), (long long)offset
);
819 DumpVnode(dumpfd
, vnode
, V_id(vp
),
820 bitNumberToVnodeNumber(vnodeIndex
, class), flag
,
830 /* A partial dump (no dump header) */
832 DumpPartial(int dumpfd
, Volume
* vp
, afs_int32 fromtime
,
838 fprintf(stderr
, "about to dump the volume header\n");
840 code
= DumpVolumeHeader(dumpfd
, vp
);
843 fprintf(stderr
, "about to dump the large vnode index\n");
845 code
= DumpVnodeIndex(dumpfd
, vp
, vLarge
, fromtime
, dumpAllDirs
);
848 fprintf(stderr
, "about to dump the small vnode index\n");
850 code
= DumpVnodeIndex(dumpfd
, vp
, vSmall
, fromtime
, 0);
857 DoMyVolDump(Volume
* vp
, struct DiskPartition64
*dp
, char *dumpfile
, int fromtime
)
866 afs_open(dumpfile
, O_CREAT
| O_WRONLY
| O_TRUNC
, S_IRUSR
| S_IWUSR
);
868 fprintf(stderr
, "Failed to open dump file: %s. Exiting.\n",
869 afs_error_message(errno
));
873 dumpfd
= 1; /* stdout */
877 fprintf(stderr
, "about to dump the dump header\n");
879 code
= DumpDumpHeader(dumpfd
, vp
, fromtime
);
882 fprintf(stderr
, "about to dump volume contents\n");
884 code
= DumpPartial(dumpfd
, vp
, fromtime
, dumpAllDirs
);
887 fprintf(stderr
, "about to dump the dump postamble\n");
889 code
= DumpEnd(dumpfd
);
892 fprintf(stderr
, "finished dump\n");
893 close(dumpfd
); /* might be closing stdout, no harm */