2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in>
5 * Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
36 static int snapshot_proplist_update(zfs_handle_t *hdl, prop_data_t *data);
39 * Returns the name of the active boot environment
42 be_active_name(libbe_handle_t *lbh)
45 return (strrchr(lbh->rootfs, '/') + sizeof(char));
50 * Returns full path of the active boot environment
53 be_active_path(libbe_handle_t *lbh)
60 * Returns the name of the next active boot environment
63 be_nextboot_name(libbe_handle_t *lbh)
66 return (strrchr(lbh->bootfs, '/') + sizeof(char));
71 * Returns full path of the active boot environment
74 be_nextboot_path(libbe_handle_t *lbh)
82 * Returns the path of the boot environment root dataset
85 be_root_path(libbe_handle_t *lbh)
93 * Populates dsnvl with one nvlist per bootenv dataset describing the properties
94 * of that dataset that we've declared ourselves to care about.
97 be_get_bootenv_props(libbe_handle_t *lbh, nvlist_t *dsnvl)
103 data.single_object = false;
104 return (be_proplist_update(&data));
108 be_get_dataset_props(libbe_handle_t *lbh, const char *name, nvlist_t *props)
110 zfs_handle_t *snap_hdl;
116 data.single_object = true;
117 if ((snap_hdl = zfs_open(lbh->lzh, name,
118 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT)) == NULL)
119 return (BE_ERR_ZFSOPEN);
121 ret = prop_list_builder_cb(snap_hdl, &data);
127 be_get_dataset_snapshots(libbe_handle_t *lbh, const char *name, nvlist_t *props)
129 zfs_handle_t *ds_hdl;
135 data.single_object = false;
136 if ((ds_hdl = zfs_open(lbh->lzh, name,
137 ZFS_TYPE_FILESYSTEM)) == NULL)
138 return (BE_ERR_ZFSOPEN);
140 ret = snapshot_proplist_update(ds_hdl, &data);
146 * Internal callback function used by zfs_iter_filesystems. For each dataset in
147 * the bootenv root, populate an nvlist_t of its relevant properties.
150 prop_list_builder_cb(zfs_handle_t *zfs_hdl, void *data_p)
152 char buf[512], *mountpoint;
156 const char *dataset, *name;
161 * some system for defining constants for the nvlist keys
164 data = (prop_data_t *)data_p;
167 if (data->single_object)
170 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
172 dataset = zfs_get_name(zfs_hdl);
173 nvlist_add_string(props, "dataset", dataset);
175 name = strrchr(dataset, '/') + 1;
176 nvlist_add_string(props, "name", name);
178 mounted = zfs_is_mounted(zfs_hdl, &mountpoint);
181 nvlist_add_string(props, "mounted", mountpoint);
183 if (zfs_prop_get(zfs_hdl, ZFS_PROP_MOUNTPOINT, buf, 512,
184 NULL, NULL, 0, 1) == 0)
185 nvlist_add_string(props, "mountpoint", buf);
187 if (zfs_prop_get(zfs_hdl, ZFS_PROP_ORIGIN, buf, 512,
188 NULL, NULL, 0, 1) == 0)
189 nvlist_add_string(props, "origin", buf);
191 if (zfs_prop_get(zfs_hdl, ZFS_PROP_CREATION, buf, 512,
192 NULL, NULL, 0, 1) == 0)
193 nvlist_add_string(props, "creation", buf);
195 nvlist_add_boolean_value(props, "active",
196 (strcmp(be_active_path(lbh), dataset) == 0));
198 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USED, buf, 512,
199 NULL, NULL, 0, 1) == 0)
200 nvlist_add_string(props, "used", buf);
202 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USEDDS, buf, 512,
203 NULL, NULL, 0, 1) == 0)
204 nvlist_add_string(props, "usedds", buf);
206 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USEDSNAP, buf, 512,
207 NULL, NULL, 0, 1) == 0)
208 nvlist_add_string(props, "usedsnap", buf);
210 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USEDREFRESERV, buf, 512,
211 NULL, NULL, 0, 1) == 0)
212 nvlist_add_string(props, "usedrefreserv", buf);
214 if (zfs_prop_get(zfs_hdl, ZFS_PROP_REFERENCED, buf, 512,
215 NULL, NULL, 0, 1) == 0)
216 nvlist_add_string(props, "referenced", buf);
218 nvlist_add_boolean_value(props, "nextboot",
219 (strcmp(be_nextboot_path(lbh), dataset) == 0));
221 if (!data->single_object)
222 nvlist_add_nvlist(data->list, name, props);
229 * Updates the properties of each bootenv in the libbe handle
230 * XXX TODO: ensure that this is always consistent (run after adds, deletes,
234 be_proplist_update(prop_data_t *data)
236 zfs_handle_t *root_hdl;
238 if ((root_hdl = zfs_open(data->lbh->lzh, data->lbh->root,
239 ZFS_TYPE_FILESYSTEM)) == NULL)
240 return (BE_ERR_ZFSOPEN);
242 /* XXX TODO: some error checking here */
243 zfs_iter_filesystems(root_hdl, prop_list_builder_cb, data);
251 snapshot_proplist_update(zfs_handle_t *hdl, prop_data_t *data)
254 return (zfs_iter_snapshots_sorted(hdl, prop_list_builder_cb, data));
259 be_prop_list_alloc(nvlist_t **be_list)
262 return (nvlist_alloc(be_list, NV_UNIQUE_NAME, KM_SLEEP));
266 * frees property list and its children
269 be_prop_list_free(nvlist_t *be_list)
274 be_pair = nvlist_next_nvpair(be_list, NULL);
275 if (nvpair_value_nvlist(be_pair, &prop_list) == 0)
276 nvlist_free(prop_list);
278 while ((be_pair = nvlist_next_nvpair(be_list, be_pair)) != NULL) {
279 if (nvpair_value_nvlist(be_pair, &prop_list) == 0)
280 nvlist_free(prop_list);
289 be_exists(libbe_handle_t *lbh, char *be)
291 char buf[BE_MAXPATHLEN];
296 be_root_concat(lbh, be, buf);
298 if (!zfs_dataset_exists(lbh->lzh, buf, ZFS_TYPE_DATASET))
299 return (BE_ERR_NOENT);
301 /* Also check if it's mounted at / */
302 if (be_prop_list_alloc(&dsprops) != 0)
303 return (BE_ERR_UNKNOWN);
305 if (be_get_dataset_props(lbh, buf, dsprops) != 0) {
306 nvlist_free(dsprops);
307 return (BE_ERR_UNKNOWN);
310 if (nvlist_lookup_string(dsprops, "mountpoint", &mntpoint) == 0) {
311 valid = (strcmp(mntpoint, "/") == 0);
312 nvlist_free(dsprops);
313 return (valid ? BE_ERR_SUCCESS : BE_ERR_BADMOUNT);
316 nvlist_free(dsprops);
317 return (BE_ERR_BADMOUNT);