forked from openzfs/zfs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a "zstream decompress" subcommand
It can be used to repair a ZFS file system corrupted by ZFS bug 12762. Use it like this: zfs send -LRec <DS> | zstream decompress <INODE>,<OFFSET> ... | zfs recv -s <DST_DS> Workaround for openzfs#12762 Sponsored-by: Axcient Signed-off-by: Alan Somers <asomers@gmail.com>
- Loading branch information
Showing
7 changed files
with
296 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,264 @@ | ||
| /* | ||
| * CDDL HEADER START | ||
| * | ||
| * The contents of this file are subject to the terms of the | ||
| * Common Development and Distribution License (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * | ||
| * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE | ||
| * or http://www.opensolaris.org/os/licensing. | ||
| * See the License for the specific language governing permissions | ||
| * and limitations under the License. | ||
| * | ||
| * When distributing Covered Code, include this CDDL HEADER in each | ||
| * file and include the License file at usr/src/OPENSOLARIS.LICENSE. | ||
| * If applicable, add the following below this CDDL HEADER, with the | ||
| * fields enclosed by brackets "[]" replaced with your own identifying | ||
| * information: Portions Copyright [yyyy] [name of copyright owner] | ||
| * | ||
| * CDDL HEADER END | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright 2022 Axcient. All rights reserved. | ||
| * Use is subject to license terms. | ||
| */ | ||
|
|
||
| #include <err.h> | ||
| #include <search.h> | ||
| #include <stdio.h> | ||
| #include <stdlib.h> | ||
| #include <unistd.h> | ||
| #include <sys/zfs_ioctl.h> | ||
| #include <sys/zio_checksum.h> | ||
| #include "zfs_fletcher.h" | ||
| #include "zstream.h" | ||
|
|
||
| static int | ||
| dump_record(dmu_replay_record_t *drr, void *payload, int payload_len, | ||
| zio_cksum_t *zc, int outfd) | ||
| { | ||
| assert(offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum) | ||
| == sizeof (dmu_replay_record_t) - sizeof (zio_cksum_t)); | ||
| fletcher_4_incremental_native(drr, | ||
| offsetof(dmu_replay_record_t, drr_u.drr_checksum.drr_checksum), zc); | ||
| if (drr->drr_type != DRR_BEGIN) { | ||
| assert(ZIO_CHECKSUM_IS_ZERO(&drr->drr_u. | ||
| drr_checksum.drr_checksum)); | ||
| drr->drr_u.drr_checksum.drr_checksum = *zc; | ||
| } | ||
| fletcher_4_incremental_native(&drr->drr_u.drr_checksum.drr_checksum, | ||
| sizeof (zio_cksum_t), zc); | ||
| if (write(outfd, drr, sizeof (*drr)) == -1) | ||
| return (errno); | ||
| if (payload_len != 0) { | ||
| fletcher_4_incremental_native(payload, payload_len, zc); | ||
| if (write(outfd, payload, payload_len) == -1) | ||
| return (errno); | ||
| } | ||
| return (0); | ||
| } | ||
|
|
||
| int | ||
| zstream_do_decompress(int argc, char *argv[]) | ||
| { | ||
| int bufsz = SPA_MAXBLOCKSIZE; | ||
| char *buf = safe_malloc(bufsz); | ||
| dmu_replay_record_t thedrr; | ||
| dmu_replay_record_t *drr = &thedrr; | ||
| zio_cksum_t stream_cksum; | ||
| int i; | ||
|
|
||
| if (hcreate(argc) == 0) | ||
| errx(1, "hcreate"); | ||
| for(i = 0; i < argc; i++) { | ||
| ENTRY e = {.key = argv[i]}; | ||
| ENTRY *p; | ||
|
|
||
| p = hsearch(e, ENTER); | ||
| if (p == NULL) | ||
| errx(1, "hsearch"); | ||
| } | ||
|
|
||
| if (isatty(STDIN_FILENO)) { | ||
| (void) fprintf(stderr, | ||
| "Error: The send stream is a binary format " | ||
| "and can not be read from a\n" | ||
| "terminal. Standard input must be redirected, " | ||
| "or a file must be\n" | ||
| "specified as a command-line argument.\n"); | ||
| exit(1); | ||
| } | ||
|
|
||
| fletcher_4_init(); | ||
| while (sfread(drr, sizeof (*drr), stdin) != 0) { | ||
| struct drr_write *drrw; | ||
| uint64_t payload_size = 0; | ||
|
|
||
| /* | ||
| * We need to regenerate the checksum. | ||
| */ | ||
| if (drr->drr_type != DRR_BEGIN) { | ||
| memset(&drr->drr_u.drr_checksum.drr_checksum, 0, | ||
| sizeof (drr->drr_u.drr_checksum.drr_checksum)); | ||
| } | ||
|
|
||
| switch (drr->drr_type) { | ||
| case DRR_BEGIN: | ||
| { | ||
| ZIO_SET_CHECKSUM(&stream_cksum, 0, 0, 0, 0); | ||
|
|
||
| int sz = drr->drr_payloadlen; | ||
| if (sz != 0) { | ||
| if (sz > bufsz) { | ||
| free(buf); | ||
| buf = safe_calloc(sz); | ||
| bufsz = sz; | ||
| } | ||
| (void) sfread(buf, sz, stdin); | ||
| } | ||
| payload_size = sz; | ||
| break; | ||
| } | ||
| case DRR_END: | ||
| { | ||
| struct drr_end *drre = &drr->drr_u.drr_end; | ||
| /* | ||
| * Use the recalculated checksum, unless this is | ||
| * the END record of a stream package, which has | ||
| * no checksum. | ||
| */ | ||
| if (!ZIO_CHECKSUM_IS_ZERO(&drre->drr_checksum)) | ||
| drre->drr_checksum = stream_cksum; | ||
| break; | ||
| } | ||
|
|
||
| case DRR_OBJECT: | ||
| { | ||
| struct drr_object *drro = &drr->drr_u.drr_object; | ||
|
|
||
| if (drro->drr_bonuslen > 0) { | ||
| payload_size = DRR_OBJECT_PAYLOAD_SIZE(drro); | ||
| (void) sfread(buf, payload_size, stdin); | ||
| } | ||
| break; | ||
| } | ||
|
|
||
| case DRR_SPILL: | ||
| { | ||
| struct drr_spill *drrs = &drr->drr_u.drr_spill; | ||
| payload_size = DRR_SPILL_PAYLOAD_SIZE(drrs); | ||
| (void) sfread(buf, payload_size, stdin); | ||
| break; | ||
| } | ||
|
|
||
| case DRR_WRITE_BYREF: | ||
| fprintf(stderr, "Dedupliated streams are not supported\n"); | ||
| exit(1); | ||
| break; | ||
|
|
||
| case DRR_WRITE: | ||
| { | ||
| const int KEYSIZE = 64; | ||
| drrw = &thedrr.drr_u.drr_write; | ||
| payload_size = DRR_WRITE_PAYLOAD_SIZE(drrw); | ||
| char key[KEYSIZE]; | ||
|
|
||
| snprintf(key, KEYSIZE, "%llu,%llu", | ||
| (u_longlong_t)drrw->drr_object, | ||
| (u_longlong_t)drrw->drr_offset); | ||
| ENTRY e = {.key = key}; | ||
|
|
||
| if (hsearch(e, FIND) != NULL) { | ||
| /* | ||
| * Read and decompress the block | ||
| */ | ||
| char* lzbuf = calloc(1, payload_size); | ||
| (void) sfread(lzbuf, payload_size, stdin); | ||
| if (0 != lz4_decompress_zfs(lzbuf, buf, | ||
| payload_size, payload_size, 0)) | ||
| { | ||
| /* | ||
| * The block must not be compressed, | ||
| * possibly because it gets written | ||
| * multiple times in this stream. | ||
| */ | ||
| warnx("lz4_decompress_zfs failed for ino %lu offset %ld", | ||
| drrw->drr_object, drrw->drr_offset); | ||
| memcpy(buf, lzbuf, payload_size); | ||
| } else { | ||
| fprintf(stderr, "successfully decompressed ino %lu offset %ld.\n", | ||
| drrw->drr_object, drrw->drr_offset); | ||
| } | ||
| free(lzbuf); | ||
| } else { | ||
| /* | ||
| * Read the contents of the block unaltered | ||
| */ | ||
| (void) sfread(buf, payload_size, stdin); | ||
| } | ||
| break; | ||
| } | ||
|
|
||
| case DRR_WRITE_EMBEDDED: | ||
| { | ||
| struct drr_write_embedded *drrwe = | ||
| &drr->drr_u.drr_write_embedded; | ||
| payload_size = | ||
| P2ROUNDUP((uint64_t)drrwe->drr_psize, 8); | ||
| (void) sfread(buf, payload_size, stdin); | ||
| break; | ||
| } | ||
|
|
||
| case DRR_FREEOBJECTS: | ||
| case DRR_FREE: | ||
| case DRR_OBJECT_RANGE: | ||
| break; | ||
|
|
||
| default: | ||
| (void) fprintf(stderr, "INVALID record type 0x%x\n", | ||
| drr->drr_type); | ||
| /* should never happen, so assert */ | ||
| assert(B_FALSE); | ||
| } | ||
|
|
||
| if (feof(stdout)) { | ||
| fprintf(stderr, "Error: unexpected end-of-file\n"); | ||
| exit(1); | ||
| } | ||
| if (ferror(stdout)) { | ||
| fprintf(stderr, "Error while reading file: %s\n", | ||
| strerror(errno)); | ||
| exit(1); | ||
| } | ||
|
|
||
| /* | ||
| * We need to recalculate the checksum, and it needs to be | ||
| * initially zero to do that. BEGIN records don't have | ||
| * a checksum. | ||
| */ | ||
| if (drr->drr_type != DRR_BEGIN) { | ||
| memset(&drr->drr_u.drr_checksum.drr_checksum, 0, | ||
| sizeof (drr->drr_u.drr_checksum.drr_checksum)); | ||
| } | ||
| if (dump_record(drr, buf, payload_size, | ||
| &stream_cksum, STDOUT_FILENO) != 0) | ||
| break; | ||
| if (drr->drr_type == DRR_END) { | ||
| /* | ||
| * Typically the END record is either the last | ||
| * thing in the stream, or it is followed | ||
| * by a BEGIN record (which also zeros the checksum). | ||
| * However, a stream package ends with two END | ||
| * records. The last END record's checksum starts | ||
| * from zero. | ||
| */ | ||
| ZIO_SET_CHECKSUM(&stream_cksum, 0, 0, 0, 0); | ||
| } | ||
| } | ||
| free(buf); | ||
| fletcher_4_fini(); | ||
| hdestroy(); | ||
|
|
||
| return (0); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters