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