Update 'zfs send' documentation
[zfs.git] / cmd / zfs / zfs_main.c
index e2c39a8..b6dc6d4 100644 (file)
@@ -238,7 +238,7 @@ get_usage(zfs_help_t idx)
        case HELP_ROLLBACK:
                return (gettext("\trollback [-rRf] <snapshot>\n"));
        case HELP_SEND:
-               return (gettext("\tsend [-RDp] [-[iI] snapshot] <snapshot>\n"));
+               return (gettext("\tsend [-vRDp] [-[iI] snapshot] <snapshot>\n"));
        case HELP_SET:
                return (gettext("\tset <property=value> "
                    "<filesystem|volume|snapshot> ...\n"));
@@ -318,7 +318,6 @@ safe_malloc(size_t size)
        return (data);
 }
 
-#ifdef HAVE_ZPL
 static char *
 safe_strdup(char *str)
 {
@@ -329,7 +328,6 @@ safe_strdup(char *str)
 
        return (dupstr);
 }
-#endif /* HAVE_ZPL */
 
 /*
  * Callback routine that will print out information for each of
@@ -497,7 +495,6 @@ parse_depth(char *opt, int *flags)
 
 #define        PROGRESS_DELAY 2                /* seconds */
 
-#ifdef HAVE_ZPL
 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";
 static time_t pt_begin;
 static char *pt_header = NULL;
@@ -549,7 +546,6 @@ finish_progress(char *done)
        free(pt_header);
        pt_header = NULL;
 }
-#endif /* HAVE_ZPL */
 
 /*
  * zfs clone [-p] [-o prop=value] ... <snap> <fs | vol>
@@ -631,7 +627,6 @@ zfs_do_clone(int argc, char **argv)
        ret = zfs_clone(zhp, argv[1], props);
 
        /* create the mountpoint if necessary */
-#ifdef HAVE_ZPL
        if (ret == 0) {
                zfs_handle_t *clone;
 
@@ -643,7 +638,6 @@ zfs_do_clone(int argc, char **argv)
                        zfs_close(clone);
                }
        }
-#endif /* HAVE_ZPL */
 
        zfs_close(zhp);
        nvlist_free(props);
@@ -831,7 +825,6 @@ zfs_do_create(int argc, char **argv)
         * verbose error message to let the user know that their filesystem was
         * in fact created, even if we failed to mount or share it.
         */
