1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26 #include <assert.h> 27 #include <ctype.h> 28 #include <errno.h> 29 #include <libgen.h> 30 #include <libintl.h> 31 #include <libuutil.h> 32 #include <libnvpair.h> 33 #include <locale.h> 34 #include <stddef.h> 35 #include <stdio.h> 36 #include <stdlib.h> 37 #include <strings.h> 38 #include <unistd.h> 39 #include <fcntl.h> 40 #include <zone.h> 41 #include <grp.h> 42 #include <pwd.h> 43 #include <sys/mkdev.h> 44 #include <sys/mntent.h> 45 #include <sys/mnttab.h> 46 #include <sys/mount.h> 47 #include <sys/stat.h> 48 #include <sys/fs/zfs.h> 49 50 #include <libzfs.h> 51 #include <libuutil.h> 52 53 #include "zfs_iter.h" 54 #include "zfs_util.h" 55 #include "zfs_comutil.h" 56 57 libzfs_handle_t *g_zfs; 58 59 static FILE *mnttab_file; 60 static char history_str[HIS_MAX_RECORD_LEN]; 61 const char *pypath = "/usr/lib/zfs/pyzfs.py"; 62 63 static int zfs_do_clone(int argc, char **argv); 64 static int zfs_do_create(int argc, char **argv); 65 static int zfs_do_destroy(int argc, char **argv); 66 static int zfs_do_get(int argc, char **argv); 67 static int zfs_do_inherit(int argc, char **argv); 68 static int zfs_do_list(int argc, char **argv); 69 static int zfs_do_mount(int argc, char **argv); 70 static int zfs_do_rename(int argc, char **argv); 71 static int zfs_do_rollback(int argc, char **argv); 72 static int zfs_do_set(int argc, char **argv); 73 static int zfs_do_upgrade(int argc, char **argv); 74 static int zfs_do_snapshot(int argc, char **argv); 75 static int zfs_do_unmount(int argc, char **argv); 76 static int zfs_do_share(int argc, char **argv); 77 static int zfs_do_unshare(int argc, char **argv); 78 static int zfs_do_send(int argc, char **argv); 79 static int zfs_do_receive(int argc, char **argv); 80 static int zfs_do_promote(int argc, char **argv); 81 static int zfs_do_userspace(int argc, char **argv); 82 static int zfs_do_python(int argc, char **argv); 83 static int zfs_do_hold(int argc, char **argv); 84 static int zfs_do_release(int argc, char **argv); 85 86 /* 87 * Enable a reasonable set of defaults for libumem debugging on DEBUG builds. 88 */ 89 90 #ifdef DEBUG 91 const char * 92 _umem_debug_init(void) 93 { 94 return ("default,verbose"); /* $UMEM_DEBUG setting */ 95 } 96 97 const char * 98 _umem_logging_init(void) 99 { 100 return ("fail,contents"); /* $UMEM_LOGGING setting */ 101 } 102 #endif 103 104 typedef enum { 105 HELP_CLONE, 106 HELP_CREATE, 107 HELP_DESTROY, 108 HELP_GET, 109 HELP_INHERIT, 110 HELP_UPGRADE, 111 HELP_LIST, 112 HELP_MOUNT, 113 HELP_PROMOTE, 114 HELP_RECEIVE, 115 HELP_RENAME, 116 HELP_ROLLBACK, 117 HELP_SEND, 118 HELP_SET, 119 HELP_SHARE, 120 HELP_SNAPSHOT, 121 HELP_UNMOUNT, 122 HELP_UNSHARE, 123 HELP_ALLOW, 124 HELP_UNALLOW, 125 HELP_USERSPACE, 126 HELP_GROUPSPACE, 127 HELP_HOLD, 128 HELP_HOLDS, 129 HELP_RELEASE 130 } zfs_help_t; 131 132 typedef struct zfs_command { 133 const char *name; 134 int (*func)(int argc, char **argv); 135 zfs_help_t usage; 136 } zfs_command_t; 137 138 /* 139 * Master command table. Each ZFS command has a name, associated function, and 140 * usage message. The usage messages need to be internationalized, so we have 141 * to have a function to return the usage message based on a command index. 142 * 143 * These commands are organized according to how they are displayed in the usage 144 * message. An empty command (one with a NULL name) indicates an empty line in 145 * the generic usage message. 146 */ 147 static zfs_command_t command_table[] = { 148 { "create", zfs_do_create, HELP_CREATE }, 149 { "destroy", zfs_do_destroy, HELP_DESTROY }, 150 { NULL }, 151 { "snapshot", zfs_do_snapshot, HELP_SNAPSHOT }, 152 { "rollback", zfs_do_rollback, HELP_ROLLBACK }, 153 { "clone", zfs_do_clone, HELP_CLONE }, 154 { "promote", zfs_do_promote, HELP_PROMOTE }, 155 { "rename", zfs_do_rename, HELP_RENAME }, 156 { NULL }, 157 { "list", zfs_do_list, HELP_LIST }, 158 { NULL }, 159 { "set", zfs_do_set, HELP_SET }, 160 { "get", zfs_do_get, HELP_GET }, 161 { "inherit", zfs_do_inherit, HELP_INHERIT }, 162 { "upgrade", zfs_do_upgrade, HELP_UPGRADE }, 163 { "userspace", zfs_do_userspace, HELP_USERSPACE }, 164 { "groupspace", zfs_do_userspace, HELP_GROUPSPACE }, 165 { NULL }, 166 { "mount", zfs_do_mount, HELP_MOUNT }, 167 { "unmount", zfs_do_unmount, HELP_UNMOUNT }, 168 { "share", zfs_do_share, HELP_SHARE }, 169 { "unshare", zfs_do_unshare, HELP_UNSHARE }, 170 { NULL }, 171 { "send", zfs_do_send, HELP_SEND }, 172 { "receive", zfs_do_receive, HELP_RECEIVE }, 173 { NULL }, 174 { "allow", zfs_do_python, HELP_ALLOW }, 175 { NULL }, 176 { "unallow", zfs_do_python, HELP_UNALLOW }, 177 { NULL }, 178 { "hold", zfs_do_hold, HELP_HOLD }, 179 { "holds", zfs_do_python, HELP_HOLDS }, 180 { "release", zfs_do_release, HELP_RELEASE }, 181 }; 182 183 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0])) 184 185 zfs_command_t *current_command; 186 187 static const char * 188 get_usage(zfs_help_t idx) 189 { 190 switch (idx) { 191 case HELP_CLONE: 192 return (gettext("\tclone [-p] [-o property=value] ... " 193 "<snapshot> <filesystem|volume>\n")); 194 case HELP_CREATE: 195 return (gettext("\tcreate [-p] [-o property=value] ... " 196 "<filesystem>\n" 197 "\tcreate [-ps] [-b blocksize] [-o property=value] ... " 198 "-V <size> <volume>\n")); 199 case HELP_DESTROY: 200 return (gettext("\tdestroy [-rRf] <filesystem|volume>\n" 201 "\tdestroy [-rRd] <snapshot>\n")); 202 case HELP_GET: 203 return (gettext("\tget [-rHp] [-d max] " 204 "[-o \"all\" | field[,...]] [-s source[,...]]\n" 205 "\t <\"all\" | property[,...]> " 206 "[filesystem|volume|snapshot] ...\n")); 207 case HELP_INHERIT: 208 return (gettext("\tinherit [-rS] <property> " 209 "<filesystem|volume|snapshot> ...\n")); 210 case HELP_UPGRADE: 211 return (gettext("\tupgrade [-v]\n" 212 "\tupgrade [-r] [-V version] <-a | filesystem ...>\n")); 213 case HELP_LIST: 214 return (gettext("\tlist [-rH][-d max] " 215 "[-o property[,...]] [-t type[,...]] [-s property] ...\n" 216 "\t [-S property] ... " 217 "[filesystem|volume|snapshot] ...\n")); 218 case HELP_MOUNT: 219 return (gettext("\tmount\n" 220 "\tmount [-vO] [-o opts] <-a | filesystem>\n")); 221 case HELP_PROMOTE: 222 return (gettext("\tpromote <clone-filesystem>\n")); 223 case HELP_RECEIVE: 224 return (gettext("\treceive [-denuvF] <filesystem|volume|" 225 "snapshot>\n" 226 "\treceive [-denuvF] -d <filesystem>\n")); 227 case HELP_RENAME: 228 return (gettext("\trename <filesystem|volume|snapshot> " 229 "<filesystem|volume|snapshot>\n" 230 "\trename -p <filesystem|volume> <filesystem|volume>\n" 231 "\trename -r <snapshot> <snapshot>")); 232 case HELP_ROLLBACK: 233 return (gettext("\trollback [-rRf] <snapshot>\n")); 234 case HELP_SEND: 235 return (gettext("\tsend [-RDp] [-[iI] snapshot] <snapshot>\n")); 236 case HELP_SET: 237 return (gettext("\tset <property=value> " 238 "<filesystem|volume|snapshot> ...\n")); 239 case HELP_SHARE: 240 return (gettext("\tshare <-a | filesystem>\n")); 241 case HELP_SNAPSHOT: 242 return (gettext("\tsnapshot [-r] [-o property=value] ... " 243 "<filesystem@snapname|volume@snapname>\n")); 244 case HELP_UNMOUNT: 245 return (gettext("\tunmount [-f] " 246 "<-a | filesystem|mountpoint>\n")); 247 case HELP_UNSHARE: 248 return (gettext("\tunshare " 249 "<-a | filesystem|mountpoint>\n")); 250 case HELP_ALLOW: 251 return (gettext("\tallow <filesystem|volume>\n" 252 "\tallow [-ldug] " 253 "<\"everyone\"|user|group>[,...] <perm|@setname>[,...]\n" 254 "\t <filesystem|volume>\n" 255 "\tallow [-ld] -e <perm|@setname>[,...] " 256 "<filesystem|volume>\n" 257 "\tallow -c <perm|@setname>[,...] <filesystem|volume>\n" 258 "\tallow -s @setname <perm|@setname>[,...] " 259 "<filesystem|volume>\n")); 260 case HELP_UNALLOW: 261 return (gettext("\tunallow [-rldug] " 262 "<\"everyone\"|user|group>[,...]\n" 263 "\t [<perm|@setname>[,...]] <filesystem|volume>\n" 264 "\tunallow [-rld] -e [<perm|@setname>[,...]] " 265 "<filesystem|volume>\n" 266 "\tunallow [-r] -c [<perm|@setname>[,...]] " 267 "<filesystem|volume>\n" 268 "\tunallow [-r] -s @setname [<perm|@setname>[,...]] " 269 "<filesystem|volume>\n")); 270 case HELP_USERSPACE: 271 return (gettext("\tuserspace [-hniHp] [-o field[,...]] " 272 "[-sS field] ... [-t type[,...]]\n" 273 "\t <filesystem|snapshot>\n")); 274 case HELP_GROUPSPACE: 275 return (gettext("\tgroupspace [-hniHpU] [-o field[,...]] " 276 "[-sS field] ... [-t type[,...]]\n" 277 "\t <filesystem|snapshot>\n")); 278 case HELP_HOLD: 279 return (gettext("\thold [-r] <tag> <snapshot> ...\n")); 280 case HELP_HOLDS: 281 return (gettext("\tholds [-r] <snapshot> ...\n")); 282 case HELP_RELEASE: 283 return (gettext("\trelease [-r] <tag> <snapshot> ...\n")); 284 } 285 286 abort(); 287 /* NOTREACHED */ 288 } 289 290 /* 291 * Utility function to guarantee malloc() success. 292 */ 293 void * 294 safe_malloc(size_t size) 295 { 296 void *data; 297 298 if ((data = calloc(1, size)) == NULL) { 299 (void) fprintf(stderr, "internal error: out of memory\n"); 300 exit(1); 301 } 302 303 return (data); 304 } 305 306 /* 307 * Callback routine that will print out information for each of 308 * the properties. 309 */ 310 static int 311 usage_prop_cb(int prop, void *cb) 312 { 313 FILE *fp = cb; 314 315 (void) fprintf(fp, "\t%-15s ", zfs_prop_to_name(prop)); 316 317 if (zfs_prop_readonly(prop)) 318 (void) fprintf(fp, " NO "); 319 else 320 (void) fprintf(fp, "YES "); 321 322 if (zfs_prop_inheritable(prop)) 323 (void) fprintf(fp, " YES "); 324 else 325 (void) fprintf(fp, " NO "); 326 327 if (zfs_prop_values(prop) == NULL) 328 (void) fprintf(fp, "-\n"); 329 else 330 (void) fprintf(fp, "%s\n", zfs_prop_values(prop)); 331 332 return (ZPROP_CONT); 333 } 334 335 /* 336 * Display usage message. If we're inside a command, display only the usage for 337 * that command. Otherwise, iterate over the entire command table and display 338 * a complete usage message. 339 */ 340 static void 341 usage(boolean_t requested) 342 { 343 int i; 344 boolean_t show_properties = B_FALSE; 345 FILE *fp = requested ? stdout : stderr; 346 347 if (current_command == NULL) { 348 349 (void) fprintf(fp, gettext("usage: zfs command args ...\n")); 350 (void) fprintf(fp, 351 gettext("where 'command' is one of the following:\n\n")); 352 353 for (i = 0; i < NCOMMAND; i++) { 354 if (command_table[i].name == NULL) 355 (void) fprintf(fp, "\n"); 356 else 357 (void) fprintf(fp, "%s", 358 get_usage(command_table[i].usage)); 359 } 360 361 (void) fprintf(fp, gettext("\nEach dataset is of the form: " 362 "pool/[dataset/]*dataset[@name]\n")); 363 } else { 364 (void) fprintf(fp, gettext("usage:\n")); 365 (void) fprintf(fp, "%s", get_usage(current_command->usage)); 366 } 367 368 if (current_command != NULL && 369 (strcmp(current_command->name, "set") == 0 || 370 strcmp(current_command->name, "get") == 0 || 371 strcmp(current_command->name, "inherit") == 0 || 372 strcmp(current_command->name, "list") == 0)) 373 show_properties = B_TRUE; 374 375 if (show_properties) { 376 (void) fprintf(fp, 377 gettext("\nThe following properties are supported:\n")); 378 379 (void) fprintf(fp, "\n\t%-14s %s %s %s\n\n", 380 "PROPERTY", "EDIT", "INHERIT", "VALUES"); 381 382 /* Iterate over all properties */ 383 (void) zprop_iter(usage_prop_cb, fp, B_FALSE, B_TRUE, 384 ZFS_TYPE_DATASET); 385 386 (void) fprintf(fp, "\t%-15s ", "userused@..."); 387 (void) fprintf(fp, " NO NO <size>\n"); 388 (void) fprintf(fp, "\t%-15s ", "groupused@..."); 389 (void) fprintf(fp, " NO NO <size>\n"); 390 (void) fprintf(fp, "\t%-15s ", "userquota@..."); 391 (void) fprintf(fp, "YES NO <size> | none\n"); 392 (void) fprintf(fp, "\t%-15s ", "groupquota@..."); 393 (void) fprintf(fp, "YES NO <size> | none\n"); 394 395 (void) fprintf(fp, gettext("\nSizes are specified in bytes " 396 "with standard units such as K, M, G, etc.\n")); 397 (void) fprintf(fp, gettext("\nUser-defined properties can " 398 "be specified by using a name containing a colon (:).\n")); 399 (void) fprintf(fp, gettext("\nThe {user|group}{used|quota}@ " 400 "properties must be appended with\n" 401 "a user or group specifier of one of these forms:\n" 402 " POSIX name (eg: \"matt\")\n" 403 " POSIX id (eg: \"126829\")\n" 404 " SMB name@domain (eg: \"matt@sun\")\n" 405 " SMB SID (eg: \"S-1-234-567-89\")\n")); 406 } else { 407 (void) fprintf(fp, 408 gettext("\nFor the property list, run: %s\n"), 409 "zfs set|get"); 410 (void) fprintf(fp, 411 gettext("\nFor the delegated permission list, run: %s\n"), 412 "zfs allow|unallow"); 413 } 414 415 /* 416 * See comments at end of main(). 417 */ 418 if (getenv("ZFS_ABORT") != NULL) { 419 (void) printf("dumping core by request\n"); 420 abort(); 421 } 422 423 exit(requested ? 0 : 2); 424 } 425 426 static int 427 parseprop(nvlist_t *props) 428 { 429 char *propname = optarg; 430 char *propval, *strval; 431 432 if ((propval = strchr(propname, '=')) == NULL) { 433 (void) fprintf(stderr, gettext("missing " 434 "'=' for -o option\n")); 435 return (-1); 436 } 437 *propval = '\0'; 438 propval++; 439 if (nvlist_lookup_string(props, propname, &strval) == 0) { 440 (void) fprintf(stderr, gettext("property '%s' " 441 "specified multiple times\n"), propname); 442 return (-1); 443 } 444 if (nvlist_add_string(props, propname, propval) != 0) { 445 (void) fprintf(stderr, gettext("internal " 446 "error: out of memory\n")); 447 return (-1); 448 } 449 return (0); 450 } 451 452 static int 453 parse_depth(char *opt, int *flags) 454 { 455 char *tmp; 456 int depth; 457 458 depth = (int)strtol(opt, &tmp, 0); 459 if (*tmp) { 460 (void) fprintf(stderr, 461 gettext("%s is not an integer\n"), optarg); 462 usage(B_FALSE); 463 } 464 if (depth < 0) { 465 (void) fprintf(stderr, 466 gettext("Depth can not be negative.\n")); 467 usage(B_FALSE); 468 } 469 *flags |= (ZFS_ITER_DEPTH_LIMIT|ZFS_ITER_RECURSE); 470 return (depth); 471 } 472 473 /* 474 * zfs clone [-p] [-o prop=value] ... <snap> <fs | vol> 475 * 476 * Given an existing dataset, create a writable copy whose initial contents 477 * are the same as the source. The newly created dataset maintains a 478 * dependency on the original; the original cannot be destroyed so long as 479 * the clone exists. 480 * 481 * The '-p' flag creates all the non-existing ancestors of the target first. 482 */ 483 static int 484 zfs_do_clone(int argc, char **argv) 485 { 486 zfs_handle_t *zhp = NULL; 487 boolean_t parents = B_FALSE; 488 nvlist_t *props; 489 int ret; 490 int c; 491 492 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) { 493 (void) fprintf(stderr, gettext("internal error: " 494 "out of memory\n")); 495 return (1); 496 } 497 498 /* check options */ 499 while ((c = getopt(argc, argv, "o:p")) != -1) { 500 switch (c) { 501 case 'o': 502 if (parseprop(props)) 503 return (1); 504 break; 505 case 'p': 506 parents = B_TRUE; 507 break; 508 case '?': 509 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 510 optopt); 511 goto usage; 512 } 513 } 514 515 argc -= optind; 516 argv += optind; 517 518 /* check number of arguments */ 519 if (argc < 1) { 520 (void) fprintf(stderr, gettext("missing source dataset " 521 "argument\n")); 522 goto usage; 523 } 524 if (argc < 2) { 525 (void) fprintf(stderr, gettext("missing target dataset " 526 "argument\n")); 527 goto usage; 528 } 529 if (argc > 2) { 530 (void) fprintf(stderr, gettext("too many arguments\n")); 531 goto usage; 532 } 533 534 /* open the source dataset */ 535 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL) 536 return (1); 537 538 if (parents && zfs_name_valid(argv[1], ZFS_TYPE_FILESYSTEM | 539 ZFS_TYPE_VOLUME)) { 540 /* 541 * Now create the ancestors of the target dataset. If the 542 * target already exists and '-p' option was used we should not 543 * complain. 544 */ 545 if (zfs_dataset_exists(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM | 546 ZFS_TYPE_VOLUME)) 547 return (0); 548 if (zfs_create_ancestors(g_zfs, argv[1]) != 0) 549 return (1); 550 } 551 552 /* pass to libzfs */ 553 ret = zfs_clone(zhp, argv[1], props); 554 555 /* create the mountpoint if necessary */ 556 if (ret == 0) { 557 zfs_handle_t *clone; 558 559 clone = zfs_open(g_zfs, argv[1], ZFS_TYPE_DATASET); 560 if (clone != NULL) { 561 if ((ret = zfs_mount(clone, NULL, 0)) == 0) 562 ret = zfs_share(clone); 563 zfs_close(clone); 564 } 565 } 566 567 zfs_close(zhp); 568 nvlist_free(props); 569 570 return (!!ret); 571 572 usage: 573 if (zhp) 574 zfs_close(zhp); 575 nvlist_free(props); 576 usage(B_FALSE); 577 return (-1); 578 } 579 580 /* 581 * zfs create [-p] [-o prop=value] ... fs 582 * zfs create [-ps] [-b blocksize] [-o prop=value] ... -V vol size 583 * 584 * Create a new dataset. This command can be used to create filesystems 585 * and volumes. Snapshot creation is handled by 'zfs snapshot'. 586 * For volumes, the user must specify a size to be used. 587 * 588 * The '-s' flag applies only to volumes, and indicates that we should not try 589 * to set the reservation for this volume. By default we set a reservation 590 * equal to the size for any volume. For pools with SPA_VERSION >= 591 * SPA_VERSION_REFRESERVATION, we set a refreservation instead. 592 * 593 * The '-p' flag creates all the non-existing ancestors of the target first. 594 */ 595 static int 596 zfs_do_create(int argc, char **argv) 597 { 598 zfs_type_t type = ZFS_TYPE_FILESYSTEM; 599 zfs_handle_t *zhp = NULL; 600 uint64_t volsize; 601 int c; 602 boolean_t noreserve = B_FALSE; 603 boolean_t bflag = B_FALSE; 604 boolean_t parents = B_FALSE; 605 int ret = 1; 606 nvlist_t *props; 607 uint64_t intval; 608 int canmount; 609 610 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) { 611 (void) fprintf(stderr, gettext("internal error: " 612 "out of memory\n")); 613 return (1); 614 } 615 616 /* check options */ 617 while ((c = getopt(argc, argv, ":V:b:so:p")) != -1) { 618 switch (c) { 619 case 'V': 620 type = ZFS_TYPE_VOLUME; 621 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) { 622 (void) fprintf(stderr, gettext("bad volume " 623 "size '%s': %s\n"), optarg, 624 libzfs_error_description(g_zfs)); 625 goto error; 626 } 627 628 if (nvlist_add_uint64(props, 629 zfs_prop_to_name(ZFS_PROP_VOLSIZE), 630 intval) != 0) { 631 (void) fprintf(stderr, gettext("internal " 632 "error: out of memory\n")); 633 goto error; 634 } 635 volsize = intval; 636 break; 637 case 'p': 638 parents = B_TRUE; 639 break; 640 case 'b': 641 bflag = B_TRUE; 642 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) { 643 (void) fprintf(stderr, gettext("bad volume " 644 "block size '%s': %s\n"), optarg, 645 libzfs_error_description(g_zfs)); 646 goto error; 647 } 648 649 if (nvlist_add_uint64(props, 650 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE), 651 intval) != 0) { 652 (void) fprintf(stderr, gettext("internal " 653 "error: out of memory\n")); 654 goto error; 655 } 656 break; 657 case 'o': 658 if (parseprop(props)) 659 goto error; 660 break; 661 case 's': 662 noreserve = B_TRUE; 663 break; 664 case ':': 665 (void) fprintf(stderr, gettext("missing size " 666 "argument\n")); 667 goto badusage; 668 break; 669 case '?': 670 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 671 optopt); 672 goto badusage; 673 } 674 } 675 676 if ((bflag || noreserve) && type != ZFS_TYPE_VOLUME) { 677 (void) fprintf(stderr, gettext("'-s' and '-b' can only be " 678 "used when creating a volume\n")); 679 goto badusage; 680 } 681 682 argc -= optind; 683 argv += optind; 684 685 /* check number of arguments */ 686 if (argc == 0) { 687 (void) fprintf(stderr, gettext("missing %s argument\n"), 688 zfs_type_to_name(type)); 689 goto badusage; 690 } 691 if (argc > 1) { 692 (void) fprintf(stderr, gettext("too many arguments\n")); 693 goto badusage; 694 } 695 696 if (type == ZFS_TYPE_VOLUME && !noreserve) { 697 zpool_handle_t *zpool_handle; 698 uint64_t spa_version; 699 char *p; 700 zfs_prop_t resv_prop; 701 char *strval; 702 703 if (p = strchr(argv[0], '/')) 704 *p = '\0'; 705 zpool_handle = zpool_open(g_zfs, argv[0]); 706 if (p != NULL) 707 *p = '/'; 708 if (zpool_handle == NULL) 709 goto error; 710 spa_version = zpool_get_prop_int(zpool_handle, 711 ZPOOL_PROP_VERSION, NULL); 712 zpool_close(zpool_handle); 713 if (spa_version >= SPA_VERSION_REFRESERVATION) 714 resv_prop = ZFS_PROP_REFRESERVATION; 715 else 716 resv_prop = ZFS_PROP_RESERVATION; 717 volsize = zvol_volsize_to_reservation(volsize, props); 718 719 if (nvlist_lookup_string(props, zfs_prop_to_name(resv_prop), 720 &strval) != 0) { 721 if (nvlist_add_uint64(props, 722 zfs_prop_to_name(resv_prop), volsize) != 0) { 723 (void) fprintf(stderr, gettext("internal " 724 "error: out of memory\n")); 725 nvlist_free(props); 726 return (1); 727 } 728 } 729 } 730 731 if (parents && zfs_name_valid(argv[0], type)) { 732 /* 733 * Now create the ancestors of target dataset. If the target 734 * already exists and '-p' option was used we should not 735 * complain. 736 */ 737 if (zfs_dataset_exists(g_zfs, argv[0], type)) { 738 ret = 0; 739 goto error; 740 } 741 if (zfs_create_ancestors(g_zfs, argv[0]) != 0) 742 goto error; 743 } 744 745 /* pass to libzfs */ 746 if (zfs_create(g_zfs, argv[0], type, props) != 0) 747 goto error; 748 749 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL) 750 goto error; 751 /* 752 * if the user doesn't want the dataset automatically mounted, 753 * then skip the mount/share step 754 */ 755 756 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT); 757 758 /* 759 * Mount and/or share the new filesystem as appropriate. We provide a 760 * verbose error message to let the user know that their filesystem was 761 * in fact created, even if we failed to mount or share it. 762 */ 763 ret = 0; 764 if (canmount == ZFS_CANMOUNT_ON) { 765 if (zfs_mount(zhp, NULL, 0) != 0) { 766 (void) fprintf(stderr, gettext("filesystem " 767 "successfully created, but not mounted\n")); 768 ret = 1; 769 } else if (zfs_share(zhp) != 0) { 770 (void) fprintf(stderr, gettext("filesystem " 771 "successfully created, but not shared\n")); 772 ret = 1; 773 } 774 } 775 776 error: 777 if (zhp) 778 zfs_close(zhp); 779 nvlist_free(props); 780 return (ret); 781 badusage: 782 nvlist_free(props); 783 usage(B_FALSE); 784 return (2); 785 } 786 787 /* 788 * zfs destroy [-rRf] <fs, vol> 789 * zfs destroy [-rRd] <snap> 790 * 791 * -r Recursively destroy all children 792 * -R Recursively destroy all dependents, including clones 793 * -f Force unmounting of any dependents 794 * -d If we can't destroy now, mark for deferred destruction 795 * 796 * Destroys the given dataset. By default, it will unmount any filesystems, 797 * and refuse to destroy a dataset that has any dependents. A dependent can 798 * either be a child, or a clone of a child. 799 */ 800 typedef struct destroy_cbdata { 801 boolean_t cb_first; 802 int cb_force; 803 int cb_recurse; 804 int cb_error; 805 int cb_needforce; 806 int cb_doclones; 807 boolean_t cb_closezhp; 808 zfs_handle_t *cb_target; 809 char *cb_snapname; 810 boolean_t cb_defer_destroy; 811 } destroy_cbdata_t; 812 813 /* 814 * Check for any dependents based on the '-r' or '-R' flags. 815 */ 816 static int 817 destroy_check_dependent(zfs_handle_t *zhp, void *data) 818 { 819 destroy_cbdata_t *cbp = data; 820 const char *tname = zfs_get_name(cbp->cb_target); 821 const char *name = zfs_get_name(zhp); 822 823 if (strncmp(tname, name, strlen(tname)) == 0 && 824 (name[strlen(tname)] == '/' || name[strlen(tname)] == '@')) { 825 /* 826 * This is a direct descendant, not a clone somewhere else in 827 * the hierarchy. 828 */ 829 if (cbp->cb_recurse) 830 goto out; 831 832 if (cbp->cb_first) { 833 (void) fprintf(stderr, gettext("cannot destroy '%s': " 834 "%s has children\n"), 835 zfs_get_name(cbp->cb_target), 836 zfs_type_to_name(zfs_get_type(cbp->cb_target))); 837 (void) fprintf(stderr, gettext("use '-r' to destroy " 838 "the following datasets:\n")); 839 cbp->cb_first = B_FALSE; 840 cbp->cb_error = 1; 841 } 842 843 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 844 } else { 845 /* 846 * This is a clone. We only want to report this if the '-r' 847 * wasn't specified, or the target is a snapshot. 848 */ 849 if (!cbp->cb_recurse && 850 zfs_get_type(cbp->cb_target) != ZFS_TYPE_SNAPSHOT) 851 goto out; 852 853 if (cbp->cb_first) { 854 (void) fprintf(stderr, gettext("cannot destroy '%s': " 855 "%s has dependent clones\n"), 856 zfs_get_name(cbp->cb_target), 857 zfs_type_to_name(zfs_get_type(cbp->cb_target))); 858 (void) fprintf(stderr, gettext("use '-R' to destroy " 859 "the following datasets:\n")); 860 cbp->cb_first = B_FALSE; 861 cbp->cb_error = 1; 862 } 863 864 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 865 } 866 867 out: 868 zfs_close(zhp); 869 return (0); 870 } 871 872 static int 873 destroy_callback(zfs_handle_t *zhp, void *data) 874 { 875 destroy_cbdata_t *cbp = data; 876 877 /* 878 * Ignore pools (which we've already flagged as an error before getting 879 * here). 880 */ 881 if (strchr(zfs_get_name(zhp), '/') == NULL && 882 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) { 883 zfs_close(zhp); 884 return (0); 885 } 886 887 /* 888 * Bail out on the first error. 889 */ 890 if (zfs_unmount(zhp, NULL, cbp->cb_force ? MS_FORCE : 0) != 0 || 891 zfs_destroy(zhp, cbp->cb_defer_destroy) != 0) { 892 zfs_close(zhp); 893 return (-1); 894 } 895 896 zfs_close(zhp); 897 return (0); 898 } 899 900 static int 901 destroy_snap_clones(zfs_handle_t *zhp, void *arg) 902 { 903 destroy_cbdata_t *cbp = arg; 904 char thissnap[MAXPATHLEN]; 905 zfs_handle_t *szhp; 906 boolean_t closezhp = cbp->cb_closezhp; 907 int rv; 908 909 (void) snprintf(thissnap, sizeof (thissnap), 910 "%s@%s", zfs_get_name(zhp), cbp->cb_snapname); 911 912 libzfs_print_on_error(g_zfs, B_FALSE); 913 szhp = zfs_open(g_zfs, thissnap, ZFS_TYPE_SNAPSHOT); 914 libzfs_print_on_error(g_zfs, B_TRUE); 915 if (szhp) { 916 /* 917 * Destroy any clones of this snapshot 918 */ 919 if (zfs_iter_dependents(szhp, B_FALSE, destroy_callback, 920 cbp) != 0) { 921 zfs_close(szhp); 922 if (closezhp) 923 zfs_close(zhp); 924 return (-1); 925 } 926 zfs_close(szhp); 927 } 928 929 cbp->cb_closezhp = B_TRUE; 930 rv = zfs_iter_filesystems(zhp, destroy_snap_clones, arg); 931 if (closezhp) 932 zfs_close(zhp); 933 return (rv); 934 } 935 936 static int 937 zfs_do_destroy(int argc, char **argv) 938 { 939 destroy_cbdata_t cb = { 0 }; 940 int c; 941 zfs_handle_t *zhp; 942 char *cp; 943 zfs_type_t type = ZFS_TYPE_DATASET; 944 945 /* check options */ 946 while ((c = getopt(argc, argv, "dfrR")) != -1) { 947 switch (c) { 948 case 'd': 949 cb.cb_defer_destroy = B_TRUE; 950 type = ZFS_TYPE_SNAPSHOT; 951 break; 952 case 'f': 953 cb.cb_force = 1; 954 break; 955 case 'r': 956 cb.cb_recurse = 1; 957 break; 958 case 'R': 959 cb.cb_recurse = 1; 960 cb.cb_doclones = 1; 961 break; 962 case '?': 963 default: 964 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 965 optopt); 966 usage(B_FALSE); 967 } 968 } 969 970 argc -= optind; 971 argv += optind; 972 973 /* check number of arguments */ 974 if (argc == 0) { 975 (void) fprintf(stderr, gettext("missing path argument\n")); 976 usage(B_FALSE); 977 } 978 if (argc > 1) { 979 (void) fprintf(stderr, gettext("too many arguments\n")); 980 usage(B_FALSE); 981 } 982 983 /* 984 * If we are doing recursive destroy of a snapshot, then the 985 * named snapshot may not exist. Go straight to libzfs. 986 */ 987 if (cb.cb_recurse && (cp = strchr(argv[0], '@'))) { 988 int ret; 989 990 *cp = '\0'; 991 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL) 992 return (1); 993 *cp = '@'; 994 cp++; 995 996 if (cb.cb_doclones) { 997 boolean_t defer = cb.cb_defer_destroy; 998 999 /* 1000 * Temporarily ignore the defer_destroy setting since 1001 * it's not supported for clones. 1002 */ 1003 cb.cb_defer_destroy = B_FALSE; 1004 cb.cb_snapname = cp; 1005 if (destroy_snap_clones(zhp, &cb) != 0) { 1006 zfs_close(zhp); 1007 return (1); 1008 } 1009 cb.cb_defer_destroy = defer; 1010 } 1011 1012 ret = zfs_destroy_snaps(zhp, cp, cb.cb_defer_destroy); 1013 zfs_close(zhp); 1014 if (ret) { 1015 (void) fprintf(stderr, 1016 gettext("no snapshots destroyed\n")); 1017 } 1018 return (ret != 0); 1019 } 1020 1021 /* Open the given dataset */ 1022 if ((zhp = zfs_open(g_zfs, argv[0], type)) == NULL) 1023 return (1); 1024 1025 cb.cb_target = zhp; 1026 1027 /* 1028 * Perform an explicit check for pools before going any further. 1029 */ 1030 if (!cb.cb_recurse && strchr(zfs_get_name(zhp), '/') == NULL && 1031 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) { 1032 (void) fprintf(stderr, gettext("cannot destroy '%s': " 1033 "operation does not apply to pools\n"), 1034 zfs_get_name(zhp)); 1035 (void) fprintf(stderr, gettext("use 'zfs destroy -r " 1036 "%s' to destroy all datasets in the pool\n"), 1037 zfs_get_name(zhp)); 1038 (void) fprintf(stderr, gettext("use 'zpool destroy %s' " 1039 "to destroy the pool itself\n"), zfs_get_name(zhp)); 1040 zfs_close(zhp); 1041 return (1); 1042 } 1043 1044 /* 1045 * Check for any dependents and/or clones. 1046 */ 1047 cb.cb_first = B_TRUE; 1048 if (!cb.cb_doclones && !cb.cb_defer_destroy && 1049 zfs_iter_dependents(zhp, B_TRUE, destroy_check_dependent, 1050 &cb) != 0) { 1051 zfs_close(zhp); 1052 return (1); 1053 } 1054 1055 if (cb.cb_error || (!cb.cb_defer_destroy && 1056 (zfs_iter_dependents(zhp, B_FALSE, destroy_callback, &cb) != 0))) { 1057 zfs_close(zhp); 1058 return (1); 1059 } 1060 1061 /* 1062 * Do the real thing. The callback will close the handle regardless of 1063 * whether it succeeds or not. 1064 */ 1065 1066 if (destroy_callback(zhp, &cb) != 0) 1067 return (1); 1068 1069 return (0); 1070 } 1071 1072 static boolean_t 1073 is_recvd_column(zprop_get_cbdata_t *cbp) 1074 { 1075 int i; 1076 zfs_get_column_t col; 1077 1078 for (i = 0; i < ZFS_GET_NCOLS && 1079 (col = cbp->cb_columns[i]) != GET_COL_NONE; i++) 1080 if (col == GET_COL_RECVD) 1081 return (B_TRUE); 1082 return (B_FALSE); 1083 } 1084 1085 /* 1086 * zfs get [-rHp] [-o all | field[,field]...] [-s source[,source]...] 1087 * < all | property[,property]... > < fs | snap | vol > ... 1088 * 1089 * -r recurse over any child datasets 1090 * -H scripted mode. Headers are stripped, and fields are separated 1091 * by tabs instead of spaces. 1092 * -o Set of fields to display. One of "name,property,value, 1093 * received,source". Default is "name,property,value,source". 1094 * "all" is an alias for all five. 1095 * -s Set of sources to allow. One of 1096 * "local,default,inherited,received,temporary,none". Default is 1097 * all six. 1098 * -p Display values in parsable (literal) format. 1099 * 1100 * Prints properties for the given datasets. The user can control which 1101 * columns to display as well as which property types to allow. 1102 */ 1103 1104 /* 1105 * Invoked to display the properties for a single dataset. 1106 */ 1107 static int 1108 get_callback(zfs_handle_t *zhp, void *data) 1109 { 1110 char buf[ZFS_MAXPROPLEN]; 1111 char rbuf[ZFS_MAXPROPLEN]; 1112 zprop_source_t sourcetype; 1113 char source[ZFS_MAXNAMELEN]; 1114 zprop_get_cbdata_t *cbp = data; 1115 nvlist_t *user_props = zfs_get_user_props(zhp); 1116 zprop_list_t *pl = cbp->cb_proplist; 1117 nvlist_t *propval; 1118 char *strval; 1119 char *sourceval; 1120 boolean_t received = is_recvd_column(cbp); 1121 1122 for (; pl != NULL; pl = pl->pl_next) { 1123 char *recvdval = NULL; 1124 /* 1125 * Skip the special fake placeholder. This will also skip over 1126 * the name property when 'all' is specified. 1127 */ 1128 if (pl->pl_prop == ZFS_PROP_NAME && 1129 pl == cbp->cb_proplist) 1130 continue; 1131 1132 if (pl->pl_prop != ZPROP_INVAL) { 1133 if (zfs_prop_get(zhp, pl->pl_prop, buf, 1134 sizeof (buf), &sourcetype, source, 1135 sizeof (source), 1136 cbp->cb_literal) != 0) { 1137 if (pl->pl_all) 1138 continue; 1139 if (!zfs_prop_valid_for_type(pl->pl_prop, 1140 ZFS_TYPE_DATASET)) { 1141 (void) fprintf(stderr, 1142 gettext("No such property '%s'\n"), 1143 zfs_prop_to_name(pl->pl_prop)); 1144 continue; 1145 } 1146 sourcetype = ZPROP_SRC_NONE; 1147 (void) strlcpy(buf, "-", sizeof (buf)); 1148 } 1149 1150 if (received && (zfs_prop_get_recvd(zhp, 1151 zfs_prop_to_name(pl->pl_prop), rbuf, sizeof (rbuf), 1152 cbp->cb_literal) == 0)) 1153 recvdval = rbuf; 1154 1155 zprop_print_one_property(zfs_get_name(zhp), cbp, 1156 zfs_prop_to_name(pl->pl_prop), 1157 buf, sourcetype, source, recvdval); 1158 } else if (zfs_prop_userquota(pl->pl_user_prop)) { 1159 sourcetype = ZPROP_SRC_LOCAL; 1160 1161 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop, 1162 buf, sizeof (buf), cbp->cb_literal) != 0) { 1163 sourcetype = ZPROP_SRC_NONE; 1164 (void) strlcpy(buf, "-", sizeof (buf)); 1165 } 1166 1167 zprop_print_one_property(zfs_get_name(zhp), cbp, 1168 pl->pl_user_prop, buf, sourcetype, source, NULL); 1169 } else { 1170 if (nvlist_lookup_nvlist(user_props, 1171 pl->pl_user_prop, &propval) != 0) { 1172 if (pl->pl_all) 1173 continue; 1174 sourcetype = ZPROP_SRC_NONE; 1175 strval = "-"; 1176 } else { 1177 verify(nvlist_lookup_string(propval, 1178 ZPROP_VALUE, &strval) == 0); 1179 verify(nvlist_lookup_string(propval, 1180 ZPROP_SOURCE, &sourceval) == 0); 1181 1182 if (strcmp(sourceval, 1183 zfs_get_name(zhp)) == 0) { 1184 sourcetype = ZPROP_SRC_LOCAL; 1185 } else if (strcmp(sourceval, 1186 ZPROP_SOURCE_VAL_RECVD) == 0) { 1187 sourcetype = ZPROP_SRC_RECEIVED; 1188 } else { 1189 sourcetype = ZPROP_SRC_INHERITED; 1190 (void) strlcpy(source, 1191 sourceval, sizeof (source)); 1192 } 1193 } 1194 1195 if (received && (zfs_prop_get_recvd(zhp, 1196 pl->pl_user_prop, rbuf, sizeof (rbuf), 1197 cbp->cb_literal) == 0)) 1198 recvdval = rbuf; 1199 1200 zprop_print_one_property(zfs_get_name(zhp), cbp, 1201 pl->pl_user_prop, strval, sourcetype, 1202 source, recvdval); 1203 } 1204 } 1205 1206 return (0); 1207 } 1208 1209 static int 1210 zfs_do_get(int argc, char **argv) 1211 { 1212 zprop_get_cbdata_t cb = { 0 }; 1213 int i, c, flags = 0; 1214 char *value, *fields; 1215 int ret; 1216 int limit = 0; 1217 zprop_list_t fake_name = { 0 }; 1218 1219 /* 1220 * Set up default columns and sources. 1221 */ 1222 cb.cb_sources = ZPROP_SRC_ALL; 1223 cb.cb_columns[0] = GET_COL_NAME; 1224 cb.cb_columns[1] = GET_COL_PROPERTY; 1225 cb.cb_columns[2] = GET_COL_VALUE; 1226 cb.cb_columns[3] = GET_COL_SOURCE; 1227 cb.cb_type = ZFS_TYPE_DATASET; 1228 1229 /* check options */ 1230 while ((c = getopt(argc, argv, ":d:o:s:rHp")) != -1) { 1231 switch (c) { 1232 case 'p': 1233 cb.cb_literal = B_TRUE; 1234 break; 1235 case 'd': 1236 limit = parse_depth(optarg, &flags); 1237 break; 1238 case 'r': 1239 flags |= ZFS_ITER_RECURSE; 1240 break; 1241 case 'H': 1242 cb.cb_scripted = B_TRUE; 1243 break; 1244 case ':': 1245 (void) fprintf(stderr, gettext("missing argument for " 1246 "'%c' option\n"), optopt); 1247 usage(B_FALSE); 1248 break; 1249 case 'o': 1250 /* 1251 * Process the set of columns to display. We zero out 1252 * the structure to give us a blank slate. 1253 */ 1254 bzero(&cb.cb_columns, sizeof (cb.cb_columns)); 1255 i = 0; 1256 while (*optarg != '\0') { 1257 static char *col_subopts[] = 1258 { "name", "property", "value", "received", 1259 "source", "all", NULL }; 1260 1261 if (i == ZFS_GET_NCOLS) { 1262 (void) fprintf(stderr, gettext("too " 1263 "many fields given to -o " 1264 "option\n")); 1265 usage(B_FALSE); 1266 } 1267 1268 switch (getsubopt(&optarg, col_subopts, 1269 &value)) { 1270 case 0: 1271 cb.cb_columns[i++] = GET_COL_NAME; 1272 break; 1273 case 1: 1274 cb.cb_columns[i++] = GET_COL_PROPERTY; 1275 break; 1276 case 2: 1277 cb.cb_columns[i++] = GET_COL_VALUE; 1278 break; 1279 case 3: 1280 cb.cb_columns[i++] = GET_COL_RECVD; 1281 flags |= ZFS_ITER_RECVD_PROPS; 1282 break; 1283 case 4: 1284 cb.cb_columns[i++] = GET_COL_SOURCE; 1285 break; 1286 case 5: 1287 if (i > 0) { 1288 (void) fprintf(stderr, 1289 gettext("\"all\" conflicts " 1290 "with specific fields " 1291 "given to -o option\n")); 1292 usage(B_FALSE); 1293 } 1294 cb.cb_columns[0] = GET_COL_NAME; 1295 cb.cb_columns[1] = GET_COL_PROPERTY; 1296 cb.cb_columns[2] = GET_COL_VALUE; 1297 cb.cb_columns[3] = GET_COL_RECVD; 1298 cb.cb_columns[4] = GET_COL_SOURCE; 1299 flags |= ZFS_ITER_RECVD_PROPS; 1300 i = ZFS_GET_NCOLS; 1301 break; 1302 default: 1303 (void) fprintf(stderr, 1304 gettext("invalid column name " 1305 "'%s'\n"), value); 1306 usage(B_FALSE); 1307 } 1308 } 1309 break; 1310 1311 case 's': 1312 cb.cb_sources = 0; 1313 while (*optarg != '\0') { 1314 static char *source_subopts[] = { 1315 "local", "default", "inherited", 1316 "received", "temporary", "none", 1317 NULL }; 1318 1319 switch (getsubopt(&optarg, source_subopts, 1320 &value)) { 1321 case 0: 1322 cb.cb_sources |= ZPROP_SRC_LOCAL; 1323 break; 1324 case 1: 1325 cb.cb_sources |= ZPROP_SRC_DEFAULT; 1326 break; 1327 case 2: 1328 cb.cb_sources |= ZPROP_SRC_INHERITED; 1329 break; 1330 case 3: 1331 cb.cb_sources |= ZPROP_SRC_RECEIVED; 1332 break; 1333 case 4: 1334 cb.cb_sources |= ZPROP_SRC_TEMPORARY; 1335 break; 1336 case 5: 1337 cb.cb_sources |= ZPROP_SRC_NONE; 1338 break; 1339 default: 1340 (void) fprintf(stderr, 1341 gettext("invalid source " 1342 "'%s'\n"), value); 1343 usage(B_FALSE); 1344 } 1345 } 1346 break; 1347 1348 case '?': 1349 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1350 optopt); 1351 usage(B_FALSE); 1352 } 1353 } 1354 1355 argc -= optind; 1356 argv += optind; 1357 1358 if (argc < 1) { 1359 (void) fprintf(stderr, gettext("missing property " 1360 "argument\n")); 1361 usage(B_FALSE); 1362 } 1363 1364 fields = argv[0]; 1365 1366 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET) 1367 != 0) 1368 usage(B_FALSE); 1369 1370 argc--; 1371 argv++; 1372 1373 /* 1374 * As part of zfs_expand_proplist(), we keep track of the maximum column 1375 * width for each property. For the 'NAME' (and 'SOURCE') columns, we 1376 * need to know the maximum name length. However, the user likely did 1377 * not specify 'name' as one of the properties to fetch, so we need to 1378 * make sure we always include at least this property for 1379 * print_get_headers() to work properly. 1380 */ 1381 if (cb.cb_proplist != NULL) { 1382 fake_name.pl_prop = ZFS_PROP_NAME; 1383 fake_name.pl_width = strlen(gettext("NAME")); 1384 fake_name.pl_next = cb.cb_proplist; 1385 cb.cb_proplist = &fake_name; 1386 } 1387 1388 cb.cb_first = B_TRUE; 1389 1390 /* run for each object */ 1391 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET, NULL, 1392 &cb.cb_proplist, limit, get_callback, &cb); 1393 1394 if (cb.cb_proplist == &fake_name) 1395 zprop_free_list(fake_name.pl_next); 1396 else 1397 zprop_free_list(cb.cb_proplist); 1398 1399 return (ret); 1400 } 1401 1402 /* 1403 * inherit [-rS] <property> <fs|vol> ... 1404 * 1405 * -r Recurse over all children 1406 * -S Revert to received value, if any 1407 * 1408 * For each dataset specified on the command line, inherit the given property 1409 * from its parent. Inheriting a property at the pool level will cause it to 1410 * use the default value. The '-r' flag will recurse over all children, and is 1411 * useful for setting a property on a hierarchy-wide basis, regardless of any 1412 * local modifications for each dataset. 1413 */ 1414 1415 typedef struct inherit_cbdata { 1416 const char *cb_propname; 1417 boolean_t cb_received; 1418 } inherit_cbdata_t; 1419 1420 static int 1421 inherit_recurse_cb(zfs_handle_t *zhp, void *data) 1422 { 1423 inherit_cbdata_t *cb = data; 1424 zfs_prop_t prop = zfs_name_to_prop(cb->cb_propname); 1425 1426 /* 1427 * If we're doing it recursively, then ignore properties that 1428 * are not valid for this type of dataset. 1429 */ 1430 if (prop != ZPROP_INVAL && 1431 !zfs_prop_valid_for_type(prop, zfs_get_type(zhp))) 1432 return (0); 1433 1434 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0); 1435 } 1436 1437 static int 1438 inherit_cb(zfs_handle_t *zhp, void *data) 1439 { 1440 inherit_cbdata_t *cb = data; 1441 1442 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0); 1443 } 1444 1445 static int 1446 zfs_do_inherit(int argc, char **argv) 1447 { 1448 int c; 1449 zfs_prop_t prop; 1450 inherit_cbdata_t cb = { 0 }; 1451 char *propname; 1452 int ret; 1453 int flags = 0; 1454 boolean_t received = B_FALSE; 1455 1456 /* check options */ 1457 while ((c = getopt(argc, argv, "rS")) != -1) { 1458 switch (c) { 1459 case 'r': 1460 flags |= ZFS_ITER_RECURSE; 1461 break; 1462 case 'S': 1463 received = B_TRUE; 1464 break; 1465 case '?': 1466 default: 1467 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1468 optopt); 1469 usage(B_FALSE); 1470 } 1471 } 1472 1473 argc -= optind; 1474 argv += optind; 1475 1476 /* check number of arguments */ 1477 if (argc < 1) { 1478 (void) fprintf(stderr, gettext("missing property argument\n")); 1479 usage(B_FALSE); 1480 } 1481 if (argc < 2) { 1482 (void) fprintf(stderr, gettext("missing dataset argument\n")); 1483 usage(B_FALSE); 1484 } 1485 1486 propname = argv[0]; 1487 argc--; 1488 argv++; 1489 1490 if ((prop = zfs_name_to_prop(propname)) != ZPROP_INVAL) { 1491 if (zfs_prop_readonly(prop)) { 1492 (void) fprintf(stderr, gettext( 1493 "%s property is read-only\n"), 1494 propname); 1495 return (1); 1496 } 1497 if (!zfs_prop_inheritable(prop) && !received) { 1498 (void) fprintf(stderr, gettext("'%s' property cannot " 1499 "be inherited\n"), propname); 1500 if (prop == ZFS_PROP_QUOTA || 1501 prop == ZFS_PROP_RESERVATION || 1502 prop == ZFS_PROP_REFQUOTA || 1503 prop == ZFS_PROP_REFRESERVATION) 1504 (void) fprintf(stderr, gettext("use 'zfs set " 1505 "%s=none' to clear\n"), propname); 1506 return (1); 1507 } 1508 if (received && (prop == ZFS_PROP_VOLSIZE || 1509 prop == ZFS_PROP_VERSION)) { 1510 (void) fprintf(stderr, gettext("'%s' property cannot " 1511 "be reverted to a received value\n"), propname); 1512 return (1); 1513 } 1514 } else if (!zfs_prop_user(propname)) { 1515 (void) fprintf(stderr, gettext("invalid property '%s'\n"), 1516 propname); 1517 usage(B_FALSE); 1518 } 1519 1520 cb.cb_propname = propname; 1521 cb.cb_received = received; 1522 1523 if (flags & ZFS_ITER_RECURSE) { 1524 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET, 1525 NULL, NULL, 0, inherit_recurse_cb, &cb); 1526 } else { 1527 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET, 1528 NULL, NULL, 0, inherit_cb, &cb); 1529 } 1530 1531 return (ret); 1532 } 1533 1534 typedef struct upgrade_cbdata { 1535 uint64_t cb_numupgraded; 1536 uint64_t cb_numsamegraded; 1537 uint64_t cb_numfailed; 1538 uint64_t cb_version; 1539 boolean_t cb_newer; 1540 boolean_t cb_foundone; 1541 char cb_lastfs[ZFS_MAXNAMELEN]; 1542 } upgrade_cbdata_t; 1543 1544 static int 1545 same_pool(zfs_handle_t *zhp, const char *name) 1546 { 1547 int len1 = strcspn(name, "/@"); 1548 const char *zhname = zfs_get_name(zhp); 1549 int len2 = strcspn(zhname, "/@"); 1550 1551 if (len1 != len2) 1552 return (B_FALSE); 1553 return (strncmp(name, zhname, len1) == 0); 1554 } 1555 1556 static int 1557 upgrade_list_callback(zfs_handle_t *zhp, void *data) 1558 { 1559 upgrade_cbdata_t *cb = data; 1560 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION); 1561 1562 /* list if it's old/new */ 1563 if ((!cb->cb_newer && version < ZPL_VERSION) || 1564 (cb->cb_newer && version > ZPL_VERSION)) { 1565 char *str; 1566 if (cb->cb_newer) { 1567 str = gettext("The following filesystems are " 1568 "formatted using a newer software version and\n" 1569 "cannot be accessed on the current system.\n\n"); 1570 } else { 1571 str = gettext("The following filesystems are " 1572 "out of date, and can be upgraded. After being\n" 1573 "upgraded, these filesystems (and any 'zfs send' " 1574 "streams generated from\n" 1575 "subsequent snapshots) will no longer be " 1576 "accessible by older software versions.\n\n"); 1577 } 1578 1579 if (!cb->cb_foundone) { 1580 (void) puts(str); 1581 (void) printf(gettext("VER FILESYSTEM\n")); 1582 (void) printf(gettext("--- ------------\n")); 1583 cb->cb_foundone = B_TRUE; 1584 } 1585 1586 (void) printf("%2u %s\n", version, zfs_get_name(zhp)); 1587 } 1588 1589 return (0); 1590 } 1591 1592 static int 1593 upgrade_set_callback(zfs_handle_t *zhp, void *data) 1594 { 1595 upgrade_cbdata_t *cb = data; 1596 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION); 1597 int needed_spa_version; 1598 int spa_version; 1599 1600 if (zfs_spa_version(zhp, &spa_version) < 0) 1601 return (-1); 1602 1603 needed_spa_version = zfs_spa_version_map(cb->cb_version); 1604 1605 if (needed_spa_version < 0) 1606 return (-1); 1607 1608 if (spa_version < needed_spa_version) { 1609 /* can't upgrade */ 1610 (void) printf(gettext("%s: can not be " 1611 "upgraded; the pool version needs to first " 1612 "be upgraded\nto version %d\n\n"), 1613 zfs_get_name(zhp), needed_spa_version); 1614 cb->cb_numfailed++; 1615 return (0); 1616 } 1617 1618 /* upgrade */ 1619 if (version < cb->cb_version) { 1620 char verstr[16]; 1621 (void) snprintf(verstr, sizeof (verstr), 1622 "%llu", cb->cb_version); 1623 if (cb->cb_lastfs[0] && !same_pool(zhp, cb->cb_lastfs)) { 1624 /* 1625 * If they did "zfs upgrade -a", then we could 1626 * be doing ioctls to different pools. We need 1627 * to log this history once to each pool. 1628 */ 1629 verify(zpool_stage_history(g_zfs, history_str) == 0); 1630 } 1631 if (zfs_prop_set(zhp, "version", verstr) == 0) 1632 cb->cb_numupgraded++; 1633 else 1634 cb->cb_numfailed++; 1635 (void) strcpy(cb->cb_lastfs, zfs_get_name(zhp)); 1636 } else if (version > cb->cb_version) { 1637 /* can't downgrade */ 1638 (void) printf(gettext("%s: can not be downgraded; " 1639 "it is already at version %u\n"), 1640 zfs_get_name(zhp), version); 1641 cb->cb_numfailed++; 1642 } else { 1643 cb->cb_numsamegraded++; 1644 } 1645 return (0); 1646 } 1647 1648 /* 1649 * zfs upgrade 1650 * zfs upgrade -v 1651 * zfs upgrade [-r] [-V <version>] <-a | filesystem> 1652 */ 1653 static int 1654 zfs_do_upgrade(int argc, char **argv) 1655 { 1656 boolean_t all = B_FALSE; 1657 boolean_t showversions = B_FALSE; 1658 int ret; 1659 upgrade_cbdata_t cb = { 0 }; 1660 char c; 1661 int flags = ZFS_ITER_ARGS_CAN_BE_PATHS; 1662 1663 /* check options */ 1664 while ((c = getopt(argc, argv, "rvV:a")) != -1) { 1665 switch (c) { 1666 case 'r': 1667 flags |= ZFS_ITER_RECURSE; 1668 break; 1669 case 'v': 1670 showversions = B_TRUE; 1671 break; 1672 case 'V': 1673 if (zfs_prop_string_to_index(ZFS_PROP_VERSION, 1674 optarg, &cb.cb_version) != 0) { 1675 (void) fprintf(stderr, 1676 gettext("invalid version %s\n"), optarg); 1677 usage(B_FALSE); 1678 } 1679 break; 1680 case 'a': 1681 all = B_TRUE; 1682 break; 1683 case '?': 1684 default: 1685 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1686 optopt); 1687 usage(B_FALSE); 1688 } 1689 } 1690 1691 argc -= optind; 1692 argv += optind; 1693 1694 if ((!all && !argc) && ((flags & ZFS_ITER_RECURSE) | cb.cb_version)) 1695 usage(B_FALSE); 1696 if (showversions && (flags & ZFS_ITER_RECURSE || all || 1697 cb.cb_version || argc)) 1698 usage(B_FALSE); 1699 if ((all || argc) && (showversions)) 1700 usage(B_FALSE); 1701 if (all && argc) 1702 usage(B_FALSE); 1703 1704 if (showversions) { 1705 /* Show info on available versions. */ 1706 (void) printf(gettext("The following filesystem versions are " 1707 "supported:\n\n")); 1708 (void) printf(gettext("VER DESCRIPTION\n")); 1709 (void) printf("--- -----------------------------------------" 1710 "---------------\n"); 1711 (void) printf(gettext(" 1 Initial ZFS filesystem version\n")); 1712 (void) printf(gettext(" 2 Enhanced directory entries\n")); 1713 (void) printf(gettext(" 3 Case insensitive and File system " 1714 "unique identifier (FUID)\n")); 1715 (void) printf(gettext(" 4 userquota, groupquota " 1716 "properties\n")); 1717 (void) printf(gettext(" 5 System attributes\n")); 1718 (void) printf(gettext("\nFor more information on a particular " 1719 "version, including supported releases,\n")); 1720 (void) printf("see the ZFS Administration Guide.\n\n"); 1721 ret = 0; 1722 } else if (argc || all) { 1723 /* Upgrade filesystems */ 1724 if (cb.cb_version == 0) 1725 cb.cb_version = ZPL_VERSION; 1726 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_FILESYSTEM, 1727 NULL, NULL, 0, upgrade_set_callback, &cb); 1728 (void) printf(gettext("%llu filesystems upgraded\n"), 1729 cb.cb_numupgraded); 1730 if (cb.cb_numsamegraded) { 1731 (void) printf(gettext("%llu filesystems already at " 1732 "this version\n"), 1733 cb.cb_numsamegraded); 1734 } 1735 if (cb.cb_numfailed != 0) 1736 ret = 1; 1737 } else { 1738 /* List old-version filesytems */ 1739 boolean_t found; 1740 (void) printf(gettext("This system is currently running " 1741 "ZFS filesystem version %llu.\n\n"), ZPL_VERSION); 1742 1743 flags |= ZFS_ITER_RECURSE; 1744 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM, 1745 NULL, NULL, 0, upgrade_list_callback, &cb); 1746 1747 found = cb.cb_foundone; 1748 cb.cb_foundone = B_FALSE; 1749 cb.cb_newer = B_TRUE; 1750 1751 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM, 1752 NULL, NULL, 0, upgrade_list_callback, &cb); 1753 1754 if (!cb.cb_foundone && !found) { 1755 (void) printf(gettext("All filesystems are " 1756 "formatted with the current version.\n")); 1757 } 1758 } 1759 1760 return (ret); 1761 } 1762 1763 /* 1764 * zfs userspace 1765 */ 1766 static int 1767 userspace_cb(void *arg, const char *domain, uid_t rid, uint64_t space) 1768 { 1769 zfs_userquota_prop_t *typep = arg; 1770 zfs_userquota_prop_t p = *typep; 1771 char *name = NULL; 1772 char *ug, *propname; 1773 char namebuf[32]; 1774 char sizebuf[32]; 1775 1776 if (domain == NULL || domain[0] == '\0') { 1777 if (p == ZFS_PROP_GROUPUSED || p == ZFS_PROP_GROUPQUOTA) { 1778 struct group *g = getgrgid(rid); 1779 if (g) 1780 name = g->gr_name; 1781 } else { 1782 struct passwd *p = getpwuid(rid); 1783 if (p) 1784 name = p->pw_name; 1785 } 1786 } 1787 1788 if (p == ZFS_PROP_GROUPUSED || p == ZFS_PROP_GROUPQUOTA) 1789 ug = "group"; 1790 else 1791 ug = "user"; 1792 1793 if (p == ZFS_PROP_USERUSED || p == ZFS_PROP_GROUPUSED) 1794 propname = "used"; 1795 else 1796 propname = "quota"; 1797 1798 if (name == NULL) { 1799 (void) snprintf(namebuf, sizeof (namebuf), 1800 "%llu", (longlong_t)rid); 1801 name = namebuf; 1802 } 1803 zfs_nicenum(space, sizebuf, sizeof (sizebuf)); 1804 1805 (void) printf("%s %s %s%c%s %s\n", propname, ug, domain, 1806 domain[0] ? '-' : ' ', name, sizebuf); 1807 1808 return (0); 1809 } 1810 1811 static int 1812 zfs_do_userspace(int argc, char **argv) 1813 { 1814 zfs_handle_t *zhp; 1815 zfs_userquota_prop_t p; 1816 int error; 1817 1818 /* 1819 * Try the python version. If the execv fails, we'll continue 1820 * and do a simplistic implementation. 1821 */ 1822 (void) execv(pypath, argv-1); 1823 1824 (void) printf("internal error: %s not found\n" 1825 "falling back on built-in implementation, " 1826 "some features will not work\n", pypath); 1827 1828 if ((zhp = zfs_open(g_zfs, argv[argc-1], ZFS_TYPE_DATASET)) == NULL) 1829 return (1); 1830 1831 (void) printf("PROP TYPE NAME VALUE\n"); 1832 1833 for (p = 0; p < ZFS_NUM_USERQUOTA_PROPS; p++) { 1834 error = zfs_userspace(zhp, p, userspace_cb, &p); 1835 if (error) 1836 break; 1837 } 1838 return (error); 1839 } 1840 1841 /* 1842 * list [-r][-d max] [-H] [-o property[,property]...] [-t type[,type]...] 1843 * [-s property [-s property]...] [-S property [-S property]...] 1844 * <dataset> ... 1845 * 1846 * -r Recurse over all children 1847 * -d Limit recursion by depth. 1848 * -H Scripted mode; elide headers and separate columns by tabs 1849 * -o Control which fields to display. 1850 * -t Control which object types to display. 1851 * -s Specify sort columns, descending order. 1852 * -S Specify sort columns, ascending order. 1853 * 1854 * When given no arguments, lists all filesystems in the system. 1855 * Otherwise, list the specified datasets, optionally recursing down them if 1856 * '-r' is specified. 1857 */ 1858 typedef struct list_cbdata { 1859 boolean_t cb_first; 1860 boolean_t cb_scripted; 1861 zprop_list_t *cb_proplist; 1862 } list_cbdata_t; 1863 1864 /* 1865 * Given a list of columns to display, output appropriate headers for each one. 1866 */ 1867 static void 1868 print_header(zprop_list_t *pl) 1869 { 1870 char headerbuf[ZFS_MAXPROPLEN]; 1871 const char *header; 1872 int i; 1873 boolean_t first = B_TRUE; 1874 boolean_t right_justify; 1875 1876 for (; pl != NULL; pl = pl->pl_next) { 1877 if (!first) { 1878 (void) printf(" "); 1879 } else { 1880 first = B_FALSE; 1881 } 1882 1883 right_justify = B_FALSE; 1884 if (pl->pl_prop != ZPROP_INVAL) { 1885 header = zfs_prop_column_name(pl->pl_prop); 1886 right_justify = zfs_prop_align_right(pl->pl_prop); 1887 } else { 1888 for (i = 0; pl->pl_user_prop[i] != '\0'; i++) 1889 headerbuf[i] = toupper(pl->pl_user_prop[i]); 1890 headerbuf[i] = '\0'; 1891 header = headerbuf; 1892 } 1893 1894 if (pl->pl_next == NULL && !right_justify) 1895 (void) printf("%s", header); 1896 else if (right_justify) 1897 (void) printf("%*s", pl->pl_width, header); 1898 else 1899 (void) printf("%-*s", pl->pl_width, header); 1900 } 1901 1902 (void) printf("\n"); 1903 } 1904 1905 /* 1906 * Given a dataset and a list of fields, print out all the properties according 1907 * to the described layout. 1908 */ 1909 static void 1910 print_dataset(zfs_handle_t *zhp, zprop_list_t *pl, boolean_t scripted) 1911 { 1912 boolean_t first = B_TRUE; 1913 char property[ZFS_MAXPROPLEN]; 1914 nvlist_t *userprops = zfs_get_user_props(zhp); 1915 nvlist_t *propval; 1916 char *propstr; 1917 boolean_t right_justify; 1918 int width; 1919 1920 for (; pl != NULL; pl = pl->pl_next) { 1921 if (!first) { 1922 if (scripted) 1923 (void) printf("\t"); 1924 else 1925 (void) printf(" "); 1926 } else { 1927 first = B_FALSE; 1928 } 1929 1930 if (pl->pl_prop != ZPROP_INVAL) { 1931 if (zfs_prop_get(zhp, pl->pl_prop, property, 1932 sizeof (property), NULL, NULL, 0, B_FALSE) != 0) 1933 propstr = "-"; 1934 else 1935 propstr = property; 1936 1937 right_justify = zfs_prop_align_right(pl->pl_prop); 1938 } else if (zfs_prop_userquota(pl->pl_user_prop)) { 1939 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop, 1940 property, sizeof (property), B_FALSE) != 0) 1941 propstr = "-"; 1942 else 1943 propstr = property; 1944 right_justify = B_TRUE; 1945 } else { 1946 if (nvlist_lookup_nvlist(userprops, 1947 pl->pl_user_prop, &propval) != 0) 1948 propstr = "-"; 1949 else 1950 verify(nvlist_lookup_string(propval, 1951 ZPROP_VALUE, &propstr) == 0); 1952 right_justify = B_FALSE; 1953 } 1954 1955 width = pl->pl_width; 1956 1957 /* 1958 * If this is being called in scripted mode, or if this is the 1959 * last column and it is left-justified, don't include a width 1960 * format specifier. 1961 */ 1962 if (scripted || (pl->pl_next == NULL && !right_justify)) 1963 (void) printf("%s", propstr); 1964 else if (right_justify) 1965 (void) printf("%*s", width, propstr); 1966 else 1967 (void) printf("%-*s", width, propstr); 1968 } 1969 1970 (void) printf("\n"); 1971 } 1972 1973 /* 1974 * Generic callback function to list a dataset or snapshot. 1975 */ 1976 static int 1977 list_callback(zfs_handle_t *zhp, void *data) 1978 { 1979 list_cbdata_t *cbp = data; 1980 1981 if (cbp->cb_first) { 1982 if (!cbp->cb_scripted) 1983 print_header(cbp->cb_proplist); 1984 cbp->cb_first = B_FALSE; 1985 } 1986 1987 print_dataset(zhp, cbp->cb_proplist, cbp->cb_scripted); 1988 1989 return (0); 1990 } 1991 1992 static int 1993 zfs_do_list(int argc, char **argv) 1994 { 1995 int c; 1996 boolean_t scripted = B_FALSE; 1997 static char default_fields[] = 1998 "name,used,available,referenced,mountpoint"; 1999 int types = ZFS_TYPE_DATASET; 2000 boolean_t types_specified = B_FALSE; 2001 char *fields = NULL; 2002 list_cbdata_t cb = { 0 }; 2003 char *value; 2004 int limit = 0; 2005 int ret; 2006 zfs_sort_column_t *sortcol = NULL; 2007 int flags = ZFS_ITER_PROP_LISTSNAPS | ZFS_ITER_ARGS_CAN_BE_PATHS; 2008 2009 /* check options */ 2010 while ((c = getopt(argc, argv, ":d:o:rt:Hs:S:")) != -1) { 2011 switch (c) { 2012 case 'o': 2013 fields = optarg; 2014 break; 2015 case 'd': 2016 limit = parse_depth(optarg, &flags); 2017 break; 2018 case 'r': 2019 flags |= ZFS_ITER_RECURSE; 2020 break; 2021 case 'H': 2022 scripted = B_TRUE; 2023 break; 2024 case 's': 2025 if (zfs_add_sort_column(&sortcol, optarg, 2026 B_FALSE) != 0) { 2027 (void) fprintf(stderr, 2028 gettext("invalid property '%s'\n"), optarg); 2029 usage(B_FALSE); 2030 } 2031 break; 2032 case 'S': 2033 if (zfs_add_sort_column(&sortcol, optarg, 2034 B_TRUE) != 0) { 2035 (void) fprintf(stderr, 2036 gettext("invalid property '%s'\n"), optarg); 2037 usage(B_FALSE); 2038 } 2039 break; 2040 case 't': 2041 types = 0; 2042 types_specified = B_TRUE; 2043 flags &= ~ZFS_ITER_PROP_LISTSNAPS; 2044 while (*optarg != '\0') { 2045 static char *type_subopts[] = { "filesystem", 2046 "volume", "snapshot", "all", NULL }; 2047 2048 switch (getsubopt(&optarg, type_subopts, 2049 &value)) { 2050 case 0: 2051 types |= ZFS_TYPE_FILESYSTEM; 2052 break; 2053 case 1: 2054 types |= ZFS_TYPE_VOLUME; 2055 break; 2056 case 2: 2057 types |= ZFS_TYPE_SNAPSHOT; 2058 break; 2059 case 3: 2060 types = ZFS_TYPE_DATASET; 2061 break; 2062 2063 default: 2064 (void) fprintf(stderr, 2065 gettext("invalid type '%s'\n"), 2066 value); 2067 usage(B_FALSE); 2068 } 2069 } 2070 break; 2071 case ':': 2072 (void) fprintf(stderr, gettext("missing argument for " 2073 "'%c' option\n"), optopt); 2074 usage(B_FALSE); 2075 break; 2076 case '?': 2077 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2078 optopt); 2079 usage(B_FALSE); 2080 } 2081 } 2082 2083 argc -= optind; 2084 argv += optind; 2085 2086 if (fields == NULL) 2087 fields = default_fields; 2088 2089 /* 2090 * If "-o space" and no types were specified, don't display snapshots. 2091 */ 2092 if (strcmp(fields, "space") == 0 && types_specified == B_FALSE) 2093 types &= ~ZFS_TYPE_SNAPSHOT; 2094 2095 /* 2096 * If the user specifies '-o all', the zprop_get_list() doesn't 2097 * normally include the name of the dataset. For 'zfs list', we always 2098 * want this property to be first. 2099 */ 2100 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET) 2101 != 0) 2102 usage(B_FALSE); 2103 2104 cb.cb_scripted = scripted; 2105 cb.cb_first = B_TRUE; 2106 2107 ret = zfs_for_each(argc, argv, flags, types, sortcol, &cb.cb_proplist, 2108 limit, list_callback, &cb); 2109 2110 zprop_free_list(cb.cb_proplist); 2111 zfs_free_sort_columns(sortcol); 2112 2113 if (ret == 0 && cb.cb_first && !cb.cb_scripted) 2114 (void) printf(gettext("no datasets available\n")); 2115 2116 return (ret); 2117 } 2118 2119 /* 2120 * zfs rename <fs | snap | vol> <fs | snap | vol> 2121 * zfs rename -p <fs | vol> <fs | vol> 2122 * zfs rename -r <snap> <snap> 2123 * 2124 * Renames the given dataset to another of the same type. 2125 * 2126 * The '-p' flag creates all the non-existing ancestors of the target first. 2127 */ 2128 /* ARGSUSED */ 2129 static int 2130 zfs_do_rename(int argc, char **argv) 2131 { 2132 zfs_handle_t *zhp; 2133 int c; 2134 int ret; 2135 boolean_t recurse = B_FALSE; 2136 boolean_t parents = B_FALSE; 2137 2138 /* check options */ 2139 while ((c = getopt(argc, argv, "pr")) != -1) { 2140 switch (c) { 2141 case 'p': 2142 parents = B_TRUE; 2143 break; 2144 case 'r': 2145 recurse = B_TRUE; 2146 break; 2147 case '?': 2148 default: 2149 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2150 optopt); 2151 usage(B_FALSE); 2152 } 2153 } 2154 2155 argc -= optind; 2156 argv += optind; 2157 2158 /* check number of arguments */ 2159 if (argc < 1) { 2160 (void) fprintf(stderr, gettext("missing source dataset " 2161 "argument\n")); 2162 usage(B_FALSE); 2163 } 2164 if (argc < 2) { 2165 (void) fprintf(stderr, gettext("missing target dataset " 2166 "argument\n")); 2167 usage(B_FALSE); 2168 } 2169 if (argc > 2) { 2170 (void) fprintf(stderr, gettext("too many arguments\n")); 2171 usage(B_FALSE); 2172 } 2173 2174 if (recurse && parents) { 2175 (void) fprintf(stderr, gettext("-p and -r options are mutually " 2176 "exclusive\n")); 2177 usage(B_FALSE); 2178 } 2179 2180 if (recurse && strchr(argv[0], '@') == 0) { 2181 (void) fprintf(stderr, gettext("source dataset for recursive " 2182 "rename must be a snapshot\n")); 2183 usage(B_FALSE); 2184 } 2185 2186 if ((zhp = zfs_open(g_zfs, argv[0], parents ? ZFS_TYPE_FILESYSTEM | 2187 ZFS_TYPE_VOLUME : ZFS_TYPE_DATASET)) == NULL) 2188 return (1); 2189 2190 /* If we were asked and the name looks good, try to create ancestors. */ 2191 if (parents && zfs_name_valid(argv[1], zfs_get_type(zhp)) && 2192 zfs_create_ancestors(g_zfs, argv[1]) != 0) { 2193 zfs_close(zhp); 2194 return (1); 2195 } 2196 2197 ret = (zfs_rename(zhp, argv[1], recurse) != 0); 2198 2199 zfs_close(zhp); 2200 return (ret); 2201 } 2202 2203 /* 2204 * zfs promote <fs> 2205 * 2206 * Promotes the given clone fs to be the parent 2207 */ 2208 /* ARGSUSED */ 2209 static int 2210 zfs_do_promote(int argc, char **argv) 2211 { 2212 zfs_handle_t *zhp; 2213 int ret; 2214 2215 /* check options */ 2216 if (argc > 1 && argv[1][0] == '-') { 2217 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2218 argv[1][1]); 2219 usage(B_FALSE); 2220 } 2221 2222 /* check number of arguments */ 2223 if (argc < 2) { 2224 (void) fprintf(stderr, gettext("missing clone filesystem" 2225 " argument\n")); 2226 usage(B_FALSE); 2227 } 2228 if (argc > 2) { 2229 (void) fprintf(stderr, gettext("too many arguments\n")); 2230 usage(B_FALSE); 2231 } 2232 2233 zhp = zfs_open(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2234 if (zhp == NULL) 2235 return (1); 2236 2237 ret = (zfs_promote(zhp) != 0); 2238 2239 2240 zfs_close(zhp); 2241 return (ret); 2242 } 2243 2244 /* 2245 * zfs rollback [-rRf] <snapshot> 2246 * 2247 * -r Delete any intervening snapshots before doing rollback 2248 * -R Delete any snapshots and their clones 2249 * -f ignored for backwards compatability 2250 * 2251 * Given a filesystem, rollback to a specific snapshot, discarding any changes 2252 * since then and making it the active dataset. If more recent snapshots exist, 2253 * the command will complain unless the '-r' flag is given. 2254 */ 2255 typedef struct rollback_cbdata { 2256 uint64_t cb_create; 2257 boolean_t cb_first; 2258 int cb_doclones; 2259 char *cb_target; 2260 int cb_error; 2261 boolean_t cb_recurse; 2262 boolean_t cb_dependent; 2263 } rollback_cbdata_t; 2264 2265 /* 2266 * Report any snapshots more recent than the one specified. Used when '-r' is 2267 * not specified. We reuse this same callback for the snapshot dependents - if 2268 * 'cb_dependent' is set, then this is a dependent and we should report it 2269 * without checking the transaction group. 2270 */ 2271 static int 2272 rollback_check(zfs_handle_t *zhp, void *data) 2273 { 2274 rollback_cbdata_t *cbp = data; 2275 2276 if (cbp->cb_doclones) { 2277 zfs_close(zhp); 2278 return (0); 2279 } 2280 2281 if (!cbp->cb_dependent) { 2282 if (strcmp(zfs_get_name(zhp), cbp->cb_target) != 0 && 2283 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 2284 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > 2285 cbp->cb_create) { 2286 2287 if (cbp->cb_first && !cbp->cb_recurse) { 2288 (void) fprintf(stderr, gettext("cannot " 2289 "rollback to '%s': more recent snapshots " 2290 "exist\n"), 2291 cbp->cb_target); 2292 (void) fprintf(stderr, gettext("use '-r' to " 2293 "force deletion of the following " 2294 "snapshots:\n")); 2295 cbp->cb_first = 0; 2296 cbp->cb_error = 1; 2297 } 2298 2299 if (cbp->cb_recurse) { 2300 cbp->cb_dependent = B_TRUE; 2301 if (zfs_iter_dependents(zhp, B_TRUE, 2302 rollback_check, cbp) != 0) { 2303 zfs_close(zhp); 2304 return (-1); 2305 } 2306 cbp->cb_dependent = B_FALSE; 2307 } else { 2308 (void) fprintf(stderr, "%s\n", 2309 zfs_get_name(zhp)); 2310 } 2311 } 2312 } else { 2313 if (cbp->cb_first && cbp->cb_recurse) { 2314 (void) fprintf(stderr, gettext("cannot rollback to " 2315 "'%s': clones of previous snapshots exist\n"), 2316 cbp->cb_target); 2317 (void) fprintf(stderr, gettext("use '-R' to " 2318 "force deletion of the following clones and " 2319 "dependents:\n")); 2320 cbp->cb_first = 0; 2321 cbp->cb_error = 1; 2322 } 2323 2324 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 2325 } 2326 2327 zfs_close(zhp); 2328 return (0); 2329 } 2330 2331 static int 2332 zfs_do_rollback(int argc, char **argv) 2333 { 2334 int ret; 2335 int c; 2336 boolean_t force = B_FALSE; 2337 rollback_cbdata_t cb = { 0 }; 2338 zfs_handle_t *zhp, *snap; 2339 char parentname[ZFS_MAXNAMELEN]; 2340 char *delim; 2341 2342 /* check options */ 2343 while ((c = getopt(argc, argv, "rRf")) != -1) { 2344 switch (c) { 2345 case 'r': 2346 cb.cb_recurse = 1; 2347 break; 2348 case 'R': 2349 cb.cb_recurse = 1; 2350 cb.cb_doclones = 1; 2351 break; 2352 case 'f': 2353 force = B_TRUE; 2354 break; 2355 case '?': 2356 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2357 optopt); 2358 usage(B_FALSE); 2359 } 2360 } 2361 2362 argc -= optind; 2363 argv += optind; 2364 2365 /* check number of arguments */ 2366 if (argc < 1) { 2367 (void) fprintf(stderr, gettext("missing dataset argument\n")); 2368 usage(B_FALSE); 2369 } 2370 if (argc > 1) { 2371 (void) fprintf(stderr, gettext("too many arguments\n")); 2372 usage(B_FALSE); 2373 } 2374 2375 /* open the snapshot */ 2376 if ((snap = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL) 2377 return (1); 2378 2379 /* open the parent dataset */ 2380 (void) strlcpy(parentname, argv[0], sizeof (parentname)); 2381 verify((delim = strrchr(parentname, '@')) != NULL); 2382 *delim = '\0'; 2383 if ((zhp = zfs_open(g_zfs, parentname, ZFS_TYPE_DATASET)) == NULL) { 2384 zfs_close(snap); 2385 return (1); 2386 } 2387 2388 /* 2389 * Check for more recent snapshots and/or clones based on the presence 2390 * of '-r' and '-R'. 2391 */ 2392 cb.cb_target = argv[0]; 2393 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG); 2394 cb.cb_first = B_TRUE; 2395 cb.cb_error = 0; 2396 if ((ret = zfs_iter_children(zhp, rollback_check, &cb)) != 0) 2397 goto out; 2398 2399 if ((ret = cb.cb_error) != 0) 2400 goto out; 2401 2402 /* 2403 * Rollback parent to the given snapshot. 2404 */ 2405 ret = zfs_rollback(zhp, snap, force); 2406 2407 out: 2408 zfs_close(snap); 2409 zfs_close(zhp); 2410 2411 if (ret == 0) 2412 return (0); 2413 else 2414 return (1); 2415 } 2416 2417 /* 2418 * zfs set property=value { fs | snap | vol } ... 2419 * 2420 * Sets the given property for all datasets specified on the command line. 2421 */ 2422 typedef struct set_cbdata { 2423 char *cb_propname; 2424 char *cb_value; 2425 } set_cbdata_t; 2426 2427 static int 2428 set_callback(zfs_handle_t *zhp, void *data) 2429 { 2430 set_cbdata_t *cbp = data; 2431 2432 if (zfs_prop_set(zhp, cbp->cb_propname, cbp->cb_value) != 0) { 2433 switch (libzfs_errno(g_zfs)) { 2434 case EZFS_MOUNTFAILED: 2435 (void) fprintf(stderr, gettext("property may be set " 2436 "but unable to remount filesystem\n")); 2437 break; 2438 case EZFS_SHARENFSFAILED: 2439 (void) fprintf(stderr, gettext("property may be set " 2440 "but unable to reshare filesystem\n")); 2441 break; 2442 } 2443 return (1); 2444 } 2445 return (0); 2446 } 2447 2448 static int 2449 zfs_do_set(int argc, char **argv) 2450 { 2451 set_cbdata_t cb; 2452 int ret; 2453 2454 /* check for options */ 2455 if (argc > 1 && argv[1][0] == '-') { 2456 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2457 argv[1][1]); 2458 usage(B_FALSE); 2459 } 2460 2461 /* check number of arguments */ 2462 if (argc < 2) { 2463 (void) fprintf(stderr, gettext("missing property=value " 2464 "argument\n")); 2465 usage(B_FALSE); 2466 } 2467 if (argc < 3) { 2468 (void) fprintf(stderr, gettext("missing dataset name\n")); 2469 usage(B_FALSE); 2470 } 2471 2472 /* validate property=value argument */ 2473 cb.cb_propname = argv[1]; 2474 if (((cb.cb_value = strchr(cb.cb_propname, '=')) == NULL) || 2475 (cb.cb_value[1] == '\0')) { 2476 (void) fprintf(stderr, gettext("missing value in " 2477 "property=value argument\n")); 2478 usage(B_FALSE); 2479 } 2480 2481 *cb.cb_value = '\0'; 2482 cb.cb_value++; 2483 2484 if (*cb.cb_propname == '\0') { 2485 (void) fprintf(stderr, 2486 gettext("missing property in property=value argument\n")); 2487 usage(B_FALSE); 2488 } 2489 2490 ret = zfs_for_each(argc - 2, argv + 2, NULL, 2491 ZFS_TYPE_DATASET, NULL, NULL, 0, set_callback, &cb); 2492 2493 return (ret); 2494 } 2495 2496 /* 2497 * zfs snapshot [-r] [-o prop=value] ... <fs@snap> 2498 * 2499 * Creates a snapshot with the given name. While functionally equivalent to 2500 * 'zfs create', it is a separate command to differentiate intent. 2501 */ 2502 static int 2503 zfs_do_snapshot(int argc, char **argv) 2504 { 2505 boolean_t recursive = B_FALSE; 2506 int ret; 2507 char c; 2508 nvlist_t *props; 2509 2510 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) { 2511 (void) fprintf(stderr, gettext("internal error: " 2512 "out of memory\n")); 2513 return (1); 2514 } 2515 2516 /* check options */ 2517 while ((c = getopt(argc, argv, "ro:")) != -1) { 2518 switch (c) { 2519 case 'o': 2520 if (parseprop(props)) 2521 return (1); 2522 break; 2523 case 'r': 2524 recursive = B_TRUE; 2525 break; 2526 case '?': 2527 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2528 optopt); 2529 goto usage; 2530 } 2531 } 2532 2533 argc -= optind; 2534 argv += optind; 2535 2536 /* check number of arguments */ 2537 if (argc < 1) { 2538 (void) fprintf(stderr, gettext("missing snapshot argument\n")); 2539 goto usage; 2540 } 2541 if (argc > 1) { 2542 (void) fprintf(stderr, gettext("too many arguments\n")); 2543 goto usage; 2544 } 2545 2546 ret = zfs_snapshot(g_zfs, argv[0], recursive, props); 2547 nvlist_free(props); 2548 if (ret && recursive) 2549 (void) fprintf(stderr, gettext("no snapshots were created\n")); 2550 return (ret != 0); 2551 2552 usage: 2553 nvlist_free(props); 2554 usage(B_FALSE); 2555 return (-1); 2556 } 2557 2558 /* 2559 * zfs send [-vDp] -R [-i|-I <@snap>] <fs@snap> 2560 * zfs send [-vDp] [-i|-I <@snap>] <fs@snap> 2561 * 2562 * Send a backup stream to stdout. 2563 */ 2564 static int 2565 zfs_do_send(int argc, char **argv) 2566 { 2567 char *fromname = NULL; 2568 char *toname = NULL; 2569 char *cp; 2570 zfs_handle_t *zhp; 2571 sendflags_t flags = { 0 }; 2572 int c, err; 2573 nvlist_t *dbgnv; 2574 boolean_t extraverbose = B_FALSE; 2575 2576 /* check options */ 2577 while ((c = getopt(argc, argv, ":i:I:RDpv")) != -1) { 2578 switch (c) { 2579 case 'i': 2580 if (fromname) 2581 usage(B_FALSE); 2582 fromname = optarg; 2583 break; 2584 case 'I': 2585 if (fromname) 2586 usage(B_FALSE); 2587 fromname = optarg; 2588 flags.doall = B_TRUE; 2589 break; 2590 case 'R': 2591 flags.replicate = B_TRUE; 2592 break; 2593 case 'p': 2594 flags.props = B_TRUE; 2595 break; 2596 case 'v': 2597 if (flags.verbose) 2598 extraverbose = B_TRUE; 2599 flags.verbose = B_TRUE; 2600 break; 2601 case 'D': 2602 flags.dedup = B_TRUE; 2603 break; 2604 case ':': 2605 (void) fprintf(stderr, gettext("missing argument for " 2606 "'%c' option\n"), optopt); 2607 usage(B_FALSE); 2608 break; 2609 case '?': 2610 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2611 optopt); 2612 usage(B_FALSE); 2613 } 2614 } 2615 2616 argc -= optind; 2617 argv += optind; 2618 2619 /* check number of arguments */ 2620 if (argc < 1) { 2621 (void) fprintf(stderr, gettext("missing snapshot argument\n")); 2622 usage(B_FALSE); 2623 } 2624 if (argc > 1) { 2625 (void) fprintf(stderr, gettext("too many arguments\n")); 2626 usage(B_FALSE); 2627 } 2628 2629 if (isatty(STDOUT_FILENO)) { 2630 (void) fprintf(stderr, 2631 gettext("Error: Stream can not be written to a terminal.\n" 2632 "You must redirect standard output.\n")); 2633 return (1); 2634 } 2635 2636 cp = strchr(argv[0], '@'); 2637 if (cp == NULL) { 2638 (void) fprintf(stderr, 2639 gettext("argument must be a snapshot\n")); 2640 usage(B_FALSE); 2641 } 2642 *cp = '\0'; 2643 toname = cp + 1; 2644 zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2645 if (zhp == NULL) 2646 return (1); 2647 2648 /* 2649 * If they specified the full path to the snapshot, chop off 2650 * everything except the short name of the snapshot, but special 2651 * case if they specify the origin. 2652 */ 2653 if (fromname && (cp = strchr(fromname, '@')) != NULL) { 2654 char origin[ZFS_MAXNAMELEN]; 2655 zprop_source_t src; 2656 2657 (void) zfs_prop_get(zhp, ZFS_PROP_ORIGIN, 2658 origin, sizeof (origin), &src, NULL, 0, B_FALSE); 2659 2660 if (strcmp(origin, fromname) == 0) { 2661 fromname = NULL; 2662 flags.fromorigin = B_TRUE; 2663 } else { 2664 *cp = '\0'; 2665 if (cp != fromname && strcmp(argv[0], fromname)) { 2666 (void) fprintf(stderr, 2667 gettext("incremental source must be " 2668 "in same filesystem\n")); 2669 usage(B_FALSE); 2670 } 2671 fromname = cp + 1; 2672 if (strchr(fromname, '@') || strchr(fromname, '/')) { 2673 (void) fprintf(stderr, 2674 gettext("invalid incremental source\n")); 2675 usage(B_FALSE); 2676 } 2677 } 2678 } 2679 2680 if (flags.replicate && fromname == NULL) 2681 flags.doall = B_TRUE; 2682 2683 err = zfs_send(zhp, fromname, toname, flags, STDOUT_FILENO, NULL, 0, 2684 extraverbose ? &dbgnv : NULL); 2685 2686 if (extraverbose) { 2687 /* 2688 * dump_nvlist prints to stdout, but that's been 2689 * redirected to a file. Make it print to stderr 2690 * instead. 2691 */ 2692 (void) dup2(STDERR_FILENO, STDOUT_FILENO); 2693 dump_nvlist(dbgnv, 0); 2694 nvlist_free(dbgnv); 2695 } 2696 zfs_close(zhp); 2697 2698 return (err != 0); 2699 } 2700 2701 /* 2702 * zfs receive [-denuvF] <fs@snap> 2703 * 2704 * Restore a backup stream from stdin. 2705 */ 2706 static int 2707 zfs_do_receive(int argc, char **argv) 2708 { 2709 int c, err; 2710 recvflags_t flags = { 0 }; 2711 2712 /* check options */ 2713 while ((c = getopt(argc, argv, ":denuvF")) != -1) { 2714 switch (c) { 2715 case 'd': 2716 flags.isprefix = B_TRUE; 2717 break; 2718 case 'e': 2719 flags.isprefix = B_TRUE; 2720 flags.istail = B_TRUE; 2721 break; 2722 case 'n': 2723 flags.dryrun = B_TRUE; 2724 break; 2725 case 'u': 2726 flags.nomount = B_TRUE; 2727 break; 2728 case 'v': 2729 flags.verbose = B_TRUE; 2730 break; 2731 case 'F': 2732 flags.force = B_TRUE; 2733 break; 2734 case ':': 2735 (void) fprintf(stderr, gettext("missing argument for " 2736 "'%c' option\n"), optopt); 2737 usage(B_FALSE); 2738 break; 2739 case '?': 2740 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2741 optopt); 2742 usage(B_FALSE); 2743 } 2744 } 2745 2746 argc -= optind; 2747 argv += optind; 2748 2749 /* check number of arguments */ 2750 if (argc < 1) { 2751 (void) fprintf(stderr, gettext("missing snapshot argument\n")); 2752 usage(B_FALSE); 2753 } 2754 if (argc > 1) { 2755 (void) fprintf(stderr, gettext("too many arguments\n")); 2756 usage(B_FALSE); 2757 } 2758 2759 if (isatty(STDIN_FILENO)) { 2760 (void) fprintf(stderr, 2761 gettext("Error: Backup stream can not be read " 2762 "from a terminal.\n" 2763 "You must redirect standard input.\n")); 2764 return (1); 2765 } 2766 2767 err = zfs_receive(g_zfs, argv[0], flags, STDIN_FILENO, NULL); 2768 2769 return (err != 0); 2770 } 2771 2772 static int 2773 zfs_do_hold_rele_impl(int argc, char **argv, boolean_t holding) 2774 { 2775 int errors = 0; 2776 int i; 2777 const char *tag; 2778 boolean_t recursive = B_FALSE; 2779 boolean_t temphold = B_FALSE; 2780 const char *opts = holding ? "rt" : "r"; 2781 int c; 2782 2783 /* check options */ 2784 while ((c = getopt(argc, argv, opts)) != -1) { 2785 switch (c) { 2786 case 'r': 2787 recursive = B_TRUE; 2788 break; 2789 case 't': 2790 temphold = B_TRUE; 2791 break; 2792 case '?': 2793 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2794 optopt); 2795 usage(B_FALSE); 2796 } 2797 } 2798 2799 argc -= optind; 2800 argv += optind; 2801 2802 /* check number of arguments */ 2803 if (argc < 2) 2804 usage(B_FALSE); 2805 2806 tag = argv[0]; 2807 --argc; 2808 ++argv; 2809 2810 if (holding && tag[0] == '.') { 2811 /* tags starting with '.' are reserved for libzfs */ 2812 (void) fprintf(stderr, gettext("tag may not start with '.'\n")); 2813 usage(B_FALSE); 2814 } 2815 2816 for (i = 0; i < argc; ++i) { 2817 zfs_handle_t *zhp; 2818 char parent[ZFS_MAXNAMELEN]; 2819 const char *delim; 2820 char *path = argv[i]; 2821 2822 delim = strchr(path, '@'); 2823 if (delim == NULL) { 2824 (void) fprintf(stderr, 2825 gettext("'%s' is not a snapshot\n"), path); 2826 ++errors; 2827 continue; 2828 } 2829 (void) strncpy(parent, path, delim - path); 2830 parent[delim - path] = '\0'; 2831 2832 zhp = zfs_open(g_zfs, parent, 2833 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 2834 if (zhp == NULL) { 2835 ++errors; 2836 continue; 2837 } 2838 if (holding) { 2839 if (zfs_hold(zhp, delim+1, tag, recursive, 2840 temphold, B_FALSE) != 0) 2841 ++errors; 2842 } else { 2843 if (zfs_release(zhp, delim+1, tag, recursive) != 0) 2844 ++errors; 2845 } 2846 zfs_close(zhp); 2847 } 2848 2849 return (errors != 0); 2850 } 2851 2852 /* 2853 * zfs hold [-r] [-t] <tag> <snap> ... 2854 * 2855 * -r Recursively hold 2856 * -t Temporary hold (hidden option) 2857 * 2858 * Apply a user-hold with the given tag to the list of snapshots. 2859 */ 2860 static int 2861 zfs_do_hold(int argc, char **argv) 2862 { 2863 return (zfs_do_hold_rele_impl(argc, argv, B_TRUE)); 2864 } 2865 2866 /* 2867 * zfs release [-r] <tag> <snap> ... 2868 * 2869 * -r Recursively release 2870 * 2871 * Release a user-hold with the given tag from the list of snapshots. 2872 */ 2873 static int 2874 zfs_do_release(int argc, char **argv) 2875 { 2876 return (zfs_do_hold_rele_impl(argc, argv, B_FALSE)); 2877 } 2878 2879 typedef struct get_all_cbdata { 2880 zfs_handle_t **cb_handles; 2881 size_t cb_alloc; 2882 size_t cb_used; 2883 uint_t cb_types; 2884 boolean_t cb_verbose; 2885 } get_all_cbdata_t; 2886 2887 #define CHECK_SPINNER 30 2888 #define SPINNER_TIME 3 /* seconds */ 2889 #define MOUNT_TIME 5 /* seconds */ 2890 2891 static int 2892 get_one_dataset(zfs_handle_t *zhp, void *data) 2893 { 2894 static char spin[] = { '-', '\\', '|', '/' }; 2895 static int spinval = 0; 2896 static int spincheck = 0; 2897 static time_t last_spin_time = (time_t)0; 2898 get_all_cbdata_t *cbp = data; 2899 zfs_type_t type = zfs_get_type(zhp); 2900 2901 if (cbp->cb_verbose) { 2902 if (--spincheck < 0) { 2903 time_t now = time(NULL); 2904 if (last_spin_time + SPINNER_TIME < now) { 2905 (void) printf("\b%c", spin[spinval++ % 4]); 2906 (void) fflush(stdout); 2907 last_spin_time = now; 2908 } 2909 spincheck = CHECK_SPINNER; 2910 } 2911 } 2912 2913 /* 2914 * Interate over any nested datasets. 2915 */ 2916 if (type == ZFS_TYPE_FILESYSTEM && 2917 zfs_iter_filesystems(zhp, get_one_dataset, data) != 0) { 2918 zfs_close(zhp); 2919 return (1); 2920 } 2921 2922 /* 2923 * Skip any datasets whose type does not match. 2924 */ 2925 if ((type & cbp->cb_types) == 0) { 2926 zfs_close(zhp); 2927 return (0); 2928 } 2929 2930 if (cbp->cb_alloc == cbp->cb_used) { 2931 zfs_handle_t **handles; 2932 2933 if (cbp->cb_alloc == 0) 2934 cbp->cb_alloc = 64; 2935 else 2936 cbp->cb_alloc *= 2; 2937 2938 handles = safe_malloc(cbp->cb_alloc * sizeof (void *)); 2939 2940 if (cbp->cb_handles) { 2941 bcopy(cbp->cb_handles, handles, 2942 cbp->cb_used * sizeof (void *)); 2943 free(cbp->cb_handles); 2944 } 2945 2946 cbp->cb_handles = handles; 2947 } 2948 2949 cbp->cb_handles[cbp->cb_used++] = zhp; 2950 2951 return (0); 2952 } 2953 2954 static void 2955 get_all_datasets(uint_t types, zfs_handle_t ***dslist, size_t *count, 2956 boolean_t verbose) 2957 { 2958 get_all_cbdata_t cb = { 0 }; 2959 cb.cb_types = types; 2960 cb.cb_verbose = verbose; 2961 2962 if (verbose) { 2963 (void) printf("%s: *", gettext("Reading ZFS config")); 2964 (void) fflush(stdout); 2965 } 2966 2967 (void) zfs_iter_root(g_zfs, get_one_dataset, &cb); 2968 2969 *dslist = cb.cb_handles; 2970 *count = cb.cb_used; 2971 2972 if (verbose) { 2973 (void) printf("\b%s\n", gettext("done.")); 2974 } 2975 } 2976 2977 static int 2978 dataset_cmp(const void *a, const void *b) 2979 { 2980 zfs_handle_t **za = (zfs_handle_t **)a; 2981 zfs_handle_t **zb = (zfs_handle_t **)b; 2982 char mounta[MAXPATHLEN]; 2983 char mountb[MAXPATHLEN]; 2984 boolean_t gota, gotb; 2985 2986 if ((gota = (zfs_get_type(*za) == ZFS_TYPE_FILESYSTEM)) != 0) 2987 verify(zfs_prop_get(*za, ZFS_PROP_MOUNTPOINT, mounta, 2988 sizeof (mounta), NULL, NULL, 0, B_FALSE) == 0); 2989 if ((gotb = (zfs_get_type(*zb) == ZFS_TYPE_FILESYSTEM)) != 0) 2990 verify(zfs_prop_get(*zb, ZFS_PROP_MOUNTPOINT, mountb, 2991 sizeof (mountb), NULL, NULL, 0, B_FALSE) == 0); 2992 2993 if (gota && gotb) 2994 return (strcmp(mounta, mountb)); 2995 2996 if (gota) 2997 return (-1); 2998 if (gotb) 2999 return (1); 3000 3001 return (strcmp(zfs_get_name(a), zfs_get_name(b))); 3002 } 3003 3004 /* 3005 * Generic callback for sharing or mounting filesystems. Because the code is so 3006 * similar, we have a common function with an extra parameter to determine which 3007 * mode we are using. 3008 */ 3009 #define OP_SHARE 0x1 3010 #define OP_MOUNT 0x2 3011 3012 /* 3013 * Share or mount a dataset. 3014 */ 3015 static int 3016 share_mount_one(zfs_handle_t *zhp, int op, int flags, char *protocol, 3017 boolean_t explicit, const char *options) 3018 { 3019 char mountpoint[ZFS_MAXPROPLEN]; 3020 char shareopts[ZFS_MAXPROPLEN]; 3021 char smbshareopts[ZFS_MAXPROPLEN]; 3022 const char *cmdname = op == OP_SHARE ? "share" : "mount"; 3023 struct mnttab mnt; 3024 uint64_t zoned, canmount; 3025 zfs_type_t type = zfs_get_type(zhp); 3026 boolean_t shared_nfs, shared_smb; 3027 3028 assert(type & (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME)); 3029 3030 if (type == ZFS_TYPE_FILESYSTEM) { 3031 /* 3032 * Check to make sure we can mount/share this dataset. If we 3033 * are in the global zone and the filesystem is exported to a 3034 * local zone, or if we are in a local zone and the 3035 * filesystem is not exported, then it is an error. 3036 */ 3037 zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED); 3038 3039 if (zoned && getzoneid() == GLOBAL_ZONEID) { 3040 if (!explicit) 3041 return (0); 3042 3043 (void) fprintf(stderr, gettext("cannot %s '%s': " 3044 "dataset is exported to a local zone\n"), cmdname, 3045 zfs_get_name(zhp)); 3046 return (1); 3047 3048 } else if (!zoned && getzoneid() != GLOBAL_ZONEID) { 3049 if (!explicit) 3050 return (0); 3051 3052 (void) fprintf(stderr, gettext("cannot %s '%s': " 3053 "permission denied\n"), cmdname, 3054 zfs_get_name(zhp)); 3055 return (1); 3056 } 3057 3058 /* 3059 * Ignore any filesystems which don't apply to us. This 3060 * includes those with a legacy mountpoint, or those with 3061 * legacy share options. 3062 */ 3063 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint, 3064 sizeof (mountpoint), NULL, NULL, 0, B_FALSE) == 0); 3065 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, shareopts, 3066 sizeof (shareopts), NULL, NULL, 0, B_FALSE) == 0); 3067 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshareopts, 3068 sizeof (smbshareopts), NULL, NULL, 0, B_FALSE) == 0); 3069 3070 if (op == OP_SHARE && strcmp(shareopts, "off") == 0 && 3071 strcmp(smbshareopts, "off") == 0) { 3072 if (!explicit) 3073 return (0); 3074 3075 (void) fprintf(stderr, gettext("cannot share '%s': " 3076 "legacy share\n"), zfs_get_name(zhp)); 3077 (void) fprintf(stderr, gettext("use share(1M) to " 3078 "share this filesystem, or set " 3079 "sharenfs property on\n")); 3080 return (1); 3081 } 3082 3083 /* 3084 * We cannot share or mount legacy filesystems. If the 3085 * shareopts is non-legacy but the mountpoint is legacy, we 3086 * treat it as a legacy share. 3087 */ 3088 if (strcmp(mountpoint, "legacy") == 0) { 3089 if (!explicit) 3090 return (0); 3091 3092 (void) fprintf(stderr, gettext("cannot %s '%s': " 3093 "legacy mountpoint\n"), cmdname, zfs_get_name(zhp)); 3094 (void) fprintf(stderr, gettext("use %s(1M) to " 3095 "%s this filesystem\n"), cmdname, cmdname); 3096 return (1); 3097 } 3098 3099 if (strcmp(mountpoint, "none") == 0) { 3100 if (!explicit) 3101 return (0); 3102 3103 (void) fprintf(stderr, gettext("cannot %s '%s': no " 3104 "mountpoint set\n"), cmdname, zfs_get_name(zhp)); 3105 return (1); 3106 } 3107 3108 /* 3109 * canmount explicit outcome 3110 * on no pass through 3111 * on yes pass through 3112 * off no return 0 3113 * off yes display error, return 1 3114 * noauto no return 0 3115 * noauto yes pass through 3116 */ 3117 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT); 3118 if (canmount == ZFS_CANMOUNT_OFF) { 3119 if (!explicit) 3120 return (0); 3121 3122 (void) fprintf(stderr, gettext("cannot %s '%s': " 3123 "'canmount' property is set to 'off'\n"), cmdname, 3124 zfs_get_name(zhp)); 3125 return (1); 3126 } else if (canmount == ZFS_CANMOUNT_NOAUTO && !explicit) { 3127 return (0); 3128 } 3129 3130 /* 3131 * At this point, we have verified that the mountpoint and/or 3132 * shareopts are appropriate for auto management. If the 3133 * filesystem is already mounted or shared, return (failing 3134 * for explicit requests); otherwise mount or share the 3135 * filesystem. 3136 */ 3137 switch (op) { 3138 case OP_SHARE: 3139 3140 shared_nfs = zfs_is_shared_nfs(zhp, NULL); 3141 shared_smb = zfs_is_shared_smb(zhp, NULL); 3142 3143 if (shared_nfs && shared_smb || 3144 (shared_nfs && strcmp(shareopts, "on") == 0 && 3145 strcmp(smbshareopts, "off") == 0) || 3146 (shared_smb && strcmp(smbshareopts, "on") == 0 && 3147 strcmp(shareopts, "off") == 0)) { 3148 if (!explicit) 3149 return (0); 3150 3151 (void) fprintf(stderr, gettext("cannot share " 3152 "'%s': filesystem already shared\n"), 3153 zfs_get_name(zhp)); 3154 return (1); 3155 } 3156 3157 if (!zfs_is_mounted(zhp, NULL) && 3158 zfs_mount(zhp, NULL, 0) != 0) 3159 return (1); 3160 3161 if (protocol == NULL) { 3162 if (zfs_shareall(zhp) != 0) 3163 return (1); 3164 } else if (strcmp(protocol, "nfs") == 0) { 3165 if (zfs_share_nfs(zhp)) 3166 return (1); 3167 } else if (strcmp(protocol, "smb") == 0) { 3168 if (zfs_share_smb(zhp)) 3169 return (1); 3170 } else { 3171 (void) fprintf(stderr, gettext("cannot share " 3172 "'%s': invalid share type '%s' " 3173 "specified\n"), 3174 zfs_get_name(zhp), protocol); 3175 return (1); 3176 } 3177 3178 break; 3179 3180 case OP_MOUNT: 3181 if (options == NULL) 3182 mnt.mnt_mntopts = ""; 3183 else 3184 mnt.mnt_mntopts = (char *)options; 3185 3186 if (!hasmntopt(&mnt, MNTOPT_REMOUNT) && 3187 zfs_is_mounted(zhp, NULL)) { 3188 if (!explicit) 3189 return (0); 3190 3191 (void) fprintf(stderr, gettext("cannot mount " 3192 "'%s': filesystem already mounted\n"), 3193 zfs_get_name(zhp)); 3194 return (1); 3195 } 3196 3197 if (zfs_mount(zhp, options, flags) != 0) 3198 return (1); 3199 break; 3200 } 3201 } else 3202 assert(op == OP_SHARE); 3203 3204 return (0); 3205 } 3206 3207 /* 3208 * Reports progress in the form "(current/total)". Not thread-safe. 3209 */ 3210 static void 3211 report_mount_progress(int current, int total) 3212 { 3213 static int len; 3214 static char *reverse = "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b" 3215 "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b"; 3216 static time_t last_progress_time; 3217 time_t now = time(NULL); 3218 3219 /* report 1..n instead of 0..n-1 */ 3220 ++current; 3221 3222 /* display header if we're here for the first time */ 3223 if (current == 1) { 3224 (void) printf(gettext("Mounting ZFS filesystems: ")); 3225 len = 0; 3226 } else if (current != total && last_progress_time + MOUNT_TIME >= now) { 3227 /* too soon to report again */ 3228 return; 3229 } 3230 3231 last_progress_time = now; 3232 3233 /* back up to prepare for overwriting */ 3234 if (len) 3235 (void) printf("%*.*s", len, len, reverse); 3236 3237 /* We put a newline at the end if this is the last one. */ 3238 len = printf("(%d/%d)%s", current, total, current == total ? "\n" : ""); 3239 (void) fflush(stdout); 3240 } 3241 3242 static void 3243 append_options(char *mntopts, char *newopts) 3244 { 3245 int len = strlen(mntopts); 3246 3247 /* original length plus new string to append plus 1 for the comma */ 3248 if (len + 1 + strlen(newopts) >= MNT_LINE_MAX) { 3249 (void) fprintf(stderr, gettext("the opts argument for " 3250 "'%c' option is too long (more than %d chars)\n"), 3251 "-o", MNT_LINE_MAX); 3252 usage(B_FALSE); 3253 } 3254 3255 if (*mntopts) 3256 mntopts[len++] = ','; 3257 3258 (void) strcpy(&mntopts[len], newopts); 3259 } 3260 3261 static int 3262 share_mount(int op, int argc, char **argv) 3263 { 3264 int do_all = 0; 3265 boolean_t verbose = B_FALSE; 3266 int c, ret = 0; 3267 char *options = NULL; 3268 int types, flags = 0; 3269 3270 /* check options */ 3271 while ((c = getopt(argc, argv, op == OP_MOUNT ? ":avo:O" : "a")) 3272 != -1) { 3273 switch (c) { 3274 case 'a': 3275 do_all = 1; 3276 break; 3277 case 'v': 3278 verbose = B_TRUE; 3279 break; 3280 case 'o': 3281 if (*optarg == '\0') { 3282 (void) fprintf(stderr, gettext("empty mount " 3283 "options (-o) specified\n")); 3284 usage(B_FALSE); 3285 } 3286 3287 if (options == NULL) 3288 options = safe_malloc(MNT_LINE_MAX + 1); 3289 3290 /* option validation is done later */ 3291 append_options(options, optarg); 3292 break; 3293 3294 case 'O': 3295 flags |= MS_OVERLAY; 3296 break; 3297 case ':': 3298 (void) fprintf(stderr, gettext("missing argument for " 3299 "'%c' option\n"), optopt); 3300 usage(B_FALSE); 3301 break; 3302 case '?': 3303 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3304 optopt); 3305 usage(B_FALSE); 3306 } 3307 } 3308 3309 argc -= optind; 3310 argv += optind; 3311 3312 /* check number of arguments */ 3313 if (do_all) { 3314 zfs_handle_t **dslist = NULL; 3315 size_t i, count = 0; 3316 char *protocol = NULL; 3317 3318 if (op == OP_MOUNT) { 3319 types = ZFS_TYPE_FILESYSTEM; 3320 } else if (argc > 0) { 3321 if (strcmp(argv[0], "nfs") == 0 || 3322 strcmp(argv[0], "smb") == 0) { 3323 types = ZFS_TYPE_FILESYSTEM; 3324 } else { 3325 (void) fprintf(stderr, gettext("share type " 3326 "must be 'nfs' or 'smb'\n")); 3327 usage(B_FALSE); 3328 } 3329 protocol = argv[0]; 3330 argc--; 3331 argv++; 3332 } else { 3333 types = ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME; 3334 } 3335 3336 if (argc != 0) { 3337 (void) fprintf(stderr, gettext("too many arguments\n")); 3338 usage(B_FALSE); 3339 } 3340 3341 get_all_datasets(types, &dslist, &count, verbose); 3342 3343 if (count == 0) 3344 return (0); 3345 3346 qsort(dslist, count, sizeof (void *), dataset_cmp); 3347 3348 for (i = 0; i < count; i++) { 3349 if (verbose) 3350 report_mount_progress(i, count); 3351 3352 if (share_mount_one(dslist[i], op, flags, protocol, 3353 B_FALSE, options) != 0) 3354 ret = 1; 3355 zfs_close(dslist[i]); 3356 } 3357 3358 free(dslist); 3359 } else if (argc == 0) { 3360 struct mnttab entry; 3361 3362 if ((op == OP_SHARE) || (options != NULL)) { 3363 (void) fprintf(stderr, gettext("missing filesystem " 3364 "argument (specify -a for all)\n")); 3365 usage(B_FALSE); 3366 } 3367 3368 /* 3369 * When mount is given no arguments, go through /etc/mnttab and 3370 * display any active ZFS mounts. We hide any snapshots, since 3371 * they are controlled automatically. 3372 */ 3373 rewind(mnttab_file); 3374 while (getmntent(mnttab_file, &entry) == 0) { 3375 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0 || 3376 strchr(entry.mnt_special, '@') != NULL) 3377 continue; 3378 3379 (void) printf("%-30s %s\n", entry.mnt_special, 3380 entry.mnt_mountp); 3381 } 3382 3383 } else { 3384 zfs_handle_t *zhp; 3385 3386 types = ZFS_TYPE_FILESYSTEM; 3387 if (op == OP_SHARE) 3388 types |= ZFS_TYPE_VOLUME; 3389 3390 if (argc > 1) { 3391 (void) fprintf(stderr, 3392 gettext("too many arguments\n")); 3393 usage(B_FALSE); 3394 } 3395 3396 if ((zhp = zfs_open(g_zfs, argv[0], types)) == NULL) { 3397 ret = 1; 3398 } else { 3399 ret = share_mount_one(zhp, op, flags, NULL, B_TRUE, 3400 options); 3401 zfs_close(zhp); 3402 } 3403 } 3404 3405 return (ret); 3406 } 3407 3408 /* 3409 * zfs mount -a [nfs] 3410 * zfs mount filesystem 3411 * 3412 * Mount all filesystems, or mount the given filesystem. 3413 */ 3414 static int 3415 zfs_do_mount(int argc, char **argv) 3416 { 3417 return (share_mount(OP_MOUNT, argc, argv)); 3418 } 3419 3420 /* 3421 * zfs share -a [nfs | smb] 3422 * zfs share filesystem 3423 * 3424 * Share all filesystems, or share the given filesystem. 3425 */ 3426 static int 3427 zfs_do_share(int argc, char **argv) 3428 { 3429 return (share_mount(OP_SHARE, argc, argv)); 3430 } 3431 3432 typedef struct unshare_unmount_node { 3433 zfs_handle_t *un_zhp; 3434 char *un_mountp; 3435 uu_avl_node_t un_avlnode; 3436 } unshare_unmount_node_t; 3437 3438 /* ARGSUSED */ 3439 static int 3440 unshare_unmount_compare(const void *larg, const void *rarg, void *unused) 3441 { 3442 const unshare_unmount_node_t *l = larg; 3443 const unshare_unmount_node_t *r = rarg; 3444 3445 return (strcmp(l->un_mountp, r->un_mountp)); 3446 } 3447 3448 /* 3449 * Convenience routine used by zfs_do_umount() and manual_unmount(). Given an 3450 * absolute path, find the entry /etc/mnttab, verify that its a ZFS filesystem, 3451 * and unmount it appropriately. 3452 */ 3453 static int 3454 unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual) 3455 { 3456 zfs_handle_t *zhp; 3457 int ret; 3458 struct stat64 statbuf; 3459 struct extmnttab entry; 3460 const char *cmdname = (op == OP_SHARE) ? "unshare" : "unmount"; 3461 ino_t path_inode; 3462 3463 /* 3464 * Search for the path in /etc/mnttab. Rather than looking for the 3465 * specific path, which can be fooled by non-standard paths (i.e. ".." 3466 * or "//"), we stat() the path and search for the corresponding 3467 * (major,minor) device pair. 3468 */ 3469 if (stat64(path, &statbuf) != 0) { 3470 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"), 3471 cmdname, path, strerror(errno)); 3472 return (1); 3473 } 3474 path_inode = statbuf.st_ino; 3475 3476 /* 3477 * Search for the given (major,minor) pair in the mount table. 3478 */ 3479 rewind(mnttab_file); 3480 while ((ret = getextmntent(mnttab_file, &entry, 0)) == 0) { 3481 if (entry.mnt_major == major(statbuf.st_dev) && 3482 entry.mnt_minor == minor(statbuf.st_dev)) 3483 break; 3484 } 3485 if (ret != 0) { 3486 if (op == OP_SHARE) { 3487 (void) fprintf(stderr, gettext("cannot %s '%s': not " 3488 "currently mounted\n"), cmdname, path); 3489 return (1); 3490 } 3491 (void) fprintf(stderr, gettext("warning: %s not in mnttab\n"), 3492 path); 3493 if ((ret = umount2(path, flags)) != 0) 3494 (void) fprintf(stderr, gettext("%s: %s\n"), path, 3495 strerror(errno)); 3496 return (ret != 0); 3497 } 3498 3499 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) { 3500 (void) fprintf(stderr, gettext("cannot %s '%s': not a ZFS " 3501 "filesystem\n"), cmdname, path); 3502 return (1); 3503 } 3504 3505 if ((zhp = zfs_open(g_zfs, entry.mnt_special, 3506 ZFS_TYPE_FILESYSTEM)) == NULL) 3507 return (1); 3508 3509 ret = 1; 3510 if (stat64(entry.mnt_mountp, &statbuf) != 0) { 3511 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"), 3512 cmdname, path, strerror(errno)); 3513 goto out; 3514 } else if (statbuf.st_ino != path_inode) { 3515 (void) fprintf(stderr, gettext("cannot " 3516 "%s '%s': not a mountpoint\n"), cmdname, path); 3517 goto out; 3518 } 3519 3520 if (op == OP_SHARE) { 3521 char nfs_mnt_prop[ZFS_MAXPROPLEN]; 3522 char smbshare_prop[ZFS_MAXPROPLEN]; 3523 3524 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, nfs_mnt_prop, 3525 sizeof (nfs_mnt_prop), NULL, NULL, 0, B_FALSE) == 0); 3526 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshare_prop, 3527 sizeof (smbshare_prop), NULL, NULL, 0, B_FALSE) == 0); 3528 3529 if (strcmp(nfs_mnt_prop, "off") == 0 && 3530 strcmp(smbshare_prop, "off") == 0) { 3531 (void) fprintf(stderr, gettext("cannot unshare " 3532 "'%s': legacy share\n"), path); 3533 (void) fprintf(stderr, gettext("use " 3534 "unshare(1M) to unshare this filesystem\n")); 3535 } else if (!zfs_is_shared(zhp)) { 3536 (void) fprintf(stderr, gettext("cannot unshare '%s': " 3537 "not currently shared\n"), path); 3538 } else { 3539 ret = zfs_unshareall_bypath(zhp, path); 3540 } 3541 } else { 3542 char mtpt_prop[ZFS_MAXPROPLEN]; 3543 3544 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mtpt_prop, 3545 sizeof (mtpt_prop), NULL, NULL, 0, B_FALSE) == 0); 3546 3547 if (is_manual) { 3548 ret = zfs_unmount(zhp, NULL, flags); 3549 } else if (strcmp(mtpt_prop, "legacy") == 0) { 3550 (void) fprintf(stderr, gettext("cannot unmount " 3551 "'%s': legacy mountpoint\n"), 3552 zfs_get_name(zhp)); 3553 (void) fprintf(stderr, gettext("use umount(1M) " 3554 "to unmount this filesystem\n")); 3555 } else { 3556 ret = zfs_unmountall(zhp, flags); 3557 } 3558 } 3559 3560 out: 3561 zfs_close(zhp); 3562 3563 return (ret != 0); 3564 } 3565 3566 /* 3567 * Generic callback for unsharing or unmounting a filesystem. 3568 */ 3569 static int 3570 unshare_unmount(int op, int argc, char **argv) 3571 { 3572 int do_all = 0; 3573 int flags = 0; 3574 int ret = 0; 3575 int types, c; 3576 zfs_handle_t *zhp; 3577 char nfs_mnt_prop[ZFS_MAXPROPLEN]; 3578 char sharesmb[ZFS_MAXPROPLEN]; 3579 3580 /* check options */ 3581 while ((c = getopt(argc, argv, op == OP_SHARE ? "a" : "af")) != -1) { 3582 switch (c) { 3583 case 'a': 3584 do_all = 1; 3585 break; 3586 case 'f': 3587 flags = MS_FORCE; 3588 break; 3589 case '?': 3590 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3591 optopt); 3592 usage(B_FALSE); 3593 } 3594 } 3595 3596 argc -= optind; 3597 argv += optind; 3598 3599 if (do_all) { 3600 /* 3601 * We could make use of zfs_for_each() to walk all datasets in 3602 * the system, but this would be very inefficient, especially 3603 * since we would have to linearly search /etc/mnttab for each 3604 * one. Instead, do one pass through /etc/mnttab looking for 3605 * zfs entries and call zfs_unmount() for each one. 3606 * 3607 * Things get a little tricky if the administrator has created 3608 * mountpoints beneath other ZFS filesystems. In this case, we 3609 * have to unmount the deepest filesystems first. To accomplish 3610 * this, we place all the mountpoints in an AVL tree sorted by 3611 * the special type (dataset name), and walk the result in 3612 * reverse to make sure to get any snapshots first. 3613 */ 3614 struct mnttab entry; 3615 uu_avl_pool_t *pool; 3616 uu_avl_t *tree; 3617 unshare_unmount_node_t *node; 3618 uu_avl_index_t idx; 3619 uu_avl_walk_t *walk; 3620 3621 if (argc != 0) { 3622 (void) fprintf(stderr, gettext("too many arguments\n")); 3623 usage(B_FALSE); 3624 } 3625 3626 if ((pool = uu_avl_pool_create("unmount_pool", 3627 sizeof (unshare_unmount_node_t), 3628 offsetof(unshare_unmount_node_t, un_avlnode), 3629 unshare_unmount_compare, 3630 UU_DEFAULT)) == NULL) { 3631 (void) fprintf(stderr, gettext("internal error: " 3632 "out of memory\n")); 3633 exit(1); 3634 } 3635 3636 if ((tree = uu_avl_create(pool, NULL, UU_DEFAULT)) == NULL) { 3637 (void) fprintf(stderr, gettext("internal error: " 3638 "out of memory\n")); 3639 exit(1); 3640 } 3641 3642 rewind(mnttab_file); 3643 while (getmntent(mnttab_file, &entry) == 0) { 3644 3645 /* ignore non-ZFS entries */ 3646 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) 3647 continue; 3648 3649 /* ignore snapshots */ 3650 if (strchr(entry.mnt_special, '@') != NULL) 3651 continue; 3652 3653 if ((zhp = zfs_open(g_zfs, entry.mnt_special, 3654 ZFS_TYPE_FILESYSTEM)) == NULL) { 3655 ret = 1; 3656 continue; 3657 } 3658 3659 switch (op) { 3660 case OP_SHARE: 3661 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, 3662 nfs_mnt_prop, 3663 sizeof (nfs_mnt_prop), 3664 NULL, NULL, 0, B_FALSE) == 0); 3665 if (strcmp(nfs_mnt_prop, "off") != 0) 3666 break; 3667 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, 3668 nfs_mnt_prop, 3669 sizeof (nfs_mnt_prop), 3670 NULL, NULL, 0, B_FALSE) == 0); 3671 if (strcmp(nfs_mnt_prop, "off") == 0) 3672 continue; 3673 break; 3674 case OP_MOUNT: 3675 /* Ignore legacy mounts */ 3676 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, 3677 nfs_mnt_prop, 3678 sizeof (nfs_mnt_prop), 3679 NULL, NULL, 0, B_FALSE) == 0); 3680 if (strcmp(nfs_mnt_prop, "legacy") == 0) 3681 continue; 3682 /* Ignore canmount=noauto mounts */ 3683 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == 3684 ZFS_CANMOUNT_NOAUTO) 3685 continue; 3686 default: 3687 break; 3688 } 3689 3690 node = safe_malloc(sizeof (unshare_unmount_node_t)); 3691 node->un_zhp = zhp; 3692 3693 if ((node->un_mountp = strdup(entry.mnt_mountp)) == 3694 NULL) { 3695 (void) fprintf(stderr, gettext("internal error:" 3696 " out of memory\n")); 3697 exit(1); 3698 } 3699 3700 uu_avl_node_init(node, &node->un_avlnode, pool); 3701 3702 if (uu_avl_find(tree, node, NULL, &idx) == NULL) { 3703 uu_avl_insert(tree, node, idx); 3704 } else { 3705 zfs_close(node->un_zhp); 3706 free(node->un_mountp); 3707 free(node); 3708 } 3709 } 3710 3711 /* 3712 * Walk the AVL tree in reverse, unmounting each filesystem and 3713 * removing it from the AVL tree in the process. 3714 */ 3715 if ((walk = uu_avl_walk_start(tree, 3716 UU_WALK_REVERSE | UU_WALK_ROBUST)) == NULL) { 3717 (void) fprintf(stderr, 3718 gettext("internal error: out of memory")); 3719 exit(1); 3720 } 3721 3722 while ((node = uu_avl_walk_next(walk)) != NULL) { 3723 uu_avl_remove(tree, node); 3724 3725 switch (op) { 3726 case OP_SHARE: 3727 if (zfs_unshareall_bypath(node->un_zhp, 3728 node->un_mountp) != 0) 3729 ret = 1; 3730 break; 3731 3732 case OP_MOUNT: 3733 if (zfs_unmount(node->un_zhp, 3734 node->un_mountp, flags) != 0) 3735 ret = 1; 3736 break; 3737 } 3738 3739 zfs_close(node->un_zhp); 3740 free(node->un_mountp); 3741 free(node); 3742 } 3743 3744 uu_avl_walk_end(walk); 3745 uu_avl_destroy(tree); 3746 uu_avl_pool_destroy(pool); 3747 3748 } else { 3749 if (argc != 1) { 3750 if (argc == 0) 3751 (void) fprintf(stderr, 3752 gettext("missing filesystem argument\n")); 3753 else 3754 (void) fprintf(stderr, 3755 gettext("too many arguments\n")); 3756 usage(B_FALSE); 3757 } 3758 3759 /* 3760 * We have an argument, but it may be a full path or a ZFS 3761 * filesystem. Pass full paths off to unmount_path() (shared by 3762 * manual_unmount), otherwise open the filesystem and pass to 3763 * zfs_unmount(). 3764 */ 3765 if (argv[0][0] == '/') 3766 return (unshare_unmount_path(op, argv[0], 3767 flags, B_FALSE)); 3768 3769 types = ZFS_TYPE_FILESYSTEM; 3770 if (op == OP_SHARE) 3771 types |= ZFS_TYPE_VOLUME; 3772 3773 if ((zhp = zfs_open(g_zfs, argv[0], types)) == NULL) 3774 return (1); 3775 3776 if (zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) { 3777 verify(zfs_prop_get(zhp, op == OP_SHARE ? 3778 ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT, 3779 nfs_mnt_prop, sizeof (nfs_mnt_prop), NULL, 3780 NULL, 0, B_FALSE) == 0); 3781 3782 switch (op) { 3783 case OP_SHARE: 3784 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, 3785 nfs_mnt_prop, 3786 sizeof (nfs_mnt_prop), 3787 NULL, NULL, 0, B_FALSE) == 0); 3788 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, 3789 sharesmb, sizeof (sharesmb), NULL, NULL, 3790 0, B_FALSE) == 0); 3791 3792 if (strcmp(nfs_mnt_prop, "off") == 0 && 3793 strcmp(sharesmb, "off") == 0) { 3794 (void) fprintf(stderr, gettext("cannot " 3795 "unshare '%s': legacy share\n"), 3796 zfs_get_name(zhp)); 3797 (void) fprintf(stderr, gettext("use " 3798 "unshare(1M) to unshare this " 3799 "filesystem\n")); 3800 ret = 1; 3801 } else if (!zfs_is_shared(zhp)) { 3802 (void) fprintf(stderr, gettext("cannot " 3803 "unshare '%s': not currently " 3804 "shared\n"), zfs_get_name(zhp)); 3805 ret = 1; 3806 } else if (zfs_unshareall(zhp) != 0) { 3807 ret = 1; 3808 } 3809 break; 3810 3811 case OP_MOUNT: 3812 if (strcmp(nfs_mnt_prop, "legacy") == 0) { 3813 (void) fprintf(stderr, gettext("cannot " 3814 "unmount '%s': legacy " 3815 "mountpoint\n"), zfs_get_name(zhp)); 3816 (void) fprintf(stderr, gettext("use " 3817 "umount(1M) to unmount this " 3818 "filesystem\n")); 3819 ret = 1; 3820 } else if (!zfs_is_mounted(zhp, NULL)) { 3821 (void) fprintf(stderr, gettext("cannot " 3822 "unmount '%s': not currently " 3823 "mounted\n"), 3824 zfs_get_name(zhp)); 3825 ret = 1; 3826 } else if (zfs_unmountall(zhp, flags) != 0) { 3827 ret = 1; 3828 } 3829 break; 3830 } 3831 } 3832 3833 zfs_close(zhp); 3834 } 3835 3836 return (ret); 3837 } 3838 3839 /* 3840 * zfs unmount -a 3841 * zfs unmount filesystem 3842 * 3843 * Unmount all filesystems, or a specific ZFS filesystem. 3844 */ 3845 static int 3846 zfs_do_unmount(int argc, char **argv) 3847 { 3848 return (unshare_unmount(OP_MOUNT, argc, argv)); 3849 } 3850 3851 /* 3852 * zfs unshare -a 3853 * zfs unshare filesystem 3854 * 3855 * Unshare all filesystems, or a specific ZFS filesystem. 3856 */ 3857 static int 3858 zfs_do_unshare(int argc, char **argv) 3859 { 3860 return (unshare_unmount(OP_SHARE, argc, argv)); 3861 } 3862 3863 /* ARGSUSED */ 3864 static int 3865 zfs_do_python(int argc, char **argv) 3866 { 3867 (void) execv(pypath, argv-1); 3868 (void) printf("internal error: %s not found\n", pypath); 3869 return (-1); 3870 } 3871 3872 /* 3873 * Called when invoked as /etc/fs/zfs/mount. Do the mount if the mountpoint is 3874 * 'legacy'. Otherwise, complain that use should be using 'zfs mount'. 3875 */ 3876 static int 3877 manual_mount(int argc, char **argv) 3878 { 3879 zfs_handle_t *zhp; 3880 char mountpoint[ZFS_MAXPROPLEN]; 3881 char mntopts[MNT_LINE_MAX] = { '\0' }; 3882 int ret; 3883 int c; 3884 int flags = 0; 3885 char *dataset, *path; 3886 3887 /* check options */ 3888 while ((c = getopt(argc, argv, ":mo:O")) != -1) { 3889 switch (c) { 3890 case 'o': 3891 (void) strlcpy(mntopts, optarg, sizeof (mntopts)); 3892 break; 3893 case 'O': 3894 flags |= MS_OVERLAY; 3895 break; 3896 case 'm': 3897 flags |= MS_NOMNTTAB; 3898 break; 3899 case ':': 3900 (void) fprintf(stderr, gettext("missing argument for " 3901 "'%c' option\n"), optopt); 3902 usage(B_FALSE); 3903 break; 3904 case '?': 3905 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3906 optopt); 3907 (void) fprintf(stderr, gettext("usage: mount [-o opts] " 3908 "<path>\n")); 3909 return (2); 3910 } 3911 } 3912 3913 argc -= optind; 3914 argv += optind; 3915 3916 /* check that we only have two arguments */ 3917 if (argc != 2) { 3918 if (argc == 0) 3919 (void) fprintf(stderr, gettext("missing dataset " 3920 "argument\n")); 3921 else if (argc == 1) 3922 (void) fprintf(stderr, 3923 gettext("missing mountpoint argument\n")); 3924 else 3925 (void) fprintf(stderr, gettext("too many arguments\n")); 3926 (void) fprintf(stderr, "usage: mount <dataset> <mountpoint>\n"); 3927 return (2); 3928 } 3929 3930 dataset = argv[0]; 3931 path = argv[1]; 3932 3933 /* try to open the dataset */ 3934 if ((zhp = zfs_open(g_zfs, dataset, ZFS_TYPE_FILESYSTEM)) == NULL) 3935 return (1); 3936 3937 (void) zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint, 3938 sizeof (mountpoint), NULL, NULL, 0, B_FALSE); 3939 3940 /* check for legacy mountpoint and complain appropriately */ 3941 ret = 0; 3942 if (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) == 0) { 3943 if (mount(dataset, path, MS_OPTIONSTR | flags, MNTTYPE_ZFS, 3944 NULL, 0, mntopts, sizeof (mntopts)) != 0) { 3945 (void) fprintf(stderr, gettext("mount failed: %s\n"), 3946 strerror(errno)); 3947 ret = 1; 3948 } 3949 } else { 3950 (void) fprintf(stderr, gettext("filesystem '%s' cannot be " 3951 "mounted using 'mount -F zfs'\n"), dataset); 3952 (void) fprintf(stderr, gettext("Use 'zfs set mountpoint=%s' " 3953 "instead.\n"), path); 3954 (void) fprintf(stderr, gettext("If you must use 'mount -F zfs' " 3955 "or /etc/vfstab, use 'zfs set mountpoint=legacy'.\n")); 3956 (void) fprintf(stderr, gettext("See zfs(1M) for more " 3957 "information.\n")); 3958 ret = 1; 3959 } 3960 3961 return (ret); 3962 } 3963 3964 /* 3965 * Called when invoked as /etc/fs/zfs/umount. Unlike a manual mount, we allow 3966 * unmounts of non-legacy filesystems, as this is the dominant administrative 3967 * interface. 3968 */ 3969 static int 3970 manual_unmount(int argc, char **argv) 3971 { 3972 int flags = 0; 3973 int c; 3974 3975 /* check options */ 3976 while ((c = getopt(argc, argv, "f")) != -1) { 3977 switch (c) { 3978 case 'f': 3979 flags = MS_FORCE; 3980 break; 3981 case '?': 3982 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3983 optopt); 3984 (void) fprintf(stderr, gettext("usage: unmount [-f] " 3985 "<path>\n")); 3986 return (2); 3987 } 3988 } 3989 3990 argc -= optind; 3991 argv += optind; 3992 3993 /* check arguments */ 3994 if (argc != 1) { 3995 if (argc == 0) 3996 (void) fprintf(stderr, gettext("missing path " 3997 "argument\n")); 3998 else 3999 (void) fprintf(stderr, gettext("too many arguments\n")); 4000 (void) fprintf(stderr, gettext("usage: unmount [-f] <path>\n")); 4001 return (2); 4002 } 4003 4004 return (unshare_unmount_path(OP_MOUNT, argv[0], flags, B_TRUE)); 4005 } 4006 4007 static int 4008 find_command_idx(char *command, int *idx) 4009 { 4010 int i; 4011 4012 for (i = 0; i < NCOMMAND; i++) { 4013 if (command_table[i].name == NULL) 4014 continue; 4015 4016 if (strcmp(command, command_table[i].name) == 0) { 4017 *idx = i; 4018 return (0); 4019 } 4020 } 4021 return (1); 4022 } 4023 4024 int 4025 main(int argc, char **argv) 4026 { 4027 int ret; 4028 int i; 4029 char *progname; 4030 char *cmdname; 4031 4032 (void) setlocale(LC_ALL, ""); 4033 (void) textdomain(TEXT_DOMAIN); 4034 4035 opterr = 0; 4036 4037 if ((g_zfs = libzfs_init()) == NULL) { 4038 (void) fprintf(stderr, gettext("internal error: failed to " 4039 "initialize ZFS library\n")); 4040 return (1); 4041 } 4042 4043 zpool_set_history_str("zfs", argc, argv, history_str); 4044 verify(zpool_stage_history(g_zfs, history_str) == 0); 4045 4046 libzfs_print_on_error(g_zfs, B_TRUE); 4047 4048 if ((mnttab_file = fopen(MNTTAB, "r")) == NULL) { 4049 (void) fprintf(stderr, gettext("internal error: unable to " 4050 "open %s\n"), MNTTAB); 4051 return (1); 4052 } 4053 4054 /* 4055 * This command also doubles as the /etc/fs mount and unmount program. 4056 * Determine if we should take this behavior based on argv[0]. 4057 */ 4058 progname = basename(argv[0]); 4059 if (strcmp(progname, "mount") == 0) { 4060 ret = manual_mount(argc, argv); 4061 } else if (strcmp(progname, "umount") == 0) { 4062 ret = manual_unmount(argc, argv); 4063 } else { 4064 /* 4065 * Make sure the user has specified some command. 4066 */ 4067 if (argc < 2) { 4068 (void) fprintf(stderr, gettext("missing command\n")); 4069 usage(B_FALSE); 4070 } 4071 4072 cmdname = argv[1]; 4073 4074 /* 4075 * The 'umount' command is an alias for 'unmount' 4076 */ 4077 if (strcmp(cmdname, "umount") == 0) 4078 cmdname = "unmount"; 4079 4080 /* 4081 * The 'recv' command is an alias for 'receive' 4082 */ 4083 if (strcmp(cmdname, "recv") == 0) 4084 cmdname = "receive"; 4085 4086 /* 4087 * Special case '-?' 4088 */ 4089 if (strcmp(cmdname, "-?") == 0) 4090 usage(B_TRUE); 4091 4092 /* 4093 * Run the appropriate command. 4094 */ 4095 libzfs_mnttab_cache(g_zfs, B_TRUE); 4096 if (find_command_idx(cmdname, &i) == 0) { 4097 current_command = &command_table[i]; 4098 ret = command_table[i].func(argc - 1, argv + 1); 4099 } else if (strchr(cmdname, '=') != NULL) { 4100 verify(find_command_idx("set", &i) == 0); 4101 current_command = &command_table[i]; 4102 ret = command_table[i].func(argc, argv); 4103 } else { 4104 (void) fprintf(stderr, gettext("unrecognized " 4105 "command '%s'\n"), cmdname); 4106 usage(B_FALSE); 4107 } 4108 libzfs_mnttab_cache(g_zfs, B_FALSE); 4109 } 4110 4111 (void) fclose(mnttab_file); 4112 4113 libzfs_fini(g_zfs); 4114 4115 /* 4116 * The 'ZFS_ABORT' environment variable causes us to dump core on exit 4117 * for the purposes of running ::findleaks. 4118 */ 4119 if (getenv("ZFS_ABORT") != NULL) { 4120 (void) printf("dumping core by request\n"); 4121 abort(); 4122 } 4123 4124 return (ret); 4125 } 4126