]> granicus.if.org Git - zfs/blob - module/zfs/spa_config.c
Check ashift validity in 'zpool add'
[zfs] / module / zfs / spa_config.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 2011 Nexenta Systems, Inc. All rights reserved.
25  * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
26  */
27
28 #include <sys/spa.h>
29 #include <sys/fm/fs/zfs.h>
30 #include <sys/spa_impl.h>
31 #include <sys/nvpair.h>
32 #include <sys/uio.h>
33 #include <sys/fs/zfs.h>
34 #include <sys/vdev_impl.h>
35 #include <sys/zfs_ioctl.h>
36 #include <sys/systeminfo.h>
37 #include <sys/sunddi.h>
38 #include <sys/zfeature.h>
39 #ifdef _KERNEL
40 #include <sys/kobj.h>
41 #include <sys/zone.h>
42 #endif
43
44 /*
45  * Pool configuration repository.
46  *
47  * Pool configuration is stored as a packed nvlist on the filesystem.  By
48  * default, all pools are stored in /etc/zfs/zpool.cache and loaded on boot
49  * (when the ZFS module is loaded).  Pools can also have the 'cachefile'
50  * property set that allows them to be stored in an alternate location until
51  * the control of external software.
52  *
53  * For each cache file, we have a single nvlist which holds all the
54  * configuration information.  When the module loads, we read this information
55  * from /etc/zfs/zpool.cache and populate the SPA namespace.  This namespace is
56  * maintained independently in spa.c.  Whenever the namespace is modified, or
57  * the configuration of a pool is changed, we call spa_config_sync(), which
58  * walks through all the active pools and writes the configuration to disk.
59  */
60
61 static uint64_t spa_config_generation = 1;
62
63 /*
64  * This can be overridden in userland to preserve an alternate namespace for
65  * userland pools when doing testing.
66  */
67 char *spa_config_path = ZPOOL_CACHE;
68 int zfs_autoimport_disable = 1;
69
70 /*
71  * Called when the module is first loaded, this routine loads the configuration
72  * file into the SPA namespace.  It does not actually open or load the pools; it
73  * only populates the namespace.
74  */
75 void
76 spa_config_load(void)
77 {
78         void *buf = NULL;
79         nvlist_t *nvlist, *child;
80         nvpair_t *nvpair;
81         char *pathname;
82         struct _buf *file;
83         uint64_t fsize;
84
85 #ifdef _KERNEL
86         if (zfs_autoimport_disable)
87                 return;
88 #endif
89
90         /*
91          * Open the configuration file.
92          */
93         pathname = kmem_alloc(MAXPATHLEN, KM_SLEEP);
94
95         (void) snprintf(pathname, MAXPATHLEN, "%s%s",
96             (rootdir != NULL) ? "./" : "", spa_config_path);
97
98         file = kobj_open_file(pathname);
99
100         kmem_free(pathname, MAXPATHLEN);
101
102         if (file == (struct _buf *)-1)
103                 return;
104
105         if (kobj_get_filesize(file, &fsize) != 0)
106                 goto out;
107
108         buf = kmem_alloc(fsize, KM_SLEEP);
109
110         /*
111          * Read the nvlist from the file.
112          */
113         if (kobj_read_file(file, buf, fsize, 0) < 0)
114                 goto out;
115
116         /*
117          * Unpack the nvlist.
118          */
119         if (nvlist_unpack(buf, fsize, &nvlist, KM_SLEEP) != 0)
120                 goto out;
121
122         /*
123          * Iterate over all elements in the nvlist, creating a new spa_t for
124          * each one with the specified configuration.
125          */
126         mutex_enter(&spa_namespace_lock);
127         nvpair = NULL;
128         while ((nvpair = nvlist_next_nvpair(nvlist, nvpair)) != NULL) {
129                 if (nvpair_type(nvpair) != DATA_TYPE_NVLIST)
130                         continue;
131
132                 child = fnvpair_value_nvlist(nvpair);
133
134                 if (spa_lookup(nvpair_name(nvpair)) != NULL)
135                         continue;
136                 (void) spa_add(nvpair_name(nvpair), child, NULL);
137         }
138         mutex_exit(&spa_namespace_lock);
139
140         nvlist_free(nvlist);
141
142 out:
143         if (buf != NULL)
144                 kmem_free(buf, fsize);
145
146         kobj_close_file(file);
147 }
148
149 static int
150 spa_config_write(spa_config_dirent_t *dp, nvlist_t *nvl)
151 {
152         size_t buflen;
153         char *buf;
154         vnode_t *vp;
155         int oflags = FWRITE | FTRUNC | FCREAT | FOFFMAX;
156         char *temp;
157         int err;
158
159         /*
160          * If the nvlist is empty (NULL), then remove the old cachefile.
161          */
162         if (nvl == NULL) {
163                 err = vn_remove(dp->scd_path, UIO_SYSSPACE, RMFILE);
164                 return (err);
165         }
166
167         /*
168          * Pack the configuration into a buffer.
169          */
170         buf = fnvlist_pack(nvl, &buflen);
171         temp = kmem_zalloc(MAXPATHLEN, KM_SLEEP);
172
173 #if defined(__linux__) && defined(_KERNEL)
174         /*
175          * Write the configuration to disk.  Due to the complexity involved
176          * in performing a rename from within the kernel the file is truncated
177          * and overwritten in place.  In the event of an error the file is
178          * unlinked to make sure we always have a consistent view of the data.
179          */
180         err = vn_open(dp->scd_path, UIO_SYSSPACE, oflags, 0644, &vp, 0, 0);
181         if (err == 0) {
182                 err = vn_rdwr(UIO_WRITE, vp, buf, buflen, 0,
183                     UIO_SYSSPACE, 0, RLIM64_INFINITY, kcred, NULL);
184                 if (err == 0)
185                         err = VOP_FSYNC(vp, FSYNC, kcred, NULL);
186
187                 (void) VOP_CLOSE(vp, oflags, 1, 0, kcred, NULL);
188
189                 if (err)
190                         (void) vn_remove(dp->scd_path, UIO_SYSSPACE, RMFILE);
191         }
192 #else
193         /*
194          * Write the configuration to disk.  We need to do the traditional
195          * 'write to temporary file, sync, move over original' to make sure we
196          * always have a consistent view of the data.
197          */
198         (void) snprintf(temp, MAXPATHLEN, "%s.tmp", dp->scd_path);
199
200         err = vn_open(temp, UIO_SYSSPACE, oflags, 0644, &vp, CRCREAT, 0);
201         if (err == 0) {
202                 err = vn_rdwr(UIO_WRITE, vp, buf, buflen, 0, UIO_SYSSPACE,
203                     0, RLIM64_INFINITY, kcred, NULL);
204                 if (err == 0)
205                         err = VOP_FSYNC(vp, FSYNC, kcred, NULL);
206                 if (err == 0)
207                         err = vn_rename(temp, dp->scd_path, UIO_SYSSPACE);
208                 (void) VOP_CLOSE(vp, oflags, 1, 0, kcred, NULL);
209         }
210
211         (void) vn_remove(temp, UIO_SYSSPACE, RMFILE);
212 #endif
213
214         fnvlist_pack_free(buf, buflen);
215         kmem_free(temp, MAXPATHLEN);
216         return (err);
217 }
218
219 /*
220  * Synchronize pool configuration to disk.  This must be called with the
221  * namespace lock held. Synchronizing the pool cache is typically done after
222  * the configuration has been synced to the MOS. This exposes a window where
223  * the MOS config will have been updated but the cache file has not. If
224  * the system were to crash at that instant then the cached config may not
225  * contain the correct information to open the pool and an explicit import
226  * would be required.
227  */
228 void
229 spa_config_sync(spa_t *target, boolean_t removing, boolean_t postsysevent)
230 {
231         spa_config_dirent_t *dp, *tdp;
232         nvlist_t *nvl;
233         char *pool_name;
234         boolean_t ccw_failure;
235         int error = 0;
236
237         ASSERT(MUTEX_HELD(&spa_namespace_lock));
238
239         if (rootdir == NULL || !(spa_mode_global & FWRITE))
240                 return;
241
242         /*
243          * Iterate over all cachefiles for the pool, past or present.  When the
244          * cachefile is changed, the new one is pushed onto this list, allowing
245          * us to update previous cachefiles that no longer contain this pool.
246          */
247         ccw_failure = B_FALSE;
248         for (dp = list_head(&target->spa_config_list); dp != NULL;
249             dp = list_next(&target->spa_config_list, dp)) {
250                 spa_t *spa = NULL;
251                 if (dp->scd_path == NULL)
252                         continue;
253
254                 /*
255                  * Iterate over all pools, adding any matching pools to 'nvl'.
256                  */
257                 nvl = NULL;
258                 while ((spa = spa_next(spa)) != NULL) {
259                         /*
260                          * Skip over our own pool if we're about to remove
261                          * ourselves from the spa namespace or any pool that
262                          * is readonly. Since we cannot guarantee that a
263                          * readonly pool would successfully import upon reboot,
264                          * we don't allow them to be written to the cache file.
265                          */
266                         if ((spa == target && removing) ||
267                             !spa_writeable(spa))
268                                 continue;
269
270                         mutex_enter(&spa->spa_props_lock);
271                         tdp = list_head(&spa->spa_config_list);
272                         if (spa->spa_config == NULL ||
273                             tdp == NULL ||
274                             tdp->scd_path == NULL ||
275                             strcmp(tdp->scd_path, dp->scd_path) != 0) {
276                                 mutex_exit(&spa->spa_props_lock);
277                                 continue;
278                         }
279
280                         if (nvl == NULL)
281                                 nvl = fnvlist_alloc();
282
283                         if (spa->spa_import_flags & ZFS_IMPORT_TEMP_NAME)
284                                 pool_name = fnvlist_lookup_string(
285                                     spa->spa_config, ZPOOL_CONFIG_POOL_NAME);
286                         else
287                                 pool_name = spa_name(spa);
288
289                         fnvlist_add_nvlist(nvl, pool_name, spa->spa_config);
290                         mutex_exit(&spa->spa_props_lock);
291                 }
292
293                 error = spa_config_write(dp, nvl);
294                 if (error != 0)
295                         ccw_failure = B_TRUE;
296                 nvlist_free(nvl);
297         }
298
299         if (ccw_failure) {
300                 /*
301                  * Keep trying so that configuration data is
302                  * written if/when any temporary filesystem
303                  * resource issues are resolved.
304                  */
305                 if (target->spa_ccw_fail_time == 0) {
306                         zfs_ereport_post(FM_EREPORT_ZFS_CONFIG_CACHE_WRITE,
307                             target, NULL, NULL, 0, 0);
308                 }
309                 target->spa_ccw_fail_time = gethrtime();
310                 spa_async_request(target, SPA_ASYNC_CONFIG_UPDATE);
311         } else {
312                 /*
313                  * Do not rate limit future attempts to update
314                  * the config cache.
315                  */
316                 target->spa_ccw_fail_time = 0;
317         }
318
319         /*
320          * Remove any config entries older than the current one.
321          */
322         dp = list_head(&target->spa_config_list);
323         while ((tdp = list_next(&target->spa_config_list, dp)) != NULL) {
324                 list_remove(&target->spa_config_list, tdp);
325                 if (tdp->scd_path != NULL)
326                         spa_strfree(tdp->scd_path);
327                 kmem_free(tdp, sizeof (spa_config_dirent_t));
328         }
329
330         spa_config_generation++;
331
332         if (postsysevent)
333                 spa_event_notify(target, NULL, ESC_ZFS_CONFIG_SYNC);
334 }
335
336 /*
337  * Sigh.  Inside a local zone, we don't have access to /etc/zfs/zpool.cache,
338  * and we don't want to allow the local zone to see all the pools anyway.
339  * So we have to invent the ZFS_IOC_CONFIG ioctl to grab the configuration
340  * information for all pool visible within the zone.
341  */
342 nvlist_t *
343 spa_all_configs(uint64_t *generation)
344 {
345         nvlist_t *pools;
346         spa_t *spa = NULL;
347
348         if (*generation == spa_config_generation)
349                 return (NULL);
350
351         pools = fnvlist_alloc();
352
353         mutex_enter(&spa_namespace_lock);
354         while ((spa = spa_next(spa)) != NULL) {
355                 if (INGLOBALZONE(curproc) ||
356                     zone_dataset_visible(spa_name(spa), NULL)) {
357                         mutex_enter(&spa->spa_props_lock);
358                         fnvlist_add_nvlist(pools, spa_name(spa),
359                             spa->spa_config);
360                         mutex_exit(&spa->spa_props_lock);
361                 }
362         }
363         *generation = spa_config_generation;
364         mutex_exit(&spa_namespace_lock);
365
366         return (pools);
367 }
368
369 void
370 spa_config_set(spa_t *spa, nvlist_t *config)
371 {
372         mutex_enter(&spa->spa_props_lock);
373         nvlist_free(spa->spa_config);
374         spa->spa_config = config;
375         mutex_exit(&spa->spa_props_lock);
376 }
377
378 /*
379  * Generate the pool's configuration based on the current in-core state.
380  *
381  * We infer whether to generate a complete config or just one top-level config
382  * based on whether vd is the root vdev.
383  */
384 nvlist_t *
385 spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg, int getstats)
386 {
387         nvlist_t *config, *nvroot;
388         vdev_t *rvd = spa->spa_root_vdev;
389         unsigned long hostid = 0;
390         boolean_t locked = B_FALSE;
391         uint64_t split_guid;
392         char *pool_name;
393         int config_gen_flags = 0;
394
395         if (vd == NULL) {
396                 vd = rvd;
397                 locked = B_TRUE;
398                 spa_config_enter(spa, SCL_CONFIG | SCL_STATE, FTAG, RW_READER);
399         }
400
401         ASSERT(spa_config_held(spa, SCL_CONFIG | SCL_STATE, RW_READER) ==
402             (SCL_CONFIG | SCL_STATE));
403
404         /*
405          * If txg is -1, report the current value of spa->spa_config_txg.
406          */
407         if (txg == -1ULL)
408                 txg = spa->spa_config_txg;
409
410         /*
411          * Originally, users had to handle spa namespace collisions by either
412          * exporting the already imported pool or by specifying a new name for
413          * the pool with a conflicting name. In the case of root pools from
414          * virtual guests, neither approach to collision resolution is
415          * reasonable. This is addressed by extending the new name syntax with
416          * an option to specify that the new name is temporary. When specified,
417          * ZFS_IMPORT_TEMP_NAME will be set in spa->spa_import_flags to tell us
418          * to use the previous name, which we do below.
419          */
420         if (spa->spa_import_flags & ZFS_IMPORT_TEMP_NAME) {
421                 VERIFY0(nvlist_lookup_string(spa->spa_config,
422                     ZPOOL_CONFIG_POOL_NAME, &pool_name));
423         } else
424                 pool_name = spa_name(spa);
425
426         config = fnvlist_alloc();
427
428         fnvlist_add_uint64(config, ZPOOL_CONFIG_VERSION, spa_version(spa));
429         fnvlist_add_string(config, ZPOOL_CONFIG_POOL_NAME, pool_name);
430         fnvlist_add_uint64(config, ZPOOL_CONFIG_POOL_STATE, spa_state(spa));
431         fnvlist_add_uint64(config, ZPOOL_CONFIG_POOL_TXG, txg);
432         fnvlist_add_uint64(config, ZPOOL_CONFIG_POOL_GUID, spa_guid(spa));
433         fnvlist_add_uint64(config, ZPOOL_CONFIG_ERRATA, spa->spa_errata);
434         if (spa->spa_comment != NULL)
435                 fnvlist_add_string(config, ZPOOL_CONFIG_COMMENT,
436                     spa->spa_comment);
437
438 #ifdef  _KERNEL
439         hostid = zone_get_hostid(NULL);
440 #else   /* _KERNEL */
441         /*
442          * We're emulating the system's hostid in userland, so we can't use
443          * zone_get_hostid().
444          */
445         (void) ddi_strtoul(hw_serial, NULL, 10, &hostid);
446 #endif  /* _KERNEL */
447         if (hostid != 0)
448                 fnvlist_add_uint64(config, ZPOOL_CONFIG_HOSTID, hostid);
449         fnvlist_add_string(config, ZPOOL_CONFIG_HOSTNAME, utsname()->nodename);
450
451         if (vd != rvd) {
452                 fnvlist_add_uint64(config, ZPOOL_CONFIG_TOP_GUID,
453                     vd->vdev_top->vdev_guid);
454                 fnvlist_add_uint64(config, ZPOOL_CONFIG_GUID,
455                     vd->vdev_guid);
456                 if (vd->vdev_isspare)
457                         fnvlist_add_uint64(config,
458                             ZPOOL_CONFIG_IS_SPARE, 1ULL);
459                 if (vd->vdev_islog)
460                         fnvlist_add_uint64(config,
461                             ZPOOL_CONFIG_IS_LOG, 1ULL);
462                 vd = vd->vdev_top;              /* label contains top config */
463         } else {
464                 /*
465                  * Only add the (potentially large) split information
466                  * in the mos config, and not in the vdev labels
467                  */
468                 if (spa->spa_config_splitting != NULL)
469                         fnvlist_add_nvlist(config, ZPOOL_CONFIG_SPLIT,
470                             spa->spa_config_splitting);
471
472                 fnvlist_add_boolean(config, ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS);
473
474                 config_gen_flags |= VDEV_CONFIG_MOS;
475         }
476
477         /*
478          * Add the top-level config.  We even add this on pools which
479          * don't support holes in the namespace.
480          */
481         vdev_top_config_generate(spa, config);
482
483         /*
484          * If we're splitting, record the original pool's guid.
485          */
486         if (spa->spa_config_splitting != NULL &&
487             nvlist_lookup_uint64(spa->spa_config_splitting,
488             ZPOOL_CONFIG_SPLIT_GUID, &split_guid) == 0) {
489                 fnvlist_add_uint64(config, ZPOOL_CONFIG_SPLIT_GUID, split_guid);
490         }
491
492         nvroot = vdev_config_generate(spa, vd, getstats, config_gen_flags);
493         fnvlist_add_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, nvroot);
494         nvlist_free(nvroot);
495
496         /*
497          * Store what's necessary for reading the MOS in the label.
498          */
499         fnvlist_add_nvlist(config, ZPOOL_CONFIG_FEATURES_FOR_READ,
500             spa->spa_label_features);
501
502         if (getstats && spa_load_state(spa) == SPA_LOAD_NONE) {
503                 ddt_histogram_t *ddh;
504                 ddt_stat_t *dds;
505                 ddt_object_t *ddo;
506
507                 ddh = kmem_zalloc(sizeof (ddt_histogram_t), KM_SLEEP);
508                 ddt_get_dedup_histogram(spa, ddh);
509                 fnvlist_add_uint64_array(config,
510                     ZPOOL_CONFIG_DDT_HISTOGRAM,
511                     (uint64_t *)ddh, sizeof (*ddh) / sizeof (uint64_t));
512                 kmem_free(ddh, sizeof (ddt_histogram_t));
513
514                 ddo = kmem_zalloc(sizeof (ddt_object_t), KM_SLEEP);
515                 ddt_get_dedup_object_stats(spa, ddo);
516                 fnvlist_add_uint64_array(config,
517                     ZPOOL_CONFIG_DDT_OBJ_STATS,
518                     (uint64_t *)ddo, sizeof (*ddo) / sizeof (uint64_t));
519                 kmem_free(ddo, sizeof (ddt_object_t));
520
521                 dds = kmem_zalloc(sizeof (ddt_stat_t), KM_SLEEP);
522                 ddt_get_dedup_stats(spa, dds);
523                 fnvlist_add_uint64_array(config,
524                     ZPOOL_CONFIG_DDT_STATS,
525                     (uint64_t *)dds, sizeof (*dds) / sizeof (uint64_t));
526                 kmem_free(dds, sizeof (ddt_stat_t));
527         }
528
529         if (locked)
530                 spa_config_exit(spa, SCL_CONFIG | SCL_STATE, FTAG);
531
532         return (config);
533 }
534
535 /*
536  * Update all disk labels, generate a fresh config based on the current
537  * in-core state, and sync the global config cache (do not sync the config
538  * cache if this is a booting rootpool).
539  */
540 void
541 spa_config_update(spa_t *spa, int what)
542 {
543         vdev_t *rvd = spa->spa_root_vdev;
544         uint64_t txg;
545         int c;
546
547         ASSERT(MUTEX_HELD(&spa_namespace_lock));
548
549         spa_config_enter(spa, SCL_ALL, FTAG, RW_WRITER);
550         txg = spa_last_synced_txg(spa) + 1;
551         if (what == SPA_CONFIG_UPDATE_POOL) {
552                 vdev_config_dirty(rvd);
553         } else {
554                 /*
555                  * If we have top-level vdevs that were added but have
556                  * not yet been prepared for allocation, do that now.
557                  * (It's safe now because the config cache is up to date,
558                  * so it will be able to translate the new DVAs.)
559                  * See comments in spa_vdev_add() for full details.
560                  */
561                 for (c = 0; c < rvd->vdev_children; c++) {
562                         vdev_t *tvd = rvd->vdev_child[c];
563                         if (tvd->vdev_ms_array == 0)
564                                 vdev_metaslab_set_size(tvd);
565                         vdev_expand(tvd, txg);
566                 }
567         }
568         spa_config_exit(spa, SCL_ALL, FTAG);
569
570         /*
571          * Wait for the mosconfig to be regenerated and synced.
572          */
573         txg_wait_synced(spa->spa_dsl_pool, txg);
574
575         /*
576          * Update the global config cache to reflect the new mosconfig.
577          */
578         if (!spa->spa_is_root)
579                 spa_config_sync(spa, B_FALSE, what != SPA_CONFIG_UPDATE_POOL);
580
581         if (what == SPA_CONFIG_UPDATE_POOL)
582                 spa_config_update(spa, SPA_CONFIG_UPDATE_VDEVS);
583 }
584
585 #if defined(_KERNEL) && defined(HAVE_SPL)
586 EXPORT_SYMBOL(spa_config_sync);
587 EXPORT_SYMBOL(spa_config_load);
588 EXPORT_SYMBOL(spa_all_configs);
589 EXPORT_SYMBOL(spa_config_set);
590 EXPORT_SYMBOL(spa_config_generate);
591 EXPORT_SYMBOL(spa_config_update);
592
593 module_param(spa_config_path, charp, 0444);
594 MODULE_PARM_DESC(spa_config_path, "SPA config file (/etc/zfs/zpool.cache)");
595
596 module_param(zfs_autoimport_disable, int, 0644);
597 MODULE_PARM_DESC(zfs_autoimport_disable, "Disable pool import at module load");
598
599 #endif