1 /*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2012, 2018 by Delphix. All rights reserved.
25 * Copyright (c) 2017, Intel Corporation.
26 * Copyright 2019 Joyent, Inc.
27 */
28
29 /*
30 * Virtual Device Labels
31 * ---------------------
32 *
33 * The vdev label serves several distinct purposes:
34 *
35 * 1. Uniquely identify this device as part of a ZFS pool and confirm its
36 * identity within the pool.
37 *
38 * 2. Verify that all the devices given in a configuration are present
39 * within the pool.
40 *
41 * 3. Determine the uberblock for the pool.
42 *
43 * 4. In case of an import operation, determine the configuration of the
44 * toplevel vdev of which it is a part.
45 *
46 * 5. If an import operation cannot find all the devices in the pool,
47 * provide enough information to the administrator to determine which
48 * devices are missing.
49 *
50 * It is important to note that while the kernel is responsible for writing the
51 * label, it only consumes the information in the first three cases. The
52 * latter information is only consumed in userland when determining the
53 * configuration to import a pool.
54 *
55 *
56 * Label Organization
57 * ------------------
58 *
59 * Before describing the contents of the label, it's important to understand how
60 * the labels are written and updated with respect to the uberblock.
61 *
62 * When the pool configuration is altered, either because it was newly created
63 * or a device was added, we want to update all the labels such that we can deal
64 * with fatal failure at any point. To this end, each disk has two labels which
65 * are updated before and after the uberblock is synced. Assuming we have
66 * labels and an uberblock with the following transaction groups:
67 *
68 * L1 UB L2
69 * +------+ +------+ +------+
70 * | | | | | |
71 * | t10 | | t10 | | t10 |
72 * | | | | | |
73 * +------+ +------+ +------+
74 *
75 * In this stable state, the labels and the uberblock were all updated within
76 * the same transaction group (10). Each label is mirrored and checksummed, so
77 * that we can detect when we fail partway through writing the label.
78 *
79 * In order to identify which labels are valid, the labels are written in the
80 * following manner:
81 *
82 * 1. For each vdev, update 'L1' to the new label
83 * 2. Update the uberblock
84 * 3. For each vdev, update 'L2' to the new label
85 *
86 * Given arbitrary failure, we can determine the correct label to use based on
87 * the transaction group. If we fail after updating L1 but before updating the
88 * UB, we will notice that L1's transaction group is greater than the uberblock,
89 * so L2 must be valid. If we fail after writing the uberblock but before
90 * writing L2, we will notice that L2's transaction group is less than L1, and
91 * therefore L1 is valid.
92 *
93 * Another added complexity is that not every label is updated when the config
94 * is synced. If we add a single device, we do not want to have to re-write
95 * every label for every device in the pool. This means that both L1 and L2 may
96 * be older than the pool uberblock, because the necessary information is stored
97 * on another vdev.
98 *
99 *
100 * On-disk Format
101 * --------------
102 *
103 * The vdev label consists of two distinct parts, and is wrapped within the
104 * vdev_label_t structure. The label includes 8k of padding to permit legacy
105 * VTOC disk labels, but is otherwise ignored.
106 *
107 * The first half of the label is a packed nvlist which contains pool wide
108 * properties, per-vdev properties, and configuration information. It is
109 * described in more detail below.
110 *
111 * The latter half of the label consists of a redundant array of uberblocks.
112 * These uberblocks are updated whenever a transaction group is committed,
113 * or when the configuration is updated. When a pool is loaded, we scan each
114 * vdev for the 'best' uberblock.
115 *
116 *
117 * Configuration Information
118 * -------------------------
119 *
120 * The nvlist describing the pool and vdev contains the following elements:
121 *
122 * version ZFS on-disk version
123 * name Pool name
124 * state Pool state
125 * txg Transaction group in which this label was written
126 * pool_guid Unique identifier for this pool
127 * vdev_tree An nvlist describing vdev tree.
128 * features_for_read
129 * An nvlist of the features necessary for reading the MOS.
130 *
131 * Each leaf device label also contains the following:
132 *
133 * top_guid Unique ID for top-level vdev in which this is contained
134 * guid Unique ID for the leaf vdev
135 *
136 * The 'vs' configuration follows the format described in 'spa_config.c'.
137 */
138
139 #include <sys/zfs_context.h>
140 #include <sys/spa.h>
141 #include <sys/spa_impl.h>
142 #include <sys/dmu.h>
143 #include <sys/zap.h>
144 #include <sys/vdev.h>
145 #include <sys/vdev_impl.h>
146 #include <sys/uberblock_impl.h>
147 #include <sys/metaslab.h>
148 #include <sys/metaslab_impl.h>
149 #include <sys/zio.h>
150 #include <sys/dsl_scan.h>
151 #include <sys/abd.h>
152 #include <sys/fs/zfs.h>
153 #include <sys/trim_map.h>
154
155 static boolean_t vdev_trim_on_init = B_TRUE;
156 SYSCTL_DECL(_vfs_zfs_vdev);
157 SYSCTL_INT(_vfs_zfs_vdev, OID_AUTO, trim_on_init, CTLFLAG_RWTUN,
158 &vdev_trim_on_init, 0, "Enable/disable full vdev trim on initialisation");
159
160 /*
161 * Basic routines to read and write from a vdev label.
162 * Used throughout the rest of this file.
163 */
164 uint64_t
vdev_label_offset(uint64_t psize,int l,uint64_t offset)165 vdev_label_offset(uint64_t psize, int l, uint64_t offset)
166 {
167 ASSERT(offset < sizeof (vdev_label_t));
168 ASSERT(P2PHASE_TYPED(psize, sizeof (vdev_label_t), uint64_t) == 0);
169
170 return (offset + l * sizeof (vdev_label_t) + (l < VDEV_LABELS / 2 ?
171 0 : psize - VDEV_LABELS * sizeof (vdev_label_t)));
172 }
173
174 /*
175 * Returns back the vdev label associated with the passed in offset.
176 */
177 int
vdev_label_number(uint64_t psize,uint64_t offset)178 vdev_label_number(uint64_t psize, uint64_t offset)
179 {
180 int l;
181
182 if (offset >= psize - VDEV_LABEL_END_SIZE) {
183 offset -= psize - VDEV_LABEL_END_SIZE;
184 offset += (VDEV_LABELS / 2) * sizeof (vdev_label_t);
185 }
186 l = offset / sizeof (vdev_label_t);
187 return (l < VDEV_LABELS ? l : -1);
188 }
189
190 static void
vdev_label_read(zio_t * zio,vdev_t * vd,int l,abd_t * buf,uint64_t offset,uint64_t size,zio_done_func_t * done,void * private,int flags)191 vdev_label_read(zio_t *zio, vdev_t *vd, int l, abd_t *buf, uint64_t offset,
192 uint64_t size, zio_done_func_t *done, void *private, int flags)
193 {
194 ASSERT(
195 spa_config_held(zio->io_spa, SCL_STATE, RW_READER) == SCL_STATE ||
196 spa_config_held(zio->io_spa, SCL_STATE, RW_WRITER) == SCL_STATE);
197 ASSERT(flags & ZIO_FLAG_CONFIG_WRITER);
198
199 zio_nowait(zio_read_phys(zio, vd,
200 vdev_label_offset(vd->vdev_psize, l, offset),
201 size, buf, ZIO_CHECKSUM_LABEL, done, private,
202 ZIO_PRIORITY_SYNC_READ, flags, B_TRUE));
203 }
204
205 void
vdev_label_write(zio_t * zio,vdev_t * vd,int l,abd_t * buf,uint64_t offset,uint64_t size,zio_done_func_t * done,void * private,int flags)206 vdev_label_write(zio_t *zio, vdev_t *vd, int l, abd_t *buf, uint64_t offset,
207 uint64_t size, zio_done_func_t *done, void *private, int flags)
208 {
209 ASSERT(
210 spa_config_held(zio->io_spa, SCL_STATE, RW_READER) == SCL_STATE ||
211 spa_config_held(zio->io_spa, SCL_STATE, RW_WRITER) == SCL_STATE);
212 ASSERT(flags & ZIO_FLAG_CONFIG_WRITER);
213
214 zio_nowait(zio_write_phys(zio, vd,
215 vdev_label_offset(vd->vdev_psize, l, offset),
216 size, buf, ZIO_CHECKSUM_LABEL, done, private,
217 ZIO_PRIORITY_SYNC_WRITE, flags, B_TRUE));
218 }
219
220 static void
root_vdev_actions_getprogress(vdev_t * vd,nvlist_t * nvl)221 root_vdev_actions_getprogress(vdev_t *vd, nvlist_t *nvl)
222 {
223 spa_t *spa = vd->vdev_spa;
224
225 if (vd != spa->spa_root_vdev)
226 return;
227
228 /* provide either current or previous scan information */
229 pool_scan_stat_t ps;
230 if (spa_scan_get_stats(spa, &ps) == 0) {
231 fnvlist_add_uint64_array(nvl,
232 ZPOOL_CONFIG_SCAN_STATS, (uint64_t *)&ps,
233 sizeof (pool_scan_stat_t) / sizeof (uint64_t));
234 }
235
236 pool_removal_stat_t prs;
237 if (spa_removal_get_stats(spa, &prs) == 0) {
238 fnvlist_add_uint64_array(nvl,
239 ZPOOL_CONFIG_REMOVAL_STATS, (uint64_t *)&prs,
240 sizeof (prs) / sizeof (uint64_t));
241 }
242
243 pool_checkpoint_stat_t pcs;
244 if (spa_checkpoint_get_stats(spa, &pcs) == 0) {
245 fnvlist_add_uint64_array(nvl,
246 ZPOOL_CONFIG_CHECKPOINT_STATS, (uint64_t *)&pcs,
247 sizeof (pcs) / sizeof (uint64_t));
248 }
249 }
250
251 /*
252 * Generate the nvlist representing this vdev's config.
253 */
254 nvlist_t *
vdev_config_generate(spa_t * spa,vdev_t * vd,boolean_t getstats,vdev_config_flag_t flags)255 vdev_config_generate(spa_t *spa, vdev_t *vd, boolean_t getstats,
256 vdev_config_flag_t flags)
257 {
258 nvlist_t *nv = NULL;
259 vdev_indirect_config_t *vic = &vd->vdev_indirect_config;
260
261 nv = fnvlist_alloc();
262
263 fnvlist_add_string(nv, ZPOOL_CONFIG_TYPE, vd->vdev_ops->vdev_op_type);
264 if (!(flags & (VDEV_CONFIG_SPARE | VDEV_CONFIG_L2CACHE)))
265 fnvlist_add_uint64(nv, ZPOOL_CONFIG_ID, vd->vdev_id);
266 fnvlist_add_uint64(nv, ZPOOL_CONFIG_GUID, vd->vdev_guid);
267
268 if (vd->vdev_path != NULL)
269 fnvlist_add_string(nv, ZPOOL_CONFIG_PATH, vd->vdev_path);
270
271 if (vd->vdev_devid != NULL)
272 fnvlist_add_string(nv, ZPOOL_CONFIG_DEVID, vd->vdev_devid);
273
274 if (vd->vdev_physpath != NULL)
275 fnvlist_add_string(nv, ZPOOL_CONFIG_PHYS_PATH,
276 vd->vdev_physpath);
277
278 if (vd->vdev_fru != NULL)
279 fnvlist_add_string(nv, ZPOOL_CONFIG_FRU, vd->vdev_fru);
280
281 if (vd->vdev_nparity != 0) {
282 ASSERT(strcmp(vd->vdev_ops->vdev_op_type,
283 VDEV_TYPE_RAIDZ) == 0);
284
285 /*
286 * Make sure someone hasn't managed to sneak a fancy new vdev
287 * into a crufty old storage pool.
288 */
289 ASSERT(vd->vdev_nparity == 1 ||
290 (vd->vdev_nparity <= 2 &&
291 spa_version(spa) >= SPA_VERSION_RAIDZ2) ||
292 (vd->vdev_nparity <= 3 &&
293 spa_version(spa) >= SPA_VERSION_RAIDZ3));
294
295 /*
296 * Note that we'll add the nparity tag even on storage pools
297 * that only support a single parity device -- older software
298 * will just ignore it.
299 */
300 fnvlist_add_uint64(nv, ZPOOL_CONFIG_NPARITY, vd->vdev_nparity);
301 }
302
303 if (vd->vdev_wholedisk != -1ULL)
304 fnvlist_add_uint64(nv, ZPOOL_CONFIG_WHOLE_DISK,
305 vd->vdev_wholedisk);
306
307 if (vd->vdev_not_present && !(flags & VDEV_CONFIG_MISSING))
308 fnvlist_add_uint64(nv, ZPOOL_CONFIG_NOT_PRESENT, 1);
309
310 if (vd->vdev_isspare)
311 fnvlist_add_uint64(nv, ZPOOL_CONFIG_IS_SPARE, 1);
312
313 if (!(flags & (VDEV_CONFIG_SPARE | VDEV_CONFIG_L2CACHE)) &&
314 vd == vd->vdev_top) {
315 fnvlist_add_uint64(nv, ZPOOL_CONFIG_METASLAB_ARRAY,
316 vd->vdev_ms_array);
317 fnvlist_add_uint64(nv, ZPOOL_CONFIG_METASLAB_SHIFT,
318 vd->vdev_ms_shift);
319 fnvlist_add_uint64(nv, ZPOOL_CONFIG_ASHIFT, vd->vdev_ashift);
320 fnvlist_add_uint64(nv, ZPOOL_CONFIG_ASIZE,
321 vd->vdev_asize);
322 fnvlist_add_uint64(nv, ZPOOL_CONFIG_IS_LOG, vd->vdev_islog);
323 if (vd->vdev_removing) {
324 fnvlist_add_uint64(nv, ZPOOL_CONFIG_REMOVING,
325 vd->vdev_removing);
326 }
327
328 /* zpool command expects alloc class data */
329 if (getstats && vd->vdev_alloc_bias != VDEV_BIAS_NONE) {
330 const char *bias = NULL;
331
332 switch (vd->vdev_alloc_bias) {
333 case VDEV_BIAS_LOG:
334 bias = VDEV_ALLOC_BIAS_LOG;
335 break;
336 case VDEV_BIAS_SPECIAL:
337 bias = VDEV_ALLOC_BIAS_SPECIAL;
338 break;
339 case VDEV_BIAS_DEDUP:
340 bias = VDEV_ALLOC_BIAS_DEDUP;
341 break;
342 default:
343 ASSERT3U(vd->vdev_alloc_bias, ==,
344 VDEV_BIAS_NONE);
345 }
346 fnvlist_add_string(nv, ZPOOL_CONFIG_ALLOCATION_BIAS,
347 bias);
348 }
349 }
350
351 if (vd->vdev_dtl_sm != NULL) {
352 fnvlist_add_uint64(nv, ZPOOL_CONFIG_DTL,
353 space_map_object(vd->vdev_dtl_sm));
354 }
355
356 if (vic->vic_mapping_object != 0) {
357 fnvlist_add_uint64(nv, ZPOOL_CONFIG_INDIRECT_OBJECT,
358 vic->vic_mapping_object);
359 }
360
361 if (vic->vic_births_object != 0) {
362 fnvlist_add_uint64(nv, ZPOOL_CONFIG_INDIRECT_BIRTHS,
363 vic->vic_births_object);
364 }
365
366 if (vic->vic_prev_indirect_vdev != UINT64_MAX) {
367 fnvlist_add_uint64(nv, ZPOOL_CONFIG_PREV_INDIRECT_VDEV,
368 vic->vic_prev_indirect_vdev);
369 }
370
371 if (vd->vdev_crtxg)
372 fnvlist_add_uint64(nv, ZPOOL_CONFIG_CREATE_TXG, vd->vdev_crtxg);
373
374 if (flags & VDEV_CONFIG_MOS) {
375 if (vd->vdev_leaf_zap != 0) {
376 ASSERT(vd->vdev_ops->vdev_op_leaf);
377 fnvlist_add_uint64(nv, ZPOOL_CONFIG_VDEV_LEAF_ZAP,
378 vd->vdev_leaf_zap);
379 }
380
381 if (vd->vdev_top_zap != 0) {
382 ASSERT(vd == vd->vdev_top);
383 fnvlist_add_uint64(nv, ZPOOL_CONFIG_VDEV_TOP_ZAP,
384 vd->vdev_top_zap);
385 }
386 }
387
388 if (getstats) {
389 vdev_stat_t vs;
390
391 vdev_get_stats(vd, &vs);
392 fnvlist_add_uint64_array(nv, ZPOOL_CONFIG_VDEV_STATS,
393 (uint64_t *)&vs, sizeof (vs) / sizeof (uint64_t));
394
395 root_vdev_actions_getprogress(vd, nv);
396
397 /*
398 * Note: this can be called from open context
399 * (spa_get_stats()), so we need the rwlock to prevent
400 * the mapping from being changed by condensing.
401 */
402 rw_enter(&vd->vdev_indirect_rwlock, RW_READER);
403 if (vd->vdev_indirect_mapping != NULL) {
404 ASSERT(vd->vdev_indirect_births != NULL);
405 vdev_indirect_mapping_t *vim =
406 vd->vdev_indirect_mapping;
407 fnvlist_add_uint64(nv, ZPOOL_CONFIG_INDIRECT_SIZE,
408 vdev_indirect_mapping_size(vim));
409 }
410 rw_exit(&vd->vdev_indirect_rwlock);
411 if (vd->vdev_mg != NULL &&
412 vd->vdev_mg->mg_fragmentation != ZFS_FRAG_INVALID) {
413 /*
414 * Compute approximately how much memory would be used
415 * for the indirect mapping if this device were to
416 * be removed.
417 *
418 * Note: If the frag metric is invalid, then not
419 * enough metaslabs have been converted to have
420 * histograms.
421 */
422 uint64_t seg_count = 0;
423 uint64_t to_alloc = vd->vdev_stat.vs_alloc;
424
425 /*
426 * There are the same number of allocated segments
427 * as free segments, so we will have at least one
428 * entry per free segment. However, small free
429 * segments (smaller than vdev_removal_max_span)
430 * will be combined with adjacent allocated segments
431 * as a single mapping.
432 */
433 for (int i = 0; i < RANGE_TREE_HISTOGRAM_SIZE; i++) {
434 if (1ULL << (i + 1) < vdev_removal_max_span) {
435 to_alloc +=
436 vd->vdev_mg->mg_histogram[i] <<
437 i + 1;
438 } else {
439 seg_count +=
440 vd->vdev_mg->mg_histogram[i];
441 }
442 }
443
444 /*
445 * The maximum length of a mapping is
446 * zfs_remove_max_segment, so we need at least one entry
447 * per zfs_remove_max_segment of allocated data.
448 */
449 seg_count += to_alloc / zfs_remove_max_segment;
450
451 fnvlist_add_uint64(nv, ZPOOL_CONFIG_INDIRECT_SIZE,
452 seg_count *
453 sizeof (vdev_indirect_mapping_entry_phys_t));
454 }
455 }
456
457 if (!vd->vdev_ops->vdev_op_leaf) {
458 nvlist_t **child;
459 int c, idx;
460
461 ASSERT(!vd->vdev_ishole);
462
463 child = kmem_alloc(vd->vdev_children * sizeof (nvlist_t *),
464 KM_SLEEP);
465
466 for (c = 0, idx = 0; c < vd->vdev_children; c++) {
467 vdev_t *cvd = vd->vdev_child[c];
468
469 /*
470 * If we're generating an nvlist of removing
471 * vdevs then skip over any device which is
472 * not being removed.
473 */
474 if ((flags & VDEV_CONFIG_REMOVING) &&
475 !cvd->vdev_removing)
476 continue;
477
478 child[idx++] = vdev_config_generate(spa, cvd,
479 getstats, flags);
480 }
481
482 if (idx) {
483 fnvlist_add_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
484 child, idx);
485 }
486
487 for (c = 0; c < idx; c++)
488 nvlist_free(child[c]);
489
490 kmem_free(child, vd->vdev_children * sizeof (nvlist_t *));
491
492 } else {
493 const char *aux = NULL;
494
495 if (vd->vdev_offline && !vd->vdev_tmpoffline)
496 fnvlist_add_uint64(nv, ZPOOL_CONFIG_OFFLINE, B_TRUE);
497 if (vd->vdev_resilver_txg != 0)
498 fnvlist_add_uint64(nv, ZPOOL_CONFIG_RESILVER_TXG,
499 vd->vdev_resilver_txg);
500 if (vd->vdev_faulted)
501 fnvlist_add_uint64(nv, ZPOOL_CONFIG_FAULTED, B_TRUE);
502 if (vd->vdev_degraded)
503 fnvlist_add_uint64(nv, ZPOOL_CONFIG_DEGRADED, B_TRUE);
504 if (vd->vdev_removed)
505 fnvlist_add_uint64(nv, ZPOOL_CONFIG_REMOVED, B_TRUE);
506 if (vd->vdev_unspare)
507 fnvlist_add_uint64(nv, ZPOOL_CONFIG_UNSPARE, B_TRUE);
508 if (vd->vdev_ishole)
509 fnvlist_add_uint64(nv, ZPOOL_CONFIG_IS_HOLE, B_TRUE);
510
511 switch (vd->vdev_stat.vs_aux) {
512 case VDEV_AUX_ERR_EXCEEDED:
513 aux = "err_exceeded";
514 break;
515
516 case VDEV_AUX_EXTERNAL:
517 aux = "external";
518 break;
519 }
520
521 if (aux != NULL)
522 fnvlist_add_string(nv, ZPOOL_CONFIG_AUX_STATE, aux);
523
524 if (vd->vdev_splitting && vd->vdev_orig_guid != 0LL) {
525 fnvlist_add_uint64(nv, ZPOOL_CONFIG_ORIG_GUID,
526 vd->vdev_orig_guid);
527 }
528 }
529
530 return (nv);
531 }
532
533 /*
534 * Generate a view of the top-level vdevs. If we currently have holes
535 * in the namespace, then generate an array which contains a list of holey
536 * vdevs. Additionally, add the number of top-level children that currently
537 * exist.
538 */
539 void
vdev_top_config_generate(spa_t * spa,nvlist_t * config)540 vdev_top_config_generate(spa_t *spa, nvlist_t *config)
541 {
542 vdev_t *rvd = spa->spa_root_vdev;
543 uint64_t *array;
544 uint_t c, idx;
545
546 array = kmem_alloc(rvd->vdev_children * sizeof (uint64_t), KM_SLEEP);
547
548 for (c = 0, idx = 0; c < rvd->vdev_children; c++) {
549 vdev_t *tvd = rvd->vdev_child[c];
550
551 if (tvd->vdev_ishole) {
552 array[idx++] = c;
553 }
554 }
555
556 if (idx) {
557 VERIFY(nvlist_add_uint64_array(config, ZPOOL_CONFIG_HOLE_ARRAY,
558 array, idx) == 0);
559 }
560
561 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_VDEV_CHILDREN,
562 rvd->vdev_children) == 0);
563
564 kmem_free(array, rvd->vdev_children * sizeof (uint64_t));
565 }
566
567 /*
568 * Returns the configuration from the label of the given vdev. For vdevs
569 * which don't have a txg value stored on their label (i.e. spares/cache)
570 * or have not been completely initialized (txg = 0) just return
571 * the configuration from the first valid label we find. Otherwise,
572 * find the most up-to-date label that does not exceed the specified
573 * 'txg' value.
574 */
575 nvlist_t *
vdev_label_read_config(vdev_t * vd,uint64_t txg)576 vdev_label_read_config(vdev_t *vd, uint64_t txg)
577 {
578 spa_t *spa = vd->vdev_spa;
579 nvlist_t *config = NULL;
580 vdev_phys_t *vp;
581 abd_t *vp_abd;
582 zio_t *zio;
583 uint64_t best_txg = 0;
584 uint64_t label_txg = 0;
585 int error = 0;
586 int flags = ZIO_FLAG_CONFIG_WRITER | ZIO_FLAG_CANFAIL |
587 ZIO_FLAG_SPECULATIVE;
588
589 ASSERT(spa_config_held(spa, SCL_STATE_ALL, RW_WRITER) == SCL_STATE_ALL);
590
591 if (!vdev_readable(vd))
592 return (NULL);
593
594 vp_abd = abd_alloc_linear(sizeof (vdev_phys_t), B_TRUE);
595 vp = abd_to_buf(vp_abd);
596
597 retry:
598 for (int l = 0; l < VDEV_LABELS; l++) {
599 nvlist_t *label = NULL;
600
601 zio = zio_root(spa, NULL, NULL, flags);
602
603 vdev_label_read(zio, vd, l, vp_abd,
604 offsetof(vdev_label_t, vl_vdev_phys),
605 sizeof (vdev_phys_t), NULL, NULL, flags);
606
607 if (zio_wait(zio) == 0 &&
608 nvlist_unpack(vp->vp_nvlist, sizeof (vp->vp_nvlist),
609 &label, 0) == 0) {
610 /*
611 * Auxiliary vdevs won't have txg values in their
612 * labels and newly added vdevs may not have been
613 * completely initialized so just return the
614 * configuration from the first valid label we
615 * encounter.
616 */
617 error = nvlist_lookup_uint64(label,
618 ZPOOL_CONFIG_POOL_TXG, &label_txg);
619 if ((error || label_txg == 0) && !config) {
620 config = label;
621 break;
622 } else if (label_txg <= txg && label_txg > best_txg) {
623 best_txg = label_txg;
624 nvlist_free(config);
625 config = fnvlist_dup(label);
626 }
627 }
628
629 if (label != NULL) {
630 nvlist_free(label);
631 label = NULL;
632 }
633 }
634
635 if (config == NULL && !(flags & ZIO_FLAG_TRYHARD)) {
636 flags |= ZIO_FLAG_TRYHARD;
637 goto retry;
638 }
639
640 /*
641 * We found a valid label but it didn't pass txg restrictions.
642 */
643 if (config == NULL && label_txg != 0) {
644 vdev_dbgmsg(vd, "label discarded as txg is too large "
645 "(%llu > %llu)", (u_longlong_t)label_txg,
646 (u_longlong_t)txg);
647 }
648
649 abd_free(vp_abd);
650
651 return (config);
652 }
653
654 /*
655 * Determine if a device is in use. The 'spare_guid' parameter will be filled
656 * in with the device guid if this spare is active elsewhere on the system.
657 */
658 static boolean_t
vdev_inuse(vdev_t * vd,uint64_t crtxg,vdev_labeltype_t reason,uint64_t * spare_guid,uint64_t * l2cache_guid)659 vdev_inuse(vdev_t *vd, uint64_t crtxg, vdev_labeltype_t reason,
660 uint64_t *spare_guid, uint64_t *l2cache_guid)
661 {
662 spa_t *spa = vd->vdev_spa;
663 uint64_t state, pool_guid, device_guid, txg, spare_pool;
664 uint64_t vdtxg = 0;
665 nvlist_t *label;
666
667 if (spare_guid)
668 *spare_guid = 0ULL;
669 if (l2cache_guid)
670 *l2cache_guid = 0ULL;
671
672 /*
673 * Read the label, if any, and perform some basic sanity checks.
674 */
675 if ((label = vdev_label_read_config(vd, -1ULL)) == NULL)
676 return (B_FALSE);
677
678 (void) nvlist_lookup_uint64(label, ZPOOL_CONFIG_CREATE_TXG,
679 &vdtxg);
680
681 if (nvlist_lookup_uint64(label, ZPOOL_CONFIG_POOL_STATE,
682 &state) != 0 ||
683 nvlist_lookup_uint64(label, ZPOOL_CONFIG_GUID,
684 &device_guid) != 0) {
685 nvlist_free(label);
686 return (B_FALSE);
687 }
688
689 if (state != POOL_STATE_SPARE && state != POOL_STATE_L2CACHE &&
690 (nvlist_lookup_uint64(label, ZPOOL_CONFIG_POOL_GUID,
691 &pool_guid) != 0 ||
692 nvlist_lookup_uint64(label, ZPOOL_CONFIG_POOL_TXG,
693 &txg) != 0)) {
694 nvlist_free(label);
695 return (B_FALSE);
696 }
697
698 nvlist_free(label);
699
700 /*
701 * Check to see if this device indeed belongs to the pool it claims to
702 * be a part of. The only way this is allowed is if the device is a hot
703 * spare (which we check for later on).
704 */
705 if (state != POOL_STATE_SPARE && state != POOL_STATE_L2CACHE &&
706 !spa_guid_exists(pool_guid, device_guid) &&
707 !spa_spare_exists(device_guid, NULL, NULL) &&
708 !spa_l2cache_exists(device_guid, NULL))
709 return (B_FALSE);
710
711 /*
712 * If the transaction group is zero, then this an initialized (but
713 * unused) label. This is only an error if the create transaction
714 * on-disk is the same as the one we're using now, in which case the
715 * user has attempted to add the same vdev multiple times in the same
716 * transaction.
717 */
718 if (state != POOL_STATE_SPARE && state != POOL_STATE_L2CACHE &&
719 txg == 0 && vdtxg == crtxg)
720 return (B_TRUE);
721
722 /*
723 * Check to see if this is a spare device. We do an explicit check for
724 * spa_has_spare() here because it may be on our pending list of spares
725 * to add. We also check if it is an l2cache device.
726 */
727 if (spa_spare_exists(device_guid, &spare_pool, NULL) ||
728 spa_has_spare(spa, device_guid)) {
729 if (spare_guid)
730 *spare_guid = device_guid;
731
732 switch (reason) {
733 case VDEV_LABEL_CREATE:
734 case VDEV_LABEL_L2CACHE:
735 return (B_TRUE);
736
737 case VDEV_LABEL_REPLACE:
738 return (!spa_has_spare(spa, device_guid) ||
739 spare_pool != 0ULL);
740
741 case VDEV_LABEL_SPARE:
742 return (spa_has_spare(spa, device_guid));
743 }
744 }
745
746 /*
747 * Check to see if this is an l2cache device.
748 */
749 if (spa_l2cache_exists(device_guid, NULL))
750 return (B_TRUE);
751
752 /*
753 * We can't rely on a pool's state if it's been imported
754 * read-only. Instead we look to see if the pools is marked
755 * read-only in the namespace and set the state to active.
756 */
757 if (state != POOL_STATE_SPARE && state != POOL_STATE_L2CACHE &&
758 (spa = spa_by_guid(pool_guid, device_guid)) != NULL &&
759 spa_mode(spa) == FREAD)
760 state = POOL_STATE_ACTIVE;
761
762 /*
763 * If the device is marked ACTIVE, then this device is in use by another
764 * pool on the system.
765 */
766 return (state == POOL_STATE_ACTIVE);
767 }
768
769 /*
770 * Initialize a vdev label. We check to make sure each leaf device is not in
771 * use, and writable. We put down an initial label which we will later
772 * overwrite with a complete label. Note that it's important to do this
773 * sequentially, not in parallel, so that we catch cases of multiple use of the
774 * same leaf vdev in the vdev we're creating -- e.g. mirroring a disk with
775 * itself.
776 */
777 int
vdev_label_init(vdev_t * vd,uint64_t crtxg,vdev_labeltype_t reason)778 vdev_label_init(vdev_t *vd, uint64_t crtxg, vdev_labeltype_t reason)
779 {
780 spa_t *spa = vd->vdev_spa;
781 nvlist_t *label;
782 vdev_phys_t *vp;
783 abd_t *vp_abd;
784 abd_t *pad2;
785 uberblock_t *ub;
786 abd_t *ub_abd;
787 zio_t *zio;
788 char *buf;
789 size_t buflen;
790 int error;
791 uint64_t spare_guid, l2cache_guid;
792 int flags = ZIO_FLAG_CONFIG_WRITER | ZIO_FLAG_CANFAIL;
793
794 ASSERT(spa_config_held(spa, SCL_ALL, RW_WRITER) == SCL_ALL);
795
796 for (int c = 0; c < vd->vdev_children; c++)
797 if ((error = vdev_label_init(vd->vdev_child[c],
798 crtxg, reason)) != 0)
799 return (error);
800
801 /* Track the creation time for this vdev */
802 vd->vdev_crtxg = crtxg;
803
804 if (!vd->vdev_ops->vdev_op_leaf || !spa_writeable(spa))
805 return (0);
806
807 /*
808 * Dead vdevs cannot be initialized.
809 */
810 if (vdev_is_dead(vd))
811 return (SET_ERROR(EIO));
812
813 /*
814 * Determine if the vdev is in use.
815 */
816 if (reason != VDEV_LABEL_REMOVE && reason != VDEV_LABEL_SPLIT &&
817 vdev_inuse(vd, crtxg, reason, &spare_guid, &l2cache_guid))
818 return (SET_ERROR(EBUSY));
819
820 /*
821 * If this is a request to add or replace a spare or l2cache device
822 * that is in use elsewhere on the system, then we must update the
823 * guid (which was initialized to a random value) to reflect the
824 * actual GUID (which is shared between multiple pools).
825 */
826 if (reason != VDEV_LABEL_REMOVE && reason != VDEV_LABEL_L2CACHE &&
827 spare_guid != 0ULL) {
828 uint64_t guid_delta = spare_guid - vd->vdev_guid;
829
830 vd->vdev_guid += guid_delta;
831
832 for (vdev_t *pvd = vd; pvd != NULL; pvd = pvd->vdev_parent)
833 pvd->vdev_guid_sum += guid_delta;
834
835 /*
836 * If this is a replacement, then we want to fallthrough to the
837 * rest of the code. If we're adding a spare, then it's already
838 * labeled appropriately and we can just return.
839 */
840 if (reason == VDEV_LABEL_SPARE)
841 return (0);
842 ASSERT(reason == VDEV_LABEL_REPLACE ||
843 reason == VDEV_LABEL_SPLIT);
844 }
845
846 if (reason != VDEV_LABEL_REMOVE && reason != VDEV_LABEL_SPARE &&
847 l2cache_guid != 0ULL) {
848 uint64_t guid_delta = l2cache_guid - vd->vdev_guid;
849
850 vd->vdev_guid += guid_delta;
851
852 for (vdev_t *pvd = vd; pvd != NULL; pvd = pvd->vdev_parent)
853 pvd->vdev_guid_sum += guid_delta;
854
855 /*
856 * If this is a replacement, then we want to fallthrough to the
857 * rest of the code. If we're adding an l2cache, then it's
858 * already labeled appropriately and we can just return.
859 */
860 if (reason == VDEV_LABEL_L2CACHE)
861 return (0);
862 ASSERT(reason == VDEV_LABEL_REPLACE);
863 }
864
865 /*
866 * TRIM the whole thing, excluding the blank space and boot header
867 * as specified by ZFS On-Disk Specification (section 1.3), so that
868 * we start with a clean slate.
869 * It's just an optimization, so we don't care if it fails.
870 * Don't TRIM if removing so that we don't interfere with zpool
871 * disaster recovery.
872 */
873 if (zfs_trim_enabled && vdev_trim_on_init && !vd->vdev_notrim &&
874 (reason == VDEV_LABEL_CREATE || reason == VDEV_LABEL_SPARE ||
875 reason == VDEV_LABEL_L2CACHE))
876 zio_wait(zio_trim(NULL, spa, vd, VDEV_SKIP_SIZE,
877 vd->vdev_psize - VDEV_SKIP_SIZE));
878
879 /*
880 * Initialize its label.
881 */
882 vp_abd = abd_alloc_linear(sizeof (vdev_phys_t), B_TRUE);
883 abd_zero(vp_abd, sizeof (vdev_phys_t));
884 vp = abd_to_buf(vp_abd);
885
886 /*
887 * Generate a label describing the pool and our top-level vdev.
888 * We mark it as being from txg 0 to indicate that it's not
889 * really part of an active pool just yet. The labels will
890 * be written again with a meaningful txg by spa_sync().
891 */
892 if (reason == VDEV_LABEL_SPARE ||
893 (reason == VDEV_LABEL_REMOVE && vd->vdev_isspare)) {
894 /*
895 * For inactive hot spares, we generate a special label that
896 * identifies as a mutually shared hot spare. We write the
897 * label if we are adding a hot spare, or if we are removing an
898 * active hot spare (in which case we want to revert the
899 * labels).
900 */
901 VERIFY(nvlist_alloc(&label, NV_UNIQUE_NAME, KM_SLEEP) == 0);
902
903 VERIFY(nvlist_add_uint64(label, ZPOOL_CONFIG_VERSION,
904 spa_version(spa)) == 0);
905 VERIFY(nvlist_add_uint64(label, ZPOOL_CONFIG_POOL_STATE,
906 POOL_STATE_SPARE) == 0);
907 VERIFY(nvlist_add_uint64(label, ZPOOL_CONFIG_GUID,
908 vd->vdev_guid) == 0);
909 } else if (reason == VDEV_LABEL_L2CACHE ||
910 (reason == VDEV_LABEL_REMOVE && vd->vdev_isl2cache)) {
911 /*
912 * For level 2 ARC devices, add a special label.
913 */
914 VERIFY(nvlist_alloc(&label, NV_UNIQUE_NAME, KM_SLEEP) == 0);
915
916 VERIFY(nvlist_add_uint64(label, ZPOOL_CONFIG_VERSION,
917 spa_version(spa)) == 0);
918 VERIFY(nvlist_add_uint64(label, ZPOOL_CONFIG_POOL_STATE,
919 POOL_STATE_L2CACHE) == 0);
920 VERIFY(nvlist_add_uint64(label, ZPOOL_CONFIG_GUID,
921 vd->vdev_guid) == 0);
922 } else {
923 uint64_t txg = 0ULL;
924
925 if (reason == VDEV_LABEL_SPLIT)
926 txg = spa->spa_uberblock.ub_txg;
927 label = spa_config_generate(spa, vd, txg, B_FALSE);
928
929 /*
930 * Add our creation time. This allows us to detect multiple
931 * vdev uses as described above, and automatically expires if we
932 * fail.
933 */
934 VERIFY(nvlist_add_uint64(label, ZPOOL_CONFIG_CREATE_TXG,
935 crtxg) == 0);
936 }
937
938 buf = vp->vp_nvlist;
939 buflen = sizeof (vp->vp_nvlist);
940
941 error = nvlist_pack(label, &buf, &buflen, NV_ENCODE_XDR, KM_SLEEP);
942 if (error != 0) {
943 nvlist_free(label);
944 abd_free(vp_abd);
945 /* EFAULT means nvlist_pack ran out of room */
946 return (error == EFAULT ? ENAMETOOLONG : EINVAL);
947 }
948
949 /*
950 * Initialize uberblock template.
951 */
952 ub_abd = abd_alloc_linear(VDEV_UBERBLOCK_RING, B_TRUE);
953 abd_zero(ub_abd, VDEV_UBERBLOCK_RING);
954 abd_copy_from_buf(ub_abd, &spa->spa_uberblock, sizeof (uberblock_t));
955 ub = abd_to_buf(ub_abd);
956 ub->ub_txg = 0;
957
958 /* Initialize the 2nd padding area. */
959 pad2 = abd_alloc_for_io(VDEV_PAD_SIZE, B_TRUE);
960 abd_zero(pad2, VDEV_PAD_SIZE);
961
962 /*
963 * Write everything in parallel.
964 */
965 retry:
966 zio = zio_root(spa, NULL, NULL, flags);
967
968 for (int l = 0; l < VDEV_LABELS; l++) {
969
970 vdev_label_write(zio, vd, l, vp_abd,
971 offsetof(vdev_label_t, vl_vdev_phys),
972 sizeof (vdev_phys_t), NULL, NULL, flags);
973
974 /*
975 * Skip the 1st padding area.
976 * Zero out the 2nd padding area where it might have
977 * left over data from previous filesystem format.
978 */
979 vdev_label_write(zio, vd, l, pad2,
980 offsetof(vdev_label_t, vl_pad2),
981 VDEV_PAD_SIZE, NULL, NULL, flags);
982
983 vdev_label_write(zio, vd, l, ub_abd,
984 offsetof(vdev_label_t, vl_uberblock),
985 VDEV_UBERBLOCK_RING, NULL, NULL, flags);
986 }
987
988 error = zio_wait(zio);
989
990 if (error != 0 && !(flags & ZIO_FLAG_TRYHARD)) {
991 flags |= ZIO_FLAG_TRYHARD;
992 goto retry;
993 }
994
995 nvlist_free(label);
996 abd_free(pad2);
997 abd_free(ub_abd);
998 abd_free(vp_abd);
999
1000 /*
1001 * If this vdev hasn't been previously identified as a spare, then we
1002 * mark it as such only if a) we are labeling it as a spare, or b) it
1003 * exists as a spare elsewhere in the system. Do the same for
1004 * level 2 ARC devices.
1005 */
1006 if (error == 0 && !vd->vdev_isspare &&
1007 (reason == VDEV_LABEL_SPARE ||
1008 spa_spare_exists(vd->vdev_guid, NULL, NULL)))
1009 spa_spare_add(vd);
1010
1011 if (error == 0 && !vd->vdev_isl2cache &&
1012 (reason == VDEV_LABEL_L2CACHE ||
1013 spa_l2cache_exists(vd->vdev_guid, NULL)))
1014 spa_l2cache_add(vd);
1015
1016 return (error);
1017 }
1018
1019 int
vdev_label_write_pad2(vdev_t * vd,const char * buf,size_t size)1020 vdev_label_write_pad2(vdev_t *vd, const char *buf, size_t size)
1021 {
1022 spa_t *spa = vd->vdev_spa;
1023 zio_t *zio;
1024 abd_t *pad2;
1025 int flags = ZIO_FLAG_CONFIG_WRITER | ZIO_FLAG_CANFAIL;
1026 int error;
1027
1028 if (size > VDEV_PAD_SIZE)
1029 return (EINVAL);
1030
1031 if (!vd->vdev_ops->vdev_op_leaf)
1032 return (ENODEV);
1033 if (vdev_is_dead(vd))
1034 return (ENXIO);
1035
1036 ASSERT(spa_config_held(spa, SCL_ALL, RW_WRITER) == SCL_ALL);
1037
1038 pad2 = abd_alloc_for_io(VDEV_PAD_SIZE, B_TRUE);
1039 abd_zero(pad2, VDEV_PAD_SIZE);
1040 abd_copy_from_buf(pad2, buf, size);
1041
1042 retry:
1043 zio = zio_root(spa, NULL, NULL, flags);
1044 vdev_label_write(zio, vd, 0, pad2,
1045 offsetof(vdev_label_t, vl_pad2),
1046 VDEV_PAD_SIZE, NULL, NULL, flags);
1047 error = zio_wait(zio);
1048 if (error != 0 && !(flags & ZIO_FLAG_TRYHARD)) {
1049 flags |= ZIO_FLAG_TRYHARD;
1050 goto retry;
1051 }
1052
1053 abd_free(pad2);
1054 return (error);
1055 }
1056
1057 /*
1058 * ==========================================================================
1059 * uberblock load/sync
1060 * ==========================================================================
1061 */
1062
1063 /*
1064 * Consider the following situation: txg is safely synced to disk. We've
1065 * written the first uberblock for txg + 1, and then we lose power. When we
1066 * come back up, we fail to see the uberblock for txg + 1 because, say,
1067 * it was on a mirrored device and the replica to which we wrote txg + 1
1068 * is now offline. If we then make some changes and sync txg + 1, and then
1069 * the missing replica comes back, then for a few seconds we'll have two
1070 * conflicting uberblocks on disk with the same txg. The solution is simple:
1071 * among uberblocks with equal txg, choose the one with the latest timestamp.
1072 */
1073 static int
vdev_uberblock_compare(const uberblock_t * ub1,const uberblock_t * ub2)1074 vdev_uberblock_compare(const uberblock_t *ub1, const uberblock_t *ub2)
1075 {
1076 int cmp = AVL_CMP(ub1->ub_txg, ub2->ub_txg);
1077
1078 if (likely(cmp))
1079 return (cmp);
1080
1081 cmp = AVL_CMP(ub1->ub_timestamp, ub2->ub_timestamp);
1082 if (likely(cmp))
1083 return (cmp);
1084
1085 /*
1086 * If MMP_VALID(ub) && MMP_SEQ_VALID(ub) then the host has an MMP-aware
1087 * ZFS, e.g. zfsonlinux >= 0.7.
1088 *
1089 * If one ub has MMP and the other does not, they were written by
1090 * different hosts, which matters for MMP. So we treat no MMP/no SEQ as
1091 * a 0 value.
1092 *
1093 * Since timestamp and txg are the same if we get this far, either is
1094 * acceptable for importing the pool.
1095 */
1096 unsigned int seq1 = 0;
1097 unsigned int seq2 = 0;
1098
1099 if (MMP_VALID(ub1) && MMP_SEQ_VALID(ub1))
1100 seq1 = MMP_SEQ(ub1);
1101
1102 if (MMP_VALID(ub2) && MMP_SEQ_VALID(ub2))
1103 seq2 = MMP_SEQ(ub2);
1104
1105 return (AVL_CMP(seq1, seq2));
1106 }
1107
1108 struct ubl_cbdata {
1109 uberblock_t *ubl_ubbest; /* Best uberblock */
1110 vdev_t *ubl_vd; /* vdev associated with the above */
1111 };
1112
1113 static void
vdev_uberblock_load_done(zio_t * zio)1114 vdev_uberblock_load_done(zio_t *zio)
1115 {
1116 vdev_t *vd = zio->io_vd;
1117 spa_t *spa = zio->io_spa;
1118 zio_t *rio = zio->io_private;
1119 uberblock_t *ub = abd_to_buf(zio->io_abd);
1120 struct ubl_cbdata *cbp = rio->io_private;
1121
1122 ASSERT3U(zio->io_size, ==, VDEV_UBERBLOCK_SIZE(vd));
1123
1124 if (zio->io_error == 0 && uberblock_verify(ub) == 0) {
1125 mutex_enter(&rio->io_lock);
1126 if (ub->ub_txg <= spa->spa_load_max_txg &&
1127 vdev_uberblock_compare(ub, cbp->ubl_ubbest) > 0) {
1128 /*
1129 * Keep track of the vdev in which this uberblock
1130 * was found. We will use this information later
1131 * to obtain the config nvlist associated with
1132 * this uberblock.
1133 */
1134 *cbp->ubl_ubbest = *ub;
1135 cbp->ubl_vd = vd;
1136 }
1137 mutex_exit(&rio->io_lock);
1138 }
1139
1140 abd_free(zio->io_abd);
1141 }
1142
1143 static void
vdev_uberblock_load_impl(zio_t * zio,vdev_t * vd,int flags,struct ubl_cbdata * cbp)1144 vdev_uberblock_load_impl(zio_t *zio, vdev_t *vd, int flags,
1145 struct ubl_cbdata *cbp)
1146 {
1147 for (int c = 0; c < vd->vdev_children; c++)
1148 vdev_uberblock_load_impl(zio, vd->vdev_child[c], flags, cbp);
1149
1150 if (vd->vdev_ops->vdev_op_leaf && vdev_readable(vd)) {
1151 for (int l = 0; l < VDEV_LABELS; l++) {
1152 for (int n = 0; n < VDEV_UBERBLOCK_COUNT(vd); n++) {
1153 vdev_label_read(zio, vd, l,
1154 abd_alloc_linear(VDEV_UBERBLOCK_SIZE(vd),
1155 B_TRUE), VDEV_UBERBLOCK_OFFSET(vd, n),
1156 VDEV_UBERBLOCK_SIZE(vd),
1157 vdev_uberblock_load_done, zio, flags);
1158 }
1159 }
1160 }
1161 }
1162
1163 /*
1164 * Reads the 'best' uberblock from disk along with its associated
1165 * configuration. First, we read the uberblock array of each label of each
1166 * vdev, keeping track of the uberblock with the highest txg in each array.
1167 * Then, we read the configuration from the same vdev as the best uberblock.
1168 */
1169 void
vdev_uberblock_load(vdev_t * rvd,uberblock_t * ub,nvlist_t ** config)1170 vdev_uberblock_load(vdev_t *rvd, uberblock_t *ub, nvlist_t **config)
1171 {
1172 zio_t *zio;
1173 spa_t *spa = rvd->vdev_spa;
1174 struct ubl_cbdata cb;
1175 int flags = ZIO_FLAG_CONFIG_WRITER | ZIO_FLAG_CANFAIL |
1176 ZIO_FLAG_SPECULATIVE | ZIO_FLAG_TRYHARD;
1177
1178 ASSERT(ub);
1179 ASSERT(config);
1180
1181 bzero(ub, sizeof (uberblock_t));
1182 *config = NULL;
1183
1184 cb.ubl_ubbest = ub;
1185 cb.ubl_vd = NULL;
1186
1187 spa_config_enter(spa, SCL_ALL, FTAG, RW_WRITER);
1188 zio = zio_root(spa, NULL, &cb, flags);
1189 vdev_uberblock_load_impl(zio, rvd, flags, &cb);
1190 (void) zio_wait(zio);
1191
1192 /*
1193 * It's possible that the best uberblock was discovered on a label
1194 * that has a configuration which was written in a future txg.
1195 * Search all labels on this vdev to find the configuration that
1196 * matches the txg for our uberblock.
1197 */
1198 if (cb.ubl_vd != NULL) {
1199 vdev_dbgmsg(cb.ubl_vd, "best uberblock found for spa %s. "
1200 "txg %llu", spa->spa_name, (u_longlong_t)ub->ub_txg);
1201
1202 *config = vdev_label_read_config(cb.ubl_vd, ub->ub_txg);
1203 if (*config == NULL && spa->spa_extreme_rewind) {
1204 vdev_dbgmsg(cb.ubl_vd, "failed to read label config. "
1205 "Trying again without txg restrictions.");
1206 *config = vdev_label_read_config(cb.ubl_vd, UINT64_MAX);
1207 }
1208 if (*config == NULL) {
1209 vdev_dbgmsg(cb.ubl_vd, "failed to read label config");
1210 }
1211 }
1212 spa_config_exit(spa, SCL_ALL, FTAG);
1213 }
1214
1215 /*
1216 * On success, increment root zio's count of good writes.
1217 * We only get credit for writes to known-visible vdevs; see spa_vdev_add().
1218 */
1219 static void
vdev_uberblock_sync_done(zio_t * zio)1220 vdev_uberblock_sync_done(zio_t *zio)
1221 {
1222 uint64_t *good_writes = zio->io_private;
1223
1224 if (zio->io_error == 0 && zio->io_vd->vdev_top->vdev_ms_array != 0)
1225 atomic_inc_64(good_writes);
1226 }
1227
1228 /*
1229 * Write the uberblock to all labels of all leaves of the specified vdev.
1230 */
1231 static void
vdev_uberblock_sync(zio_t * zio,uint64_t * good_writes,uberblock_t * ub,vdev_t * vd,int flags)1232 vdev_uberblock_sync(zio_t *zio, uint64_t *good_writes,
1233 uberblock_t *ub, vdev_t *vd, int flags)
1234 {
1235 for (uint64_t c = 0; c < vd->vdev_children; c++) {
1236 vdev_uberblock_sync(zio, good_writes,
1237 ub, vd->vdev_child[c], flags);
1238 }
1239
1240 if (!vd->vdev_ops->vdev_op_leaf)
1241 return;
1242
1243 if (!vdev_writeable(vd))
1244 return;
1245
1246 int m = spa_multihost(vd->vdev_spa) ? MMP_BLOCKS_PER_LABEL : 0;
1247 int n = ub->ub_txg % (VDEV_UBERBLOCK_COUNT(vd) - m);
1248
1249 /* Copy the uberblock_t into the ABD */
1250 abd_t *ub_abd = abd_alloc_for_io(VDEV_UBERBLOCK_SIZE(vd), B_TRUE);
1251 abd_zero(ub_abd, VDEV_UBERBLOCK_SIZE(vd));
1252 abd_copy_from_buf(ub_abd, ub, sizeof (uberblock_t));
1253
1254 for (int l = 0; l < VDEV_LABELS; l++)
1255 vdev_label_write(zio, vd, l, ub_abd,
1256 VDEV_UBERBLOCK_OFFSET(vd, n), VDEV_UBERBLOCK_SIZE(vd),
1257 vdev_uberblock_sync_done, good_writes,
1258 flags | ZIO_FLAG_DONT_PROPAGATE);
1259
1260 abd_free(ub_abd);
1261 }
1262
1263 /* Sync the uberblocks to all vdevs in svd[] */
1264 int
vdev_uberblock_sync_list(vdev_t ** svd,int svdcount,uberblock_t * ub,int flags)1265 vdev_uberblock_sync_list(vdev_t **svd, int svdcount, uberblock_t *ub, int flags)
1266 {
1267 spa_t *spa = svd[0]->vdev_spa;
1268 zio_t *zio;
1269 uint64_t good_writes = 0;
1270
1271 zio = zio_root(spa, NULL, NULL, flags);
1272
1273 for (int v = 0; v < svdcount; v++)
1274 vdev_uberblock_sync(zio, &good_writes, ub, svd[v], flags);
1275
1276 (void) zio_wait(zio);
1277
1278 /*
1279 * Flush the uberblocks to disk. This ensures that the odd labels
1280 * are no longer needed (because the new uberblocks and the even
1281 * labels are safely on disk), so it is safe to overwrite them.
1282 */
1283 zio = zio_root(spa, NULL, NULL, flags);
1284
1285 for (int v = 0; v < svdcount; v++) {
1286 if (vdev_writeable(svd[v])) {
1287 zio_flush(zio, svd[v]);
1288 }
1289 }
1290
1291 (void) zio_wait(zio);
1292
1293 return (good_writes >= 1 ? 0 : EIO);
1294 }
1295
1296 /*
1297 * On success, increment the count of good writes for our top-level vdev.
1298 */
1299 static void
vdev_label_sync_done(zio_t * zio)1300 vdev_label_sync_done(zio_t *zio)
1301 {
1302 uint64_t *good_writes = zio->io_private;
1303
1304 if (zio->io_error == 0)
1305 atomic_inc_64(good_writes);
1306 }
1307
1308 /*
1309 * If there weren't enough good writes, indicate failure to the parent.
1310 */
1311 static void
vdev_label_sync_top_done(zio_t * zio)1312 vdev_label_sync_top_done(zio_t *zio)
1313 {
1314 uint64_t *good_writes = zio->io_private;
1315
1316 if (*good_writes == 0)
1317 zio->io_error = SET_ERROR(EIO);
1318
1319 kmem_free(good_writes, sizeof (uint64_t));
1320 }
1321
1322 /*
1323 * We ignore errors for log and cache devices, simply free the private data.
1324 */
1325 static void
vdev_label_sync_ignore_done(zio_t * zio)1326 vdev_label_sync_ignore_done(zio_t *zio)
1327 {
1328 kmem_free(zio->io_private, sizeof (uint64_t));
1329 }
1330
1331 /*
1332 * Write all even or odd labels to all leaves of the specified vdev.
1333 */
1334 static void
vdev_label_sync(zio_t * zio,uint64_t * good_writes,vdev_t * vd,int l,uint64_t txg,int flags)1335 vdev_label_sync(zio_t *zio, uint64_t *good_writes,
1336 vdev_t *vd, int l, uint64_t txg, int flags)
1337 {
1338 nvlist_t *label;
1339 vdev_phys_t *vp;
1340 abd_t *vp_abd;
1341 char *buf;
1342 size_t buflen;
1343
1344 for (int c = 0; c < vd->vdev_children; c++) {
1345 vdev_label_sync(zio, good_writes,
1346 vd->vdev_child[c], l, txg, flags);
1347 }
1348
1349 if (!vd->vdev_ops->vdev_op_leaf)
1350 return;
1351
1352 if (!vdev_writeable(vd))
1353 return;
1354
1355 /*
1356 * Generate a label describing the top-level config to which we belong.
1357 */
1358 label = spa_config_generate(vd->vdev_spa, vd, txg, B_FALSE);
1359
1360 vp_abd = abd_alloc_linear(sizeof (vdev_phys_t), B_TRUE);
1361 abd_zero(vp_abd, sizeof (vdev_phys_t));
1362 vp = abd_to_buf(vp_abd);
1363
1364 buf = vp->vp_nvlist;
1365 buflen = sizeof (vp->vp_nvlist);
1366
1367 if (nvlist_pack(label, &buf, &buflen, NV_ENCODE_XDR, KM_SLEEP) == 0) {
1368 for (; l < VDEV_LABELS; l += 2) {
1369 vdev_label_write(zio, vd, l, vp_abd,
1370 offsetof(vdev_label_t, vl_vdev_phys),
1371 sizeof (vdev_phys_t),
1372 vdev_label_sync_done, good_writes,
1373 flags | ZIO_FLAG_DONT_PROPAGATE);
1374 }
1375 }
1376
1377 abd_free(vp_abd);
1378 nvlist_free(label);
1379 }
1380
1381 int
vdev_label_sync_list(spa_t * spa,int l,uint64_t txg,int flags)1382 vdev_label_sync_list(spa_t *spa, int l, uint64_t txg, int flags)
1383 {
1384 list_t *dl = &spa->spa_config_dirty_list;
1385 vdev_t *vd;
1386 zio_t *zio;
1387 int error;
1388
1389 /*
1390 * Write the new labels to disk.
1391 */
1392 zio = zio_root(spa, NULL, NULL, flags);
1393
1394 for (vd = list_head(dl); vd != NULL; vd = list_next(dl, vd)) {
1395 uint64_t *good_writes = kmem_zalloc(sizeof (uint64_t),
1396 KM_SLEEP);
1397
1398 ASSERT(!vd->vdev_ishole);
1399
1400 zio_t *vio = zio_null(zio, spa, NULL,
1401 (vd->vdev_islog || vd->vdev_aux != NULL) ?
1402 vdev_label_sync_ignore_done : vdev_label_sync_top_done,
1403 good_writes, flags);
1404 vdev_label_sync(vio, good_writes, vd, l, txg, flags);
1405 zio_nowait(vio);
1406 }
1407
1408 error = zio_wait(zio);
1409
1410 /*
1411 * Flush the new labels to disk.
1412 */
1413 zio = zio_root(spa, NULL, NULL, flags);
1414
1415 for (vd = list_head(dl); vd != NULL; vd = list_next(dl, vd))
1416 zio_flush(zio, vd);
1417
1418 (void) zio_wait(zio);
1419
1420 return (error);
1421 }
1422
1423 /*
1424 * Sync the uberblock and any changes to the vdev configuration.
1425 *
1426 * The order of operations is carefully crafted to ensure that
1427 * if the system panics or loses power at any time, the state on disk
1428 * is still transactionally consistent. The in-line comments below
1429 * describe the failure semantics at each stage.
1430 *
1431 * Moreover, vdev_config_sync() is designed to be idempotent: if it fails
1432 * at any time, you can just call it again, and it will resume its work.
1433 */
1434 int
vdev_config_sync(vdev_t ** svd,int svdcount,uint64_t txg)1435 vdev_config_sync(vdev_t **svd, int svdcount, uint64_t txg)
1436 {
1437 spa_t *spa = svd[0]->vdev_spa;
1438 uberblock_t *ub = &spa->spa_uberblock;
1439 int error = 0;
1440 int flags = ZIO_FLAG_CONFIG_WRITER | ZIO_FLAG_CANFAIL;
1441
1442 ASSERT(svdcount != 0);
1443 retry:
1444 /*
1445 * Normally, we don't want to try too hard to write every label and
1446 * uberblock. If there is a flaky disk, we don't want the rest of the
1447 * sync process to block while we retry. But if we can't write a
1448 * single label out, we should retry with ZIO_FLAG_TRYHARD before
1449 * bailing out and declaring the pool faulted.
1450 */
1451 if (error != 0) {
1452 if ((flags & ZIO_FLAG_TRYHARD) != 0)
1453 return (error);
1454 flags |= ZIO_FLAG_TRYHARD;
1455 }
1456
1457 ASSERT(ub->ub_txg <= txg);
1458
1459 /*
1460 * If this isn't a resync due to I/O errors,
1461 * and nothing changed in this transaction group,
1462 * and the vdev configuration hasn't changed,
1463 * then there's nothing to do.
1464 */
1465 if (ub->ub_txg < txg) {
1466 boolean_t changed = uberblock_update(ub, spa->spa_root_vdev,
1467 txg, spa->spa_mmp.mmp_delay);
1468
1469 if (!changed && list_is_empty(&spa->spa_config_dirty_list))
1470 return (0);
1471 }
1472
1473 if (txg > spa_freeze_txg(spa))
1474 return (0);
1475
1476 ASSERT(txg <= spa->spa_final_txg);
1477
1478 /*
1479 * Flush the write cache of every disk that's been written to
1480 * in this transaction group. This ensures that all blocks
1481 * written in this txg will be committed to stable storage
1482 * before any uberblock that references them.
1483 */
1484 zio_t *zio = zio_root(spa, NULL, NULL, flags);
1485
1486 for (vdev_t *vd =
1487 txg_list_head(&spa->spa_vdev_txg_list, TXG_CLEAN(txg)); vd != NULL;
1488 vd = txg_list_next(&spa->spa_vdev_txg_list, vd, TXG_CLEAN(txg)))
1489 zio_flush(zio, vd);
1490
1491 (void) zio_wait(zio);
1492
1493 /*
1494 * Sync out the even labels (L0, L2) for every dirty vdev. If the
1495 * system dies in the middle of this process, that's OK: all of the
1496 * even labels that made it to disk will be newer than any uberblock,
1497 * and will therefore be considered invalid. The odd labels (L1, L3),
1498 * which have not yet been touched, will still be valid. We flush
1499 * the new labels to disk to ensure that all even-label updates
1500 * are committed to stable storage before the uberblock update.
1501 */
1502 if ((error = vdev_label_sync_list(spa, 0, txg, flags)) != 0) {
1503 if ((flags & ZIO_FLAG_TRYHARD) != 0) {
1504 zfs_dbgmsg("vdev_label_sync_list() returned error %d "
1505 "for pool '%s' when syncing out the even labels "
1506 "of dirty vdevs", error, spa_name(spa));
1507 }
1508 goto retry;
1509 }
1510
1511 /*
1512 * Sync the uberblocks to all vdevs in svd[].
1513 * If the system dies in the middle of this step, there are two cases
1514 * to consider, and the on-disk state is consistent either way:
1515 *
1516 * (1) If none of the new uberblocks made it to disk, then the
1517 * previous uberblock will be the newest, and the odd labels
1518 * (which had not yet been touched) will be valid with respect
1519 * to that uberblock.
1520 *
1521 * (2) If one or more new uberblocks made it to disk, then they
1522 * will be the newest, and the even labels (which had all
1523 * been successfully committed) will be valid with respect
1524 * to the new uberblocks.
1525 */
1526 if ((error = vdev_uberblock_sync_list(svd, svdcount, ub, flags)) != 0) {
1527 if ((flags & ZIO_FLAG_TRYHARD) != 0) {
1528 zfs_dbgmsg("vdev_uberblock_sync_list() returned error "
1529 "%d for pool '%s'", error, spa_name(spa));
1530 }
1531 goto retry;
1532 }
1533
1534 if (spa_multihost(spa))
1535 mmp_update_uberblock(spa, ub);
1536
1537 /*
1538 * Sync out odd labels for every dirty vdev. If the system dies
1539 * in the middle of this process, the even labels and the new
1540 * uberblocks will suffice to open the pool. The next time
1541 * the pool is opened, the first thing we'll do -- before any
1542 * user data is modified -- is mark every vdev dirty so that
1543 * all labels will be brought up to date. We flush the new labels
1544 * to disk to ensure that all odd-label updates are committed to
1545 * stable storage before the next transaction group begins.
1546 */
1547 if ((error = vdev_label_sync_list(spa, 1, txg, flags)) != 0) {
1548 if ((flags & ZIO_FLAG_TRYHARD) != 0) {
1549 zfs_dbgmsg("vdev_label_sync_list() returned error %d "
1550 "for pool '%s' when syncing out the odd labels of "
1551 "dirty vdevs", error, spa_name(spa));
1552 }
1553 goto retry;;
1554 }
1555
1556 trim_thread_wakeup(spa);
1557
1558 return (0);
1559 }
1560