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 http://www.opensolaris.org/os/licensing.
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.
36 #include <sys/zfs_context.h>
38 #include <sys/spa_impl.h>
41 #include <sys/zfs_znode.h>
42 #include <sys/dsl_synctask.h>
44 #include <sys/fs/zfs.h>
45 #include <sys/dmu_objset.h>
46 #include <sys/dsl_pool.h>
47 #include <sys/zio_checksum.h>
48 #include <sys/zio_compress.h>
49 #include <sys/zfeature.h>
50 #include <sys/dmu_tx.h>
53 extern boolean_t zfeature_checks_disable
;
55 const char cmdname
[] = "zhack";
56 libzfs_handle_t
*g_zfs
;
57 static importargs_t g_importargs
;
59 static boolean_t g_readonly
;
64 (void) fprintf(stderr
,
65 "Usage: %s [-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");
87 fatal(spa_t
*spa
, void *tag
, const char *fmt
, ...)
93 (void) spa_export(g_pool
, NULL
, B_TRUE
, B_FALSE
);
97 (void) fprintf(stderr
, "%s: ", cmdname
);
98 (void) vfprintf(stderr
, fmt
, ap
);
100 (void) fprintf(stderr
, "\n");
107 space_delta_cb(dmu_object_type_t bonustype
, void *data
,
108 uint64_t *userp
, uint64_t *groupp
)
111 * Is it a valid type of object to track?
113 if (bonustype
!= DMU_OT_ZNODE
&& bonustype
!= DMU_OT_SA
)
115 (void) fprintf(stderr
, "modifying object that needs user accounting");
121 * Target is the dataset whose pool we want to open.
124 import_pool(const char *target
, boolean_t readonly
)
135 kernel_init(readonly
? FREAD
: (FREAD
| FWRITE
));
136 g_zfs
= libzfs_init();
137 ASSERT(g_zfs
!= NULL
);
139 dmu_objset_register_type(DMU_OST_ZFS
, space_delta_cb
);
141 g_readonly
= readonly
;
144 * If we only want readonly access, it's OK if we find
145 * a potentially-active (ie, imported into the kernel) pool from the
148 if (readonly
&& spa_open(target
, &spa
, FTAG
) == 0) {
149 spa_close(spa
, FTAG
);
153 g_importargs
.unique
= B_TRUE
;
154 g_importargs
.can_be_active
= readonly
;
155 g_pool
= strdup(target
);
156 if ((sepp
= strpbrk(g_pool
, "/@")) != NULL
)
158 g_importargs
.poolname
= g_pool
;
159 pools
= zpool_search_import(g_zfs
, &g_importargs
);
161 if (nvlist_empty(pools
)) {
162 if (!g_importargs
.can_be_active
) {
163 g_importargs
.can_be_active
= B_TRUE
;
164 if (zpool_search_import(g_zfs
, &g_importargs
) != NULL
||
165 spa_open(target
, &spa
, FTAG
) == 0) {
166 fatal(spa
, FTAG
, "cannot import '%s': pool is "
167 "active; run " "\"zpool export %s\" "
168 "first\n", g_pool
, g_pool
);
172 fatal(NULL
, FTAG
, "cannot import '%s': no such pool "
173 "available\n", g_pool
);
176 elem
= nvlist_next_nvpair(pools
, NULL
);
177 name
= nvpair_name(elem
);
178 VERIFY(nvpair_value_nvlist(elem
, &config
) == 0);
182 VERIFY(nvlist_alloc(&props
, NV_UNIQUE_NAME
, 0) == 0);
183 VERIFY(nvlist_add_uint64(props
,
184 zpool_prop_to_name(ZPOOL_PROP_READONLY
), 1) == 0);
187 zfeature_checks_disable
= B_TRUE
;
188 error
= spa_import(name
, config
, props
, ZFS_IMPORT_NORMAL
);
189 zfeature_checks_disable
= B_FALSE
;
194 fatal(NULL
, FTAG
, "can't import '%s': %s", name
,
199 zhack_spa_open(const char *target
, boolean_t readonly
, void *tag
, spa_t
**spa
)
203 import_pool(target
, readonly
);
205 zfeature_checks_disable
= B_TRUE
;
206 err
= spa_open(target
, spa
, tag
);
207 zfeature_checks_disable
= B_FALSE
;
210 fatal(*spa
, FTAG
, "cannot open '%s': %s", target
,
212 if (spa_version(*spa
) < SPA_VERSION_FEATURES
) {
213 fatal(*spa
, FTAG
, "'%s' has version %d, features not enabled",
214 target
, (int)spa_version(*spa
));
219 dump_obj(objset_t
*os
, uint64_t obj
, const char *name
)
224 (void) printf("%s_obj:\n", name
);
226 for (zap_cursor_init(&zc
, os
, obj
);
227 zap_cursor_retrieve(&zc
, &za
) == 0;
228 zap_cursor_advance(&zc
)) {
229 if (za
.za_integer_length
== 8) {
230 ASSERT(za
.za_num_integers
== 1);
231 (void) printf("\t%s = %llu\n",
232 za
.za_name
, (u_longlong_t
)za
.za_first_integer
);
234 ASSERT(za
.za_integer_length
== 1);
236 VERIFY(zap_lookup(os
, obj
, za
.za_name
,
237 1, sizeof (val
), val
) == 0);
238 (void) printf("\t%s = %s\n", za
.za_name
, val
);
241 zap_cursor_fini(&zc
);
247 nvlist_t
*nv
= spa
->spa_label_features
;
250 (void) printf("label config:\n");
251 for (pair
= nvlist_next_nvpair(nv
, NULL
);
253 pair
= nvlist_next_nvpair(nv
, pair
)) {
254 (void) printf("\t%s\n", nvpair_name(pair
));
259 zhack_do_feature_stat(int argc
, char **argv
)
269 (void) fprintf(stderr
, "error: missing pool name\n");
274 zhack_spa_open(target
, B_TRUE
, FTAG
, &spa
);
275 os
= spa
->spa_meta_objset
;
277 dump_obj(os
, spa
->spa_feat_for_read_obj
, "for_read");
278 dump_obj(os
, spa
->spa_feat_for_write_obj
, "for_write");
279 dump_obj(os
, spa
->spa_feat_desc_obj
, "descriptions");
280 if (spa_feature_is_active(spa
, SPA_FEATURE_ENABLED_TXG
)) {
281 dump_obj(os
, spa
->spa_feat_enabled_txg_obj
, "enabled_txg");
285 spa_close(spa
, FTAG
);
289 zhack_feature_enable_sync(void *arg
, dmu_tx_t
*tx
)
291 spa_t
*spa
= dmu_tx_pool(tx
)->dp_spa
;
292 zfeature_info_t
*feature
= arg
;
294 feature_enable_sync(spa
, feature
, tx
);
296 spa_history_log_internal(spa
, "zhack enable feature", tx
,
298 feature
->fi_guid
, feature
->fi_flags
);
302 zhack_do_feature_enable(int argc
, char **argv
)
308 zfeature_info_t feature
;
309 spa_feature_t nodeps
[] = { SPA_FEATURE_NONE
};
312 * Features are not added to the pool's label until their refcounts
313 * are incremented, so fi_mos can just be left as false for now.
316 feature
.fi_uname
= "zhack";
317 feature
.fi_flags
= 0;
318 feature
.fi_depends
= nodeps
;
319 feature
.fi_feature
= SPA_FEATURE_NONE
;
322 while ((c
= getopt(argc
, argv
, "+rd:")) != -1) {
325 feature
.fi_flags
|= ZFEATURE_FLAG_READONLY_COMPAT
;
328 desc
= strdup(optarg
);
337 desc
= strdup("zhack injected");
338 feature
.fi_desc
= desc
;
344 (void) fprintf(stderr
, "error: missing feature or pool name\n");
348 feature
.fi_guid
= argv
[1];
350 if (!zfeature_is_valid_guid(feature
.fi_guid
))
351 fatal(NULL
, FTAG
, "invalid feature guid: %s", feature
.fi_guid
);
353 zhack_spa_open(target
, B_FALSE
, FTAG
, &spa
);
354 mos
= spa
->spa_meta_objset
;
356 if (zfeature_is_supported(feature
.fi_guid
))
357 fatal(spa
, FTAG
, "'%s' is a real feature, will not enable");
358 if (0 == zap_contains(mos
, spa
->spa_feat_desc_obj
, feature
.fi_guid
))
359 fatal(spa
, FTAG
, "feature already enabled: %s",
362 VERIFY0(dsl_sync_task(spa_name(spa
), NULL
,
363 zhack_feature_enable_sync
, &feature
, 5, ZFS_SPACE_CHECK_NORMAL
));
365 spa_close(spa
, FTAG
);
371 feature_incr_sync(void *arg
, dmu_tx_t
*tx
)
373 spa_t
*spa
= dmu_tx_pool(tx
)->dp_spa
;
374 zfeature_info_t
*feature
= arg
;
377 VERIFY0(feature_get_refcount_from_disk(spa
, feature
, &refcount
));
378 feature_sync(spa
, feature
, refcount
+ 1, tx
);
379 spa_history_log_internal(spa
, "zhack feature incr", tx
,
380 "name=%s", feature
->fi_guid
);
384 feature_decr_sync(void *arg
, dmu_tx_t
*tx
)
386 spa_t
*spa
= dmu_tx_pool(tx
)->dp_spa
;
387 zfeature_info_t
*feature
= arg
;
390 VERIFY0(feature_get_refcount_from_disk(spa
, feature
, &refcount
));
391 feature_sync(spa
, feature
, refcount
- 1, tx
);
392 spa_history_log_internal(spa
, "zhack feature decr", tx
,
393 "name=%s", feature
->fi_guid
);
397 zhack_do_feature_ref(int argc
, char **argv
)
401 boolean_t decr
= B_FALSE
;
404 zfeature_info_t feature
;
405 spa_feature_t nodeps
[] = { SPA_FEATURE_NONE
};
408 * fi_desc does not matter here because it was written to disk
409 * when the feature was enabled, but we need to properly set the
410 * feature for read or write based on the information we read off
413 feature
.fi_uname
= "zhack";
414 feature
.fi_flags
= 0;
415 feature
.fi_desc
= NULL
;
416 feature
.fi_depends
= nodeps
;
417 feature
.fi_feature
= SPA_FEATURE_NONE
;
420 while ((c
= getopt(argc
, argv
, "+md")) != -1) {
423 feature
.fi_flags
|= ZFEATURE_FLAG_MOS
;
437 (void) fprintf(stderr
, "error: missing feature or pool name\n");
441 feature
.fi_guid
= argv
[1];
443 if (!zfeature_is_valid_guid(feature
.fi_guid
))
444 fatal(NULL
, FTAG
, "invalid feature guid: %s", feature
.fi_guid
);
446 zhack_spa_open(target
, B_FALSE
, FTAG
, &spa
);
447 mos
= spa
->spa_meta_objset
;
449 if (zfeature_is_supported(feature
.fi_guid
)) {
451 "'%s' is a real feature, will not change refcount");
454 if (0 == zap_contains(mos
, spa
->spa_feat_for_read_obj
,
456 feature
.fi_flags
&= ~ZFEATURE_FLAG_READONLY_COMPAT
;
457 } else if (0 == zap_contains(mos
, spa
->spa_feat_for_write_obj
,
459 feature
.fi_flags
|= ZFEATURE_FLAG_READONLY_COMPAT
;
461 fatal(spa
, FTAG
, "feature is not enabled: %s", feature
.fi_guid
);
466 if (feature_get_refcount_from_disk(spa
, &feature
,
467 &count
) == 0 && count
== 0) {
468 fatal(spa
, FTAG
, "feature refcount already 0: %s",
473 VERIFY0(dsl_sync_task(spa_name(spa
), NULL
,
474 decr
? feature_decr_sync
: feature_incr_sync
, &feature
,
475 5, ZFS_SPACE_CHECK_NORMAL
));
477 spa_close(spa
, FTAG
);
481 zhack_do_feature(int argc
, char **argv
)
488 (void) fprintf(stderr
,
489 "error: no feature operation specified\n");
493 subcommand
= argv
[0];
494 if (strcmp(subcommand
, "stat") == 0) {
495 zhack_do_feature_stat(argc
, argv
);
496 } else if (strcmp(subcommand
, "enable") == 0) {
497 zhack_do_feature_enable(argc
, argv
);
498 } else if (strcmp(subcommand
, "ref") == 0) {
499 zhack_do_feature_ref(argc
, argv
);
501 (void) fprintf(stderr
, "error: unknown subcommand: %s\n",
509 #define MAX_NUM_PATHS 1024
512 main(int argc
, char **argv
)
514 extern void zfs_prop_init(void);
516 char *path
[MAX_NUM_PATHS
];
517 const char *subcommand
;
521 g_importargs
.path
= path
;
523 dprintf_setup(&argc
, argv
);
526 while ((c
= getopt(argc
, argv
, "+c:d:")) != -1) {
529 g_importargs
.cachefile
= optarg
;
532 assert(g_importargs
.paths
< MAX_NUM_PATHS
);
533 g_importargs
.path
[g_importargs
.paths
++] = optarg
;
546 (void) fprintf(stderr
, "error: no command specified\n");
550 subcommand
= argv
[0];
552 if (strcmp(subcommand
, "feature") == 0) {
553 rv
= zhack_do_feature(argc
, argv
);
555 (void) fprintf(stderr
, "error: unknown subcommand: %s\n",
560 if (!g_readonly
&& spa_export(g_pool
, NULL
, B_TRUE
, B_FALSE
) != 0) {
561 fatal(NULL
, FTAG
, "pool export failed; "
562 "changes may not be committed to disk\n");