2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/mount.h>
34 #include <sys/ucred.h>
35 #include <sys/queue.h>
36 #include <sys/zfs_context.h>
37 #include <sys/mntent.h>
41 #include <libzfs_core.h>
50 struct promote_entry {
51 char name[BE_MAXPATHLEN];
52 SLIST_ENTRY(promote_entry) link;
55 struct be_destroy_data {
57 char target_name[BE_MAXPATHLEN];
59 SLIST_HEAD(, promote_entry) promotelist;
63 static int be_create_child_noent(libbe_handle_t *lbh, const char *active,
64 const char *child_path);
65 static int be_create_child_cloned(libbe_handle_t *lbh, const char *active);
68 /* Arbitrary... should tune */
69 #define BE_SNAP_SERIAL_MAX 1024
72 * Iterator function for locating the rootfs amongst the children of the
73 * zfs_be_root set by loader(8). data is expected to be a libbe_handle_t *.
76 be_locate_rootfs(libbe_handle_t *lbh)
83 * Check first if root is ZFS; if not, we'll bail on rootfs capture.
84 * Unfortunately needed because zfs_path_to_zhandle will emit to
85 * stderr if / isn't actually a ZFS filesystem, which we'd like
88 if (statfs("/", &sfs) == 0) {
89 statfs2mnttab(&sfs, &entry);
90 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
94 zfs = zfs_path_to_zhandle(lbh->lzh, "/", ZFS_TYPE_FILESYSTEM);
98 strlcpy(lbh->rootfs, zfs_get_name(zfs), sizeof(lbh->rootfs));
104 * Initializes the libbe context to operate in the root boot environment
105 * dataset, for example, zroot/ROOT.
108 libbe_init(const char *root)
110 char altroot[MAXPATHLEN];
112 char *poolname, *pos;
116 poolname = pos = NULL;
118 if ((lbh = calloc(1, sizeof(libbe_handle_t))) == NULL)
121 if ((lbh->lzh = libzfs_init()) == NULL)
125 * Grab rootfs, we'll work backwards from there if an optional BE root
126 * has not been passed in.
128 if (be_locate_rootfs(lbh) != 0) {
134 /* Strip off the final slash from rootfs to get the be root */
135 strlcpy(lbh->root, lbh->rootfs, sizeof(lbh->root));
136 pos = strrchr(lbh->root, '/');
141 strlcpy(lbh->root, root, sizeof(lbh->root));
143 if ((pos = strchr(lbh->root, '/')) == NULL)
146 pnamelen = pos - lbh->root;
147 poolname = malloc(pnamelen + 1);
148 if (poolname == NULL)
151 strlcpy(poolname, lbh->root, pnamelen + 1);
152 if ((lbh->active_phandle = zpool_open(lbh->lzh, poolname)) == NULL)
157 if (zpool_get_prop(lbh->active_phandle, ZPOOL_PROP_BOOTFS, lbh->bootfs,
158 sizeof(lbh->bootfs), NULL, true) != 0)
161 if (zpool_get_prop(lbh->active_phandle, ZPOOL_PROP_ALTROOT,
162 altroot, sizeof(altroot), NULL, true) == 0 &&
163 strcmp(altroot, "-") != 0)
164 lbh->altroot_len = strlen(altroot);
169 if (lbh->active_phandle != NULL)
170 zpool_close(lbh->active_phandle);
171 if (lbh->lzh != NULL)
172 libzfs_fini(lbh->lzh);
181 * Free memory allocated by libbe_init()
184 libbe_close(libbe_handle_t *lbh)
187 if (lbh->active_phandle != NULL)
188 zpool_close(lbh->active_phandle);
189 libzfs_fini(lbh->lzh);
194 * Proxy through to libzfs for the moment.
197 be_nicenum(uint64_t num, char *buf, size_t buflen)
200 zfs_nicenum(num, buf, buflen);
204 be_should_promote_clones(zfs_handle_t *zfs_hdl, struct be_destroy_data *bdd)
208 if (zfs_get_type(zfs_hdl) != ZFS_TYPE_SNAPSHOT)
212 * If we're deleting a snapshot, we need to make sure we only promote
213 * clones that are derived from one of the snapshots we're deleting,
214 * rather than that of a snapshot we're not touching. This keeps stuff
215 * in a consistent state, making sure that we don't error out unless
218 if (bdd->snapname == NULL)
221 atpos = strchr(zfs_get_name(zfs_hdl), '@');
222 return (strcmp(atpos + 1, bdd->snapname) == 0);
226 * This is executed from be_promote_dependent_clones via zfs_iter_dependents,
227 * It checks if the dependent type is a snapshot then attempts to find any
228 * clones associated with it. Any clones not related to the destroy target are
229 * added to the promote list.
232 be_dependent_clone_cb(zfs_handle_t *zfs_hdl, void *data)
239 struct be_destroy_data *bdd;
240 struct promote_entry *entry, *newentry;
244 bdd = (struct be_destroy_data *)data;
246 if (be_should_promote_clones(zfs_hdl, bdd) &&
247 (nvl = zfs_get_clones_nvl(zfs_hdl)) != NULL) {
248 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
249 name = nvpair_name(nvp);
252 * Skip if the clone is equal to, or a child of, the
255 if (strncmp(name, bdd->target_name,
256 strlen(bdd->target_name)) == 0 ||
257 strstr(name, bdd->target_name) == name) {
262 SLIST_FOREACH(entry, &bdd->promotelist, link) {
263 if (strcmp(entry->name, name) == 0) {
272 newentry = malloc(sizeof(struct promote_entry));
273 if (newentry == NULL) {
278 #define BE_COPY_NAME(entry, src) \
279 strlcpy((entry)->name, (src), sizeof((entry)->name))
280 if (BE_COPY_NAME(newentry, name) >=
281 sizeof(newentry->name)) {
282 /* Shouldn't happen. */
290 * We're building up a SLIST here to make sure both that
291 * we get the order right and so that we don't
292 * inadvertently observe the wrong state by promoting
293 * datasets while we're still walking the tree. The
294 * latter can lead to situations where we promote a BE
295 * then effectively demote it again.
297 SLIST_INSERT_HEAD(&bdd->promotelist, newentry, link);
306 * This is called before a destroy, so that any datasets(environments) that are
307 * dependent on this one get promoted before destroying the target.
310 be_promote_dependent_clones(zfs_handle_t *zfs_hdl, struct be_destroy_data *bdd)
314 struct promote_entry *entry;
316 snprintf(bdd->target_name, BE_MAXPATHLEN, "%s/", zfs_get_name(zfs_hdl));
317 err = zfs_iter_dependents(zfs_hdl, true, be_dependent_clone_cb, bdd);
320 * Drain the list and walk away from it if we're only deleting a
323 if (bdd->snapname != NULL && !SLIST_EMPTY(&bdd->promotelist))
324 err = BE_ERR_HASCLONES;
325 while (!SLIST_EMPTY(&bdd->promotelist)) {
326 entry = SLIST_FIRST(&bdd->promotelist);
327 SLIST_REMOVE_HEAD(&bdd->promotelist, link);
329 #define ZFS_GRAB_CLONE() \
330 zfs_open(bdd->lbh->lzh, entry->name, ZFS_TYPE_FILESYSTEM)
332 * Just skip this part on error, we still want to clean up the
333 * promotion list after the first error. We'll then preserve it
336 if (err == 0 && (clone = ZFS_GRAB_CLONE()) != NULL) {
337 err = zfs_promote(clone);
339 err = BE_ERR_DESTROYMNT;
342 #undef ZFS_GRAB_CLONE
350 be_destroy_cb(zfs_handle_t *zfs_hdl, void *data)
352 char path[BE_MAXPATHLEN];
353 struct be_destroy_data *bdd;
357 bdd = (struct be_destroy_data *)data;
358 if (bdd->snapname == NULL) {
359 err = zfs_iter_children(zfs_hdl, be_destroy_cb, data);
362 return (zfs_destroy(zfs_hdl, false));
364 /* If we're dealing with snapshots instead, delete that one alone */
365 err = zfs_iter_filesystems(zfs_hdl, be_destroy_cb, data);
369 * This part is intentionally glossing over any potential errors,
370 * because there's a lot less potential for errors when we're cleaning
371 * up snapshots rather than a full deep BE. The primary error case
372 * here being if the snapshot doesn't exist in the first place, which
373 * the caller will likely deem insignificant as long as it doesn't
374 * exist after the call. Thus, such a missing snapshot shouldn't jam
375 * up the destruction.
377 snprintf(path, sizeof(path), "%s@%s", zfs_get_name(zfs_hdl),
379 if (!zfs_dataset_exists(bdd->lbh->lzh, path, ZFS_TYPE_SNAPSHOT))
381 snap = zfs_open(bdd->lbh->lzh, path, ZFS_TYPE_SNAPSHOT);
383 zfs_destroy(snap, false);
387 #define BE_DESTROY_WANTORIGIN (BE_DESTROY_ORIGIN | BE_DESTROY_AUTOORIGIN)
389 * Destroy the boot environment or snapshot specified by the name
390 * parameter. Options are or'd together with the possible values:
391 * BE_DESTROY_FORCE : forces operation on mounted datasets
392 * BE_DESTROY_ORIGIN: destroy the origin snapshot as well
395 be_destroy_internal(libbe_handle_t *lbh, const char *name, int options,
398 struct be_destroy_data bdd;
399 char origin[BE_MAXPATHLEN], path[BE_MAXPATHLEN];
402 int err, force, mounted;
407 SLIST_INIT(&bdd.promotelist);
408 force = options & BE_DESTROY_FORCE;
411 be_root_concat(lbh, name, path);
413 if ((snapdelim = strchr(path, '@')) == NULL) {
414 if (!zfs_dataset_exists(lbh->lzh, path, ZFS_TYPE_FILESYSTEM))
415 return (set_error(lbh, BE_ERR_NOENT));
417 if (strcmp(path, lbh->rootfs) == 0 ||
418 strcmp(path, lbh->bootfs) == 0)
419 return (set_error(lbh, BE_ERR_DESTROYACT));
421 fs = zfs_open(lbh->lzh, path, ZFS_TYPE_FILESYSTEM);
423 return (set_error(lbh, BE_ERR_ZFSOPEN));
425 /* Don't destroy a mounted dataset unless force is specified */
426 if ((mounted = zfs_is_mounted(fs, NULL)) != 0) {
428 zfs_unmount(fs, NULL, 0);
431 return (set_error(lbh, BE_ERR_DESTROYMNT));
436 * If we're initially destroying a snapshot, origin options do
437 * not make sense. If we're destroying the origin snapshot of
438 * a BE, we want to maintain the options in case we need to
439 * fake success after failing to promote.
442 options &= ~BE_DESTROY_WANTORIGIN;
443 if (!zfs_dataset_exists(lbh->lzh, path, ZFS_TYPE_SNAPSHOT))
444 return (set_error(lbh, BE_ERR_NOENT));
446 bdd.snapname = strdup(snapdelim + 1);
447 if (bdd.snapname == NULL)
448 return (set_error(lbh, BE_ERR_NOMEM));
450 fs = zfs_open(lbh->lzh, path, ZFS_TYPE_DATASET);
453 return (set_error(lbh, BE_ERR_ZFSOPEN));
458 * Whether we're destroying a BE or a single snapshot, we need to walk
459 * the tree of what we're going to destroy and promote everything in our
460 * path so that we can make it happen.
462 if ((err = be_promote_dependent_clones(fs, &bdd)) != 0) {
466 * If we're just destroying the origin of some other dataset
467 * we were invoked to destroy, then we just ignore
468 * BE_ERR_HASCLONES and return success unless the caller wanted
469 * to force the issue.
471 if (odestroyer && err == BE_ERR_HASCLONES &&
472 (options & BE_DESTROY_AUTOORIGIN) != 0)
474 return (set_error(lbh, err));
478 * This was deferred until after we promote all of the derivatives so
479 * that we grab the new origin after everything's settled down.
481 if ((options & BE_DESTROY_WANTORIGIN) != 0 &&
482 zfs_prop_get(fs, ZFS_PROP_ORIGIN, origin, sizeof(origin),
483 NULL, NULL, 0, 1) != 0 &&
484 (options & BE_DESTROY_ORIGIN) != 0)
485 return (set_error(lbh, BE_ERR_NOORIGIN));
488 * If the caller wants auto-origin destruction and the origin
489 * name matches one of our automatically created snapshot names
490 * (i.e. strftime("%F-%T") with a serial at the end), then
491 * we'll set the DESTROY_ORIGIN flag and nuke it
492 * be_is_auto_snapshot_name is exported from libbe(3) so that
493 * the caller can determine if it needs to warn about the origin
494 * not being destroyed or not.
496 if ((options & BE_DESTROY_AUTOORIGIN) != 0 && *origin != '\0' &&
497 be_is_auto_snapshot_name(lbh, origin))
498 options |= BE_DESTROY_ORIGIN;
500 err = be_destroy_cb(fs, &bdd);
504 /* Children are still present or the mount is referenced */
506 return (set_error(lbh, BE_ERR_DESTROYMNT));
507 return (set_error(lbh, BE_ERR_UNKNOWN));
510 if ((options & BE_DESTROY_ORIGIN) == 0)
513 /* The origin can't possibly be shorter than the BE root */
514 rootlen = strlen(lbh->root);
515 if (*origin == '\0' || strlen(origin) <= rootlen + 1)
516 return (set_error(lbh, BE_ERR_INVORIGIN));
519 * We'll be chopping off the BE root and running this back through
520 * be_destroy, so that we properly handle the origin snapshot whether
521 * it be that of a deep BE or not.
523 if (strncmp(origin, lbh->root, rootlen) != 0 || origin[rootlen] != '/')
526 return (be_destroy_internal(lbh, origin + rootlen + 1,
527 options & ~BE_DESTROY_ORIGIN, true));
531 be_destroy(libbe_handle_t *lbh, const char *name, int options)
535 * The consumer must not set both BE_DESTROY_AUTOORIGIN and
536 * BE_DESTROY_ORIGIN. Internally, we'll set the latter from the former.
537 * The latter should imply that we must succeed at destroying the
538 * origin, or complain otherwise.
540 if ((options & BE_DESTROY_WANTORIGIN) == BE_DESTROY_WANTORIGIN)
541 return (set_error(lbh, BE_ERR_UNKNOWN));
542 return (be_destroy_internal(lbh, name, options, false));
546 be_setup_snapshot_name(libbe_handle_t *lbh, char *buf, size_t buflen)
553 len += strftime(buf + len, buflen - len, "@%F-%T", localtime(&rawtime));
554 /* No room for serial... caller will do its best */
555 if (buflen - len < 2)
558 for (serial = 0; serial < BE_SNAP_SERIAL_MAX; ++serial) {
559 snprintf(buf + len, buflen - len, "-%d", serial);
560 if (!zfs_dataset_exists(lbh->lzh, buf, ZFS_TYPE_SNAPSHOT))
566 be_is_auto_snapshot_name(libbe_handle_t *lbh __unused, const char *name)
569 int day, hour, minute, month, second, serial, year;
571 if ((snap = strchr(name, '@')) == NULL)
574 /* We'll grab the individual components and do some light validation. */
575 if (sscanf(snap, "%d-%d-%d-%d:%d:%d-%d", &year, &month, &day, &hour,
576 &minute, &second, &serial) != 7)
578 return (year >= 1970) && (month >= 1 && month <= 12) &&
579 (day >= 1 && day <= 31) && (hour >= 0 && hour <= 23) &&
580 (minute >= 0 && minute <= 59) && (second >= 0 && second <= 60) &&
585 be_snapshot(libbe_handle_t *lbh, const char *source, const char *snap_name,
586 bool recursive, char *result)
588 char buf[BE_MAXPATHLEN];
591 be_root_concat(lbh, source, buf);
593 if ((err = be_exists(lbh, buf)) != 0)
594 return (set_error(lbh, err));
596 if (snap_name != NULL) {
597 if (strlcat(buf, "@", sizeof(buf)) >= sizeof(buf))
598 return (set_error(lbh, BE_ERR_INVALIDNAME));
600 if (strlcat(buf, snap_name, sizeof(buf)) >= sizeof(buf))
601 return (set_error(lbh, BE_ERR_INVALIDNAME));
604 snprintf(result, BE_MAXPATHLEN, "%s@%s", source,
607 be_setup_snapshot_name(lbh, buf, sizeof(buf));
609 if (result != NULL && strlcpy(result, strrchr(buf, '/') + 1,
610 sizeof(buf)) >= sizeof(buf))
611 return (set_error(lbh, BE_ERR_INVALIDNAME));
613 if ((err = zfs_snapshot(lbh->lzh, buf, recursive, NULL)) != 0) {
615 case EZFS_INVALIDNAME:
616 return (set_error(lbh, BE_ERR_INVALIDNAME));
620 * The other errors that zfs_ioc_snapshot might return
621 * shouldn't happen if we've set things up properly, so
622 * we'll gloss over them and call it UNKNOWN as it will
623 * require further triage.
625 if (errno == ENOTSUP)
626 return (set_error(lbh, BE_ERR_NOPOOL));
627 return (set_error(lbh, BE_ERR_UNKNOWN));
631 return (BE_ERR_SUCCESS);
636 * Create the boot environment specified by the name parameter
639 be_create(libbe_handle_t *lbh, const char *name)
643 err = be_create_from_existing(lbh, name, be_active_path(lbh));
645 return (set_error(lbh, err));
649 be_deep_clone_prop(int prop, void *cb)
652 struct libbe_dccb *dccb;
654 char pval[BE_MAXPATHLEN];
655 char source[BE_MAXPATHLEN];
659 /* Skip some properties we don't want to touch */
660 if (prop == ZFS_PROP_CANMOUNT)
663 /* Don't copy readonly properties */
664 if (zfs_prop_readonly(prop))
667 if ((err = zfs_prop_get(dccb->zhp, prop, (char *)&pval,
668 sizeof(pval), &src, (char *)&source, sizeof(source), false)))
669 /* Just continue if we fail to read a property */
673 * Only copy locally defined or received properties. This continues
674 * to avoid temporary/default/local properties intentionally without
675 * breaking received datasets.
677 if (src != ZPROP_SRC_LOCAL && src != ZPROP_SRC_RECEIVED)
680 /* Augment mountpoint with altroot, if needed */
682 if (prop == ZFS_PROP_MOUNTPOINT)
683 val = be_mountpoint_augmented(dccb->lbh, val);
685 nvlist_add_string(dccb->props, zfs_prop_to_name(prop), val);
691 * Return the corresponding boot environment path for a given
692 * dataset path, the constructed path is placed in 'result'.
694 * example: say our new boot environment name is 'bootenv' and
695 * the dataset path is 'zroot/ROOT/default/data/set'.
697 * result should produce: 'zroot/ROOT/bootenv/data/set'
700 be_get_path(struct libbe_deep_clone *ldc, const char *dspath, char *result, int result_size)
705 /* match the root path for the boot environments */
706 pos = strstr(dspath, ldc->lbh->root);
708 /* no match, different pools? */
710 return (BE_ERR_BADPATH);
712 /* root path of the new boot environment */
713 snprintf(result, result_size, "%s/%s", ldc->lbh->root, ldc->bename);
715 /* gets us to the parent dataset, the +1 consumes a trailing slash */
716 pos += strlen(ldc->lbh->root) + 1;
718 /* skip the parent dataset */
719 if ((child_dataset = strchr(pos, '/')) != NULL)
720 strlcat(result, child_dataset, result_size);
722 return (BE_ERR_SUCCESS);
726 be_clone_cb(zfs_handle_t *ds, void *data)
729 char be_path[BE_MAXPATHLEN];
730 char snap_path[BE_MAXPATHLEN];
732 zfs_handle_t *snap_hdl;
734 struct libbe_deep_clone *ldc;
735 struct libbe_dccb dccb;
737 ldc = (struct libbe_deep_clone *)data;
738 dspath = zfs_get_name(ds);
740 snprintf(snap_path, sizeof(snap_path), "%s@%s", dspath, ldc->snapname);
742 /* construct the boot environment path from the dataset we're cloning */
743 if (be_get_path(ldc, dspath, be_path, sizeof(be_path)) != BE_ERR_SUCCESS)
744 return (set_error(ldc->lbh, BE_ERR_UNKNOWN));
746 /* the dataset to be created (i.e. the boot environment) already exists */
747 if (zfs_dataset_exists(ldc->lbh->lzh, be_path, ZFS_TYPE_DATASET))
748 return (set_error(ldc->lbh, BE_ERR_EXISTS));
750 /* no snapshot found for this dataset, silently skip it */
751 if (!zfs_dataset_exists(ldc->lbh->lzh, snap_path, ZFS_TYPE_SNAPSHOT))
755 zfs_open(ldc->lbh->lzh, snap_path, ZFS_TYPE_SNAPSHOT)) == NULL)
756 return (set_error(ldc->lbh, BE_ERR_ZFSOPEN));
758 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
759 nvlist_add_string(props, "canmount", "noauto");
764 if (zprop_iter(be_deep_clone_prop, &dccb, B_FALSE, B_FALSE,
765 ZFS_TYPE_FILESYSTEM) == ZPROP_INVAL)
768 if ((err = zfs_clone(snap_hdl, be_path, props)) != 0)
769 return (set_error(ldc->lbh, BE_ERR_ZFSCLONE));
774 if (ldc->depth_limit == -1 || ldc->depth < ldc->depth_limit) {
776 err = zfs_iter_filesystems(ds, be_clone_cb, ldc);
780 return (set_error(ldc->lbh, err));
784 * Create a boot environment with a given name from a given snapshot.
785 * Snapshots can be in the format 'zroot/ROOT/default@snapshot' or
786 * 'default@snapshot'. In the latter case, 'default@snapshot' will be prepended
787 * with the root path that libbe was initailized with.
790 be_clone(libbe_handle_t *lbh, const char *bename, const char *snapshot, int depth)
793 char snap_path[BE_MAXPATHLEN];
794 char *parentname, *snapname;
795 zfs_handle_t *parent_hdl;
796 struct libbe_deep_clone ldc;
798 /* ensure the boot environment name is valid */
799 if ((err = be_validate_name(lbh, bename)) != 0)
800 return (set_error(lbh, err));
803 * prepend the boot environment root path if we're
804 * given a partial snapshot name.
806 if ((err = be_root_concat(lbh, snapshot, snap_path)) != 0)
807 return (set_error(lbh, err));
809 /* ensure the snapshot exists */
810 if ((err = be_validate_snap(lbh, snap_path)) != 0)
811 return (set_error(lbh, err));
813 /* get a copy of the snapshot path so we can disect it */
814 if ((parentname = strdup(snap_path)) == NULL)
815 return (set_error(lbh, BE_ERR_UNKNOWN));
817 /* split dataset name from snapshot name */
818 snapname = strchr(parentname, '@');
819 if (snapname == NULL) {
821 return (set_error(lbh, BE_ERR_UNKNOWN));
826 /* set-up the boot environment */
829 ldc.snapname = snapname;
831 ldc.depth_limit = depth;
833 /* the boot environment will be cloned from this dataset */
834 parent_hdl = zfs_open(lbh->lzh, parentname, ZFS_TYPE_DATASET);
836 /* create the boot environment */
837 err = be_clone_cb(parent_hdl, &ldc);
840 return (set_error(lbh, err));
844 * Create a boot environment from pre-existing snapshot, specifying a depth.
846 int be_create_depth(libbe_handle_t *lbh, const char *bename,
847 const char *snap, int depth)
849 return (be_clone(lbh, bename, snap, depth));
853 * Create the boot environment from pre-existing snapshot
856 be_create_from_existing_snap(libbe_handle_t *lbh, const char *bename,
859 return (be_clone(lbh, bename, snap, -1));
864 * Create a boot environment from an existing boot environment
867 be_create_from_existing(libbe_handle_t *lbh, const char *bename, const char *old)
870 char snap[BE_MAXPATHLEN];
872 if ((err = be_snapshot(lbh, old, NULL, true, snap)) != 0)
873 return (set_error(lbh, err));
875 err = be_clone(lbh, bename, snap, -1);
877 return (set_error(lbh, err));
882 * Verifies that a snapshot has a valid name, exists, and has a mountpoint of
883 * '/'. Returns BE_ERR_SUCCESS (0), upon success, or the relevant BE_ERR_* upon
884 * failure. Does not set the internal library error state.
887 be_validate_snap(libbe_handle_t *lbh, const char *snap_name)
890 if (strlen(snap_name) >= BE_MAXPATHLEN)
891 return (BE_ERR_PATHLEN);
893 if (!zfs_name_valid(snap_name, ZFS_TYPE_SNAPSHOT))
894 return (BE_ERR_INVALIDNAME);
896 if (!zfs_dataset_exists(lbh->lzh, snap_name,
898 return (BE_ERR_NOENT);
900 return (BE_ERR_SUCCESS);
905 * Idempotently appends the name argument to the root boot environment path
906 * and copies the resulting string into the result buffer (which is assumed
907 * to be at least BE_MAXPATHLEN characters long. Returns BE_ERR_SUCCESS upon
908 * success, BE_ERR_PATHLEN if the resulting path is longer than BE_MAXPATHLEN,
909 * or BE_ERR_INVALIDNAME if the name is a path that does not begin with
910 * zfs_be_root. Does not set internal library error state.
913 be_root_concat(libbe_handle_t *lbh, const char *name, char *result)
915 size_t name_len, root_len;
917 name_len = strlen(name);
918 root_len = strlen(lbh->root);
920 /* Act idempotently; return be name if it is already a full path */
921 if (strrchr(name, '/') != NULL) {
922 if (strstr(name, lbh->root) != name)
923 return (BE_ERR_INVALIDNAME);
925 if (name_len >= BE_MAXPATHLEN)
926 return (BE_ERR_PATHLEN);
928 strlcpy(result, name, BE_MAXPATHLEN);
929 return (BE_ERR_SUCCESS);
930 } else if (name_len + root_len + 1 < BE_MAXPATHLEN) {
931 snprintf(result, BE_MAXPATHLEN, "%s/%s", lbh->root,
933 return (BE_ERR_SUCCESS);
936 return (BE_ERR_PATHLEN);
941 * Verifies the validity of a boot environment name (A-Za-z0-9-_.). Returns
942 * BE_ERR_SUCCESS (0) if name is valid, otherwise returns BE_ERR_INVALIDNAME
944 * Does not set internal library error state.
947 be_validate_name(libbe_handle_t *lbh, const char *name)
951 * Impose the additional restriction that the entire dataset name must
952 * not exceed the maximum length of a dataset, i.e. MAXNAMELEN.
954 if (strlen(lbh->root) + 1 + strlen(name) > MAXNAMELEN)
955 return (BE_ERR_PATHLEN);
957 if (!zfs_name_valid(name, ZFS_TYPE_DATASET))
958 return (BE_ERR_INVALIDNAME);
960 return (BE_ERR_SUCCESS);
968 be_rename(libbe_handle_t *lbh, const char *old, const char *new)
970 char full_old[BE_MAXPATHLEN];
971 char full_new[BE_MAXPATHLEN];
972 zfs_handle_t *zfs_hdl;
976 * be_validate_name is documented not to set error state, so we should
979 if ((err = be_validate_name(lbh, new)) != 0)
980 return (set_error(lbh, err));
981 if ((err = be_root_concat(lbh, old, full_old)) != 0)
982 return (set_error(lbh, err));
983 if ((err = be_root_concat(lbh, new, full_new)) != 0)
984 return (set_error(lbh, err));
986 if (!zfs_dataset_exists(lbh->lzh, full_old, ZFS_TYPE_DATASET))
987 return (set_error(lbh, BE_ERR_NOENT));
989 if (zfs_dataset_exists(lbh->lzh, full_new, ZFS_TYPE_DATASET))
990 return (set_error(lbh, BE_ERR_EXISTS));
992 if ((zfs_hdl = zfs_open(lbh->lzh, full_old,
993 ZFS_TYPE_FILESYSTEM)) == NULL)
994 return (set_error(lbh, BE_ERR_ZFSOPEN));
996 /* recurse, nounmount, forceunmount */
997 struct renameflags flags = {
1001 err = zfs_rename(zfs_hdl, NULL, full_new, flags);
1005 return (set_error(lbh, BE_ERR_UNKNOWN));
1011 be_export(libbe_handle_t *lbh, const char *bootenv, int fd)
1013 char snap_name[BE_MAXPATHLEN];
1014 char buf[BE_MAXPATHLEN];
1016 sendflags_t flags = { 0 };
1019 if ((err = be_snapshot(lbh, bootenv, NULL, true, snap_name)) != 0)
1020 /* Use the error set by be_snapshot */
1023 be_root_concat(lbh, snap_name, buf);
1025 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_DATASET)) == NULL)
1026 return (set_error(lbh, BE_ERR_ZFSOPEN));
1028 err = zfs_send_one(zfs, NULL, fd, flags);
1036 be_import(libbe_handle_t *lbh, const char *bootenv, int fd)
1038 char buf[BE_MAXPATHLEN];
1041 recvflags_t flags = { .nomount = 1 };
1044 be_root_concat(lbh, bootenv, buf);
1046 if ((err = zfs_receive(lbh->lzh, buf, NULL, &flags, fd, NULL)) != 0) {
1049 return (set_error(lbh, BE_ERR_NOORIGIN));
1051 return (set_error(lbh, BE_ERR_NOENT));
1053 return (set_error(lbh, BE_ERR_IO));
1055 return (set_error(lbh, BE_ERR_UNKNOWN));
1059 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_FILESYSTEM)) == NULL)
1060 return (set_error(lbh, BE_ERR_ZFSOPEN));
1062 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
1063 nvlist_add_string(props, "canmount", "noauto");
1064 nvlist_add_string(props, "mountpoint", "none");
1066 err = zfs_prop_set_list(zfs, props);
1072 return (set_error(lbh, BE_ERR_UNKNOWN));
1079 be_create_child_noent(libbe_handle_t *lbh, const char *active,
1080 const char *child_path)
1086 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
1087 nvlist_add_string(props, "canmount", "noauto");
1088 nvlist_add_string(props, "mountpoint", child_path);
1091 if ((err = zfs_create(lbh->lzh, active, ZFS_TYPE_DATASET,
1095 return (set_error(lbh, BE_ERR_EXISTS));
1097 return (set_error(lbh, BE_ERR_NOENT));
1099 case EZFS_BADVERSION:
1100 return (set_error(lbh, BE_ERR_NOPOOL));
1103 /* We set something up wrong, probably... */
1104 return (set_error(lbh, BE_ERR_UNKNOWN));
1109 if ((zfs = zfs_open(lbh->lzh, active, ZFS_TYPE_DATASET)) == NULL)
1110 return (set_error(lbh, BE_ERR_ZFSOPEN));
1113 if ((err = zfs_prop_set(zfs, "canmount", "noauto")) != 0) {
1116 * Similar to other cases, this shouldn't fail unless we've
1117 * done something wrong. This is a new dataset that shouldn't
1118 * have been mounted anywhere between creation and now.
1120 if (err == EZFS_NOMEM)
1121 return (set_error(lbh, BE_ERR_NOMEM));
1122 return (set_error(lbh, BE_ERR_UNKNOWN));
1125 return (BE_ERR_SUCCESS);
1129 be_create_child_cloned(libbe_handle_t *lbh, const char *active)
1131 char buf[BE_MAXPATHLEN], tmp[BE_MAXPATHLEN];;
1138 * Establish if the existing path is a zfs dataset or just
1139 * the subdirectory of one
1141 strlcpy(tmp, "tmp/be_snap.XXXXX", sizeof(tmp));
1142 if (mktemp(tmp) == NULL)
1143 return (set_error(lbh, BE_ERR_UNKNOWN));
1145 be_root_concat(lbh, tmp, buf);
1146 printf("Here %s?\n", buf);
1147 if ((err = zfs_snapshot(lbh->lzh, buf, false, NULL)) != 0) {
1149 case EZFS_INVALIDNAME:
1150 return (set_error(lbh, BE_ERR_INVALIDNAME));
1154 * The other errors that zfs_ioc_snapshot might return
1155 * shouldn't happen if we've set things up properly, so
1156 * we'll gloss over them and call it UNKNOWN as it will
1157 * require further triage.
1159 if (errno == ENOTSUP)
1160 return (set_error(lbh, BE_ERR_NOPOOL));
1161 return (set_error(lbh, BE_ERR_UNKNOWN));
1166 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_SNAPSHOT)) == NULL)
1167 return (BE_ERR_ZFSOPEN);
1169 if ((err = zfs_clone(zfs, active, NULL)) != 0)
1170 /* XXX TODO correct error */
1171 return (set_error(lbh, BE_ERR_UNKNOWN));
1175 return (BE_ERR_SUCCESS);
1179 be_add_child(libbe_handle_t *lbh, const char *child_path, bool cp_if_exists)
1182 char active[BE_MAXPATHLEN], buf[BE_MAXPATHLEN];
1186 /* Require absolute paths */
1187 if (*child_path != '/')
1188 return (set_error(lbh, BE_ERR_BADPATH));
1190 strlcpy(active, be_active_path(lbh), BE_MAXPATHLEN);
1191 strcpy(buf, active);
1193 /* Create non-mountable parent dataset(s) */
1195 for (char *p; (p = strchr(s+1, '/')) != NULL; s = p) {
1197 strncat(buf, s, len);
1199 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
1200 nvlist_add_string(props, "canmount", "off");
1201 nvlist_add_string(props, "mountpoint", "none");
1202 zfs_create(lbh->lzh, buf, ZFS_TYPE_DATASET, props);
1206 /* Path does not exist as a descendent of / yet */
1207 if (strlcat(active, child_path, BE_MAXPATHLEN) >= BE_MAXPATHLEN)
1208 return (set_error(lbh, BE_ERR_PATHLEN));
1210 if (stat(child_path, &sb) != 0) {
1211 /* Verify that error is ENOENT */
1212 if (errno != ENOENT)
1213 return (set_error(lbh, BE_ERR_UNKNOWN));
1214 return (be_create_child_noent(lbh, active, child_path));
1215 } else if (cp_if_exists)
1216 /* Path is already a descendent of / and should be copied */
1217 return (be_create_child_cloned(lbh, active));
1218 return (set_error(lbh, BE_ERR_EXISTS));
1223 be_set_nextboot(libbe_handle_t *lbh, nvlist_t *config, uint64_t pool_guid,
1230 if (nvlist_lookup_nvlist_array(config, ZPOOL_CONFIG_CHILDREN, &child,
1232 for (c = 0; c < children; ++c)
1233 if (be_set_nextboot(lbh, child[c], pool_guid, zfsdev) != 0)
1238 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
1243 if (zpool_nextboot(lbh->lzh, pool_guid, vdev_guid, zfsdev) != 0) {
1244 perror("ZFS_IOC_NEXTBOOT failed");
1252 * Deactivate old BE dataset; currently just sets canmount=noauto
1255 be_deactivate(libbe_handle_t *lbh, const char *ds)
1259 if ((zfs = zfs_open(lbh->lzh, ds, ZFS_TYPE_DATASET)) == NULL)
1261 if (zfs_prop_set(zfs, "canmount", "noauto") != 0)
1268 be_activate(libbe_handle_t *lbh, const char *bootenv, bool temporary)
1270 char be_path[BE_MAXPATHLEN];
1271 char buf[BE_MAXPATHLEN];
1272 nvlist_t *config, *dsprops, *vdevs;
1278 be_root_concat(lbh, bootenv, be_path);
1280 /* Note: be_exists fails if mountpoint is not / */
1281 if ((err = be_exists(lbh, be_path)) != 0)
1282 return (set_error(lbh, err));
1285 config = zpool_get_config(lbh->active_phandle, NULL);
1287 /* config should be fetchable... */
1288 return (set_error(lbh, BE_ERR_UNKNOWN));
1290 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1292 /* Similarly, it shouldn't be possible */
1293 return (set_error(lbh, BE_ERR_UNKNOWN));
1295 /* Expected format according to zfsbootcfg(8) man */
1296 snprintf(buf, sizeof(buf), "zfs:%s:", be_path);
1298 /* We have no config tree */
1299 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1301 return (set_error(lbh, BE_ERR_NOPOOL));
1303 return (be_set_nextboot(lbh, vdevs, pool_guid, buf));
1305 if (be_deactivate(lbh, lbh->bootfs) != 0)
1308 /* Obtain bootenv zpool */
1309 err = zpool_set_prop(lbh->active_phandle, "bootfs", be_path);
1313 zhp = zfs_open(lbh->lzh, be_path, ZFS_TYPE_FILESYSTEM);
1317 if (be_prop_list_alloc(&dsprops) != 0)
1320 if (be_get_dataset_props(lbh, be_path, dsprops) != 0) {
1321 nvlist_free(dsprops);
1325 if (nvlist_lookup_string(dsprops, "origin", &origin) == 0)
1326 err = zfs_promote(zhp);
1327 nvlist_free(dsprops);
1335 return (BE_ERR_SUCCESS);