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>
36 #include <sys/queue.h>
37 #include <sys/zfs_context.h>
38 #include <sys/mntent.h>
42 #include <libzfs_core.h>
51 struct promote_entry {
52 char name[BE_MAXPATHLEN];
53 SLIST_ENTRY(promote_entry) link;
56 struct be_destroy_data {
58 char target_name[BE_MAXPATHLEN];
60 SLIST_HEAD(, promote_entry) promotelist;
64 static int be_create_child_noent(libbe_handle_t *lbh, const char *active,
65 const char *child_path);
66 static int be_create_child_cloned(libbe_handle_t *lbh, const char *active);
69 /* Arbitrary... should tune */
70 #define BE_SNAP_SERIAL_MAX 1024
73 * Iterator function for locating the rootfs amongst the children of the
74 * zfs_be_root set by loader(8). data is expected to be a libbe_handle_t *.
77 be_locate_rootfs(libbe_handle_t *lbh)
84 * Check first if root is ZFS; if not, we'll bail on rootfs capture.
85 * Unfortunately needed because zfs_path_to_zhandle will emit to
86 * stderr if / isn't actually a ZFS filesystem, which we'd like
89 if (statfs("/", &sfs) == 0) {
90 statfs2mnttab(&sfs, &entry);
91 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
95 zfs = zfs_path_to_zhandle(lbh->lzh, "/", ZFS_TYPE_FILESYSTEM);
99 strlcpy(lbh->rootfs, zfs_get_name(zfs), sizeof(lbh->rootfs));
105 * Initializes the libbe context to operate in the root boot environment
106 * dataset, for example, zroot/ROOT.
109 libbe_init(const char *root)
111 char altroot[MAXPATHLEN];
113 char *poolname, *pos;
117 poolname = pos = NULL;
119 if ((lbh = calloc(1, sizeof(libbe_handle_t))) == NULL)
122 if ((lbh->lzh = libzfs_init()) == NULL)
126 * Grab rootfs, we'll work backwards from there if an optional BE root
127 * has not been passed in.
129 if (be_locate_rootfs(lbh) != 0) {
135 /* Strip off the final slash from rootfs to get the be root */
136 strlcpy(lbh->root, lbh->rootfs, sizeof(lbh->root));
137 pos = strrchr(lbh->root, '/');
142 strlcpy(lbh->root, root, sizeof(lbh->root));
144 if ((pos = strchr(lbh->root, '/')) == NULL)
147 pnamelen = pos - lbh->root;
148 poolname = malloc(pnamelen + 1);
149 if (poolname == NULL)
152 strlcpy(poolname, lbh->root, pnamelen + 1);
153 if ((lbh->active_phandle = zpool_open(lbh->lzh, poolname)) == NULL)
158 if (zpool_get_prop(lbh->active_phandle, ZPOOL_PROP_BOOTFS, lbh->bootfs,
159 sizeof(lbh->bootfs), NULL, true) != 0)
162 if (zpool_get_prop(lbh->active_phandle, ZPOOL_PROP_ALTROOT,
163 altroot, sizeof(altroot), NULL, true) == 0 &&
164 strcmp(altroot, "-") != 0)
165 lbh->altroot_len = strlen(altroot);
170 if (lbh->active_phandle != NULL)
171 zpool_close(lbh->active_phandle);
172 if (lbh->lzh != NULL)
173 libzfs_fini(lbh->lzh);
182 * Free memory allocated by libbe_init()
185 libbe_close(libbe_handle_t *lbh)
188 if (lbh->active_phandle != NULL)
189 zpool_close(lbh->active_phandle);
190 libzfs_fini(lbh->lzh);
195 * Proxy through to libzfs for the moment.
198 be_nicenum(uint64_t num, char *buf, size_t buflen)
201 zfs_nicenum(num, buf, buflen);
205 be_should_promote_clones(zfs_handle_t *zfs_hdl, struct be_destroy_data *bdd)
209 if (zfs_get_type(zfs_hdl) != ZFS_TYPE_SNAPSHOT)
213 * If we're deleting a snapshot, we need to make sure we only promote
214 * clones that are derived from one of the snapshots we're deleting,
215 * rather than that of a snapshot we're not touching. This keeps stuff
216 * in a consistent state, making sure that we don't error out unless
219 if (bdd->snapname == NULL)
222 atpos = strchr(zfs_get_name(zfs_hdl), '@');
223 return (strcmp(atpos + 1, bdd->snapname) == 0);
227 * This is executed from be_promote_dependent_clones via zfs_iter_dependents,
228 * It checks if the dependent type is a snapshot then attempts to find any
229 * clones associated with it. Any clones not related to the destroy target are
230 * added to the promote list.
233 be_dependent_clone_cb(zfs_handle_t *zfs_hdl, void *data)
240 struct be_destroy_data *bdd;
241 struct promote_entry *entry, *newentry;
245 bdd = (struct be_destroy_data *)data;
247 if (be_should_promote_clones(zfs_hdl, bdd) &&
248 (nvl = zfs_get_clones_nvl(zfs_hdl)) != NULL) {
249 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {
250 name = nvpair_name(nvp);
253 * Skip if the clone is equal to, or a child of, the
256 if (strncmp(name, bdd->target_name,
257 strlen(bdd->target_name)) == 0 ||
258 strstr(name, bdd->target_name) == name) {
263 SLIST_FOREACH(entry, &bdd->promotelist, link) {
264 if (strcmp(entry->name, name) == 0) {
273 newentry = malloc(sizeof(struct promote_entry));
274 if (newentry == NULL) {
279 #define BE_COPY_NAME(entry, src) \
280 strlcpy((entry)->name, (src), sizeof((entry)->name))
281 if (BE_COPY_NAME(newentry, name) >=
282 sizeof(newentry->name)) {
283 /* Shouldn't happen. */
291 * We're building up a SLIST here to make sure both that
292 * we get the order right and so that we don't
293 * inadvertently observe the wrong state by promoting
294 * datasets while we're still walking the tree. The
295 * latter can lead to situations where we promote a BE
296 * then effectively demote it again.
298 SLIST_INSERT_HEAD(&bdd->promotelist, newentry, link);
307 * This is called before a destroy, so that any datasets(environments) that are
308 * dependent on this one get promoted before destroying the target.
311 be_promote_dependent_clones(zfs_handle_t *zfs_hdl, struct be_destroy_data *bdd)
315 struct promote_entry *entry;
317 snprintf(bdd->target_name, BE_MAXPATHLEN, "%s/", zfs_get_name(zfs_hdl));
318 err = zfs_iter_dependents(zfs_hdl, true, be_dependent_clone_cb, bdd);
321 * Drain the list and walk away from it if we're only deleting a
324 if (bdd->snapname != NULL && !SLIST_EMPTY(&bdd->promotelist))
325 err = BE_ERR_HASCLONES;
326 while (!SLIST_EMPTY(&bdd->promotelist)) {
327 entry = SLIST_FIRST(&bdd->promotelist);
328 SLIST_REMOVE_HEAD(&bdd->promotelist, link);
330 #define ZFS_GRAB_CLONE() \
331 zfs_open(bdd->lbh->lzh, entry->name, ZFS_TYPE_FILESYSTEM)
333 * Just skip this part on error, we still want to clean up the
334 * promotion list after the first error. We'll then preserve it
337 if (err == 0 && (clone = ZFS_GRAB_CLONE()) != NULL) {
338 err = zfs_promote(clone);
340 err = BE_ERR_DESTROYMNT;
343 #undef ZFS_GRAB_CLONE
351 be_destroy_cb(zfs_handle_t *zfs_hdl, void *data)
353 char path[BE_MAXPATHLEN];
354 struct be_destroy_data *bdd;
358 bdd = (struct be_destroy_data *)data;
359 if (bdd->snapname == NULL) {
360 err = zfs_iter_children(zfs_hdl, be_destroy_cb, data);
363 return (zfs_destroy(zfs_hdl, false));
365 /* If we're dealing with snapshots instead, delete that one alone */
366 err = zfs_iter_filesystems(zfs_hdl, be_destroy_cb, data);
370 * This part is intentionally glossing over any potential errors,
371 * because there's a lot less potential for errors when we're cleaning
372 * up snapshots rather than a full deep BE. The primary error case
373 * here being if the snapshot doesn't exist in the first place, which
374 * the caller will likely deem insignificant as long as it doesn't
375 * exist after the call. Thus, such a missing snapshot shouldn't jam
376 * up the destruction.
378 snprintf(path, sizeof(path), "%s@%s", zfs_get_name(zfs_hdl),
380 if (!zfs_dataset_exists(bdd->lbh->lzh, path, ZFS_TYPE_SNAPSHOT))
382 snap = zfs_open(bdd->lbh->lzh, path, ZFS_TYPE_SNAPSHOT);
384 zfs_destroy(snap, false);
388 #define BE_DESTROY_WANTORIGIN (BE_DESTROY_ORIGIN | BE_DESTROY_AUTOORIGIN)
390 * Destroy the boot environment or snapshot specified by the name
391 * parameter. Options are or'd together with the possible values:
392 * BE_DESTROY_FORCE : forces operation on mounted datasets
393 * BE_DESTROY_ORIGIN: destroy the origin snapshot as well
396 be_destroy_internal(libbe_handle_t *lbh, const char *name, int options,
399 struct be_destroy_data bdd;
400 char origin[BE_MAXPATHLEN], path[BE_MAXPATHLEN];
403 int err, force, mounted;
408 SLIST_INIT(&bdd.promotelist);
409 force = options & BE_DESTROY_FORCE;
412 be_root_concat(lbh, name, path);
414 if ((snapdelim = strchr(path, '@')) == NULL) {
415 if (!zfs_dataset_exists(lbh->lzh, path, ZFS_TYPE_FILESYSTEM))
416 return (set_error(lbh, BE_ERR_NOENT));
418 if (strcmp(path, lbh->rootfs) == 0 ||
419 strcmp(path, lbh->bootfs) == 0)
420 return (set_error(lbh, BE_ERR_DESTROYACT));
422 fs = zfs_open(lbh->lzh, path, ZFS_TYPE_FILESYSTEM);
424 return (set_error(lbh, BE_ERR_ZFSOPEN));
426 /* Don't destroy a mounted dataset unless force is specified */
427 if ((mounted = zfs_is_mounted(fs, NULL)) != 0) {
429 zfs_unmount(fs, NULL, 0);
432 return (set_error(lbh, BE_ERR_DESTROYMNT));
437 * If we're initially destroying a snapshot, origin options do
438 * not make sense. If we're destroying the origin snapshot of
439 * a BE, we want to maintain the options in case we need to
440 * fake success after failing to promote.
443 options &= ~BE_DESTROY_WANTORIGIN;
444 if (!zfs_dataset_exists(lbh->lzh, path, ZFS_TYPE_SNAPSHOT))
445 return (set_error(lbh, BE_ERR_NOENT));
447 bdd.snapname = strdup(snapdelim + 1);
448 if (bdd.snapname == NULL)
449 return (set_error(lbh, BE_ERR_NOMEM));
451 fs = zfs_open(lbh->lzh, path, ZFS_TYPE_DATASET);
454 return (set_error(lbh, BE_ERR_ZFSOPEN));
459 * Whether we're destroying a BE or a single snapshot, we need to walk
460 * the tree of what we're going to destroy and promote everything in our
461 * path so that we can make it happen.
463 if ((err = be_promote_dependent_clones(fs, &bdd)) != 0) {
467 * If we're just destroying the origin of some other dataset
468 * we were invoked to destroy, then we just ignore
469 * BE_ERR_HASCLONES and return success unless the caller wanted
470 * to force the issue.
472 if (odestroyer && err == BE_ERR_HASCLONES &&
473 (options & BE_DESTROY_AUTOORIGIN) != 0)
475 return (set_error(lbh, err));
479 * This was deferred until after we promote all of the derivatives so
480 * that we grab the new origin after everything's settled down.
482 if ((options & BE_DESTROY_WANTORIGIN) != 0 &&
483 zfs_prop_get(fs, ZFS_PROP_ORIGIN, origin, sizeof(origin),
484 NULL, NULL, 0, 1) != 0 &&
485 (options & BE_DESTROY_ORIGIN) != 0)
486 return (set_error(lbh, BE_ERR_NOORIGIN));
489 * If the caller wants auto-origin destruction and the origin
490 * name matches one of our automatically created snapshot names
491 * (i.e. strftime("%F-%T") with a serial at the end), then
492 * we'll set the DESTROY_ORIGIN flag and nuke it
493 * be_is_auto_snapshot_name is exported from libbe(3) so that
494 * the caller can determine if it needs to warn about the origin
495 * not being destroyed or not.
497 if ((options & BE_DESTROY_AUTOORIGIN) != 0 && *origin != '\0' &&
498 be_is_auto_snapshot_name(lbh, origin))
499 options |= BE_DESTROY_ORIGIN;
501 err = be_destroy_cb(fs, &bdd);
505 /* Children are still present or the mount is referenced */
507 return (set_error(lbh, BE_ERR_DESTROYMNT));
508 return (set_error(lbh, BE_ERR_UNKNOWN));
511 if ((options & BE_DESTROY_ORIGIN) == 0)
514 /* The origin can't possibly be shorter than the BE root */
515 rootlen = strlen(lbh->root);
516 if (*origin == '\0' || strlen(origin) <= rootlen + 1)
517 return (set_error(lbh, BE_ERR_INVORIGIN));
520 * We'll be chopping off the BE root and running this back through
521 * be_destroy, so that we properly handle the origin snapshot whether
522 * it be that of a deep BE or not.
524 if (strncmp(origin, lbh->root, rootlen) != 0 || origin[rootlen] != '/')
527 return (be_destroy_internal(lbh, origin + rootlen + 1,
528 options & ~BE_DESTROY_ORIGIN, true));
532 be_destroy(libbe_handle_t *lbh, const char *name, int options)
536 * The consumer must not set both BE_DESTROY_AUTOORIGIN and
537 * BE_DESTROY_ORIGIN. Internally, we'll set the latter from the former.
538 * The latter should imply that we must succeed at destroying the
539 * origin, or complain otherwise.
541 if ((options & BE_DESTROY_WANTORIGIN) == BE_DESTROY_WANTORIGIN)
542 return (set_error(lbh, BE_ERR_UNKNOWN));
543 return (be_destroy_internal(lbh, name, options, false));
547 be_setup_snapshot_name(libbe_handle_t *lbh, char *buf, size_t buflen)
554 len += strftime(buf + len, buflen - len, "@%F-%T", localtime(&rawtime));
555 /* No room for serial... caller will do its best */
556 if (buflen - len < 2)
559 for (serial = 0; serial < BE_SNAP_SERIAL_MAX; ++serial) {
560 snprintf(buf + len, buflen - len, "-%d", serial);
561 if (!zfs_dataset_exists(lbh->lzh, buf, ZFS_TYPE_SNAPSHOT))
567 be_is_auto_snapshot_name(libbe_handle_t *lbh, const char *name)
570 int day, hour, minute, month, second, serial, year;
572 if ((snap = strchr(name, '@')) == NULL)
575 /* We'll grab the individual components and do some light validation. */
576 if (sscanf(snap, "%d-%d-%d-%d:%d:%d-%d", &year, &month, &day, &hour,
577 &minute, &second, &serial) != 7)
579 return (year >= 1970) && (month >= 1 && month <= 12) &&
580 (day >= 1 && day <= 31) && (hour >= 0 && hour <= 23) &&
581 (minute >= 0 && minute <= 59) && (second >= 0 && second <= 60) &&
586 be_snapshot(libbe_handle_t *lbh, const char *source, const char *snap_name,
587 bool recursive, char *result)
589 char buf[BE_MAXPATHLEN];
592 be_root_concat(lbh, source, buf);
594 if ((err = be_exists(lbh, buf)) != 0)
595 return (set_error(lbh, err));
597 if (snap_name != NULL) {
598 if (strlcat(buf, "@", sizeof(buf)) >= sizeof(buf))
599 return (set_error(lbh, BE_ERR_INVALIDNAME));
601 if (strlcat(buf, snap_name, sizeof(buf)) >= sizeof(buf))
602 return (set_error(lbh, BE_ERR_INVALIDNAME));
605 snprintf(result, BE_MAXPATHLEN, "%s@%s", source,
608 be_setup_snapshot_name(lbh, buf, sizeof(buf));
610 if (result != NULL && strlcpy(result, strrchr(buf, '/') + 1,
611 sizeof(buf)) >= sizeof(buf))
612 return (set_error(lbh, BE_ERR_INVALIDNAME));
614 if ((err = zfs_snapshot(lbh->lzh, buf, recursive, NULL)) != 0) {
616 case EZFS_INVALIDNAME:
617 return (set_error(lbh, BE_ERR_INVALIDNAME));
621 * The other errors that zfs_ioc_snapshot might return
622 * shouldn't happen if we've set things up properly, so
623 * we'll gloss over them and call it UNKNOWN as it will
624 * require further triage.
626 if (errno == ENOTSUP)
627 return (set_error(lbh, BE_ERR_NOPOOL));
628 return (set_error(lbh, BE_ERR_UNKNOWN));
632 return (BE_ERR_SUCCESS);
637 * Create the boot environment specified by the name parameter
640 be_create(libbe_handle_t *lbh, const char *name)
644 err = be_create_from_existing(lbh, name, be_active_path(lbh));
646 return (set_error(lbh, err));
650 be_deep_clone_prop(int prop, void *cb)
653 struct libbe_dccb *dccb;
655 char pval[BE_MAXPATHLEN];
656 char source[BE_MAXPATHLEN];
660 /* Skip some properties we don't want to touch */
661 if (prop == ZFS_PROP_CANMOUNT)
664 /* Don't copy readonly properties */
665 if (zfs_prop_readonly(prop))
668 if ((err = zfs_prop_get(dccb->zhp, prop, (char *)&pval,
669 sizeof(pval), &src, (char *)&source, sizeof(source), false)))
670 /* Just continue if we fail to read a property */
674 * Only copy locally defined or received properties. This continues
675 * to avoid temporary/default/local properties intentionally without
676 * breaking received datasets.
678 if (src != ZPROP_SRC_LOCAL && src != ZPROP_SRC_RECEIVED)
681 /* Augment mountpoint with altroot, if needed */
683 if (prop == ZFS_PROP_MOUNTPOINT)
684 val = be_mountpoint_augmented(dccb->lbh, val);
686 nvlist_add_string(dccb->props, zfs_prop_to_name(prop), val);
692 * Return the corresponding boot environment path for a given
693 * dataset path, the constructed path is placed in 'result'.
695 * example: say our new boot environment name is 'bootenv' and
696 * the dataset path is 'zroot/ROOT/default/data/set'.
698 * result should produce: 'zroot/ROOT/bootenv/data/set'
701 be_get_path(struct libbe_deep_clone *ldc, const char *dspath, char *result, int result_size)
706 /* match the root path for the boot environments */
707 pos = strstr(dspath, ldc->lbh->root);
709 /* no match, different pools? */
711 return (BE_ERR_BADPATH);
713 /* root path of the new boot environment */
714 snprintf(result, result_size, "%s/%s", ldc->lbh->root, ldc->bename);
716 /* gets us to the parent dataset, the +1 consumes a trailing slash */
717 pos += strlen(ldc->lbh->root) + 1;
719 /* skip the parent dataset */
720 if ((child_dataset = strchr(pos, '/')) != NULL)
721 strlcat(result, child_dataset, result_size);
723 return (BE_ERR_SUCCESS);
727 be_clone_cb(zfs_handle_t *ds, void *data)
730 char be_path[BE_MAXPATHLEN];
731 char snap_path[BE_MAXPATHLEN];
733 zfs_handle_t *snap_hdl;
735 struct libbe_deep_clone *ldc;
736 struct libbe_dccb dccb;
738 ldc = (struct libbe_deep_clone *)data;
739 dspath = zfs_get_name(ds);
741 snprintf(snap_path, sizeof(snap_path), "%s@%s", dspath, ldc->snapname);
743 /* construct the boot environment path from the dataset we're cloning */
744 if (be_get_path(ldc, dspath, be_path, sizeof(be_path)) != BE_ERR_SUCCESS)
745 return (set_error(ldc->lbh, BE_ERR_UNKNOWN));
747 /* the dataset to be created (i.e. the boot environment) already exists */
748 if (zfs_dataset_exists(ldc->lbh->lzh, be_path, ZFS_TYPE_DATASET))
749 return (set_error(ldc->lbh, BE_ERR_EXISTS));
751 /* no snapshot found for this dataset, silently skip it */
752 if (!zfs_dataset_exists(ldc->lbh->lzh, snap_path, ZFS_TYPE_SNAPSHOT))
756 zfs_open(ldc->lbh->lzh, snap_path, ZFS_TYPE_SNAPSHOT)) == NULL)
757 return (set_error(ldc->lbh, BE_ERR_ZFSOPEN));
759 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
760 nvlist_add_string(props, "canmount", "noauto");
765 if (zprop_iter(be_deep_clone_prop, &dccb, B_FALSE, B_FALSE,
766 ZFS_TYPE_FILESYSTEM) == ZPROP_INVAL)
769 if ((err = zfs_clone(snap_hdl, be_path, props)) != 0)
770 return (set_error(ldc->lbh, BE_ERR_ZFSCLONE));
775 if (ldc->depth_limit == -1 || ldc->depth < ldc->depth_limit) {
777 err = zfs_iter_filesystems(ds, be_clone_cb, ldc);
781 return (set_error(ldc->lbh, err));
785 * Create a boot environment with a given name from a given snapshot.
786 * Snapshots can be in the format 'zroot/ROOT/default@snapshot' or
787 * 'default@snapshot'. In the latter case, 'default@snapshot' will be prepended
788 * with the root path that libbe was initailized with.
791 be_clone(libbe_handle_t *lbh, const char *bename, const char *snapshot, int depth)
794 char snap_path[BE_MAXPATHLEN];
795 char *parentname, *snapname;
796 zfs_handle_t *parent_hdl;
797 struct libbe_deep_clone ldc;
799 /* ensure the boot environment name is valid */
800 if ((err = be_validate_name(lbh, bename)) != 0)
801 return (set_error(lbh, err));
804 * prepend the boot environment root path if we're
805 * given a partial snapshot name.
807 if ((err = be_root_concat(lbh, snapshot, snap_path)) != 0)
808 return (set_error(lbh, err));
810 /* ensure the snapshot exists */
811 if ((err = be_validate_snap(lbh, snap_path)) != 0)
812 return (set_error(lbh, err));
814 /* get a copy of the snapshot path so we can disect it */
815 if ((parentname = strdup(snap_path)) == NULL)
816 return (set_error(lbh, BE_ERR_UNKNOWN));
818 /* split dataset name from snapshot name */
819 snapname = strchr(parentname, '@');
820 if (snapname == NULL) {
822 return (set_error(lbh, BE_ERR_UNKNOWN));
827 /* set-up the boot environment */
830 ldc.snapname = snapname;
832 ldc.depth_limit = depth;
834 /* the boot environment will be cloned from this dataset */
835 parent_hdl = zfs_open(lbh->lzh, parentname, ZFS_TYPE_DATASET);
837 /* create the boot environment */
838 err = be_clone_cb(parent_hdl, &ldc);
841 return (set_error(lbh, err));
845 * Create a boot environment from pre-existing snapshot, specifying a depth.
847 int be_create_depth(libbe_handle_t *lbh, const char *bename,
848 const char *snap, int depth)
850 return (be_clone(lbh, bename, snap, depth));
854 * Create the boot environment from pre-existing snapshot
857 be_create_from_existing_snap(libbe_handle_t *lbh, const char *bename,
860 return (be_clone(lbh, bename, snap, -1));
865 * Create a boot environment from an existing boot environment
868 be_create_from_existing(libbe_handle_t *lbh, const char *bename, const char *old)
871 char snap[BE_MAXPATHLEN];
873 if ((err = be_snapshot(lbh, old, NULL, true, snap)) != 0)
874 return (set_error(lbh, err));
876 err = be_clone(lbh, bename, snap, -1);
878 return (set_error(lbh, err));
883 * Verifies that a snapshot has a valid name, exists, and has a mountpoint of
884 * '/'. Returns BE_ERR_SUCCESS (0), upon success, or the relevant BE_ERR_* upon
885 * failure. Does not set the internal library error state.
888 be_validate_snap(libbe_handle_t *lbh, const char *snap_name)
891 if (strlen(snap_name) >= BE_MAXPATHLEN)
892 return (BE_ERR_PATHLEN);
894 if (!zfs_name_valid(snap_name, ZFS_TYPE_SNAPSHOT))
895 return (BE_ERR_INVALIDNAME);
897 if (!zfs_dataset_exists(lbh->lzh, snap_name,
899 return (BE_ERR_NOENT);
901 return (BE_ERR_SUCCESS);
906 * Idempotently appends the name argument to the root boot environment path
907 * and copies the resulting string into the result buffer (which is assumed
908 * to be at least BE_MAXPATHLEN characters long. Returns BE_ERR_SUCCESS upon
909 * success, BE_ERR_PATHLEN if the resulting path is longer than BE_MAXPATHLEN,
910 * or BE_ERR_INVALIDNAME if the name is a path that does not begin with
911 * zfs_be_root. Does not set internal library error state.
914 be_root_concat(libbe_handle_t *lbh, const char *name, char *result)
916 size_t name_len, root_len;
918 name_len = strlen(name);
919 root_len = strlen(lbh->root);
921 /* Act idempotently; return be name if it is already a full path */
922 if (strrchr(name, '/') != NULL) {
923 if (strstr(name, lbh->root) != name)
924 return (BE_ERR_INVALIDNAME);
926 if (name_len >= BE_MAXPATHLEN)
927 return (BE_ERR_PATHLEN);
929 strlcpy(result, name, BE_MAXPATHLEN);
930 return (BE_ERR_SUCCESS);
931 } else if (name_len + root_len + 1 < BE_MAXPATHLEN) {
932 snprintf(result, BE_MAXPATHLEN, "%s/%s", lbh->root,
934 return (BE_ERR_SUCCESS);
937 return (BE_ERR_PATHLEN);
942 * Verifies the validity of a boot environment name (A-Za-z0-9-_.). Returns
943 * BE_ERR_SUCCESS (0) if name is valid, otherwise returns BE_ERR_INVALIDNAME
945 * Does not set internal library error state.
948 be_validate_name(libbe_handle_t *lbh, const char *name)
952 * Impose the additional restriction that the entire dataset name must
953 * not exceed the maximum length of a dataset, i.e. MAXNAMELEN.
955 if (strlen(lbh->root) + 1 + strlen(name) > MAXNAMELEN)
956 return (BE_ERR_PATHLEN);
958 if (!zfs_name_valid(name, ZFS_TYPE_DATASET))
959 return (BE_ERR_INVALIDNAME);
961 return (BE_ERR_SUCCESS);
969 be_rename(libbe_handle_t *lbh, const char *old, const char *new)
971 char full_old[BE_MAXPATHLEN];
972 char full_new[BE_MAXPATHLEN];
973 zfs_handle_t *zfs_hdl;
977 * be_validate_name is documented not to set error state, so we should
980 if ((err = be_validate_name(lbh, new)) != 0)
981 return (set_error(lbh, err));
982 if ((err = be_root_concat(lbh, old, full_old)) != 0)
983 return (set_error(lbh, err));
984 if ((err = be_root_concat(lbh, new, full_new)) != 0)
985 return (set_error(lbh, err));
987 if (!zfs_dataset_exists(lbh->lzh, full_old, ZFS_TYPE_DATASET))
988 return (set_error(lbh, BE_ERR_NOENT));
990 if (zfs_dataset_exists(lbh->lzh, full_new, ZFS_TYPE_DATASET))
991 return (set_error(lbh, BE_ERR_EXISTS));
993 if ((zfs_hdl = zfs_open(lbh->lzh, full_old,
994 ZFS_TYPE_FILESYSTEM)) == NULL)
995 return (set_error(lbh, BE_ERR_ZFSOPEN));
997 /* recurse, nounmount, forceunmount */
998 struct renameflags flags = {
1002 err = zfs_rename(zfs_hdl, NULL, full_new, flags);
1006 return (set_error(lbh, BE_ERR_UNKNOWN));
1012 be_export(libbe_handle_t *lbh, const char *bootenv, int fd)
1014 char snap_name[BE_MAXPATHLEN];
1015 char buf[BE_MAXPATHLEN];
1017 sendflags_t flags = { 0 };
1020 if ((err = be_snapshot(lbh, bootenv, NULL, true, snap_name)) != 0)
1021 /* Use the error set by be_snapshot */
1024 be_root_concat(lbh, snap_name, buf);
1026 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_DATASET)) == NULL)
1027 return (set_error(lbh, BE_ERR_ZFSOPEN));
1029 err = zfs_send_one(zfs, NULL, fd, flags);
1037 be_import(libbe_handle_t *lbh, const char *bootenv, int fd)
1039 char buf[BE_MAXPATHLEN];
1042 recvflags_t flags = { .nomount = 1 };
1045 be_root_concat(lbh, bootenv, buf);
1047 if ((err = zfs_receive(lbh->lzh, buf, NULL, &flags, fd, NULL)) != 0) {
1050 return (set_error(lbh, BE_ERR_NOORIGIN));
1052 return (set_error(lbh, BE_ERR_NOENT));
1054 return (set_error(lbh, BE_ERR_IO));
1056 return (set_error(lbh, BE_ERR_UNKNOWN));
1060 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_FILESYSTEM)) == NULL)
1061 return (set_error(lbh, BE_ERR_ZFSOPEN));
1063 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
1064 nvlist_add_string(props, "canmount", "noauto");
1065 nvlist_add_string(props, "mountpoint", "none");
1067 err = zfs_prop_set_list(zfs, props);
1073 return (set_error(lbh, BE_ERR_UNKNOWN));
1080 be_create_child_noent(libbe_handle_t *lbh, const char *active,
1081 const char *child_path)
1087 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
1088 nvlist_add_string(props, "canmount", "noauto");
1089 nvlist_add_string(props, "mountpoint", child_path);
1092 if ((err = zfs_create(lbh->lzh, active, ZFS_TYPE_DATASET,
1096 return (set_error(lbh, BE_ERR_EXISTS));
1098 return (set_error(lbh, BE_ERR_NOENT));
1100 case EZFS_BADVERSION:
1101 return (set_error(lbh, BE_ERR_NOPOOL));
1104 /* We set something up wrong, probably... */
1105 return (set_error(lbh, BE_ERR_UNKNOWN));
1110 if ((zfs = zfs_open(lbh->lzh, active, ZFS_TYPE_DATASET)) == NULL)
1111 return (set_error(lbh, BE_ERR_ZFSOPEN));
1114 if ((err = zfs_prop_set(zfs, "canmount", "noauto")) != 0) {
1117 * Similar to other cases, this shouldn't fail unless we've
1118 * done something wrong. This is a new dataset that shouldn't
1119 * have been mounted anywhere between creation and now.
1121 if (err == EZFS_NOMEM)
1122 return (set_error(lbh, BE_ERR_NOMEM));
1123 return (set_error(lbh, BE_ERR_UNKNOWN));
1126 return (BE_ERR_SUCCESS);
1130 be_create_child_cloned(libbe_handle_t *lbh, const char *active)
1132 char buf[BE_MAXPATHLEN], tmp[BE_MAXPATHLEN];;
1139 * Establish if the existing path is a zfs dataset or just
1140 * the subdirectory of one
1142 strlcpy(tmp, "tmp/be_snap.XXXXX", sizeof(tmp));
1143 if (mktemp(tmp) == NULL)
1144 return (set_error(lbh, BE_ERR_UNKNOWN));
1146 be_root_concat(lbh, tmp, buf);
1147 printf("Here %s?\n", buf);
1148 if ((err = zfs_snapshot(lbh->lzh, buf, false, NULL)) != 0) {
1150 case EZFS_INVALIDNAME:
1151 return (set_error(lbh, BE_ERR_INVALIDNAME));
1155 * The other errors that zfs_ioc_snapshot might return
1156 * shouldn't happen if we've set things up properly, so
1157 * we'll gloss over them and call it UNKNOWN as it will
1158 * require further triage.
1160 if (errno == ENOTSUP)
1161 return (set_error(lbh, BE_ERR_NOPOOL));
1162 return (set_error(lbh, BE_ERR_UNKNOWN));
1167 if ((zfs = zfs_open(lbh->lzh, buf, ZFS_TYPE_SNAPSHOT)) == NULL)
1168 return (BE_ERR_ZFSOPEN);
1170 if ((err = zfs_clone(zfs, active, NULL)) != 0)
1171 /* XXX TODO correct error */
1172 return (set_error(lbh, BE_ERR_UNKNOWN));
1176 return (BE_ERR_SUCCESS);
1180 be_add_child(libbe_handle_t *lbh, const char *child_path, bool cp_if_exists)
1183 char active[BE_MAXPATHLEN], buf[BE_MAXPATHLEN];
1187 /* Require absolute paths */
1188 if (*child_path != '/')
1189 return (set_error(lbh, BE_ERR_BADPATH));
1191 strlcpy(active, be_active_path(lbh), BE_MAXPATHLEN);
1192 strcpy(buf, active);
1194 /* Create non-mountable parent dataset(s) */
1196 for (char *p; (p = strchr(s+1, '/')) != NULL; s = p) {
1198 strncat(buf, s, len);
1200 nvlist_alloc(&props, NV_UNIQUE_NAME, KM_SLEEP);
1201 nvlist_add_string(props, "canmount", "off");
1202 nvlist_add_string(props, "mountpoint", "none");
1203 zfs_create(lbh->lzh, buf, ZFS_TYPE_DATASET, props);
1207 /* Path does not exist as a descendent of / yet */
1208 if (strlcat(active, child_path, BE_MAXPATHLEN) >= BE_MAXPATHLEN)
1209 return (set_error(lbh, BE_ERR_PATHLEN));
1211 if (stat(child_path, &sb) != 0) {
1212 /* Verify that error is ENOENT */
1213 if (errno != ENOENT)
1214 return (set_error(lbh, BE_ERR_UNKNOWN));
1215 return (be_create_child_noent(lbh, active, child_path));
1216 } else if (cp_if_exists)
1217 /* Path is already a descendent of / and should be copied */
1218 return (be_create_child_cloned(lbh, active));
1219 return (set_error(lbh, BE_ERR_EXISTS));
1224 be_set_nextboot(libbe_handle_t *lbh, nvlist_t *config, uint64_t pool_guid,
1231 if (nvlist_lookup_nvlist_array(config, ZPOOL_CONFIG_CHILDREN, &child,
1233 for (c = 0; c < children; ++c)
1234 if (be_set_nextboot(lbh, child[c], pool_guid, zfsdev) != 0)
1239 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_GUID,
1244 if (zpool_nextboot(lbh->lzh, pool_guid, vdev_guid, zfsdev) != 0) {
1245 perror("ZFS_IOC_NEXTBOOT failed");
1253 * Deactivate old BE dataset; currently just sets canmount=noauto
1256 be_deactivate(libbe_handle_t *lbh, const char *ds)
1260 if ((zfs = zfs_open(lbh->lzh, ds, ZFS_TYPE_DATASET)) == NULL)
1262 if (zfs_prop_set(zfs, "canmount", "noauto") != 0)
1269 be_activate(libbe_handle_t *lbh, const char *bootenv, bool temporary)
1271 char be_path[BE_MAXPATHLEN];
1272 char buf[BE_MAXPATHLEN];
1273 nvlist_t *config, *dsprops, *vdevs;
1279 be_root_concat(lbh, bootenv, be_path);
1281 /* Note: be_exists fails if mountpoint is not / */
1282 if ((err = be_exists(lbh, be_path)) != 0)
1283 return (set_error(lbh, err));
1286 config = zpool_get_config(lbh->active_phandle, NULL);
1288 /* config should be fetchable... */
1289 return (set_error(lbh, BE_ERR_UNKNOWN));
1291 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID,
1293 /* Similarly, it shouldn't be possible */
1294 return (set_error(lbh, BE_ERR_UNKNOWN));
1296 /* Expected format according to zfsbootcfg(8) man */
1297 snprintf(buf, sizeof(buf), "zfs:%s:", be_path);
1299 /* We have no config tree */
1300 if (nvlist_lookup_nvlist(config, ZPOOL_CONFIG_VDEV_TREE,
1302 return (set_error(lbh, BE_ERR_NOPOOL));
1304 return (be_set_nextboot(lbh, vdevs, pool_guid, buf));
1306 if (be_deactivate(lbh, lbh->bootfs) != 0)
1309 /* Obtain bootenv zpool */
1310 err = zpool_set_prop(lbh->active_phandle, "bootfs", be_path);
1314 zhp = zfs_open(lbh->lzh, be_path, ZFS_TYPE_FILESYSTEM);
1318 if (be_prop_list_alloc(&dsprops) != 0)
1321 if (be_get_dataset_props(lbh, be_path, dsprops) != 0) {
1322 nvlist_free(dsprops);
1326 if (nvlist_lookup_string(dsprops, "origin", &origin) == 0)
1327 err = zfs_promote(zhp);
1328 nvlist_free(dsprops);
1336 return (BE_ERR_SUCCESS);