4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or https://opensource.org/licenses/CDDL-1.0.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
24 * Copyright (c) 2013 Steven Hartland. All rights reserved.
28 * zhack is a debugging tool that can write changes to ZFS pool using libzpool
29 * for testing purposes. Altering pools with zhack is unsupported and may
30 * result in corrupted pools.
38 #include <sys/zfs_context.h>
40 #include <sys/spa_impl.h>
43 #include <sys/zfs_znode.h>
44 #include <sys/dsl_synctask.h>
46 #include <sys/vdev_impl.h>
47 #include <sys/fs/zfs.h>
48 #include <sys/dmu_objset.h>
49 #include <sys/dsl_pool.h>
50 #include <sys/zio_checksum.h>
51 #include <sys/zio_compress.h>
52 #include <sys/zfeature.h>
53 #include <sys/dmu_tx.h>
54 #include <zfeature_common.h>
57 static importargs_t g_importargs
;
59 static boolean_t g_readonly
;
61 static __attribute__((noreturn
)) void
64 (void) fprintf(stderr
,
65 "Usage: zhack [-c cachefile] [-d dir] <subcommand> <args> ...\n"
66 "where <subcommand> <args> is one of the following:\n"
69 (void) fprintf(stderr
,
70 " feature stat <pool>\n"
71 " print information about enabled features\n"
72 " feature enable [-r] [-d desc] <pool> <feature>\n"
73 " add a new enabled feature to the pool\n"
74 " -d <desc> sets the feature's description\n"
75 " -r set read-only compatible flag for feature\n"
76 " feature ref [-md] <pool> <feature>\n"
77 " change the refcount on the given feature\n"
78 " -d decrease instead of increase the refcount\n"
79 " -m add the feature to the label if increasing refcount\n"
81 " <feature> : should be a feature guid\n"
83 " label repair <device>\n"
84 " repair corrupted label checksums\n"
86 " <device> : path to vdev\n");
91 static __attribute__((format(printf
, 3, 4))) __attribute__((noreturn
)) void
92 fatal(spa_t
*spa
, const void *tag
, const char *fmt
, ...)
98 (void) spa_export(g_pool
, NULL
, B_TRUE
, B_FALSE
);
102 (void) fputs("zhack: ", stderr
);
103 (void) vfprintf(stderr
, fmt
, ap
);
105 (void) fputc('\n', stderr
);
111 space_delta_cb(dmu_object_type_t bonustype
, const void *data
,
112 zfs_file_info_t
*zoi
)
114 (void) data
, (void) zoi
;
117 * Is it a valid type of object to track?
119 if (bonustype
!= DMU_OT_ZNODE
&& bonustype
!= DMU_OT_SA
)
121 (void) fprintf(stderr
, "modifying object that needs user accounting");
126 * Target is the dataset whose pool we want to open.
129 zhack_import(char *target
, boolean_t readonly
)
135 kernel_init(readonly
? SPA_MODE_READ
:
136 (SPA_MODE_READ
| SPA_MODE_WRITE
));
138 dmu_objset_register_type(DMU_OST_ZFS
, space_delta_cb
);
140 g_readonly
= readonly
;
141 g_importargs
.can_be_active
= readonly
;
142 g_pool
= strdup(target
);
144 libpc_handle_t lpch
= {
145 .lpc_lib_handle
= NULL
,
146 .lpc_ops
= &libzpool_config_ops
,
147 .lpc_printerr
= B_TRUE
149 error
= zpool_find_config(&lpch
, target
, &config
, &g_importargs
);
151 fatal(NULL
, FTAG
, "cannot import '%s'", target
);
155 VERIFY(nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) == 0);
156 VERIFY(nvlist_add_uint64(props
,
157 zpool_prop_to_name(ZPOOL_PROP_READONLY
), 1) == 0);
160 zfeature_checks_disable
= B_TRUE
;
161 error
= spa_import(target
, config
, props
,
162 (readonly
? ZFS_IMPORT_SKIP_MMP
: ZFS_IMPORT_NORMAL
));
163 fnvlist_free(config
);
164 zfeature_checks_disable
= B_FALSE
;
169 fatal(NULL
, FTAG
, "can't import '%s': %s", target
,
174 zhack_spa_open(char *target
, boolean_t readonly
, const void *tag
, spa_t
**spa
)
178 zhack_import(target
, readonly
);
180 zfeature_checks_disable
= B_TRUE
;
181 err
= spa_open(target
, spa
, tag
);
182 zfeature_checks_disable
= B_FALSE
;
185 fatal(*spa
, FTAG
, "cannot open '%s': %s", target
,
187 if (spa_version(*spa
) < SPA_VERSION_FEATURES
) {
188 fatal(*spa
, FTAG
, "'%s' has version %d, features not enabled",
189 target
, (int)spa_version(*spa
));
194 dump_obj(objset_t
*os
, uint64_t obj
, const char *name
)
199 (void) printf("%s_obj:\n", name
);
201 for (zap_cursor_init(&zc
, os
, obj
);
202 zap_cursor_retrieve(&zc
, &za
) == 0;
203 zap_cursor_advance(&zc
)) {
204 if (za
.za_integer_length
== 8) {
205 ASSERT(za
.za_num_integers
== 1);
206 (void) printf("\t%s = %llu\n",
207 za
.za_name
, (u_longlong_t
)za
.za_first_integer
);
209 ASSERT(za
.za_integer_length
== 1);
211 VERIFY(zap_lookup(os
, obj
, za
.za_name
,
212 1, sizeof (val
), val
) == 0);
213 (void) printf("\t%s = %s\n", za
.za_name
, val
);
216 zap_cursor_fini(&zc
);
222 nvlist_t
*nv
= spa
->spa_label_features
;
225 (void) printf("label config:\n");
226 for (pair
= nvlist_next_nvpair(nv
, NULL
);
228 pair
= nvlist_next_nvpair(nv
, pair
)) {
229 (void) printf("\t%s\n", nvpair_name(pair
));
234 zhack_do_feature_stat(int argc
, char **argv
)
244 (void) fprintf(stderr
, "error: missing pool name\n");
249 zhack_spa_open(target
, B_TRUE
, FTAG
, &spa
);
250 os
= spa
->spa_meta_objset
;
252 dump_obj(os
, spa
->spa_feat_for_read_obj
, "for_read");
253 dump_obj(os
, spa
->spa_feat_for_write_obj
, "for_write");
254 dump_obj(os
, spa
->spa_feat_desc_obj
, "descriptions");
255 if (spa_feature_is_active(spa
, SPA_FEATURE_ENABLED_TXG
)) {
256 dump_obj(os
, spa
->spa_feat_enabled_txg_obj
, "enabled_txg");
260 spa_close(spa
, FTAG
);
264 zhack_feature_enable_sync(void *arg
, dmu_tx_t
*tx
)
266 spa_t
*spa
= dmu_tx_pool(tx
)->dp_spa
;
267 zfeature_info_t
*feature
= arg
;
269 feature_enable_sync(spa
, feature
, tx
);
271 spa_history_log_internal(spa
, "zhack enable feature", tx
,
273 feature
->fi_guid
, feature
->fi_flags
);
277 zhack_do_feature_enable(int argc
, char **argv
)
283 zfeature_info_t feature
;
284 const spa_feature_t nodeps
[] = { SPA_FEATURE_NONE
};
287 * Features are not added to the pool's label until their refcounts
288 * are incremented, so fi_mos can just be left as false for now.
291 feature
.fi_uname
= "zhack";
292 feature
.fi_flags
= 0;
293 feature
.fi_depends
= nodeps
;
294 feature
.fi_feature
= SPA_FEATURE_NONE
;
297 while ((c
= getopt(argc
, argv
, "+rd:")) != -1) {
300 feature
.fi_flags
|= ZFEATURE_FLAG_READONLY_COMPAT
;
305 desc
= strdup(optarg
);
314 desc
= strdup("zhack injected");
315 feature
.fi_desc
= desc
;
321 (void) fprintf(stderr
, "error: missing feature or pool name\n");
325 feature
.fi_guid
= argv
[1];
327 if (!zfeature_is_valid_guid(feature
.fi_guid
))
328 fatal(NULL
, FTAG
, "invalid feature guid: %s", feature
.fi_guid
);
330 zhack_spa_open(target
, B_FALSE
, FTAG
, &spa
);
331 mos
= spa
->spa_meta_objset
;
333 if (zfeature_is_supported(feature
.fi_guid
))
334 fatal(spa
, FTAG
, "'%s' is a real feature, will not enable",
336 if (0 == zap_contains(mos
, spa
->spa_feat_desc_obj
, feature
.fi_guid
))
337 fatal(spa
, FTAG
, "feature already enabled: %s",
340 VERIFY0(dsl_sync_task(spa_name(spa
), NULL
,
341 zhack_feature_enable_sync
, &feature
, 5, ZFS_SPACE_CHECK_NORMAL
));
343 spa_close(spa
, FTAG
);
349 feature_incr_sync(void *arg
, dmu_tx_t
*tx
)
351 spa_t
*spa
= dmu_tx_pool(tx
)->dp_spa
;
352 zfeature_info_t
*feature
= arg
;
355 VERIFY0(feature_get_refcount_from_disk(spa
, feature
, &refcount
));
356 feature_sync(spa
, feature
, refcount
+ 1, tx
);
357 spa_history_log_internal(spa
, "zhack feature incr", tx
,
358 "name=%s", feature
->fi_guid
);
362 feature_decr_sync(void *arg
, dmu_tx_t
*tx
)
364 spa_t
*spa
= dmu_tx_pool(tx
)->dp_spa
;
365 zfeature_info_t
*feature
= arg
;
368 VERIFY0(feature_get_refcount_from_disk(spa
, feature
, &refcount
));
369 feature_sync(spa
, feature
, refcount
- 1, tx
);
370 spa_history_log_internal(spa
, "zhack feature decr", tx
,
371 "name=%s", feature
->fi_guid
);
375 zhack_do_feature_ref(int argc
, char **argv
)
379 boolean_t decr
= B_FALSE
;
382 zfeature_info_t feature
;
383 const spa_feature_t nodeps
[] = { SPA_FEATURE_NONE
};
386 * fi_desc does not matter here because it was written to disk
387 * when the feature was enabled, but we need to properly set the
388 * feature for read or write based on the information we read off
391 feature
.fi_uname
= "zhack";
392 feature
.fi_flags
= 0;
393 feature
.fi_desc
= NULL
;
394 feature
.fi_depends
= nodeps
;
395 feature
.fi_feature
= SPA_FEATURE_NONE
;
398 while ((c
= getopt(argc
, argv
, "+md")) != -1) {
401 feature
.fi_flags
|= ZFEATURE_FLAG_MOS
;
415 (void) fprintf(stderr
, "error: missing feature or pool name\n");
419 feature
.fi_guid
= argv
[1];
421 if (!zfeature_is_valid_guid(feature
.fi_guid
))
422 fatal(NULL
, FTAG
, "invalid feature guid: %s", feature
.fi_guid
);
424 zhack_spa_open(target
, B_FALSE
, FTAG
, &spa
);
425 mos
= spa
->spa_meta_objset
;
427 if (zfeature_is_supported(feature
.fi_guid
)) {
429 "'%s' is a real feature, will not change refcount",
433 if (0 == zap_contains(mos
, spa
->spa_feat_for_read_obj
,
435 feature
.fi_flags
&= ~ZFEATURE_FLAG_READONLY_COMPAT
;
436 } else if (0 == zap_contains(mos
, spa
->spa_feat_for_write_obj
,
438 feature
.fi_flags
|= ZFEATURE_FLAG_READONLY_COMPAT
;
440 fatal(spa
, FTAG
, "feature is not enabled: %s", feature
.fi_guid
);
445 if (feature_get_refcount_from_disk(spa
, &feature
,
446 &count
) == 0 && count
== 0) {
447 fatal(spa
, FTAG
, "feature refcount already 0: %s",
452 VERIFY0(dsl_sync_task(spa_name(spa
), NULL
,
453 decr
? feature_decr_sync
: feature_incr_sync
, &feature
,
454 5, ZFS_SPACE_CHECK_NORMAL
));
456 spa_close(spa
, FTAG
);
460 zhack_do_feature(int argc
, char **argv
)
467 (void) fprintf(stderr
,
468 "error: no feature operation specified\n");
472 subcommand
= argv
[0];
473 if (strcmp(subcommand
, "stat") == 0) {
474 zhack_do_feature_stat(argc
, argv
);
475 } else if (strcmp(subcommand
, "enable") == 0) {
476 zhack_do_feature_enable(argc
, argv
);
477 } else if (strcmp(subcommand
, "ref") == 0) {
478 zhack_do_feature_ref(argc
, argv
);
480 (void) fprintf(stderr
, "error: unknown subcommand: %s\n",
489 zhack_repair_label_cksum(int argc
, char **argv
)
491 zio_checksum_info_t
*ci
= &zio_checksum_table
[ZIO_CHECKSUM_LABEL
];
492 const char *cfg_keys
[] = { ZPOOL_CONFIG_VERSION
,
493 ZPOOL_CONFIG_POOL_STATE
, ZPOOL_CONFIG_GUID
};
494 boolean_t labels_repaired
[VDEV_LABELS
] = {0};
495 boolean_t repaired
= B_FALSE
;
496 vdev_label_t labels
[VDEV_LABELS
] = {{{0}}};
506 (void) fprintf(stderr
, "error: missing device\n");
510 if ((fd
= open(argv
[0], O_RDWR
)) == -1)
511 fatal(NULL
, FTAG
, "cannot open '%s': %s", argv
[0],
514 if (stat(argv
[0], &st
) != 0)
515 fatal(NULL
, FTAG
, "cannot stat '%s': %s", argv
[0],
518 for (int l
= 0; l
< VDEV_LABELS
; l
++) {
519 uint64_t label_offset
, offset
;
520 zio_cksum_t expected_cksum
;
521 zio_cksum_t actual_cksum
;
522 zio_cksum_t verifier
;
529 vdev_label_t
*vl
= &labels
[l
];
531 label_offset
= vdev_label_offset(st
.st_size
, l
, 0);
532 err
= pread64(fd
, vl
, sizeof (vdev_label_t
), label_offset
);
534 (void) fprintf(stderr
, "error: cannot read "
535 "label %d: %s\n", l
, strerror(errno
));
537 } else if (err
!= sizeof (vdev_label_t
)) {
538 (void) fprintf(stderr
, "error: bad label %d read size "
543 err
= nvlist_unpack(vl
->vl_vdev_phys
.vp_nvlist
,
544 VDEV_PHYS_SIZE
- sizeof (zio_eck_t
), &cfg
, 0);
546 (void) fprintf(stderr
, "error: cannot unpack nvlist "
551 for (int i
= 0; i
< ARRAY_SIZE(cfg_keys
); i
++) {
552 err
= nvlist_lookup_uint64(cfg
, cfg_keys
[i
], &val
);
554 (void) fprintf(stderr
, "error: label %d: "
555 "cannot find nvlist key %s\n",
561 void *data
= (char *)vl
+ offsetof(vdev_label_t
, vl_vdev_phys
);
562 eck
= (zio_eck_t
*)((char *)(data
) + VDEV_PHYS_SIZE
) - 1;
564 offset
= label_offset
+ offsetof(vdev_label_t
, vl_vdev_phys
);
565 ZIO_SET_CHECKSUM(&verifier
, offset
, 0, 0, 0);
567 byteswap
= (eck
->zec_magic
== BSWAP_64(ZEC_MAGIC
));
569 byteswap_uint64_array(&verifier
, sizeof (zio_cksum_t
));
571 expected_cksum
= eck
->zec_cksum
;
572 eck
->zec_cksum
= verifier
;
574 abd_t
*abd
= abd_get_from_buf(data
, VDEV_PHYS_SIZE
);
575 ci
->ci_func
[byteswap
](abd
, VDEV_PHYS_SIZE
, NULL
, &actual_cksum
);
579 byteswap_uint64_array(&expected_cksum
,
580 sizeof (zio_cksum_t
));
582 if (ZIO_CHECKSUM_EQUAL(actual_cksum
, expected_cksum
))
585 eck
->zec_cksum
= actual_cksum
;
587 err
= pwrite64(fd
, data
, VDEV_PHYS_SIZE
, offset
);
589 (void) fprintf(stderr
, "error: cannot write "
590 "label %d: %s\n", l
, strerror(errno
));
592 } else if (err
!= VDEV_PHYS_SIZE
) {
593 (void) fprintf(stderr
, "error: bad write size "
600 labels_repaired
[l
] = B_TRUE
;
607 for (int l
= 0; l
< VDEV_LABELS
; l
++) {
608 (void) printf("label %d: %s\n", l
,
609 labels_repaired
[l
] ? "repaired" : "skipped");
610 repaired
|= labels_repaired
[l
];
620 zhack_do_label(int argc
, char **argv
)
628 (void) fprintf(stderr
,
629 "error: no label operation specified\n");
633 subcommand
= argv
[0];
634 if (strcmp(subcommand
, "repair") == 0) {
635 err
= zhack_repair_label_cksum(argc
, argv
);
637 (void) fprintf(stderr
, "error: unknown subcommand: %s\n",
645 #define MAX_NUM_PATHS 1024
648 main(int argc
, char **argv
)
650 char *path
[MAX_NUM_PATHS
];
651 const char *subcommand
;
655 g_importargs
.path
= path
;
657 dprintf_setup(&argc
, argv
);
660 while ((c
= getopt(argc
, argv
, "+c:d:")) != -1) {
663 g_importargs
.cachefile
= optarg
;
666 assert(g_importargs
.paths
< MAX_NUM_PATHS
);
667 g_importargs
.path
[g_importargs
.paths
++] = optarg
;
680 (void) fprintf(stderr
, "error: no command specified\n");
684 subcommand
= argv
[0];
686 if (strcmp(subcommand
, "feature") == 0) {
687 rv
= zhack_do_feature(argc
, argv
);
688 } else if (strcmp(subcommand
, "label") == 0) {
689 return (zhack_do_label(argc
, argv
));
691 (void) fprintf(stderr
, "error: unknown subcommand: %s\n",
696 if (!g_readonly
&& spa_export(g_pool
, NULL
, B_TRUE
, B_FALSE
) != 0) {
697 fatal(NULL
, FTAG
, "pool export failed; "
698 "changes may not be committed to disk\n");