1789Sahrens /* 2789Sahrens * CDDL HEADER START 3789Sahrens * 4789Sahrens * The contents of this file are subject to the terms of the 5789Sahrens * Common Development and Distribution License, Version 1.0 only 6789Sahrens * (the "License"). You may not use this file except in compliance 7789Sahrens * with the License. 8789Sahrens * 9789Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10789Sahrens * or http://www.opensolaris.org/os/licensing. 11789Sahrens * See the License for the specific language governing permissions 12789Sahrens * and limitations under the License. 13789Sahrens * 14789Sahrens * When distributing Covered Code, include this CDDL HEADER in each 15789Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16789Sahrens * If applicable, add the following below this CDDL HEADER, with the 17789Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 18789Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 19789Sahrens * 20789Sahrens * CDDL HEADER END 21789Sahrens */ 22789Sahrens /* 231204Slling * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 24789Sahrens * Use is subject to license terms. 25789Sahrens */ 26789Sahrens 27789Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 28789Sahrens 29789Sahrens #include <assert.h> 30789Sahrens #include <errno.h> 31789Sahrens #include <libgen.h> 32789Sahrens #include <libintl.h> 33789Sahrens #include <libuutil.h> 34789Sahrens #include <locale.h> 35789Sahrens #include <stddef.h> 36789Sahrens #include <stdio.h> 37789Sahrens #include <stdlib.h> 38789Sahrens #include <strings.h> 39789Sahrens #include <unistd.h> 40789Sahrens #include <fcntl.h> 41789Sahrens #include <zone.h> 42789Sahrens #include <sys/mkdev.h> 43789Sahrens #include <sys/mntent.h> 44789Sahrens #include <sys/mnttab.h> 45789Sahrens #include <sys/mount.h> 46789Sahrens #include <sys/stat.h> 47789Sahrens 48789Sahrens #include <libzfs.h> 49789Sahrens 50789Sahrens #include "zfs_iter.h" 51789Sahrens 52789Sahrens static FILE *mnttab_file; 53789Sahrens 54789Sahrens static int zfs_do_clone(int argc, char **argv); 55789Sahrens static int zfs_do_create(int argc, char **argv); 56789Sahrens static int zfs_do_destroy(int argc, char **argv); 57789Sahrens static int zfs_do_get(int argc, char **argv); 58789Sahrens static int zfs_do_inherit(int argc, char **argv); 59789Sahrens static int zfs_do_list(int argc, char **argv); 60789Sahrens static int zfs_do_mount(int argc, char **argv); 61789Sahrens static int zfs_do_rename(int argc, char **argv); 62789Sahrens static int zfs_do_rollback(int argc, char **argv); 63789Sahrens static int zfs_do_set(int argc, char **argv); 64789Sahrens static int zfs_do_snapshot(int argc, char **argv); 65789Sahrens static int zfs_do_unmount(int argc, char **argv); 66789Sahrens static int zfs_do_share(int argc, char **argv); 67789Sahrens static int zfs_do_unshare(int argc, char **argv); 68789Sahrens static int zfs_do_backup(int argc, char **argv); 69789Sahrens static int zfs_do_restore(int argc, char **argv); 70789Sahrens 71789Sahrens /* 72789Sahrens * These libumem hooks provide a reasonable set of defaults for the allocator's 73789Sahrens * debugging facilities. 74789Sahrens */ 75789Sahrens const char * 76789Sahrens _umem_debug_init() 77789Sahrens { 78789Sahrens return ("default,verbose"); /* $UMEM_DEBUG setting */ 79789Sahrens } 80789Sahrens 81789Sahrens const char * 82789Sahrens _umem_logging_init(void) 83789Sahrens { 84789Sahrens return ("fail,contents"); /* $UMEM_LOGGING setting */ 85789Sahrens } 86789Sahrens 87789Sahrens typedef struct zfs_command { 88789Sahrens const char *name; 89789Sahrens int (*func)(int argc, char **argv); 90789Sahrens const char *usage; 91789Sahrens } zfs_command_t; 92789Sahrens 93789Sahrens /* 94789Sahrens * Master command table. Each ZFS command has a name, associated function, and 95789Sahrens * usage message. These commands are organized according to how they are 96789Sahrens * displayed in the usage message. An empty command (one with a NULL name) 97789Sahrens * indicates an empty line in the generic usage message. A command with a NULL 98789Sahrens * usage message indicates an alias for an existing command, and is not 99789Sahrens * displayed in the general usage message. 100789Sahrens */ 101789Sahrens static zfs_command_t command_table[] = { 102789Sahrens { "create", zfs_do_create, 103789Sahrens "\tcreate <filesystem>\n" 104789Sahrens "\tcreate [-s] [-b blocksize] -V <size> <volume>\n" }, 105789Sahrens { "destroy", zfs_do_destroy, 106789Sahrens "\tdestroy [-rRf] <filesystem|volume|snapshot>\n" }, 107789Sahrens { NULL }, 108789Sahrens { "snapshot", zfs_do_snapshot, 109789Sahrens "\tsnapshot <filesystem@name|volume@name>\n" }, 110789Sahrens { "rollback", zfs_do_rollback, 111789Sahrens "\trollback [-rRf] <snapshot>\n" }, 112789Sahrens { "clone", zfs_do_clone, 113789Sahrens "\tclone <snapshot> <filesystem|volume>\n" }, 114789Sahrens { "rename", zfs_do_rename, 1151003Slling "\trename <filesystem|volume|snapshot> " 116789Sahrens "<filesystem|volume|snapshot>\n" }, 117789Sahrens { NULL }, 118789Sahrens { "list", zfs_do_list, 119789Sahrens "\tlist [-rH] [-o property[,property]...] [-t type[,type]...]\n" 120789Sahrens "\t [filesystem|volume|snapshot] ...\n" }, 121789Sahrens { NULL }, 122789Sahrens { "set", zfs_do_set, 123789Sahrens "\tset <property=value> <filesystem|volume> ...\n" }, 124789Sahrens { "get", zfs_do_get, 125789Sahrens "\tget [-rHp] [-o field[,field]...] [-s source[,source]...]\n" 126789Sahrens "\t <all | property[,property]...> " 127789Sahrens "<filesystem|volume|snapshot> ...\n" }, 128789Sahrens { "inherit", zfs_do_inherit, 129789Sahrens "\tinherit [-r] <property> <filesystem|volume> ...\n" }, 130789Sahrens { NULL }, 131789Sahrens { "mount", zfs_do_mount, 132789Sahrens "\tmount\n" 133789Sahrens "\tmount [-o opts] [-O] -a\n" 134789Sahrens "\tmount [-o opts] [-O] <filesystem>\n" }, 135789Sahrens { NULL }, 136789Sahrens { "unmount", zfs_do_unmount, 137789Sahrens "\tunmount [-f] -a\n" 138789Sahrens "\tunmount [-f] <filesystem|mountpoint>\n" }, 139789Sahrens { NULL }, 140789Sahrens { "share", zfs_do_share, 141789Sahrens "\tshare -a\n" 142789Sahrens "\tshare <filesystem>\n" }, 143789Sahrens { NULL }, 144789Sahrens { "unshare", zfs_do_unshare, 145789Sahrens "\tunshare [-f] -a\n" 146789Sahrens "\tunshare [-f] <filesystem|mountpoint>\n" }, 147789Sahrens { NULL }, 148789Sahrens { "backup", zfs_do_backup, 149789Sahrens "\tbackup [-i <snapshot>] <snapshot>\n" }, 150789Sahrens { "restore", zfs_do_restore, 151789Sahrens "\trestore [-vn] <filesystem|volume|snapshot>\n" 152789Sahrens "\trestore [-vn] -d <filesystem>\n" }, 153789Sahrens }; 154789Sahrens 155789Sahrens #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0])) 156789Sahrens 157789Sahrens zfs_command_t *current_command; 158789Sahrens 159789Sahrens /* 160789Sahrens * Utility function to guarantee malloc() success. 161789Sahrens */ 162789Sahrens void * 163789Sahrens safe_malloc(size_t size) 164789Sahrens { 165789Sahrens void *data; 166789Sahrens 167789Sahrens if ((data = calloc(1, size)) == NULL) { 168789Sahrens (void) fprintf(stderr, "internal error: out of memory\n"); 169789Sahrens exit(1); 170789Sahrens } 171789Sahrens 172789Sahrens return (data); 173789Sahrens } 174789Sahrens 175789Sahrens /* 176789Sahrens * Display usage message. If we're inside a command, display only the usage for 177789Sahrens * that command. Otherwise, iterate over the entire command table and display 178789Sahrens * a complete usage message. 179789Sahrens */ 180789Sahrens static void 181789Sahrens usage(int requested) 182789Sahrens { 183789Sahrens int i; 184789Sahrens int show_properties = FALSE; 185789Sahrens FILE *fp = requested ? stdout : stderr; 186789Sahrens 187789Sahrens if (current_command == NULL) { 188789Sahrens 189789Sahrens (void) fprintf(fp, gettext("usage: zfs command args ...\n")); 190789Sahrens (void) fprintf(fp, 191789Sahrens gettext("where 'command' is one of the following:\n\n")); 192789Sahrens 193789Sahrens for (i = 0; i < NCOMMAND; i++) { 194789Sahrens if (command_table[i].name == NULL) 195789Sahrens (void) fprintf(fp, "\n"); 196789Sahrens else 197789Sahrens (void) fprintf(fp, "%s", 198789Sahrens command_table[i].usage); 199789Sahrens } 200789Sahrens 201789Sahrens (void) fprintf(fp, gettext("\nEach dataset is of the form: " 202789Sahrens "pool/[dataset/]*dataset[@name]\n")); 203789Sahrens } else { 204789Sahrens (void) fprintf(fp, gettext("usage:\n")); 205789Sahrens (void) fprintf(fp, current_command->usage); 206789Sahrens } 207789Sahrens 208789Sahrens if (current_command == NULL || 209789Sahrens strcmp(current_command->name, "set") == 0 || 210789Sahrens strcmp(current_command->name, "get") == 0 || 211789Sahrens strcmp(current_command->name, "inherit") == 0 || 212789Sahrens strcmp(current_command->name, "list") == 0) 213789Sahrens show_properties = TRUE; 214789Sahrens 215789Sahrens if (show_properties) { 216789Sahrens 217789Sahrens (void) fprintf(fp, 218789Sahrens gettext("\nThe following properties are supported:\n")); 219789Sahrens 220789Sahrens (void) fprintf(fp, "\n\t%-13s %s %s %s\n\n", 221789Sahrens "PROPERTY", "EDIT", "INHERIT", "VALUES"); 222789Sahrens 223789Sahrens for (i = 0; i < ZFS_NPROP_VISIBLE; i++) { 224789Sahrens (void) fprintf(fp, "\t%-13s ", zfs_prop_to_name(i)); 225789Sahrens 226789Sahrens if (zfs_prop_readonly(i)) 227789Sahrens (void) fprintf(fp, " NO "); 228789Sahrens else 229789Sahrens (void) fprintf(fp, " YES "); 230789Sahrens 231789Sahrens if (zfs_prop_inheritable(i)) 232789Sahrens (void) fprintf(fp, " YES "); 233789Sahrens else 234789Sahrens (void) fprintf(fp, " NO "); 235789Sahrens 236789Sahrens if (zfs_prop_values(i) == NULL) 237789Sahrens (void) fprintf(fp, "-\n"); 238789Sahrens else 239789Sahrens (void) fprintf(fp, "%s\n", zfs_prop_values(i)); 240789Sahrens } 241789Sahrens (void) fprintf(fp, gettext("\nSizes are specified in bytes " 242789Sahrens "with standard units such as K, M, G, etc.\n")); 243789Sahrens } 244789Sahrens 245789Sahrens exit(requested ? 0 : 2); 246789Sahrens } 247789Sahrens 248789Sahrens /* 249789Sahrens * zfs clone <fs, snap, vol> fs 250789Sahrens * 251789Sahrens * Given an existing dataset, create a writable copy whose initial contents 252789Sahrens * are the same as the source. The newly created dataset maintains a 253789Sahrens * dependency on the original; the original cannot be destroyed so long as 254789Sahrens * the clone exists. 255789Sahrens */ 256789Sahrens static int 257789Sahrens zfs_do_clone(int argc, char **argv) 258789Sahrens { 259789Sahrens zfs_handle_t *zhp; 260789Sahrens int ret; 261789Sahrens 262789Sahrens /* check options */ 263789Sahrens if (argc > 1 && argv[1][0] == '-') { 264789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 265789Sahrens argv[1][1]); 266789Sahrens usage(FALSE); 267789Sahrens } 268789Sahrens 269789Sahrens /* check number of arguments */ 270789Sahrens if (argc < 2) { 271789Sahrens (void) fprintf(stderr, gettext("missing source dataset " 272789Sahrens "argument\n")); 273789Sahrens usage(FALSE); 274789Sahrens } 275789Sahrens if (argc < 3) { 276789Sahrens (void) fprintf(stderr, gettext("missing target dataset " 277789Sahrens "argument\n")); 278789Sahrens usage(FALSE); 279789Sahrens } 280789Sahrens if (argc > 3) { 281789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 282789Sahrens usage(FALSE); 283789Sahrens } 284789Sahrens 285789Sahrens /* open the source dataset */ 286789Sahrens if ((zhp = zfs_open(argv[1], ZFS_TYPE_SNAPSHOT)) == NULL) 287789Sahrens return (1); 288789Sahrens 289789Sahrens /* pass to libzfs */ 290789Sahrens ret = zfs_clone(zhp, argv[2]); 291789Sahrens 292789Sahrens /* create the mountpoint if necessary */ 293789Sahrens if (ret == 0) { 294789Sahrens zfs_handle_t *clone = zfs_open(argv[2], ZFS_TYPE_ANY); 295789Sahrens if (clone != NULL) { 296789Sahrens if ((ret = zfs_mount(clone, NULL, 0)) == 0) 297789Sahrens ret = zfs_share(clone); 298789Sahrens zfs_close(clone); 299789Sahrens } 300789Sahrens } 301789Sahrens 302789Sahrens zfs_close(zhp); 303789Sahrens 304789Sahrens return (ret == 0 ? 0 : 1); 305789Sahrens } 306789Sahrens 307789Sahrens /* 308789Sahrens * zfs create fs 309789Sahrens * zfs create [-s] -V vol size 310789Sahrens * 311789Sahrens * Create a new dataset. This command can be used to create filesystems 312789Sahrens * and volumes. Snapshot creation is handled by 'zfs snapshot'. 313789Sahrens * For volumes, the user must specify a size to be used. 314789Sahrens * 315789Sahrens * The '-s' flag applies only to volumes, and indicates that we should not try 316789Sahrens * to set the reservation for this volume. By default we set a reservation 317789Sahrens * equal to the size for any volume. 318789Sahrens */ 319789Sahrens static int 320789Sahrens zfs_do_create(int argc, char **argv) 321789Sahrens { 322789Sahrens zfs_type_t type = ZFS_TYPE_FILESYSTEM; 323789Sahrens zfs_handle_t *zhp; 324789Sahrens char *size = NULL; 325789Sahrens char *blocksize = NULL; 326789Sahrens int c; 327789Sahrens int noreserve = FALSE; 328789Sahrens int ret; 329789Sahrens 330789Sahrens /* check options */ 331789Sahrens while ((c = getopt(argc, argv, ":V:b:s")) != -1) { 332789Sahrens switch (c) { 333789Sahrens case 'V': 334789Sahrens type = ZFS_TYPE_VOLUME; 335789Sahrens size = optarg; 336789Sahrens break; 337789Sahrens case 'b': 338789Sahrens blocksize = optarg; 339789Sahrens break; 340789Sahrens case 's': 341789Sahrens noreserve = TRUE; 342789Sahrens break; 343789Sahrens case ':': 344789Sahrens (void) fprintf(stderr, gettext("missing size " 345789Sahrens "argument\n")); 346789Sahrens usage(FALSE); 347789Sahrens break; 348789Sahrens case '?': 349789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 350789Sahrens optopt); 351789Sahrens usage(FALSE); 352789Sahrens } 353789Sahrens } 354789Sahrens 355789Sahrens if (noreserve && type != ZFS_TYPE_VOLUME) { 356789Sahrens (void) fprintf(stderr, gettext("'-s' can only be used when " 357789Sahrens "creating a volume\n")); 358789Sahrens usage(FALSE); 359789Sahrens } 360789Sahrens 361789Sahrens argc -= optind; 362789Sahrens argv += optind; 363789Sahrens 364789Sahrens /* check number of arguments */ 365789Sahrens if (argc == 0) { 366789Sahrens (void) fprintf(stderr, gettext("missing %s argument\n"), 367789Sahrens zfs_type_to_name(type)); 368789Sahrens usage(FALSE); 369789Sahrens } 370789Sahrens if (argc > 1) { 371789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 372789Sahrens usage(FALSE); 373789Sahrens } 374789Sahrens 375789Sahrens /* pass to libzfs */ 376789Sahrens if (zfs_create(argv[0], type, size, blocksize) != 0) 377789Sahrens return (1); 378789Sahrens 379789Sahrens if ((zhp = zfs_open(argv[0], ZFS_TYPE_ANY)) == NULL) 380789Sahrens return (1); 381789Sahrens 382789Sahrens /* 383789Sahrens * Volume handling. By default, we try to create a reservation of equal 384789Sahrens * size for the volume. If we can't do this, then destroy the dataset 385789Sahrens * and report an error. 386789Sahrens */ 387789Sahrens if (type == ZFS_TYPE_VOLUME && !noreserve) { 388789Sahrens if (zfs_prop_set(zhp, ZFS_PROP_RESERVATION, size) != 0) { 389789Sahrens (void) fprintf(stderr, gettext("use '-s' to create a " 390789Sahrens "volume without a matching reservation\n")); 391789Sahrens (void) zfs_destroy(zhp); 392789Sahrens return (1); 393789Sahrens } 394789Sahrens } 395789Sahrens 396789Sahrens /* 397789Sahrens * Mount and/or share the new filesystem as appropriate. We provide a 398789Sahrens * verbose error message to let the user know that their filesystem was 399789Sahrens * in fact created, even if we failed to mount or share it. 400789Sahrens */ 401789Sahrens if (zfs_mount(zhp, NULL, 0) != 0) { 402789Sahrens (void) fprintf(stderr, gettext("filesystem successfully " 403789Sahrens "created, but not mounted\n")); 404789Sahrens ret = 1; 405789Sahrens } else if (zfs_share(zhp) != 0) { 406789Sahrens (void) fprintf(stderr, gettext("filesystem successfully " 407789Sahrens "created, but not shared\n")); 408789Sahrens ret = 1; 409789Sahrens } else { 410789Sahrens ret = 0; 411789Sahrens } 412789Sahrens 413789Sahrens zfs_close(zhp); 414789Sahrens return (ret); 415789Sahrens } 416789Sahrens 417789Sahrens /* 418789Sahrens * zfs destroy [-rf] <fs, snap, vol> 419789Sahrens * 420789Sahrens * -r Recursively destroy all children 421789Sahrens * -R Recursively destroy all dependents, including clones 422789Sahrens * -f Force unmounting of any dependents 423789Sahrens * 424789Sahrens * Destroys the given dataset. By default, it will unmount any filesystems, 425789Sahrens * and refuse to destroy a dataset that has any dependents. A dependent can 426789Sahrens * either be a child, or a clone of a child. 427789Sahrens */ 428789Sahrens typedef struct destroy_cbdata { 429789Sahrens int cb_first; 430789Sahrens int cb_force; 431789Sahrens int cb_recurse; 432789Sahrens int cb_error; 433789Sahrens int cb_needforce; 434789Sahrens int cb_doclones; 435789Sahrens zfs_handle_t *cb_target; 436789Sahrens } destroy_cbdata_t; 437789Sahrens 438789Sahrens /* 439789Sahrens * Check for any dependents based on the '-r' or '-R' flags. 440789Sahrens */ 441789Sahrens static int 442789Sahrens destroy_check_dependent(zfs_handle_t *zhp, void *data) 443789Sahrens { 444789Sahrens destroy_cbdata_t *cbp = data; 445789Sahrens const char *tname = zfs_get_name(cbp->cb_target); 446789Sahrens const char *name = zfs_get_name(zhp); 447789Sahrens 448789Sahrens if (strncmp(tname, name, strlen(tname)) == 0 && 449789Sahrens (name[strlen(tname)] == '/' || name[strlen(tname)] == '@')) { 450789Sahrens /* 451789Sahrens * This is a direct descendant, not a clone somewhere else in 452789Sahrens * the hierarchy. 453789Sahrens */ 454789Sahrens if (cbp->cb_recurse) 455789Sahrens goto out; 456789Sahrens 457789Sahrens if (cbp->cb_first) { 458789Sahrens (void) fprintf(stderr, gettext("cannot destroy '%s': " 459789Sahrens "%s has children\n"), 460789Sahrens zfs_get_name(cbp->cb_target), 461789Sahrens zfs_type_to_name(zfs_get_type(cbp->cb_target))); 462789Sahrens (void) fprintf(stderr, gettext("use '-r' to destroy " 463789Sahrens "the following datasets:\n")); 464789Sahrens cbp->cb_first = 0; 465789Sahrens cbp->cb_error = 1; 466789Sahrens } 467789Sahrens 468789Sahrens (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 469789Sahrens } else { 470789Sahrens /* 471789Sahrens * This is a clone. We only want to report this if the '-r' 472789Sahrens * wasn't specified, or the target is a snapshot. 473789Sahrens */ 474789Sahrens if (!cbp->cb_recurse && 475789Sahrens zfs_get_type(cbp->cb_target) != ZFS_TYPE_SNAPSHOT) 476789Sahrens goto out; 477789Sahrens 478789Sahrens if (cbp->cb_first) { 479789Sahrens (void) fprintf(stderr, gettext("cannot destroy '%s': " 480789Sahrens "%s has dependent clones\n"), 481789Sahrens zfs_get_name(cbp->cb_target), 482789Sahrens zfs_type_to_name(zfs_get_type(cbp->cb_target))); 483789Sahrens (void) fprintf(stderr, gettext("use '-R' to destroy " 484789Sahrens "the following datasets:\n")); 485789Sahrens cbp->cb_first = 0; 486789Sahrens cbp->cb_error = 1; 487789Sahrens } 488789Sahrens 489789Sahrens (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 490789Sahrens } 491789Sahrens 492789Sahrens out: 493789Sahrens zfs_close(zhp); 494789Sahrens return (0); 495789Sahrens } 496789Sahrens 497789Sahrens static int 498789Sahrens destroy_callback(zfs_handle_t *zhp, void *data) 499789Sahrens { 500789Sahrens destroy_cbdata_t *cbp = data; 501789Sahrens 502789Sahrens /* 503789Sahrens * Ignore pools (which we've already flagged as an error before getting 504789Sahrens * here. 505789Sahrens */ 506789Sahrens if (strchr(zfs_get_name(zhp), '/') == NULL && 507789Sahrens zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) { 508789Sahrens zfs_close(zhp); 509789Sahrens return (0); 510789Sahrens } 511789Sahrens 512789Sahrens /* 513789Sahrens * Bail out on the first error. 514789Sahrens */ 515789Sahrens if (zfs_unmount(zhp, NULL, cbp->cb_force ? MS_FORCE : 0) != 0 || 516789Sahrens zfs_destroy(zhp) != 0) { 517789Sahrens zfs_close(zhp); 518789Sahrens return (-1); 519789Sahrens } 520789Sahrens 521789Sahrens zfs_close(zhp); 522789Sahrens return (0); 523789Sahrens } 524789Sahrens 525789Sahrens 526789Sahrens static int 527789Sahrens zfs_do_destroy(int argc, char **argv) 528789Sahrens { 529789Sahrens destroy_cbdata_t cb = { 0 }; 530789Sahrens int c; 531789Sahrens zfs_handle_t *zhp; 532789Sahrens 533789Sahrens /* check options */ 534789Sahrens while ((c = getopt(argc, argv, "frR")) != -1) { 535789Sahrens switch (c) { 536789Sahrens case 'f': 537789Sahrens cb.cb_force = 1; 538789Sahrens break; 539789Sahrens case 'r': 540789Sahrens cb.cb_recurse = 1; 541789Sahrens break; 542789Sahrens case 'R': 543789Sahrens cb.cb_recurse = 1; 544789Sahrens cb.cb_doclones = 1; 545789Sahrens break; 546789Sahrens case '?': 547789Sahrens default: 548789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 549789Sahrens optopt); 550789Sahrens usage(FALSE); 551789Sahrens } 552789Sahrens } 553789Sahrens 554789Sahrens argc -= optind; 555789Sahrens argv += optind; 556789Sahrens 557789Sahrens /* check number of arguments */ 558789Sahrens if (argc == 0) { 559789Sahrens (void) fprintf(stderr, gettext("missing path argument\n")); 560789Sahrens usage(FALSE); 561789Sahrens } 562789Sahrens if (argc > 1) { 563789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 564789Sahrens usage(FALSE); 565789Sahrens } 566789Sahrens 567789Sahrens /* Open the given dataset */ 568789Sahrens if ((zhp = zfs_open(argv[0], ZFS_TYPE_ANY)) == NULL) 569789Sahrens return (1); 570789Sahrens 571789Sahrens cb.cb_target = zhp; 572789Sahrens 573789Sahrens /* 574789Sahrens * Perform an explicit check for pools before going any further. 575789Sahrens */ 576789Sahrens if (!cb.cb_recurse && strchr(zfs_get_name(zhp), '/') == NULL && 577789Sahrens zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) { 578789Sahrens (void) fprintf(stderr, gettext("cannot destroy '%s': " 579789Sahrens "operation does not apply to pools\n"), 580789Sahrens zfs_get_name(zhp)); 581789Sahrens (void) fprintf(stderr, gettext("use 'zfs destroy -r " 582789Sahrens "%s' to destroy all datasets in the pool\n"), 583789Sahrens zfs_get_name(zhp)); 584789Sahrens (void) fprintf(stderr, gettext("use 'zpool destroy %s' " 585789Sahrens "to destroy the pool itself\n"), zfs_get_name(zhp)); 586789Sahrens zfs_close(zhp); 587789Sahrens return (1); 588789Sahrens } 589789Sahrens 590789Sahrens 591789Sahrens /* 592789Sahrens * Check for any dependents and/or clones. 593789Sahrens */ 594789Sahrens cb.cb_first = 1; 595789Sahrens if (!cb.cb_doclones) 596789Sahrens (void) zfs_iter_dependents(zhp, destroy_check_dependent, &cb); 597789Sahrens 598789Sahrens if (cb.cb_error) { 599789Sahrens zfs_close(zhp); 600789Sahrens return (1); 601789Sahrens } 602789Sahrens 603789Sahrens /* 604789Sahrens * Do the real thing. 605789Sahrens */ 606789Sahrens if (zfs_iter_dependents(zhp, destroy_callback, &cb) == 0 && 607789Sahrens destroy_callback(zhp, &cb) == 0) 608789Sahrens return (0); 609789Sahrens 610789Sahrens return (1); 611789Sahrens } 612789Sahrens 613789Sahrens /* 614866Seschrock * zfs get [-rHp] [-o field[,field]...] [-s source[,source]...] 615866Seschrock * < all | property[,property]... > < fs | snap | vol > ... 616789Sahrens * 617789Sahrens * -r recurse over any child datasets 618789Sahrens * -H scripted mode. Headers are stripped, and fields are separated 619789Sahrens * by tabs instead of spaces. 620789Sahrens * -o Set of fields to display. One of "name,property,value,source". 621789Sahrens * Default is all four. 622789Sahrens * -s Set of sources to allow. One of 623789Sahrens * "local,default,inherited,temporary,none". Default is all 624789Sahrens * five. 625789Sahrens * -p Display values in parsable (literal) format. 626789Sahrens * 627789Sahrens * Prints properties for the given datasets. The user can control which 628789Sahrens * columns to display as well as which property types to allow. 629789Sahrens */ 630789Sahrens typedef struct get_cbdata { 631789Sahrens int cb_scripted; 632789Sahrens int cb_sources; 633789Sahrens int cb_literal; 634789Sahrens int cb_columns[4]; 635789Sahrens zfs_prop_t cb_prop[ZFS_NPROP_ALL]; 636789Sahrens int cb_nprop; 637866Seschrock int cb_isall; 638789Sahrens } get_cbdata_t; 639789Sahrens 640789Sahrens #define GET_COL_NAME 1 641789Sahrens #define GET_COL_PROPERTY 2 642789Sahrens #define GET_COL_VALUE 3 643789Sahrens #define GET_COL_SOURCE 4 644789Sahrens 645789Sahrens /* 646789Sahrens * Display a single line of output, according to the settings in the callback 647789Sahrens * structure. 648789Sahrens */ 649789Sahrens static void 650789Sahrens print_one_property(zfs_handle_t *zhp, get_cbdata_t *cbp, zfs_prop_t prop, 651789Sahrens const char *value, zfs_source_t sourcetype, const char *source) 652789Sahrens { 653789Sahrens int i; 654789Sahrens int width; 655789Sahrens const char *str; 656789Sahrens char buf[128]; 657789Sahrens 658789Sahrens /* 659789Sahrens * Ignore those source types that the user has chosen to ignore. 660789Sahrens */ 661789Sahrens if ((sourcetype & cbp->cb_sources) == 0) 662789Sahrens return; 663789Sahrens 664789Sahrens for (i = 0; i < 4; i++) { 665789Sahrens switch (cbp->cb_columns[i]) { 666789Sahrens case GET_COL_NAME: 667789Sahrens width = 15; 668789Sahrens str = zfs_get_name(zhp); 669789Sahrens break; 670789Sahrens 671789Sahrens case GET_COL_PROPERTY: 672789Sahrens width = 13; 673789Sahrens str = zfs_prop_to_name(prop); 674789Sahrens break; 675789Sahrens 676789Sahrens case GET_COL_VALUE: 677789Sahrens width = 25; 678789Sahrens str = value; 679789Sahrens break; 680789Sahrens 681789Sahrens case GET_COL_SOURCE: 682789Sahrens width = 15; 683789Sahrens switch (sourcetype) { 684789Sahrens case ZFS_SRC_NONE: 685789Sahrens str = "-"; 686789Sahrens break; 687789Sahrens 688789Sahrens case ZFS_SRC_DEFAULT: 689789Sahrens str = "default"; 690789Sahrens break; 691789Sahrens 692789Sahrens case ZFS_SRC_LOCAL: 693789Sahrens str = "local"; 694789Sahrens break; 695789Sahrens 696789Sahrens case ZFS_SRC_TEMPORARY: 697789Sahrens str = "temporary"; 698789Sahrens break; 699789Sahrens 700789Sahrens case ZFS_SRC_INHERITED: 701789Sahrens (void) snprintf(buf, sizeof (buf), 702789Sahrens "inherited from %s", source); 703789Sahrens str = buf; 704789Sahrens break; 705789Sahrens } 706789Sahrens break; 707789Sahrens 708789Sahrens default: 709789Sahrens continue; 710789Sahrens } 711789Sahrens 712789Sahrens if (cbp->cb_columns[i + 1] == 0) 713789Sahrens (void) printf("%s", str); 714789Sahrens else if (cbp->cb_scripted) 715789Sahrens (void) printf("%s\t", str); 716789Sahrens else 717789Sahrens (void) printf("%-*s ", width, str); 718789Sahrens 719789Sahrens } 720789Sahrens 721789Sahrens (void) printf("\n"); 722789Sahrens } 723789Sahrens 724789Sahrens /* 725789Sahrens * Invoked to display the properties for a single dataset. 726789Sahrens */ 727789Sahrens static int 728789Sahrens get_callback(zfs_handle_t *zhp, void *data) 729789Sahrens { 730789Sahrens char buf[ZFS_MAXPROPLEN]; 731789Sahrens zfs_source_t sourcetype; 732789Sahrens char source[ZFS_MAXNAMELEN]; 733789Sahrens get_cbdata_t *cbp = data; 734789Sahrens int i; 735789Sahrens 736866Seschrock for (i = 0; i < cbp->cb_nprop; i++) { 737866Seschrock if (zfs_prop_get(zhp, cbp->cb_prop[i], buf, 738866Seschrock sizeof (buf), &sourcetype, source, sizeof (source), 739866Seschrock cbp->cb_literal) != 0) { 740866Seschrock if (cbp->cb_isall) 741866Seschrock continue; 742866Seschrock (void) strlcpy(buf, "-", sizeof (buf)); 743866Seschrock sourcetype = ZFS_SRC_NONE; 744866Seschrock } 745789Sahrens 746866Seschrock print_one_property(zhp, cbp, cbp->cb_prop[i], 747866Seschrock buf, sourcetype, source); 748789Sahrens } 749789Sahrens 750789Sahrens return (0); 751789Sahrens } 752789Sahrens 753789Sahrens static int 754789Sahrens zfs_do_get(int argc, char **argv) 755789Sahrens { 756789Sahrens get_cbdata_t cb = { 0 }; 757789Sahrens int recurse = 0; 758789Sahrens int c; 759866Seschrock char *value, *fields, *badopt; 760789Sahrens int i; 761866Seschrock int ret; 762789Sahrens 763789Sahrens /* 764789Sahrens * Set up default columns and sources. 765789Sahrens */ 766789Sahrens cb.cb_sources = ZFS_SRC_ALL; 767789Sahrens cb.cb_columns[0] = GET_COL_NAME; 768789Sahrens cb.cb_columns[1] = GET_COL_PROPERTY; 769789Sahrens cb.cb_columns[2] = GET_COL_VALUE; 770789Sahrens cb.cb_columns[3] = GET_COL_SOURCE; 771789Sahrens 772789Sahrens /* check options */ 773789Sahrens while ((c = getopt(argc, argv, ":o:s:rHp")) != -1) { 774789Sahrens switch (c) { 775789Sahrens case 'p': 776789Sahrens cb.cb_literal = TRUE; 777789Sahrens break; 778789Sahrens case 'r': 779789Sahrens recurse = TRUE; 780789Sahrens break; 781789Sahrens case 'H': 782789Sahrens cb.cb_scripted = TRUE; 783789Sahrens break; 784789Sahrens case ':': 785789Sahrens (void) fprintf(stderr, gettext("missing argument for " 786789Sahrens "'%c' option\n"), optopt); 787789Sahrens usage(FALSE); 788789Sahrens break; 789789Sahrens case 'o': 790789Sahrens /* 791789Sahrens * Process the set of columns to display. We zero out 792789Sahrens * the structure to give us a blank slate. 793789Sahrens */ 794789Sahrens bzero(&cb.cb_columns, sizeof (cb.cb_columns)); 795789Sahrens i = 0; 796789Sahrens while (*optarg != '\0') { 797789Sahrens static char *col_subopts[] = 798789Sahrens { "name", "property", "value", "source", 799789Sahrens NULL }; 800789Sahrens 801789Sahrens if (i == 4) { 802789Sahrens (void) fprintf(stderr, gettext("too " 803789Sahrens "many fields given to -o " 804789Sahrens "option\n")); 805789Sahrens usage(FALSE); 806789Sahrens } 807789Sahrens 808789Sahrens switch (getsubopt(&optarg, col_subopts, 809789Sahrens &value)) { 810789Sahrens case 0: 811789Sahrens cb.cb_columns[i++] = GET_COL_NAME; 812789Sahrens break; 813789Sahrens case 1: 814789Sahrens cb.cb_columns[i++] = GET_COL_PROPERTY; 815789Sahrens break; 816789Sahrens case 2: 817789Sahrens cb.cb_columns[i++] = GET_COL_VALUE; 818789Sahrens break; 819789Sahrens case 3: 820789Sahrens cb.cb_columns[i++] = GET_COL_SOURCE; 821789Sahrens break; 822789Sahrens default: 823789Sahrens (void) fprintf(stderr, 824789Sahrens gettext("invalid column name " 825789Sahrens "'%s'\n"), value); 826789Sahrens usage(FALSE); 827789Sahrens } 828789Sahrens } 829789Sahrens break; 830789Sahrens 831789Sahrens case 's': 832789Sahrens cb.cb_sources = 0; 833789Sahrens while (*optarg != '\0') { 834789Sahrens static char *source_subopts[] = { 835789Sahrens "local", "default", "inherited", 836789Sahrens "temporary", "none", NULL }; 837789Sahrens 838789Sahrens switch (getsubopt(&optarg, source_subopts, 839789Sahrens &value)) { 840789Sahrens case 0: 841789Sahrens cb.cb_sources |= ZFS_SRC_LOCAL; 842789Sahrens break; 843789Sahrens case 1: 844789Sahrens cb.cb_sources |= ZFS_SRC_DEFAULT; 845789Sahrens break; 846789Sahrens case 2: 847789Sahrens cb.cb_sources |= ZFS_SRC_INHERITED; 848789Sahrens break; 849789Sahrens case 3: 850789Sahrens cb.cb_sources |= ZFS_SRC_TEMPORARY; 851789Sahrens break; 852789Sahrens case 4: 853789Sahrens cb.cb_sources |= ZFS_SRC_NONE; 854789Sahrens break; 855789Sahrens default: 856789Sahrens (void) fprintf(stderr, 857789Sahrens gettext("invalid source " 858789Sahrens "'%s'\n"), value); 859789Sahrens usage(FALSE); 860789Sahrens } 861789Sahrens } 862789Sahrens break; 863789Sahrens 864789Sahrens case '?': 865789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 866789Sahrens optopt); 867789Sahrens usage(FALSE); 868789Sahrens } 869789Sahrens } 870789Sahrens 871789Sahrens argc -= optind; 872789Sahrens argv += optind; 873789Sahrens 874789Sahrens if (argc < 1) { 875789Sahrens (void) fprintf(stderr, gettext("missing property " 876789Sahrens "argument\n")); 877789Sahrens usage(FALSE); 878789Sahrens } 879789Sahrens 880789Sahrens fields = argv[0]; 881789Sahrens 882789Sahrens /* 883866Seschrock * If the user specifies 'all', the behavior of 'zfs get' is slightly 884866Seschrock * different, because we don't show properties which don't apply to the 885866Seschrock * given dataset. 886789Sahrens */ 887866Seschrock if (strcmp(fields, "all") == 0) 888866Seschrock cb.cb_isall = TRUE; 889789Sahrens 890866Seschrock if ((ret = zfs_get_proplist(fields, cb.cb_prop, ZFS_NPROP_ALL, 891866Seschrock &cb.cb_nprop, &badopt)) != 0) { 892866Seschrock if (ret == EINVAL) 893866Seschrock (void) fprintf(stderr, gettext("invalid property " 894866Seschrock "'%s'\n"), badopt); 895866Seschrock else 896866Seschrock (void) fprintf(stderr, gettext("too many properties " 897866Seschrock "specified\n")); 898866Seschrock usage(FALSE); 899789Sahrens } 900789Sahrens 901789Sahrens argc--; 902789Sahrens argv++; 903789Sahrens 904789Sahrens /* check for at least one dataset name */ 905789Sahrens if (argc < 1) { 906789Sahrens (void) fprintf(stderr, gettext("missing dataset argument\n")); 907789Sahrens usage(FALSE); 908789Sahrens } 909789Sahrens 910789Sahrens /* 911789Sahrens * Print out any headers 912789Sahrens */ 913789Sahrens if (!cb.cb_scripted) { 914789Sahrens int i; 915789Sahrens for (i = 0; i < 4; i++) { 916789Sahrens switch (cb.cb_columns[i]) { 917789Sahrens case GET_COL_NAME: 918789Sahrens (void) printf("%-15s ", "NAME"); 919789Sahrens break; 920789Sahrens case GET_COL_PROPERTY: 921789Sahrens (void) printf("%-13s ", "PROPERTY"); 922789Sahrens break; 923789Sahrens case GET_COL_VALUE: 924789Sahrens (void) printf("%-25s ", "VALUE"); 925789Sahrens break; 926789Sahrens case GET_COL_SOURCE: 927789Sahrens (void) printf("%s", "SOURCE"); 928789Sahrens break; 929789Sahrens } 930789Sahrens } 931789Sahrens (void) printf("\n"); 932789Sahrens } 933789Sahrens 934789Sahrens /* run for each object */ 935789Sahrens return (zfs_for_each(argc, argv, recurse, ZFS_TYPE_ANY, 936789Sahrens get_callback, &cb)); 937789Sahrens } 938789Sahrens 939789Sahrens /* 940789Sahrens * inherit [-r] <property> <fs|vol> ... 941789Sahrens * 942789Sahrens * -r Recurse over all children 943789Sahrens * 944789Sahrens * For each dataset specified on the command line, inherit the given property 945789Sahrens * from its parent. Inheriting a property at the pool level will cause it to 946789Sahrens * use the default value. The '-r' flag will recurse over all children, and is 947789Sahrens * useful for setting a property on a hierarchy-wide basis, regardless of any 948789Sahrens * local modifications for each dataset. 949789Sahrens */ 950789Sahrens static int 951789Sahrens inherit_callback(zfs_handle_t *zhp, void *data) 952789Sahrens { 953789Sahrens zfs_prop_t prop = (zfs_prop_t)data; 954789Sahrens 955789Sahrens return (zfs_prop_inherit(zhp, prop) != 0); 956789Sahrens } 957789Sahrens 958789Sahrens static int 959789Sahrens zfs_do_inherit(int argc, char **argv) 960789Sahrens { 961789Sahrens int recurse = 0; 962789Sahrens int c; 963789Sahrens zfs_prop_t prop; 964789Sahrens char *propname; 965789Sahrens 966789Sahrens /* check options */ 967789Sahrens while ((c = getopt(argc, argv, "r")) != -1) { 968789Sahrens switch (c) { 969789Sahrens case 'r': 970789Sahrens recurse = TRUE; 971789Sahrens break; 972789Sahrens case '?': 973789Sahrens default: 974789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 975789Sahrens optopt); 976789Sahrens usage(FALSE); 977789Sahrens } 978789Sahrens } 979789Sahrens 980789Sahrens argc -= optind; 981789Sahrens argv += optind; 982789Sahrens 983789Sahrens /* check number of arguments */ 984789Sahrens if (argc < 1) { 985789Sahrens (void) fprintf(stderr, gettext("missing property argument\n")); 986789Sahrens usage(FALSE); 987789Sahrens } 988789Sahrens if (argc < 2) { 989789Sahrens (void) fprintf(stderr, gettext("missing dataset argument\n")); 990789Sahrens usage(FALSE); 991789Sahrens } 992789Sahrens 993789Sahrens propname = argv[0]; 994789Sahrens 995789Sahrens /* 996789Sahrens * Get and validate the property before iterating over the datasets. We 997789Sahrens * do this now so as to avoid printing out an error message for each and 998789Sahrens * every dataset. 999789Sahrens */ 1000789Sahrens if ((prop = zfs_name_to_prop(propname)) == ZFS_PROP_INVAL) { 1001789Sahrens (void) fprintf(stderr, gettext("invalid property '%s'\n"), 1002789Sahrens propname); 1003789Sahrens usage(FALSE); 1004789Sahrens } 1005789Sahrens if (zfs_prop_readonly(prop)) { 1006789Sahrens (void) fprintf(stderr, gettext("%s property is read-only\n"), 1007789Sahrens propname); 1008789Sahrens return (1); 1009789Sahrens } 1010789Sahrens if (!zfs_prop_inheritable(prop)) { 1011789Sahrens (void) fprintf(stderr, gettext("%s property cannot be " 1012789Sahrens "inherited\n"), propname); 1013789Sahrens (void) fprintf(stderr, gettext("use 'zfs set %s=none' to " 1014789Sahrens "clear\n"), propname); 1015789Sahrens return (1); 1016789Sahrens } 1017789Sahrens 1018789Sahrens return (zfs_for_each(argc - 1, argv + 1, recurse, 1019789Sahrens ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME, 1020789Sahrens inherit_callback, (void *)prop)); 1021789Sahrens } 1022789Sahrens 1023789Sahrens /* 1024866Seschrock * list [-rH] [-o property[,property]...] [-t type[,type]...] <dataset> ... 1025789Sahrens * 1026789Sahrens * -r Recurse over all children 1027789Sahrens * -H Scripted mode; elide headers and separate colums by tabs 1028789Sahrens * -o Control which fields to display. 1029866Seschrock * -t Control which object types to display. 1030789Sahrens * 1031789Sahrens * When given no arguments, lists all filesystems in the system. 1032789Sahrens * Otherwise, list the specified datasets, optionally recursing down them if 1033789Sahrens * '-r' is specified. 1034789Sahrens */ 1035789Sahrens typedef struct list_cbdata { 1036866Seschrock int cb_first; 1037866Seschrock int cb_scripted; 1038866Seschrock zfs_prop_t cb_fields[ZFS_NPROP_ALL]; 1039866Seschrock int cb_fieldcount; 1040789Sahrens } list_cbdata_t; 1041789Sahrens 1042789Sahrens /* 1043789Sahrens * Given a list of columns to display, output appropriate headers for each one. 1044789Sahrens */ 1045789Sahrens static void 1046866Seschrock print_header(zfs_prop_t *fields, size_t count) 1047789Sahrens { 1048789Sahrens int i; 1049789Sahrens 1050789Sahrens for (i = 0; i < count; i++) { 1051789Sahrens if (i != 0) 1052789Sahrens (void) printf(" "); 1053789Sahrens if (i == count - 1) 1054789Sahrens (void) printf("%s", zfs_prop_column_name(fields[i])); 1055789Sahrens else /* LINTED - format specifier */ 1056789Sahrens (void) printf(zfs_prop_column_format(fields[i]), 1057789Sahrens zfs_prop_column_name(fields[i])); 1058789Sahrens } 1059789Sahrens 1060789Sahrens (void) printf("\n"); 1061789Sahrens } 1062789Sahrens 1063789Sahrens /* 1064789Sahrens * Given a dataset and a list of fields, print out all the properties according 1065789Sahrens * to the described layout. 1066789Sahrens */ 1067789Sahrens static void 1068866Seschrock print_dataset(zfs_handle_t *zhp, zfs_prop_t *fields, size_t count, int scripted) 1069789Sahrens { 1070789Sahrens int i; 1071789Sahrens char property[ZFS_MAXPROPLEN]; 1072789Sahrens 1073789Sahrens for (i = 0; i < count; i++) { 1074789Sahrens if (i != 0) { 1075789Sahrens if (scripted) 1076789Sahrens (void) printf("\t"); 1077789Sahrens else 1078789Sahrens (void) printf(" "); 1079789Sahrens } 1080789Sahrens 1081789Sahrens if (zfs_prop_get(zhp, fields[i], property, 1082789Sahrens sizeof (property), NULL, NULL, 0, FALSE) != 0) 1083789Sahrens (void) strlcpy(property, "-", sizeof (property)); 1084789Sahrens 1085866Seschrock /* 1086866Seschrock * If this is being called in scripted mode, or if this is the 1087866Seschrock * last column and it is left-justified, don't include a width 1088866Seschrock * format specifier. 1089866Seschrock */ 1090866Seschrock if (scripted || (i == count - 1 && 1091866Seschrock strchr(zfs_prop_column_format(fields[i]), '-') != NULL)) 1092789Sahrens (void) printf("%s", property); 1093789Sahrens else /* LINTED - format specifier */ 1094789Sahrens (void) printf(zfs_prop_column_format(fields[i]), 1095789Sahrens property); 1096789Sahrens } 1097789Sahrens 1098789Sahrens (void) printf("\n"); 1099789Sahrens } 1100789Sahrens 1101789Sahrens /* 1102789Sahrens * Generic callback function to list a dataset or snapshot. 1103789Sahrens */ 1104789Sahrens static int 1105789Sahrens list_callback(zfs_handle_t *zhp, void *data) 1106789Sahrens { 1107789Sahrens list_cbdata_t *cbp = data; 1108789Sahrens 1109789Sahrens if (cbp->cb_first) { 1110789Sahrens if (!cbp->cb_scripted) 1111789Sahrens print_header(cbp->cb_fields, cbp->cb_fieldcount); 1112789Sahrens cbp->cb_first = FALSE; 1113789Sahrens } 1114789Sahrens 1115789Sahrens print_dataset(zhp, cbp->cb_fields, cbp->cb_fieldcount, 1116789Sahrens cbp->cb_scripted); 1117789Sahrens 1118789Sahrens return (0); 1119789Sahrens } 1120789Sahrens 1121789Sahrens static int 1122789Sahrens zfs_do_list(int argc, char **argv) 1123789Sahrens { 1124789Sahrens int c; 1125789Sahrens int recurse = 0; 1126789Sahrens int scripted = FALSE; 1127789Sahrens static char default_fields[] = 1128789Sahrens "name,used,available,referenced,mountpoint"; 1129789Sahrens int types = ZFS_TYPE_ANY; 1130789Sahrens char *fields = NULL; 1131789Sahrens char *basic_fields = default_fields; 1132789Sahrens list_cbdata_t cb = { 0 }; 1133789Sahrens char *value; 1134789Sahrens int ret; 1135789Sahrens char *type_subopts[] = { "filesystem", "volume", "snapshot", NULL }; 1136866Seschrock char *badopt; 1137866Seschrock int alloffset; 1138789Sahrens 1139789Sahrens /* check options */ 1140789Sahrens while ((c = getopt(argc, argv, ":o:rt:H")) != -1) { 1141789Sahrens switch (c) { 1142789Sahrens case 'o': 1143789Sahrens fields = optarg; 1144789Sahrens break; 1145789Sahrens case 'r': 1146789Sahrens recurse = TRUE; 1147789Sahrens break; 1148789Sahrens case 'H': 1149789Sahrens scripted = TRUE; 1150789Sahrens break; 1151789Sahrens case 't': 1152789Sahrens types = 0; 1153789Sahrens while (*optarg != '\0') { 1154789Sahrens switch (getsubopt(&optarg, type_subopts, 1155789Sahrens &value)) { 1156789Sahrens case 0: 1157789Sahrens types |= ZFS_TYPE_FILESYSTEM; 1158789Sahrens break; 1159789Sahrens case 1: 1160789Sahrens types |= ZFS_TYPE_VOLUME; 1161789Sahrens break; 1162789Sahrens case 2: 1163789Sahrens types |= ZFS_TYPE_SNAPSHOT; 1164789Sahrens break; 1165789Sahrens default: 1166789Sahrens (void) fprintf(stderr, 1167789Sahrens gettext("invalid type '%s'\n"), 1168789Sahrens value); 1169789Sahrens usage(FALSE); 1170789Sahrens } 1171789Sahrens } 1172789Sahrens break; 1173789Sahrens case ':': 1174789Sahrens (void) fprintf(stderr, gettext("missing argument for " 1175789Sahrens "'%c' option\n"), optopt); 1176789Sahrens usage(FALSE); 1177789Sahrens break; 1178789Sahrens case '?': 1179789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1180789Sahrens optopt); 1181789Sahrens usage(FALSE); 1182789Sahrens } 1183789Sahrens } 1184789Sahrens 1185789Sahrens argc -= optind; 1186789Sahrens argv += optind; 1187789Sahrens 1188789Sahrens if (fields == NULL) 1189789Sahrens fields = basic_fields; 1190789Sahrens 1191866Seschrock /* 1192866Seschrock * If the user specifies '-o all', the zfs_get_proplist() doesn't 1193866Seschrock * normally include the name of the dataset. For 'zfs list', we always 1194866Seschrock * want this property to be first. 1195866Seschrock */ 1196866Seschrock if (strcmp(fields, "all") == 0) { 1197866Seschrock cb.cb_fields[0] = ZFS_PROP_NAME; 1198866Seschrock alloffset = 1; 1199866Seschrock } else { 1200866Seschrock alloffset = 0; 1201789Sahrens } 1202789Sahrens 1203866Seschrock if ((ret = zfs_get_proplist(fields, cb.cb_fields + alloffset, 1204866Seschrock ZFS_NPROP_ALL - alloffset, &cb.cb_fieldcount, &badopt)) != 0) { 1205866Seschrock if (ret == EINVAL) 1206866Seschrock (void) fprintf(stderr, gettext("invalid property " 1207866Seschrock "'%s'\n"), badopt); 1208866Seschrock else 1209866Seschrock (void) fprintf(stderr, gettext("too many properties " 1210866Seschrock "specified\n")); 1211866Seschrock usage(FALSE); 1212866Seschrock } 1213866Seschrock 1214866Seschrock cb.cb_fieldcount += alloffset; 1215789Sahrens cb.cb_scripted = scripted; 1216789Sahrens cb.cb_first = TRUE; 1217789Sahrens 1218789Sahrens ret = zfs_for_each(argc, argv, recurse, types, list_callback, &cb); 1219789Sahrens 1220789Sahrens if (ret == 0 && cb.cb_first == TRUE) 1221789Sahrens (void) printf(gettext("no datasets available\n")); 1222789Sahrens 1223789Sahrens return (ret); 1224789Sahrens } 1225789Sahrens 1226789Sahrens /* 1227789Sahrens * zfs rename <fs | snap | vol> <fs | snap | vol> 1228789Sahrens * 1229789Sahrens * Renames the given dataset to another of the same type. 1230789Sahrens */ 1231789Sahrens /* ARGSUSED */ 1232789Sahrens static int 1233789Sahrens zfs_do_rename(int argc, char **argv) 1234789Sahrens { 1235789Sahrens zfs_handle_t *zhp; 1236789Sahrens int ret = 1; 1237789Sahrens 1238789Sahrens /* check options */ 1239789Sahrens if (argc > 1 && argv[1][0] == '-') { 1240789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1241789Sahrens argv[1][1]); 1242789Sahrens usage(FALSE); 1243789Sahrens } 1244789Sahrens 1245789Sahrens /* check number of arguments */ 1246789Sahrens if (argc < 2) { 1247789Sahrens (void) fprintf(stderr, gettext("missing source dataset " 1248789Sahrens "argument\n")); 1249789Sahrens usage(FALSE); 1250789Sahrens } 1251789Sahrens if (argc < 3) { 1252789Sahrens (void) fprintf(stderr, gettext("missing target dataset " 1253789Sahrens "argument\n")); 1254789Sahrens usage(FALSE); 1255789Sahrens } 1256789Sahrens if (argc > 3) { 1257789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 1258789Sahrens usage(FALSE); 1259789Sahrens } 1260789Sahrens 1261789Sahrens if ((zhp = zfs_open(argv[1], ZFS_TYPE_ANY)) == NULL) 1262789Sahrens return (1); 1263789Sahrens 1264789Sahrens if (zfs_rename(zhp, argv[2]) != 0) 1265789Sahrens goto error; 1266789Sahrens 1267789Sahrens ret = 0; 1268789Sahrens error: 1269789Sahrens zfs_close(zhp); 1270789Sahrens return (ret); 1271789Sahrens } 1272789Sahrens 1273789Sahrens /* 1274789Sahrens * zfs rollback [-rfR] <snapshot> 1275789Sahrens * 1276789Sahrens * -r Delete any intervening snapshots before doing rollback 1277789Sahrens * -R Delete any snapshots and their clones 1278789Sahrens * -f Force unmount filesystems, even if they are in use. 1279789Sahrens * 1280789Sahrens * Given a filesystem, rollback to a specific snapshot, discarding any changes 1281789Sahrens * since then and making it the active dataset. If more recent snapshots exist, 1282789Sahrens * the command will complain unless the '-r' flag is given. 1283789Sahrens */ 1284789Sahrens typedef struct rollback_cbdata { 1285789Sahrens uint64_t cb_create; 1286789Sahrens int cb_first; 1287789Sahrens int cb_doclones; 1288789Sahrens char *cb_target; 1289789Sahrens int cb_error; 1290789Sahrens int cb_recurse; 1291789Sahrens int cb_dependent; 1292789Sahrens } rollback_cbdata_t; 1293789Sahrens 1294789Sahrens /* 1295789Sahrens * Report any snapshots more recent than the one specified. Used when '-r' is 1296789Sahrens * not specified. We reuse this same callback for the snapshot dependents - if 1297789Sahrens * 'cb_dependent' is set, then this is a dependent and we should report it 1298789Sahrens * without checking the transaction group. 1299789Sahrens */ 1300789Sahrens static int 1301789Sahrens rollback_check(zfs_handle_t *zhp, void *data) 1302789Sahrens { 1303789Sahrens rollback_cbdata_t *cbp = data; 1304789Sahrens 1305789Sahrens if (cbp->cb_doclones) 1306789Sahrens return (0); 1307789Sahrens 1308789Sahrens if (!cbp->cb_dependent) { 1309789Sahrens if (strcmp(zfs_get_name(zhp), cbp->cb_target) != 0 && 1310*1294Slling zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 1311789Sahrens zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > 1312789Sahrens cbp->cb_create) { 1313789Sahrens 1314789Sahrens if (cbp->cb_first && !cbp->cb_recurse) { 1315789Sahrens (void) fprintf(stderr, gettext("cannot " 1316789Sahrens "rollback to '%s': more recent snapshots " 1317789Sahrens "exist\n"), 1318789Sahrens cbp->cb_target); 1319789Sahrens (void) fprintf(stderr, gettext("use '-r' to " 1320789Sahrens "force deletion of the following " 1321789Sahrens "snapshots:\n")); 1322789Sahrens cbp->cb_first = 0; 1323789Sahrens cbp->cb_error = 1; 1324789Sahrens } 1325789Sahrens 1326789Sahrens if (cbp->cb_recurse) { 1327789Sahrens cbp->cb_dependent = TRUE; 1328789Sahrens (void) zfs_iter_dependents(zhp, rollback_check, 1329789Sahrens cbp); 1330789Sahrens cbp->cb_dependent = FALSE; 1331789Sahrens } else { 1332789Sahrens (void) fprintf(stderr, "%s\n", 1333789Sahrens zfs_get_name(zhp)); 1334789Sahrens } 1335789Sahrens } 1336789Sahrens } else { 1337789Sahrens if (cbp->cb_first && cbp->cb_recurse) { 1338789Sahrens (void) fprintf(stderr, gettext("cannot rollback to " 1339789Sahrens "'%s': clones of previous snapshots exist\n"), 1340789Sahrens cbp->cb_target); 1341789Sahrens (void) fprintf(stderr, gettext("use '-R' to " 1342789Sahrens "force deletion of the following clones and " 1343789Sahrens "dependents:\n")); 1344789Sahrens cbp->cb_first = 0; 1345789Sahrens cbp->cb_error = 1; 1346789Sahrens } 1347789Sahrens 1348789Sahrens (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 1349789Sahrens } 1350789Sahrens 1351789Sahrens zfs_close(zhp); 1352789Sahrens return (0); 1353789Sahrens } 1354789Sahrens 1355789Sahrens static int 1356789Sahrens zfs_do_rollback(int argc, char **argv) 1357789Sahrens { 1358789Sahrens int ret; 1359789Sahrens int c; 1360789Sahrens rollback_cbdata_t cb = { 0 }; 1361789Sahrens zfs_handle_t *zhp, *snap; 1362789Sahrens char parentname[ZFS_MAXNAMELEN]; 1363789Sahrens char *delim; 1364*1294Slling int force = 0; 1365789Sahrens 1366789Sahrens /* check options */ 1367789Sahrens while ((c = getopt(argc, argv, "rfR")) != -1) { 1368789Sahrens switch (c) { 1369789Sahrens case 'f': 1370*1294Slling force = 1; 1371789Sahrens break; 1372789Sahrens case 'r': 1373789Sahrens cb.cb_recurse = 1; 1374789Sahrens break; 1375789Sahrens case 'R': 1376789Sahrens cb.cb_recurse = 1; 1377789Sahrens cb.cb_doclones = 1; 1378789Sahrens break; 1379789Sahrens case '?': 1380789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1381789Sahrens optopt); 1382789Sahrens usage(FALSE); 1383789Sahrens } 1384789Sahrens } 1385789Sahrens 1386789Sahrens argc -= optind; 1387789Sahrens argv += optind; 1388789Sahrens 1389789Sahrens /* check number of arguments */ 1390789Sahrens if (argc < 1) { 1391789Sahrens (void) fprintf(stderr, gettext("missing dataset argument\n")); 1392789Sahrens usage(FALSE); 1393789Sahrens } 1394789Sahrens if (argc > 1) { 1395789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 1396789Sahrens usage(FALSE); 1397789Sahrens } 1398789Sahrens 1399789Sahrens /* open the snapshot */ 1400*1294Slling if ((snap = zfs_open(argv[0], ZFS_TYPE_SNAPSHOT)) == NULL) 1401789Sahrens return (1); 1402789Sahrens 1403*1294Slling /* open the parent dataset */ 1404*1294Slling (void) strlcpy(parentname, argv[0], sizeof (parentname)); 1405789Sahrens verify((delim = strrchr(parentname, '@')) != NULL); 1406789Sahrens *delim = '\0'; 1407789Sahrens if ((zhp = zfs_open(parentname, ZFS_TYPE_ANY)) == NULL) { 1408789Sahrens zfs_close(snap); 1409789Sahrens return (1); 1410789Sahrens } 1411789Sahrens 1412789Sahrens /* 1413789Sahrens * Check for more recent snapshots and/or clones based on the presence 1414789Sahrens * of '-r' and '-R'. 1415789Sahrens */ 1416*1294Slling cb.cb_target = argv[0]; 1417*1294Slling cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG); 1418789Sahrens cb.cb_first = 1; 1419789Sahrens cb.cb_error = 0; 1420789Sahrens (void) zfs_iter_children(zhp, rollback_check, &cb); 1421789Sahrens 1422789Sahrens if ((ret = cb.cb_error) != 0) 1423789Sahrens goto out; 1424789Sahrens 1425789Sahrens /* 1426*1294Slling * Rollback parent to the given snapshot. 1427789Sahrens */ 1428*1294Slling ret = zfs_rollback(zhp, snap, force); 1429789Sahrens 1430789Sahrens out: 1431789Sahrens zfs_close(snap); 1432789Sahrens zfs_close(zhp); 1433789Sahrens 1434789Sahrens if (ret == 0) 1435789Sahrens return (0); 1436789Sahrens else 1437789Sahrens return (1); 1438789Sahrens } 1439789Sahrens 1440789Sahrens /* 1441789Sahrens * zfs set property=value { fs | snap | vol } ... 1442789Sahrens * 1443789Sahrens * Sets the given property for all datasets specified on the command line. 1444789Sahrens */ 1445789Sahrens typedef struct set_cbdata { 1446789Sahrens char *cb_propname; 1447789Sahrens char *cb_value; 1448789Sahrens zfs_prop_t cb_prop; 1449789Sahrens } set_cbdata_t; 1450789Sahrens 1451789Sahrens static int 1452789Sahrens set_callback(zfs_handle_t *zhp, void *data) 1453789Sahrens { 1454789Sahrens set_cbdata_t *cbp = data; 1455789Sahrens int ret = 1; 1456789Sahrens 1457789Sahrens /* don't allow setting of properties for snapshots */ 1458789Sahrens if (zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT) { 1459789Sahrens (void) fprintf(stderr, gettext("cannot set %s property for " 1460789Sahrens "'%s': snapshot properties cannot be modified\n"), 1461789Sahrens cbp->cb_propname, zfs_get_name(zhp)); 1462789Sahrens return (1); 1463789Sahrens } 1464789Sahrens 1465789Sahrens /* 14661133Seschrock * If we're changing the volsize, make sure the value is appropriate, 14671133Seschrock * and set the reservation if this is a non-sparse volume. 1468789Sahrens */ 1469789Sahrens if (cbp->cb_prop == ZFS_PROP_VOLSIZE && 14701133Seschrock zfs_get_type(zhp) == ZFS_TYPE_VOLUME) { 1471789Sahrens uint64_t volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE); 1472789Sahrens uint64_t avail = zfs_prop_get_int(zhp, ZFS_PROP_AVAILABLE); 14731133Seschrock uint64_t reservation = zfs_prop_get_int(zhp, 14741133Seschrock ZFS_PROP_RESERVATION); 14751133Seschrock uint64_t blocksize = zfs_prop_get_int(zhp, 14761133Seschrock ZFS_PROP_VOLBLOCKSIZE); 1477789Sahrens uint64_t value; 1478789Sahrens 1479789Sahrens verify(zfs_nicestrtonum(cbp->cb_value, &value) == 0); 1480789Sahrens 14811133Seschrock if (value % blocksize != 0) { 14821133Seschrock char buf[64]; 14831133Seschrock 14841133Seschrock zfs_nicenum(blocksize, buf, sizeof (buf)); 14851133Seschrock (void) fprintf(stderr, gettext("cannot set %s for " 14861133Seschrock "'%s': must be a multiple of volume block size " 14871133Seschrock "(%s)\n"), cbp->cb_propname, zfs_get_name(zhp), 14881133Seschrock buf); 1489789Sahrens return (1); 1490789Sahrens } 1491789Sahrens 14921133Seschrock if (value == 0) { 14931133Seschrock (void) fprintf(stderr, gettext("cannot set %s for " 14941133Seschrock "'%s': cannot be zero\n"), cbp->cb_propname, 14951133Seschrock zfs_get_name(zhp)); 1496789Sahrens return (1); 1497789Sahrens } 14981133Seschrock 14991133Seschrock if (volsize == reservation) { 15001133Seschrock if (value > volsize && (value - volsize) > avail) { 15011133Seschrock (void) fprintf(stderr, gettext("cannot set " 15021133Seschrock "%s property for '%s': volume size exceeds " 15031133Seschrock "amount of available space\n"), 15041133Seschrock cbp->cb_propname, zfs_get_name(zhp)); 15051133Seschrock return (1); 15061133Seschrock } 15071133Seschrock 15081133Seschrock if (zfs_prop_set(zhp, ZFS_PROP_RESERVATION, 15091133Seschrock cbp->cb_value) != 0) { 15101133Seschrock (void) fprintf(stderr, gettext("volsize and " 15111133Seschrock "reservation must remain equal\n")); 15121133Seschrock return (1); 15131133Seschrock } 15141133Seschrock } 1515789Sahrens } 1516789Sahrens 1517789Sahrens /* 1518789Sahrens * Do not allow the reservation to be set above the volume size. We do 1519789Sahrens * this here instead of inside libzfs because libzfs violates this rule 1520789Sahrens * internally. 1521789Sahrens */ 1522789Sahrens if (cbp->cb_prop == ZFS_PROP_RESERVATION && 1523789Sahrens zfs_get_type(zhp) == ZFS_TYPE_VOLUME) { 1524789Sahrens uint64_t value; 1525789Sahrens uint64_t volsize; 1526789Sahrens 1527789Sahrens volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE); 1528789Sahrens if (strcmp(cbp->cb_value, "none") == 0) 1529789Sahrens value = 0; 1530789Sahrens else 1531789Sahrens verify(zfs_nicestrtonum(cbp->cb_value, &value) == 0); 1532789Sahrens 1533789Sahrens if (value > volsize) { 1534789Sahrens (void) fprintf(stderr, gettext("cannot set %s " 1535789Sahrens "for '%s': size is greater than current " 1536789Sahrens "volume size\n"), cbp->cb_propname, 1537789Sahrens zfs_get_name(zhp)); 1538789Sahrens return (-1); 1539789Sahrens } 1540789Sahrens } 1541789Sahrens 1542789Sahrens if (zfs_prop_set(zhp, cbp->cb_prop, cbp->cb_value) != 0) 1543789Sahrens return (1); 1544789Sahrens 1545789Sahrens ret = 0; 1546789Sahrens error: 1547789Sahrens return (ret); 1548789Sahrens } 1549789Sahrens 1550789Sahrens static int 1551789Sahrens zfs_do_set(int argc, char **argv) 1552789Sahrens { 1553789Sahrens set_cbdata_t cb; 1554789Sahrens 1555789Sahrens /* check for options */ 1556789Sahrens if (argc > 1 && argv[1][0] == '-') { 1557789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1558789Sahrens argv[1][1]); 1559789Sahrens usage(FALSE); 1560789Sahrens } 1561789Sahrens 1562789Sahrens /* check number of arguments */ 1563789Sahrens if (argc < 2) { 1564789Sahrens (void) fprintf(stderr, gettext("missing property=value " 1565789Sahrens "argument\n")); 1566789Sahrens usage(FALSE); 1567789Sahrens } 1568789Sahrens if (argc < 3) { 1569789Sahrens (void) fprintf(stderr, gettext("missing dataset name\n")); 1570789Sahrens usage(FALSE); 1571789Sahrens } 1572789Sahrens 1573789Sahrens /* validate property=value argument */ 1574789Sahrens cb.cb_propname = argv[1]; 1575789Sahrens if ((cb.cb_value = strchr(cb.cb_propname, '=')) == NULL) { 1576789Sahrens (void) fprintf(stderr, gettext("missing value in " 1577789Sahrens "property=value argument\n")); 1578789Sahrens usage(FALSE); 1579789Sahrens } 1580789Sahrens 1581789Sahrens *cb.cb_value = '\0'; 1582789Sahrens cb.cb_value++; 1583789Sahrens 1584789Sahrens if (*cb.cb_propname == '\0') { 1585789Sahrens (void) fprintf(stderr, 1586789Sahrens gettext("missing property in property=value argument\n")); 1587789Sahrens usage(FALSE); 1588789Sahrens } 1589789Sahrens if (*cb.cb_value == '\0') { 1590789Sahrens (void) fprintf(stderr, 1591789Sahrens gettext("missing value in property=value argument\n")); 1592789Sahrens usage(FALSE); 1593789Sahrens } 1594789Sahrens 1595789Sahrens /* get the property type */ 1596789Sahrens if ((cb.cb_prop = zfs_name_to_prop(cb.cb_propname)) == 1597789Sahrens ZFS_PROP_INVAL) { 1598789Sahrens (void) fprintf(stderr, 1599789Sahrens gettext("invalid property '%s'\n"), cb.cb_propname); 1600789Sahrens usage(FALSE); 1601789Sahrens } 1602789Sahrens 1603789Sahrens /* 1604789Sahrens * Validate that the value is appropriate for this property. We do this 1605789Sahrens * once now so we don't generate multiple errors each time we try to 1606789Sahrens * apply it to a dataset. 1607789Sahrens */ 1608789Sahrens if (zfs_prop_validate(cb.cb_prop, cb.cb_value, NULL) != 0) 1609789Sahrens return (1); 1610789Sahrens 1611789Sahrens return (zfs_for_each(argc - 2, argv + 2, FALSE, 1612789Sahrens ZFS_TYPE_ANY, set_callback, &cb)); 1613789Sahrens } 1614789Sahrens 1615789Sahrens /* 1616789Sahrens * zfs snapshot <fs@snap> 1617789Sahrens * 1618789Sahrens * Creates a snapshot with the given name. While functionally equivalent to 1619789Sahrens * 'zfs create', it is a separate command to diffferentiate intent. 1620789Sahrens */ 1621789Sahrens static int 1622789Sahrens zfs_do_snapshot(int argc, char **argv) 1623789Sahrens { 1624789Sahrens /* check options */ 1625789Sahrens if (argc > 1 && argv[1][0] == '-') { 1626789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1627789Sahrens argv[1][1]); 1628789Sahrens usage(FALSE); 1629789Sahrens } 1630789Sahrens 1631789Sahrens /* check number of arguments */ 1632789Sahrens if (argc < 2) { 1633789Sahrens (void) fprintf(stderr, gettext("missing snapshot argument\n")); 1634789Sahrens usage(FALSE); 1635789Sahrens } 1636789Sahrens if (argc > 2) { 1637789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 1638789Sahrens usage(FALSE); 1639789Sahrens } 1640789Sahrens 1641789Sahrens return (zfs_snapshot(argv[1]) != 0); 1642789Sahrens } 1643789Sahrens 1644789Sahrens /* 1645789Sahrens * zfs backup [-i <fs@snap>] <fs@snap> 1646789Sahrens * 1647789Sahrens * Send a backup stream to stdout. 1648789Sahrens */ 1649789Sahrens static int 1650789Sahrens zfs_do_backup(int argc, char **argv) 1651789Sahrens { 1652789Sahrens char *fromname = NULL; 1653789Sahrens zfs_handle_t *zhp_from = NULL, *zhp_to; 1654789Sahrens int c, err; 1655789Sahrens 1656789Sahrens /* check options */ 1657789Sahrens while ((c = getopt(argc, argv, ":i:")) != -1) { 1658789Sahrens switch (c) { 1659789Sahrens case 'i': 1660789Sahrens fromname = optarg; 1661789Sahrens break; 1662789Sahrens case ':': 1663789Sahrens (void) fprintf(stderr, gettext("missing argument for " 1664789Sahrens "'%c' option\n"), optopt); 1665789Sahrens usage(FALSE); 1666789Sahrens break; 1667789Sahrens case '?': 1668789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1669789Sahrens optopt); 1670789Sahrens usage(FALSE); 1671789Sahrens } 1672789Sahrens } 1673789Sahrens 1674789Sahrens argc -= optind; 1675789Sahrens argv += optind; 1676789Sahrens 1677789Sahrens /* check number of arguments */ 1678789Sahrens if (argc < 1) { 1679789Sahrens (void) fprintf(stderr, gettext("missing snapshot argument\n")); 1680789Sahrens usage(FALSE); 1681789Sahrens } 1682789Sahrens if (argc > 1) { 1683789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 1684789Sahrens usage(FALSE); 1685789Sahrens } 1686789Sahrens 1687789Sahrens if (isatty(STDOUT_FILENO)) { 1688789Sahrens (void) fprintf(stderr, 1689789Sahrens gettext("Error: Backup stream can not be written " 1690789Sahrens "to a terminal.\n" 1691789Sahrens "You must redirect standard output.\n")); 1692789Sahrens return (1); 1693789Sahrens } 1694789Sahrens 1695789Sahrens if (fromname) { 1696789Sahrens if ((zhp_from = zfs_open(fromname, ZFS_TYPE_SNAPSHOT)) == NULL) 1697789Sahrens return (1); 1698789Sahrens } 1699789Sahrens if ((zhp_to = zfs_open(argv[0], ZFS_TYPE_SNAPSHOT)) == NULL) 1700789Sahrens return (1); 1701789Sahrens 1702789Sahrens err = zfs_backup(zhp_to, zhp_from); 1703789Sahrens 1704789Sahrens if (zhp_from) 1705789Sahrens zfs_close(zhp_from); 1706789Sahrens zfs_close(zhp_to); 1707789Sahrens 1708789Sahrens return (err != 0); 1709789Sahrens } 1710789Sahrens 1711789Sahrens /* 1712789Sahrens * zfs restore <fs@snap> 1713789Sahrens * 1714789Sahrens * Restore a backup stream from stdin. 1715789Sahrens */ 1716789Sahrens static int 1717789Sahrens zfs_do_restore(int argc, char **argv) 1718789Sahrens { 1719789Sahrens int c, err; 1720789Sahrens int isprefix = FALSE; 1721789Sahrens int dryrun = FALSE; 1722789Sahrens int verbose = FALSE; 1723789Sahrens 1724789Sahrens /* check options */ 1725789Sahrens while ((c = getopt(argc, argv, ":dnv")) != -1) { 1726789Sahrens switch (c) { 1727789Sahrens case 'd': 1728789Sahrens isprefix = TRUE; 1729789Sahrens break; 1730789Sahrens case 'n': 1731789Sahrens dryrun = TRUE; 1732789Sahrens break; 1733789Sahrens case 'v': 1734789Sahrens verbose = TRUE; 1735789Sahrens break; 1736789Sahrens case ':': 1737789Sahrens (void) fprintf(stderr, gettext("missing argument for " 1738789Sahrens "'%c' option\n"), optopt); 1739789Sahrens usage(FALSE); 1740789Sahrens break; 1741789Sahrens case '?': 1742789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1743789Sahrens optopt); 1744789Sahrens usage(FALSE); 1745789Sahrens } 1746789Sahrens } 1747789Sahrens 1748789Sahrens argc -= optind; 1749789Sahrens argv += optind; 1750789Sahrens 1751789Sahrens /* check number of arguments */ 1752789Sahrens if (argc < 1) { 1753789Sahrens (void) fprintf(stderr, gettext("missing snapshot argument\n")); 1754789Sahrens usage(FALSE); 1755789Sahrens } 1756789Sahrens if (argc > 1) { 1757789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 1758789Sahrens usage(FALSE); 1759789Sahrens } 1760789Sahrens 1761789Sahrens if (isatty(STDIN_FILENO)) { 1762789Sahrens (void) fprintf(stderr, 1763789Sahrens gettext("Error: Backup stream can not be read " 1764789Sahrens "from a terminal.\n" 1765789Sahrens "You must redirect standard input.\n")); 1766789Sahrens return (1); 1767789Sahrens } 1768789Sahrens 1769789Sahrens err = zfs_restore(argv[0], isprefix, verbose, dryrun); 1770789Sahrens return (err != 0); 1771789Sahrens } 1772789Sahrens 1773789Sahrens 1774789Sahrens /* 1775789Sahrens * Generic callback for sharing or mounting filesystems. Because the code is so 1776789Sahrens * similar, we have a common function with an extra parameter to determine which 1777789Sahrens * mode we are using. 1778789Sahrens */ 1779789Sahrens #define OP_SHARE 0x1 1780789Sahrens #define OP_MOUNT 0x2 1781789Sahrens 1782789Sahrens typedef struct share_mount_cbdata { 1783789Sahrens int cb_type; 1784789Sahrens int cb_explicit; 1785789Sahrens int cb_flags; 1786789Sahrens const char *cb_options; 1787789Sahrens } share_mount_cbdata_t; 1788789Sahrens 1789789Sahrens /* 1790789Sahrens * Share or mount the filesystem. 1791789Sahrens */ 1792789Sahrens static int 1793789Sahrens share_mount_callback(zfs_handle_t *zhp, void *data) 1794789Sahrens { 1795789Sahrens char mountpoint[ZFS_MAXPROPLEN]; 1796789Sahrens char shareopts[ZFS_MAXPROPLEN]; 1797789Sahrens share_mount_cbdata_t *cbp = data; 1798789Sahrens const char *cmdname = cbp->cb_type == OP_SHARE ? "share" : "mount"; 1799789Sahrens struct mnttab mnt; 1800789Sahrens uint64_t zoned; 1801789Sahrens 1802789Sahrens if (cbp->cb_options == NULL) 1803789Sahrens mnt.mnt_mntopts = ""; 1804789Sahrens else 1805789Sahrens mnt.mnt_mntopts = (char *)cbp->cb_options; 1806789Sahrens 1807789Sahrens /* 1808789Sahrens * Check to make sure we can mount/share this dataset. If we are in the 1809789Sahrens * global zone and the filesystem is exported to a local zone, or if we 1810789Sahrens * are in a local zone and the filesystem is not exported, then it is an 1811789Sahrens * error. 1812789Sahrens */ 1813789Sahrens zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED); 1814789Sahrens 1815789Sahrens if (zoned && getzoneid() == GLOBAL_ZONEID) { 1816789Sahrens if (!cbp->cb_explicit) 1817789Sahrens return (0); 1818789Sahrens 1819789Sahrens (void) fprintf(stderr, gettext("cannot %s '%s': dataset is " 1820789Sahrens "exported to a local zone\n"), cmdname, zfs_get_name(zhp)); 1821789Sahrens return (1); 1822789Sahrens 1823789Sahrens } else if (!zoned && getzoneid() != GLOBAL_ZONEID) { 1824789Sahrens if (!cbp->cb_explicit) 1825789Sahrens return (0); 1826789Sahrens 1827789Sahrens (void) fprintf(stderr, gettext("cannot %s '%s': permission " 1828789Sahrens "denied\n"), cmdname, zfs_get_name(zhp)); 1829789Sahrens return (1); 1830789Sahrens } 1831789Sahrens 1832789Sahrens /* 1833789Sahrens * Inore any filesystems which don't apply to us. This includes those 1834789Sahrens * with a legacy mountpoint, or those with legacy share options. 1835789Sahrens */ 1836789Sahrens verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint, 1837789Sahrens sizeof (mountpoint), NULL, NULL, 0, FALSE) == 0); 1838789Sahrens verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, shareopts, 1839789Sahrens sizeof (shareopts), NULL, NULL, 0, FALSE) == 0); 1840789Sahrens 1841789Sahrens if (cbp->cb_type == OP_SHARE) { 1842789Sahrens if (strcmp(shareopts, "off") == 0) { 1843789Sahrens if (!cbp->cb_explicit) 1844789Sahrens return (0); 1845789Sahrens 1846789Sahrens (void) fprintf(stderr, gettext("cannot share '%s': " 1847789Sahrens "legacy share\n"), zfs_get_name(zhp)); 1848789Sahrens (void) fprintf(stderr, gettext("use share(1M) to " 1849789Sahrens "share this filesystem\n")); 1850789Sahrens return (1); 1851789Sahrens } 1852789Sahrens } 1853789Sahrens 1854789Sahrens /* 1855789Sahrens * We cannot share or mount legacy filesystems. If the shareopts is 1856789Sahrens * non-legacy but the mountpoint is legacy, we treat it as a legacy 1857789Sahrens * share. 1858789Sahrens */ 1859789Sahrens if (strcmp(mountpoint, "legacy") == 0) { 1860789Sahrens if (!cbp->cb_explicit) 1861789Sahrens return (0); 1862789Sahrens 1863789Sahrens (void) fprintf(stderr, gettext("cannot %s '%s': " 1864789Sahrens "legacy mountpoint\n"), cmdname, zfs_get_name(zhp)); 1865789Sahrens (void) fprintf(stderr, gettext("use %s to " 1866789Sahrens "%s this filesystem\n"), cbp->cb_type == OP_SHARE ? 1867789Sahrens "share(1M)" : "mount(1M)", cmdname); 1868789Sahrens return (1); 1869789Sahrens } 1870789Sahrens 1871789Sahrens if (strcmp(mountpoint, "none") == 0) { 1872789Sahrens if (!cbp->cb_explicit) 1873789Sahrens return (0); 1874789Sahrens 1875789Sahrens (void) fprintf(stderr, gettext("cannot %s '%s': no " 1876789Sahrens "mountpoint set\n"), cmdname, zfs_get_name(zhp)); 1877789Sahrens return (1); 1878789Sahrens } 1879789Sahrens 1880789Sahrens /* 1881789Sahrens * At this point, we have verified that the mountpoint and/or shareopts 1882789Sahrens * are appropriate for auto management. Determine if the filesystem is 1883789Sahrens * currently mounted or shared, and abort if this is an explicit 1884789Sahrens * request. 1885789Sahrens */ 1886789Sahrens switch (cbp->cb_type) { 1887789Sahrens case OP_SHARE: 1888789Sahrens if (zfs_is_shared(zhp, NULL)) { 1889789Sahrens if (cbp->cb_explicit) { 1890789Sahrens (void) fprintf(stderr, gettext("cannot share " 1891789Sahrens "'%s': filesystem already shared\n"), 1892789Sahrens zfs_get_name(zhp)); 1893789Sahrens return (1); 1894789Sahrens } else { 1895789Sahrens return (0); 1896789Sahrens } 1897789Sahrens } 1898789Sahrens break; 1899789Sahrens 1900789Sahrens case OP_MOUNT: 1901789Sahrens if (!hasmntopt(&mnt, MNTOPT_REMOUNT) && 1902789Sahrens zfs_is_mounted(zhp, NULL)) { 1903789Sahrens if (cbp->cb_explicit) { 1904789Sahrens (void) fprintf(stderr, gettext("cannot mount " 1905789Sahrens "'%s': filesystem already mounted\n"), 1906789Sahrens zfs_get_name(zhp)); 1907789Sahrens return (1); 1908789Sahrens } else { 1909789Sahrens return (0); 1910789Sahrens } 1911789Sahrens } 1912789Sahrens break; 1913789Sahrens } 1914789Sahrens 1915789Sahrens /* 1916789Sahrens * Mount and optionally share the filesystem. 1917789Sahrens */ 1918789Sahrens switch (cbp->cb_type) { 1919789Sahrens case OP_SHARE: 1920789Sahrens { 1921789Sahrens if (!zfs_is_mounted(zhp, NULL) && 1922789Sahrens zfs_mount(zhp, NULL, 0) != 0) 1923789Sahrens return (1); 1924789Sahrens 1925789Sahrens if (zfs_share(zhp) != 0) 1926789Sahrens return (1); 1927789Sahrens } 1928789Sahrens break; 1929789Sahrens 1930789Sahrens case OP_MOUNT: 1931789Sahrens if (zfs_mount(zhp, cbp->cb_options, cbp->cb_flags) != 0) 1932789Sahrens return (1); 1933789Sahrens break; 1934789Sahrens } 1935789Sahrens 1936789Sahrens return (0); 1937789Sahrens } 1938789Sahrens 1939789Sahrens static int 1940789Sahrens share_or_mount(int type, int argc, char **argv) 1941789Sahrens { 1942789Sahrens int do_all = 0; 1943789Sahrens int c, ret; 1944789Sahrens share_mount_cbdata_t cb = { 0 }; 1945789Sahrens 1946789Sahrens cb.cb_type = type; 1947789Sahrens 1948789Sahrens /* check options */ 1949789Sahrens while ((c = getopt(argc, argv, type == OP_MOUNT ? ":ao:O" : "a")) 1950789Sahrens != -1) { 1951789Sahrens switch (c) { 1952789Sahrens case 'a': 1953789Sahrens do_all = 1; 1954789Sahrens break; 1955789Sahrens case 'o': 1956789Sahrens cb.cb_options = optarg; 1957789Sahrens break; 1958789Sahrens case 'O': 1959789Sahrens cb.cb_flags |= MS_OVERLAY; 1960789Sahrens break; 1961789Sahrens case ':': 1962789Sahrens (void) fprintf(stderr, gettext("missing argument for " 1963789Sahrens "'%c' option\n"), optopt); 1964789Sahrens usage(FALSE); 1965789Sahrens break; 1966789Sahrens case '?': 1967789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1968789Sahrens optopt); 1969789Sahrens usage(FALSE); 1970789Sahrens } 1971789Sahrens } 1972789Sahrens 1973789Sahrens argc -= optind; 1974789Sahrens argv += optind; 1975789Sahrens 1976789Sahrens /* check number of arguments */ 1977789Sahrens if (do_all) { 1978789Sahrens if (argc != 0) { 1979789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 1980789Sahrens usage(FALSE); 1981789Sahrens } 1982789Sahrens 1983789Sahrens ret = zfs_for_each(argc, argv, TRUE, 1984789Sahrens ZFS_TYPE_FILESYSTEM, share_mount_callback, &cb); 1985789Sahrens } else if (argc == 0) { 1986789Sahrens struct mnttab entry; 1987789Sahrens 1988789Sahrens if (type == OP_SHARE) { 1989789Sahrens (void) fprintf(stderr, gettext("missing filesystem " 1990789Sahrens "argument\n")); 1991789Sahrens usage(FALSE); 1992789Sahrens } 1993789Sahrens 1994789Sahrens /* 1995789Sahrens * When mount is given no arguments, go through /etc/mnttab and 1996789Sahrens * display any active ZFS mounts. We hide any snapshots, since 1997789Sahrens * they are controlled automatically. 1998789Sahrens */ 1999789Sahrens rewind(mnttab_file); 2000789Sahrens while (getmntent(mnttab_file, &entry) == 0) { 2001789Sahrens if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0 || 2002789Sahrens strchr(entry.mnt_special, '@') != NULL) 2003789Sahrens continue; 2004789Sahrens 2005789Sahrens (void) printf("%-30s %s\n", entry.mnt_special, 2006789Sahrens entry.mnt_mountp); 2007789Sahrens } 2008789Sahrens 2009789Sahrens ret = 0; 2010789Sahrens } else { 2011789Sahrens zfs_handle_t *zhp; 2012789Sahrens 2013789Sahrens if (argc > 1) { 2014789Sahrens (void) fprintf(stderr, 2015789Sahrens gettext("too many arguments\n")); 2016789Sahrens usage(FALSE); 2017789Sahrens } 2018789Sahrens 2019789Sahrens if ((zhp = zfs_open(argv[0], ZFS_TYPE_FILESYSTEM)) == NULL) 2020789Sahrens ret = 1; 2021789Sahrens else { 2022789Sahrens cb.cb_explicit = TRUE; 2023789Sahrens ret = share_mount_callback(zhp, &cb); 2024789Sahrens zfs_close(zhp); 2025789Sahrens } 2026789Sahrens } 2027789Sahrens 2028789Sahrens return (ret); 2029789Sahrens } 2030789Sahrens 2031789Sahrens /* 2032789Sahrens * zfs mount -a 2033789Sahrens * zfs mount filesystem 2034789Sahrens * 2035789Sahrens * Mount all filesystems, or mount the given filesystem. 2036789Sahrens */ 2037789Sahrens static int 2038789Sahrens zfs_do_mount(int argc, char **argv) 2039789Sahrens { 2040789Sahrens return (share_or_mount(OP_MOUNT, argc, argv)); 2041789Sahrens } 2042789Sahrens 2043789Sahrens /* 2044789Sahrens * zfs share -a 2045789Sahrens * zfs share filesystem 2046789Sahrens * 2047789Sahrens * Share all filesystems, or share the given filesystem. 2048789Sahrens */ 2049789Sahrens static int 2050789Sahrens zfs_do_share(int argc, char **argv) 2051789Sahrens { 2052789Sahrens return (share_or_mount(OP_SHARE, argc, argv)); 2053789Sahrens } 2054789Sahrens 2055789Sahrens typedef struct unshare_unmount_node { 2056789Sahrens zfs_handle_t *un_zhp; 2057789Sahrens char *un_mountp; 2058789Sahrens uu_avl_node_t un_avlnode; 2059789Sahrens } unshare_unmount_node_t; 2060789Sahrens 2061789Sahrens /* ARGSUSED */ 2062789Sahrens static int 2063789Sahrens unshare_unmount_compare(const void *larg, const void *rarg, void *unused) 2064789Sahrens { 2065789Sahrens const unshare_unmount_node_t *l = larg; 2066789Sahrens const unshare_unmount_node_t *r = rarg; 2067789Sahrens 2068789Sahrens return (strcmp(l->un_mountp, r->un_mountp)); 2069789Sahrens } 2070789Sahrens 2071789Sahrens /* 2072789Sahrens * Convenience routine used by zfs_do_umount() and manual_unmount(). Given an 2073789Sahrens * absolute path, find the entry /etc/mnttab, verify that its a ZFS filesystem, 2074789Sahrens * and unmount it appropriately. 2075789Sahrens */ 2076789Sahrens static int 2077789Sahrens unshare_unmount_path(int type, char *path, int flags, int is_manual) 2078789Sahrens { 2079789Sahrens zfs_handle_t *zhp; 2080789Sahrens int ret; 2081789Sahrens struct stat64 statbuf; 2082789Sahrens struct extmnttab entry; 2083789Sahrens const char *cmdname = (type == OP_SHARE) ? "unshare" : "unmount"; 2084789Sahrens char property[ZFS_MAXPROPLEN]; 2085789Sahrens 2086789Sahrens /* 2087789Sahrens * Search for the path in /etc/mnttab. Rather than looking for the 2088789Sahrens * specific path, which can be fooled by non-standard paths (i.e. ".." 2089789Sahrens * or "//"), we stat() the path and search for the corresponding 2090789Sahrens * (major,minor) device pair. 2091789Sahrens */ 2092789Sahrens if (stat64(path, &statbuf) != 0) { 2093789Sahrens (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"), 2094789Sahrens cmdname, path, strerror(errno)); 2095789Sahrens return (1); 2096789Sahrens } 2097789Sahrens 2098789Sahrens /* 2099789Sahrens * Search for the given (major,minor) pair in the mount table. 2100789Sahrens */ 2101789Sahrens rewind(mnttab_file); 2102789Sahrens while ((ret = getextmntent(mnttab_file, &entry, 0)) == 0) { 2103789Sahrens if (entry.mnt_major == major(statbuf.st_dev) && 2104789Sahrens entry.mnt_minor == minor(statbuf.st_dev)) 2105789Sahrens break; 2106789Sahrens } 2107789Sahrens if (ret != 0) { 2108789Sahrens (void) fprintf(stderr, gettext("cannot %s '%s': not " 2109789Sahrens "currently mounted\n"), cmdname, path); 2110789Sahrens return (1); 2111789Sahrens } 2112789Sahrens 2113789Sahrens if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) { 2114789Sahrens (void) fprintf(stderr, gettext("cannot %s '%s': not a ZFS " 2115789Sahrens "filesystem\n"), cmdname, path); 2116789Sahrens return (1); 2117789Sahrens } 2118789Sahrens 2119789Sahrens if ((zhp = zfs_open(entry.mnt_special, ZFS_TYPE_FILESYSTEM)) == NULL) 2120789Sahrens return (1); 2121789Sahrens 2122789Sahrens verify(zfs_prop_get(zhp, type == OP_SHARE ? 2123789Sahrens ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT, property, 2124789Sahrens sizeof (property), NULL, NULL, 0, FALSE) == 0); 2125789Sahrens 2126789Sahrens if (type == OP_SHARE) { 2127789Sahrens if (strcmp(property, "off") == 0) { 2128789Sahrens (void) fprintf(stderr, gettext("cannot unshare " 2129789Sahrens "'%s': legacy share\n"), path); 2130789Sahrens (void) fprintf(stderr, gettext("use " 2131789Sahrens "unshare(1M) to unshare this filesystem\n")); 2132789Sahrens ret = 1; 2133789Sahrens } else if (!zfs_is_shared(zhp, NULL)) { 2134789Sahrens (void) fprintf(stderr, gettext("cannot unshare '%s': " 2135789Sahrens "not currently shared\n"), path); 2136789Sahrens ret = 1; 2137789Sahrens } else { 2138789Sahrens ret = zfs_unshareall(zhp); 2139789Sahrens } 2140789Sahrens } else { 21411264Slling if (is_manual) { 21421264Slling ret = zfs_unmount(zhp, NULL, flags); 21431264Slling } else if (strcmp(property, "legacy") == 0) { 21441264Slling (void) fprintf(stderr, gettext("cannot unmount " 21451264Slling "'%s': legacy mountpoint\n"), 21461264Slling zfs_get_name(zhp)); 21471264Slling (void) fprintf(stderr, gettext("use umount(1M) " 21481264Slling "to unmount this filesystem\n")); 21491264Slling ret = 1; 2150789Sahrens } else { 2151789Sahrens ret = zfs_unmountall(zhp, flags); 2152789Sahrens } 2153789Sahrens } 2154789Sahrens 2155789Sahrens zfs_close(zhp); 2156789Sahrens 2157789Sahrens return (ret != 0); 2158789Sahrens } 2159789Sahrens 2160789Sahrens /* 2161789Sahrens * Generic callback for unsharing or unmounting a filesystem. 2162789Sahrens */ 2163789Sahrens static int 2164789Sahrens unshare_unmount(int type, int argc, char **argv) 2165789Sahrens { 2166789Sahrens int do_all = 0; 2167789Sahrens int flags = 0; 2168789Sahrens int ret = 0; 2169789Sahrens int c; 2170789Sahrens zfs_handle_t *zhp; 2171789Sahrens char property[ZFS_MAXPROPLEN]; 2172789Sahrens 2173789Sahrens /* check options */ 2174789Sahrens while ((c = getopt(argc, argv, type == OP_SHARE ? "a" : "af")) != -1) { 2175789Sahrens switch (c) { 2176789Sahrens case 'a': 2177789Sahrens do_all = 1; 2178789Sahrens break; 2179789Sahrens case 'f': 2180789Sahrens flags = MS_FORCE; 2181789Sahrens break; 2182789Sahrens case '?': 2183789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2184789Sahrens optopt); 2185789Sahrens usage(FALSE); 2186789Sahrens } 2187789Sahrens } 2188789Sahrens 2189789Sahrens argc -= optind; 2190789Sahrens argv += optind; 2191789Sahrens 2192789Sahrens /* ensure correct number of arguments */ 2193789Sahrens if (do_all) { 2194789Sahrens if (argc != 0) { 2195789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 2196789Sahrens usage(FALSE); 2197789Sahrens } 2198789Sahrens } else if (argc != 1) { 2199789Sahrens if (argc == 0) 2200789Sahrens (void) fprintf(stderr, 2201789Sahrens gettext("missing filesystem argument\n")); 2202789Sahrens else 2203789Sahrens (void) fprintf(stderr, 2204789Sahrens gettext("too many arguments\n")); 2205789Sahrens usage(FALSE); 2206789Sahrens } 2207789Sahrens 2208789Sahrens if (do_all) { 2209789Sahrens /* 2210789Sahrens * We could make use of zfs_for_each() to walk all datasets in 2211789Sahrens * the system, but this would be very inefficient, especially 2212789Sahrens * since we would have to linearly search /etc/mnttab for each 2213789Sahrens * one. Instead, do one pass through /etc/mnttab looking for 2214789Sahrens * zfs entries and call zfs_unmount() for each one. 2215789Sahrens * 2216789Sahrens * Things get a little tricky if the administrator has created 2217789Sahrens * mountpoints beneath other ZFS filesystems. In this case, we 2218789Sahrens * have to unmount the deepest filesystems first. To accomplish 2219789Sahrens * this, we place all the mountpoints in an AVL tree sorted by 2220789Sahrens * the special type (dataset name), and walk the result in 2221789Sahrens * reverse to make sure to get any snapshots first. 2222789Sahrens */ 2223789Sahrens struct mnttab entry; 2224789Sahrens uu_avl_pool_t *pool; 2225789Sahrens uu_avl_t *tree; 2226789Sahrens unshare_unmount_node_t *node; 2227789Sahrens uu_avl_index_t idx; 2228789Sahrens uu_avl_walk_t *walk; 2229789Sahrens 2230789Sahrens if ((pool = uu_avl_pool_create("unmount_pool", 2231789Sahrens sizeof (unshare_unmount_node_t), 2232789Sahrens offsetof(unshare_unmount_node_t, un_avlnode), 2233789Sahrens unshare_unmount_compare, 2234789Sahrens UU_DEFAULT)) == NULL) { 2235789Sahrens (void) fprintf(stderr, gettext("internal error: " 2236789Sahrens "out of memory\n")); 2237789Sahrens exit(1); 2238789Sahrens } 2239789Sahrens 2240789Sahrens if ((tree = uu_avl_create(pool, NULL, UU_DEFAULT)) == NULL) { 2241789Sahrens (void) fprintf(stderr, gettext("internal error: " 2242789Sahrens "out of memory\n")); 2243789Sahrens exit(1); 2244789Sahrens } 2245789Sahrens 2246789Sahrens rewind(mnttab_file); 2247789Sahrens while (getmntent(mnttab_file, &entry) == 0) { 2248789Sahrens 2249789Sahrens /* ignore non-ZFS entries */ 2250789Sahrens if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) 2251789Sahrens continue; 2252789Sahrens 2253789Sahrens /* ignore snapshots */ 2254789Sahrens if (strchr(entry.mnt_special, '@') != NULL) 2255789Sahrens continue; 2256789Sahrens 2257789Sahrens if ((zhp = zfs_open(entry.mnt_special, 2258789Sahrens ZFS_TYPE_FILESYSTEM)) == NULL) { 2259789Sahrens ret = 1; 2260789Sahrens continue; 2261789Sahrens } 2262789Sahrens 2263789Sahrens verify(zfs_prop_get(zhp, type == OP_SHARE ? 2264789Sahrens ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT, 2265789Sahrens property, sizeof (property), NULL, NULL, 2266789Sahrens 0, FALSE) == 0); 2267789Sahrens 2268789Sahrens /* Ignore legacy mounts and shares */ 2269789Sahrens if ((type == OP_SHARE && 2270789Sahrens strcmp(property, "off") == 0) || 2271789Sahrens (type == OP_MOUNT && 2272789Sahrens strcmp(property, "legacy") == 0)) { 2273789Sahrens zfs_close(zhp); 2274789Sahrens continue; 2275789Sahrens } 2276789Sahrens 2277789Sahrens node = safe_malloc(sizeof (unshare_unmount_node_t)); 2278789Sahrens node->un_zhp = zhp; 2279789Sahrens 2280789Sahrens if ((node->un_mountp = strdup(entry.mnt_mountp)) == 2281789Sahrens NULL) { 2282789Sahrens (void) fprintf(stderr, gettext("internal error:" 2283789Sahrens " out of memory\n")); 2284789Sahrens exit(1); 2285789Sahrens } 2286789Sahrens 2287789Sahrens uu_avl_node_init(node, &node->un_avlnode, pool); 2288789Sahrens 2289789Sahrens if (uu_avl_find(tree, node, NULL, &idx) == NULL) { 2290789Sahrens uu_avl_insert(tree, node, idx); 2291789Sahrens } else { 2292789Sahrens zfs_close(node->un_zhp); 2293789Sahrens free(node->un_mountp); 2294789Sahrens free(node); 2295789Sahrens } 2296789Sahrens } 2297789Sahrens 2298789Sahrens /* 2299789Sahrens * Walk the AVL tree in reverse, unmounting each filesystem and 2300789Sahrens * removing it from the AVL tree in the process. 2301789Sahrens */ 2302789Sahrens if ((walk = uu_avl_walk_start(tree, 2303789Sahrens UU_WALK_REVERSE | UU_WALK_ROBUST)) == NULL) { 2304789Sahrens (void) fprintf(stderr, 2305789Sahrens gettext("internal error: out of memory")); 2306789Sahrens exit(1); 2307789Sahrens } 2308789Sahrens 2309789Sahrens while ((node = uu_avl_walk_next(walk)) != NULL) { 2310789Sahrens uu_avl_remove(tree, node); 2311789Sahrens 2312789Sahrens switch (type) { 2313789Sahrens case OP_SHARE: 2314789Sahrens if (zfs_unshare(node->un_zhp, 2315789Sahrens node->un_mountp) != 0) 2316789Sahrens ret = 1; 2317789Sahrens break; 2318789Sahrens 2319789Sahrens case OP_MOUNT: 2320789Sahrens if (zfs_unmount(node->un_zhp, 2321789Sahrens node->un_mountp, flags) != 0) 2322789Sahrens ret = 1; 2323789Sahrens break; 2324789Sahrens } 2325789Sahrens 2326789Sahrens zfs_close(node->un_zhp); 2327789Sahrens free(node->un_mountp); 2328789Sahrens free(node); 2329789Sahrens } 2330789Sahrens 2331789Sahrens uu_avl_walk_end(walk); 2332789Sahrens uu_avl_destroy(tree); 2333789Sahrens uu_avl_pool_destroy(pool); 2334789Sahrens } else { 2335789Sahrens /* 2336789Sahrens * We have an argument, but it may be a full path or a ZFS 2337789Sahrens * filesystem. Pass full paths off to unmount_path() (shared by 2338789Sahrens * manual_unmount), otherwise open the filesystem and pass to 2339789Sahrens * zfs_unmount(). 2340789Sahrens */ 2341789Sahrens if (argv[0][0] == '/') 2342789Sahrens return (unshare_unmount_path(type, argv[0], 2343789Sahrens flags, FALSE)); 2344789Sahrens 2345789Sahrens if ((zhp = zfs_open(argv[0], ZFS_TYPE_FILESYSTEM)) == NULL) 2346789Sahrens return (1); 2347789Sahrens 2348789Sahrens verify(zfs_prop_get(zhp, type == OP_SHARE ? 2349789Sahrens ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT, property, 2350789Sahrens sizeof (property), NULL, NULL, 0, FALSE) == 0); 2351789Sahrens 2352789Sahrens switch (type) { 2353789Sahrens case OP_SHARE: 2354789Sahrens if (strcmp(property, "off") == 0) { 2355789Sahrens (void) fprintf(stderr, gettext("cannot unshare " 2356789Sahrens "'%s': legacy share\n"), zfs_get_name(zhp)); 2357789Sahrens (void) fprintf(stderr, gettext("use unshare(1M)" 2358789Sahrens " to unshare this filesystem\n")); 2359789Sahrens ret = 1; 2360789Sahrens } else if (!zfs_is_shared(zhp, NULL)) { 2361789Sahrens (void) fprintf(stderr, gettext("cannot unshare " 2362789Sahrens "'%s': not currently shared\n"), 2363789Sahrens zfs_get_name(zhp)); 2364789Sahrens ret = 1; 2365789Sahrens } else if (zfs_unshareall(zhp) != 0) { 2366789Sahrens ret = 1; 2367789Sahrens } 2368789Sahrens break; 2369789Sahrens 2370789Sahrens case OP_MOUNT: 2371789Sahrens if (strcmp(property, "legacy") == 0) { 2372789Sahrens (void) fprintf(stderr, gettext("cannot unmount " 2373789Sahrens "'%s': legacy mountpoint\n"), 2374789Sahrens zfs_get_name(zhp)); 2375789Sahrens (void) fprintf(stderr, gettext("use umount(1M) " 2376789Sahrens "to unmount this filesystem\n")); 2377789Sahrens ret = 1; 2378789Sahrens } else if (!zfs_is_mounted(zhp, NULL)) { 2379789Sahrens (void) fprintf(stderr, gettext("cannot unmount " 2380789Sahrens "'%s': not currently mounted\n"), 2381789Sahrens zfs_get_name(zhp)); 2382789Sahrens ret = 1; 2383789Sahrens } else if (zfs_unmountall(zhp, flags) != 0) { 2384789Sahrens ret = 1; 2385789Sahrens } 2386789Sahrens } 2387789Sahrens 2388789Sahrens zfs_close(zhp); 2389789Sahrens } 2390789Sahrens 2391789Sahrens return (ret); 2392789Sahrens } 2393789Sahrens 2394789Sahrens /* 2395789Sahrens * zfs unmount -a 2396789Sahrens * zfs unmount filesystem 2397789Sahrens * 2398789Sahrens * Unmount all filesystems, or a specific ZFS filesystem. 2399789Sahrens */ 2400789Sahrens static int 2401789Sahrens zfs_do_unmount(int argc, char **argv) 2402789Sahrens { 2403789Sahrens return (unshare_unmount(OP_MOUNT, argc, argv)); 2404789Sahrens } 2405789Sahrens 2406789Sahrens /* 2407789Sahrens * zfs unshare -a 2408789Sahrens * zfs unshare filesystem 2409789Sahrens * 2410789Sahrens * Unshare all filesystems, or a specific ZFS filesystem. 2411789Sahrens */ 2412789Sahrens static int 2413789Sahrens zfs_do_unshare(int argc, char **argv) 2414789Sahrens { 2415789Sahrens return (unshare_unmount(OP_SHARE, argc, argv)); 2416789Sahrens } 2417789Sahrens 2418789Sahrens /* 2419789Sahrens * Called when invoked as /etc/fs/zfs/mount. Do the mount if the mountpoint is 2420789Sahrens * 'legacy'. Otherwise, complain that use should be using 'zfs mount'. 2421789Sahrens */ 2422789Sahrens static int 2423789Sahrens manual_mount(int argc, char **argv) 2424789Sahrens { 2425789Sahrens zfs_handle_t *zhp; 2426789Sahrens char mountpoint[ZFS_MAXPROPLEN]; 2427789Sahrens char mntopts[MNT_LINE_MAX] = { '\0' }; 2428789Sahrens int ret; 2429789Sahrens int c; 2430789Sahrens int flags = 0; 2431789Sahrens char *dataset, *path; 2432789Sahrens 2433789Sahrens /* check options */ 2434789Sahrens while ((c = getopt(argc, argv, ":o:O")) != -1) { 2435789Sahrens switch (c) { 2436789Sahrens case 'o': 2437789Sahrens (void) strlcpy(mntopts, optarg, sizeof (mntopts)); 2438789Sahrens break; 2439789Sahrens case 'O': 2440789Sahrens flags |= MS_OVERLAY; 2441789Sahrens break; 2442789Sahrens case ':': 2443789Sahrens (void) fprintf(stderr, gettext("missing argument for " 2444789Sahrens "'%c' option\n"), optopt); 2445789Sahrens usage(FALSE); 2446789Sahrens break; 2447789Sahrens case '?': 2448789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2449789Sahrens optopt); 2450789Sahrens (void) fprintf(stderr, gettext("usage: mount [-o opts] " 2451789Sahrens "<path>\n")); 2452789Sahrens return (2); 2453789Sahrens } 2454789Sahrens } 2455789Sahrens 2456789Sahrens argc -= optind; 2457789Sahrens argv += optind; 2458789Sahrens 2459789Sahrens /* check that we only have two arguments */ 2460789Sahrens if (argc != 2) { 2461789Sahrens if (argc == 0) 2462789Sahrens (void) fprintf(stderr, gettext("missing dataset " 2463789Sahrens "argument\n")); 2464789Sahrens else if (argc == 1) 2465789Sahrens (void) fprintf(stderr, 2466789Sahrens gettext("missing mountpoint argument\n")); 2467789Sahrens else 2468789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 2469789Sahrens (void) fprintf(stderr, "usage: mount <dataset> <mountpoint>\n"); 2470789Sahrens return (2); 2471789Sahrens } 2472789Sahrens 2473789Sahrens dataset = argv[0]; 2474789Sahrens path = argv[1]; 2475789Sahrens 2476789Sahrens /* try to open the dataset */ 2477789Sahrens if ((zhp = zfs_open(dataset, ZFS_TYPE_FILESYSTEM)) == NULL) 2478789Sahrens return (1); 2479789Sahrens 2480789Sahrens (void) zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint, 2481789Sahrens sizeof (mountpoint), NULL, NULL, 0, FALSE); 2482789Sahrens 2483789Sahrens /* check for legacy mountpoint and complain appropriately */ 2484789Sahrens ret = 0; 2485789Sahrens if (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) == 0) { 2486789Sahrens if (mount(dataset, path, MS_OPTIONSTR | flags, MNTTYPE_ZFS, 2487789Sahrens NULL, 0, mntopts, sizeof (mntopts)) != 0) { 2488789Sahrens (void) fprintf(stderr, gettext("mount failed: %s\n"), 2489789Sahrens strerror(errno)); 2490789Sahrens ret = 1; 2491789Sahrens } 2492789Sahrens } else { 2493789Sahrens (void) fprintf(stderr, gettext("filesystem '%s' cannot be " 2494789Sahrens "mounted using 'mount -F zfs'\n"), dataset); 2495789Sahrens (void) fprintf(stderr, gettext("Use 'zfs set mountpoint=%s' " 2496789Sahrens "instead.\n"), path); 2497789Sahrens (void) fprintf(stderr, gettext("If you must use 'mount -F zfs' " 2498789Sahrens "or /etc/vfstab, use 'zfs set mountpoint=legacy'.\n")); 2499789Sahrens (void) fprintf(stderr, gettext("See zfs(1M) for more " 2500789Sahrens "information.\n")); 2501789Sahrens ret = 1; 2502789Sahrens } 2503789Sahrens 2504789Sahrens return (ret); 2505789Sahrens } 2506789Sahrens 2507789Sahrens /* 2508789Sahrens * Called when invoked as /etc/fs/zfs/umount. Unlike a manual mount, we allow 2509789Sahrens * unmounts of non-legacy filesystems, as this is the dominant administrative 2510789Sahrens * interface. 2511789Sahrens */ 2512789Sahrens static int 2513789Sahrens manual_unmount(int argc, char **argv) 2514789Sahrens { 2515789Sahrens int flags = 0; 2516789Sahrens int c; 2517789Sahrens 2518789Sahrens /* check options */ 2519789Sahrens while ((c = getopt(argc, argv, "f")) != -1) { 2520789Sahrens switch (c) { 2521789Sahrens case 'f': 2522789Sahrens flags = MS_FORCE; 2523789Sahrens break; 2524789Sahrens case '?': 2525789Sahrens (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2526789Sahrens optopt); 2527789Sahrens (void) fprintf(stderr, gettext("usage: unmount [-f] " 2528789Sahrens "<path>\n")); 2529789Sahrens return (2); 2530789Sahrens } 2531789Sahrens } 2532789Sahrens 2533789Sahrens argc -= optind; 2534789Sahrens argv += optind; 2535789Sahrens 2536789Sahrens /* check arguments */ 2537789Sahrens if (argc != 1) { 2538789Sahrens if (argc == 0) 2539789Sahrens (void) fprintf(stderr, gettext("missing path " 2540789Sahrens "argument\n")); 2541789Sahrens else 2542789Sahrens (void) fprintf(stderr, gettext("too many arguments\n")); 2543789Sahrens (void) fprintf(stderr, gettext("usage: unmount [-f] <path>\n")); 2544789Sahrens return (2); 2545789Sahrens } 2546789Sahrens 2547789Sahrens return (unshare_unmount_path(OP_MOUNT, argv[0], flags, TRUE)); 2548789Sahrens } 2549789Sahrens 2550789Sahrens static int 2551789Sahrens volcheck(zpool_handle_t *zhp, void *data) 2552789Sahrens { 2553789Sahrens int isinit = (int)data; 2554789Sahrens 2555789Sahrens if (isinit) 2556789Sahrens return (zpool_create_zvol_links(zhp)); 2557789Sahrens else 2558789Sahrens return (zpool_remove_zvol_links(zhp)); 2559789Sahrens } 2560789Sahrens 2561789Sahrens /* 2562789Sahrens * Iterate over all pools in the system and either create or destroy /dev/zvol 2563789Sahrens * links, depending on the value of 'isinit'. 2564789Sahrens */ 2565789Sahrens static int 2566789Sahrens do_volcheck(int isinit) 2567789Sahrens { 2568789Sahrens return (zpool_iter(volcheck, (void *)isinit) ? 1 : 0); 2569789Sahrens } 2570789Sahrens 2571789Sahrens int 2572789Sahrens main(int argc, char **argv) 2573789Sahrens { 2574789Sahrens int ret; 2575789Sahrens int i; 2576789Sahrens char *progname; 2577789Sahrens char *cmdname; 2578789Sahrens 2579789Sahrens (void) setlocale(LC_ALL, ""); 2580789Sahrens (void) textdomain(TEXT_DOMAIN); 2581789Sahrens 2582789Sahrens opterr = 0; 2583789Sahrens 2584789Sahrens if ((mnttab_file = fopen(MNTTAB, "r")) == NULL) { 2585789Sahrens (void) fprintf(stderr, gettext("internal error: unable to " 2586789Sahrens "open %s\n"), MNTTAB); 2587789Sahrens return (1); 2588789Sahrens } 2589789Sahrens 2590789Sahrens /* 2591789Sahrens * This command also doubles as the /etc/fs mount and unmount program. 2592789Sahrens * Determine if we should take this behavior based on argv[0]. 2593789Sahrens */ 2594789Sahrens progname = basename(argv[0]); 2595789Sahrens if (strcmp(progname, "mount") == 0) { 2596789Sahrens ret = manual_mount(argc, argv); 2597789Sahrens } else if (strcmp(progname, "umount") == 0) { 2598789Sahrens ret = manual_unmount(argc, argv); 2599789Sahrens } else { 2600789Sahrens /* 2601789Sahrens * Make sure the user has specified some command. 2602789Sahrens */ 2603789Sahrens if (argc < 2) { 2604789Sahrens (void) fprintf(stderr, gettext("missing command\n")); 2605789Sahrens usage(FALSE); 2606789Sahrens } 2607789Sahrens 2608789Sahrens cmdname = argv[1]; 2609789Sahrens 2610789Sahrens /* 2611789Sahrens * The 'umount' command is an alias for 'unmount' 2612789Sahrens */ 2613789Sahrens if (strcmp(cmdname, "umount") == 0) 2614789Sahrens cmdname = "unmount"; 2615789Sahrens 2616789Sahrens /* 2617789Sahrens * Special case '-?' 2618789Sahrens */ 2619789Sahrens if (strcmp(cmdname, "-?") == 0) 2620789Sahrens usage(TRUE); 2621789Sahrens 2622789Sahrens /* 2623789Sahrens * 'volinit' and 'volfini' do not appear in the usage message, 2624789Sahrens * so we have to special case them here. 2625789Sahrens */ 2626789Sahrens if (strcmp(cmdname, "volinit") == 0) 2627789Sahrens return (do_volcheck(TRUE)); 2628789Sahrens else if (strcmp(cmdname, "volfini") == 0) 2629789Sahrens return (do_volcheck(FALSE)); 2630789Sahrens 2631789Sahrens /* 2632789Sahrens * Run the appropriate command. 2633789Sahrens */ 2634789Sahrens for (i = 0; i < NCOMMAND; i++) { 2635789Sahrens if (command_table[i].name == NULL) 2636789Sahrens continue; 2637789Sahrens 2638789Sahrens if (strcmp(cmdname, command_table[i].name) == 0) { 2639789Sahrens current_command = &command_table[i]; 2640789Sahrens ret = command_table[i].func(argc - 1, argv + 1); 2641789Sahrens break; 2642789Sahrens } 2643789Sahrens } 2644789Sahrens 2645789Sahrens if (i == NCOMMAND) { 2646789Sahrens (void) fprintf(stderr, gettext("unrecognized " 2647789Sahrens "command '%s'\n"), cmdname); 2648789Sahrens usage(FALSE); 2649789Sahrens } 2650789Sahrens } 2651789Sahrens 2652789Sahrens (void) fclose(mnttab_file); 2653789Sahrens 2654789Sahrens /* 2655789Sahrens * The 'ZFS_ABORT' environment variable causes us to dump core on exit 2656789Sahrens * for the purposes of running ::findleaks. 2657789Sahrens */ 2658789Sahrens if (getenv("ZFS_ABORT") != NULL) { 2659789Sahrens (void) printf("dumping core by request\n"); 2660789Sahrens abort(); 2661789Sahrens } 2662789Sahrens 2663789Sahrens return (ret); 2664789Sahrens } 2665