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 * Copyright 2012 Nexenta Systems, Inc. All rights reserved. 25 * Copyright (c) 2012 by Delphix. All rights reserved. 26 * Copyright 2012 Milan Jurik. All rights reserved. 27 * Copyright (c) 2012, Joyent, Inc. All rights reserved. 28 */ 29 30 #include <assert.h> 31 #include <ctype.h> 32 #include <errno.h> 33 #include <libgen.h> 34 #include <libintl.h> 35 #include <libuutil.h> 36 #include <libnvpair.h> 37 #include <locale.h> 38 #include <stddef.h> 39 #include <stdio.h> 40 #include <stdlib.h> 41 #include <strings.h> 42 #include <unistd.h> 43 #include <fcntl.h> 44 #include <zone.h> 45 #include <grp.h> 46 #include <pwd.h> 47 #include <signal.h> 48 #include <sys/list.h> 49 #include <sys/mkdev.h> 50 #include <sys/mntent.h> 51 #include <sys/mnttab.h> 52 #include <sys/mount.h> 53 #include <sys/stat.h> 54 #include <sys/fs/zfs.h> 55 #include <sys/types.h> 56 #include <time.h> 57 58 #include <libzfs.h> 59 #include <libzfs_core.h> 60 #include <zfs_prop.h> 61 #include <zfs_deleg.h> 62 #include <libuutil.h> 63 #include <aclutils.h> 64 #include <directory.h> 65 66 #include "zfs_iter.h" 67 #include "zfs_util.h" 68 #include "zfs_comutil.h" 69 70 libzfs_handle_t *g_zfs; 71 72 static FILE *mnttab_file; 73 static char history_str[HIS_MAX_RECORD_LEN]; 74 static boolean_t log_history = B_TRUE; 75 76 static int zfs_do_clone(int argc, char **argv); 77 static int zfs_do_create(int argc, char **argv); 78 static int zfs_do_destroy(int argc, char **argv); 79 static int zfs_do_get(int argc, char **argv); 80 static int zfs_do_inherit(int argc, char **argv); 81 static int zfs_do_list(int argc, char **argv); 82 static int zfs_do_mount(int argc, char **argv); 83 static int zfs_do_rename(int argc, char **argv); 84 static int zfs_do_rollback(int argc, char **argv); 85 static int zfs_do_set(int argc, char **argv); 86 static int zfs_do_upgrade(int argc, char **argv); 87 static int zfs_do_snapshot(int argc, char **argv); 88 static int zfs_do_unmount(int argc, char **argv); 89 static int zfs_do_share(int argc, char **argv); 90 static int zfs_do_unshare(int argc, char **argv); 91 static int zfs_do_send(int argc, char **argv); 92 static int zfs_do_receive(int argc, char **argv); 93 static int zfs_do_promote(int argc, char **argv); 94 static int zfs_do_userspace(int argc, char **argv); 95 static int zfs_do_allow(int argc, char **argv); 96 static int zfs_do_unallow(int argc, char **argv); 97 static int zfs_do_hold(int argc, char **argv); 98 static int zfs_do_holds(int argc, char **argv); 99 static int zfs_do_release(int argc, char **argv); 100 static int zfs_do_diff(int argc, char **argv); 101 102 /* 103 * Enable a reasonable set of defaults for libumem debugging on DEBUG builds. 104 */ 105 106 #ifdef DEBUG 107 const char * 108 _umem_debug_init(void) 109 { 110 return ("default,verbose"); /* $UMEM_DEBUG setting */ 111 } 112 113 const char * 114 _umem_logging_init(void) 115 { 116 return ("fail,contents"); /* $UMEM_LOGGING setting */ 117 } 118 #endif 119 120 typedef enum { 121 HELP_CLONE, 122 HELP_CREATE, 123 HELP_DESTROY, 124 HELP_GET, 125 HELP_INHERIT, 126 HELP_UPGRADE, 127 HELP_LIST, 128 HELP_MOUNT, 129 HELP_PROMOTE, 130 HELP_RECEIVE, 131 HELP_RENAME, 132 HELP_ROLLBACK, 133 HELP_SEND, 134 HELP_SET, 135 HELP_SHARE, 136 HELP_SNAPSHOT, 137 HELP_UNMOUNT, 138 HELP_UNSHARE, 139 HELP_ALLOW, 140 HELP_UNALLOW, 141 HELP_USERSPACE, 142 HELP_GROUPSPACE, 143 HELP_HOLD, 144 HELP_HOLDS, 145 HELP_RELEASE, 146 HELP_DIFF, 147 } zfs_help_t; 148 149 typedef struct zfs_command { 150 const char *name; 151 int (*func)(int argc, char **argv); 152 zfs_help_t usage; 153 } zfs_command_t; 154 155 /* 156 * Master command table. Each ZFS command has a name, associated function, and 157 * usage message. The usage messages need to be internationalized, so we have 158 * to have a function to return the usage message based on a command index. 159 * 160 * These commands are organized according to how they are displayed in the usage 161 * message. An empty command (one with a NULL name) indicates an empty line in 162 * the generic usage message. 163 */ 164 static zfs_command_t command_table[] = { 165 { "create", zfs_do_create, HELP_CREATE }, 166 { "destroy", zfs_do_destroy, HELP_DESTROY }, 167 { NULL }, 168 { "snapshot", zfs_do_snapshot, HELP_SNAPSHOT }, 169 { "rollback", zfs_do_rollback, HELP_ROLLBACK }, 170 { "clone", zfs_do_clone, HELP_CLONE }, 171 { "promote", zfs_do_promote, HELP_PROMOTE }, 172 { "rename", zfs_do_rename, HELP_RENAME }, 173 { NULL }, 174 { "list", zfs_do_list, HELP_LIST }, 175 { NULL }, 176 { "set", zfs_do_set, HELP_SET }, 177 { "get", zfs_do_get, HELP_GET }, 178 { "inherit", zfs_do_inherit, HELP_INHERIT }, 179 { "upgrade", zfs_do_upgrade, HELP_UPGRADE }, 180 { "userspace", zfs_do_userspace, HELP_USERSPACE }, 181 { "groupspace", zfs_do_userspace, HELP_GROUPSPACE }, 182 { NULL }, 183 { "mount", zfs_do_mount, HELP_MOUNT }, 184 { "unmount", zfs_do_unmount, HELP_UNMOUNT }, 185 { "share", zfs_do_share, HELP_SHARE }, 186 { "unshare", zfs_do_unshare, HELP_UNSHARE }, 187 { NULL }, 188 { "send", zfs_do_send, HELP_SEND }, 189 { "receive", zfs_do_receive, HELP_RECEIVE }, 190 { NULL }, 191 { "allow", zfs_do_allow, HELP_ALLOW }, 192 { NULL }, 193 { "unallow", zfs_do_unallow, HELP_UNALLOW }, 194 { NULL }, 195 { "hold", zfs_do_hold, HELP_HOLD }, 196 { "holds", zfs_do_holds, HELP_HOLDS }, 197 { "release", zfs_do_release, HELP_RELEASE }, 198 { "diff", zfs_do_diff, HELP_DIFF }, 199 }; 200 201 #define NCOMMAND (sizeof (command_table) / sizeof (command_table[0])) 202 203 zfs_command_t *current_command; 204 205 static const char * 206 get_usage(zfs_help_t idx) 207 { 208 switch (idx) { 209 case HELP_CLONE: 210 return (gettext("\tclone [-p] [-o property=value] ... " 211 "<snapshot> <filesystem|volume>\n")); 212 case HELP_CREATE: 213 return (gettext("\tcreate [-p] [-o property=value] ... " 214 "<filesystem>\n" 215 "\tcreate [-ps] [-b blocksize] [-o property=value] ... " 216 "-V <size> <volume>\n")); 217 case HELP_DESTROY: 218 return (gettext("\tdestroy [-fnpRrv] <filesystem|volume>\n" 219 "\tdestroy [-dnpRrv] " 220 "<filesystem|volume>@<snap>[%<snap>][,...]\n")); 221 case HELP_GET: 222 return (gettext("\tget [-rHp] [-d max] " 223 "[-o \"all\" | field[,...]] [-t type[,...]] " 224 "[-s source[,...]]\n" 225 "\t <\"all\" | property[,...]> " 226 "[filesystem|volume|snapshot] ...\n")); 227 case HELP_INHERIT: 228 return (gettext("\tinherit [-rS] <property> " 229 "<filesystem|volume|snapshot> ...\n")); 230 case HELP_UPGRADE: 231 return (gettext("\tupgrade [-v]\n" 232 "\tupgrade [-r] [-V version] <-a | filesystem ...>\n")); 233 case HELP_LIST: 234 return (gettext("\tlist [-rH][-d max] " 235 "[-o property[,...]] [-t type[,...]] [-s property] ...\n" 236 "\t [-S property] ... " 237 "[filesystem|volume|snapshot] ...\n")); 238 case HELP_MOUNT: 239 return (gettext("\tmount\n" 240 "\tmount [-vO] [-o opts] <-a | filesystem>\n")); 241 case HELP_PROMOTE: 242 return (gettext("\tpromote <clone-filesystem>\n")); 243 case HELP_RECEIVE: 244 return (gettext("\treceive [-vnFu] <filesystem|volume|" 245 "snapshot>\n" 246 "\treceive [-vnFu] [-d | -e] <filesystem>\n")); 247 case HELP_RENAME: 248 return (gettext("\trename [-f] <filesystem|volume|snapshot> " 249 "<filesystem|volume|snapshot>\n" 250 "\trename [-f] -p <filesystem|volume> <filesystem|volume>\n" 251 "\trename -r <snapshot> <snapshot>")); 252 case HELP_ROLLBACK: 253 return (gettext("\trollback [-rRf] <snapshot>\n")); 254 case HELP_SEND: 255 return (gettext("\tsend [-DnPpRv] [-[iI] snapshot] " 256 "<snapshot>\n")); 257 case HELP_SET: 258 return (gettext("\tset <property=value> " 259 "<filesystem|volume|snapshot> ...\n")); 260 case HELP_SHARE: 261 return (gettext("\tshare <-a | filesystem>\n")); 262 case HELP_SNAPSHOT: 263 return (gettext("\tsnapshot [-r] [-o property=value] ... " 264 "<filesystem@snapname|volume@snapname> ...\n")); 265 case HELP_UNMOUNT: 266 return (gettext("\tunmount [-f] " 267 "<-a | filesystem|mountpoint>\n")); 268 case HELP_UNSHARE: 269 return (gettext("\tunshare " 270 "<-a | filesystem|mountpoint>\n")); 271 case HELP_ALLOW: 272 return (gettext("\tallow <filesystem|volume>\n" 273 "\tallow [-ldug] " 274 "<\"everyone\"|user|group>[,...] <perm|@setname>[,...]\n" 275 "\t <filesystem|volume>\n" 276 "\tallow [-ld] -e <perm|@setname>[,...] " 277 "<filesystem|volume>\n" 278 "\tallow -c <perm|@setname>[,...] <filesystem|volume>\n" 279 "\tallow -s @setname <perm|@setname>[,...] " 280 "<filesystem|volume>\n")); 281 case HELP_UNALLOW: 282 return (gettext("\tunallow [-rldug] " 283 "<\"everyone\"|user|group>[,...]\n" 284 "\t [<perm|@setname>[,...]] <filesystem|volume>\n" 285 "\tunallow [-rld] -e [<perm|@setname>[,...]] " 286 "<filesystem|volume>\n" 287 "\tunallow [-r] -c [<perm|@setname>[,...]] " 288 "<filesystem|volume>\n" 289 "\tunallow [-r] -s @setname [<perm|@setname>[,...]] " 290 "<filesystem|volume>\n")); 291 case HELP_USERSPACE: 292 return (gettext("\tuserspace [-Hinp] [-o field[,...]] " 293 "[-s field] ...\n\t[-S field] ... " 294 "[-t type[,...]] <filesystem|snapshot>\n")); 295 case HELP_GROUPSPACE: 296 return (gettext("\tgroupspace [-Hinp] [-o field[,...]] " 297 "[-s field] ...\n\t[-S field] ... " 298 "[-t type[,...]] <filesystem|snapshot>\n")); 299 case HELP_HOLD: 300 return (gettext("\thold [-r] <tag> <snapshot> ...\n")); 301 case HELP_HOLDS: 302 return (gettext("\tholds [-r] <snapshot> ...\n")); 303 case HELP_RELEASE: 304 return (gettext("\trelease [-r] <tag> <snapshot> ...\n")); 305 case HELP_DIFF: 306 return (gettext("\tdiff [-FHt] <snapshot> " 307 "[snapshot|filesystem]\n")); 308 } 309 310 abort(); 311 /* NOTREACHED */ 312 } 313 314 void 315 nomem(void) 316 { 317 (void) fprintf(stderr, gettext("internal error: out of memory\n")); 318 exit(1); 319 } 320 321 /* 322 * Utility function to guarantee malloc() success. 323 */ 324 325 void * 326 safe_malloc(size_t size) 327 { 328 void *data; 329 330 if ((data = calloc(1, size)) == NULL) 331 nomem(); 332 333 return (data); 334 } 335 336 static char * 337 safe_strdup(char *str) 338 { 339 char *dupstr = strdup(str); 340 341 if (dupstr == NULL) 342 nomem(); 343 344 return (dupstr); 345 } 346 347 /* 348 * Callback routine that will print out information for each of 349 * the properties. 350 */ 351 static int 352 usage_prop_cb(int prop, void *cb) 353 { 354 FILE *fp = cb; 355 356 (void) fprintf(fp, "\t%-15s ", zfs_prop_to_name(prop)); 357 358 if (zfs_prop_readonly(prop)) 359 (void) fprintf(fp, " NO "); 360 else 361 (void) fprintf(fp, "YES "); 362 363 if (zfs_prop_inheritable(prop)) 364 (void) fprintf(fp, " YES "); 365 else 366 (void) fprintf(fp, " NO "); 367 368 if (zfs_prop_values(prop) == NULL) 369 (void) fprintf(fp, "-\n"); 370 else 371 (void) fprintf(fp, "%s\n", zfs_prop_values(prop)); 372 373 return (ZPROP_CONT); 374 } 375 376 /* 377 * Display usage message. If we're inside a command, display only the usage for 378 * that command. Otherwise, iterate over the entire command table and display 379 * a complete usage message. 380 */ 381 static void 382 usage(boolean_t requested) 383 { 384 int i; 385 boolean_t show_properties = B_FALSE; 386 FILE *fp = requested ? stdout : stderr; 387 388 if (current_command == NULL) { 389 390 (void) fprintf(fp, gettext("usage: zfs command args ...\n")); 391 (void) fprintf(fp, 392 gettext("where 'command' is one of the following:\n\n")); 393 394 for (i = 0; i < NCOMMAND; i++) { 395 if (command_table[i].name == NULL) 396 (void) fprintf(fp, "\n"); 397 else 398 (void) fprintf(fp, "%s", 399 get_usage(command_table[i].usage)); 400 } 401 402 (void) fprintf(fp, gettext("\nEach dataset is of the form: " 403 "pool/[dataset/]*dataset[@name]\n")); 404 } else { 405 (void) fprintf(fp, gettext("usage:\n")); 406 (void) fprintf(fp, "%s", get_usage(current_command->usage)); 407 } 408 409 if (current_command != NULL && 410 (strcmp(current_command->name, "set") == 0 || 411 strcmp(current_command->name, "get") == 0 || 412 strcmp(current_command->name, "inherit") == 0 || 413 strcmp(current_command->name, "list") == 0)) 414 show_properties = B_TRUE; 415 416 if (show_properties) { 417 (void) fprintf(fp, 418 gettext("\nThe following properties are supported:\n")); 419 420 (void) fprintf(fp, "\n\t%-14s %s %s %s\n\n", 421 "PROPERTY", "EDIT", "INHERIT", "VALUES"); 422 423 /* Iterate over all properties */ 424 (void) zprop_iter(usage_prop_cb, fp, B_FALSE, B_TRUE, 425 ZFS_TYPE_DATASET); 426 427 (void) fprintf(fp, "\t%-15s ", "userused@..."); 428 (void) fprintf(fp, " NO NO <size>\n"); 429 (void) fprintf(fp, "\t%-15s ", "groupused@..."); 430 (void) fprintf(fp, " NO NO <size>\n"); 431 (void) fprintf(fp, "\t%-15s ", "userquota@..."); 432 (void) fprintf(fp, "YES NO <size> | none\n"); 433 (void) fprintf(fp, "\t%-15s ", "groupquota@..."); 434 (void) fprintf(fp, "YES NO <size> | none\n"); 435 (void) fprintf(fp, "\t%-15s ", "written@<snap>"); 436 (void) fprintf(fp, " NO NO <size>\n"); 437 438 (void) fprintf(fp, gettext("\nSizes are specified in bytes " 439 "with standard units such as K, M, G, etc.\n")); 440 (void) fprintf(fp, gettext("\nUser-defined properties can " 441 "be specified by using a name containing a colon (:).\n")); 442 (void) fprintf(fp, gettext("\nThe {user|group}{used|quota}@ " 443 "properties must be appended with\n" 444 "a user or group specifier of one of these forms:\n" 445 " POSIX name (eg: \"matt\")\n" 446 " POSIX id (eg: \"126829\")\n" 447 " SMB name@domain (eg: \"matt@sun\")\n" 448 " SMB SID (eg: \"S-1-234-567-89\")\n")); 449 } else { 450 (void) fprintf(fp, 451 gettext("\nFor the property list, run: %s\n"), 452 "zfs set|get"); 453 (void) fprintf(fp, 454 gettext("\nFor the delegated permission list, run: %s\n"), 455 "zfs allow|unallow"); 456 } 457 458 /* 459 * See comments at end of main(). 460 */ 461 if (getenv("ZFS_ABORT") != NULL) { 462 (void) printf("dumping core by request\n"); 463 abort(); 464 } 465 466 exit(requested ? 0 : 2); 467 } 468 469 static int 470 parseprop(nvlist_t *props) 471 { 472 char *propname = optarg; 473 char *propval, *strval; 474 475 if ((propval = strchr(propname, '=')) == NULL) { 476 (void) fprintf(stderr, gettext("missing " 477 "'=' for -o option\n")); 478 return (-1); 479 } 480 *propval = '\0'; 481 propval++; 482 if (nvlist_lookup_string(props, propname, &strval) == 0) { 483 (void) fprintf(stderr, gettext("property '%s' " 484 "specified multiple times\n"), propname); 485 return (-1); 486 } 487 if (nvlist_add_string(props, propname, propval) != 0) 488 nomem(); 489 return (0); 490 } 491 492 static int 493 parse_depth(char *opt, int *flags) 494 { 495 char *tmp; 496 int depth; 497 498 depth = (int)strtol(opt, &tmp, 0); 499 if (*tmp) { 500 (void) fprintf(stderr, 501 gettext("%s is not an integer\n"), optarg); 502 usage(B_FALSE); 503 } 504 if (depth < 0) { 505 (void) fprintf(stderr, 506 gettext("Depth can not be negative.\n")); 507 usage(B_FALSE); 508 } 509 *flags |= (ZFS_ITER_DEPTH_LIMIT|ZFS_ITER_RECURSE); 510 return (depth); 511 } 512 513 #define PROGRESS_DELAY 2 /* seconds */ 514 515 static char *pt_reverse = "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b"; 516 static time_t pt_begin; 517 static char *pt_header = NULL; 518 static boolean_t pt_shown; 519 520 static void 521 start_progress_timer(void) 522 { 523 pt_begin = time(NULL) + PROGRESS_DELAY; 524 pt_shown = B_FALSE; 525 } 526 527 static void 528 set_progress_header(char *header) 529 { 530 assert(pt_header == NULL); 531 pt_header = safe_strdup(header); 532 if (pt_shown) { 533 (void) printf("%s: ", header); 534 (void) fflush(stdout); 535 } 536 } 537 538 static void 539 update_progress(char *update) 540 { 541 if (!pt_shown && time(NULL) > pt_begin) { 542 int len = strlen(update); 543 544 (void) printf("%s: %s%*.*s", pt_header, update, len, len, 545 pt_reverse); 546 (void) fflush(stdout); 547 pt_shown = B_TRUE; 548 } else if (pt_shown) { 549 int len = strlen(update); 550 551 (void) printf("%s%*.*s", update, len, len, pt_reverse); 552 (void) fflush(stdout); 553 } 554 } 555 556 static void 557 finish_progress(char *done) 558 { 559 if (pt_shown) { 560 (void) printf("%s\n", done); 561 (void) fflush(stdout); 562 } 563 free(pt_header); 564 pt_header = NULL; 565 } 566 /* 567 * zfs clone [-p] [-o prop=value] ... <snap> <fs | vol> 568 * 569 * Given an existing dataset, create a writable copy whose initial contents 570 * are the same as the source. The newly created dataset maintains a 571 * dependency on the original; the original cannot be destroyed so long as 572 * the clone exists. 573 * 574 * The '-p' flag creates all the non-existing ancestors of the target first. 575 */ 576 static int 577 zfs_do_clone(int argc, char **argv) 578 { 579 zfs_handle_t *zhp = NULL; 580 boolean_t parents = B_FALSE; 581 nvlist_t *props; 582 int ret = 0; 583 int c; 584 585 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) 586 nomem(); 587 588 /* check options */ 589 while ((c = getopt(argc, argv, "o:p")) != -1) { 590 switch (c) { 591 case 'o': 592 if (parseprop(props)) 593 return (1); 594 break; 595 case 'p': 596 parents = B_TRUE; 597 break; 598 case '?': 599 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 600 optopt); 601 goto usage; 602 } 603 } 604 605 argc -= optind; 606 argv += optind; 607 608 /* check number of arguments */ 609 if (argc < 1) { 610 (void) fprintf(stderr, gettext("missing source dataset " 611 "argument\n")); 612 goto usage; 613 } 614 if (argc < 2) { 615 (void) fprintf(stderr, gettext("missing target dataset " 616 "argument\n")); 617 goto usage; 618 } 619 if (argc > 2) { 620 (void) fprintf(stderr, gettext("too many arguments\n")); 621 goto usage; 622 } 623 624 /* open the source dataset */ 625 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL) 626 return (1); 627 628 if (parents && zfs_name_valid(argv[1], ZFS_TYPE_FILESYSTEM | 629 ZFS_TYPE_VOLUME)) { 630 /* 631 * Now create the ancestors of the target dataset. If the 632 * target already exists and '-p' option was used we should not 633 * complain. 634 */ 635 if (zfs_dataset_exists(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM | 636 ZFS_TYPE_VOLUME)) 637 return (0); 638 if (zfs_create_ancestors(g_zfs, argv[1]) != 0) 639 return (1); 640 } 641 642 /* pass to libzfs */ 643 ret = zfs_clone(zhp, argv[1], props); 644 645 /* create the mountpoint if necessary */ 646 if (ret == 0) { 647 zfs_handle_t *clone; 648 649 clone = zfs_open(g_zfs, argv[1], ZFS_TYPE_DATASET); 650 if (clone != NULL) { 651 if (zfs_get_type(clone) != ZFS_TYPE_VOLUME) 652 if ((ret = zfs_mount(clone, NULL, 0)) == 0) 653 ret = zfs_share(clone); 654 zfs_close(clone); 655 } 656 } 657 658 zfs_close(zhp); 659 nvlist_free(props); 660 661 return (!!ret); 662 663 usage: 664 if (zhp) 665 zfs_close(zhp); 666 nvlist_free(props); 667 usage(B_FALSE); 668 return (-1); 669 } 670 671 /* 672 * zfs create [-p] [-o prop=value] ... fs 673 * zfs create [-ps] [-b blocksize] [-o prop=value] ... -V vol size 674 * 675 * Create a new dataset. This command can be used to create filesystems 676 * and volumes. Snapshot creation is handled by 'zfs snapshot'. 677 * For volumes, the user must specify a size to be used. 678 * 679 * The '-s' flag applies only to volumes, and indicates that we should not try 680 * to set the reservation for this volume. By default we set a reservation 681 * equal to the size for any volume. For pools with SPA_VERSION >= 682 * SPA_VERSION_REFRESERVATION, we set a refreservation instead. 683 * 684 * The '-p' flag creates all the non-existing ancestors of the target first. 685 */ 686 static int 687 zfs_do_create(int argc, char **argv) 688 { 689 zfs_type_t type = ZFS_TYPE_FILESYSTEM; 690 zfs_handle_t *zhp = NULL; 691 uint64_t volsize; 692 int c; 693 boolean_t noreserve = B_FALSE; 694 boolean_t bflag = B_FALSE; 695 boolean_t parents = B_FALSE; 696 int ret = 1; 697 nvlist_t *props; 698 uint64_t intval; 699 int canmount = ZFS_CANMOUNT_OFF; 700 701 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) 702 nomem(); 703 704 /* check options */ 705 while ((c = getopt(argc, argv, ":V:b:so:p")) != -1) { 706 switch (c) { 707 case 'V': 708 type = ZFS_TYPE_VOLUME; 709 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) { 710 (void) fprintf(stderr, gettext("bad volume " 711 "size '%s': %s\n"), optarg, 712 libzfs_error_description(g_zfs)); 713 goto error; 714 } 715 716 if (nvlist_add_uint64(props, 717 zfs_prop_to_name(ZFS_PROP_VOLSIZE), intval) != 0) 718 nomem(); 719 volsize = intval; 720 break; 721 case 'p': 722 parents = B_TRUE; 723 break; 724 case 'b': 725 bflag = B_TRUE; 726 if (zfs_nicestrtonum(g_zfs, optarg, &intval) != 0) { 727 (void) fprintf(stderr, gettext("bad volume " 728 "block size '%s': %s\n"), optarg, 729 libzfs_error_description(g_zfs)); 730 goto error; 731 } 732 733 if (nvlist_add_uint64(props, 734 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE), 735 intval) != 0) 736 nomem(); 737 break; 738 case 'o': 739 if (parseprop(props)) 740 goto error; 741 break; 742 case 's': 743 noreserve = B_TRUE; 744 break; 745 case ':': 746 (void) fprintf(stderr, gettext("missing size " 747 "argument\n")); 748 goto badusage; 749 case '?': 750 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 751 optopt); 752 goto badusage; 753 } 754 } 755 756 if ((bflag || noreserve) && type != ZFS_TYPE_VOLUME) { 757 (void) fprintf(stderr, gettext("'-s' and '-b' can only be " 758 "used when creating a volume\n")); 759 goto badusage; 760 } 761 762 argc -= optind; 763 argv += optind; 764 765 /* check number of arguments */ 766 if (argc == 0) { 767 (void) fprintf(stderr, gettext("missing %s argument\n"), 768 zfs_type_to_name(type)); 769 goto badusage; 770 } 771 if (argc > 1) { 772 (void) fprintf(stderr, gettext("too many arguments\n")); 773 goto badusage; 774 } 775 776 if (type == ZFS_TYPE_VOLUME && !noreserve) { 777 zpool_handle_t *zpool_handle; 778 uint64_t spa_version; 779 char *p; 780 zfs_prop_t resv_prop; 781 char *strval; 782 783 if (p = strchr(argv[0], '/')) 784 *p = '\0'; 785 zpool_handle = zpool_open(g_zfs, argv[0]); 786 if (p != NULL) 787 *p = '/'; 788 if (zpool_handle == NULL) 789 goto error; 790 spa_version = zpool_get_prop_int(zpool_handle, 791 ZPOOL_PROP_VERSION, NULL); 792 zpool_close(zpool_handle); 793 if (spa_version >= SPA_VERSION_REFRESERVATION) 794 resv_prop = ZFS_PROP_REFRESERVATION; 795 else 796 resv_prop = ZFS_PROP_RESERVATION; 797 volsize = zvol_volsize_to_reservation(volsize, props); 798 799 if (nvlist_lookup_string(props, zfs_prop_to_name(resv_prop), 800 &strval) != 0) { 801 if (nvlist_add_uint64(props, 802 zfs_prop_to_name(resv_prop), volsize) != 0) { 803 nvlist_free(props); 804 nomem(); 805 } 806 } 807 } 808 809 if (parents && zfs_name_valid(argv[0], type)) { 810 /* 811 * Now create the ancestors of target dataset. If the target 812 * already exists and '-p' option was used we should not 813 * complain. 814 */ 815 if (zfs_dataset_exists(g_zfs, argv[0], type)) { 816 ret = 0; 817 goto error; 818 } 819 if (zfs_create_ancestors(g_zfs, argv[0]) != 0) 820 goto error; 821 } 822 823 /* pass to libzfs */ 824 if (zfs_create(g_zfs, argv[0], type, props) != 0) 825 goto error; 826 827 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL) 828 goto error; 829 830 ret = 0; 831 /* 832 * if the user doesn't want the dataset automatically mounted, 833 * then skip the mount/share step 834 */ 835 if (zfs_prop_valid_for_type(ZFS_PROP_CANMOUNT, type)) 836 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT); 837 838 /* 839 * Mount and/or share the new filesystem as appropriate. We provide a 840 * verbose error message to let the user know that their filesystem was 841 * in fact created, even if we failed to mount or share it. 842 */ 843 if (canmount == ZFS_CANMOUNT_ON) { 844 if (zfs_mount(zhp, NULL, 0) != 0) { 845 (void) fprintf(stderr, gettext("filesystem " 846 "successfully created, but not mounted\n")); 847 ret = 1; 848 } else if (zfs_share(zhp) != 0) { 849 (void) fprintf(stderr, gettext("filesystem " 850 "successfully created, but not shared\n")); 851 ret = 1; 852 } 853 } 854 855 error: 856 if (zhp) 857 zfs_close(zhp); 858 nvlist_free(props); 859 return (ret); 860 badusage: 861 nvlist_free(props); 862 usage(B_FALSE); 863 return (2); 864 } 865 866 /* 867 * zfs destroy [-rRf] <fs, vol> 868 * zfs destroy [-rRd] <snap> 869 * 870 * -r Recursively destroy all children 871 * -R Recursively destroy all dependents, including clones 872 * -f Force unmounting of any dependents 873 * -d If we can't destroy now, mark for deferred destruction 874 * 875 * Destroys the given dataset. By default, it will unmount any filesystems, 876 * and refuse to destroy a dataset that has any dependents. A dependent can 877 * either be a child, or a clone of a child. 878 */ 879 typedef struct destroy_cbdata { 880 boolean_t cb_first; 881 boolean_t cb_force; 882 boolean_t cb_recurse; 883 boolean_t cb_error; 884 boolean_t cb_doclones; 885 zfs_handle_t *cb_target; 886 boolean_t cb_defer_destroy; 887 boolean_t cb_verbose; 888 boolean_t cb_parsable; 889 boolean_t cb_dryrun; 890 nvlist_t *cb_nvl; 891 892 /* first snap in contiguous run */ 893 char *cb_firstsnap; 894 /* previous snap in contiguous run */ 895 char *cb_prevsnap; 896 int64_t cb_snapused; 897 char *cb_snapspec; 898 } destroy_cbdata_t; 899 900 /* 901 * Check for any dependents based on the '-r' or '-R' flags. 902 */ 903 static int 904 destroy_check_dependent(zfs_handle_t *zhp, void *data) 905 { 906 destroy_cbdata_t *cbp = data; 907 const char *tname = zfs_get_name(cbp->cb_target); 908 const char *name = zfs_get_name(zhp); 909 910 if (strncmp(tname, name, strlen(tname)) == 0 && 911 (name[strlen(tname)] == '/' || name[strlen(tname)] == '@')) { 912 /* 913 * This is a direct descendant, not a clone somewhere else in 914 * the hierarchy. 915 */ 916 if (cbp->cb_recurse) 917 goto out; 918 919 if (cbp->cb_first) { 920 (void) fprintf(stderr, gettext("cannot destroy '%s': " 921 "%s has children\n"), 922 zfs_get_name(cbp->cb_target), 923 zfs_type_to_name(zfs_get_type(cbp->cb_target))); 924 (void) fprintf(stderr, gettext("use '-r' to destroy " 925 "the following datasets:\n")); 926 cbp->cb_first = B_FALSE; 927 cbp->cb_error = B_TRUE; 928 } 929 930 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 931 } else { 932 /* 933 * This is a clone. We only want to report this if the '-r' 934 * wasn't specified, or the target is a snapshot. 935 */ 936 if (!cbp->cb_recurse && 937 zfs_get_type(cbp->cb_target) != ZFS_TYPE_SNAPSHOT) 938 goto out; 939 940 if (cbp->cb_first) { 941 (void) fprintf(stderr, gettext("cannot destroy '%s': " 942 "%s has dependent clones\n"), 943 zfs_get_name(cbp->cb_target), 944 zfs_type_to_name(zfs_get_type(cbp->cb_target))); 945 (void) fprintf(stderr, gettext("use '-R' to destroy " 946 "the following datasets:\n")); 947 cbp->cb_first = B_FALSE; 948 cbp->cb_error = B_TRUE; 949 cbp->cb_dryrun = B_TRUE; 950 } 951 952 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 953 } 954 955 out: 956 zfs_close(zhp); 957 return (0); 958 } 959 960 static int 961 destroy_callback(zfs_handle_t *zhp, void *data) 962 { 963 destroy_cbdata_t *cb = data; 964 const char *name = zfs_get_name(zhp); 965 966 if (cb->cb_verbose) { 967 if (cb->cb_parsable) { 968 (void) printf("destroy\t%s\n", name); 969 } else if (cb->cb_dryrun) { 970 (void) printf(gettext("would destroy %s\n"), 971 name); 972 } else { 973 (void) printf(gettext("will destroy %s\n"), 974 name); 975 } 976 } 977 978 /* 979 * Ignore pools (which we've already flagged as an error before getting 980 * here). 981 */ 982 if (strchr(zfs_get_name(zhp), '/') == NULL && 983 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) { 984 zfs_close(zhp); 985 return (0); 986 } 987 988 if (!cb->cb_dryrun) { 989 if (zfs_unmount(zhp, NULL, cb->cb_force ? MS_FORCE : 0) != 0 || 990 zfs_destroy(zhp, cb->cb_defer_destroy) != 0) { 991 zfs_close(zhp); 992 return (-1); 993 } 994 } 995 996 zfs_close(zhp); 997 return (0); 998 } 999 1000 static int 1001 destroy_print_cb(zfs_handle_t *zhp, void *arg) 1002 { 1003 destroy_cbdata_t *cb = arg; 1004 const char *name = zfs_get_name(zhp); 1005 int err = 0; 1006 1007 if (nvlist_exists(cb->cb_nvl, name)) { 1008 if (cb->cb_firstsnap == NULL) 1009 cb->cb_firstsnap = strdup(name); 1010 if (cb->cb_prevsnap != NULL) 1011 free(cb->cb_prevsnap); 1012 /* this snap continues the current range */ 1013 cb->cb_prevsnap = strdup(name); 1014 if (cb->cb_firstsnap == NULL || cb->cb_prevsnap == NULL) 1015 nomem(); 1016 if (cb->cb_verbose) { 1017 if (cb->cb_parsable) { 1018 (void) printf("destroy\t%s\n", name); 1019 } else if (cb->cb_dryrun) { 1020 (void) printf(gettext("would destroy %s\n"), 1021 name); 1022 } else { 1023 (void) printf(gettext("will destroy %s\n"), 1024 name); 1025 } 1026 } 1027 } else if (cb->cb_firstsnap != NULL) { 1028 /* end of this range */ 1029 uint64_t used = 0; 1030 err = lzc_snaprange_space(cb->cb_firstsnap, 1031 cb->cb_prevsnap, &used); 1032 cb->cb_snapused += used; 1033 free(cb->cb_firstsnap); 1034 cb->cb_firstsnap = NULL; 1035 free(cb->cb_prevsnap); 1036 cb->cb_prevsnap = NULL; 1037 } 1038 zfs_close(zhp); 1039 return (err); 1040 } 1041 1042 static int 1043 destroy_print_snapshots(zfs_handle_t *fs_zhp, destroy_cbdata_t *cb) 1044 { 1045 int err = 0; 1046 assert(cb->cb_firstsnap == NULL); 1047 assert(cb->cb_prevsnap == NULL); 1048 err = zfs_iter_snapshots_sorted(fs_zhp, destroy_print_cb, cb); 1049 if (cb->cb_firstsnap != NULL) { 1050 uint64_t used = 0; 1051 if (err == 0) { 1052 err = lzc_snaprange_space(cb->cb_firstsnap, 1053 cb->cb_prevsnap, &used); 1054 } 1055 cb->cb_snapused += used; 1056 free(cb->cb_firstsnap); 1057 cb->cb_firstsnap = NULL; 1058 free(cb->cb_prevsnap); 1059 cb->cb_prevsnap = NULL; 1060 } 1061 return (err); 1062 } 1063 1064 static int 1065 snapshot_to_nvl_cb(zfs_handle_t *zhp, void *arg) 1066 { 1067 destroy_cbdata_t *cb = arg; 1068 int err = 0; 1069 1070 /* Check for clones. */ 1071 if (!cb->cb_doclones && !cb->cb_defer_destroy) { 1072 cb->cb_target = zhp; 1073 cb->cb_first = B_TRUE; 1074 err = zfs_iter_dependents(zhp, B_TRUE, 1075 destroy_check_dependent, cb); 1076 } 1077 1078 if (err == 0) { 1079 if (nvlist_add_boolean(cb->cb_nvl, zfs_get_name(zhp))) 1080 nomem(); 1081 } 1082 zfs_close(zhp); 1083 return (err); 1084 } 1085 1086 static int 1087 gather_snapshots(zfs_handle_t *zhp, void *arg) 1088 { 1089 destroy_cbdata_t *cb = arg; 1090 int err = 0; 1091 1092 err = zfs_iter_snapspec(zhp, cb->cb_snapspec, snapshot_to_nvl_cb, cb); 1093 if (err == ENOENT) 1094 err = 0; 1095 if (err != 0) 1096 goto out; 1097 1098 if (cb->cb_verbose) { 1099 err = destroy_print_snapshots(zhp, cb); 1100 if (err != 0) 1101 goto out; 1102 } 1103 1104 if (cb->cb_recurse) 1105 err = zfs_iter_filesystems(zhp, gather_snapshots, cb); 1106 1107 out: 1108 zfs_close(zhp); 1109 return (err); 1110 } 1111 1112 static int 1113 destroy_clones(destroy_cbdata_t *cb) 1114 { 1115 nvpair_t *pair; 1116 for (pair = nvlist_next_nvpair(cb->cb_nvl, NULL); 1117 pair != NULL; 1118 pair = nvlist_next_nvpair(cb->cb_nvl, pair)) { 1119 zfs_handle_t *zhp = zfs_open(g_zfs, nvpair_name(pair), 1120 ZFS_TYPE_SNAPSHOT); 1121 if (zhp != NULL) { 1122 boolean_t defer = cb->cb_defer_destroy; 1123 int err = 0; 1124 1125 /* 1126 * We can't defer destroy non-snapshots, so set it to 1127 * false while destroying the clones. 1128 */ 1129 cb->cb_defer_destroy = B_FALSE; 1130 err = zfs_iter_dependents(zhp, B_FALSE, 1131 destroy_callback, cb); 1132 cb->cb_defer_destroy = defer; 1133 zfs_close(zhp); 1134 if (err != 0) 1135 return (err); 1136 } 1137 } 1138 return (0); 1139 } 1140 1141 static int 1142 zfs_do_destroy(int argc, char **argv) 1143 { 1144 destroy_cbdata_t cb = { 0 }; 1145 int c; 1146 zfs_handle_t *zhp; 1147 char *at; 1148 zfs_type_t type = ZFS_TYPE_DATASET; 1149 1150 /* check options */ 1151 while ((c = getopt(argc, argv, "vpndfrR")) != -1) { 1152 switch (c) { 1153 case 'v': 1154 cb.cb_verbose = B_TRUE; 1155 break; 1156 case 'p': 1157 cb.cb_verbose = B_TRUE; 1158 cb.cb_parsable = B_TRUE; 1159 break; 1160 case 'n': 1161 cb.cb_dryrun = B_TRUE; 1162 break; 1163 case 'd': 1164 cb.cb_defer_destroy = B_TRUE; 1165 type = ZFS_TYPE_SNAPSHOT; 1166 break; 1167 case 'f': 1168 cb.cb_force = B_TRUE; 1169 break; 1170 case 'r': 1171 cb.cb_recurse = B_TRUE; 1172 break; 1173 case 'R': 1174 cb.cb_recurse = B_TRUE; 1175 cb.cb_doclones = B_TRUE; 1176 break; 1177 case '?': 1178 default: 1179 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1180 optopt); 1181 usage(B_FALSE); 1182 } 1183 } 1184 1185 argc -= optind; 1186 argv += optind; 1187 1188 /* check number of arguments */ 1189 if (argc == 0) { 1190 (void) fprintf(stderr, gettext("missing dataset argument\n")); 1191 usage(B_FALSE); 1192 } 1193 if (argc > 1) { 1194 (void) fprintf(stderr, gettext("too many arguments\n")); 1195 usage(B_FALSE); 1196 } 1197 1198 at = strchr(argv[0], '@'); 1199 if (at != NULL) { 1200 int err = 0; 1201 1202 /* Build the list of snaps to destroy in cb_nvl. */ 1203 if (nvlist_alloc(&cb.cb_nvl, NV_UNIQUE_NAME, 0) != 0) 1204 nomem(); 1205 1206 *at = '\0'; 1207 zhp = zfs_open(g_zfs, argv[0], 1208 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 1209 if (zhp == NULL) 1210 return (1); 1211 1212 cb.cb_snapspec = at + 1; 1213 if (gather_snapshots(zfs_handle_dup(zhp), &cb) != 0 || 1214 cb.cb_error) { 1215 zfs_close(zhp); 1216 nvlist_free(cb.cb_nvl); 1217 return (1); 1218 } 1219 1220 if (nvlist_empty(cb.cb_nvl)) { 1221 (void) fprintf(stderr, gettext("could not find any " 1222 "snapshots to destroy; check snapshot names.\n")); 1223 zfs_close(zhp); 1224 nvlist_free(cb.cb_nvl); 1225 return (1); 1226 } 1227 1228 if (cb.cb_verbose) { 1229 char buf[16]; 1230 zfs_nicenum(cb.cb_snapused, buf, sizeof (buf)); 1231 if (cb.cb_parsable) { 1232 (void) printf("reclaim\t%llu\n", 1233 cb.cb_snapused); 1234 } else if (cb.cb_dryrun) { 1235 (void) printf(gettext("would reclaim %s\n"), 1236 buf); 1237 } else { 1238 (void) printf(gettext("will reclaim %s\n"), 1239 buf); 1240 } 1241 } 1242 1243 if (!cb.cb_dryrun) { 1244 if (cb.cb_doclones) 1245 err = destroy_clones(&cb); 1246 if (err == 0) { 1247 err = zfs_destroy_snaps_nvl(zhp, cb.cb_nvl, 1248 cb.cb_defer_destroy); 1249 } 1250 } 1251 1252 zfs_close(zhp); 1253 nvlist_free(cb.cb_nvl); 1254 if (err != 0) 1255 return (1); 1256 } else { 1257 /* Open the given dataset */ 1258 if ((zhp = zfs_open(g_zfs, argv[0], type)) == NULL) 1259 return (1); 1260 1261 cb.cb_target = zhp; 1262 1263 /* 1264 * Perform an explicit check for pools before going any further. 1265 */ 1266 if (!cb.cb_recurse && strchr(zfs_get_name(zhp), '/') == NULL && 1267 zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) { 1268 (void) fprintf(stderr, gettext("cannot destroy '%s': " 1269 "operation does not apply to pools\n"), 1270 zfs_get_name(zhp)); 1271 (void) fprintf(stderr, gettext("use 'zfs destroy -r " 1272 "%s' to destroy all datasets in the pool\n"), 1273 zfs_get_name(zhp)); 1274 (void) fprintf(stderr, gettext("use 'zpool destroy %s' " 1275 "to destroy the pool itself\n"), zfs_get_name(zhp)); 1276 zfs_close(zhp); 1277 return (1); 1278 } 1279 1280 /* 1281 * Check for any dependents and/or clones. 1282 */ 1283 cb.cb_first = B_TRUE; 1284 if (!cb.cb_doclones && 1285 zfs_iter_dependents(zhp, B_TRUE, destroy_check_dependent, 1286 &cb) != 0) { 1287 zfs_close(zhp); 1288 return (1); 1289 } 1290 1291 if (cb.cb_error) { 1292 zfs_close(zhp); 1293 return (1); 1294 } 1295 1296 if (zfs_iter_dependents(zhp, B_FALSE, destroy_callback, 1297 &cb) != 0) { 1298 zfs_close(zhp); 1299 return (1); 1300 } 1301 1302 /* 1303 * Do the real thing. The callback will close the 1304 * handle regardless of whether it succeeds or not. 1305 */ 1306 if (destroy_callback(zhp, &cb) != 0) 1307 return (1); 1308 } 1309 1310 return (0); 1311 } 1312 1313 static boolean_t 1314 is_recvd_column(zprop_get_cbdata_t *cbp) 1315 { 1316 int i; 1317 zfs_get_column_t col; 1318 1319 for (i = 0; i < ZFS_GET_NCOLS && 1320 (col = cbp->cb_columns[i]) != GET_COL_NONE; i++) 1321 if (col == GET_COL_RECVD) 1322 return (B_TRUE); 1323 return (B_FALSE); 1324 } 1325 1326 /* 1327 * zfs get [-rHp] [-o all | field[,field]...] [-s source[,source]...] 1328 * < all | property[,property]... > < fs | snap | vol > ... 1329 * 1330 * -r recurse over any child datasets 1331 * -H scripted mode. Headers are stripped, and fields are separated 1332 * by tabs instead of spaces. 1333 * -o Set of fields to display. One of "name,property,value, 1334 * received,source". Default is "name,property,value,source". 1335 * "all" is an alias for all five. 1336 * -s Set of sources to allow. One of 1337 * "local,default,inherited,received,temporary,none". Default is 1338 * all six. 1339 * -p Display values in parsable (literal) format. 1340 * 1341 * Prints properties for the given datasets. The user can control which 1342 * columns to display as well as which property types to allow. 1343 */ 1344 1345 /* 1346 * Invoked to display the properties for a single dataset. 1347 */ 1348 static int 1349 get_callback(zfs_handle_t *zhp, void *data) 1350 { 1351 char buf[ZFS_MAXPROPLEN]; 1352 char rbuf[ZFS_MAXPROPLEN]; 1353 zprop_source_t sourcetype; 1354 char source[ZFS_MAXNAMELEN]; 1355 zprop_get_cbdata_t *cbp = data; 1356 nvlist_t *user_props = zfs_get_user_props(zhp); 1357 zprop_list_t *pl = cbp->cb_proplist; 1358 nvlist_t *propval; 1359 char *strval; 1360 char *sourceval; 1361 boolean_t received = is_recvd_column(cbp); 1362 1363 for (; pl != NULL; pl = pl->pl_next) { 1364 char *recvdval = NULL; 1365 /* 1366 * Skip the special fake placeholder. This will also skip over 1367 * the name property when 'all' is specified. 1368 */ 1369 if (pl->pl_prop == ZFS_PROP_NAME && 1370 pl == cbp->cb_proplist) 1371 continue; 1372 1373 if (pl->pl_prop != ZPROP_INVAL) { 1374 if (zfs_prop_get(zhp, pl->pl_prop, buf, 1375 sizeof (buf), &sourcetype, source, 1376 sizeof (source), 1377 cbp->cb_literal) != 0) { 1378 if (pl->pl_all) 1379 continue; 1380 if (!zfs_prop_valid_for_type(pl->pl_prop, 1381 ZFS_TYPE_DATASET)) { 1382 (void) fprintf(stderr, 1383 gettext("No such property '%s'\n"), 1384 zfs_prop_to_name(pl->pl_prop)); 1385 continue; 1386 } 1387 sourcetype = ZPROP_SRC_NONE; 1388 (void) strlcpy(buf, "-", sizeof (buf)); 1389 } 1390 1391 if (received && (zfs_prop_get_recvd(zhp, 1392 zfs_prop_to_name(pl->pl_prop), rbuf, sizeof (rbuf), 1393 cbp->cb_literal) == 0)) 1394 recvdval = rbuf; 1395 1396 zprop_print_one_property(zfs_get_name(zhp), cbp, 1397 zfs_prop_to_name(pl->pl_prop), 1398 buf, sourcetype, source, recvdval); 1399 } else if (zfs_prop_userquota(pl->pl_user_prop)) { 1400 sourcetype = ZPROP_SRC_LOCAL; 1401 1402 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop, 1403 buf, sizeof (buf), cbp->cb_literal) != 0) { 1404 sourcetype = ZPROP_SRC_NONE; 1405 (void) strlcpy(buf, "-", sizeof (buf)); 1406 } 1407 1408 zprop_print_one_property(zfs_get_name(zhp), cbp, 1409 pl->pl_user_prop, buf, sourcetype, source, NULL); 1410 } else if (zfs_prop_written(pl->pl_user_prop)) { 1411 sourcetype = ZPROP_SRC_LOCAL; 1412 1413 if (zfs_prop_get_written(zhp, pl->pl_user_prop, 1414 buf, sizeof (buf), cbp->cb_literal) != 0) { 1415 sourcetype = ZPROP_SRC_NONE; 1416 (void) strlcpy(buf, "-", sizeof (buf)); 1417 } 1418 1419 zprop_print_one_property(zfs_get_name(zhp), cbp, 1420 pl->pl_user_prop, buf, sourcetype, source, NULL); 1421 } else { 1422 if (nvlist_lookup_nvlist(user_props, 1423 pl->pl_user_prop, &propval) != 0) { 1424 if (pl->pl_all) 1425 continue; 1426 sourcetype = ZPROP_SRC_NONE; 1427 strval = "-"; 1428 } else { 1429 verify(nvlist_lookup_string(propval, 1430 ZPROP_VALUE, &strval) == 0); 1431 verify(nvlist_lookup_string(propval, 1432 ZPROP_SOURCE, &sourceval) == 0); 1433 1434 if (strcmp(sourceval, 1435 zfs_get_name(zhp)) == 0) { 1436 sourcetype = ZPROP_SRC_LOCAL; 1437 } else if (strcmp(sourceval, 1438 ZPROP_SOURCE_VAL_RECVD) == 0) { 1439 sourcetype = ZPROP_SRC_RECEIVED; 1440 } else { 1441 sourcetype = ZPROP_SRC_INHERITED; 1442 (void) strlcpy(source, 1443 sourceval, sizeof (source)); 1444 } 1445 } 1446 1447 if (received && (zfs_prop_get_recvd(zhp, 1448 pl->pl_user_prop, rbuf, sizeof (rbuf), 1449 cbp->cb_literal) == 0)) 1450 recvdval = rbuf; 1451 1452 zprop_print_one_property(zfs_get_name(zhp), cbp, 1453 pl->pl_user_prop, strval, sourcetype, 1454 source, recvdval); 1455 } 1456 } 1457 1458 return (0); 1459 } 1460 1461 static int 1462 zfs_do_get(int argc, char **argv) 1463 { 1464 zprop_get_cbdata_t cb = { 0 }; 1465 int i, c, flags = ZFS_ITER_ARGS_CAN_BE_PATHS; 1466 int types = ZFS_TYPE_DATASET; 1467 char *value, *fields; 1468 int ret = 0; 1469 int limit = 0; 1470 zprop_list_t fake_name = { 0 }; 1471 1472 /* 1473 * Set up default columns and sources. 1474 */ 1475 cb.cb_sources = ZPROP_SRC_ALL; 1476 cb.cb_columns[0] = GET_COL_NAME; 1477 cb.cb_columns[1] = GET_COL_PROPERTY; 1478 cb.cb_columns[2] = GET_COL_VALUE; 1479 cb.cb_columns[3] = GET_COL_SOURCE; 1480 cb.cb_type = ZFS_TYPE_DATASET; 1481 1482 /* check options */ 1483 while ((c = getopt(argc, argv, ":d:o:s:rt:Hp")) != -1) { 1484 switch (c) { 1485 case 'p': 1486 cb.cb_literal = B_TRUE; 1487 break; 1488 case 'd': 1489 limit = parse_depth(optarg, &flags); 1490 break; 1491 case 'r': 1492 flags |= ZFS_ITER_RECURSE; 1493 break; 1494 case 'H': 1495 cb.cb_scripted = B_TRUE; 1496 break; 1497 case ':': 1498 (void) fprintf(stderr, gettext("missing argument for " 1499 "'%c' option\n"), optopt); 1500 usage(B_FALSE); 1501 break; 1502 case 'o': 1503 /* 1504 * Process the set of columns to display. We zero out 1505 * the structure to give us a blank slate. 1506 */ 1507 bzero(&cb.cb_columns, sizeof (cb.cb_columns)); 1508 i = 0; 1509 while (*optarg != '\0') { 1510 static char *col_subopts[] = 1511 { "name", "property", "value", "received", 1512 "source", "all", NULL }; 1513 1514 if (i == ZFS_GET_NCOLS) { 1515 (void) fprintf(stderr, gettext("too " 1516 "many fields given to -o " 1517 "option\n")); 1518 usage(B_FALSE); 1519 } 1520 1521 switch (getsubopt(&optarg, col_subopts, 1522 &value)) { 1523 case 0: 1524 cb.cb_columns[i++] = GET_COL_NAME; 1525 break; 1526 case 1: 1527 cb.cb_columns[i++] = GET_COL_PROPERTY; 1528 break; 1529 case 2: 1530 cb.cb_columns[i++] = GET_COL_VALUE; 1531 break; 1532 case 3: 1533 cb.cb_columns[i++] = GET_COL_RECVD; 1534 flags |= ZFS_ITER_RECVD_PROPS; 1535 break; 1536 case 4: 1537 cb.cb_columns[i++] = GET_COL_SOURCE; 1538 break; 1539 case 5: 1540 if (i > 0) { 1541 (void) fprintf(stderr, 1542 gettext("\"all\" conflicts " 1543 "with specific fields " 1544 "given to -o option\n")); 1545 usage(B_FALSE); 1546 } 1547 cb.cb_columns[0] = GET_COL_NAME; 1548 cb.cb_columns[1] = GET_COL_PROPERTY; 1549 cb.cb_columns[2] = GET_COL_VALUE; 1550 cb.cb_columns[3] = GET_COL_RECVD; 1551 cb.cb_columns[4] = GET_COL_SOURCE; 1552 flags |= ZFS_ITER_RECVD_PROPS; 1553 i = ZFS_GET_NCOLS; 1554 break; 1555 default: 1556 (void) fprintf(stderr, 1557 gettext("invalid column name " 1558 "'%s'\n"), value); 1559 usage(B_FALSE); 1560 } 1561 } 1562 break; 1563 1564 case 's': 1565 cb.cb_sources = 0; 1566 while (*optarg != '\0') { 1567 static char *source_subopts[] = { 1568 "local", "default", "inherited", 1569 "received", "temporary", "none", 1570 NULL }; 1571 1572 switch (getsubopt(&optarg, source_subopts, 1573 &value)) { 1574 case 0: 1575 cb.cb_sources |= ZPROP_SRC_LOCAL; 1576 break; 1577 case 1: 1578 cb.cb_sources |= ZPROP_SRC_DEFAULT; 1579 break; 1580 case 2: 1581 cb.cb_sources |= ZPROP_SRC_INHERITED; 1582 break; 1583 case 3: 1584 cb.cb_sources |= ZPROP_SRC_RECEIVED; 1585 break; 1586 case 4: 1587 cb.cb_sources |= ZPROP_SRC_TEMPORARY; 1588 break; 1589 case 5: 1590 cb.cb_sources |= ZPROP_SRC_NONE; 1591 break; 1592 default: 1593 (void) fprintf(stderr, 1594 gettext("invalid source " 1595 "'%s'\n"), value); 1596 usage(B_FALSE); 1597 } 1598 } 1599 break; 1600 1601 case 't': 1602 types = 0; 1603 flags &= ~ZFS_ITER_PROP_LISTSNAPS; 1604 while (*optarg != '\0') { 1605 static char *type_subopts[] = { "filesystem", 1606 "volume", "snapshot", "all", NULL }; 1607 1608 switch (getsubopt(&optarg, type_subopts, 1609 &value)) { 1610 case 0: 1611 types |= ZFS_TYPE_FILESYSTEM; 1612 break; 1613 case 1: 1614 types |= ZFS_TYPE_VOLUME; 1615 break; 1616 case 2: 1617 types |= ZFS_TYPE_SNAPSHOT; 1618 break; 1619 case 3: 1620 types = ZFS_TYPE_DATASET; 1621 break; 1622 1623 default: 1624 (void) fprintf(stderr, 1625 gettext("invalid type '%s'\n"), 1626 value); 1627 usage(B_FALSE); 1628 } 1629 } 1630 break; 1631 1632 case '?': 1633 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1634 optopt); 1635 usage(B_FALSE); 1636 } 1637 } 1638 1639 argc -= optind; 1640 argv += optind; 1641 1642 if (argc < 1) { 1643 (void) fprintf(stderr, gettext("missing property " 1644 "argument\n")); 1645 usage(B_FALSE); 1646 } 1647 1648 fields = argv[0]; 1649 1650 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET) 1651 != 0) 1652 usage(B_FALSE); 1653 1654 argc--; 1655 argv++; 1656 1657 /* 1658 * As part of zfs_expand_proplist(), we keep track of the maximum column 1659 * width for each property. For the 'NAME' (and 'SOURCE') columns, we 1660 * need to know the maximum name length. However, the user likely did 1661 * not specify 'name' as one of the properties to fetch, so we need to 1662 * make sure we always include at least this property for 1663 * print_get_headers() to work properly. 1664 */ 1665 if (cb.cb_proplist != NULL) { 1666 fake_name.pl_prop = ZFS_PROP_NAME; 1667 fake_name.pl_width = strlen(gettext("NAME")); 1668 fake_name.pl_next = cb.cb_proplist; 1669 cb.cb_proplist = &fake_name; 1670 } 1671 1672 cb.cb_first = B_TRUE; 1673 1674 /* run for each object */ 1675 ret = zfs_for_each(argc, argv, flags, types, NULL, 1676 &cb.cb_proplist, limit, get_callback, &cb); 1677 1678 if (cb.cb_proplist == &fake_name) 1679 zprop_free_list(fake_name.pl_next); 1680 else 1681 zprop_free_list(cb.cb_proplist); 1682 1683 return (ret); 1684 } 1685 1686 /* 1687 * inherit [-rS] <property> <fs|vol> ... 1688 * 1689 * -r Recurse over all children 1690 * -S Revert to received value, if any 1691 * 1692 * For each dataset specified on the command line, inherit the given property 1693 * from its parent. Inheriting a property at the pool level will cause it to 1694 * use the default value. The '-r' flag will recurse over all children, and is 1695 * useful for setting a property on a hierarchy-wide basis, regardless of any 1696 * local modifications for each dataset. 1697 */ 1698 1699 typedef struct inherit_cbdata { 1700 const char *cb_propname; 1701 boolean_t cb_received; 1702 } inherit_cbdata_t; 1703 1704 static int 1705 inherit_recurse_cb(zfs_handle_t *zhp, void *data) 1706 { 1707 inherit_cbdata_t *cb = data; 1708 zfs_prop_t prop = zfs_name_to_prop(cb->cb_propname); 1709 1710 /* 1711 * If we're doing it recursively, then ignore properties that 1712 * are not valid for this type of dataset. 1713 */ 1714 if (prop != ZPROP_INVAL && 1715 !zfs_prop_valid_for_type(prop, zfs_get_type(zhp))) 1716 return (0); 1717 1718 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0); 1719 } 1720 1721 static int 1722 inherit_cb(zfs_handle_t *zhp, void *data) 1723 { 1724 inherit_cbdata_t *cb = data; 1725 1726 return (zfs_prop_inherit(zhp, cb->cb_propname, cb->cb_received) != 0); 1727 } 1728 1729 static int 1730 zfs_do_inherit(int argc, char **argv) 1731 { 1732 int c; 1733 zfs_prop_t prop; 1734 inherit_cbdata_t cb = { 0 }; 1735 char *propname; 1736 int ret = 0; 1737 int flags = 0; 1738 boolean_t received = B_FALSE; 1739 1740 /* check options */ 1741 while ((c = getopt(argc, argv, "rS")) != -1) { 1742 switch (c) { 1743 case 'r': 1744 flags |= ZFS_ITER_RECURSE; 1745 break; 1746 case 'S': 1747 received = B_TRUE; 1748 break; 1749 case '?': 1750 default: 1751 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1752 optopt); 1753 usage(B_FALSE); 1754 } 1755 } 1756 1757 argc -= optind; 1758 argv += optind; 1759 1760 /* check number of arguments */ 1761 if (argc < 1) { 1762 (void) fprintf(stderr, gettext("missing property argument\n")); 1763 usage(B_FALSE); 1764 } 1765 if (argc < 2) { 1766 (void) fprintf(stderr, gettext("missing dataset argument\n")); 1767 usage(B_FALSE); 1768 } 1769 1770 propname = argv[0]; 1771 argc--; 1772 argv++; 1773 1774 if ((prop = zfs_name_to_prop(propname)) != ZPROP_INVAL) { 1775 if (zfs_prop_readonly(prop)) { 1776 (void) fprintf(stderr, gettext( 1777 "%s property is read-only\n"), 1778 propname); 1779 return (1); 1780 } 1781 if (!zfs_prop_inheritable(prop) && !received) { 1782 (void) fprintf(stderr, gettext("'%s' property cannot " 1783 "be inherited\n"), propname); 1784 if (prop == ZFS_PROP_QUOTA || 1785 prop == ZFS_PROP_RESERVATION || 1786 prop == ZFS_PROP_REFQUOTA || 1787 prop == ZFS_PROP_REFRESERVATION) 1788 (void) fprintf(stderr, gettext("use 'zfs set " 1789 "%s=none' to clear\n"), propname); 1790 return (1); 1791 } 1792 if (received && (prop == ZFS_PROP_VOLSIZE || 1793 prop == ZFS_PROP_VERSION)) { 1794 (void) fprintf(stderr, gettext("'%s' property cannot " 1795 "be reverted to a received value\n"), propname); 1796 return (1); 1797 } 1798 } else if (!zfs_prop_user(propname)) { 1799 (void) fprintf(stderr, gettext("invalid property '%s'\n"), 1800 propname); 1801 usage(B_FALSE); 1802 } 1803 1804 cb.cb_propname = propname; 1805 cb.cb_received = received; 1806 1807 if (flags & ZFS_ITER_RECURSE) { 1808 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET, 1809 NULL, NULL, 0, inherit_recurse_cb, &cb); 1810 } else { 1811 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_DATASET, 1812 NULL, NULL, 0, inherit_cb, &cb); 1813 } 1814 1815 return (ret); 1816 } 1817 1818 typedef struct upgrade_cbdata { 1819 uint64_t cb_numupgraded; 1820 uint64_t cb_numsamegraded; 1821 uint64_t cb_numfailed; 1822 uint64_t cb_version; 1823 boolean_t cb_newer; 1824 boolean_t cb_foundone; 1825 char cb_lastfs[ZFS_MAXNAMELEN]; 1826 } upgrade_cbdata_t; 1827 1828 static int 1829 same_pool(zfs_handle_t *zhp, const char *name) 1830 { 1831 int len1 = strcspn(name, "/@"); 1832 const char *zhname = zfs_get_name(zhp); 1833 int len2 = strcspn(zhname, "/@"); 1834 1835 if (len1 != len2) 1836 return (B_FALSE); 1837 return (strncmp(name, zhname, len1) == 0); 1838 } 1839 1840 static int 1841 upgrade_list_callback(zfs_handle_t *zhp, void *data) 1842 { 1843 upgrade_cbdata_t *cb = data; 1844 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION); 1845 1846 /* list if it's old/new */ 1847 if ((!cb->cb_newer && version < ZPL_VERSION) || 1848 (cb->cb_newer && version > ZPL_VERSION)) { 1849 char *str; 1850 if (cb->cb_newer) { 1851 str = gettext("The following filesystems are " 1852 "formatted using a newer software version and\n" 1853 "cannot be accessed on the current system.\n\n"); 1854 } else { 1855 str = gettext("The following filesystems are " 1856 "out of date, and can be upgraded. After being\n" 1857 "upgraded, these filesystems (and any 'zfs send' " 1858 "streams generated from\n" 1859 "subsequent snapshots) will no longer be " 1860 "accessible by older software versions.\n\n"); 1861 } 1862 1863 if (!cb->cb_foundone) { 1864 (void) puts(str); 1865 (void) printf(gettext("VER FILESYSTEM\n")); 1866 (void) printf(gettext("--- ------------\n")); 1867 cb->cb_foundone = B_TRUE; 1868 } 1869 1870 (void) printf("%2u %s\n", version, zfs_get_name(zhp)); 1871 } 1872 1873 return (0); 1874 } 1875 1876 static int 1877 upgrade_set_callback(zfs_handle_t *zhp, void *data) 1878 { 1879 upgrade_cbdata_t *cb = data; 1880 int version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION); 1881 int needed_spa_version; 1882 int spa_version; 1883 1884 if (zfs_spa_version(zhp, &spa_version) < 0) 1885 return (-1); 1886 1887 needed_spa_version = zfs_spa_version_map(cb->cb_version); 1888 1889 if (needed_spa_version < 0) 1890 return (-1); 1891 1892 if (spa_version < needed_spa_version) { 1893 /* can't upgrade */ 1894 (void) printf(gettext("%s: can not be " 1895 "upgraded; the pool version needs to first " 1896 "be upgraded\nto version %d\n\n"), 1897 zfs_get_name(zhp), needed_spa_version); 1898 cb->cb_numfailed++; 1899 return (0); 1900 } 1901 1902 /* upgrade */ 1903 if (version < cb->cb_version) { 1904 char verstr[16]; 1905 (void) snprintf(verstr, sizeof (verstr), 1906 "%llu", cb->cb_version); 1907 if (cb->cb_lastfs[0] && !same_pool(zhp, cb->cb_lastfs)) { 1908 /* 1909 * If they did "zfs upgrade -a", then we could 1910 * be doing ioctls to different pools. We need 1911 * to log this history once to each pool, and bypass 1912 * the normal history logging that happens in main(). 1913 */ 1914 (void) zpool_log_history(g_zfs, history_str); 1915 log_history = B_FALSE; 1916 } 1917 if (zfs_prop_set(zhp, "version", verstr) == 0) 1918 cb->cb_numupgraded++; 1919 else 1920 cb->cb_numfailed++; 1921 (void) strcpy(cb->cb_lastfs, zfs_get_name(zhp)); 1922 } else if (version > cb->cb_version) { 1923 /* can't downgrade */ 1924 (void) printf(gettext("%s: can not be downgraded; " 1925 "it is already at version %u\n"), 1926 zfs_get_name(zhp), version); 1927 cb->cb_numfailed++; 1928 } else { 1929 cb->cb_numsamegraded++; 1930 } 1931 return (0); 1932 } 1933 1934 /* 1935 * zfs upgrade 1936 * zfs upgrade -v 1937 * zfs upgrade [-r] [-V <version>] <-a | filesystem> 1938 */ 1939 static int 1940 zfs_do_upgrade(int argc, char **argv) 1941 { 1942 boolean_t all = B_FALSE; 1943 boolean_t showversions = B_FALSE; 1944 int ret = 0; 1945 upgrade_cbdata_t cb = { 0 }; 1946 char c; 1947 int flags = ZFS_ITER_ARGS_CAN_BE_PATHS; 1948 1949 /* check options */ 1950 while ((c = getopt(argc, argv, "rvV:a")) != -1) { 1951 switch (c) { 1952 case 'r': 1953 flags |= ZFS_ITER_RECURSE; 1954 break; 1955 case 'v': 1956 showversions = B_TRUE; 1957 break; 1958 case 'V': 1959 if (zfs_prop_string_to_index(ZFS_PROP_VERSION, 1960 optarg, &cb.cb_version) != 0) { 1961 (void) fprintf(stderr, 1962 gettext("invalid version %s\n"), optarg); 1963 usage(B_FALSE); 1964 } 1965 break; 1966 case 'a': 1967 all = B_TRUE; 1968 break; 1969 case '?': 1970 default: 1971 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 1972 optopt); 1973 usage(B_FALSE); 1974 } 1975 } 1976 1977 argc -= optind; 1978 argv += optind; 1979 1980 if ((!all && !argc) && ((flags & ZFS_ITER_RECURSE) | cb.cb_version)) 1981 usage(B_FALSE); 1982 if (showversions && (flags & ZFS_ITER_RECURSE || all || 1983 cb.cb_version || argc)) 1984 usage(B_FALSE); 1985 if ((all || argc) && (showversions)) 1986 usage(B_FALSE); 1987 if (all && argc) 1988 usage(B_FALSE); 1989 1990 if (showversions) { 1991 /* Show info on available versions. */ 1992 (void) printf(gettext("The following filesystem versions are " 1993 "supported:\n\n")); 1994 (void) printf(gettext("VER DESCRIPTION\n")); 1995 (void) printf("--- -----------------------------------------" 1996 "---------------\n"); 1997 (void) printf(gettext(" 1 Initial ZFS filesystem version\n")); 1998 (void) printf(gettext(" 2 Enhanced directory entries\n")); 1999 (void) printf(gettext(" 3 Case insensitive and filesystem " 2000 "user identifier (FUID)\n")); 2001 (void) printf(gettext(" 4 userquota, groupquota " 2002 "properties\n")); 2003 (void) printf(gettext(" 5 System attributes\n")); 2004 (void) printf(gettext("\nFor more information on a particular " 2005 "version, including supported releases,\n")); 2006 (void) printf("see the ZFS Administration Guide.\n\n"); 2007 ret = 0; 2008 } else if (argc || all) { 2009 /* Upgrade filesystems */ 2010 if (cb.cb_version == 0) 2011 cb.cb_version = ZPL_VERSION; 2012 ret = zfs_for_each(argc, argv, flags, ZFS_TYPE_FILESYSTEM, 2013 NULL, NULL, 0, upgrade_set_callback, &cb); 2014 (void) printf(gettext("%llu filesystems upgraded\n"), 2015 cb.cb_numupgraded); 2016 if (cb.cb_numsamegraded) { 2017 (void) printf(gettext("%llu filesystems already at " 2018 "this version\n"), 2019 cb.cb_numsamegraded); 2020 } 2021 if (cb.cb_numfailed != 0) 2022 ret = 1; 2023 } else { 2024 /* List old-version filesytems */ 2025 boolean_t found; 2026 (void) printf(gettext("This system is currently running " 2027 "ZFS filesystem version %llu.\n\n"), ZPL_VERSION); 2028 2029 flags |= ZFS_ITER_RECURSE; 2030 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM, 2031 NULL, NULL, 0, upgrade_list_callback, &cb); 2032 2033 found = cb.cb_foundone; 2034 cb.cb_foundone = B_FALSE; 2035 cb.cb_newer = B_TRUE; 2036 2037 ret = zfs_for_each(0, NULL, flags, ZFS_TYPE_FILESYSTEM, 2038 NULL, NULL, 0, upgrade_list_callback, &cb); 2039 2040 if (!cb.cb_foundone && !found) { 2041 (void) printf(gettext("All filesystems are " 2042 "formatted with the current version.\n")); 2043 } 2044 } 2045 2046 return (ret); 2047 } 2048 2049 /* 2050 * zfs userspace [-Hinp] [-o field[,...]] [-s field [-s field]...] 2051 * [-S field [-S field]...] [-t type[,...]] filesystem | snapshot 2052 * zfs groupspace [-Hinp] [-o field[,...]] [-s field [-s field]...] 2053 * [-S field [-S field]...] [-t type[,...]] filesystem | snapshot 2054 * 2055 * -H Scripted mode; elide headers and separate columns by tabs. 2056 * -i Translate SID to POSIX ID. 2057 * -n Print numeric ID instead of user/group name. 2058 * -o Control which fields to display. 2059 * -p Use exact (parseable) numeric output. 2060 * -s Specify sort columns, descending order. 2061 * -S Specify sort columns, ascending order. 2062 * -t Control which object types to display. 2063 * 2064 * Displays space consumed by, and quotas on, each user in the specified 2065 * filesystem or snapshot. 2066 */ 2067 2068 /* us_field_types, us_field_hdr and us_field_names should be kept in sync */ 2069 enum us_field_types { 2070 USFIELD_TYPE, 2071 USFIELD_NAME, 2072 USFIELD_USED, 2073 USFIELD_QUOTA 2074 }; 2075 static char *us_field_hdr[] = { "TYPE", "NAME", "USED", "QUOTA" }; 2076 static char *us_field_names[] = { "type", "name", "used", "quota" }; 2077 #define USFIELD_LAST (sizeof (us_field_names) / sizeof (char *)) 2078 2079 #define USTYPE_PSX_GRP (1 << 0) 2080 #define USTYPE_PSX_USR (1 << 1) 2081 #define USTYPE_SMB_GRP (1 << 2) 2082 #define USTYPE_SMB_USR (1 << 3) 2083 #define USTYPE_ALL \ 2084 (USTYPE_PSX_GRP | USTYPE_PSX_USR | USTYPE_SMB_GRP | USTYPE_SMB_USR) 2085 2086 static int us_type_bits[] = { 2087 USTYPE_PSX_GRP, 2088 USTYPE_PSX_USR, 2089 USTYPE_SMB_GRP, 2090 USTYPE_SMB_USR, 2091 USTYPE_ALL 2092 }; 2093 static char *us_type_names[] = { "posixgroup", "posxiuser", "smbgroup", 2094 "smbuser", "all" }; 2095 2096 typedef struct us_node { 2097 nvlist_t *usn_nvl; 2098 uu_avl_node_t usn_avlnode; 2099 uu_list_node_t usn_listnode; 2100 } us_node_t; 2101 2102 typedef struct us_cbdata { 2103 nvlist_t **cb_nvlp; 2104 uu_avl_pool_t *cb_avl_pool; 2105 uu_avl_t *cb_avl; 2106 boolean_t cb_numname; 2107 boolean_t cb_nicenum; 2108 boolean_t cb_sid2posix; 2109 zfs_userquota_prop_t cb_prop; 2110 zfs_sort_column_t *cb_sortcol; 2111 size_t cb_width[USFIELD_LAST]; 2112 } us_cbdata_t; 2113 2114 static boolean_t us_populated = B_FALSE; 2115 2116 typedef struct { 2117 zfs_sort_column_t *si_sortcol; 2118 boolean_t si_numname; 2119 } us_sort_info_t; 2120 2121 static int 2122 us_field_index(char *field) 2123 { 2124 int i; 2125 2126 for (i = 0; i < USFIELD_LAST; i++) { 2127 if (strcmp(field, us_field_names[i]) == 0) 2128 return (i); 2129 } 2130 2131 return (-1); 2132 } 2133 2134 static int 2135 us_compare(const void *larg, const void *rarg, void *unused) 2136 { 2137 const us_node_t *l = larg; 2138 const us_node_t *r = rarg; 2139 us_sort_info_t *si = (us_sort_info_t *)unused; 2140 zfs_sort_column_t *sortcol = si->si_sortcol; 2141 boolean_t numname = si->si_numname; 2142 nvlist_t *lnvl = l->usn_nvl; 2143 nvlist_t *rnvl = r->usn_nvl; 2144 int rc = 0; 2145 boolean_t lvb, rvb; 2146 2147 for (; sortcol != NULL; sortcol = sortcol->sc_next) { 2148 char *lvstr = ""; 2149 char *rvstr = ""; 2150 uint32_t lv32 = 0; 2151 uint32_t rv32 = 0; 2152 uint64_t lv64 = 0; 2153 uint64_t rv64 = 0; 2154 zfs_prop_t prop = sortcol->sc_prop; 2155 const char *propname = NULL; 2156 boolean_t reverse = sortcol->sc_reverse; 2157 2158 switch (prop) { 2159 case ZFS_PROP_TYPE: 2160 propname = "type"; 2161 (void) nvlist_lookup_uint32(lnvl, propname, &lv32); 2162 (void) nvlist_lookup_uint32(rnvl, propname, &rv32); 2163 if (rv32 != lv32) 2164 rc = (rv32 < lv32) ? 1 : -1; 2165 break; 2166 case ZFS_PROP_NAME: 2167 propname = "name"; 2168 if (numname) { 2169 (void) nvlist_lookup_uint64(lnvl, propname, 2170 &lv64); 2171 (void) nvlist_lookup_uint64(rnvl, propname, 2172 &rv64); 2173 if (rv64 != lv64) 2174 rc = (rv64 < lv64) ? 1 : -1; 2175 } else { 2176 (void) nvlist_lookup_string(lnvl, propname, 2177 &lvstr); 2178 (void) nvlist_lookup_string(rnvl, propname, 2179 &rvstr); 2180 rc = strcmp(lvstr, rvstr); 2181 } 2182 break; 2183 case ZFS_PROP_USED: 2184 case ZFS_PROP_QUOTA: 2185 if (!us_populated) 2186 break; 2187 if (prop == ZFS_PROP_USED) 2188 propname = "used"; 2189 else 2190 propname = "quota"; 2191 (void) nvlist_lookup_uint64(lnvl, propname, &lv64); 2192 (void) nvlist_lookup_uint64(rnvl, propname, &rv64); 2193 if (rv64 != lv64) 2194 rc = (rv64 < lv64) ? 1 : -1; 2195 break; 2196 } 2197 2198 if (rc != 0) { 2199 if (rc < 0) 2200 return (reverse ? 1 : -1); 2201 else 2202 return (reverse ? -1 : 1); 2203 } 2204 } 2205 2206 /* 2207 * If entries still seem to be the same, check if they are of the same 2208 * type (smbentity is added only if we are doing SID to POSIX ID 2209 * translation where we can have duplicate type/name combinations). 2210 */ 2211 if (nvlist_lookup_boolean_value(lnvl, "smbentity", &lvb) == 0 && 2212 nvlist_lookup_boolean_value(rnvl, "smbentity", &rvb) == 0 && 2213 lvb != rvb) 2214 return (lvb < rvb ? -1 : 1); 2215 2216 return (0); 2217 } 2218 2219 static inline const char * 2220 us_type2str(unsigned field_type) 2221 { 2222 switch (field_type) { 2223 case USTYPE_PSX_USR: 2224 return ("POSIX User"); 2225 case USTYPE_PSX_GRP: 2226 return ("POSIX Group"); 2227 case USTYPE_SMB_USR: 2228 return ("SMB User"); 2229 case USTYPE_SMB_GRP: 2230 return ("SMB Group"); 2231 default: 2232 return ("Undefined"); 2233 } 2234 } 2235 2236 static int 2237 userspace_cb(void *arg, const char *domain, uid_t rid, uint64_t space) 2238 { 2239 us_cbdata_t *cb = (us_cbdata_t *)arg; 2240 zfs_userquota_prop_t prop = cb->cb_prop; 2241 char *name = NULL; 2242 char *propname; 2243 char sizebuf[32]; 2244 us_node_t *node; 2245 uu_avl_pool_t *avl_pool = cb->cb_avl_pool; 2246 uu_avl_t *avl = cb->cb_avl; 2247 uu_avl_index_t idx; 2248 nvlist_t *props; 2249 us_node_t *n; 2250 zfs_sort_column_t *sortcol = cb->cb_sortcol; 2251 unsigned type; 2252 const char *typestr; 2253 size_t namelen; 2254 size_t typelen; 2255 size_t sizelen; 2256 int typeidx, nameidx, sizeidx; 2257 us_sort_info_t sortinfo = { sortcol, cb->cb_numname }; 2258 boolean_t smbentity = B_FALSE; 2259 2260 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) 2261 nomem(); 2262 node = safe_malloc(sizeof (us_node_t)); 2263 uu_avl_node_init(node, &node->usn_avlnode, avl_pool); 2264 node->usn_nvl = props; 2265 2266 if (domain != NULL && domain[0] != '\0') { 2267 /* SMB */ 2268 char sid[ZFS_MAXNAMELEN + 32]; 2269 uid_t id; 2270 uint64_t classes; 2271 int err; 2272 directory_error_t e; 2273 2274 smbentity = B_TRUE; 2275 2276 (void) snprintf(sid, sizeof (sid), "%s-%u", domain, rid); 2277 2278 if (prop == ZFS_PROP_GROUPUSED || prop == ZFS_PROP_GROUPQUOTA) { 2279 type = USTYPE_SMB_GRP; 2280 err = sid_to_id(sid, B_FALSE, &id); 2281 } else { 2282 type = USTYPE_SMB_USR; 2283 err = sid_to_id(sid, B_TRUE, &id); 2284 } 2285 2286 if (err == 0) { 2287 rid = id; 2288 if (!cb->cb_sid2posix) { 2289 e = directory_name_from_sid(NULL, sid, &name, 2290 &classes); 2291 if (e != NULL) 2292 directory_error_free(e); 2293 if (name == NULL) 2294 name = sid; 2295 } 2296 } 2297 } 2298 2299 if (cb->cb_sid2posix || domain == NULL || domain[0] == '\0') { 2300 /* POSIX or -i */ 2301 if (prop == ZFS_PROP_GROUPUSED || prop == ZFS_PROP_GROUPQUOTA) { 2302 type = USTYPE_PSX_GRP; 2303 if (!cb->cb_numname) { 2304 struct group *g; 2305 2306 if ((g = getgrgid(rid)) != NULL) 2307 name = g->gr_name; 2308 } 2309 } else { 2310 type = USTYPE_PSX_USR; 2311 if (!cb->cb_numname) { 2312 struct passwd *p; 2313 2314 if ((p = getpwuid(rid)) != NULL) 2315 name = p->pw_name; 2316 } 2317 } 2318 } 2319 2320 /* 2321 * Make sure that the type/name combination is unique when doing 2322 * SID to POSIX ID translation (hence changing the type from SMB to 2323 * POSIX). 2324 */ 2325 if (cb->cb_sid2posix && 2326 nvlist_add_boolean_value(props, "smbentity", smbentity) != 0) 2327 nomem(); 2328 2329 /* Calculate/update width of TYPE field */ 2330 typestr = us_type2str(type); 2331 typelen = strlen(gettext(typestr)); 2332 typeidx = us_field_index("type"); 2333 if (typelen > cb->cb_width[typeidx]) 2334 cb->cb_width[typeidx] = typelen; 2335 if (nvlist_add_uint32(props, "type", type) != 0) 2336 nomem(); 2337 2338 /* Calculate/update width of NAME field */ 2339 if ((cb->cb_numname && cb->cb_sid2posix) || name == NULL) { 2340 if (nvlist_add_uint64(props, "name", rid) != 0) 2341 nomem(); 2342 namelen = snprintf(NULL, 0, "%u", rid); 2343 } else { 2344 if (nvlist_add_string(props, "name", name) != 0) 2345 nomem(); 2346 namelen = strlen(name); 2347 } 2348 nameidx = us_field_index("name"); 2349 if (namelen > cb->cb_width[nameidx]) 2350 cb->cb_width[nameidx] = namelen; 2351 2352 /* 2353 * Check if this type/name combination is in the list and update it; 2354 * otherwise add new node to the list. 2355 */ 2356 if ((n = uu_avl_find(avl, node, &sortinfo, &idx)) == NULL) { 2357 uu_avl_insert(avl, node, idx); 2358 } else { 2359 nvlist_free(props); 2360 free(node); 2361 node = n; 2362 props = node->usn_nvl; 2363 } 2364 2365 /* Calculate/update width of USED/QUOTA fields */ 2366 if (cb->cb_nicenum) 2367 zfs_nicenum(space, sizebuf, sizeof (sizebuf)); 2368 else 2369 (void) snprintf(sizebuf, sizeof (sizebuf), "%llu", space); 2370 sizelen = strlen(sizebuf); 2371 if (prop == ZFS_PROP_USERUSED || prop == ZFS_PROP_GROUPUSED) { 2372 propname = "used"; 2373 if (!nvlist_exists(props, "quota")) 2374 (void) nvlist_add_uint64(props, "quota", 0); 2375 } else { 2376 propname = "quota"; 2377 if (!nvlist_exists(props, "used")) 2378 (void) nvlist_add_uint64(props, "used", 0); 2379 } 2380 sizeidx = us_field_index(propname); 2381 if (sizelen > cb->cb_width[sizeidx]) 2382 cb->cb_width[sizeidx] = sizelen; 2383 2384 if (nvlist_add_uint64(props, propname, space) != 0) 2385 nomem(); 2386 2387 return (0); 2388 } 2389 2390 static void 2391 print_us_node(boolean_t scripted, boolean_t parsable, int *fields, int types, 2392 size_t *width, us_node_t *node) 2393 { 2394 nvlist_t *nvl = node->usn_nvl; 2395 char valstr[ZFS_MAXNAMELEN]; 2396 boolean_t first = B_TRUE; 2397 int cfield = 0; 2398 int field; 2399 uint32_t ustype; 2400 2401 /* Check type */ 2402 (void) nvlist_lookup_uint32(nvl, "type", &ustype); 2403 if (!(ustype & types)) 2404 return; 2405 2406 while ((field = fields[cfield]) != USFIELD_LAST) { 2407 nvpair_t *nvp = NULL; 2408 data_type_t type; 2409 uint32_t val32; 2410 uint64_t val64; 2411 char *strval = NULL; 2412 2413 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) { 2414 if (strcmp(nvpair_name(nvp), 2415 us_field_names[field]) == 0) 2416 break; 2417 } 2418 2419 type = nvpair_type(nvp); 2420 switch (type) { 2421 case DATA_TYPE_UINT32: 2422 (void) nvpair_value_uint32(nvp, &val32); 2423 break; 2424 case DATA_TYPE_UINT64: 2425 (void) nvpair_value_uint64(nvp, &val64); 2426 break; 2427 case DATA_TYPE_STRING: 2428 (void) nvpair_value_string(nvp, &strval); 2429 break; 2430 default: 2431 (void) fprintf(stderr, "invalid data type\n"); 2432 } 2433 2434 switch (field) { 2435 case USFIELD_TYPE: 2436 strval = (char *)us_type2str(val32); 2437 break; 2438 case USFIELD_NAME: 2439 if (type == DATA_TYPE_UINT64) { 2440 (void) sprintf(valstr, "%llu", val64); 2441 strval = valstr; 2442 } 2443 break; 2444 case USFIELD_USED: 2445 case USFIELD_QUOTA: 2446 if (type == DATA_TYPE_UINT64) { 2447 if (parsable) { 2448 (void) sprintf(valstr, "%llu", val64); 2449 } else { 2450 zfs_nicenum(val64, valstr, 2451 sizeof (valstr)); 2452 } 2453 if (field == USFIELD_QUOTA && 2454 strcmp(valstr, "0") == 0) 2455 strval = "none"; 2456 else 2457 strval = valstr; 2458 } 2459 break; 2460 } 2461 2462 if (!first) { 2463 if (scripted) 2464 (void) printf("\t"); 2465 else 2466 (void) printf(" "); 2467 } 2468 if (scripted) 2469 (void) printf("%s", strval); 2470 else if (field == USFIELD_TYPE || field == USFIELD_NAME) 2471 (void) printf("%-*s", width[field], strval); 2472 else 2473 (void) printf("%*s", width[field], strval); 2474 2475 first = B_FALSE; 2476 cfield++; 2477 } 2478 2479 (void) printf("\n"); 2480 } 2481 2482 static void 2483 print_us(boolean_t scripted, boolean_t parsable, int *fields, int types, 2484 size_t *width, boolean_t rmnode, uu_avl_t *avl) 2485 { 2486 us_node_t *node; 2487 const char *col; 2488 int cfield = 0; 2489 int field; 2490 2491 if (!scripted) { 2492 boolean_t first = B_TRUE; 2493 2494 while ((field = fields[cfield]) != USFIELD_LAST) { 2495 col = gettext(us_field_hdr[field]); 2496 if (field == USFIELD_TYPE || field == USFIELD_NAME) { 2497 (void) printf(first ? "%-*s" : " %-*s", 2498 width[field], col); 2499 } else { 2500 (void) printf(first ? "%*s" : " %*s", 2501 width[field], col); 2502 } 2503 first = B_FALSE; 2504 cfield++; 2505 } 2506 (void) printf("\n"); 2507 } 2508 2509 for (node = uu_avl_first(avl); node; node = uu_avl_next(avl, node)) { 2510 print_us_node(scripted, parsable, fields, types, width, node); 2511 if (rmnode) 2512 nvlist_free(node->usn_nvl); 2513 } 2514 } 2515 2516 static int 2517 zfs_do_userspace(int argc, char **argv) 2518 { 2519 zfs_handle_t *zhp; 2520 zfs_userquota_prop_t p; 2521 uu_avl_pool_t *avl_pool; 2522 uu_avl_t *avl_tree; 2523 uu_avl_walk_t *walk; 2524 char *delim; 2525 char deffields[] = "type,name,used,quota"; 2526 char *ofield = NULL; 2527 char *tfield = NULL; 2528 int cfield = 0; 2529 int fields[256]; 2530 int i; 2531 boolean_t scripted = B_FALSE; 2532 boolean_t prtnum = B_FALSE; 2533 boolean_t parsable = B_FALSE; 2534 boolean_t sid2posix = B_FALSE; 2535 int ret = 0; 2536 int c; 2537 zfs_sort_column_t *sortcol = NULL; 2538 int types = USTYPE_PSX_USR | USTYPE_SMB_USR; 2539 us_cbdata_t cb; 2540 us_node_t *node; 2541 us_node_t *rmnode; 2542 uu_list_pool_t *listpool; 2543 uu_list_t *list; 2544 uu_avl_index_t idx = 0; 2545 uu_list_index_t idx2 = 0; 2546 2547 if (argc < 2) 2548 usage(B_FALSE); 2549 2550 if (strcmp(argv[0], "groupspace") == 0) 2551 /* Toggle default group types */ 2552 types = USTYPE_PSX_GRP | USTYPE_SMB_GRP; 2553 2554 while ((c = getopt(argc, argv, "nHpo:s:S:t:i")) != -1) { 2555 switch (c) { 2556 case 'n': 2557 prtnum = B_TRUE; 2558 break; 2559 case 'H': 2560 scripted = B_TRUE; 2561 break; 2562 case 'p': 2563 parsable = B_TRUE; 2564 break; 2565 case 'o': 2566 ofield = optarg; 2567 break; 2568 case 's': 2569 case 'S': 2570 if (zfs_add_sort_column(&sortcol, optarg, 2571 c == 's' ? B_FALSE : B_TRUE) != 0) { 2572 (void) fprintf(stderr, 2573 gettext("invalid field '%s'\n"), optarg); 2574 usage(B_FALSE); 2575 } 2576 break; 2577 case 't': 2578 tfield = optarg; 2579 break; 2580 case 'i': 2581 sid2posix = B_TRUE; 2582 break; 2583 case ':': 2584 (void) fprintf(stderr, gettext("missing argument for " 2585 "'%c' option\n"), optopt); 2586 usage(B_FALSE); 2587 break; 2588 case '?': 2589 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2590 optopt); 2591 usage(B_FALSE); 2592 } 2593 } 2594 2595 argc -= optind; 2596 argv += optind; 2597 2598 if (argc < 1) { 2599 (void) fprintf(stderr, gettext("missing dataset name\n")); 2600 usage(B_FALSE); 2601 } 2602 if (argc > 1) { 2603 (void) fprintf(stderr, gettext("too many arguments\n")); 2604 usage(B_FALSE); 2605 } 2606 2607 /* Use default output fields if not specified using -o */ 2608 if (ofield == NULL) 2609 ofield = deffields; 2610 do { 2611 if ((delim = strchr(ofield, ',')) != NULL) 2612 *delim = '\0'; 2613 if ((fields[cfield++] = us_field_index(ofield)) == -1) { 2614 (void) fprintf(stderr, gettext("invalid type '%s' " 2615 "for -o option\n"), ofield); 2616 return (-1); 2617 } 2618 if (delim != NULL) 2619 ofield = delim + 1; 2620 } while (delim != NULL); 2621 fields[cfield] = USFIELD_LAST; 2622 2623 /* Override output types (-t option) */ 2624 if (tfield != NULL) { 2625 types = 0; 2626 2627 do { 2628 boolean_t found = B_FALSE; 2629 2630 if ((delim = strchr(tfield, ',')) != NULL) 2631 *delim = '\0'; 2632 for (i = 0; i < sizeof (us_type_bits) / sizeof (int); 2633 i++) { 2634 if (strcmp(tfield, us_type_names[i]) == 0) { 2635 found = B_TRUE; 2636 types |= us_type_bits[i]; 2637 break; 2638 } 2639 } 2640 if (!found) { 2641 (void) fprintf(stderr, gettext("invalid type " 2642 "'%s' for -t option\n"), tfield); 2643 return (-1); 2644 } 2645 if (delim != NULL) 2646 tfield = delim + 1; 2647 } while (delim != NULL); 2648 } 2649 2650 if ((zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_DATASET)) == NULL) 2651 return (1); 2652 2653 if ((avl_pool = uu_avl_pool_create("us_avl_pool", sizeof (us_node_t), 2654 offsetof(us_node_t, usn_avlnode), us_compare, UU_DEFAULT)) == NULL) 2655 nomem(); 2656 if ((avl_tree = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL) 2657 nomem(); 2658 2659 /* Always add default sorting columns */ 2660 (void) zfs_add_sort_column(&sortcol, "type", B_FALSE); 2661 (void) zfs_add_sort_column(&sortcol, "name", B_FALSE); 2662 2663 cb.cb_sortcol = sortcol; 2664 cb.cb_numname = prtnum; 2665 cb.cb_nicenum = !parsable; 2666 cb.cb_avl_pool = avl_pool; 2667 cb.cb_avl = avl_tree; 2668 cb.cb_sid2posix = sid2posix; 2669 2670 for (i = 0; i < USFIELD_LAST; i++) 2671 cb.cb_width[i] = strlen(gettext(us_field_hdr[i])); 2672 2673 for (p = 0; p < ZFS_NUM_USERQUOTA_PROPS; p++) { 2674 if (((p == ZFS_PROP_USERUSED || p == ZFS_PROP_USERQUOTA) && 2675 !(types & (USTYPE_PSX_USR | USTYPE_SMB_USR))) || 2676 ((p == ZFS_PROP_GROUPUSED || p == ZFS_PROP_GROUPQUOTA) && 2677 !(types & (USTYPE_PSX_GRP | USTYPE_SMB_GRP)))) 2678 continue; 2679 cb.cb_prop = p; 2680 if ((ret = zfs_userspace(zhp, p, userspace_cb, &cb)) != 0) 2681 return (ret); 2682 } 2683 2684 /* Sort the list */ 2685 if ((node = uu_avl_first(avl_tree)) == NULL) 2686 return (0); 2687 2688 us_populated = B_TRUE; 2689 2690 listpool = uu_list_pool_create("tmplist", sizeof (us_node_t), 2691 offsetof(us_node_t, usn_listnode), NULL, UU_DEFAULT); 2692 list = uu_list_create(listpool, NULL, UU_DEFAULT); 2693 uu_list_node_init(node, &node->usn_listnode, listpool); 2694 2695 while (node != NULL) { 2696 rmnode = node; 2697 node = uu_avl_next(avl_tree, node); 2698 uu_avl_remove(avl_tree, rmnode); 2699 if (uu_list_find(list, rmnode, NULL, &idx2) == NULL) 2700 uu_list_insert(list, rmnode, idx2); 2701 } 2702 2703 for (node = uu_list_first(list); node != NULL; 2704 node = uu_list_next(list, node)) { 2705 us_sort_info_t sortinfo = { sortcol, cb.cb_numname }; 2706 2707 if (uu_avl_find(avl_tree, node, &sortinfo, &idx) == NULL) 2708 uu_avl_insert(avl_tree, node, idx); 2709 } 2710 2711 uu_list_destroy(list); 2712 uu_list_pool_destroy(listpool); 2713 2714 /* Print and free node nvlist memory */ 2715 print_us(scripted, parsable, fields, types, cb.cb_width, B_TRUE, 2716 cb.cb_avl); 2717 2718 zfs_free_sort_columns(sortcol); 2719 2720 /* Clean up the AVL tree */ 2721 if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL) 2722 nomem(); 2723 2724 while ((node = uu_avl_walk_next(walk)) != NULL) { 2725 uu_avl_remove(cb.cb_avl, node); 2726 free(node); 2727 } 2728 2729 uu_avl_walk_end(walk); 2730 uu_avl_destroy(avl_tree); 2731 uu_avl_pool_destroy(avl_pool); 2732 2733 return (ret); 2734 } 2735 2736 /* 2737 * list [-r][-d max] [-H] [-o property[,property]...] [-t type[,type]...] 2738 * [-s property [-s property]...] [-S property [-S property]...] 2739 * <dataset> ... 2740 * 2741 * -r Recurse over all children 2742 * -d Limit recursion by depth. 2743 * -H Scripted mode; elide headers and separate columns by tabs 2744 * -o Control which fields to display. 2745 * -t Control which object types to display. 2746 * -s Specify sort columns, descending order. 2747 * -S Specify sort columns, ascending order. 2748 * 2749 * When given no arguments, lists all filesystems in the system. 2750 * Otherwise, list the specified datasets, optionally recursing down them if 2751 * '-r' is specified. 2752 */ 2753 typedef struct list_cbdata { 2754 boolean_t cb_first; 2755 boolean_t cb_scripted; 2756 zprop_list_t *cb_proplist; 2757 } list_cbdata_t; 2758 2759 /* 2760 * Given a list of columns to display, output appropriate headers for each one. 2761 */ 2762 static void 2763 print_header(zprop_list_t *pl) 2764 { 2765 char headerbuf[ZFS_MAXPROPLEN]; 2766 const char *header; 2767 int i; 2768 boolean_t first = B_TRUE; 2769 boolean_t right_justify; 2770 2771 for (; pl != NULL; pl = pl->pl_next) { 2772 if (!first) { 2773 (void) printf(" "); 2774 } else { 2775 first = B_FALSE; 2776 } 2777 2778 right_justify = B_FALSE; 2779 if (pl->pl_prop != ZPROP_INVAL) { 2780 header = zfs_prop_column_name(pl->pl_prop); 2781 right_justify = zfs_prop_align_right(pl->pl_prop); 2782 } else { 2783 for (i = 0; pl->pl_user_prop[i] != '\0'; i++) 2784 headerbuf[i] = toupper(pl->pl_user_prop[i]); 2785 headerbuf[i] = '\0'; 2786 header = headerbuf; 2787 } 2788 2789 if (pl->pl_next == NULL && !right_justify) 2790 (void) printf("%s", header); 2791 else if (right_justify) 2792 (void) printf("%*s", pl->pl_width, header); 2793 else 2794 (void) printf("%-*s", pl->pl_width, header); 2795 } 2796 2797 (void) printf("\n"); 2798 } 2799 2800 /* 2801 * Given a dataset and a list of fields, print out all the properties according 2802 * to the described layout. 2803 */ 2804 static void 2805 print_dataset(zfs_handle_t *zhp, zprop_list_t *pl, boolean_t scripted) 2806 { 2807 boolean_t first = B_TRUE; 2808 char property[ZFS_MAXPROPLEN]; 2809 nvlist_t *userprops = zfs_get_user_props(zhp); 2810 nvlist_t *propval; 2811 char *propstr; 2812 boolean_t right_justify; 2813 int width; 2814 2815 for (; pl != NULL; pl = pl->pl_next) { 2816 if (!first) { 2817 if (scripted) 2818 (void) printf("\t"); 2819 else 2820 (void) printf(" "); 2821 } else { 2822 first = B_FALSE; 2823 } 2824 2825 if (pl->pl_prop != ZPROP_INVAL) { 2826 if (zfs_prop_get(zhp, pl->pl_prop, property, 2827 sizeof (property), NULL, NULL, 0, B_FALSE) != 0) 2828 propstr = "-"; 2829 else 2830 propstr = property; 2831 2832 right_justify = zfs_prop_align_right(pl->pl_prop); 2833 } else if (zfs_prop_userquota(pl->pl_user_prop)) { 2834 if (zfs_prop_get_userquota(zhp, pl->pl_user_prop, 2835 property, sizeof (property), B_FALSE) != 0) 2836 propstr = "-"; 2837 else 2838 propstr = property; 2839 right_justify = B_TRUE; 2840 } else if (zfs_prop_written(pl->pl_user_prop)) { 2841 if (zfs_prop_get_written(zhp, pl->pl_user_prop, 2842 property, sizeof (property), B_FALSE) != 0) 2843 propstr = "-"; 2844 else 2845 propstr = property; 2846 right_justify = B_TRUE; 2847 } else { 2848 if (nvlist_lookup_nvlist(userprops, 2849 pl->pl_user_prop, &propval) != 0) 2850 propstr = "-"; 2851 else 2852 verify(nvlist_lookup_string(propval, 2853 ZPROP_VALUE, &propstr) == 0); 2854 right_justify = B_FALSE; 2855 } 2856 2857 width = pl->pl_width; 2858 2859 /* 2860 * If this is being called in scripted mode, or if this is the 2861 * last column and it is left-justified, don't include a width 2862 * format specifier. 2863 */ 2864 if (scripted || (pl->pl_next == NULL && !right_justify)) 2865 (void) printf("%s", propstr); 2866 else if (right_justify) 2867 (void) printf("%*s", width, propstr); 2868 else 2869 (void) printf("%-*s", width, propstr); 2870 } 2871 2872 (void) printf("\n"); 2873 } 2874 2875 /* 2876 * Generic callback function to list a dataset or snapshot. 2877 */ 2878 static int 2879 list_callback(zfs_handle_t *zhp, void *data) 2880 { 2881 list_cbdata_t *cbp = data; 2882 2883 if (cbp->cb_first) { 2884 if (!cbp->cb_scripted) 2885 print_header(cbp->cb_proplist); 2886 cbp->cb_first = B_FALSE; 2887 } 2888 2889 print_dataset(zhp, cbp->cb_proplist, cbp->cb_scripted); 2890 2891 return (0); 2892 } 2893 2894 static int 2895 zfs_do_list(int argc, char **argv) 2896 { 2897 int c; 2898 boolean_t scripted = B_FALSE; 2899 static char default_fields[] = 2900 "name,used,available,referenced,mountpoint"; 2901 int types = ZFS_TYPE_DATASET; 2902 boolean_t types_specified = B_FALSE; 2903 char *fields = NULL; 2904 list_cbdata_t cb = { 0 }; 2905 char *value; 2906 int limit = 0; 2907 int ret = 0; 2908 zfs_sort_column_t *sortcol = NULL; 2909 int flags = ZFS_ITER_PROP_LISTSNAPS | ZFS_ITER_ARGS_CAN_BE_PATHS; 2910 2911 /* check options */ 2912 while ((c = getopt(argc, argv, ":d:o:rt:Hs:S:")) != -1) { 2913 switch (c) { 2914 case 'o': 2915 fields = optarg; 2916 break; 2917 case 'd': 2918 limit = parse_depth(optarg, &flags); 2919 break; 2920 case 'r': 2921 flags |= ZFS_ITER_RECURSE; 2922 break; 2923 case 'H': 2924 scripted = B_TRUE; 2925 break; 2926 case 's': 2927 if (zfs_add_sort_column(&sortcol, optarg, 2928 B_FALSE) != 0) { 2929 (void) fprintf(stderr, 2930 gettext("invalid property '%s'\n"), optarg); 2931 usage(B_FALSE); 2932 } 2933 break; 2934 case 'S': 2935 if (zfs_add_sort_column(&sortcol, optarg, 2936 B_TRUE) != 0) { 2937 (void) fprintf(stderr, 2938 gettext("invalid property '%s'\n"), optarg); 2939 usage(B_FALSE); 2940 } 2941 break; 2942 case 't': 2943 types = 0; 2944 types_specified = B_TRUE; 2945 flags &= ~ZFS_ITER_PROP_LISTSNAPS; 2946 while (*optarg != '\0') { 2947 static char *type_subopts[] = { "filesystem", 2948 "volume", "snapshot", "all", NULL }; 2949 2950 switch (getsubopt(&optarg, type_subopts, 2951 &value)) { 2952 case 0: 2953 types |= ZFS_TYPE_FILESYSTEM; 2954 break; 2955 case 1: 2956 types |= ZFS_TYPE_VOLUME; 2957 break; 2958 case 2: 2959 types |= ZFS_TYPE_SNAPSHOT; 2960 break; 2961 case 3: 2962 types = ZFS_TYPE_DATASET; 2963 break; 2964 2965 default: 2966 (void) fprintf(stderr, 2967 gettext("invalid type '%s'\n"), 2968 value); 2969 usage(B_FALSE); 2970 } 2971 } 2972 break; 2973 case ':': 2974 (void) fprintf(stderr, gettext("missing argument for " 2975 "'%c' option\n"), optopt); 2976 usage(B_FALSE); 2977 break; 2978 case '?': 2979 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 2980 optopt); 2981 usage(B_FALSE); 2982 } 2983 } 2984 2985 argc -= optind; 2986 argv += optind; 2987 2988 if (fields == NULL) 2989 fields = default_fields; 2990 2991 /* 2992 * If "-o space" and no types were specified, don't display snapshots. 2993 */ 2994 if (strcmp(fields, "space") == 0 && types_specified == B_FALSE) 2995 types &= ~ZFS_TYPE_SNAPSHOT; 2996 2997 /* 2998 * If the user specifies '-o all', the zprop_get_list() doesn't 2999 * normally include the name of the dataset. For 'zfs list', we always 3000 * want this property to be first. 3001 */ 3002 if (zprop_get_list(g_zfs, fields, &cb.cb_proplist, ZFS_TYPE_DATASET) 3003 != 0) 3004 usage(B_FALSE); 3005 3006 cb.cb_scripted = scripted; 3007 cb.cb_first = B_TRUE; 3008 3009 ret = zfs_for_each(argc, argv, flags, types, sortcol, &cb.cb_proplist, 3010 limit, list_callback, &cb); 3011 3012 zprop_free_list(cb.cb_proplist); 3013 zfs_free_sort_columns(sortcol); 3014 3015 if (ret == 0 && cb.cb_first && !cb.cb_scripted) 3016 (void) printf(gettext("no datasets available\n")); 3017 3018 return (ret); 3019 } 3020 3021 /* 3022 * zfs rename [-f] <fs | snap | vol> <fs | snap | vol> 3023 * zfs rename [-f] -p <fs | vol> <fs | vol> 3024 * zfs rename -r <snap> <snap> 3025 * 3026 * Renames the given dataset to another of the same type. 3027 * 3028 * The '-p' flag creates all the non-existing ancestors of the target first. 3029 */ 3030 /* ARGSUSED */ 3031 static int 3032 zfs_do_rename(int argc, char **argv) 3033 { 3034 zfs_handle_t *zhp; 3035 int c; 3036 int ret = 0; 3037 boolean_t recurse = B_FALSE; 3038 boolean_t parents = B_FALSE; 3039 boolean_t force_unmount = B_FALSE; 3040 3041 /* check options */ 3042 while ((c = getopt(argc, argv, "prf")) != -1) { 3043 switch (c) { 3044 case 'p': 3045 parents = B_TRUE; 3046 break; 3047 case 'r': 3048 recurse = B_TRUE; 3049 break; 3050 case 'f': 3051 force_unmount = B_TRUE; 3052 break; 3053 case '?': 3054 default: 3055 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3056 optopt); 3057 usage(B_FALSE); 3058 } 3059 } 3060 3061 argc -= optind; 3062 argv += optind; 3063 3064 /* check number of arguments */ 3065 if (argc < 1) { 3066 (void) fprintf(stderr, gettext("missing source dataset " 3067 "argument\n")); 3068 usage(B_FALSE); 3069 } 3070 if (argc < 2) { 3071 (void) fprintf(stderr, gettext("missing target dataset " 3072 "argument\n")); 3073 usage(B_FALSE); 3074 } 3075 if (argc > 2) { 3076 (void) fprintf(stderr, gettext("too many arguments\n")); 3077 usage(B_FALSE); 3078 } 3079 3080 if (recurse && parents) { 3081 (void) fprintf(stderr, gettext("-p and -r options are mutually " 3082 "exclusive\n")); 3083 usage(B_FALSE); 3084 } 3085 3086 if (recurse && strchr(argv[0], '@') == 0) { 3087 (void) fprintf(stderr, gettext("source dataset for recursive " 3088 "rename must be a snapshot\n")); 3089 usage(B_FALSE); 3090 } 3091 3092 if ((zhp = zfs_open(g_zfs, argv[0], parents ? ZFS_TYPE_FILESYSTEM | 3093 ZFS_TYPE_VOLUME : ZFS_TYPE_DATASET)) == NULL) 3094 return (1); 3095 3096 /* If we were asked and the name looks good, try to create ancestors. */ 3097 if (parents && zfs_name_valid(argv[1], zfs_get_type(zhp)) && 3098 zfs_create_ancestors(g_zfs, argv[1]) != 0) { 3099 zfs_close(zhp); 3100 return (1); 3101 } 3102 3103 ret = (zfs_rename(zhp, argv[1], recurse, force_unmount) != 0); 3104 3105 zfs_close(zhp); 3106 return (ret); 3107 } 3108 3109 /* 3110 * zfs promote <fs> 3111 * 3112 * Promotes the given clone fs to be the parent 3113 */ 3114 /* ARGSUSED */ 3115 static int 3116 zfs_do_promote(int argc, char **argv) 3117 { 3118 zfs_handle_t *zhp; 3119 int ret = 0; 3120 3121 /* check options */ 3122 if (argc > 1 && argv[1][0] == '-') { 3123 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3124 argv[1][1]); 3125 usage(B_FALSE); 3126 } 3127 3128 /* check number of arguments */ 3129 if (argc < 2) { 3130 (void) fprintf(stderr, gettext("missing clone filesystem" 3131 " argument\n")); 3132 usage(B_FALSE); 3133 } 3134 if (argc > 2) { 3135 (void) fprintf(stderr, gettext("too many arguments\n")); 3136 usage(B_FALSE); 3137 } 3138 3139 zhp = zfs_open(g_zfs, argv[1], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 3140 if (zhp == NULL) 3141 return (1); 3142 3143 ret = (zfs_promote(zhp) != 0); 3144 3145 3146 zfs_close(zhp); 3147 return (ret); 3148 } 3149 3150 /* 3151 * zfs rollback [-rRf] <snapshot> 3152 * 3153 * -r Delete any intervening snapshots before doing rollback 3154 * -R Delete any snapshots and their clones 3155 * -f ignored for backwards compatability 3156 * 3157 * Given a filesystem, rollback to a specific snapshot, discarding any changes 3158 * since then and making it the active dataset. If more recent snapshots exist, 3159 * the command will complain unless the '-r' flag is given. 3160 */ 3161 typedef struct rollback_cbdata { 3162 uint64_t cb_create; 3163 boolean_t cb_first; 3164 int cb_doclones; 3165 char *cb_target; 3166 int cb_error; 3167 boolean_t cb_recurse; 3168 boolean_t cb_dependent; 3169 } rollback_cbdata_t; 3170 3171 /* 3172 * Report any snapshots more recent than the one specified. Used when '-r' is 3173 * not specified. We reuse this same callback for the snapshot dependents - if 3174 * 'cb_dependent' is set, then this is a dependent and we should report it 3175 * without checking the transaction group. 3176 */ 3177 static int 3178 rollback_check(zfs_handle_t *zhp, void *data) 3179 { 3180 rollback_cbdata_t *cbp = data; 3181 3182 if (cbp->cb_doclones) { 3183 zfs_close(zhp); 3184 return (0); 3185 } 3186 3187 if (!cbp->cb_dependent) { 3188 if (strcmp(zfs_get_name(zhp), cbp->cb_target) != 0 && 3189 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT && 3190 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) > 3191 cbp->cb_create) { 3192 3193 if (cbp->cb_first && !cbp->cb_recurse) { 3194 (void) fprintf(stderr, gettext("cannot " 3195 "rollback to '%s': more recent snapshots " 3196 "exist\n"), 3197 cbp->cb_target); 3198 (void) fprintf(stderr, gettext("use '-r' to " 3199 "force deletion of the following " 3200 "snapshots:\n")); 3201 cbp->cb_first = 0; 3202 cbp->cb_error = 1; 3203 } 3204 3205 if (cbp->cb_recurse) { 3206 cbp->cb_dependent = B_TRUE; 3207 if (zfs_iter_dependents(zhp, B_TRUE, 3208 rollback_check, cbp) != 0) { 3209 zfs_close(zhp); 3210 return (-1); 3211 } 3212 cbp->cb_dependent = B_FALSE; 3213 } else { 3214 (void) fprintf(stderr, "%s\n", 3215 zfs_get_name(zhp)); 3216 } 3217 } 3218 } else { 3219 if (cbp->cb_first && cbp->cb_recurse) { 3220 (void) fprintf(stderr, gettext("cannot rollback to " 3221 "'%s': clones of previous snapshots exist\n"), 3222 cbp->cb_target); 3223 (void) fprintf(stderr, gettext("use '-R' to " 3224 "force deletion of the following clones and " 3225 "dependents:\n")); 3226 cbp->cb_first = 0; 3227 cbp->cb_error = 1; 3228 } 3229 3230 (void) fprintf(stderr, "%s\n", zfs_get_name(zhp)); 3231 } 3232 3233 zfs_close(zhp); 3234 return (0); 3235 } 3236 3237 static int 3238 zfs_do_rollback(int argc, char **argv) 3239 { 3240 int ret = 0; 3241 int c; 3242 boolean_t force = B_FALSE; 3243 rollback_cbdata_t cb = { 0 }; 3244 zfs_handle_t *zhp, *snap; 3245 char parentname[ZFS_MAXNAMELEN]; 3246 char *delim; 3247 3248 /* check options */ 3249 while ((c = getopt(argc, argv, "rRf")) != -1) { 3250 switch (c) { 3251 case 'r': 3252 cb.cb_recurse = 1; 3253 break; 3254 case 'R': 3255 cb.cb_recurse = 1; 3256 cb.cb_doclones = 1; 3257 break; 3258 case 'f': 3259 force = B_TRUE; 3260 break; 3261 case '?': 3262 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3263 optopt); 3264 usage(B_FALSE); 3265 } 3266 } 3267 3268 argc -= optind; 3269 argv += optind; 3270 3271 /* check number of arguments */ 3272 if (argc < 1) { 3273 (void) fprintf(stderr, gettext("missing dataset argument\n")); 3274 usage(B_FALSE); 3275 } 3276 if (argc > 1) { 3277 (void) fprintf(stderr, gettext("too many arguments\n")); 3278 usage(B_FALSE); 3279 } 3280 3281 /* open the snapshot */ 3282 if ((snap = zfs_open(g_zfs, argv[0], ZFS_TYPE_SNAPSHOT)) == NULL) 3283 return (1); 3284 3285 /* open the parent dataset */ 3286 (void) strlcpy(parentname, argv[0], sizeof (parentname)); 3287 verify((delim = strrchr(parentname, '@')) != NULL); 3288 *delim = '\0'; 3289 if ((zhp = zfs_open(g_zfs, parentname, ZFS_TYPE_DATASET)) == NULL) { 3290 zfs_close(snap); 3291 return (1); 3292 } 3293 3294 /* 3295 * Check for more recent snapshots and/or clones based on the presence 3296 * of '-r' and '-R'. 3297 */ 3298 cb.cb_target = argv[0]; 3299 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG); 3300 cb.cb_first = B_TRUE; 3301 cb.cb_error = 0; 3302 if ((ret = zfs_iter_children(zhp, rollback_check, &cb)) != 0) 3303 goto out; 3304 3305 if ((ret = cb.cb_error) != 0) 3306 goto out; 3307 3308 /* 3309 * Rollback parent to the given snapshot. 3310 */ 3311 ret = zfs_rollback(zhp, snap, force); 3312 3313 out: 3314 zfs_close(snap); 3315 zfs_close(zhp); 3316 3317 if (ret == 0) 3318 return (0); 3319 else 3320 return (1); 3321 } 3322 3323 /* 3324 * zfs set property=value { fs | snap | vol } ... 3325 * 3326 * Sets the given property for all datasets specified on the command line. 3327 */ 3328 typedef struct set_cbdata { 3329 char *cb_propname; 3330 char *cb_value; 3331 } set_cbdata_t; 3332 3333 static int 3334 set_callback(zfs_handle_t *zhp, void *data) 3335 { 3336 set_cbdata_t *cbp = data; 3337 3338 if (zfs_prop_set(zhp, cbp->cb_propname, cbp->cb_value) != 0) { 3339 switch (libzfs_errno(g_zfs)) { 3340 case EZFS_MOUNTFAILED: 3341 (void) fprintf(stderr, gettext("property may be set " 3342 "but unable to remount filesystem\n")); 3343 break; 3344 case EZFS_SHARENFSFAILED: 3345 (void) fprintf(stderr, gettext("property may be set " 3346 "but unable to reshare filesystem\n")); 3347 break; 3348 } 3349 return (1); 3350 } 3351 return (0); 3352 } 3353 3354 static int 3355 zfs_do_set(int argc, char **argv) 3356 { 3357 set_cbdata_t cb; 3358 int ret = 0; 3359 3360 /* check for options */ 3361 if (argc > 1 && argv[1][0] == '-') { 3362 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3363 argv[1][1]); 3364 usage(B_FALSE); 3365 } 3366 3367 /* check number of arguments */ 3368 if (argc < 2) { 3369 (void) fprintf(stderr, gettext("missing property=value " 3370 "argument\n")); 3371 usage(B_FALSE); 3372 } 3373 if (argc < 3) { 3374 (void) fprintf(stderr, gettext("missing dataset name\n")); 3375 usage(B_FALSE); 3376 } 3377 3378 /* validate property=value argument */ 3379 cb.cb_propname = argv[1]; 3380 if (((cb.cb_value = strchr(cb.cb_propname, '=')) == NULL) || 3381 (cb.cb_value[1] == '\0')) { 3382 (void) fprintf(stderr, gettext("missing value in " 3383 "property=value argument\n")); 3384 usage(B_FALSE); 3385 } 3386 3387 *cb.cb_value = '\0'; 3388 cb.cb_value++; 3389 3390 if (*cb.cb_propname == '\0') { 3391 (void) fprintf(stderr, 3392 gettext("missing property in property=value argument\n")); 3393 usage(B_FALSE); 3394 } 3395 3396 ret = zfs_for_each(argc - 2, argv + 2, NULL, 3397 ZFS_TYPE_DATASET, NULL, NULL, 0, set_callback, &cb); 3398 3399 return (ret); 3400 } 3401 3402 typedef struct snap_cbdata { 3403 nvlist_t *sd_nvl; 3404 boolean_t sd_recursive; 3405 const char *sd_snapname; 3406 } snap_cbdata_t; 3407 3408 static int 3409 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg) 3410 { 3411 snap_cbdata_t *sd = arg; 3412 char *name; 3413 int rv = 0; 3414 int error; 3415 3416 error = asprintf(&name, "%s@%s", zfs_get_name(zhp), sd->sd_snapname); 3417 if (error == -1) 3418 nomem(); 3419 fnvlist_add_boolean(sd->sd_nvl, name); 3420 free(name); 3421 3422 if (sd->sd_recursive) 3423 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd); 3424 zfs_close(zhp); 3425 return (rv); 3426 } 3427 3428 /* 3429 * zfs snapshot [-r] [-o prop=value] ... <fs@snap> 3430 * 3431 * Creates a snapshot with the given name. While functionally equivalent to 3432 * 'zfs create', it is a separate command to differentiate intent. 3433 */ 3434 static int 3435 zfs_do_snapshot(int argc, char **argv) 3436 { 3437 int ret = 0; 3438 char c; 3439 nvlist_t *props; 3440 snap_cbdata_t sd = { 0 }; 3441 boolean_t multiple_snaps = B_FALSE; 3442 3443 if (nvlist_alloc(&props, NV_UNIQUE_NAME, 0) != 0) 3444 nomem(); 3445 if (nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) != 0) 3446 nomem(); 3447 3448 /* check options */ 3449 while ((c = getopt(argc, argv, "ro:")) != -1) { 3450 switch (c) { 3451 case 'o': 3452 if (parseprop(props)) 3453 return (1); 3454 break; 3455 case 'r': 3456 sd.sd_recursive = B_TRUE; 3457 multiple_snaps = B_TRUE; 3458 break; 3459 case '?': 3460 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3461 optopt); 3462 goto usage; 3463 } 3464 } 3465 3466 argc -= optind; 3467 argv += optind; 3468 3469 /* check number of arguments */ 3470 if (argc < 1) { 3471 (void) fprintf(stderr, gettext("missing snapshot argument\n")); 3472 goto usage; 3473 } 3474 3475 if (argc > 1) 3476 multiple_snaps = B_TRUE; 3477 for (; argc > 0; argc--, argv++) { 3478 char *atp; 3479 zfs_handle_t *zhp; 3480 3481 atp = strchr(argv[0], '@'); 3482 if (atp == NULL) 3483 goto usage; 3484 *atp = '\0'; 3485 sd.sd_snapname = atp + 1; 3486 zhp = zfs_open(g_zfs, argv[0], 3487 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 3488 if (zhp == NULL) 3489 goto usage; 3490 if (zfs_snapshot_cb(zhp, &sd) != 0) 3491 goto usage; 3492 } 3493 3494 ret = zfs_snapshot_nvl(g_zfs, sd.sd_nvl, props); 3495 nvlist_free(sd.sd_nvl); 3496 nvlist_free(props); 3497 if (ret != 0 && multiple_snaps) 3498 (void) fprintf(stderr, gettext("no snapshots were created\n")); 3499 return (ret != 0); 3500 3501 usage: 3502 nvlist_free(sd.sd_nvl); 3503 nvlist_free(props); 3504 usage(B_FALSE); 3505 return (-1); 3506 } 3507 3508 /* 3509 * Send a backup stream to stdout. 3510 */ 3511 static int 3512 zfs_do_send(int argc, char **argv) 3513 { 3514 char *fromname = NULL; 3515 char *toname = NULL; 3516 char *cp; 3517 zfs_handle_t *zhp; 3518 sendflags_t flags = { 0 }; 3519 int c, err; 3520 nvlist_t *dbgnv = NULL; 3521 boolean_t extraverbose = B_FALSE; 3522 3523 /* check options */ 3524 while ((c = getopt(argc, argv, ":i:I:RDpvnP")) != -1) { 3525 switch (c) { 3526 case 'i': 3527 if (fromname) 3528 usage(B_FALSE); 3529 fromname = optarg; 3530 break; 3531 case 'I': 3532 if (fromname) 3533 usage(B_FALSE); 3534 fromname = optarg; 3535 flags.doall = B_TRUE; 3536 break; 3537 case 'R': 3538 flags.replicate = B_TRUE; 3539 break; 3540 case 'p': 3541 flags.props = B_TRUE; 3542 break; 3543 case 'P': 3544 flags.parsable = B_TRUE; 3545 flags.verbose = B_TRUE; 3546 break; 3547 case 'v': 3548 if (flags.verbose) 3549 extraverbose = B_TRUE; 3550 flags.verbose = B_TRUE; 3551 flags.progress = B_TRUE; 3552 break; 3553 case 'D': 3554 flags.dedup = B_TRUE; 3555 break; 3556 case 'n': 3557 flags.dryrun = B_TRUE; 3558 break; 3559 case ':': 3560 (void) fprintf(stderr, gettext("missing argument for " 3561 "'%c' option\n"), optopt); 3562 usage(B_FALSE); 3563 break; 3564 case '?': 3565 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3566 optopt); 3567 usage(B_FALSE); 3568 } 3569 } 3570 3571 argc -= optind; 3572 argv += optind; 3573 3574 /* check number of arguments */ 3575 if (argc < 1) { 3576 (void) fprintf(stderr, gettext("missing snapshot argument\n")); 3577 usage(B_FALSE); 3578 } 3579 if (argc > 1) { 3580 (void) fprintf(stderr, gettext("too many arguments\n")); 3581 usage(B_FALSE); 3582 } 3583 3584 if (!flags.dryrun && isatty(STDOUT_FILENO)) { 3585 (void) fprintf(stderr, 3586 gettext("Error: Stream can not be written to a terminal.\n" 3587 "You must redirect standard output.\n")); 3588 return (1); 3589 } 3590 3591 cp = strchr(argv[0], '@'); 3592 if (cp == NULL) { 3593 (void) fprintf(stderr, 3594 gettext("argument must be a snapshot\n")); 3595 usage(B_FALSE); 3596 } 3597 *cp = '\0'; 3598 toname = cp + 1; 3599 zhp = zfs_open(g_zfs, argv[0], ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 3600 if (zhp == NULL) 3601 return (1); 3602 3603 /* 3604 * If they specified the full path to the snapshot, chop off 3605 * everything except the short name of the snapshot, but special 3606 * case if they specify the origin. 3607 */ 3608 if (fromname && (cp = strchr(fromname, '@')) != NULL) { 3609 char origin[ZFS_MAXNAMELEN]; 3610 zprop_source_t src; 3611 3612 (void) zfs_prop_get(zhp, ZFS_PROP_ORIGIN, 3613 origin, sizeof (origin), &src, NULL, 0, B_FALSE); 3614 3615 if (strcmp(origin, fromname) == 0) { 3616 fromname = NULL; 3617 flags.fromorigin = B_TRUE; 3618 } else { 3619 *cp = '\0'; 3620 if (cp != fromname && strcmp(argv[0], fromname)) { 3621 (void) fprintf(stderr, 3622 gettext("incremental source must be " 3623 "in same filesystem\n")); 3624 usage(B_FALSE); 3625 } 3626 fromname = cp + 1; 3627 if (strchr(fromname, '@') || strchr(fromname, '/')) { 3628 (void) fprintf(stderr, 3629 gettext("invalid incremental source\n")); 3630 usage(B_FALSE); 3631 } 3632 } 3633 } 3634 3635 if (flags.replicate && fromname == NULL) 3636 flags.doall = B_TRUE; 3637 3638 err = zfs_send(zhp, fromname, toname, &flags, STDOUT_FILENO, NULL, 0, 3639 extraverbose ? &dbgnv : NULL); 3640 3641 if (extraverbose && dbgnv != NULL) { 3642 /* 3643 * dump_nvlist prints to stdout, but that's been 3644 * redirected to a file. Make it print to stderr 3645 * instead. 3646 */ 3647 (void) dup2(STDERR_FILENO, STDOUT_FILENO); 3648 dump_nvlist(dbgnv, 0); 3649 nvlist_free(dbgnv); 3650 } 3651 zfs_close(zhp); 3652 3653 return (err != 0); 3654 } 3655 3656 /* 3657 * zfs receive [-vnFu] [-d | -e] <fs@snap> 3658 * 3659 * Restore a backup stream from stdin. 3660 */ 3661 static int 3662 zfs_do_receive(int argc, char **argv) 3663 { 3664 int c, err; 3665 recvflags_t flags = { 0 }; 3666 3667 /* check options */ 3668 while ((c = getopt(argc, argv, ":denuvF")) != -1) { 3669 switch (c) { 3670 case 'd': 3671 flags.isprefix = B_TRUE; 3672 break; 3673 case 'e': 3674 flags.isprefix = B_TRUE; 3675 flags.istail = B_TRUE; 3676 break; 3677 case 'n': 3678 flags.dryrun = B_TRUE; 3679 break; 3680 case 'u': 3681 flags.nomount = B_TRUE; 3682 break; 3683 case 'v': 3684 flags.verbose = B_TRUE; 3685 break; 3686 case 'F': 3687 flags.force = B_TRUE; 3688 break; 3689 case ':': 3690 (void) fprintf(stderr, gettext("missing argument for " 3691 "'%c' option\n"), optopt); 3692 usage(B_FALSE); 3693 break; 3694 case '?': 3695 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 3696 optopt); 3697 usage(B_FALSE); 3698 } 3699 } 3700 3701 argc -= optind; 3702 argv += optind; 3703 3704 /* check number of arguments */ 3705 if (argc < 1) { 3706 (void) fprintf(stderr, gettext("missing snapshot argument\n")); 3707 usage(B_FALSE); 3708 } 3709 if (argc > 1) { 3710 (void) fprintf(stderr, gettext("too many arguments\n")); 3711 usage(B_FALSE); 3712 } 3713 3714 if (isatty(STDIN_FILENO)) { 3715 (void) fprintf(stderr, 3716 gettext("Error: Backup stream can not be read " 3717 "from a terminal.\n" 3718 "You must redirect standard input.\n")); 3719 return (1); 3720 } 3721 3722 err = zfs_receive(g_zfs, argv[0], &flags, STDIN_FILENO, NULL); 3723 3724 return (err != 0); 3725 } 3726 3727 /* 3728 * allow/unallow stuff 3729 */ 3730 /* copied from zfs/sys/dsl_deleg.h */ 3731 #define ZFS_DELEG_PERM_CREATE "create" 3732 #define ZFS_DELEG_PERM_DESTROY "destroy" 3733 #define ZFS_DELEG_PERM_SNAPSHOT "snapshot" 3734 #define ZFS_DELEG_PERM_ROLLBACK "rollback" 3735 #define ZFS_DELEG_PERM_CLONE "clone" 3736 #define ZFS_DELEG_PERM_PROMOTE "promote" 3737 #define ZFS_DELEG_PERM_RENAME "rename" 3738 #define ZFS_DELEG_PERM_MOUNT "mount" 3739 #define ZFS_DELEG_PERM_SHARE "share" 3740 #define ZFS_DELEG_PERM_SEND "send" 3741 #define ZFS_DELEG_PERM_RECEIVE "receive" 3742 #define ZFS_DELEG_PERM_ALLOW "allow" 3743 #define ZFS_DELEG_PERM_USERPROP "userprop" 3744 #define ZFS_DELEG_PERM_VSCAN "vscan" /* ??? */ 3745 #define ZFS_DELEG_PERM_USERQUOTA "userquota" 3746 #define ZFS_DELEG_PERM_GROUPQUOTA "groupquota" 3747 #define ZFS_DELEG_PERM_USERUSED "userused" 3748 #define ZFS_DELEG_PERM_GROUPUSED "groupused" 3749 #define ZFS_DELEG_PERM_HOLD "hold" 3750 #define ZFS_DELEG_PERM_RELEASE "release" 3751 #define ZFS_DELEG_PERM_DIFF "diff" 3752 3753 #define ZFS_NUM_DELEG_NOTES ZFS_DELEG_NOTE_NONE 3754 3755 static zfs_deleg_perm_tab_t zfs_deleg_perm_tbl[] = { 3756 { ZFS_DELEG_PERM_ALLOW, ZFS_DELEG_NOTE_ALLOW }, 3757 { ZFS_DELEG_PERM_CLONE, ZFS_DELEG_NOTE_CLONE }, 3758 { ZFS_DELEG_PERM_CREATE, ZFS_DELEG_NOTE_CREATE }, 3759 { ZFS_DELEG_PERM_DESTROY, ZFS_DELEG_NOTE_DESTROY }, 3760 { ZFS_DELEG_PERM_DIFF, ZFS_DELEG_NOTE_DIFF}, 3761 { ZFS_DELEG_PERM_HOLD, ZFS_DELEG_NOTE_HOLD }, 3762 { ZFS_DELEG_PERM_MOUNT, ZFS_DELEG_NOTE_MOUNT }, 3763 { ZFS_DELEG_PERM_PROMOTE, ZFS_DELEG_NOTE_PROMOTE }, 3764 { ZFS_DELEG_PERM_RECEIVE, ZFS_DELEG_NOTE_RECEIVE }, 3765 { ZFS_DELEG_PERM_RELEASE, ZFS_DELEG_NOTE_RELEASE }, 3766 { ZFS_DELEG_PERM_RENAME, ZFS_DELEG_NOTE_RENAME }, 3767 { ZFS_DELEG_PERM_ROLLBACK, ZFS_DELEG_NOTE_ROLLBACK }, 3768 { ZFS_DELEG_PERM_SEND, ZFS_DELEG_NOTE_SEND }, 3769 { ZFS_DELEG_PERM_SHARE, ZFS_DELEG_NOTE_SHARE }, 3770 { ZFS_DELEG_PERM_SNAPSHOT, ZFS_DELEG_NOTE_SNAPSHOT }, 3771 3772 { ZFS_DELEG_PERM_GROUPQUOTA, ZFS_DELEG_NOTE_GROUPQUOTA }, 3773 { ZFS_DELEG_PERM_GROUPUSED, ZFS_DELEG_NOTE_GROUPUSED }, 3774 { ZFS_DELEG_PERM_USERPROP, ZFS_DELEG_NOTE_USERPROP }, 3775 { ZFS_DELEG_PERM_USERQUOTA, ZFS_DELEG_NOTE_USERQUOTA }, 3776 { ZFS_DELEG_PERM_USERUSED, ZFS_DELEG_NOTE_USERUSED }, 3777 { NULL, ZFS_DELEG_NOTE_NONE } 3778 }; 3779 3780 /* permission structure */ 3781 typedef struct deleg_perm { 3782 zfs_deleg_who_type_t dp_who_type; 3783 const char *dp_name; 3784 boolean_t dp_local; 3785 boolean_t dp_descend; 3786 } deleg_perm_t; 3787 3788 /* */ 3789 typedef struct deleg_perm_node { 3790 deleg_perm_t dpn_perm; 3791 3792 uu_avl_node_t dpn_avl_node; 3793 } deleg_perm_node_t; 3794 3795 typedef struct fs_perm fs_perm_t; 3796 3797 /* permissions set */ 3798 typedef struct who_perm { 3799 zfs_deleg_who_type_t who_type; 3800 const char *who_name; /* id */ 3801 char who_ug_name[256]; /* user/group name */ 3802 fs_perm_t *who_fsperm; /* uplink */ 3803 3804 uu_avl_t *who_deleg_perm_avl; /* permissions */ 3805 } who_perm_t; 3806 3807 /* */ 3808 typedef struct who_perm_node { 3809 who_perm_t who_perm; 3810 uu_avl_node_t who_avl_node; 3811 } who_perm_node_t; 3812 3813 typedef struct fs_perm_set fs_perm_set_t; 3814 /* fs permissions */ 3815 struct fs_perm { 3816 const char *fsp_name; 3817 3818 uu_avl_t *fsp_sc_avl; /* sets,create */ 3819 uu_avl_t *fsp_uge_avl; /* user,group,everyone */ 3820 3821 fs_perm_set_t *fsp_set; /* uplink */ 3822 }; 3823 3824 /* */ 3825 typedef struct fs_perm_node { 3826 fs_perm_t fspn_fsperm; 3827 uu_avl_t *fspn_avl; 3828 3829 uu_list_node_t fspn_list_node; 3830 } fs_perm_node_t; 3831 3832 /* top level structure */ 3833 struct fs_perm_set { 3834 uu_list_pool_t *fsps_list_pool; 3835 uu_list_t *fsps_list; /* list of fs_perms */ 3836 3837 uu_avl_pool_t *fsps_named_set_avl_pool; 3838 uu_avl_pool_t *fsps_who_perm_avl_pool; 3839 uu_avl_pool_t *fsps_deleg_perm_avl_pool; 3840 }; 3841 3842 static inline const char * 3843 deleg_perm_type(zfs_deleg_note_t note) 3844 { 3845 /* subcommands */ 3846 switch (note) { 3847 /* SUBCOMMANDS */ 3848 /* OTHER */ 3849 case ZFS_DELEG_NOTE_GROUPQUOTA: 3850 case ZFS_DELEG_NOTE_GROUPUSED: 3851 case ZFS_DELEG_NOTE_USERPROP: 3852 case ZFS_DELEG_NOTE_USERQUOTA: 3853 case ZFS_DELEG_NOTE_USERUSED: 3854 /* other */ 3855 return (gettext("other")); 3856 default: 3857 return (gettext("subcommand")); 3858 } 3859 } 3860 3861 static int inline 3862 who_type2weight(zfs_deleg_who_type_t who_type) 3863 { 3864 int res; 3865 switch (who_type) { 3866 case ZFS_DELEG_NAMED_SET_SETS: 3867 case ZFS_DELEG_NAMED_SET: 3868 res = 0; 3869 break; 3870 case ZFS_DELEG_CREATE_SETS: 3871 case ZFS_DELEG_CREATE: 3872 res = 1; 3873 break; 3874 case ZFS_DELEG_USER_SETS: 3875 case ZFS_DELEG_USER: 3876 res = 2; 3877 break; 3878 case ZFS_DELEG_GROUP_SETS: 3879 case ZFS_DELEG_GROUP: 3880 res = 3; 3881 break; 3882 case ZFS_DELEG_EVERYONE_SETS: 3883 case ZFS_DELEG_EVERYONE: 3884 res = 4; 3885 break; 3886 default: 3887 res = -1; 3888 } 3889 3890 return (res); 3891 } 3892 3893 /* ARGSUSED */ 3894 static int 3895 who_perm_compare(const void *larg, const void *rarg, void *unused) 3896 { 3897 const who_perm_node_t *l = larg; 3898 const who_perm_node_t *r = rarg; 3899 zfs_deleg_who_type_t ltype = l->who_perm.who_type; 3900 zfs_deleg_who_type_t rtype = r->who_perm.who_type; 3901 int lweight = who_type2weight(ltype); 3902 int rweight = who_type2weight(rtype); 3903 int res = lweight - rweight; 3904 if (res == 0) 3905 res = strncmp(l->who_perm.who_name, r->who_perm.who_name, 3906 ZFS_MAX_DELEG_NAME-1); 3907 3908 if (res == 0) 3909 return (0); 3910 if (res > 0) 3911 return (1); 3912 else 3913 return (-1); 3914 } 3915 3916 /* ARGSUSED */ 3917 static int 3918 deleg_perm_compare(const void *larg, const void *rarg, void *unused) 3919 { 3920 const deleg_perm_node_t *l = larg; 3921 const deleg_perm_node_t *r = rarg; 3922 int res = strncmp(l->dpn_perm.dp_name, r->dpn_perm.dp_name, 3923 ZFS_MAX_DELEG_NAME-1); 3924 3925 if (res == 0) 3926 return (0); 3927 3928 if (res > 0) 3929 return (1); 3930 else 3931 return (-1); 3932 } 3933 3934 static inline void 3935 fs_perm_set_init(fs_perm_set_t *fspset) 3936 { 3937 bzero(fspset, sizeof (fs_perm_set_t)); 3938 3939 if ((fspset->fsps_list_pool = uu_list_pool_create("fsps_list_pool", 3940 sizeof (fs_perm_node_t), offsetof(fs_perm_node_t, fspn_list_node), 3941 NULL, UU_DEFAULT)) == NULL) 3942 nomem(); 3943 if ((fspset->fsps_list = uu_list_create(fspset->fsps_list_pool, NULL, 3944 UU_DEFAULT)) == NULL) 3945 nomem(); 3946 3947 if ((fspset->fsps_named_set_avl_pool = uu_avl_pool_create( 3948 "named_set_avl_pool", sizeof (who_perm_node_t), offsetof( 3949 who_perm_node_t, who_avl_node), who_perm_compare, 3950 UU_DEFAULT)) == NULL) 3951 nomem(); 3952 3953 if ((fspset->fsps_who_perm_avl_pool = uu_avl_pool_create( 3954 "who_perm_avl_pool", sizeof (who_perm_node_t), offsetof( 3955 who_perm_node_t, who_avl_node), who_perm_compare, 3956 UU_DEFAULT)) == NULL) 3957 nomem(); 3958 3959 if ((fspset->fsps_deleg_perm_avl_pool = uu_avl_pool_create( 3960 "deleg_perm_avl_pool", sizeof (deleg_perm_node_t), offsetof( 3961 deleg_perm_node_t, dpn_avl_node), deleg_perm_compare, UU_DEFAULT)) 3962 == NULL) 3963 nomem(); 3964 } 3965 3966 static inline void fs_perm_fini(fs_perm_t *); 3967 static inline void who_perm_fini(who_perm_t *); 3968 3969 static inline void 3970 fs_perm_set_fini(fs_perm_set_t *fspset) 3971 { 3972 fs_perm_node_t *node = uu_list_first(fspset->fsps_list); 3973 3974 while (node != NULL) { 3975 fs_perm_node_t *next_node = 3976 uu_list_next(fspset->fsps_list, node); 3977 fs_perm_t *fsperm = &node->fspn_fsperm; 3978 fs_perm_fini(fsperm); 3979 uu_list_remove(fspset->fsps_list, node); 3980 free(node); 3981 node = next_node; 3982 } 3983 3984 uu_avl_pool_destroy(fspset->fsps_named_set_avl_pool); 3985 uu_avl_pool_destroy(fspset->fsps_who_perm_avl_pool); 3986 uu_avl_pool_destroy(fspset->fsps_deleg_perm_avl_pool); 3987 } 3988 3989 static inline void 3990 deleg_perm_init(deleg_perm_t *deleg_perm, zfs_deleg_who_type_t type, 3991 const char *name) 3992 { 3993 deleg_perm->dp_who_type = type; 3994 deleg_perm->dp_name = name; 3995 } 3996 3997 static inline void 3998 who_perm_init(who_perm_t *who_perm, fs_perm_t *fsperm, 3999 zfs_deleg_who_type_t type, const char *name) 4000 { 4001 uu_avl_pool_t *pool; 4002 pool = fsperm->fsp_set->fsps_deleg_perm_avl_pool; 4003 4004 bzero(who_perm, sizeof (who_perm_t)); 4005 4006 if ((who_perm->who_deleg_perm_avl = uu_avl_create(pool, NULL, 4007 UU_DEFAULT)) == NULL) 4008 nomem(); 4009 4010 who_perm->who_type = type; 4011 who_perm->who_name = name; 4012 who_perm->who_fsperm = fsperm; 4013 } 4014 4015 static inline void 4016 who_perm_fini(who_perm_t *who_perm) 4017 { 4018 deleg_perm_node_t *node = uu_avl_first(who_perm->who_deleg_perm_avl); 4019 4020 while (node != NULL) { 4021 deleg_perm_node_t *next_node = 4022 uu_avl_next(who_perm->who_deleg_perm_avl, node); 4023 4024 uu_avl_remove(who_perm->who_deleg_perm_avl, node); 4025 free(node); 4026 node = next_node; 4027 } 4028 4029 uu_avl_destroy(who_perm->who_deleg_perm_avl); 4030 } 4031 4032 static inline void 4033 fs_perm_init(fs_perm_t *fsperm, fs_perm_set_t *fspset, const char *fsname) 4034 { 4035 uu_avl_pool_t *nset_pool = fspset->fsps_named_set_avl_pool; 4036 uu_avl_pool_t *who_pool = fspset->fsps_who_perm_avl_pool; 4037 4038 bzero(fsperm, sizeof (fs_perm_t)); 4039 4040 if ((fsperm->fsp_sc_avl = uu_avl_create(nset_pool, NULL, UU_DEFAULT)) 4041 == NULL) 4042 nomem(); 4043 4044 if ((fsperm->fsp_uge_avl = uu_avl_create(who_pool, NULL, UU_DEFAULT)) 4045 == NULL) 4046 nomem(); 4047 4048 fsperm->fsp_set = fspset; 4049 fsperm->fsp_name = fsname; 4050 } 4051 4052 static inline void 4053 fs_perm_fini(fs_perm_t *fsperm) 4054 { 4055 who_perm_node_t *node = uu_avl_first(fsperm->fsp_sc_avl); 4056 while (node != NULL) { 4057 who_perm_node_t *next_node = uu_avl_next(fsperm->fsp_sc_avl, 4058 node); 4059 who_perm_t *who_perm = &node->who_perm; 4060 who_perm_fini(who_perm); 4061 uu_avl_remove(fsperm->fsp_sc_avl, node); 4062 free(node); 4063 node = next_node; 4064 } 4065 4066 node = uu_avl_first(fsperm->fsp_uge_avl); 4067 while (node != NULL) { 4068 who_perm_node_t *next_node = uu_avl_next(fsperm->fsp_uge_avl, 4069 node); 4070 who_perm_t *who_perm = &node->who_perm; 4071 who_perm_fini(who_perm); 4072 uu_avl_remove(fsperm->fsp_uge_avl, node); 4073 free(node); 4074 node = next_node; 4075 } 4076 4077 uu_avl_destroy(fsperm->fsp_sc_avl); 4078 uu_avl_destroy(fsperm->fsp_uge_avl); 4079 } 4080 4081 static void inline 4082 set_deleg_perm_node(uu_avl_t *avl, deleg_perm_node_t *node, 4083 zfs_deleg_who_type_t who_type, const char *name, char locality) 4084 { 4085 uu_avl_index_t idx = 0; 4086 4087 deleg_perm_node_t *found_node = NULL; 4088 deleg_perm_t *deleg_perm = &node->dpn_perm; 4089 4090 deleg_perm_init(deleg_perm, who_type, name); 4091 4092 if ((found_node = uu_avl_find(avl, node, NULL, &idx)) 4093 == NULL) 4094 uu_avl_insert(avl, node, idx); 4095 else { 4096 node = found_node; 4097 deleg_perm = &node->dpn_perm; 4098 } 4099 4100 4101 switch (locality) { 4102 case ZFS_DELEG_LOCAL: 4103 deleg_perm->dp_local = B_TRUE; 4104 break; 4105 case ZFS_DELEG_DESCENDENT: 4106 deleg_perm->dp_descend = B_TRUE; 4107 break; 4108 case ZFS_DELEG_NA: 4109 break; 4110 default: 4111 assert(B_FALSE); /* invalid locality */ 4112 } 4113 } 4114 4115 static inline int 4116 parse_who_perm(who_perm_t *who_perm, nvlist_t *nvl, char locality) 4117 { 4118 nvpair_t *nvp = NULL; 4119 fs_perm_set_t *fspset = who_perm->who_fsperm->fsp_set; 4120 uu_avl_t *avl = who_perm->who_deleg_perm_avl; 4121 zfs_deleg_who_type_t who_type = who_perm->who_type; 4122 4123 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) { 4124 const char *name = nvpair_name(nvp); 4125 data_type_t type = nvpair_type(nvp); 4126 uu_avl_pool_t *avl_pool = fspset->fsps_deleg_perm_avl_pool; 4127 deleg_perm_node_t *node = 4128 safe_malloc(sizeof (deleg_perm_node_t)); 4129 4130 assert(type == DATA_TYPE_BOOLEAN); 4131 4132 uu_avl_node_init(node, &node->dpn_avl_node, avl_pool); 4133 set_deleg_perm_node(avl, node, who_type, name, locality); 4134 } 4135 4136 return (0); 4137 } 4138 4139 static inline int 4140 parse_fs_perm(fs_perm_t *fsperm, nvlist_t *nvl) 4141 { 4142 nvpair_t *nvp = NULL; 4143 fs_perm_set_t *fspset = fsperm->fsp_set; 4144 4145 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) { 4146 nvlist_t *nvl2 = NULL; 4147 const char *name = nvpair_name(nvp); 4148 uu_avl_t *avl = NULL; 4149 uu_avl_pool_t *avl_pool; 4150 zfs_deleg_who_type_t perm_type = name[0]; 4151 char perm_locality = name[1]; 4152 const char *perm_name = name + 3; 4153 boolean_t is_set = B_TRUE; 4154 who_perm_t *who_perm = NULL; 4155 4156 assert('$' == name[2]); 4157 4158 if (nvpair_value_nvlist(nvp, &nvl2) != 0) 4159 return (-1); 4160 4161 switch (perm_type) { 4162 case ZFS_DELEG_CREATE: 4163 case ZFS_DELEG_CREATE_SETS: 4164 case ZFS_DELEG_NAMED_SET: 4165 case ZFS_DELEG_NAMED_SET_SETS: 4166 avl_pool = fspset->fsps_named_set_avl_pool; 4167 avl = fsperm->fsp_sc_avl; 4168 break; 4169 case ZFS_DELEG_USER: 4170 case ZFS_DELEG_USER_SETS: 4171 case ZFS_DELEG_GROUP: 4172 case ZFS_DELEG_GROUP_SETS: 4173 case ZFS_DELEG_EVERYONE: 4174 case ZFS_DELEG_EVERYONE_SETS: 4175 avl_pool = fspset->fsps_who_perm_avl_pool; 4176 avl = fsperm->fsp_uge_avl; 4177 break; 4178 } 4179 4180 if (is_set) { 4181 who_perm_node_t *found_node = NULL; 4182 who_perm_node_t *node = safe_malloc( 4183 sizeof (who_perm_node_t)); 4184 who_perm = &node->who_perm; 4185 uu_avl_index_t idx = 0; 4186 4187 uu_avl_node_init(node, &node->who_avl_node, avl_pool); 4188 who_perm_init(who_perm, fsperm, perm_type, perm_name); 4189 4190 if ((found_node = uu_avl_find(avl, node, NULL, &idx)) 4191 == NULL) { 4192 if (avl == fsperm->fsp_uge_avl) { 4193 uid_t rid = 0; 4194 struct passwd *p = NULL; 4195 struct group *g = NULL; 4196 const char *nice_name = NULL; 4197 4198 switch (perm_type) { 4199 case ZFS_DELEG_USER_SETS: 4200 case ZFS_DELEG_USER: 4201 rid = atoi(perm_name); 4202 p = getpwuid(rid); 4203 if (p) 4204 nice_name = p->pw_name; 4205 break; 4206 case ZFS_DELEG_GROUP_SETS: 4207 case ZFS_DELEG_GROUP: 4208 rid = atoi(perm_name); 4209 g = getgrgid(rid); 4210 if (g) 4211 nice_name = g->gr_name; 4212 break; 4213 } 4214 4215 if (nice_name != NULL) 4216 (void) strlcpy( 4217 node->who_perm.who_ug_name, 4218 nice_name, 256); 4219 } 4220 4221 uu_avl_insert(avl, node, idx); 4222 } else { 4223 node = found_node; 4224 who_perm = &node->who_perm; 4225 } 4226 } 4227 4228 (void) parse_who_perm(who_perm, nvl2, perm_locality); 4229 } 4230 4231 return (0); 4232 } 4233 4234 static inline int 4235 parse_fs_perm_set(fs_perm_set_t *fspset, nvlist_t *nvl) 4236 { 4237 nvpair_t *nvp = NULL; 4238 uu_avl_index_t idx = 0; 4239 4240 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) { 4241 nvlist_t *nvl2 = NULL; 4242 const char *fsname = nvpair_name(nvp); 4243 data_type_t type = nvpair_type(nvp); 4244 fs_perm_t *fsperm = NULL; 4245 fs_perm_node_t *node = safe_malloc(sizeof (fs_perm_node_t)); 4246 if (node == NULL) 4247 nomem(); 4248 4249 fsperm = &node->fspn_fsperm; 4250 4251 assert(DATA_TYPE_NVLIST == type); 4252 4253 uu_list_node_init(node, &node->fspn_list_node, 4254 fspset->fsps_list_pool); 4255 4256 idx = uu_list_numnodes(fspset->fsps_list); 4257 fs_perm_init(fsperm, fspset, fsname); 4258 4259 if (nvpair_value_nvlist(nvp, &nvl2) != 0) 4260 return (-1); 4261 4262 (void) parse_fs_perm(fsperm, nvl2); 4263 4264 uu_list_insert(fspset->fsps_list, node, idx); 4265 } 4266 4267 return (0); 4268 } 4269 4270 static inline const char * 4271 deleg_perm_comment(zfs_deleg_note_t note) 4272 { 4273 const char *str = ""; 4274 4275 /* subcommands */ 4276 switch (note) { 4277 /* SUBCOMMANDS */ 4278 case ZFS_DELEG_NOTE_ALLOW: 4279 str = gettext("Must also have the permission that is being" 4280 "\n\t\t\t\tallowed"); 4281 break; 4282 case ZFS_DELEG_NOTE_CLONE: 4283 str = gettext("Must also have the 'create' ability and 'mount'" 4284 "\n\t\t\t\tability in the origin file system"); 4285 break; 4286 case ZFS_DELEG_NOTE_CREATE: 4287 str = gettext("Must also have the 'mount' ability"); 4288 break; 4289 case ZFS_DELEG_NOTE_DESTROY: 4290 str = gettext("Must also have the 'mount' ability"); 4291 break; 4292 case ZFS_DELEG_NOTE_DIFF: 4293 str = gettext("Allows lookup of paths within a dataset;" 4294 "\n\t\t\t\tgiven an object number. Ordinary users need this" 4295 "\n\t\t\t\tin order to use zfs diff"); 4296 break; 4297 case ZFS_DELEG_NOTE_HOLD: 4298 str = gettext("Allows adding a user hold to a snapshot"); 4299 break; 4300 case ZFS_DELEG_NOTE_MOUNT: 4301 str = gettext("Allows mount/umount of ZFS datasets"); 4302 break; 4303 case ZFS_DELEG_NOTE_PROMOTE: 4304 str = gettext("Must also have the 'mount'\n\t\t\t\tand" 4305 " 'promote' ability in the origin file system"); 4306 break; 4307 case ZFS_DELEG_NOTE_RECEIVE: 4308 str = gettext("Must also have the 'mount' and 'create'" 4309 " ability"); 4310 break; 4311 case ZFS_DELEG_NOTE_RELEASE: 4312 str = gettext("Allows releasing a user hold which\n\t\t\t\t" 4313 "might destroy the snapshot"); 4314 break; 4315 case ZFS_DELEG_NOTE_RENAME: 4316 str = gettext("Must also have the 'mount' and 'create'" 4317 "\n\t\t\t\tability in the new parent"); 4318 break; 4319 case ZFS_DELEG_NOTE_ROLLBACK: 4320 str = gettext(""); 4321 break; 4322 case ZFS_DELEG_NOTE_SEND: 4323 str = gettext(""); 4324 break; 4325 case ZFS_DELEG_NOTE_SHARE: 4326 str = gettext("Allows sharing file systems over NFS or SMB" 4327 "\n\t\t\t\tprotocols"); 4328 break; 4329 case ZFS_DELEG_NOTE_SNAPSHOT: 4330 str = gettext(""); 4331 break; 4332 /* 4333 * case ZFS_DELEG_NOTE_VSCAN: 4334 * str = gettext(""); 4335 * break; 4336 */ 4337 /* OTHER */ 4338 case ZFS_DELEG_NOTE_GROUPQUOTA: 4339 str = gettext("Allows accessing any groupquota@... property"); 4340 break; 4341 case ZFS_DELEG_NOTE_GROUPUSED: 4342 str = gettext("Allows reading any groupused@... property"); 4343 break; 4344 case ZFS_DELEG_NOTE_USERPROP: 4345 str = gettext("Allows changing any user property"); 4346 break; 4347 case ZFS_DELEG_NOTE_USERQUOTA: 4348 str = gettext("Allows accessing any userquota@... property"); 4349 break; 4350 case ZFS_DELEG_NOTE_USERUSED: 4351 str = gettext("Allows reading any userused@... property"); 4352 break; 4353 /* other */ 4354 default: 4355 str = ""; 4356 } 4357 4358 return (str); 4359 } 4360 4361 struct allow_opts { 4362 boolean_t local; 4363 boolean_t descend; 4364 boolean_t user; 4365 boolean_t group; 4366 boolean_t everyone; 4367 boolean_t create; 4368 boolean_t set; 4369 boolean_t recursive; /* unallow only */ 4370 boolean_t prt_usage; 4371 4372 boolean_t prt_perms; 4373 char *who; 4374 char *perms; 4375 const char *dataset; 4376 }; 4377 4378 static inline int 4379 prop_cmp(const void *a, const void *b) 4380 { 4381 const char *str1 = *(const char **)a; 4382 const char *str2 = *(const char **)b; 4383 return (strcmp(str1, str2)); 4384 } 4385 4386 static void 4387 allow_usage(boolean_t un, boolean_t requested, const char *msg) 4388 { 4389 const char *opt_desc[] = { 4390 "-h", gettext("show this help message and exit"), 4391 "-l", gettext("set permission locally"), 4392 "-d", gettext("set permission for descents"), 4393 "-u", gettext("set permission for user"), 4394 "-g", gettext("set permission for group"), 4395 "-e", gettext("set permission for everyone"), 4396 "-c", gettext("set create time permission"), 4397 "-s", gettext("define permission set"), 4398 /* unallow only */ 4399 "-r", gettext("remove permissions recursively"), 4400 }; 4401 size_t unallow_size = sizeof (opt_desc) / sizeof (char *); 4402 size_t allow_size = unallow_size - 2; 4403 const char *props[ZFS_NUM_PROPS]; 4404 int i; 4405 size_t count = 0; 4406 FILE *fp = requested ? stdout : stderr; 4407 zprop_desc_t *pdtbl = zfs_prop_get_table(); 4408 const char *fmt = gettext("%-16s %-14s\t%s\n"); 4409 4410 (void) fprintf(fp, gettext("Usage: %s\n"), get_usage(un ? HELP_UNALLOW : 4411 HELP_ALLOW)); 4412 (void) fprintf(fp, gettext("Options:\n")); 4413 for (int i = 0; i < (un ? unallow_size : allow_size); i++) { 4414 const char *opt = opt_desc[i++]; 4415 const char *optdsc = opt_desc[i]; 4416 (void) fprintf(fp, gettext(" %-10s %s\n"), opt, optdsc); 4417 } 4418 4419 (void) fprintf(fp, gettext("\nThe following permissions are " 4420 "supported:\n\n")); 4421 (void) fprintf(fp, fmt, gettext("NAME"), gettext("TYPE"), 4422 gettext("NOTES")); 4423 for (i = 0; i < ZFS_NUM_DELEG_NOTES; i++) { 4424 const char *perm_name = zfs_deleg_perm_tbl[i].z_perm; 4425 zfs_deleg_note_t perm_note = zfs_deleg_perm_tbl[i].z_note; 4426 const char *perm_type = deleg_perm_type(perm_note); 4427 const char *perm_comment = deleg_perm_comment(perm_note); 4428 (void) fprintf(fp, fmt, perm_name, perm_type, perm_comment); 4429 } 4430 4431 for (i = 0; i < ZFS_NUM_PROPS; i++) { 4432 zprop_desc_t *pd = &pdtbl[i]; 4433 if (pd->pd_visible != B_TRUE) 4434 continue; 4435 4436 if (pd->pd_attr == PROP_READONLY) 4437 continue; 4438 4439 props[count++] = pd->pd_name; 4440 } 4441 props[count] = NULL; 4442 4443 qsort(props, count, sizeof (char *), prop_cmp); 4444 4445 for (i = 0; i < count; i++) 4446 (void) fprintf(fp, fmt, props[i], gettext("property"), ""); 4447 4448 if (msg != NULL) 4449 (void) fprintf(fp, gettext("\nzfs: error: %s"), msg); 4450 4451 exit(requested ? 0 : 2); 4452 } 4453 4454 static inline const char * 4455 munge_args(int argc, char **argv, boolean_t un, size_t expected_argc, 4456 char **permsp) 4457 { 4458 if (un && argc == expected_argc - 1) 4459 *permsp = NULL; 4460 else if (argc == expected_argc) 4461 *permsp = argv[argc - 2]; 4462 else 4463 allow_usage(un, B_FALSE, 4464 gettext("wrong number of parameters\n")); 4465 4466 return (argv[argc - 1]); 4467 } 4468 4469 static void 4470 parse_allow_args(int argc, char **argv, boolean_t un, struct allow_opts *opts) 4471 { 4472 int uge_sum = opts->user + opts->group + opts->everyone; 4473 int csuge_sum = opts->create + opts->set + uge_sum; 4474 int ldcsuge_sum = csuge_sum + opts->local + opts->descend; 4475 int all_sum = un ? ldcsuge_sum + opts->recursive : ldcsuge_sum; 4476 4477 if (uge_sum > 1) 4478 allow_usage(un, B_FALSE, 4479 gettext("-u, -g, and -e are mutually exclusive\n")); 4480 4481 if (opts->prt_usage) 4482 if (argc == 0 && all_sum == 0) 4483 allow_usage(un, B_TRUE, NULL); 4484 else 4485 usage(B_FALSE); 4486 4487 if (opts->set) { 4488 if (csuge_sum > 1) 4489 allow_usage(un, B_FALSE, 4490 gettext("invalid options combined with -s\n")); 4491 4492 opts->dataset = munge_args(argc, argv, un, 3, &opts->perms); 4493 if (argv[0][0] != '@') 4494 allow_usage(un, B_FALSE, 4495 gettext("invalid set name: missing '@' prefix\n")); 4496 opts->who = argv[0]; 4497 } else if (opts->create) { 4498 if (ldcsuge_sum > 1) 4499 allow_usage(un, B_FALSE, 4500 gettext("invalid options combined with -c\n")); 4501 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms); 4502 } else if (opts->everyone) { 4503 if (csuge_sum > 1) 4504 allow_usage(un, B_FALSE, 4505 gettext("invalid options combined with -e\n")); 4506 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms); 4507 } else if (uge_sum == 0 && argc > 0 && strcmp(argv[0], "everyone") 4508 == 0) { 4509 opts->everyone = B_TRUE; 4510 argc--; 4511 argv++; 4512 opts->dataset = munge_args(argc, argv, un, 2, &opts->perms); 4513 } else if (argc == 1 && !un) { 4514 opts->prt_perms = B_TRUE; 4515 opts->dataset = argv[argc-1]; 4516 } else { 4517 opts->dataset = munge_args(argc, argv, un, 3, &opts->perms); 4518 opts->who = argv[0]; 4519 } 4520 4521 if (!opts->local && !opts->descend) { 4522 opts->local = B_TRUE; 4523 opts->descend = B_TRUE; 4524 } 4525 } 4526 4527 static void 4528 store_allow_perm(zfs_deleg_who_type_t type, boolean_t local, boolean_t descend, 4529 const char *who, char *perms, nvlist_t *top_nvl) 4530 { 4531 int i; 4532 char ld[2] = { '\0', '\0' }; 4533 char who_buf[ZFS_MAXNAMELEN+32]; 4534 char base_type; 4535 char set_type; 4536 nvlist_t *base_nvl = NULL; 4537 nvlist_t *set_nvl = NULL; 4538 nvlist_t *nvl; 4539 4540 if (nvlist_alloc(&base_nvl, NV_UNIQUE_NAME, 0) != 0) 4541 nomem(); 4542 if (nvlist_alloc(&set_nvl, NV_UNIQUE_NAME, 0) != 0) 4543 nomem(); 4544 4545 switch (type) { 4546 case ZFS_DELEG_NAMED_SET_SETS: 4547 case ZFS_DELEG_NAMED_SET: 4548 set_type = ZFS_DELEG_NAMED_SET_SETS; 4549 base_type = ZFS_DELEG_NAMED_SET; 4550 ld[0] = ZFS_DELEG_NA; 4551 break; 4552 case ZFS_DELEG_CREATE_SETS: 4553 case ZFS_DELEG_CREATE: 4554 set_type = ZFS_DELEG_CREATE_SETS; 4555 base_type = ZFS_DELEG_CREATE; 4556 ld[0] = ZFS_DELEG_NA; 4557 break; 4558 case ZFS_DELEG_USER_SETS: 4559 case ZFS_DELEG_USER: 4560 set_type = ZFS_DELEG_USER_SETS; 4561 base_type = ZFS_DELEG_USER; 4562 if (local) 4563 ld[0] = ZFS_DELEG_LOCAL; 4564 if (descend) 4565 ld[1] = ZFS_DELEG_DESCENDENT; 4566 break; 4567 case ZFS_DELEG_GROUP_SETS: 4568 case ZFS_DELEG_GROUP: 4569 set_type = ZFS_DELEG_GROUP_SETS; 4570 base_type = ZFS_DELEG_GROUP; 4571 if (local) 4572 ld[0] = ZFS_DELEG_LOCAL; 4573 if (descend) 4574 ld[1] = ZFS_DELEG_DESCENDENT; 4575 break; 4576 case ZFS_DELEG_EVERYONE_SETS: 4577 case ZFS_DELEG_EVERYONE: 4578 set_type = ZFS_DELEG_EVERYONE_SETS; 4579 base_type = ZFS_DELEG_EVERYONE; 4580 if (local) 4581 ld[0] = ZFS_DELEG_LOCAL; 4582 if (descend) 4583 ld[1] = ZFS_DELEG_DESCENDENT; 4584 } 4585 4586 if (perms != NULL) { 4587 char *curr = perms; 4588 char *end = curr + strlen(perms); 4589 4590 while (curr < end) { 4591 char *delim = strchr(curr, ','); 4592 if (delim == NULL) 4593 delim = end; 4594 else 4595 *delim = '\0'; 4596 4597 if (curr[0] == '@') 4598 nvl = set_nvl; 4599 else 4600 nvl = base_nvl; 4601 4602 (void) nvlist_add_boolean(nvl, curr); 4603 if (delim != end) 4604 *delim = ','; 4605 curr = delim + 1; 4606 } 4607 4608 for (i = 0; i < 2; i++) { 4609 char locality = ld[i]; 4610 if (locality == 0) 4611 continue; 4612 4613 if (!nvlist_empty(base_nvl)) { 4614 if (who != NULL) 4615 (void) snprintf(who_buf, 4616 sizeof (who_buf), "%c%c$%s", 4617 base_type, locality, who); 4618 else 4619 (void) snprintf(who_buf, 4620 sizeof (who_buf), "%c%c$", 4621 base_type, locality); 4622 4623 (void) nvlist_add_nvlist(top_nvl, who_buf, 4624 base_nvl); 4625 } 4626 4627 4628 if (!nvlist_empty(set_nvl)) { 4629 if (who != NULL) 4630 (void) snprintf(who_buf, 4631 sizeof (who_buf), "%c%c$%s", 4632 set_type, locality, who); 4633 else 4634 (void) snprintf(who_buf, 4635 sizeof (who_buf), "%c%c$", 4636 set_type, locality); 4637 4638 (void) nvlist_add_nvlist(top_nvl, who_buf, 4639 set_nvl); 4640 } 4641 } 4642 } else { 4643 for (i = 0; i < 2; i++) { 4644 char locality = ld[i]; 4645 if (locality == 0) 4646 continue; 4647 4648 if (who != NULL) 4649 (void) snprintf(who_buf, sizeof (who_buf), 4650 "%c%c$%s", base_type, locality, who); 4651 else 4652 (void) snprintf(who_buf, sizeof (who_buf), 4653 "%c%c$", base_type, locality); 4654 (void) nvlist_add_boolean(top_nvl, who_buf); 4655 4656 if (who != NULL) 4657 (void) snprintf(who_buf, sizeof (who_buf), 4658 "%c%c$%s", set_type, locality, who); 4659 else 4660 (void) snprintf(who_buf, sizeof (who_buf), 4661 "%c%c$", set_type, locality); 4662 (void) nvlist_add_boolean(top_nvl, who_buf); 4663 } 4664 } 4665 } 4666 4667 static int 4668 construct_fsacl_list(boolean_t un, struct allow_opts *opts, nvlist_t **nvlp) 4669 { 4670 if (nvlist_alloc(nvlp, NV_UNIQUE_NAME, 0) != 0) 4671 nomem(); 4672 4673 if (opts->set) { 4674 store_allow_perm(ZFS_DELEG_NAMED_SET, opts->local, 4675 opts->descend, opts->who, opts->perms, *nvlp); 4676 } else if (opts->create) { 4677 store_allow_perm(ZFS_DELEG_CREATE, opts->local, 4678 opts->descend, NULL, opts->perms, *nvlp); 4679 } else if (opts->everyone) { 4680 store_allow_perm(ZFS_DELEG_EVERYONE, opts->local, 4681 opts->descend, NULL, opts->perms, *nvlp); 4682 } else { 4683 char *curr = opts->who; 4684 char *end = curr + strlen(curr); 4685 4686 while (curr < end) { 4687 const char *who; 4688 zfs_deleg_who_type_t who_type; 4689 char *endch; 4690 char *delim = strchr(curr, ','); 4691 char errbuf[256]; 4692 char id[64]; 4693 struct passwd *p = NULL; 4694 struct group *g = NULL; 4695 4696 uid_t rid; 4697 if (delim == NULL) 4698 delim = end; 4699 else 4700 *delim = '\0'; 4701 4702 rid = (uid_t)strtol(curr, &endch, 0); 4703 if (opts->user) { 4704 who_type = ZFS_DELEG_USER; 4705 if (*endch != '\0') 4706 p = getpwnam(curr); 4707 else 4708 p = getpwuid(rid); 4709 4710 if (p != NULL) 4711 rid = p->pw_uid; 4712 else { 4713 (void) snprintf(errbuf, 256, gettext( 4714 "invalid user %s"), curr); 4715 allow_usage(un, B_TRUE, errbuf); 4716 } 4717 } else if (opts->group) { 4718 who_type = ZFS_DELEG_GROUP; 4719 if (*endch != '\0') 4720 g = getgrnam(curr); 4721 else 4722 g = getgrgid(rid); 4723 4724 if (g != NULL) 4725 rid = g->gr_gid; 4726 else { 4727 (void) snprintf(errbuf, 256, gettext( 4728 "invalid group %s"), curr); 4729 allow_usage(un, B_TRUE, errbuf); 4730 } 4731 } else { 4732 if (*endch != '\0') { 4733 p = getpwnam(curr); 4734 } else { 4735 p = getpwuid(rid); 4736 } 4737 4738 if (p == NULL) 4739 if (*endch != '\0') { 4740 g = getgrnam(curr); 4741 } else { 4742 g = getgrgid(rid); 4743 } 4744 4745 if (p != NULL) { 4746 who_type = ZFS_DELEG_USER; 4747 rid = p->pw_uid; 4748 } else if (g != NULL) { 4749 who_type = ZFS_DELEG_GROUP; 4750 rid = g->gr_gid; 4751 } else { 4752 (void) snprintf(errbuf, 256, gettext( 4753 "invalid user/group %s"), curr); 4754 allow_usage(un, B_TRUE, errbuf); 4755 } 4756 } 4757 4758 (void) sprintf(id, "%u", rid); 4759 who = id; 4760 4761 store_allow_perm(who_type, opts->local, 4762 opts->descend, who, opts->perms, *nvlp); 4763 curr = delim + 1; 4764 } 4765 } 4766 4767 return (0); 4768 } 4769 4770 static void 4771 print_set_creat_perms(uu_avl_t *who_avl) 4772 { 4773 const char *sc_title[] = { 4774 gettext("Permission sets:\n"), 4775 gettext("Create time permissions:\n"), 4776 NULL 4777 }; 4778 const char **title_ptr = sc_title; 4779 who_perm_node_t *who_node = NULL; 4780 int prev_weight = -1; 4781 4782 for (who_node = uu_avl_first(who_avl); who_node != NULL; 4783 who_node = uu_avl_next(who_avl, who_node)) { 4784 uu_avl_t *avl = who_node->who_perm.who_deleg_perm_avl; 4785 zfs_deleg_who_type_t who_type = who_node->who_perm.who_type; 4786 const char *who_name = who_node->who_perm.who_name; 4787 int weight = who_type2weight(who_type); 4788 boolean_t first = B_TRUE; 4789 deleg_perm_node_t *deleg_node; 4790 4791 if (prev_weight != weight) { 4792 (void) printf(*title_ptr++); 4793 prev_weight = weight; 4794 } 4795 4796 if (who_name == NULL || strnlen(who_name, 1) == 0) 4797 (void) printf("\t"); 4798 else 4799 (void) printf("\t%s ", who_name); 4800 4801 for (deleg_node = uu_avl_first(avl); deleg_node != NULL; 4802 deleg_node = uu_avl_next(avl, deleg_node)) { 4803 if (first) { 4804 (void) printf("%s", 4805 deleg_node->dpn_perm.dp_name); 4806 first = B_FALSE; 4807 } else 4808 (void) printf(",%s", 4809 deleg_node->dpn_perm.dp_name); 4810 } 4811 4812 (void) printf("\n"); 4813 } 4814 } 4815 4816 static void inline 4817 print_uge_deleg_perms(uu_avl_t *who_avl, boolean_t local, boolean_t descend, 4818 const char *title) 4819 { 4820 who_perm_node_t *who_node = NULL; 4821 boolean_t prt_title = B_TRUE; 4822 uu_avl_walk_t *walk; 4823 4824 if ((walk = uu_avl_walk_start(who_avl, UU_WALK_ROBUST)) == NULL) 4825 nomem(); 4826 4827 while ((who_node = uu_avl_walk_next(walk)) != NULL) { 4828 const char *who_name = who_node->who_perm.who_name; 4829 const char *nice_who_name = who_node->who_perm.who_ug_name; 4830 uu_avl_t *avl = who_node->who_perm.who_deleg_perm_avl; 4831 zfs_deleg_who_type_t who_type = who_node->who_perm.who_type; 4832 char delim = ' '; 4833 deleg_perm_node_t *deleg_node; 4834 boolean_t prt_who = B_TRUE; 4835 4836 for (deleg_node = uu_avl_first(avl); 4837 deleg_node != NULL; 4838 deleg_node = uu_avl_next(avl, deleg_node)) { 4839 if (local != deleg_node->dpn_perm.dp_local || 4840 descend != deleg_node->dpn_perm.dp_descend) 4841 continue; 4842 4843 if (prt_who) { 4844 const char *who = NULL; 4845 if (prt_title) { 4846 prt_title = B_FALSE; 4847 (void) printf(title); 4848 } 4849 4850 switch (who_type) { 4851 case ZFS_DELEG_USER_SETS: 4852 case ZFS_DELEG_USER: 4853 who = gettext("user"); 4854 if (nice_who_name) 4855 who_name = nice_who_name; 4856 break; 4857 case ZFS_DELEG_GROUP_SETS: 4858 case ZFS_DELEG_GROUP: 4859 who = gettext("group"); 4860 if (nice_who_name) 4861 who_name = nice_who_name; 4862 break; 4863 case ZFS_DELEG_EVERYONE_SETS: 4864 case ZFS_DELEG_EVERYONE: 4865 who = gettext("everyone"); 4866 who_name = NULL; 4867 } 4868 4869 prt_who = B_FALSE; 4870 if (who_name == NULL) 4871 (void) printf("\t%s", who); 4872 else 4873 (void) printf("\t%s %s", who, who_name); 4874 } 4875 4876 (void) printf("%c%s", delim, 4877 deleg_node->dpn_perm.dp_name); 4878 delim = ','; 4879 } 4880 4881 if (!prt_who) 4882 (void) printf("\n"); 4883 } 4884 4885 uu_avl_walk_end(walk); 4886 } 4887 4888 static void 4889 print_fs_perms(fs_perm_set_t *fspset) 4890 { 4891 fs_perm_node_t *node = NULL; 4892 char buf[ZFS_MAXNAMELEN+32]; 4893 const char *dsname = buf; 4894 4895 for (node = uu_list_first(fspset->fsps_list); node != NULL; 4896 node = uu_list_next(fspset->fsps_list, node)) { 4897 uu_avl_t *sc_avl = node->fspn_fsperm.fsp_sc_avl; 4898 uu_avl_t *uge_avl = node->fspn_fsperm.fsp_uge_avl; 4899 int left = 0; 4900 4901 (void) snprintf(buf, ZFS_MAXNAMELEN+32, 4902 gettext("---- Permissions on %s "), 4903 node->fspn_fsperm.fsp_name); 4904 (void) printf(dsname); 4905 left = 70 - strlen(buf); 4906 while (left-- > 0) 4907 (void) printf("-"); 4908 (void) printf("\n"); 4909 4910 print_set_creat_perms(sc_avl); 4911 print_uge_deleg_perms(uge_avl, B_TRUE, B_FALSE, 4912 gettext("Local permissions:\n")); 4913 print_uge_deleg_perms(uge_avl, B_FALSE, B_TRUE, 4914 gettext("Descendent permissions:\n")); 4915 print_uge_deleg_perms(uge_avl, B_TRUE, B_TRUE, 4916 gettext("Local+Descendent permissions:\n")); 4917 } 4918 } 4919 4920 static fs_perm_set_t fs_perm_set = { NULL, NULL, NULL, NULL }; 4921 4922 struct deleg_perms { 4923 boolean_t un; 4924 nvlist_t *nvl; 4925 }; 4926 4927 static int 4928 set_deleg_perms(zfs_handle_t *zhp, void *data) 4929 { 4930 struct deleg_perms *perms = (struct deleg_perms *)data; 4931 zfs_type_t zfs_type = zfs_get_type(zhp); 4932 4933 if (zfs_type != ZFS_TYPE_FILESYSTEM && zfs_type != ZFS_TYPE_VOLUME) 4934 return (0); 4935 4936 return (zfs_set_fsacl(zhp, perms->un, perms->nvl)); 4937 } 4938 4939 static int 4940 zfs_do_allow_unallow_impl(int argc, char **argv, boolean_t un) 4941 { 4942 zfs_handle_t *zhp; 4943 nvlist_t *perm_nvl = NULL; 4944 nvlist_t *update_perm_nvl = NULL; 4945 int error = 1; 4946 int c; 4947 struct allow_opts opts = { 0 }; 4948 4949 const char *optstr = un ? "ldugecsrh" : "ldugecsh"; 4950 4951 /* check opts */ 4952 while ((c = getopt(argc, argv, optstr)) != -1) { 4953 switch (c) { 4954 case 'l': 4955 opts.local = B_TRUE; 4956 break; 4957 case 'd': 4958 opts.descend = B_TRUE; 4959 break; 4960 case 'u': 4961 opts.user = B_TRUE; 4962 break; 4963 case 'g': 4964 opts.group = B_TRUE; 4965 break; 4966 case 'e': 4967 opts.everyone = B_TRUE; 4968 break; 4969 case 's': 4970 opts.set = B_TRUE; 4971 break; 4972 case 'c': 4973 opts.create = B_TRUE; 4974 break; 4975 case 'r': 4976 opts.recursive = B_TRUE; 4977 break; 4978 case ':': 4979 (void) fprintf(stderr, gettext("missing argument for " 4980 "'%c' option\n"), optopt); 4981 usage(B_FALSE); 4982 break; 4983 case 'h': 4984 opts.prt_usage = B_TRUE; 4985 break; 4986 case '?': 4987 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 4988 optopt); 4989 usage(B_FALSE); 4990 } 4991 } 4992 4993 argc -= optind; 4994 argv += optind; 4995 4996 /* check arguments */ 4997 parse_allow_args(argc, argv, un, &opts); 4998 4999 /* try to open the dataset */ 5000 if ((zhp = zfs_open(g_zfs, opts.dataset, ZFS_TYPE_FILESYSTEM | 5001 ZFS_TYPE_VOLUME)) == NULL) { 5002 (void) fprintf(stderr, "Failed to open dataset: %s\n", 5003 opts.dataset); 5004 return (-1); 5005 } 5006 5007 if (zfs_get_fsacl(zhp, &perm_nvl) != 0) 5008 goto cleanup2; 5009 5010 fs_perm_set_init(&fs_perm_set); 5011 if (parse_fs_perm_set(&fs_perm_set, perm_nvl) != 0) { 5012 (void) fprintf(stderr, "Failed to parse fsacl permissions\n"); 5013 goto cleanup1; 5014 } 5015 5016 if (opts.prt_perms) 5017 print_fs_perms(&fs_perm_set); 5018 else { 5019 (void) construct_fsacl_list(un, &opts, &update_perm_nvl); 5020 if (zfs_set_fsacl(zhp, un, update_perm_nvl) != 0) 5021 goto cleanup0; 5022 5023 if (un && opts.recursive) { 5024 struct deleg_perms data = { un, update_perm_nvl }; 5025 if (zfs_iter_filesystems(zhp, set_deleg_perms, 5026 &data) != 0) 5027 goto cleanup0; 5028 } 5029 } 5030 5031 error = 0; 5032 5033 cleanup0: 5034 nvlist_free(perm_nvl); 5035 if (update_perm_nvl != NULL) 5036 nvlist_free(update_perm_nvl); 5037 cleanup1: 5038 fs_perm_set_fini(&fs_perm_set); 5039 cleanup2: 5040 zfs_close(zhp); 5041 5042 return (error); 5043 } 5044 5045 /* 5046 * zfs allow [-r] [-t] <tag> <snap> ... 5047 * 5048 * -r Recursively hold 5049 * -t Temporary hold (hidden option) 5050 * 5051 * Apply a user-hold with the given tag to the list of snapshots. 5052 */ 5053 static int 5054 zfs_do_allow(int argc, char **argv) 5055 { 5056 return (zfs_do_allow_unallow_impl(argc, argv, B_FALSE)); 5057 } 5058 5059 /* 5060 * zfs unallow [-r] [-t] <tag> <snap> ... 5061 * 5062 * -r Recursively hold 5063 * -t Temporary hold (hidden option) 5064 * 5065 * Apply a user-hold with the given tag to the list of snapshots. 5066 */ 5067 static int 5068 zfs_do_unallow(int argc, char **argv) 5069 { 5070 return (zfs_do_allow_unallow_impl(argc, argv, B_TRUE)); 5071 } 5072 5073 static int 5074 zfs_do_hold_rele_impl(int argc, char **argv, boolean_t holding) 5075 { 5076 int errors = 0; 5077 int i; 5078 const char *tag; 5079 boolean_t recursive = B_FALSE; 5080 boolean_t temphold = B_FALSE; 5081 const char *opts = holding ? "rt" : "r"; 5082 int c; 5083 5084 /* check options */ 5085 while ((c = getopt(argc, argv, opts)) != -1) { 5086 switch (c) { 5087 case 'r': 5088 recursive = B_TRUE; 5089 break; 5090 case 't': 5091 temphold = B_TRUE; 5092 break; 5093 case '?': 5094 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 5095 optopt); 5096 usage(B_FALSE); 5097 } 5098 } 5099 5100 argc -= optind; 5101 argv += optind; 5102 5103 /* check number of arguments */ 5104 if (argc < 2) 5105 usage(B_FALSE); 5106 5107 tag = argv[0]; 5108 --argc; 5109 ++argv; 5110 5111 if (holding && tag[0] == '.') { 5112 /* tags starting with '.' are reserved for libzfs */ 5113 (void) fprintf(stderr, gettext("tag may not start with '.'\n")); 5114 usage(B_FALSE); 5115 } 5116 5117 for (i = 0; i < argc; ++i) { 5118 zfs_handle_t *zhp; 5119 char parent[ZFS_MAXNAMELEN]; 5120 const char *delim; 5121 char *path = argv[i]; 5122 5123 delim = strchr(path, '@'); 5124 if (delim == NULL) { 5125 (void) fprintf(stderr, 5126 gettext("'%s' is not a snapshot\n"), path); 5127 ++errors; 5128 continue; 5129 } 5130 (void) strncpy(parent, path, delim - path); 5131 parent[delim - path] = '\0'; 5132 5133 zhp = zfs_open(g_zfs, parent, 5134 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 5135 if (zhp == NULL) { 5136 ++errors; 5137 continue; 5138 } 5139 if (holding) { 5140 if (zfs_hold(zhp, delim+1, tag, recursive, 5141 temphold, B_FALSE, -1, 0, 0) != 0) 5142 ++errors; 5143 } else { 5144 if (zfs_release(zhp, delim+1, tag, recursive) != 0) 5145 ++errors; 5146 } 5147 zfs_close(zhp); 5148 } 5149 5150 return (errors != 0); 5151 } 5152 5153 /* 5154 * zfs hold [-r] [-t] <tag> <snap> ... 5155 * 5156 * -r Recursively hold 5157 * -t Temporary hold (hidden option) 5158 * 5159 * Apply a user-hold with the given tag to the list of snapshots. 5160 */ 5161 static int 5162 zfs_do_hold(int argc, char **argv) 5163 { 5164 return (zfs_do_hold_rele_impl(argc, argv, B_TRUE)); 5165 } 5166 5167 /* 5168 * zfs release [-r] <tag> <snap> ... 5169 * 5170 * -r Recursively release 5171 * 5172 * Release a user-hold with the given tag from the list of snapshots. 5173 */ 5174 static int 5175 zfs_do_release(int argc, char **argv) 5176 { 5177 return (zfs_do_hold_rele_impl(argc, argv, B_FALSE)); 5178 } 5179 5180 typedef struct holds_cbdata { 5181 boolean_t cb_recursive; 5182 const char *cb_snapname; 5183 nvlist_t **cb_nvlp; 5184 size_t cb_max_namelen; 5185 size_t cb_max_taglen; 5186 } holds_cbdata_t; 5187 5188 #define STRFTIME_FMT_STR "%a %b %e %k:%M %Y" 5189 #define DATETIME_BUF_LEN (32) 5190 /* 5191 * 5192 */ 5193 static void 5194 print_holds(boolean_t scripted, size_t nwidth, size_t tagwidth, nvlist_t *nvl) 5195 { 5196 int i; 5197 nvpair_t *nvp = NULL; 5198 char *hdr_cols[] = { "NAME", "TAG", "TIMESTAMP" }; 5199 const char *col; 5200 5201 if (!scripted) { 5202 for (i = 0; i < 3; i++) { 5203 col = gettext(hdr_cols[i]); 5204 if (i < 2) 5205 (void) printf("%-*s ", i ? tagwidth : nwidth, 5206 col); 5207 else 5208 (void) printf("%s\n", col); 5209 } 5210 } 5211 5212 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) { 5213 char *zname = nvpair_name(nvp); 5214 nvlist_t *nvl2; 5215 nvpair_t *nvp2 = NULL; 5216 (void) nvpair_value_nvlist(nvp, &nvl2); 5217 while ((nvp2 = nvlist_next_nvpair(nvl2, nvp2)) != NULL) { 5218 char tsbuf[DATETIME_BUF_LEN]; 5219 char *tagname = nvpair_name(nvp2); 5220 uint64_t val = 0; 5221 time_t time; 5222 struct tm t; 5223 char sep = scripted ? '\t' : ' '; 5224 size_t sepnum = scripted ? 1 : 2; 5225 5226 (void) nvpair_value_uint64(nvp2, &val); 5227 time = (time_t)val; 5228 (void) localtime_r(&time, &t); 5229 (void) strftime(tsbuf, DATETIME_BUF_LEN, 5230 gettext(STRFTIME_FMT_STR), &t); 5231 5232 (void) printf("%-*s%*c%-*s%*c%s\n", nwidth, zname, 5233 sepnum, sep, tagwidth, tagname, sepnum, sep, tsbuf); 5234 } 5235 } 5236 } 5237 5238 /* 5239 * Generic callback function to list a dataset or snapshot. 5240 */ 5241 static int 5242 holds_callback(zfs_handle_t *zhp, void *data) 5243 { 5244 holds_cbdata_t *cbp = data; 5245 nvlist_t *top_nvl = *cbp->cb_nvlp; 5246 nvlist_t *nvl = NULL; 5247 nvpair_t *nvp = NULL; 5248 const char *zname = zfs_get_name(zhp); 5249 size_t znamelen = strnlen(zname, ZFS_MAXNAMELEN); 5250 5251 if (cbp->cb_recursive) { 5252 const char *snapname; 5253 char *delim = strchr(zname, '@'); 5254 if (delim == NULL) 5255 return (0); 5256 5257 snapname = delim + 1; 5258 if (strcmp(cbp->cb_snapname, snapname)) 5259 return (0); 5260 } 5261 5262 if (zfs_get_holds(zhp, &nvl) != 0) 5263 return (-1); 5264 5265 if (znamelen > cbp->cb_max_namelen) 5266 cbp->cb_max_namelen = znamelen; 5267 5268 while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) { 5269 const char *tag = nvpair_name(nvp); 5270 size_t taglen = strnlen(tag, MAXNAMELEN); 5271 if (taglen > cbp->cb_max_taglen) 5272 cbp->cb_max_taglen = taglen; 5273 } 5274 5275 return (nvlist_add_nvlist(top_nvl, zname, nvl)); 5276 } 5277 5278 /* 5279 * zfs holds [-r] <snap> ... 5280 * 5281 * -r Recursively hold 5282 */ 5283 static int 5284 zfs_do_holds(int argc, char **argv) 5285 { 5286 int errors = 0; 5287 int c; 5288 int i; 5289 boolean_t scripted = B_FALSE; 5290 boolean_t recursive = B_FALSE; 5291 const char *opts = "rH"; 5292 nvlist_t *nvl; 5293 5294 int types = ZFS_TYPE_SNAPSHOT; 5295 holds_cbdata_t cb = { 0 }; 5296 5297 int limit = 0; 5298 int ret = 0; 5299 int flags = 0; 5300 5301 /* check options */ 5302 while ((c = getopt(argc, argv, opts)) != -1) { 5303 switch (c) { 5304 case 'r': 5305 recursive = B_TRUE; 5306 break; 5307 case 'H': 5308 scripted = B_TRUE; 5309 break; 5310 case '?': 5311 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 5312 optopt); 5313 usage(B_FALSE); 5314 } 5315 } 5316 5317 if (recursive) { 5318 types |= ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME; 5319 flags |= ZFS_ITER_RECURSE; 5320 } 5321 5322 argc -= optind; 5323 argv += optind; 5324 5325 /* check number of arguments */ 5326 if (argc < 1) 5327 usage(B_FALSE); 5328 5329 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) 5330 nomem(); 5331 5332 for (i = 0; i < argc; ++i) { 5333 char *snapshot = argv[i]; 5334 const char *delim; 5335 const char *snapname; 5336 5337 delim = strchr(snapshot, '@'); 5338 if (delim == NULL) { 5339 (void) fprintf(stderr, 5340 gettext("'%s' is not a snapshot\n"), snapshot); 5341 ++errors; 5342 continue; 5343 } 5344 snapname = delim + 1; 5345 if (recursive) 5346 snapshot[delim - snapshot] = '\0'; 5347 5348 cb.cb_recursive = recursive; 5349 cb.cb_snapname = snapname; 5350 cb.cb_nvlp = &nvl; 5351 5352 /* 5353 * 1. collect holds data, set format options 5354 */ 5355 ret = zfs_for_each(argc, argv, flags, types, NULL, NULL, limit, 5356 holds_callback, &cb); 5357 if (ret != 0) 5358 ++errors; 5359 } 5360 5361 /* 5362 * 2. print holds data 5363 */ 5364 print_holds(scripted, cb.cb_max_namelen, cb.cb_max_taglen, nvl); 5365 5366 if (nvlist_empty(nvl)) 5367 (void) printf(gettext("no datasets available\n")); 5368 5369 nvlist_free(nvl); 5370 5371 return (0 != errors); 5372 } 5373 5374 #define CHECK_SPINNER 30 5375 #define SPINNER_TIME 3 /* seconds */ 5376 #define MOUNT_TIME 5 /* seconds */ 5377 5378 static int 5379 get_one_dataset(zfs_handle_t *zhp, void *data) 5380 { 5381 static char *spin[] = { "-", "\\", "|", "/" }; 5382 static int spinval = 0; 5383 static int spincheck = 0; 5384 static time_t last_spin_time = (time_t)0; 5385 get_all_cb_t *cbp = data; 5386 zfs_type_t type = zfs_get_type(zhp); 5387 5388 if (cbp->cb_verbose) { 5389 if (--spincheck < 0) { 5390 time_t now = time(NULL); 5391 if (last_spin_time + SPINNER_TIME < now) { 5392 update_progress(spin[spinval++ % 4]); 5393 last_spin_time = now; 5394 } 5395 spincheck = CHECK_SPINNER; 5396 } 5397 } 5398 5399 /* 5400 * Interate over any nested datasets. 5401 */ 5402 if (zfs_iter_filesystems(zhp, get_one_dataset, data) != 0) { 5403 zfs_close(zhp); 5404 return (1); 5405 } 5406 5407 /* 5408 * Skip any datasets whose type does not match. 5409 */ 5410 if ((type & ZFS_TYPE_FILESYSTEM) == 0) { 5411 zfs_close(zhp); 5412 return (0); 5413 } 5414 libzfs_add_handle(cbp, zhp); 5415 assert(cbp->cb_used <= cbp->cb_alloc); 5416 5417 return (0); 5418 } 5419 5420 static void 5421 get_all_datasets(zfs_handle_t ***dslist, size_t *count, boolean_t verbose) 5422 { 5423 get_all_cb_t cb = { 0 }; 5424 cb.cb_verbose = verbose; 5425 cb.cb_getone = get_one_dataset; 5426 5427 if (verbose) 5428 set_progress_header(gettext("Reading ZFS config")); 5429 (void) zfs_iter_root(g_zfs, get_one_dataset, &cb); 5430 5431 *dslist = cb.cb_handles; 5432 *count = cb.cb_used; 5433 5434 if (verbose) 5435 finish_progress(gettext("done.")); 5436 } 5437 5438 /* 5439 * Generic callback for sharing or mounting filesystems. Because the code is so 5440 * similar, we have a common function with an extra parameter to determine which 5441 * mode we are using. 5442 */ 5443 #define OP_SHARE 0x1 5444 #define OP_MOUNT 0x2 5445 5446 /* 5447 * Share or mount a dataset. 5448 */ 5449 static int 5450 share_mount_one(zfs_handle_t *zhp, int op, int flags, char *protocol, 5451 boolean_t explicit, const char *options) 5452 { 5453 char mountpoint[ZFS_MAXPROPLEN]; 5454 char shareopts[ZFS_MAXPROPLEN]; 5455 char smbshareopts[ZFS_MAXPROPLEN]; 5456 const char *cmdname = op == OP_SHARE ? "share" : "mount"; 5457 struct mnttab mnt; 5458 uint64_t zoned, canmount; 5459 boolean_t shared_nfs, shared_smb; 5460 5461 assert(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM); 5462 5463 /* 5464 * Check to make sure we can mount/share this dataset. If we 5465 * are in the global zone and the filesystem is exported to a 5466 * local zone, or if we are in a local zone and the 5467 * filesystem is not exported, then it is an error. 5468 */ 5469 zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED); 5470 5471 if (zoned && getzoneid() == GLOBAL_ZONEID) { 5472 if (!explicit) 5473 return (0); 5474 5475 (void) fprintf(stderr, gettext("cannot %s '%s': " 5476 "dataset is exported to a local zone\n"), cmdname, 5477 zfs_get_name(zhp)); 5478 return (1); 5479 5480 } else if (!zoned && getzoneid() != GLOBAL_ZONEID) { 5481 if (!explicit) 5482 return (0); 5483 5484 (void) fprintf(stderr, gettext("cannot %s '%s': " 5485 "permission denied\n"), cmdname, 5486 zfs_get_name(zhp)); 5487 return (1); 5488 } 5489 5490 /* 5491 * Ignore any filesystems which don't apply to us. This 5492 * includes those with a legacy mountpoint, or those with 5493 * legacy share options. 5494 */ 5495 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint, 5496 sizeof (mountpoint), NULL, NULL, 0, B_FALSE) == 0); 5497 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, shareopts, 5498 sizeof (shareopts), NULL, NULL, 0, B_FALSE) == 0); 5499 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshareopts, 5500 sizeof (smbshareopts), NULL, NULL, 0, B_FALSE) == 0); 5501 5502 if (op == OP_SHARE && strcmp(shareopts, "off") == 0 && 5503 strcmp(smbshareopts, "off") == 0) { 5504 if (!explicit) 5505 return (0); 5506 5507 (void) fprintf(stderr, gettext("cannot share '%s': " 5508 "legacy share\n"), zfs_get_name(zhp)); 5509 (void) fprintf(stderr, gettext("use share(1M) to " 5510 "share this filesystem, or set " 5511 "sharenfs property on\n")); 5512 return (1); 5513 } 5514 5515 /* 5516 * We cannot share or mount legacy filesystems. If the 5517 * shareopts is non-legacy but the mountpoint is legacy, we 5518 * treat it as a legacy share. 5519 */ 5520 if (strcmp(mountpoint, "legacy") == 0) { 5521 if (!explicit) 5522 return (0); 5523 5524 (void) fprintf(stderr, gettext("cannot %s '%s': " 5525 "legacy mountpoint\n"), cmdname, zfs_get_name(zhp)); 5526 (void) fprintf(stderr, gettext("use %s(1M) to " 5527 "%s this filesystem\n"), cmdname, cmdname); 5528 return (1); 5529 } 5530 5531 if (strcmp(mountpoint, "none") == 0) { 5532 if (!explicit) 5533 return (0); 5534 5535 (void) fprintf(stderr, gettext("cannot %s '%s': no " 5536 "mountpoint set\n"), cmdname, zfs_get_name(zhp)); 5537 return (1); 5538 } 5539 5540 /* 5541 * canmount explicit outcome 5542 * on no pass through 5543 * on yes pass through 5544 * off no return 0 5545 * off yes display error, return 1 5546 * noauto no return 0 5547 * noauto yes pass through 5548 */ 5549 canmount = zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT); 5550 if (canmount == ZFS_CANMOUNT_OFF) { 5551 if (!explicit) 5552 return (0); 5553 5554 (void) fprintf(stderr, gettext("cannot %s '%s': " 5555 "'canmount' property is set to 'off'\n"), cmdname, 5556 zfs_get_name(zhp)); 5557 return (1); 5558 } else if (canmount == ZFS_CANMOUNT_NOAUTO && !explicit) { 5559 return (0); 5560 } 5561 5562 /* 5563 * At this point, we have verified that the mountpoint and/or 5564 * shareopts are appropriate for auto management. If the 5565 * filesystem is already mounted or shared, return (failing 5566 * for explicit requests); otherwise mount or share the 5567 * filesystem. 5568 */ 5569 switch (op) { 5570 case OP_SHARE: 5571 5572 shared_nfs = zfs_is_shared_nfs(zhp, NULL); 5573 shared_smb = zfs_is_shared_smb(zhp, NULL); 5574 5575 if (shared_nfs && shared_smb || 5576 (shared_nfs && strcmp(shareopts, "on") == 0 && 5577 strcmp(smbshareopts, "off") == 0) || 5578 (shared_smb && strcmp(smbshareopts, "on") == 0 && 5579 strcmp(shareopts, "off") == 0)) { 5580 if (!explicit) 5581 return (0); 5582 5583 (void) fprintf(stderr, gettext("cannot share " 5584 "'%s': filesystem already shared\n"), 5585 zfs_get_name(zhp)); 5586 return (1); 5587 } 5588 5589 if (!zfs_is_mounted(zhp, NULL) && 5590 zfs_mount(zhp, NULL, 0) != 0) 5591 return (1); 5592 5593 if (protocol == NULL) { 5594 if (zfs_shareall(zhp) != 0) 5595 return (1); 5596 } else if (strcmp(protocol, "nfs") == 0) { 5597 if (zfs_share_nfs(zhp)) 5598 return (1); 5599 } else if (strcmp(protocol, "smb") == 0) { 5600 if (zfs_share_smb(zhp)) 5601 return (1); 5602 } else { 5603 (void) fprintf(stderr, gettext("cannot share " 5604 "'%s': invalid share type '%s' " 5605 "specified\n"), 5606 zfs_get_name(zhp), protocol); 5607 return (1); 5608 } 5609 5610 break; 5611 5612 case OP_MOUNT: 5613 if (options == NULL) 5614 mnt.mnt_mntopts = ""; 5615 else 5616 mnt.mnt_mntopts = (char *)options; 5617 5618 if (!hasmntopt(&mnt, MNTOPT_REMOUNT) && 5619 zfs_is_mounted(zhp, NULL)) { 5620 if (!explicit) 5621 return (0); 5622 5623 (void) fprintf(stderr, gettext("cannot mount " 5624 "'%s': filesystem already mounted\n"), 5625 zfs_get_name(zhp)); 5626 return (1); 5627 } 5628 5629 if (zfs_mount(zhp, options, flags) != 0) 5630 return (1); 5631 break; 5632 } 5633 5634 return (0); 5635 } 5636 5637 /* 5638 * Reports progress in the form "(current/total)". Not thread-safe. 5639 */ 5640 static void 5641 report_mount_progress(int current, int total) 5642 { 5643 static time_t last_progress_time = 0; 5644 time_t now = time(NULL); 5645 char info[32]; 5646 5647 /* report 1..n instead of 0..n-1 */ 5648 ++current; 5649 5650 /* display header if we're here for the first time */ 5651 if (current == 1) { 5652 set_progress_header(gettext("Mounting ZFS filesystems")); 5653 } else if (current != total && last_progress_time + MOUNT_TIME >= now) { 5654 /* too soon to report again */ 5655 return; 5656 } 5657 5658 last_progress_time = now; 5659 5660 (void) sprintf(info, "(%d/%d)", current, total); 5661 5662 if (current == total) 5663 finish_progress(info); 5664 else 5665 update_progress(info); 5666 } 5667 5668 static void 5669 append_options(char *mntopts, char *newopts) 5670 { 5671 int len = strlen(mntopts); 5672 5673 /* original length plus new string to append plus 1 for the comma */ 5674 if (len + 1 + strlen(newopts) >= MNT_LINE_MAX) { 5675 (void) fprintf(stderr, gettext("the opts argument for " 5676 "'%c' option is too long (more than %d chars)\n"), 5677 "-o", MNT_LINE_MAX); 5678 usage(B_FALSE); 5679 } 5680 5681 if (*mntopts) 5682 mntopts[len++] = ','; 5683 5684 (void) strcpy(&mntopts[len], newopts); 5685 } 5686 5687 static int 5688 share_mount(int op, int argc, char **argv) 5689 { 5690 int do_all = 0; 5691 boolean_t verbose = B_FALSE; 5692 int c, ret = 0; 5693 char *options = NULL; 5694 int flags = 0; 5695 5696 /* check options */ 5697 while ((c = getopt(argc, argv, op == OP_MOUNT ? ":avo:O" : "a")) 5698 != -1) { 5699 switch (c) { 5700 case 'a': 5701 do_all = 1; 5702 break; 5703 case 'v': 5704 verbose = B_TRUE; 5705 break; 5706 case 'o': 5707 if (*optarg == '\0') { 5708 (void) fprintf(stderr, gettext("empty mount " 5709 "options (-o) specified\n")); 5710 usage(B_FALSE); 5711 } 5712 5713 if (options == NULL) 5714 options = safe_malloc(MNT_LINE_MAX + 1); 5715 5716 /* option validation is done later */ 5717 append_options(options, optarg); 5718 break; 5719 5720 case 'O': 5721 flags |= MS_OVERLAY; 5722 break; 5723 case ':': 5724 (void) fprintf(stderr, gettext("missing argument for " 5725 "'%c' option\n"), optopt); 5726 usage(B_FALSE); 5727 break; 5728 case '?': 5729 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 5730 optopt); 5731 usage(B_FALSE); 5732 } 5733 } 5734 5735 argc -= optind; 5736 argv += optind; 5737 5738 /* check number of arguments */ 5739 if (do_all) { 5740 zfs_handle_t **dslist = NULL; 5741 size_t i, count = 0; 5742 char *protocol = NULL; 5743 5744 if (op == OP_SHARE && argc > 0) { 5745 if (strcmp(argv[0], "nfs") != 0 && 5746 strcmp(argv[0], "smb") != 0) { 5747 (void) fprintf(stderr, gettext("share type " 5748 "must be 'nfs' or 'smb'\n")); 5749 usage(B_FALSE); 5750 } 5751 protocol = argv[0]; 5752 argc--; 5753 argv++; 5754 } 5755 5756 if (argc != 0) { 5757 (void) fprintf(stderr, gettext("too many arguments\n")); 5758 usage(B_FALSE); 5759 } 5760 5761 start_progress_timer(); 5762 get_all_datasets(&dslist, &count, verbose); 5763 5764 if (count == 0) 5765 return (0); 5766 5767 qsort(dslist, count, sizeof (void *), libzfs_dataset_cmp); 5768 5769 for (i = 0; i < count; i++) { 5770 if (verbose) 5771 report_mount_progress(i, count); 5772 5773 if (share_mount_one(dslist[i], op, flags, protocol, 5774 B_FALSE, options) != 0) 5775 ret = 1; 5776 zfs_close(dslist[i]); 5777 } 5778 5779 free(dslist); 5780 } else if (argc == 0) { 5781 struct mnttab entry; 5782 5783 if ((op == OP_SHARE) || (options != NULL)) { 5784 (void) fprintf(stderr, gettext("missing filesystem " 5785 "argument (specify -a for all)\n")); 5786 usage(B_FALSE); 5787 } 5788 5789 /* 5790 * When mount is given no arguments, go through /etc/mnttab and 5791 * display any active ZFS mounts. We hide any snapshots, since 5792 * they are controlled automatically. 5793 */ 5794 rewind(mnttab_file); 5795 while (getmntent(mnttab_file, &entry) == 0) { 5796 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0 || 5797 strchr(entry.mnt_special, '@') != NULL) 5798 continue; 5799 5800 (void) printf("%-30s %s\n", entry.mnt_special, 5801 entry.mnt_mountp); 5802 } 5803 5804 } else { 5805 zfs_handle_t *zhp; 5806 5807 if (argc > 1) { 5808 (void) fprintf(stderr, 5809 gettext("too many arguments\n")); 5810 usage(B_FALSE); 5811 } 5812 5813 if ((zhp = zfs_open(g_zfs, argv[0], 5814 ZFS_TYPE_FILESYSTEM)) == NULL) { 5815 ret = 1; 5816 } else { 5817 ret = share_mount_one(zhp, op, flags, NULL, B_TRUE, 5818 options); 5819 zfs_close(zhp); 5820 } 5821 } 5822 5823 return (ret); 5824 } 5825 5826 /* 5827 * zfs mount -a [nfs] 5828 * zfs mount filesystem 5829 * 5830 * Mount all filesystems, or mount the given filesystem. 5831 */ 5832 static int 5833 zfs_do_mount(int argc, char **argv) 5834 { 5835 return (share_mount(OP_MOUNT, argc, argv)); 5836 } 5837 5838 /* 5839 * zfs share -a [nfs | smb] 5840 * zfs share filesystem 5841 * 5842 * Share all filesystems, or share the given filesystem. 5843 */ 5844 static int 5845 zfs_do_share(int argc, char **argv) 5846 { 5847 return (share_mount(OP_SHARE, argc, argv)); 5848 } 5849 5850 typedef struct unshare_unmount_node { 5851 zfs_handle_t *un_zhp; 5852 char *un_mountp; 5853 uu_avl_node_t un_avlnode; 5854 } unshare_unmount_node_t; 5855 5856 /* ARGSUSED */ 5857 static int 5858 unshare_unmount_compare(const void *larg, const void *rarg, void *unused) 5859 { 5860 const unshare_unmount_node_t *l = larg; 5861 const unshare_unmount_node_t *r = rarg; 5862 5863 return (strcmp(l->un_mountp, r->un_mountp)); 5864 } 5865 5866 /* 5867 * Convenience routine used by zfs_do_umount() and manual_unmount(). Given an 5868 * absolute path, find the entry /etc/mnttab, verify that its a ZFS filesystem, 5869 * and unmount it appropriately. 5870 */ 5871 static int 5872 unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual) 5873 { 5874 zfs_handle_t *zhp; 5875 int ret = 0; 5876 struct stat64 statbuf; 5877 struct extmnttab entry; 5878 const char *cmdname = (op == OP_SHARE) ? "unshare" : "unmount"; 5879 ino_t path_inode; 5880 5881 /* 5882 * Search for the path in /etc/mnttab. Rather than looking for the 5883 * specific path, which can be fooled by non-standard paths (i.e. ".." 5884 * or "//"), we stat() the path and search for the corresponding 5885 * (major,minor) device pair. 5886 */ 5887 if (stat64(path, &statbuf) != 0) { 5888 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"), 5889 cmdname, path, strerror(errno)); 5890 return (1); 5891 } 5892 path_inode = statbuf.st_ino; 5893 5894 /* 5895 * Search for the given (major,minor) pair in the mount table. 5896 */ 5897 rewind(mnttab_file); 5898 while ((ret = getextmntent(mnttab_file, &entry, 0)) == 0) { 5899 if (entry.mnt_major == major(statbuf.st_dev) && 5900 entry.mnt_minor == minor(statbuf.st_dev)) 5901 break; 5902 } 5903 if (ret != 0) { 5904 if (op == OP_SHARE) { 5905 (void) fprintf(stderr, gettext("cannot %s '%s': not " 5906 "currently mounted\n"), cmdname, path); 5907 return (1); 5908 } 5909 (void) fprintf(stderr, gettext("warning: %s not in mnttab\n"), 5910 path); 5911 if ((ret = umount2(path, flags)) != 0) 5912 (void) fprintf(stderr, gettext("%s: %s\n"), path, 5913 strerror(errno)); 5914 return (ret != 0); 5915 } 5916 5917 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) { 5918 (void) fprintf(stderr, gettext("cannot %s '%s': not a ZFS " 5919 "filesystem\n"), cmdname, path); 5920 return (1); 5921 } 5922 5923 if ((zhp = zfs_open(g_zfs, entry.mnt_special, 5924 ZFS_TYPE_FILESYSTEM)) == NULL) 5925 return (1); 5926 5927 ret = 1; 5928 if (stat64(entry.mnt_mountp, &statbuf) != 0) { 5929 (void) fprintf(stderr, gettext("cannot %s '%s': %s\n"), 5930 cmdname, path, strerror(errno)); 5931 goto out; 5932 } else if (statbuf.st_ino != path_inode) { 5933 (void) fprintf(stderr, gettext("cannot " 5934 "%s '%s': not a mountpoint\n"), cmdname, path); 5935 goto out; 5936 } 5937 5938 if (op == OP_SHARE) { 5939 char nfs_mnt_prop[ZFS_MAXPROPLEN]; 5940 char smbshare_prop[ZFS_MAXPROPLEN]; 5941 5942 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, nfs_mnt_prop, 5943 sizeof (nfs_mnt_prop), NULL, NULL, 0, B_FALSE) == 0); 5944 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, smbshare_prop, 5945 sizeof (smbshare_prop), NULL, NULL, 0, B_FALSE) == 0); 5946 5947 if (strcmp(nfs_mnt_prop, "off") == 0 && 5948 strcmp(smbshare_prop, "off") == 0) { 5949 (void) fprintf(stderr, gettext("cannot unshare " 5950 "'%s': legacy share\n"), path); 5951 (void) fprintf(stderr, gettext("use " 5952 "unshare(1M) to unshare this filesystem\n")); 5953 } else if (!zfs_is_shared(zhp)) { 5954 (void) fprintf(stderr, gettext("cannot unshare '%s': " 5955 "not currently shared\n"), path); 5956 } else { 5957 ret = zfs_unshareall_bypath(zhp, path); 5958 } 5959 } else { 5960 char mtpt_prop[ZFS_MAXPROPLEN]; 5961 5962 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mtpt_prop, 5963 sizeof (mtpt_prop), NULL, NULL, 0, B_FALSE) == 0); 5964 5965 if (is_manual) { 5966 ret = zfs_unmount(zhp, NULL, flags); 5967 } else if (strcmp(mtpt_prop, "legacy") == 0) { 5968 (void) fprintf(stderr, gettext("cannot unmount " 5969 "'%s': legacy mountpoint\n"), 5970 zfs_get_name(zhp)); 5971 (void) fprintf(stderr, gettext("use umount(1M) " 5972 "to unmount this filesystem\n")); 5973 } else { 5974 ret = zfs_unmountall(zhp, flags); 5975 } 5976 } 5977 5978 out: 5979 zfs_close(zhp); 5980 5981 return (ret != 0); 5982 } 5983 5984 /* 5985 * Generic callback for unsharing or unmounting a filesystem. 5986 */ 5987 static int 5988 unshare_unmount(int op, int argc, char **argv) 5989 { 5990 int do_all = 0; 5991 int flags = 0; 5992 int ret = 0; 5993 int c; 5994 zfs_handle_t *zhp; 5995 char nfs_mnt_prop[ZFS_MAXPROPLEN]; 5996 char sharesmb[ZFS_MAXPROPLEN]; 5997 5998 /* check options */ 5999 while ((c = getopt(argc, argv, op == OP_SHARE ? "a" : "af")) != -1) { 6000 switch (c) { 6001 case 'a': 6002 do_all = 1; 6003 break; 6004 case 'f': 6005 flags = MS_FORCE; 6006 break; 6007 case '?': 6008 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 6009 optopt); 6010 usage(B_FALSE); 6011 } 6012 } 6013 6014 argc -= optind; 6015 argv += optind; 6016 6017 if (do_all) { 6018 /* 6019 * We could make use of zfs_for_each() to walk all datasets in 6020 * the system, but this would be very inefficient, especially 6021 * since we would have to linearly search /etc/mnttab for each 6022 * one. Instead, do one pass through /etc/mnttab looking for 6023 * zfs entries and call zfs_unmount() for each one. 6024 * 6025 * Things get a little tricky if the administrator has created 6026 * mountpoints beneath other ZFS filesystems. In this case, we 6027 * have to unmount the deepest filesystems first. To accomplish 6028 * this, we place all the mountpoints in an AVL tree sorted by 6029 * the special type (dataset name), and walk the result in 6030 * reverse to make sure to get any snapshots first. 6031 */ 6032 struct mnttab entry; 6033 uu_avl_pool_t *pool; 6034 uu_avl_t *tree; 6035 unshare_unmount_node_t *node; 6036 uu_avl_index_t idx; 6037 uu_avl_walk_t *walk; 6038 6039 if (argc != 0) { 6040 (void) fprintf(stderr, gettext("too many arguments\n")); 6041 usage(B_FALSE); 6042 } 6043 6044 if (((pool = uu_avl_pool_create("unmount_pool", 6045 sizeof (unshare_unmount_node_t), 6046 offsetof(unshare_unmount_node_t, un_avlnode), 6047 unshare_unmount_compare, UU_DEFAULT)) == NULL) || 6048 ((tree = uu_avl_create(pool, NULL, UU_DEFAULT)) == NULL)) 6049 nomem(); 6050 6051 rewind(mnttab_file); 6052 while (getmntent(mnttab_file, &entry) == 0) { 6053 6054 /* ignore non-ZFS entries */ 6055 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) 6056 continue; 6057 6058 /* ignore snapshots */ 6059 if (strchr(entry.mnt_special, '@') != NULL) 6060 continue; 6061 6062 if ((zhp = zfs_open(g_zfs, entry.mnt_special, 6063 ZFS_TYPE_FILESYSTEM)) == NULL) { 6064 ret = 1; 6065 continue; 6066 } 6067 6068 switch (op) { 6069 case OP_SHARE: 6070 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, 6071 nfs_mnt_prop, 6072 sizeof (nfs_mnt_prop), 6073 NULL, NULL, 0, B_FALSE) == 0); 6074 if (strcmp(nfs_mnt_prop, "off") != 0) 6075 break; 6076 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, 6077 nfs_mnt_prop, 6078 sizeof (nfs_mnt_prop), 6079 NULL, NULL, 0, B_FALSE) == 0); 6080 if (strcmp(nfs_mnt_prop, "off") == 0) 6081 continue; 6082 break; 6083 case OP_MOUNT: 6084 /* Ignore legacy mounts */ 6085 verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, 6086 nfs_mnt_prop, 6087 sizeof (nfs_mnt_prop), 6088 NULL, NULL, 0, B_FALSE) == 0); 6089 if (strcmp(nfs_mnt_prop, "legacy") == 0) 6090 continue; 6091 /* Ignore canmount=noauto mounts */ 6092 if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == 6093 ZFS_CANMOUNT_NOAUTO) 6094 continue; 6095 default: 6096 break; 6097 } 6098 6099 node = safe_malloc(sizeof (unshare_unmount_node_t)); 6100 node->un_zhp = zhp; 6101 node->un_mountp = safe_strdup(entry.mnt_mountp); 6102 6103 uu_avl_node_init(node, &node->un_avlnode, pool); 6104 6105 if (uu_avl_find(tree, node, NULL, &idx) == NULL) { 6106 uu_avl_insert(tree, node, idx); 6107 } else { 6108 zfs_close(node->un_zhp); 6109 free(node->un_mountp); 6110 free(node); 6111 } 6112 } 6113 6114 /* 6115 * Walk the AVL tree in reverse, unmounting each filesystem and 6116 * removing it from the AVL tree in the process. 6117 */ 6118 if ((walk = uu_avl_walk_start(tree, 6119 UU_WALK_REVERSE | UU_WALK_ROBUST)) == NULL) 6120 nomem(); 6121 6122 while ((node = uu_avl_walk_next(walk)) != NULL) { 6123 uu_avl_remove(tree, node); 6124 6125 switch (op) { 6126 case OP_SHARE: 6127 if (zfs_unshareall_bypath(node->un_zhp, 6128 node->un_mountp) != 0) 6129 ret = 1; 6130 break; 6131 6132 case OP_MOUNT: 6133 if (zfs_unmount(node->un_zhp, 6134 node->un_mountp, flags) != 0) 6135 ret = 1; 6136 break; 6137 } 6138 6139 zfs_close(node->un_zhp); 6140 free(node->un_mountp); 6141 free(node); 6142 } 6143 6144 uu_avl_walk_end(walk); 6145 uu_avl_destroy(tree); 6146 uu_avl_pool_destroy(pool); 6147 6148 } else { 6149 if (argc != 1) { 6150 if (argc == 0) 6151 (void) fprintf(stderr, 6152 gettext("missing filesystem argument\n")); 6153 else 6154 (void) fprintf(stderr, 6155 gettext("too many arguments\n")); 6156 usage(B_FALSE); 6157 } 6158 6159 /* 6160 * We have an argument, but it may be a full path or a ZFS 6161 * filesystem. Pass full paths off to unmount_path() (shared by 6162 * manual_unmount), otherwise open the filesystem and pass to 6163 * zfs_unmount(). 6164 */ 6165 if (argv[0][0] == '/') 6166 return (unshare_unmount_path(op, argv[0], 6167 flags, B_FALSE)); 6168 6169 if ((zhp = zfs_open(g_zfs, argv[0], 6170 ZFS_TYPE_FILESYSTEM)) == NULL) 6171 return (1); 6172 6173 verify(zfs_prop_get(zhp, op == OP_SHARE ? 6174 ZFS_PROP_SHARENFS : ZFS_PROP_MOUNTPOINT, 6175 nfs_mnt_prop, sizeof (nfs_mnt_prop), NULL, 6176 NULL, 0, B_FALSE) == 0); 6177 6178 switch (op) { 6179 case OP_SHARE: 6180 verify(zfs_prop_get(zhp, ZFS_PROP_SHARENFS, 6181 nfs_mnt_prop, 6182 sizeof (nfs_mnt_prop), 6183 NULL, NULL, 0, B_FALSE) == 0); 6184 verify(zfs_prop_get(zhp, ZFS_PROP_SHARESMB, 6185 sharesmb, sizeof (sharesmb), NULL, NULL, 6186 0, B_FALSE) == 0); 6187 6188 if (strcmp(nfs_mnt_prop, "off") == 0 && 6189 strcmp(sharesmb, "off") == 0) { 6190 (void) fprintf(stderr, gettext("cannot " 6191 "unshare '%s': legacy share\n"), 6192 zfs_get_name(zhp)); 6193 (void) fprintf(stderr, gettext("use " 6194 "unshare(1M) to unshare this " 6195 "filesystem\n")); 6196 ret = 1; 6197 } else if (!zfs_is_shared(zhp)) { 6198 (void) fprintf(stderr, gettext("cannot " 6199 "unshare '%s': not currently " 6200 "shared\n"), zfs_get_name(zhp)); 6201 ret = 1; 6202 } else if (zfs_unshareall(zhp) != 0) { 6203 ret = 1; 6204 } 6205 break; 6206 6207 case OP_MOUNT: 6208 if (strcmp(nfs_mnt_prop, "legacy") == 0) { 6209 (void) fprintf(stderr, gettext("cannot " 6210 "unmount '%s': legacy " 6211 "mountpoint\n"), zfs_get_name(zhp)); 6212 (void) fprintf(stderr, gettext("use " 6213 "umount(1M) to unmount this " 6214 "filesystem\n")); 6215 ret = 1; 6216 } else if (!zfs_is_mounted(zhp, NULL)) { 6217 (void) fprintf(stderr, gettext("cannot " 6218 "unmount '%s': not currently " 6219 "mounted\n"), 6220 zfs_get_name(zhp)); 6221 ret = 1; 6222 } else if (zfs_unmountall(zhp, flags) != 0) { 6223 ret = 1; 6224 } 6225 break; 6226 } 6227 6228 zfs_close(zhp); 6229 } 6230 6231 return (ret); 6232 } 6233 6234 /* 6235 * zfs unmount -a 6236 * zfs unmount filesystem 6237 * 6238 * Unmount all filesystems, or a specific ZFS filesystem. 6239 */ 6240 static int 6241 zfs_do_unmount(int argc, char **argv) 6242 { 6243 return (unshare_unmount(OP_MOUNT, argc, argv)); 6244 } 6245 6246 /* 6247 * zfs unshare -a 6248 * zfs unshare filesystem 6249 * 6250 * Unshare all filesystems, or a specific ZFS filesystem. 6251 */ 6252 static int 6253 zfs_do_unshare(int argc, char **argv) 6254 { 6255 return (unshare_unmount(OP_SHARE, argc, argv)); 6256 } 6257 6258 /* 6259 * Called when invoked as /etc/fs/zfs/mount. Do the mount if the mountpoint is 6260 * 'legacy'. Otherwise, complain that use should be using 'zfs mount'. 6261 */ 6262 static int 6263 manual_mount(int argc, char **argv) 6264 { 6265 zfs_handle_t *zhp; 6266 char mountpoint[ZFS_MAXPROPLEN]; 6267 char mntopts[MNT_LINE_MAX] = { '\0' }; 6268 int ret = 0; 6269 int c; 6270 int flags = 0; 6271 char *dataset, *path; 6272 6273 /* check options */ 6274 while ((c = getopt(argc, argv, ":mo:O")) != -1) { 6275 switch (c) { 6276 case 'o': 6277 (void) strlcpy(mntopts, optarg, sizeof (mntopts)); 6278 break; 6279 case 'O': 6280 flags |= MS_OVERLAY; 6281 break; 6282 case 'm': 6283 flags |= MS_NOMNTTAB; 6284 break; 6285 case ':': 6286 (void) fprintf(stderr, gettext("missing argument for " 6287 "'%c' option\n"), optopt); 6288 usage(B_FALSE); 6289 break; 6290 case '?': 6291 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 6292 optopt); 6293 (void) fprintf(stderr, gettext("usage: mount [-o opts] " 6294 "<path>\n")); 6295 return (2); 6296 } 6297 } 6298 6299 argc -= optind; 6300 argv += optind; 6301 6302 /* check that we only have two arguments */ 6303 if (argc != 2) { 6304 if (argc == 0) 6305 (void) fprintf(stderr, gettext("missing dataset " 6306 "argument\n")); 6307 else if (argc == 1) 6308 (void) fprintf(stderr, 6309 gettext("missing mountpoint argument\n")); 6310 else 6311 (void) fprintf(stderr, gettext("too many arguments\n")); 6312 (void) fprintf(stderr, "usage: mount <dataset> <mountpoint>\n"); 6313 return (2); 6314 } 6315 6316 dataset = argv[0]; 6317 path = argv[1]; 6318 6319 /* try to open the dataset */ 6320 if ((zhp = zfs_open(g_zfs, dataset, ZFS_TYPE_FILESYSTEM)) == NULL) 6321 return (1); 6322 6323 (void) zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint, 6324 sizeof (mountpoint), NULL, NULL, 0, B_FALSE); 6325 6326 /* check for legacy mountpoint and complain appropriately */ 6327 ret = 0; 6328 if (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) == 0) { 6329 if (mount(dataset, path, MS_OPTIONSTR | flags, MNTTYPE_ZFS, 6330 NULL, 0, mntopts, sizeof (mntopts)) != 0) { 6331 (void) fprintf(stderr, gettext("mount failed: %s\n"), 6332 strerror(errno)); 6333 ret = 1; 6334 } 6335 } else { 6336 (void) fprintf(stderr, gettext("filesystem '%s' cannot be " 6337 "mounted using 'mount -F zfs'\n"), dataset); 6338 (void) fprintf(stderr, gettext("Use 'zfs set mountpoint=%s' " 6339 "instead.\n"), path); 6340 (void) fprintf(stderr, gettext("If you must use 'mount -F zfs' " 6341 "or /etc/vfstab, use 'zfs set mountpoint=legacy'.\n")); 6342 (void) fprintf(stderr, gettext("See zfs(1M) for more " 6343 "information.\n")); 6344 ret = 1; 6345 } 6346 6347 return (ret); 6348 } 6349 6350 /* 6351 * Called when invoked as /etc/fs/zfs/umount. Unlike a manual mount, we allow 6352 * unmounts of non-legacy filesystems, as this is the dominant administrative 6353 * interface. 6354 */ 6355 static int 6356 manual_unmount(int argc, char **argv) 6357 { 6358 int flags = 0; 6359 int c; 6360 6361 /* check options */ 6362 while ((c = getopt(argc, argv, "f")) != -1) { 6363 switch (c) { 6364 case 'f': 6365 flags = MS_FORCE; 6366 break; 6367 case '?': 6368 (void) fprintf(stderr, gettext("invalid option '%c'\n"), 6369 optopt); 6370 (void) fprintf(stderr, gettext("usage: unmount [-f] " 6371 "<path>\n")); 6372 return (2); 6373 } 6374 } 6375 6376 argc -= optind; 6377 argv += optind; 6378 6379 /* check arguments */ 6380 if (argc != 1) { 6381 if (argc == 0) 6382 (void) fprintf(stderr, gettext("missing path " 6383 "argument\n")); 6384 else 6385 (void) fprintf(stderr, gettext("too many arguments\n")); 6386 (void) fprintf(stderr, gettext("usage: unmount [-f] <path>\n")); 6387 return (2); 6388 } 6389 6390 return (unshare_unmount_path(OP_MOUNT, argv[0], flags, B_TRUE)); 6391 } 6392 6393 static int 6394 find_command_idx(char *command, int *idx) 6395 { 6396 int i; 6397 6398 for (i = 0; i < NCOMMAND; i++) { 6399 if (command_table[i].name == NULL) 6400 continue; 6401 6402 if (strcmp(command, command_table[i].name) == 0) { 6403 *idx = i; 6404 return (0); 6405 } 6406 } 6407 return (1); 6408 } 6409 6410 static int 6411 zfs_do_diff(int argc, char **argv) 6412 { 6413 zfs_handle_t *zhp; 6414 int flags = 0; 6415 char *tosnap = NULL; 6416 char *fromsnap = NULL; 6417 char *atp, *copy; 6418 int err = 0; 6419 int c; 6420 6421 while ((c = getopt(argc, argv, "FHt")) != -1) { 6422 switch (c) { 6423 case 'F': 6424 flags |= ZFS_DIFF_CLASSIFY; 6425 break; 6426 case 'H': 6427 flags |= ZFS_DIFF_PARSEABLE; 6428 break; 6429 case 't': 6430 flags |= ZFS_DIFF_TIMESTAMP; 6431 break; 6432 default: 6433 (void) fprintf(stderr, 6434 gettext("invalid option '%c'\n"), optopt); 6435 usage(B_FALSE); 6436 } 6437 } 6438 6439 argc -= optind; 6440 argv += optind; 6441 6442 if (argc < 1) { 6443 (void) fprintf(stderr, 6444 gettext("must provide at least one snapshot name\n")); 6445 usage(B_FALSE); 6446 } 6447 6448 if (argc > 2) { 6449 (void) fprintf(stderr, gettext("too many arguments\n")); 6450 usage(B_FALSE); 6451 } 6452 6453 fromsnap = argv[0]; 6454 tosnap = (argc == 2) ? argv[1] : NULL; 6455 6456 copy = NULL; 6457 if (*fromsnap != '@') 6458 copy = strdup(fromsnap); 6459 else if (tosnap) 6460 copy = strdup(tosnap); 6461 if (copy == NULL) 6462 usage(B_FALSE); 6463 6464 if (atp = strchr(copy, '@')) 6465 *atp = '\0'; 6466 6467 if ((zhp = zfs_open(g_zfs, copy, ZFS_TYPE_FILESYSTEM)) == NULL) 6468 return (1); 6469 6470 free(copy); 6471 6472 /* 6473 * Ignore SIGPIPE so that the library can give us 6474 * information on any failure 6475 */ 6476 (void) sigignore(SIGPIPE); 6477 6478 err = zfs_show_diffs(zhp, STDOUT_FILENO, fromsnap, tosnap, flags); 6479 6480 zfs_close(zhp); 6481 6482 return (err != 0); 6483 } 6484 6485 int 6486 main(int argc, char **argv) 6487 { 6488 int ret = 0; 6489 int i; 6490 char *progname; 6491 char *cmdname; 6492 6493 (void) setlocale(LC_ALL, ""); 6494 (void) textdomain(TEXT_DOMAIN); 6495 6496 opterr = 0; 6497 6498 if ((g_zfs = libzfs_init()) == NULL) { 6499 (void) fprintf(stderr, gettext("internal error: failed to " 6500 "initialize ZFS library\n")); 6501 return (1); 6502 } 6503 6504 zfs_save_arguments(argc, argv, history_str, sizeof (history_str)); 6505 6506 libzfs_print_on_error(g_zfs, B_TRUE); 6507 6508 if ((mnttab_file = fopen(MNTTAB, "r")) == NULL) { 6509 (void) fprintf(stderr, gettext("internal error: unable to " 6510 "open %s\n"), MNTTAB); 6511 return (1); 6512 } 6513 6514 /* 6515 * This command also doubles as the /etc/fs mount and unmount program. 6516 * Determine if we should take this behavior based on argv[0]. 6517 */ 6518 progname = basename(argv[0]); 6519 if (strcmp(progname, "mount") == 0) { 6520 ret = manual_mount(argc, argv); 6521 } else if (strcmp(progname, "umount") == 0) { 6522 ret = manual_unmount(argc, argv); 6523 } else { 6524 /* 6525 * Make sure the user has specified some command. 6526 */ 6527 if (argc < 2) { 6528 (void) fprintf(stderr, gettext("missing command\n")); 6529 usage(B_FALSE); 6530 } 6531 6532 cmdname = argv[1]; 6533 6534 /* 6535 * The 'umount' command is an alias for 'unmount' 6536 */ 6537 if (strcmp(cmdname, "umount") == 0) 6538 cmdname = "unmount"; 6539 6540 /* 6541 * The 'recv' command is an alias for 'receive' 6542 */ 6543 if (strcmp(cmdname, "recv") == 0) 6544 cmdname = "receive"; 6545 6546 /* 6547 * Special case '-?' 6548 */ 6549 if (strcmp(cmdname, "-?") == 0) 6550 usage(B_TRUE); 6551 6552 /* 6553 * Run the appropriate command. 6554 */ 6555 libzfs_mnttab_cache(g_zfs, B_TRUE); 6556 if (find_command_idx(cmdname, &i) == 0) { 6557 current_command = &command_table[i]; 6558 ret = command_table[i].func(argc - 1, argv + 1); 6559 } else if (strchr(cmdname, '=') != NULL) { 6560 verify(find_command_idx("set", &i) == 0); 6561 current_command = &command_table[i]; 6562 ret = command_table[i].func(argc, argv); 6563 } else { 6564 (void) fprintf(stderr, gettext("unrecognized " 6565 "command '%s'\n"), cmdname); 6566 usage(B_FALSE); 6567 } 6568 libzfs_mnttab_cache(g_zfs, B_FALSE); 6569 } 6570 6571 (void) fclose(mnttab_file); 6572 6573 if (ret == 0 && log_history) 6574 (void) zpool_log_history(g_zfs, history_str); 6575 6576 libzfs_fini(g_zfs); 6577 6578 /* 6579 * The 'ZFS_ABORT' environment variable causes us to dump core on exit 6580 * for the purposes of running ::findleaks. 6581 */ 6582 if (getenv("ZFS_ABORT") != NULL) { 6583 (void) printf("dumping core by request\n"); 6584 abort(); 6585 } 6586 6587 return (ret); 6588 } 6589