4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
27 #include <sys/spa_impl.h>
28 #include <sys/nvpair.h>
30 #include <sys/fs/zfs.h>
31 #include <sys/vdev_impl.h>
32 #include <sys/zfs_ioctl.h>
33 #include <sys/utsname.h>
34 #include <sys/systeminfo.h>
35 #include <sys/sunddi.h>
42 * Pool configuration repository.
44 * Pool configuration is stored as a packed nvlist on the filesystem. By
45 * default, all pools are stored in /etc/zfs/zpool.cache and loaded on boot
46 * (when the ZFS module is loaded). Pools can also have the 'cachefile'
47 * property set that allows them to be stored in an alternate location until
48 * the control of external software.
50 * For each cache file, we have a single nvlist which holds all the
51 * configuration information. When the module loads, we read this information
52 * from /etc/zfs/zpool.cache and populate the SPA namespace. This namespace is
53 * maintained independently in spa.c. Whenever the namespace is modified, or
54 * the configuration of a pool is changed, we call spa_config_sync(), which
55 * walks through all the active pools and writes the configuration to disk.
58 static uint64_t spa_config_generation = 1;
61 * This can be overridden in userland to preserve an alternate namespace for
62 * userland pools when doing testing.
64 char *spa_config_path = ZPOOL_CACHE;
67 * Called when the module is first loaded, this routine loads the configuration
68 * file into the SPA namespace. It does not actually open or load the pools; it
69 * only populates the namespace.
75 nvlist_t *nvlist, *child;
82 * Open the configuration file.
84 pathname = kmem_alloc(MAXPATHLEN, KM_SLEEP);
86 (void) snprintf(pathname, MAXPATHLEN, "%s%s",
87 (rootdir != NULL) ? "./" : "", spa_config_path);
89 file = kobj_open_file(pathname);
91 kmem_free(pathname, MAXPATHLEN);
93 if (file == (struct _buf *)-1)
96 if (kobj_get_filesize(file, &fsize) != 0)
99 buf = kmem_alloc(fsize, KM_SLEEP | KM_NODEBUG);
102 * Read the nvlist from the file.
104 if (kobj_read_file(file, buf, fsize, 0) < 0)
110 if (nvlist_unpack(buf, fsize, &nvlist, KM_SLEEP) != 0)
114 * Iterate over all elements in the nvlist, creating a new spa_t for
115 * each one with the specified configuration.
117 mutex_enter(&spa_namespace_lock);
119 while ((nvpair = nvlist_next_nvpair(nvlist, nvpair)) != NULL) {
120 if (nvpair_type(nvpair) != DATA_TYPE_NVLIST)
123 VERIFY(nvpair_value_nvlist(nvpair, &child) == 0);
125 if (spa_lookup(nvpair_name(nvpair)) != NULL)
127 (void) spa_add(nvpair_name(nvpair), child, NULL);
129 mutex_exit(&spa_namespace_lock);
135 kmem_free(buf, fsize);
137 kobj_close_file(file);
141 spa_config_write(spa_config_dirent_t *dp, nvlist_t *nvl)
146 int oflags = FWRITE | FTRUNC | FCREAT | FOFFMAX;
150 * If the nvlist is empty (NULL), then remove the old cachefile.
153 (void) vn_remove(dp->scd_path, UIO_SYSSPACE, RMFILE);
158 * Pack the configuration into a buffer.
160 VERIFY(nvlist_size(nvl, &buflen, NV_ENCODE_XDR) == 0);
162 buf = kmem_alloc(buflen, KM_SLEEP | KM_NODEBUG);
163 temp = kmem_zalloc(MAXPATHLEN, KM_SLEEP);
165 VERIFY(nvlist_pack(nvl, &buf, &buflen, NV_ENCODE_XDR,
169 * Write the configuration to disk. We need to do the traditional
170 * 'write to temporary file, sync, move over original' to make sure we
171 * always have a consistent view of the data.
173 (void) snprintf(temp, MAXPATHLEN, "%s.tmp", dp->scd_path);
175 if (vn_open(temp, UIO_SYSSPACE, oflags, 0644, &vp, CRCREAT, 0) == 0) {
176 if (vn_rdwr(UIO_WRITE, vp, buf, buflen, 0, UIO_SYSSPACE,
177 0, RLIM64_INFINITY, kcred, NULL) == 0 &&
178 VOP_FSYNC(vp, FSYNC, kcred, NULL) == 0) {
179 (void) vn_rename(temp, dp->scd_path, UIO_SYSSPACE);
181 (void) VOP_CLOSE(vp, oflags, 1, 0, kcred, NULL);
184 (void) vn_remove(temp, UIO_SYSSPACE, RMFILE);
186 kmem_free(buf, buflen);
187 kmem_free(temp, MAXPATHLEN);
191 * Synchronize pool configuration to disk. This must be called with the
192 * namespace lock held.
195 spa_config_sync(spa_t *target, boolean_t removing, boolean_t postsysevent)
197 spa_config_dirent_t *dp, *tdp;
200 ASSERT(MUTEX_HELD(&spa_namespace_lock));
202 if (rootdir == NULL || !(spa_mode_global & FWRITE))
206 * Iterate over all cachefiles for the pool, past or present. When the
207 * cachefile is changed, the new one is pushed onto this list, allowing
208 * us to update previous cachefiles that no longer contain this pool.
210 for (dp = list_head(&target->spa_config_list); dp != NULL;
211 dp = list_next(&target->spa_config_list, dp)) {
213 if (dp->scd_path == NULL)
217 * Iterate over all pools, adding any matching pools to 'nvl'.
220 while ((spa = spa_next(spa)) != NULL) {
221 if (spa == target && removing)
224 mutex_enter(&spa->spa_props_lock);
225 tdp = list_head(&spa->spa_config_list);
226 if (spa->spa_config == NULL ||
227 tdp->scd_path == NULL ||
228 strcmp(tdp->scd_path, dp->scd_path) != 0) {
229 mutex_exit(&spa->spa_props_lock);
234 VERIFY(nvlist_alloc(&nvl, NV_UNIQUE_NAME,
237 VERIFY(nvlist_add_nvlist(nvl, spa->spa_name,
238 spa->spa_config) == 0);
239 mutex_exit(&spa->spa_props_lock);
242 spa_config_write(dp, nvl);
247 * Remove any config entries older than the current one.
249 dp = list_head(&target->spa_config_list);
250 while ((tdp = list_next(&target->spa_config_list, dp)) != NULL) {
251 list_remove(&target->spa_config_list, tdp);
252 if (tdp->scd_path != NULL)
253 spa_strfree(tdp->scd_path);
254 kmem_free(tdp, sizeof (spa_config_dirent_t));
257 spa_config_generation++;
260 spa_event_notify(target, NULL, FM_EREPORT_ZFS_CONFIG_SYNC);
264 * Sigh. Inside a local zone, we don't have access to /etc/zfs/zpool.cache,
265 * and we don't want to allow the local zone to see all the pools anyway.
266 * So we have to invent the ZFS_IOC_CONFIG ioctl to grab the configuration
267 * information for all pool visible within the zone.
270 spa_all_configs(uint64_t *generation)
275 if (*generation == spa_config_generation)
278 VERIFY(nvlist_alloc(&pools, NV_UNIQUE_NAME, KM_SLEEP) == 0);
280 mutex_enter(&spa_namespace_lock);
281 while ((spa = spa_next(spa)) != NULL) {
282 if (INGLOBALZONE(curproc) ||
283 zone_dataset_visible(spa_name(spa), NULL)) {
284 mutex_enter(&spa->spa_props_lock);
285 VERIFY(nvlist_add_nvlist(pools, spa_name(spa),
286 spa->spa_config) == 0);
287 mutex_exit(&spa->spa_props_lock);
290 *generation = spa_config_generation;
291 mutex_exit(&spa_namespace_lock);
297 spa_config_set(spa_t *spa, nvlist_t *config)
299 mutex_enter(&spa->spa_props_lock);
300 if (spa->spa_config != NULL)
301 nvlist_free(spa->spa_config);
302 spa->spa_config = config;
303 mutex_exit(&spa->spa_props_lock);
307 * Generate the pool's configuration based on the current in-core state.
308 * We infer whether to generate a complete config or just one top-level config
309 * based on whether vd is the root vdev.
312 spa_config_generate(spa_t *spa, vdev_t *vd, uint64_t txg, int getstats)
314 nvlist_t *config, *nvroot;
315 vdev_t *rvd = spa->spa_root_vdev;
316 unsigned long hostid = 0;
317 boolean_t locked = B_FALSE;
323 spa_config_enter(spa, SCL_CONFIG | SCL_STATE, FTAG, RW_READER);
326 ASSERT(spa_config_held(spa, SCL_CONFIG | SCL_STATE, RW_READER) ==
327 (SCL_CONFIG | SCL_STATE));
330 * If txg is -1, report the current value of spa->spa_config_txg.
333 txg = spa->spa_config_txg;
335 VERIFY(nvlist_alloc(&config, NV_UNIQUE_NAME, KM_SLEEP) == 0);
337 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_VERSION,
338 spa_version(spa)) == 0);
339 VERIFY(nvlist_add_string(config, ZPOOL_CONFIG_POOL_NAME,
340 spa_name(spa)) == 0);
341 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_POOL_STATE,
342 spa_state(spa)) == 0);
343 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_POOL_TXG,
345 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_POOL_GUID,
346 spa_guid(spa)) == 0);
348 hostid = zone_get_hostid(NULL);
351 * We're emulating the system's hostid in userland, so we can't use
354 (void) ddi_strtoul(hw_serial, NULL, 10, &hostid);
357 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_HOSTID,
360 VERIFY(nvlist_add_string(config, ZPOOL_CONFIG_HOSTNAME,
361 utsname.nodename) == 0);
364 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_TOP_GUID,
365 vd->vdev_top->vdev_guid) == 0);
366 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_GUID,
367 vd->vdev_guid) == 0);
368 if (vd->vdev_isspare)
369 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_IS_SPARE,
372 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_IS_LOG,
374 vd = vd->vdev_top; /* label contains top config */
377 * Only add the (potentially large) split information
378 * in the mos config, and not in the vdev labels
380 if (spa->spa_config_splitting != NULL)
381 VERIFY(nvlist_add_nvlist(config, ZPOOL_CONFIG_SPLIT,
382 spa->spa_config_splitting) == 0);
386 * Add the top-level config. We even add this on pools which
387 * don't support holes in the namespace.
389 vdev_top_config_generate(spa, config);
392 * If we're splitting, record the original pool's guid.
394 if (spa->spa_config_splitting != NULL &&
395 nvlist_lookup_uint64(spa->spa_config_splitting,
396 ZPOOL_CONFIG_SPLIT_GUID, &split_guid) == 0) {
397 VERIFY(nvlist_add_uint64(config, ZPOOL_CONFIG_SPLIT_GUID,
401 nvroot = vdev_config_generate(spa, vd, getstats, 0);
402 VERIFY(nvlist_add_nvlist(config, ZPOOL_CONFIG_VDEV_TREE, nvroot) == 0);
405 if (getstats && spa_load_state(spa) == SPA_LOAD_NONE) {
406 ddt_histogram_t *ddh;
410 ddh = kmem_zalloc(sizeof (ddt_histogram_t), KM_SLEEP);
411 ddt_get_dedup_histogram(spa, ddh);
412 VERIFY(nvlist_add_uint64_array(config,
413 ZPOOL_CONFIG_DDT_HISTOGRAM,
414 (uint64_t *)ddh, sizeof (*ddh) / sizeof (uint64_t)) == 0);
415 kmem_free(ddh, sizeof (ddt_histogram_t));
417 ddo = kmem_zalloc(sizeof (ddt_object_t), KM_SLEEP);
418 ddt_get_dedup_object_stats(spa, ddo);
419 VERIFY(nvlist_add_uint64_array(config,
420 ZPOOL_CONFIG_DDT_OBJ_STATS,
421 (uint64_t *)ddo, sizeof (*ddo) / sizeof (uint64_t)) == 0);
422 kmem_free(ddo, sizeof (ddt_object_t));
424 dds = kmem_zalloc(sizeof (ddt_stat_t), KM_SLEEP);
425 ddt_get_dedup_stats(spa, dds);
426 VERIFY(nvlist_add_uint64_array(config,
427 ZPOOL_CONFIG_DDT_STATS,
428 (uint64_t *)dds, sizeof (*dds) / sizeof (uint64_t)) == 0);
429 kmem_free(dds, sizeof (ddt_stat_t));
433 spa_config_exit(spa, SCL_CONFIG | SCL_STATE, FTAG);
439 * Update all disk labels, generate a fresh config based on the current
440 * in-core state, and sync the global config cache (do not sync the config
441 * cache if this is a booting rootpool).
444 spa_config_update(spa_t *spa, int what)
446 vdev_t *rvd = spa->spa_root_vdev;
450 ASSERT(MUTEX_HELD(&spa_namespace_lock));
452 spa_config_enter(spa, SCL_ALL, FTAG, RW_WRITER);
453 txg = spa_last_synced_txg(spa) + 1;
454 if (what == SPA_CONFIG_UPDATE_POOL) {
455 vdev_config_dirty(rvd);
458 * If we have top-level vdevs that were added but have
459 * not yet been prepared for allocation, do that now.
460 * (It's safe now because the config cache is up to date,
461 * so it will be able to translate the new DVAs.)
462 * See comments in spa_vdev_add() for full details.
464 for (c = 0; c < rvd->vdev_children; c++) {
465 vdev_t *tvd = rvd->vdev_child[c];
466 if (tvd->vdev_ms_array == 0)
467 vdev_metaslab_set_size(tvd);
468 vdev_expand(tvd, txg);
471 spa_config_exit(spa, SCL_ALL, FTAG);
474 * Wait for the mosconfig to be regenerated and synced.
476 txg_wait_synced(spa->spa_dsl_pool, txg);
479 * Update the global config cache to reflect the new mosconfig.
481 if (!spa->spa_is_root)
482 spa_config_sync(spa, B_FALSE, what != SPA_CONFIG_UPDATE_POOL);
484 if (what == SPA_CONFIG_UPDATE_POOL)
485 spa_config_update(spa, SPA_CONFIG_UPDATE_VDEVS);
488 #if defined(_KERNEL) && defined(HAVE_SPL)
489 EXPORT_SYMBOL(spa_config_sync);
490 EXPORT_SYMBOL(spa_config_load);
491 EXPORT_SYMBOL(spa_all_configs);
492 EXPORT_SYMBOL(spa_config_set);
493 EXPORT_SYMBOL(spa_config_generate);
494 EXPORT_SYMBOL(spa_config_update);
496 module_param(spa_config_path, charp, 0444);
497 MODULE_PARM_DESC(spa_config_path, "SPA config file (/etc/zfs/zpool.cache)");