-#ifdef HAVE_ZPL
        if (canmount == ZFS_CANMOUNT_ON) {
                if (zfs_mount(zhp, NULL, 0) != 0) {
                        (void) fprintf(stderr, gettext("filesystem "
@@ -843,7 +836,6 @@ zfs_do_create(int argc, char **argv)
                        ret = 1;
                }
        }
-#endif /* HAVE_ZPL */
 
 error:
        if (zhp)
@@ -1887,16 +1879,6 @@ zfs_do_userspace(int argc, char **argv)
        zfs_userquota_prop_t p;
        int error;
 
-       /*
-        * Try the python version.  If the execv fails, we'll continue
-        * and do a simplistic implementation.
-        */
-       (void) execv(pypath, argv-1);
-
-       (void) printf("internal error: %s not found\n"
-           "falling back on built-in implementation, "
-           "some features will not work\n", pypath);
-
        if ((zhp = zfs_open(g_zfs, argv[argc-1], ZFS_TYPE_DATASET)) == NULL)
                return (1);
 
@@ -2340,7 +2322,6 @@ typedef struct rollback_cbdata {
  * 'cb_dependent' is set, then this is a dependent and we should report it
  * without checking the transaction group.
  */
-#ifdef HAVE_ZPL
 static int
 rollback_check(zfs_handle_t *zhp, void *data)
 {
@@ -2400,12 +2381,10 @@ rollback_check(zfs_handle_t *zhp, void *data)
        zfs_close(zhp);
        return (0);
 }
-#endif /* HAVE_ZPL */
 
 static int
 zfs_do_rollback(int argc, char **argv)
 {
-#ifdef HAVE_ZPL
        int ret;
        int c;
        boolean_t force = B_FALSE;
@@ -2487,9 +2466,6 @@ out:
                return (0);
        else
                return (1);
-#else
-       return ENOSYS;
-#endif /*HAVE_ZPL*/
 }
 
 /*
@@ -2955,7 +2931,6 @@ zfs_do_release(int argc, char **argv)
 #define        SPINNER_TIME 3          /* seconds */
 #define        MOUNT_TIME 5            /* seconds */
 
-#ifdef HAVE_ZPL
 static int
 get_one_dataset(zfs_handle_t *zhp, void *data)
 {
@@ -3275,7 +3250,7 @@ share_mount(int op, int argc, char **argv)
        int flags = 0;
 
        /* check options */
-       while ((c = getopt(argc, argv, op == OP_MOUNT ? ":avo:O" : "a"))
+       while ((c = getopt(argc, argv, op == OP_MOUNT ? ":avo:" : "a"))
            != -1) {
                switch (c) {
                case 'a':
@@ -3298,9 +3273,6 @@ share_mount(int op, int argc, char **argv)
                        append_options(options, optarg);
                        break;
 
-               case 'O':
-                       flags |= MS_OVERLAY;
-                       break;
                case ':':
                        (void) fprintf(stderr, gettext("missing argument for "
                            "'%c' option\n"), optopt);
@@ -3368,7 +3340,7 @@ share_mount(int op, int argc, char **argv)
                }
 
                /*
-                * When mount is given no arguments, go through /etc/mnttab and
+                * When mount is given no arguments, go through /etc/mtab and
                 * display any active ZFS mounts.  We hide any snapshots, since
                 * they are controlled automatically.
                 */
@@ -3403,7 +3375,6 @@ share_mount(int op, int argc, char **argv)
 
        return (ret);
 }
-#endif  /* HAVE_ZPL */
 
 /*
  * zfs mount -a [nfs]
@@ -3414,11 +3385,7 @@ share_mount(int op, int argc, char **argv)
 static int
 zfs_do_mount(int argc, char **argv)
 {
-#ifdef HAVE_ZPL
        return (share_mount(OP_MOUNT, argc, argv));
-#else
-       return ENOSYS;
-#endif  /* HAVE_ZPL */
 }
 
 /*
@@ -3430,14 +3397,9 @@ zfs_do_mount(int argc, char **argv)
 static int
 zfs_do_share(int argc, char **argv)
 {
-#ifdef HAVE_ZPL
        return (share_mount(OP_SHARE, argc, argv));
-#else
-       return ENOSYS;
-#endif  /* HAVE_ZPL */
 }
 
-#ifdef HAVE_ZPL
 typedef struct unshare_unmount_node {
        zfs_handle_t    *un_zhp;
        char            *un_mountp;
@@ -3456,7 +3418,7 @@ unshare_unmount_compare(const void *larg, const void *rarg, void *unused)
 
 /*
  * Convenience routine used by zfs_do_umount() and manual_unmount().  Given an
- * absolute path, find the entry /etc/mnttab, verify that its a ZFS filesystem,
+ * absolute path, find the entry /etc/mtab, verify that its a ZFS filesystem,
  * and unmount it appropriately.
  */
 static int
@@ -3470,7 +3432,7 @@ unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual)
        ino_t path_inode;
 
        /*
-        * Search for the path in /etc/mnttab.  Rather than looking for the
+        * Search for the path in /etc/mtab.  Rather than looking for the
         * specific path, which can be fooled by non-standard paths (i.e. ".."
         * or "//"), we stat() the path and search for the corresponding
         * (major,minor) device pair.
@@ -3497,7 +3459,7 @@ unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual)
                            "currently mounted\n"), cmdname, path);
                        return (1);
                }
-               (void) fprintf(stderr, gettext("warning: %s not in mnttab\n"),
+               (void) fprintf(stderr, gettext("warning: %s not in mtab\n"),
                    path);
                if ((ret = umount2(path, flags)) != 0)
                        (void) fprintf(stderr, gettext("%s: %s\n"), path,
@@ -3539,8 +3501,8 @@ unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual)
                    strcmp(smbshare_prop, "off") == 0) {
                        (void) fprintf(stderr, gettext("cannot unshare "
                            "'%s': legacy share\n"), path);
-                       (void) fprintf(stderr, gettext("use "
-                           "unshare(1M) to unshare this filesystem\n"));
+                       (void) fprintf(stderr, gettext("use exportfs(8) "
+                           "or smbcontrol(1) to unshare this filesystem\n"));
                } else if (!zfs_is_shared(zhp)) {
                        (void) fprintf(stderr, gettext("cannot unshare '%s': "
                            "not currently shared\n"), path);
@@ -3559,7 +3521,7 @@ unshare_unmount_path(int op, char *path, int flags, boolean_t is_manual)
                        (void) fprintf(stderr, gettext("cannot unmount "
                            "'%s': legacy mountpoint\n"),
                            zfs_get_name(zhp));
-                       (void) fprintf(stderr, gettext("use umount(1M) "
+                       (void) fprintf(stderr, gettext("use umount(8) "
                            "to unmount this filesystem\n"));
                } else {
                        ret = zfs_unmountall(zhp, flags);
@@ -3609,8 +3571,8 @@ unshare_unmount(int op, int argc, char **argv)
                /*
                 * We could make use of zfs_for_each() to walk all datasets in
                 * the system, but this would be very inefficient, especially
-                * since we would have to linearly search /etc/mnttab for each
-                * one.  Instead, do one pass through /etc/mnttab looking for
+                * since we would have to linearly search /etc/mtab for each
+                * one.  Instead, do one pass through /etc/mtab looking for
                 * zfs entries and call zfs_unmount() for each one.
                 *
                 * Things get a little tricky if the administrator has created
@@ -3821,7 +3783,6 @@ unshare_unmount(int op, int argc, char **argv)
 
        return (ret);
 }
-#endif  /* HAVE_ZPL */
 
 /*
  * zfs unmount -a
@@ -3832,11 +3793,7 @@ unshare_unmount(int op, int argc, char **argv)
 static int
 zfs_do_unmount(int argc, char **argv)
 {
-#ifdef HAVE_ZPL
        return (unshare_unmount(OP_MOUNT, argc, argv));
-#else
-       return ENOSYS;
-#endif  /* HAVE_ZPL */
 }
 
 /*
@@ -3848,11 +3805,7 @@ zfs_do_unmount(int argc, char **argv)
 static int
 zfs_do_unshare(int argc, char **argv)
 {
-#ifdef HAVE_ZPL
        return (unshare_unmount(OP_SHARE, argc, argv));
-#else
-       return ENOSYS;
-#endif  /* HAVE_ZPL */
 }
 
 /* ARGSUSED */
@@ -3864,143 +3817,6 @@ zfs_do_python(int argc, char **argv)
        return (-1);
 }
 
