2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/mount.h>
35 #include <sys/ucred.h>
39 #include <libzfs_core.h>
48 struct be_destroy_data {
54 static int be_create_child_noent(libbe_handle_t *lbh, const char *active,
55 const char *child_path);
56 static int be_create_child_cloned(libbe_handle_t *lbh, const char *active);
59 /* Arbitrary... should tune */
60 #define BE_SNAP_SERIAL_MAX 1024
63 * Iterator function for locating the rootfs amongst the children of the
64 * zfs_be_root set by loader(8). data is expected to be a libbe_handle_t *.
67 be_locate_rootfs(libbe_handle_t *lbh)
70 struct extmnttab entry;
74 * Check first if root is ZFS; if not, we'll bail on rootfs capture.
75 * Unfortunately needed because zfs_path_to_zhandle will emit to
76 * stderr if / isn't actually a ZFS filesystem, which we'd like
79 if (statfs("/", &sfs) == 0) {
80 statfs2mnttab(&sfs, &entry);
81 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
85 zfs = zfs_path_to_zhandle(lbh->lzh, "/", ZFS_TYPE_FILESYSTEM);
89 strlcpy(lbh->rootfs, zfs_get_name(zfs), sizeof(lbh->rootfs));
95 * Initializes the libbe context to operate in the root boot environment
96 * dataset, for example, zroot/ROOT.
99 libbe_init(const char *root)
101 char altroot[MAXPATHLEN];
103 char *poolname, *pos;
107 poolname = pos = NULL;
109 if ((lbh = calloc(1, sizeof(libbe_handle_t))) == NULL)
112 if ((lbh->lzh = libzfs_init()) == NULL)
116 * Grab rootfs, we'll work backwards from there if an optional BE root
117 * has not been passed in.
119 if (be_locate_rootfs(lbh) != 0) {
125 /* Strip off the final slash from rootfs to get the be root */
126 strlcpy(lbh->root, lbh->rootfs, sizeof(lbh->root));
127 pos = strrchr(lbh->root, '/');
132 strlcpy(lbh->root, root, sizeof(lbh->root));
134 if ((pos = strchr(lbh->root, '/')) == NULL)
137 pnamelen = pos - lbh->root;
138 poolname = malloc(pnamelen + 1);
139 if (poolname == NULL)
142 strlcpy(poolname, lbh->root, pnamelen + 1);
143 if ((lbh->active_phandle = zpool_open(lbh->lzh, poolname)) == NULL)
148 if (zpool_get_prop(lbh->active_phandle, ZPOOL_PROP_BOOTFS, lbh->bootfs,
149 sizeof(lbh->bootfs), NULL, true) != 0)
152 if (zpool_get_prop(lbh->active_phandle, ZPOOL_PROP_ALTROOT,
153 altroot, sizeof(altroot), NULL, true) == 0 &&
154 strcmp(altroot, "-") != 0)
155 lbh->altroot_len = strlen(altroot);
160 if (lbh->active_phandle != NULL)
161 zpool_close(lbh->active_phandle);
162 if (lbh->lzh != NULL)
163 libzfs_fini(lbh->lzh);
172 * Free memory allocated by libbe_init()
175 libbe_close(libbe_handle_t *lbh)
178 if (lbh->active_phandle != NULL)
179 zpool_close(lbh->active_phandle);
180 libzfs_fini(lbh->lzh);
185 * Proxy through to libzfs for the moment.
188 be_nicenum(uint64_t num, char *buf, size_t buflen)
191 zfs_nicenum(num, buf, buflen);
195 be_destroy_cb(zfs_handle_t *zfs_hdl, void *data)
197 char path[BE_MAXPATHLEN];
198 struct be_destroy_data *bdd;
202 bdd = (struct be_destroy_data *)data;
203 if (bdd->snapname == NULL) {
204 err = zfs_iter_children(zfs_hdl, be_destroy_cb, data);
207 return (zfs_destroy(zfs_hdl, false));
209 /* If we're dealing with snapshots instead, delete that one alone */
210 err = zfs_iter_filesystems(zfs_hdl, be_destroy_cb, data);
214 * This part is intentionally glossing over any potential errors,
215 * because there's a lot less potential for errors when we're cleaning
216 * up snapshots rather than a full deep BE. The primary error case
217 * here being if the snapshot doesn't exist in the first place, which
218 * the caller will likely deem insignificant as long as it doesn't
219 * exist after the call. Thus, such a missing snapshot shouldn't jam
220 * up the destruction.
222 snprintf(path, sizeof(path), "%s@%s", zfs_get_name(zfs_hdl),
224 if (!zfs_dataset_exists(bdd->lbh->lzh, path, ZFS_TYPE_SNAPSHOT))
226 snap = zfs_open(bdd->lbh->lzh, path, ZFS_TYPE_SNAPSHOT);
228 zfs_destroy(snap, false);
232 #define BE_DESTROY_WANTORIGIN (BE_DESTROY_ORIGIN | BE_DESTROY_AUTOORIGIN)
234 * Destroy the boot environment or snapshot specified by the name
235 * parameter. Options are or'd together with the possible values:
236 * BE_DESTROY_FORCE : forces operation on mounted datasets
237 * BE_DESTROY_ORIGIN: destroy the origin snapshot as well
240 be_destroy(libbe_handle_t *lbh, const char *name, int options)
242 struct be_destroy_data bdd;
243 char origin[BE_MAXPATHLEN], path[BE_MAXPATHLEN];
246 int err, force, mounted;
251 force = options & BE_DESTROY_FORCE;
254 be_root_concat(lbh, name, path);
256 if ((snapdelim = strchr(path, '@')) == NULL) {
257 if (!zfs_dataset_exists(lbh->lzh, path, ZFS_TYPE_FILESYSTEM))
258 return (set_error(lbh, BE_ERR_NOENT));
260 if (strcmp(path, lbh->rootfs) == 0 ||
261 strcmp(path, lbh->bootfs) == 0)
262 return (set_error(lbh, BE_ERR_DESTROYACT));
264 fs = zfs_open(lbh->lzh, path, ZFS_TYPE_FILESYSTEM);
266 return (set_error(lbh, BE_ERR_ZFSOPEN));
268 if ((options & BE_DESTROY_WANTORIGIN) != 0 &&
269 zfs_prop_get(fs, ZFS_PROP_ORIGIN, origin, sizeof(origin),
270 NULL, NULL, 0, 1) != 0 &&
271 (options & BE_DESTROY_ORIGIN) != 0)
272 return (set_error(lbh, BE_ERR_NOORIGIN));
275 * If the caller wants auto-origin destruction and the origin
276 * name matches one of our automatically created snapshot names
277 * (i.e. strftime("%F-%T") with a serial at the end), then
278 * we'll set the DESTROY_ORIGIN flag and nuke it
279 * be_is_auto_snapshot_name is exported from libbe(3) so that
280 * the caller can determine if it needs to warn about the origin
281 * not being destroyed or not.
283 if ((options & BE_DESTROY_AUTOORIGIN) != 0 && *origin != '\0' &&
284 be_is_auto_snapshot_name(lbh, origin))
285 options |= BE_DESTROY_ORIGIN;
287 /* Don't destroy a mounted dataset unless force is specified */
288 if ((mounted = zfs_is_mounted(fs, NULL)) != 0) {
290 zfs_unmount(fs, NULL, 0);
293 return (set_error(lbh, BE_ERR_DESTROYMNT));
297 if (!zfs_dataset_exists(lbh->lzh, path, ZFS_TYPE_SNAPSHOT))
298 return (set_error(lbh, BE_ERR_NOENT));
300 bdd.snapname = strdup(snapdelim + 1);
301 if (bdd.snapname == NULL)
302 return (set_error(lbh, BE_ERR_NOMEM));
304 fs = zfs_open(lbh->lzh, path, ZFS_TYPE_DATASET);
307 return (set_error(lbh, BE_ERR_ZFSOPEN));
311 err = be_destroy_cb(fs, &bdd);
315 /* Children are still present or the mount is referenced */
317 return (set_error(lbh, BE_ERR_DESTROYMNT));
318 return (set_error(lbh, BE_ERR_UNKNOWN));
321 if ((options & BE_DESTROY_ORIGIN) == 0)
324 /* The origin can't possibly be shorter than the BE root */
325 rootlen = strlen(lbh->root);
326 if (*origin == '\0' || strlen(origin) <= rootlen + 1)
327 return (set_error(lbh, BE_ERR_INVORIGIN));
330 * We'll be chopping off the BE root and running this back through
331 * be_destroy, so that we properly handle the origin snapshot whether
332 * it be that of a deep BE or not.
334 if (strncmp(origin, lbh->root, rootlen) != 0 || origin[rootlen] != '/')
337 return (be_destroy(lbh, origin + rootlen + 1,
338 options & ~BE_DESTROY_ORIGIN));
342 be_setup_snapshot_name(libbe_handle_t *lbh, char *buf, size_t buflen)
349 len += strftime(buf + len, buflen - len, "@%F-%T", localtime(&rawtime));
350 /* No room for serial... caller will do its best */
351 if (buflen - len < 2)
354 for (serial = 0; serial < BE_SNAP_SERIAL_MAX; ++serial) {
355 snprintf(buf + len, buflen - len, "-%d", serial);
356 if (!zfs_dataset_exists(lbh->lzh, buf, ZFS_TYPE_SNAPSHOT))
362 be_is_auto_snapshot_name(libbe_handle_t *lbh, const char *name)
365 int day, hour, minute, month, second, serial, year;
367 if ((snap = strchr(name, '@')) == NULL)
370 /* We'll grab the individual components and do some light validation. */
371 if (sscanf(snap, "%d-%d-%d-%d:%d:%d-%d", &year, &month, &day, &hour,
372 &minute, &second, &serial) != 7)
374 return (year >= 1970) && (month >= 1 && month <= 12) &&
375 (day >= 1 && day <= 31) && (hour >= 0 && hour <= 23) &&
376 (minute >= 0 && minute <= 59) && (second >= 0 && second <= 60) &&
381 be_snapshot(libbe_handle_t *lbh, const char *source, const char *snap_name,
382 bool recursive, char *result)
384 char buf[BE_MAXPATHLEN];
387 be_root_concat(lbh, source, buf);
389 if ((err = be_exists(lbh, buf)) != 0)
390 return (set_error(lbh, err));
392 if (snap_name != NULL) {
393 if (strlcat(buf, "@", sizeof(buf)) >= sizeof(buf))
394 return (set_error(lbh, BE_ERR_INVALIDNAME));
396 if (strlcat(buf, snap_name, sizeof(buf)) >= sizeof(buf))
397 return (set_error(lbh, BE_ERR_INVALIDNAME));
400 snprintf(result, BE_MAXPATHLEN, "%s@%s", source,
403 be_setup_snapshot_name(lbh, buf, sizeof(buf));
405 if (result != NULL && strlcpy(result, strrchr(buf, '/') + 1,
406 sizeof(buf)) >= sizeof(buf))
407 return (set_error(lbh, BE_ERR_INVALIDNAME));
409 if ((err = zfs_snapshot(lbh->lzh, buf, recursive, NULL)) != 0) {
411 case EZFS_INVALIDNAME:
412 return (set_error(lbh, BE_ERR_INVALIDNAME));
416 * The other errors that zfs_ioc_snapshot might return
417 * shouldn't happen if we've set things up properly, so
418 * we'll gloss over them and call it UNKNOWN as it will
419 * require further triage.
421 if (errno == ENOTSUP)
422 return (set_error(lbh, BE_ERR_NOPOOL));
423 return (set_error(lbh, BE_ERR_UNKNOWN));
427 return (BE_ERR_SUCCESS);
432 * Create the boot environment specified by the name parameter
435 be_create(libbe_handle_t *lbh, const char *name)
439 err = be_create_from_existing(lbh, name, be_active_path(lbh));
441 return (set_error(lbh, err));
445 be_deep_clone_prop(int prop, void *cb)
448 struct libbe_dccb *dccb;
450 char pval[BE_MAXPATHLEN];
451 char source[BE_MAXPATHLEN];
455 /* Skip some properties we don't want to touch */
456 if (prop == ZFS_PROP_CANMOUNT)
459 /* Don't copy readonly properties */
460 if (zfs_prop_readonly(prop))
463 if ((err = zfs_prop_get(dccb->zhp, prop, (char *)&pval,
464 sizeof(pval), &src, (char *)&source, sizeof(source), false)))
465 /* Just continue if we fail to read a property */
469 * Only copy locally defined or received properties. This continues
470 * to avoid temporary/default/local properties intentionally without
471 * breaking received datasets.
473 if (src != ZPROP_SRC_LOCAL && src != ZPROP_SRC_RECEIVED)
476 /* Augment mountpoint with altroot, if needed */
478 if (prop == ZFS_PROP_MOUNTPOINT)
479 val = be_mountpoint_augmented(dccb->lbh, val);
481 nvlist_add_string(dccb->props, zfs_prop_to_name(prop), val);
487 * Return the corresponding boot environment path for a given
488 * dataset path, the constructed path is placed in 'result'.
490 * example: say our new boot environment name is 'bootenv' and
491 * the dataset path is 'zroot/ROOT/default/data/set'.
493 * result should produce: 'zroot/ROOT/bootenv/data/set'
496 be_get_path(struct libbe_deep_clone *ldc, const char *dspath, char *result, int result_size)
501 /* match the root path for the boot environments */
502 pos = strstr(dspath, ldc->lbh->root);
504 /* no match, different pools? */
506 return (BE_ERR_BADPATH);
508 /* root path of the new boot environment */
509 snprintf(result, result_size, "%s/%s", ldc->lbh->root, ldc->bename);
511 /* gets us to the parent dataset, the +1 consumes a trailing slash */
512 pos += strlen(ldc->lbh->root) + 1;
514 /* skip the parent dataset */
515 if ((child_dataset = strchr(pos, '/')) != NULL)
516 strlcat(result, child_dataset, result_size);
518 return (BE_ERR_SUCCESS);
522 be_clone_cb(zfs_handle_t *ds, void *data)
525 char be_path[BE_MAXPATHLEN];
526 char snap_path[BE_MAXPATHLEN];
528 zfs_handle_t *snap_hdl;
530 struct libbe_deep_clone *ldc;
531 struct libbe_dccb dccb;
533 ldc = (struct libbe_deep_clone *)data;
534 dspath = zfs_get_name(ds);
536 snprintf(snap_path, sizeof(snap_path), "%s@%s", dspath, ldc->snapname);
538 /* construct the boot environment path from the dataset we're cloning */
539 if (be_get_path(ldc, dspath, be_path, sizeof(be_path)) != BE_ERR_SUCCESS)
540 return (set_error(ldc->lbh, BE_ERR_UNKNOWN));
542 /* the dataset to be created (i.e. the boot environment) already exists */
543 if (zfs_dataset_exists(ldc->lbh->lzh, be_path, ZFS_TYPE_DATASET))
544 return (set_error(ldc->lbh, BE_ERR_EXISTS));
546 /* no snapshot found for this dataset, silently skip it */
547 if (!zfs_dataset_exists(ldc->lbh->lzh, snap_path, ZFS_TYPE_SNAPSHOT))
551 zfs_open(ldc->lbh->lzh, snap_path, ZFS_TYPE_SNAPSHOT)) == NULL)
552 return (set_error(ldc->lbh, BE_ERR_ZFSOPEN));
554 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
555 nvlist_add_string(props, "canmount", "noauto");
560 if (zprop_iter(be_deep_clone_prop, &dccb, B_FALSE, B_FALSE,
561 ZFS_TYPE_FILESYSTEM) == ZPROP_INVAL)
564 if ((err = zfs_clone(snap_hdl, be_path, props)) != 0)
565 return (set_error(ldc->lbh, BE_ERR_ZFSCLONE));
570 if (ldc->depth_limit == -1 || ldc->depth < ldc->depth_limit) {
572 err = zfs_iter_filesystems(ds, be_clone_cb, ldc);
576 return (set_error(ldc->lbh, err));
580 * Create a boot environment with a given name from a given snapshot.
581 * Snapshots can be in the format 'zroot/ROOT/default@snapshot' or
582 * 'default@snapshot'. In the latter case, 'default@snapshot' will be prepended
583 * with the root path that libbe was initailized with.
586 be_clone(libbe_handle_t *lbh, const char *bename, const char *snapshot, int depth)
589 char snap_path[BE_MAXPATHLEN];
590 char *parentname, *snapname;
591 zfs_handle_t *parent_hdl;
592 struct libbe_deep_clone ldc;
594 /* ensure the boot environment name is valid */
595 if ((err = be_validate_name(lbh, bename)) != 0)
596 return (set_error(lbh, err));
599 * prepend the boot environment root path if we're
600 * given a partial snapshot name.
602 if ((err = be_root_concat(lbh, snapshot, snap_path)) != 0)
603 return (set_error(lbh, err));
605 /* ensure the snapshot exists */
606 if ((err = be_validate_snap(lbh, snap_path)) != 0)
607 return (set_error(lbh, err));
609 /* get a copy of the snapshot path so we can disect it */
610 if ((parentname = strdup(snap_path)) == NULL)
611 return (set_error(lbh, BE_ERR_UNKNOWN));
613 /* split dataset name from snapshot name */
614 snapname = strchr(parentname, '@');
615 if (snapname == NULL) {
617 return (set_error(lbh, BE_ERR_UNKNOWN));
622 /* set-up the boot environment */
625 ldc.snapname = snapname;
627 ldc.depth_limit = depth;
629 /* the boot environment will be cloned from this dataset */
630 parent_hdl = zfs_open(lbh->lzh, parentname, ZFS_TYPE_DATASET);
632 /* create the boot environment */
633 err = be_clone_cb(parent_hdl, &ldc);
636 return (set_error(lbh, err));
640 * Create a boot environment from pre-existing snapshot, specifying a depth.
642 int be_create_depth(libbe_handle_t *lbh, const char *bename,
643 const char *snap, int depth)
645 return (be_clone(lbh, bename, snap, depth));
649 * Create the boot environment from pre-existing snapshot
652 be_create_from_existing_snap(libbe_handle_t *lbh, const char *bename,
655 return (be_clone(lbh, bename, snap, -1));
660 * Create a boot environment from an existing boot environment
663 be_create_from_existing(libbe_handle_t *lbh, const char *bename, const char *old)
666 char snap[BE_MAXPATHLEN];
668 if ((err = be_snapshot(lbh, old, NULL, true, snap)) != 0)
669 return (set_error(lbh, err));
671 err = be_clone(lbh, bename, snap, -1);
673 return (set_error(lbh, err));
678 * Verifies that a snapshot has a valid name, exists, and has a mountpoint of
679 * '/'. Returns BE_ERR_SUCCESS (0), upon success, or the relevant BE_ERR_* upon
680 * failure. Does not set the internal library error state.
683 be_validate_snap(libbe_handle_t *lbh, const char *snap_name)
686 if (strlen(snap_name) >= BE_MAXPATHLEN)
687 return (BE_ERR_PATHLEN);
689 if (!zfs_name_valid(snap_name, ZFS_TYPE_SNAPSHOT))
690 return (BE_ERR_INVALIDNAME);
692 if (!zfs_dataset_exists(lbh->lzh, snap_name,
694 return (BE_ERR_NOENT);
696 return (BE_ERR_SUCCESS);
701 * Idempotently appends the name argument to the root boot environment path
702 * and copies the resulting string into the result buffer (which is assumed
703 * to be at least BE_MAXPATHLEN characters long. Returns BE_ERR_SUCCESS upon
704 * success, BE_ERR_PATHLEN if the resulting path is longer than BE_MAXPATHLEN,
705 * or BE_ERR_INVALIDNAME if the name is a path that does not begin with
706 * zfs_be_root. Does not set internal library error state.
709 be_root_concat(libbe_handle_t *lbh, const char *name, char *result)
711 size_t name_len, root_len;
713 name_len = strlen(name);
714 root_len = strlen(lbh->root);
716 /* Act idempotently; return be name if it is already a full path */
717 if (strrchr(name, '/') != NULL) {
718 if (strstr(name, lbh->root) != name)
719 return (BE_ERR_INVALIDNAME);
721 if (name_len >= BE_MAXPATHLEN)
722 return (BE_ERR_PATHLEN);
724 strlcpy(result, name, BE_MAXPATHLEN);
725 return (BE_ERR_SUCCESS);
726 } else if (name_len + root_len + 1 < BE_MAXPATHLEN) {
727 snprintf(result, BE_MAXPATHLEN, "%s/%s", lbh->root,
729 return (BE_ERR_SUCCESS);
732 return (BE_ERR_PATHLEN);
737 * Verifies the validity of a boot environment name (A-Za-z0-9-_.). Returns
738 * BE_ERR_SUCCESS (0) if name is valid, otherwise returns BE_ERR_INVALIDNAME
740 * Does not set internal library error state.
743 be_validate_name(libbe_handle_t *lbh, const char *name)
747 * Impose the additional restriction that the entire dataset name must
748 * not exceed the maximum length of a dataset, i.e. MAXNAMELEN.
750 if (strlen(lbh->root) + 1 + strlen(name) > MAXNAMELEN)
751 return (BE_ERR_PATHLEN);
753 if (!zfs_name_valid(name, ZFS_TYPE_DATASET))
754 return (BE_ERR_INVALIDNAME);
756 return (BE_ERR_SUCCESS);
764 be_rename(libbe_handle_t *lbh, const char *old, const char *new)
766 char full_old[BE_MAXPATHLEN];
767 char full_new[BE_MAXPATHLEN];
768 zfs_handle_t *zfs_hdl;
772 * be_validate_name is documented not to set error state, so we should
775 if ((err = be_validate_name(lbh, new)) != 0)
776 return (set_error(lbh, err));
777 if ((err = be_root_concat(lbh, old, full_old)) != 0)
778 return (set_error(lbh, err));
779 if ((err = be_root_concat(lbh, new, full_new)) != 0)
780 return (set_error(lbh, err));
782 if (!zfs_dataset_exists(lbh->lzh, full_old, ZFS_TYPE_DATASET))
783 return (set_error(lbh, BE_ERR_NOENT));
785 if (zfs_dataset_exists(lbh->lzh, full_new, ZFS_TYPE_DATASET))
786 return (set_error(lbh, BE_ERR_EXISTS));
788 if ((zfs_hdl = zfs_open(lbh->lzh, full_old,
789 ZFS_TYPE_FILESYSTEM)) == NULL)
790 return (set_error(lbh, BE_ERR_ZFSOPEN));
792 /* recurse, nounmount, forceunmount */
793 struct renameflags flags = {
797 err = zfs_rename(zfs_hdl, NULL, full_new, flags);
801 return (set_error(lbh, BE_ERR_UNKNOWN));
807 be_export(libbe_handle_t *lbh, const char *bootenv, int fd)
809 char snap_name[BE_MAXPATHLEN];
810 char buf[BE_MAXPATHLEN];
812 sendflags_t flags = { 0 };
815 if ((err = be_snapshot(lbh, bootenv, NULL, true, snap_name)) != 0)
816 /* Use the error set by be_snapshot */
819 be_root_concat(lbh, snap_name, buf);
821 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_DATASET)) == NULL)
822 return (set_error(lbh, BE_ERR_ZFSOPEN));
824 err = zfs_send_one(zfs, NULL, fd, flags);
832 be_import(libbe_handle_t *lbh, const char *bootenv, int fd)
834 char buf[BE_MAXPATHLEN];
837 recvflags_t flags = { .nomount = 1 };
840 be_root_concat(lbh, bootenv, buf);
842 if ((err = zfs_receive(lbh->lzh, buf, NULL, &flags, fd, NULL)) != 0) {
845 return (set_error(lbh, BE_ERR_NOORIGIN));
847 return (set_error(lbh, BE_ERR_NOENT));
849 return (set_error(lbh, BE_ERR_IO));
851 return (set_error(lbh, BE_ERR_UNKNOWN));
855 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_FILESYSTEM)) == NULL)
856 return (set_error(lbh, BE_ERR_ZFSOPEN));
858 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
859 nvlist_add_string(props, "canmount", "noauto");
860 nvlist_add_string(props, "mountpoint", "none");
862 err = zfs_prop_set_list(zfs, props);
868 return (set_error(lbh, BE_ERR_UNKNOWN));
875 be_create_child_noent(libbe_handle_t *lbh, const char *active,
876 const char *child_path)
882 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
883 nvlist_add_string(props, "canmount", "noauto");
884 nvlist_add_string(props, "mountpoint", child_path);
887 if ((err = zfs_create(lbh->lzh, active, ZFS_TYPE_DATASET,
891 return (set_error(lbh, BE_ERR_EXISTS));
893 return (set_error(lbh, BE_ERR_NOENT));
895 case EZFS_BADVERSION:
896 return (set_error(lbh, BE_ERR_NOPOOL));
899 /* We set something up wrong, probably... */
900 return (set_error(lbh, BE_ERR_UNKNOWN));
905 if ((zfs = zfs_open(lbh->lzh, active, ZFS_TYPE_DATASET)) == NULL)
906 return (set_error(lbh, BE_ERR_ZFSOPEN));
909 if ((err = zfs_prop_set(zfs, "canmount", "noauto")) != 0) {
912 * Similar to other cases, this shouldn't fail unless we've
913 * done something wrong. This is a new dataset that shouldn't
914 * have been mounted anywhere between creation and now.
916 if (err == EZFS_NOMEM)
917 return (set_error(lbh, BE_ERR_NOMEM));
918 return (set_error(lbh, BE_ERR_UNKNOWN));
921 return (BE_ERR_SUCCESS);
925 be_create_child_cloned(libbe_handle_t *lbh, const char *active)
927 char buf[BE_MAXPATHLEN], tmp[BE_MAXPATHLEN];;
934 * Establish if the existing path is a zfs dataset or just
935 * the subdirectory of one
937 strlcpy(tmp, "tmp/be_snap.XXXXX", sizeof(tmp));
938 if (mktemp(tmp) == NULL)
939 return (set_error(lbh, BE_ERR_UNKNOWN));
941 be_root_concat(lbh, tmp, buf);
942 printf("Here %s?\n", buf);
943 if ((err = zfs_snapshot(lbh->lzh, buf, false, NULL)) != 0) {
945 case EZFS_INVALIDNAME:
946 return (set_error(lbh, BE_ERR_INVALIDNAME));
950 * The other errors that zfs_ioc_snapshot might return
951 * shouldn't happen if we've set things up properly, so
952 * we'll gloss over them and call it UNKNOWN as it will
953 * require further triage.
955 if (errno == ENOTSUP)
956 return (set_error(lbh, BE_ERR_NOPOOL));
957 return (set_error(lbh, BE_ERR_UNKNOWN));
962 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_SNAPSHOT)) == NULL)
963 return (BE_ERR_ZFSOPEN);
965 if ((err = zfs_clone(zfs, active, NULL)) != 0)
966 /* XXX TODO correct error */
967 return (set_error(lbh, BE_ERR_UNKNOWN));
971 return (BE_ERR_SUCCESS);
975 be_add_child(libbe_handle_t *lbh, const char *child_path, bool cp_if_exists)
978 char active[BE_MAXPATHLEN], buf[BE_MAXPATHLEN];
982 /* Require absolute paths */
983 if (*child_path != '/')
984 return (set_error(lbh, BE_ERR_BADPATH));
986 strlcpy(active, be_active_path(lbh), BE_MAXPATHLEN);
989 /* Create non-mountable parent dataset(s) */
991 for (char *p; (p = strchr(s+1, '/')) != NULL; s = p) {
993 strncat(buf, s, len);
995 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
996 nvlist_add_string(props, "canmount", "off");
997 nvlist_add_string(props, "mountpoint", "none");
998 zfs_create(lbh->lzh, buf, ZFS_TYPE_DATASET, props);
1002 /* Path does not exist as a descendent of / yet */
1003 if (strlcat(active, child_path, BE_MAXPATHLEN) >= BE_MAXPATHLEN)
1004 return (set_error(lbh, BE_ERR_PATHLEN));
1006 if (stat(child_path, &sb) != 0) {
1007 /* Verify that error is ENOENT */
1008 if (errno != ENOENT)
1009 return (set_error(lbh, BE_ERR_UNKNOWN));
1010 return (be_create_child_noent(lbh, active, child_path));
1011 } else if (cp_if_exists)
1012 /* Path is already a descendent of / and should be copied */
1013 return (be_create_child_cloned(lbh, active));
1014 return (set_error(lbh, BE_ERR_EXISTS));
1019 be_set_nextboot(libbe_handle_t *lbh, nvlist_t *config, uint64_t pool_guid,
1026 if (nvlist_lookup_nvlist_array(config, ZPOOL_CONFIG_CHILDREN, &child,
1028 for (c = 0; c < children; ++c)
1029 if (be_set_nextboot(lbh, child[c], pool_guid, zfsdev) != 0)
1034 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
1039 if (zpool_nextboot(lbh->lzh, pool_guid, vdev_guid, zfsdev) != 0) {
1040 perror("ZFS_IOC_NEXTBOOT failed");
1048 * Deactivate old BE dataset; currently just sets canmount=noauto
1051 be_deactivate(libbe_handle_t *lbh, const char *ds)
1055 if ((zfs = zfs_open(lbh->lzh, ds, ZFS_TYPE_DATASET)) == NULL)
1057 if (zfs_prop_set(zfs, "canmount", "noauto") != 0)
1064 be_activate(libbe_handle_t *lbh, const char *bootenv, bool temporary)
1066 char be_path[BE_MAXPATHLEN];
1067 char buf[BE_MAXPATHLEN];
1068 nvlist_t *config, *dsprops, *vdevs;
1074 be_root_concat(lbh, bootenv, be_path);
1076 /* Note: be_exists fails if mountpoint is not / */
1077 if ((err = be_exists(lbh, be_path)) != 0)
1078 return (set_error(lbh, err));
1081 config = zpool_get_config(lbh->active_phandle, NULL);
1083 /* config should be fetchable... */
1084 return (set_error(lbh, BE_ERR_UNKNOWN));
1086 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1088 /* Similarly, it shouldn't be possible */
1089 return (set_error(lbh, BE_ERR_UNKNOWN));
1091 /* Expected format according to zfsbootcfg(8) man */
1092 snprintf(buf, sizeof(buf), "zfs:%s:", be_path);
1094 /* We have no config tree */
1095 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1097 return (set_error(lbh, BE_ERR_NOPOOL));
1099 return (be_set_nextboot(lbh, vdevs, pool_guid, buf));
1101 if (be_deactivate(lbh, lbh->bootfs) != 0)
1104 /* Obtain bootenv zpool */
1105 err = zpool_set_prop(lbh->active_phandle, "bootfs", be_path);
1109 zhp = zfs_open(lbh->lzh, be_path, ZFS_TYPE_FILESYSTEM);
1113 if (be_prop_list_alloc(&dsprops) != 0)
1116 if (be_get_dataset_props(lbh, be_path, dsprops) != 0) {
1117 nvlist_free(dsprops);
1121 if (nvlist_lookup_string(dsprops, "origin", &origin) == 0)
1122 err = zfs_promote(zhp);
1123 nvlist_free(dsprops);
1131 return (BE_ERR_SUCCESS);