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/param.h>
31 #include <sys/mount.h>
46 #define HEADER_BE "BE"
47 #define HEADER_ACTIVE "Active"
48 #define HEADER_MOUNT "Mountpoint"
49 #define HEADER_SPACE "Space"
50 #define HEADER_CREATED "Created"
52 static int bectl_cmd_activate(int argc, char *argv[]);
53 static int bectl_cmd_create(int argc, char *argv[]);
54 static int bectl_cmd_destroy(int argc, char *argv[]);
55 static int bectl_cmd_export(int argc, char *argv[]);
56 static int bectl_cmd_import(int argc, char *argv[]);
57 static int bectl_cmd_add(int argc, char *argv[]);
58 static int bectl_cmd_jail(int argc, char *argv[]);
59 static int bectl_cmd_list(int argc, char *argv[]);
60 static int bectl_cmd_mount(int argc, char *argv[]);
61 static int bectl_cmd_rename(int argc, char *argv[]);
62 static int bectl_search_jail_paths(const char *mnt);
63 static int bectl_locate_jail(const char *ident);
64 static int bectl_cmd_unjail(int argc, char *argv[]);
65 static int bectl_cmd_unmount(int argc, char *argv[]);
67 static libbe_handle_t *be;
74 fp = explicit ? stdout : stderr;
76 "usage:\tbectl ( -h | -? | subcommand [args...] )\n"
77 "\tbectl activate [-t] beName\n"
78 "\tbectl create [-e nonActiveBe | -e beName@snapshot] beName\n"
79 "\tbectl create beName@snapshot\n"
80 "\tbectl destroy [-F] beName | beName@snapshot⟩\n"
81 "\tbectl export sourceBe\n"
82 "\tbectl import targetBe\n"
83 "\tbectl add (path)*\n"
84 "\tbectl jail bootenv\n"
85 "\tbectl list [-a] [-D] [-H] [-s]\n"
86 "\tbectl mount beName [mountpoint]\n"
87 "\tbectl rename origBeName newBeName\n"
88 "\tbectl { ujail | unjail } ⟨jailID | jailName | bootenv)\n"
89 "\tbectl { umount | unmount } [-f] beName\n");
91 return (explicit ? 0 : EX_USAGE);
96 * Represents a relationship between the command name and the parser action
99 struct command_map_entry {
101 int (*fn)(int argc, char *argv[]);
104 static struct command_map_entry command_map[] =
106 { "activate", bectl_cmd_activate },
107 { "create", bectl_cmd_create },
108 { "destroy", bectl_cmd_destroy },
109 { "export", bectl_cmd_export },
110 { "import", bectl_cmd_import },
111 { "add", bectl_cmd_add },
112 { "jail", bectl_cmd_jail },
113 { "list", bectl_cmd_list },
114 { "mount", bectl_cmd_mount },
115 { "rename", bectl_cmd_rename },
116 { "unjail", bectl_cmd_unjail },
117 { "unmount", bectl_cmd_unmount },
121 get_cmd_index(const char *cmd, int *index)
125 map_size = nitems(command_map);
126 for (int i = 0; i < map_size; ++i) {
127 if (strcmp(cmd, command_map[i].command) == 0) {
138 bectl_cmd_activate(int argc, char *argv[])
144 while ((opt = getopt(argc, argv, "t")) != -1) {
150 fprintf(stderr, "bectl activate: unknown option '-%c'\n",
152 return (usage(false));
160 fprintf(stderr, "bectl activate: wrong number of arguments\n");
161 return (usage(false));
165 /* activate logic goes here */
166 if ((err = be_activate(be, argv[0], temp)) != 0)
167 /* XXX TODO: more specific error msg based on err */
168 printf("did not successfully activate boot environment %s\n",
171 printf("successfully activated boot environment %s\n", argv[0]);
174 printf("for next boot\n");
181 * TODO: when only one arg is given, and it contains an "@" the this should
182 * create that snapshot
185 bectl_cmd_create(int argc, char *argv[])
187 char *bootenv, *snapname, *source;
191 while ((opt = getopt(argc, argv, "e:")) != -1) {
197 fprintf(stderr, "bectl create: unknown option '-%c'\n",
199 return (usage(false));
207 fprintf(stderr, "bectl create: wrong number of arguments\n");
208 return (usage(false));
213 if (snapname != NULL) {
214 if (strchr(snapname, '@') != NULL)
215 err = be_create_from_existing_snap(be, bootenv,
218 err = be_create_from_existing(be, bootenv, snapname);
220 if ((snapname = strchr(bootenv, '@')) != NULL) {
221 *(snapname++) = '\0';
222 if ((err = be_snapshot(be, be_active_path(be),
223 snapname, true, NULL)) != BE_ERR_SUCCESS)
224 fprintf(stderr, "failed to create snapshot\n");
225 asprintf(&source, "%s@%s", be_active_path(be), snapname);
226 err = be_create_from_existing_snap(be, bootenv,
230 err = be_create(be, bootenv);
237 if (snapname == NULL)
239 "failed to create bootenv %s\n", bootenv);
242 "failed to create bootenv %s from snapshot %s\n",
251 bectl_cmd_export(int argc, char *argv[])
256 fprintf(stderr, "bectl export: missing boot environment name\n");
257 return (usage(false));
261 fprintf(stderr, "bectl export: extra arguments provided\n");
262 return (usage(false));
267 if (isatty(STDOUT_FILENO)) {
268 fprintf(stderr, "bectl export: must redirect output\n");
272 be_export(be, bootenv, STDOUT_FILENO);
279 bectl_cmd_import(int argc, char *argv[])
285 fprintf(stderr, "bectl import: missing boot environment name\n");
286 return (usage(false));
290 fprintf(stderr, "bectl import: extra arguments provided\n");
291 return (usage(false));
296 if (isatty(STDIN_FILENO)) {
297 fprintf(stderr, "bectl import: input can not be from terminal\n");
301 err = be_import(be, bootenv, STDIN_FILENO);
308 bectl_cmd_add(int argc, char *argv[])
312 fprintf(stderr, "bectl add: must provide at least one path\n");
313 return (usage(false));
316 for (int i = 1; i < argc; ++i) {
317 printf("arg %d: %s\n", i, argv[i]);
318 /* XXX TODO catch err */
319 be_add_child(be, argv[i], true);
327 bectl_cmd_destroy(int argc, char *argv[])
334 while ((opt = getopt(argc, argv, "F")) != -1) {
340 fprintf(stderr, "bectl destroy: unknown option '-%c'\n",
342 return (usage(false));
350 fprintf(stderr, "bectl destroy: wrong number of arguments\n");
351 return (usage(false));
356 err = be_destroy(be, target, force);
363 bectl_cmd_jail(int argc, char *argv[])
366 char mnt_loc[BE_MAXPATHLEN];
369 /* struct jail be_jail = { 0 }; */
372 fprintf(stderr, "bectl jail: missing boot environment name\n");
373 return (usage(false));
376 fprintf(stderr, "bectl jail: too many arguments\n");
377 return (usage(false));
383 * XXX TODO: if its already mounted, perhaps there should be a flag to
384 * indicate its okay to proceed??
386 if ((err = be_mount(be, bootenv, NULL, 0, mnt_loc)) != BE_ERR_SUCCESS) {
387 fprintf(stderr, "could not mount bootenv\n");
391 /* XXX TODO: Make the IP/hostname configurable? */
392 jid = jail_setv(JAIL_CREATE | JAIL_ATTACH,
395 "host.hostname", bootenv,
397 "ip4.addr", "10.20.30.40",
398 "allow.mount", "true",
399 "allow.mount.devfs", "true",
400 "enforce_statfs", "1",
403 fprintf(stderr, "unable to create jail. error: %d\n", errno);
407 /* We're attached within the jail... good bye! */
409 execl("/bin/sh", "/bin/sh", NULL);
415 bectl_cmd_list(int argc, char *argv[])
419 nvlist_t *props, *dsprops;
420 unsigned long long ctimenum, space;
422 int active_colsz, active_colsz_def, be_colsz, mount_colsz, opt, space_colsz;
423 char buf[BUFSZ], *creation, *mnt, *spacestr;
424 boolean_t active_now, active_reboot;
425 bool show_all_datasets, show_space, hide_headers, show_snaps;
428 show_all_datasets = show_space = hide_headers = show_snaps = false;
429 while ((opt = getopt(argc, argv, "aDHs")) != -1) {
432 show_all_datasets = true;
444 fprintf(stderr, "bectl list: unknown option '-%c'\n",
446 return (usage(false));
453 fprintf(stderr, "bectl list: extra argument provided\n");
454 return (usage(false));
457 if (be_prop_list_alloc(&props) != 0) {
458 fprintf(stderr, "bectl list: failed to allocate prop nvlist\n");
461 if (be_get_bootenv_props(be, props) != 0) {
462 /* XXX TODO: Real errors */
463 fprintf(stderr, "bectl list: failed to fetch boot environments\n");
467 be_maxcol = strlen(HEADER_BE);
468 for (cur = nvlist_next_nvpair(props, NULL); cur != NULL;
469 cur = nvlist_next_nvpair(props, cur)) {
470 be_maxcol = MAX(be_maxcol, strlen(nvpair_name(cur)));
473 be_colsz = -be_maxcol;
474 /* To be made negative after calculating final col sz */
475 active_colsz_def = strlen(HEADER_ACTIVE);
476 mount_colsz = -(int)strlen(HEADER_MOUNT);
477 space_colsz = -(int)strlen(HEADER_SPACE);
478 printf("%*s %s %s %s %s\n", be_colsz, HEADER_BE, HEADER_ACTIVE,
479 HEADER_MOUNT, HEADER_SPACE, HEADER_CREATED);
482 for (cur = nvlist_next_nvpair(props, NULL); cur != NULL;
483 cur = nvlist_next_nvpair(props, cur)) {
484 printf("%*s ", be_colsz, nvpair_name(cur));
486 active_colsz = active_colsz_def;
487 nvpair_value_nvlist(cur, &dsprops);
488 if (nvlist_lookup_boolean_value(dsprops, "active",
489 &active_now) == 0 && active_now) {
493 if (nvlist_lookup_boolean_value(dsprops, "nextboot",
494 &active_reboot) == 0 && active_reboot) {
498 if (active_colsz == active_colsz_def) {
502 printf("%*s ", -active_colsz, " ");
503 if (nvlist_lookup_string(dsprops, "mountpoint", &mnt) == 0)
504 printf("%*s ", mount_colsz, mnt);
506 printf("%*s ", mount_colsz, "-");
508 if (nvlist_lookup_string(dsprops, "used", &spacestr) == 0) {
509 space = strtoull(spacestr, NULL, 10);
510 humanize_number(buf, 6, space, "", HN_AUTOSCALE,
511 HN_DECIMAL | HN_NOSPACE | HN_B);
512 printf("%*s ", space_colsz, buf);
514 printf("%*s ", space_colsz, "-");
516 if (nvlist_lookup_string(dsprops, "creation", &creation) == 0) {
517 ctimenum = strtoull(creation, NULL, 10);
518 strftime(buf, BUFSZ, "%Y-%m-%d %H:%M",
519 localtime((time_t *)&ctimenum));
526 be_prop_list_free(props);
534 bectl_cmd_mount(int argc, char *argv[])
536 char result_loc[BE_MAXPATHLEN];
537 char *bootenv, *mountpoint;
541 fprintf(stderr, "bectl mount: missing argument(s)\n");
542 return (usage(false));
546 fprintf(stderr, "bectl mount: too many arguments\n");
547 return (usage(false));
551 mountpoint = ((argc == 3) ? argv[2] : NULL);
553 err = be_mount(be, bootenv, mountpoint, 0, result_loc);
557 printf("successfully mounted %s at %s\n", bootenv, result_loc);
561 (argc == 3) ? "failed to mount bootenv %s at %s\n" :
562 "failed to mount bootenv %s at temporary path %s\n",
563 bootenv, mountpoint);
571 bectl_cmd_rename(int argc, char *argv[])
577 fprintf(stderr, "bectl rename: missing argument\n");
578 return (usage(false));
582 fprintf(stderr, "bectl rename: too many arguments\n");
583 return (usage(false));
589 err = be_rename(be, src, dest);
595 fprintf(stderr, "failed to rename bootenv %s to %s\n",
603 bectl_search_jail_paths(const char *mnt)
605 char jailpath[MAXPATHLEN + 1];
610 while ((jid = jail_getv(0, "lastjid", &jid, "path", &jailpath,
612 if (strcmp(jailpath, mnt) == 0)
620 * Locate a jail based on an arbitrary identifier. This may be either a name,
621 * a jid, or a BE name. Returns the jid or -1 on failure.
624 bectl_locate_jail(const char *ident)
626 nvlist_t *belist, *props;
630 /* Try the easy-match first */
631 jid = jail_getid(ident);
635 /* Attempt to try it as a BE name, first */
636 if (be_prop_list_alloc(&belist) != 0)
639 if (be_get_bootenv_props(be, belist) != 0)
642 if (nvlist_lookup_nvlist(belist, ident, &props) == 0) {
643 /* We'll attempt to resolve the jid by way of mountpoint */
644 if (nvlist_lookup_string(props, "mountpoint", &mnt) == 0) {
645 jid = bectl_search_jail_paths(mnt);
646 be_prop_list_free(belist);
650 be_prop_list_free(belist);
657 bectl_cmd_unjail(int argc, char *argv[])
659 char path[MAXPATHLEN + 1];
660 char *cmd, *name, *target;
663 /* Store alias used */
667 fprintf(stderr, "bectl %s: wrong number of arguments\n", cmd);
668 return (usage(false));
673 /* Locate the jail */
674 if ((jid = bectl_locate_jail(target)) == -1) {
675 fprintf(stderr, "bectl %s: failed to locate BE by '%s'\n", cmd, target);
679 bzero(&path, MAXPATHLEN + 1);
680 name = jail_getname(jid);
681 if (jail_getv(0, "name", name, "path", path, NULL) != jid) {
683 fprintf(stderr, "bectl %s: failed to get path for jail requested by '%s'\n", cmd, target);
689 if (be_mounted_at(be, path, NULL) != 0) {
690 fprintf(stderr, "bectl %s: jail requested by '%s' not a BE\n", cmd, target);
702 bectl_cmd_unmount(int argc, char *argv[])
707 /* Store alias used */
711 while ((opt = getopt(argc, argv, "f")) != -1) {
714 flags |= BE_MNT_FORCE;
717 fprintf(stderr, "bectl %s: unknown option '-%c'\n",
719 return (usage(false));
727 fprintf(stderr, "bectl %s: wrong number of arguments\n", cmd);
728 return (usage(false));
733 err = be_unmount(be, bootenv, flags);
739 fprintf(stderr, "failed to unmount bootenv %s\n", bootenv);
747 main(int argc, char *argv[])
750 int command_index, rc;
753 fprintf(stderr, "missing command\n");
754 return (usage(false));
759 /* Handle command aliases */
760 if (strcmp(command, "umount") == 0)
763 if (strcmp(command, "ujail") == 0)
766 if ((strcmp(command, "-?") == 0) || (strcmp(command, "-h") == 0))
767 return (usage(true));
769 if (get_cmd_index(command, &command_index)) {
770 fprintf(stderr, "unknown command: %s\n", command);
771 return (usage(false));
775 if ((be = libbe_init()) == NULL)
778 libbe_print_on_error(be, true);
780 /* XXX TODO: can be simplified if offset by 2 instead of one */
781 rc = command_map[command_index].fn(argc-1, argv+1);