1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in> 5 * Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org> 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 #include <sys/zfs_context.h> 31 #include <libzfsbootenv.h> 32 33 #include "be.h" 34 #include "be_impl.h" 35 36 static int snapshot_proplist_update(zfs_handle_t *hdl, prop_data_t *data); 37 38 /* 39 * Returns the name of the active boot environment 40 */ 41 const char * 42 be_active_name(libbe_handle_t *lbh) 43 { 44 45 if (*lbh->rootfs != '\0') 46 return (strrchr(lbh->rootfs, '/') + sizeof(char)); 47 else 48 return (lbh->rootfs); 49 } 50 51 52 /* 53 * Returns full path of the active boot environment 54 */ 55 const char * 56 be_active_path(libbe_handle_t *lbh) 57 { 58 59 return (lbh->rootfs); 60 } 61 62 /* 63 * Returns the name of the next active boot environment 64 */ 65 const char * 66 be_nextboot_name(libbe_handle_t *lbh) 67 { 68 69 if (*lbh->bootfs != '\0') 70 return (strrchr(lbh->bootfs, '/') + sizeof(char)); 71 else 72 return (lbh->bootfs); 73 } 74 75 76 /* 77 * Returns full path of the active boot environment 78 */ 79 const char * 80 be_nextboot_path(libbe_handle_t *lbh) 81 { 82 83 return (lbh->bootfs); 84 } 85 86 87 /* 88 * Returns the path of the boot environment root dataset 89 */ 90 const char * 91 be_root_path(libbe_handle_t *lbh) 92 { 93 94 return (lbh->root); 95 } 96 97 98 /* 99 * Populates dsnvl with one nvlist per bootenv dataset describing the properties 100 * of that dataset that we've declared ourselves to care about. 101 */ 102 int 103 be_get_bootenv_props(libbe_handle_t *lbh, nvlist_t *dsnvl) 104 { 105 prop_data_t data; 106 107 data.lbh = lbh; 108 data.list = dsnvl; 109 data.single_object = false; 110 data.bootonce = NULL; 111 return (be_proplist_update(&data)); 112 } 113 114 int 115 be_get_dataset_props(libbe_handle_t *lbh, const char *name, nvlist_t *props) 116 { 117 zfs_handle_t *snap_hdl; 118 prop_data_t data; 119 int ret; 120 121 data.lbh = lbh; 122 data.list = props; 123 data.single_object = true; 124 data.bootonce = NULL; 125 if ((snap_hdl = zfs_open(lbh->lzh, name, 126 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_SNAPSHOT)) == NULL) 127 return (BE_ERR_ZFSOPEN); 128 129 ret = prop_list_builder_cb(snap_hdl, &data); 130 zfs_close(snap_hdl); 131 return (ret); 132 } 133 134 int 135 be_get_dataset_snapshots(libbe_handle_t *lbh, const char *name, nvlist_t *props) 136 { 137 zfs_handle_t *ds_hdl; 138 prop_data_t data; 139 int ret; 140 141 data.lbh = lbh; 142 data.list = props; 143 data.single_object = false; 144 data.bootonce = NULL; 145 if ((ds_hdl = zfs_open(lbh->lzh, name, 146 ZFS_TYPE_FILESYSTEM)) == NULL) 147 return (BE_ERR_ZFSOPEN); 148 149 ret = snapshot_proplist_update(ds_hdl, &data); 150 zfs_close(ds_hdl); 151 return (ret); 152 } 153 154 /* 155 * Internal callback function used by zfs_iter_filesystems. For each dataset in 156 * the bootenv root, populate an nvlist_t of its relevant properties. 157 */ 158 int 159 prop_list_builder_cb(zfs_handle_t *zfs_hdl, void *data_p) 160 { 161 char buf[512], *mountpoint; 162 prop_data_t *data; 163 libbe_handle_t *lbh; 164 nvlist_t *props; 165 const char *dataset, *name; 166 boolean_t mounted; 167 168 /* 169 * XXX TODO: 170 * some system for defining constants for the nvlist keys 171 * error checking 172 */ 173 data = (prop_data_t *)data_p; 174 lbh = data->lbh; 175 176 if (data->single_object) 177 props = data->list; 178 else 179 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP); 180 181 dataset = zfs_get_name(zfs_hdl); 182 nvlist_add_string(props, "dataset", dataset); 183 184 if (data->bootonce != NULL && 185 strcmp(dataset, data->bootonce) == 0) 186 nvlist_add_boolean_value(props, "bootonce", true); 187 188 name = strrchr(dataset, '/') + 1; 189 nvlist_add_string(props, "name", name); 190 191 mounted = zfs_is_mounted(zfs_hdl, &mountpoint); 192 193 if (mounted) 194 nvlist_add_string(props, "mounted", mountpoint); 195 196 if (zfs_prop_get(zfs_hdl, ZFS_PROP_MOUNTPOINT, buf, 512, 197 NULL, NULL, 0, 1) == 0) 198 nvlist_add_string(props, "mountpoint", buf); 199 200 if (zfs_prop_get(zfs_hdl, ZFS_PROP_ORIGIN, buf, 512, 201 NULL, NULL, 0, 1) == 0) 202 nvlist_add_string(props, "origin", buf); 203 204 if (zfs_prop_get(zfs_hdl, ZFS_PROP_CREATION, buf, 512, 205 NULL, NULL, 0, 1) == 0) 206 nvlist_add_string(props, "creation", buf); 207 208 nvlist_add_boolean_value(props, "active", 209 (strcmp(be_active_path(lbh), dataset) == 0)); 210 211 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USED, buf, 512, 212 NULL, NULL, 0, 1) == 0) 213 nvlist_add_string(props, "used", buf); 214 215 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USEDDS, buf, 512, 216 NULL, NULL, 0, 1) == 0) 217 nvlist_add_string(props, "usedds", buf); 218 219 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USEDSNAP, buf, 512, 220 NULL, NULL, 0, 1) == 0) 221 nvlist_add_string(props, "usedsnap", buf); 222 223 if (zfs_prop_get(zfs_hdl, ZFS_PROP_USEDREFRESERV, buf, 512, 224 NULL, NULL, 0, 1) == 0) 225 nvlist_add_string(props, "usedrefreserv", buf); 226 227 if (zfs_prop_get(zfs_hdl, ZFS_PROP_REFERENCED, buf, 512, 228 NULL, NULL, 0, 1) == 0) 229 nvlist_add_string(props, "referenced", buf); 230 231 nvlist_add_boolean_value(props, "nextboot", 232 (strcmp(be_nextboot_path(lbh), dataset) == 0)); 233 234 if (!data->single_object) 235 nvlist_add_nvlist(data->list, name, props); 236 237 return (0); 238 } 239 240 241 /* 242 * Updates the properties of each bootenv in the libbe handle 243 * XXX TODO: ensure that this is always consistent (run after adds, deletes, 244 * renames,etc 245 */ 246 int 247 be_proplist_update(prop_data_t *data) 248 { 249 zfs_handle_t *root_hdl; 250 251 if ((root_hdl = zfs_open(data->lbh->lzh, data->lbh->root, 252 ZFS_TYPE_FILESYSTEM)) == NULL) 253 return (BE_ERR_ZFSOPEN); 254 255 (void) lzbe_get_boot_device(zpool_get_name(data->lbh->active_phandle), 256 &data->bootonce); 257 258 /* XXX TODO: some error checking here */ 259 zfs_iter_filesystems(root_hdl, prop_list_builder_cb, data); 260 261 zfs_close(root_hdl); 262 263 return (0); 264 } 265 266 static int 267 snapshot_proplist_update(zfs_handle_t *hdl, prop_data_t *data) 268 { 269 270 return (zfs_iter_snapshots_sorted(hdl, prop_list_builder_cb, data, 271 0, 0)); 272 } 273 274 275 int 276 be_prop_list_alloc(nvlist_t **be_list) 277 { 278 279 return (nvlist_alloc(be_list, NV_UNIQUE_NAME, KM_SLEEP)); 280 } 281 282 /* 283 * frees property list and its children 284 */ 285 void 286 be_prop_list_free(nvlist_t *be_list) 287 { 288 nvlist_t *prop_list; 289 nvpair_t *be_pair; 290 291 be_pair = nvlist_next_nvpair(be_list, NULL); 292 if (nvpair_value_nvlist(be_pair, &prop_list) == 0) 293 nvlist_free(prop_list); 294 295 while ((be_pair = nvlist_next_nvpair(be_list, be_pair)) != NULL) { 296 if (nvpair_value_nvlist(be_pair, &prop_list) == 0) 297 nvlist_free(prop_list); 298 } 299 } 300 301 302 /* 303 * Usage 304 */ 305 int 306 be_exists(libbe_handle_t *lbh, const char *be) 307 { 308 char buf[BE_MAXPATHLEN]; 309 310 be_root_concat(lbh, be, buf); 311 312 if (!zfs_dataset_exists(lbh->lzh, buf, ZFS_TYPE_DATASET)) 313 return (BE_ERR_NOENT); 314 315 return (BE_ERR_SUCCESS); 316 } 317