1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/mount.h> 34 #include <errno.h> 35 #include <libutil.h> 36 #include <stdbool.h> 37 #include <stdio.h> 38 #include <stdint.h> 39 #include <stdlib.h> 40 #include <string.h> 41 #include <sysexits.h> 42 #include <time.h> 43 #include <unistd.h> 44 45 #include <be.h> 46 47 #include "bectl.h" 48 49 static int bectl_cmd_activate(int argc, char *argv[]); 50 static int bectl_cmd_create(int argc, char *argv[]); 51 static int bectl_cmd_destroy(int argc, char *argv[]); 52 static int bectl_cmd_export(int argc, char *argv[]); 53 static int bectl_cmd_import(int argc, char *argv[]); 54 #if SOON 55 static int bectl_cmd_add(int argc, char *argv[]); 56 #endif 57 static int bectl_cmd_mount(int argc, char *argv[]); 58 static int bectl_cmd_rename(int argc, char *argv[]); 59 static int bectl_cmd_unmount(int argc, char *argv[]); 60 61 libbe_handle_t *be; 62 63 int 64 usage(bool explicit) 65 { 66 FILE *fp; 67 68 fp = explicit ? stdout : stderr; 69 fprintf(fp, "%s", 70 "usage:\tbectl {-h | -? | subcommand [args...]}\n" 71 #if SOON 72 "\tbectl add (path)*\n" 73 #endif 74 "\tbectl activate [-t] beName\n" 75 "\tbectl create [-r] [-e {nonActiveBe | beName@snapshot}] beName\n" 76 "\tbectl create [-r] beName@snapshot\n" 77 "\tbectl destroy [-F] {beName | beName@snapshot}\n" 78 "\tbectl export sourceBe\n" 79 "\tbectl import targetBe\n" 80 "\tbectl jail {-b | -U} [{-o key=value | -u key}]... " 81 "{jailID | jailName}\n" 82 "\t bootenv [utility [argument ...]]\n" 83 "\tbectl list [-DHas]\n" 84 "\tbectl mount beName [mountpoint]\n" 85 "\tbectl rename origBeName newBeName\n" 86 "\tbectl {ujail | unjail} {jailID | jailName} bootenv\n" 87 "\tbectl {umount | unmount} [-f] beName\n"); 88 89 return (explicit ? 0 : EX_USAGE); 90 } 91 92 93 /* 94 * Represents a relationship between the command name and the parser action 95 * that handles it. 96 */ 97 struct command_map_entry { 98 const char *command; 99 int (*fn)(int argc, char *argv[]); 100 }; 101 102 static struct command_map_entry command_map[] = 103 { 104 { "activate", bectl_cmd_activate }, 105 { "create", bectl_cmd_create }, 106 { "destroy", bectl_cmd_destroy }, 107 { "export", bectl_cmd_export }, 108 { "import", bectl_cmd_import }, 109 #if SOON 110 { "add", bectl_cmd_add }, 111 #endif 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 }, 118 }; 119 120 static int 121 get_cmd_index(const char *cmd, int *idx) 122 { 123 int map_size; 124 125 map_size = nitems(command_map); 126 for (int i = 0; i < map_size; ++i) { 127 if (strcmp(cmd, command_map[i].command) == 0) { 128 *idx = i; 129 return (0); 130 } 131 } 132 133 return (1); 134 } 135 136 137 static int 138 bectl_cmd_activate(int argc, char *argv[]) 139 { 140 int err, opt; 141 bool temp; 142 143 temp = false; 144 while ((opt = getopt(argc, argv, "t")) != -1) { 145 switch (opt) { 146 case 't': 147 temp = true; 148 break; 149 default: 150 fprintf(stderr, "bectl activate: unknown option '-%c'\n", 151 optopt); 152 return (usage(false)); 153 } 154 } 155 156 argc -= optind; 157 argv += optind; 158 159 if (argc != 1) { 160 fprintf(stderr, "bectl activate: wrong number of arguments\n"); 161 return (usage(false)); 162 } 163 164 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", 169 argv[0]); 170 else 171 printf("successfully activated boot environment %s\n", argv[0]); 172 173 if (temp) 174 printf("for next boot\n"); 175 176 return (err); 177 } 178 179 180 /* 181 * TODO: when only one arg is given, and it contains an "@" the this should 182 * create that snapshot 183 */ 184 static int 185 bectl_cmd_create(int argc, char *argv[]) 186 { 187 char *atpos, *bootenv, *snapname, *source; 188 int err, opt; 189 bool recursive; 190 191 snapname = NULL; 192 recursive = false; 193 while ((opt = getopt(argc, argv, "e:r")) != -1) { 194 switch (opt) { 195 case 'e': 196 snapname = optarg; 197 break; 198 case 'r': 199 recursive = true; 200 break; 201 default: 202 fprintf(stderr, "bectl create: unknown option '-%c'\n", 203 optopt); 204 return (usage(false)); 205 } 206 } 207 208 argc -= optind; 209 argv += optind; 210 211 if (argc != 1) { 212 fprintf(stderr, "bectl create: wrong number of arguments\n"); 213 return (usage(false)); 214 } 215 216 bootenv = *argv; 217 if ((atpos = strchr(bootenv, '@')) != NULL) { 218 /* 219 * This is the "create a snapshot variant". No new boot 220 * environment is to be created here. 221 */ 222 *atpos++ = '\0'; 223 err = be_snapshot(be, bootenv, atpos, recursive, NULL); 224 } else if (snapname != NULL) { 225 if (strchr(snapname, '@') != NULL) 226 err = be_create_from_existing_snap(be, bootenv, 227 snapname); 228 else 229 err = be_create_from_existing(be, bootenv, snapname); 230 } else { 231 if ((snapname = strchr(bootenv, '@')) != NULL) { 232 *(snapname++) = '\0'; 233 if ((err = be_snapshot(be, be_active_path(be), 234 snapname, true, NULL)) != BE_ERR_SUCCESS) 235 fprintf(stderr, "failed to create snapshot\n"); 236 asprintf(&source, "%s@%s", be_active_path(be), snapname); 237 err = be_create_from_existing_snap(be, bootenv, 238 source); 239 return (err); 240 } else 241 err = be_create(be, bootenv); 242 } 243 244 switch (err) { 245 case BE_ERR_SUCCESS: 246 break; 247 default: 248 if (atpos != NULL) 249 fprintf(stderr, 250 "failed to create a snapshot '%s' of '%s'\n", 251 atpos, bootenv); 252 else if (snapname == NULL) 253 fprintf(stderr, 254 "failed to create bootenv %s\n", bootenv); 255 else 256 fprintf(stderr, 257 "failed to create bootenv %s from snapshot %s\n", 258 bootenv, snapname); 259 } 260 261 return (err); 262 } 263 264 265 static int 266 bectl_cmd_export(int argc, char *argv[]) 267 { 268 char *bootenv; 269 270 if (argc == 1) { 271 fprintf(stderr, "bectl export: missing boot environment name\n"); 272 return (usage(false)); 273 } 274 275 if (argc > 2) { 276 fprintf(stderr, "bectl export: extra arguments provided\n"); 277 return (usage(false)); 278 } 279 280 bootenv = argv[1]; 281 282 if (isatty(STDOUT_FILENO)) { 283 fprintf(stderr, "bectl export: must redirect output\n"); 284 return (EX_USAGE); 285 } 286 287 be_export(be, bootenv, STDOUT_FILENO); 288 289 return (0); 290 } 291 292 293 static int 294 bectl_cmd_import(int argc, char *argv[]) 295 { 296 char *bootenv; 297 int err; 298 299 if (argc == 1) { 300 fprintf(stderr, "bectl import: missing boot environment name\n"); 301 return (usage(false)); 302 } 303 304 if (argc > 2) { 305 fprintf(stderr, "bectl import: extra arguments provided\n"); 306 return (usage(false)); 307 } 308 309 bootenv = argv[1]; 310 311 if (isatty(STDIN_FILENO)) { 312 fprintf(stderr, "bectl import: input can not be from terminal\n"); 313 return (EX_USAGE); 314 } 315 316 err = be_import(be, bootenv, STDIN_FILENO); 317 318 return (err); 319 } 320 321 #if SOON 322 static int 323 bectl_cmd_add(int argc, char *argv[]) 324 { 325 326 if (argc < 2) { 327 fprintf(stderr, "bectl add: must provide at least one path\n"); 328 return (usage(false)); 329 } 330 331 for (int i = 1; i < argc; ++i) { 332 printf("arg %d: %s\n", i, argv[i]); 333 /* XXX TODO catch err */ 334 be_add_child(be, argv[i], true); 335 } 336 337 return (0); 338 } 339 #endif 340 341 static int 342 bectl_cmd_destroy(int argc, char *argv[]) 343 { 344 char *target; 345 int opt, err; 346 bool force; 347 348 force = false; 349 while ((opt = getopt(argc, argv, "F")) != -1) { 350 switch (opt) { 351 case 'F': 352 force = true; 353 break; 354 default: 355 fprintf(stderr, "bectl destroy: unknown option '-%c'\n", 356 optopt); 357 return (usage(false)); 358 } 359 } 360 361 argc -= optind; 362 argv += optind; 363 364 if (argc != 1) { 365 fprintf(stderr, "bectl destroy: wrong number of arguments\n"); 366 return (usage(false)); 367 } 368 369 target = argv[0]; 370 371 err = be_destroy(be, target, force); 372 373 return (err); 374 } 375 376 static int 377 bectl_cmd_mount(int argc, char *argv[]) 378 { 379 char result_loc[BE_MAXPATHLEN]; 380 char *bootenv, *mountpoint; 381 int err, mntflags; 382 383 /* XXX TODO: Allow shallow */ 384 mntflags = BE_MNT_DEEP; 385 if (argc < 2) { 386 fprintf(stderr, "bectl mount: missing argument(s)\n"); 387 return (usage(false)); 388 } 389 390 if (argc > 3) { 391 fprintf(stderr, "bectl mount: too many arguments\n"); 392 return (usage(false)); 393 } 394 395 bootenv = argv[1]; 396 mountpoint = ((argc == 3) ? argv[2] : NULL); 397 398 err = be_mount(be, bootenv, mountpoint, mntflags, result_loc); 399 400 switch (err) { 401 case BE_ERR_SUCCESS: 402 printf("successfully mounted %s at %s\n", bootenv, result_loc); 403 break; 404 default: 405 fprintf(stderr, 406 (argc == 3) ? "failed to mount bootenv %s at %s\n" : 407 "failed to mount bootenv %s at temporary path %s\n", 408 bootenv, mountpoint); 409 } 410 411 return (err); 412 } 413 414 415 static int 416 bectl_cmd_rename(int argc, char *argv[]) 417 { 418 char *dest, *src; 419 int err; 420 421 if (argc < 3) { 422 fprintf(stderr, "bectl rename: missing argument\n"); 423 return (usage(false)); 424 } 425 426 if (argc > 3) { 427 fprintf(stderr, "bectl rename: too many arguments\n"); 428 return (usage(false)); 429 } 430 431 src = argv[1]; 432 dest = argv[2]; 433 434 err = be_rename(be, src, dest); 435 436 switch (err) { 437 case BE_ERR_SUCCESS: 438 break; 439 default: 440 fprintf(stderr, "failed to rename bootenv %s to %s\n", 441 src, dest); 442 } 443 444 return (0); 445 } 446 447 static int 448 bectl_cmd_unmount(int argc, char *argv[]) 449 { 450 char *bootenv, *cmd; 451 int err, flags, opt; 452 453 /* Store alias used */ 454 cmd = argv[0]; 455 456 flags = 0; 457 while ((opt = getopt(argc, argv, "f")) != -1) { 458 switch (opt) { 459 case 'f': 460 flags |= BE_MNT_FORCE; 461 break; 462 default: 463 fprintf(stderr, "bectl %s: unknown option '-%c'\n", 464 cmd, optopt); 465 return (usage(false)); 466 } 467 } 468 469 argc -= optind; 470 argv += optind; 471 472 if (argc != 1) { 473 fprintf(stderr, "bectl %s: wrong number of arguments\n", cmd); 474 return (usage(false)); 475 } 476 477 bootenv = argv[0]; 478 479 err = be_unmount(be, bootenv, flags); 480 481 switch (err) { 482 case BE_ERR_SUCCESS: 483 break; 484 default: 485 fprintf(stderr, "failed to unmount bootenv %s\n", bootenv); 486 } 487 488 return (err); 489 } 490 491 492 int 493 main(int argc, char *argv[]) 494 { 495 const char *command; 496 char *root; 497 int command_index, rc; 498 499 root = NULL; 500 if (argc < 2) 501 return (usage(false)); 502 503 if (strcmp(argv[1], "-r") == 0) { 504 if (argc < 4) 505 return (usage(false)); 506 root = strdup(argv[2]); 507 command = argv[3]; 508 argc -= 3; 509 argv += 3; 510 } else { 511 command = argv[1]; 512 argc -= 1; 513 argv += 1; 514 } 515 516 /* Handle command aliases */ 517 if (strcmp(command, "umount") == 0) 518 command = "unmount"; 519 520 if (strcmp(command, "ujail") == 0) 521 command = "unjail"; 522 523 if ((strcmp(command, "-?") == 0) || (strcmp(command, "-h") == 0)) 524 return (usage(true)); 525 526 if (get_cmd_index(command, &command_index)) { 527 fprintf(stderr, "unknown command: %s\n", command); 528 return (usage(false)); 529 } 530 531 532 if ((be = libbe_init(root)) == NULL) 533 return (-1); 534 535 libbe_print_on_error(be, true); 536 537 rc = command_map[command_index].fn(argc, argv); 538 539 libbe_close(be); 540 return (rc); 541 } 542