-/*
- * Called when invoked as /etc/fs/zfs/mount.  Do the mount if the mountpoint is
- * 'legacy'.  Otherwise, complain that use should be using 'zfs mount'.
- */
-#ifdef HAVE_ZPL
-static int
-manual_mount(int argc, char **argv)
-{
-       zfs_handle_t *zhp;
-       char mountpoint[ZFS_MAXPROPLEN];
-       char mntopts[MNT_LINE_MAX] = { '\0' };
-       int ret;
-       int c;
-       int flags = 0;
-       char *dataset, *path;
-
-       /* check options */
-       while ((c = getopt(argc, argv, ":mo:O")) != -1) {
-               switch (c) {
-               case 'o':
-                       (void) strlcpy(mntopts, optarg, sizeof (mntopts));
-                       break;
-               case 'O':
-                       flags |= MS_OVERLAY;
-                       break;
-               case 'm':
-                       flags |= MS_NOMNTTAB;
-                       break;
-               case ':':
-                       (void) fprintf(stderr, gettext("missing argument for "
-                           "'%c' option\n"), optopt);
-                       usage(B_FALSE);
-                       break;
-               case '?':
-                       (void) fprintf(stderr, gettext("invalid option '%c'\n"),
-                           optopt);
-                       (void) fprintf(stderr, gettext("usage: mount [-o opts] "
-                           "<path>\n"));
-                       return (2);
-               }
-       }
-
-       argc -= optind;
-       argv += optind;
-
-       /* check that we only have two arguments */
-       if (argc != 2) {
-               if (argc == 0)
-                       (void) fprintf(stderr, gettext("missing dataset "
-                           "argument\n"));
-               else if (argc == 1)
-                       (void) fprintf(stderr,
-                           gettext("missing mountpoint argument\n"));
-               else
-                       (void) fprintf(stderr, gettext("too many arguments\n"));
-               (void) fprintf(stderr, "usage: mount <dataset> <mountpoint>\n");
-               return (2);
-       }
-
-       dataset = argv[0];
-       path = argv[1];
-
-       /* try to open the dataset */
-       if ((zhp = zfs_open(g_zfs, dataset, ZFS_TYPE_FILESYSTEM)) == NULL)
-               return (1);
-
-       (void) zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, mountpoint,
-           sizeof (mountpoint), NULL, NULL, 0, B_FALSE);
-
-       /* check for legacy mountpoint and complain appropriately */
-       ret = 0;
-       if (strcmp(mountpoint, ZFS_MOUNTPOINT_LEGACY) == 0) {
-               if (mount(dataset, path, MS_OPTIONSTR | flags, MNTTYPE_ZFS,
-                   NULL, 0, mntopts, sizeof (mntopts)) != 0) {
-                       (void) fprintf(stderr, gettext("mount failed: %s\n"),
-                           strerror(errno));
-                       ret = 1;
-               }
-       } else {
-               (void) fprintf(stderr, gettext("filesystem '%s' cannot be "
-                   "mounted using 'mount -F zfs'\n"), dataset);
-               (void) fprintf(stderr, gettext("Use 'zfs set mountpoint=%s' "
-                   "instead.\n"), path);
-               (void) fprintf(stderr, gettext("If you must use 'mount -F zfs' "
-                   "or /etc/vfstab, use 'zfs set mountpoint=legacy'.\n"));
-               (void) fprintf(stderr, gettext("See zfs(1M) for more "
-                   "information.\n"));
-               ret = 1;
-       }
-
-       return (ret);
-}
-
-/*
- * Called when invoked as /etc/fs/zfs/umount.  Unlike a manual mount, we allow
- * unmounts of non-legacy filesystems, as this is the dominant administrative
- * interface.
- */
-static int
-manual_unmount(int argc, char **argv)
-{
-       int flags = 0;
-       int c;
-
-       /* check options */
-       while ((c = getopt(argc, argv, "f")) != -1) {
-               switch (c) {
-               case 'f':
-                       flags = MS_FORCE;
-                       break;
-               case '?':
-                       (void) fprintf(stderr, gettext("invalid option '%c'\n"),
-                           optopt);
-                       (void) fprintf(stderr, gettext("usage: unmount [-f] "
-                           "<path>\n"));
-                       return (2);
-               }
-       }
-
-       argc -= optind;
-       argv += optind;
-
-       /* check arguments */
-       if (argc != 1) {
-               if (argc == 0)
-                       (void) fprintf(stderr, gettext("missing path "
-                           "argument\n"));
-               else
-                       (void) fprintf(stderr, gettext("too many arguments\n"));
-               (void) fprintf(stderr, gettext("usage: unmount [-f] <path>\n"));
-               return (2);
-       }
-
-       return (unshare_unmount_path(OP_MOUNT, argv[0], flags, B_TRUE));
-}
-#endif /* HAVE_ZPL */
-
 static int
 find_command_idx(char *command, int *idx)
 {
@@ -4098,9 +3914,6 @@ main(int argc, char **argv)
 {
        int ret;
        int i = 0;
-#ifdef HAVE_ZPL
-       char *progname;
-#endif
        char *cmdname;
 
        (void) setlocale(LC_ALL, "");
@@ -4114,81 +3927,65 @@ main(int argc, char **argv)
                return (1);
        }
 
-#ifdef HAVE_ZPL
        /*
-        * This command also doubles as the /etc/fs mount and unmount program.
-        * Determine if we should take this behavior based on argv[0].
+        * Make sure the user has specified some command.
         */
-       progname = basename(argv[0]);
-       if (strcmp(progname, "mount") == 0) {
-               ret = manual_mount(argc, argv);
-       } else if (strcmp(progname, "umount") == 0) {
-               ret = manual_unmount(argc, argv);
-       } else {
-#else
-       {
-#endif /* HAVE_ZPL */
-               /*
-                * Make sure the user has specified some command.
-                */
-               if (argc < 2) {
-                       (void) fprintf(stderr, gettext("missing command\n"));
-                       usage(B_FALSE);
-               }
+       if (argc < 2) {
+               (void) fprintf(stderr, gettext("missing command\n"));
+               usage(B_FALSE);
+       }
 
-               cmdname = argv[1];
+       cmdname = argv[1];
 
-               /*
-                * The 'umount' command is an alias for 'unmount'
-                */
-               if (strcmp(cmdname, "umount") == 0)
-                       cmdname = "unmount";
+       /*
+        * The 'umount' command is an alias for 'unmount'
+        */
+       if (strcmp(cmdname, "umount") == 0)
+               cmdname = "unmount";
 
-               /*
-                * The 'recv' command is an alias for 'receive'
-                */
-               if (strcmp(cmdname, "recv") == 0)
-                       cmdname = "receive";
+       /*
+        * The 'recv' command is an alias for 'receive'
+        */
+       if (strcmp(cmdname, "recv") == 0)
+               cmdname = "receive";
 
-               /*
-                * Special case '-?'
-                */
-               if ((strcmp(cmdname, "-?") == 0) ||
-                   (strcmp(cmdname, "--help") == 0))
-                       usage(B_TRUE);
+       /*
+        * Special case '-?'
+        */
+       if ((strcmp(cmdname, "-?") == 0) ||
+           (strcmp(cmdname, "--help") == 0))
+               usage(B_TRUE);
 
-               if ((g_zfs = libzfs_init()) == NULL)
-                       return (1);
+       if ((g_zfs = libzfs_init()) == NULL)
+               return (1);
 
-               zpool_set_history_str("zfs", argc, argv, history_str);
-               verify(zpool_stage_history(g_zfs, history_str) == 0);
+       zpool_set_history_str("zfs", argc, argv, history_str);
+       verify(zpool_stage_history(g_zfs, history_str) == 0);
 
-               libzfs_print_on_error(g_zfs, B_TRUE);
+       libzfs_print_on_error(g_zfs, B_TRUE);
 
-               /*
-                * Run the appropriate command.
-                */
-               libzfs_mnttab_cache(g_zfs, B_TRUE);
-               if (find_command_idx(cmdname, &i) == 0) {
-                       current_command = &command_table[i];
-                       ret = command_table[i].func(argc - 1, argv + 1);
-               } else if (strchr(cmdname, '=') != NULL) {
-                       verify(find_command_idx("set", &i) == 0);
-                       current_command = &command_table[i];
-                       ret = command_table[i].func(argc, argv);
-               } else {
-                       (void) fprintf(stderr, gettext("unrecognized "
-                           "command '%s'\n"), cmdname);
-                       usage(B_FALSE);
-                       ret = 1;
-               }
-               libzfs_mnttab_cache(g_zfs, B_FALSE);
+       /*
+        * Run the appropriate command.
+        */
+       libzfs_mnttab_cache(g_zfs, B_TRUE);
+       if (find_command_idx(cmdname, &i) == 0) {
+               current_command = &command_table[i];
+               ret = command_table[i].func(argc - 1, argv + 1);
+       } else if (strchr(cmdname, '=') != NULL) {
+               verify(find_command_idx("set", &i) == 0);
+               current_command = &command_table[i];
+               ret = command_table[i].func(argc, argv);
+       } else {
+               (void) fprintf(stderr, gettext("unrecognized "
+                   "command '%s'\n"), cmdname);
+               usage(B_FALSE);
+               ret = 1;
        }
+       libzfs_mnttab_cache(g_zfs, B_FALSE);
+       libzfs_fini(g_zfs);
 
        (void) fclose(mnttab_file);
 
-       libzfs_fini(g_zfs);
-
        /*
         * The 'ZFS_ABORT' environment variable causes us to dump core on exit
         * for the purposes of running ::findleaks.