]> granicus.if.org Git - zfs/blobdiff - lib/libzfs/libzfs_util.c
OpenZFS 9166 - zfs storage pool checkpoint
[zfs] / lib / libzfs / libzfs_util.c
index 926ed4ed8aa9647980a998e93878585da56450fb..a19b34415dbd81cd3febea95ad8859b6c26f192a 100644 (file)
 
 /*
  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
- * Copyright (c) 2013, Joyent, Inc. All rights reserved.
- * Copyright (c) 2011, 2014 by Delphix. All rights reserved.
+ * Copyright (c) 2018, Joyent, Inc. All rights reserved.
+ * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
+ * Copyright 2016 Igor Kozhukhov <ikozhukhov@gmail.com>
+ * Copyright (c) 2017 Datto Inc.
  */
 
 /*
@@ -43,7 +45,7 @@
 #include <sys/mnttab.h>
 #include <sys/mntent.h>
 #include <sys/types.h>
-#include <wait.h>
+#include <sys/wait.h>
 
 #include <libzfs.h>
 #include <libzfs_core.h>
@@ -51,6 +53,7 @@
 #include "libzfs_impl.h"
 #include "zfs_prop.h"
 #include "zfeature_common.h"
+#include <zfs_fletcher.h>
 
 int
 libzfs_errno(libzfs_handle_t *hdl)
@@ -67,9 +70,9 @@ libzfs_error_init(int error)
                    "loaded.\nTry running '/sbin/modprobe zfs' as root "
                    "to load them.\n"));
        case ENOENT:
-               return (dgettext(TEXT_DOMAIN, "The /dev/zfs device is "
-                   "missing and must be created.\nTry running 'udevadm "
-                   "trigger' as root to create it.\n"));
+               return (dgettext(TEXT_DOMAIN, "/dev/zfs and /proc/self/mounts "
+                   "are required.\nTry running 'udevadm trigger' and 'mount "
+                   "-t proc proc /proc' as root.\n"));
        case ENOEXEC:
                return (dgettext(TEXT_DOMAIN, "The ZFS modules cannot be "
                    "auto-loaded.\nTry running '/sbin/modprobe zfs' as "
@@ -244,6 +247,9 @@ libzfs_error_description(libzfs_handle_t *hdl)
        case EZFS_POSTSPLIT_ONLINE:
                return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
                    "into a new one"));
+       case EZFS_SCRUB_PAUSED:
+               return (dgettext(TEXT_DOMAIN, "scrub is paused; "
+                   "use 'zpool scrub' to resume"));
        case EZFS_SCRUBBING:
                return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
                    "use 'zpool scrub -s' to cancel current scrub"));
@@ -255,6 +261,25 @@ libzfs_error_description(libzfs_handle_t *hdl)
                return (dgettext(TEXT_DOMAIN, "invalid diff data"));
        case EZFS_POOLREADONLY:
                return (dgettext(TEXT_DOMAIN, "pool is read-only"));
+       case EZFS_NO_PENDING:
+               return (dgettext(TEXT_DOMAIN, "operation is not "
+                   "in progress"));
+       case EZFS_CHECKPOINT_EXISTS:
+               return (dgettext(TEXT_DOMAIN, "checkpoint exists"));
+       case EZFS_DISCARDING_CHECKPOINT:
+               return (dgettext(TEXT_DOMAIN, "currently discarding "
+                   "checkpoint"));
+       case EZFS_NO_CHECKPOINT:
+               return (dgettext(TEXT_DOMAIN, "checkpoint does not exist"));
+       case EZFS_DEVRM_IN_PROGRESS:
+               return (dgettext(TEXT_DOMAIN, "device removal in progress"));
+       case EZFS_VDEV_TOO_BIG:
+               return (dgettext(TEXT_DOMAIN, "device exceeds supported size"));
+       case EZFS_ACTIVE_POOL:
+               return (dgettext(TEXT_DOMAIN, "pool is imported on a "
+                   "different host"));
+       case EZFS_CRYPTOFAILED:
+               return (dgettext(TEXT_DOMAIN, "encryption failure"));
        case EZFS_UNKNOWN:
                return (dgettext(TEXT_DOMAIN, "unknown error"));
        default:
@@ -390,7 +415,7 @@ zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
        case ENOSPC:
        case EDQUOT:
                zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
-               return (-1);
+               break;
 
        case EEXIST:
                zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
@@ -417,6 +442,9 @@ zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
                    "pool I/O is currently suspended"));
                zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
                break;
+       case EREMOTEIO:
+               zfs_verror(hdl, EZFS_ACTIVE_POOL, fmt, ap);
+               break;
        default:
                zfs_error_aux(hdl, strerror(error));
                zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
@@ -468,6 +496,11 @@ zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
                zfs_verror(hdl, EZFS_BUSY, fmt, ap);
                break;
 
+       /* There is no pending operation to cancel */
+       case ENOTACTIVE:
+               zfs_verror(hdl, EZFS_NO_PENDING, fmt, ap);
+               break;
+
        case ENXIO:
                zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
                    "one or more devices is currently unavailable"));
@@ -505,7 +538,24 @@ zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
                    "block size out of range or does not match"));
                zfs_verror(hdl, EZFS_BADPROP, fmt, ap);
                break;
-
+       case EREMOTEIO:
+               zfs_verror(hdl, EZFS_ACTIVE_POOL, fmt, ap);
+               break;
+       case ZFS_ERR_CHECKPOINT_EXISTS:
+               zfs_verror(hdl, EZFS_CHECKPOINT_EXISTS, fmt, ap);
+               break;
+       case ZFS_ERR_DISCARDING_CHECKPOINT:
+               zfs_verror(hdl, EZFS_DISCARDING_CHECKPOINT, fmt, ap);
+               break;
+       case ZFS_ERR_NO_CHECKPOINT:
+               zfs_verror(hdl, EZFS_NO_CHECKPOINT, fmt, ap);
+               break;
+       case ZFS_ERR_DEVRM_IN_PROGRESS:
+               zfs_verror(hdl, EZFS_DEVRM_IN_PROGRESS, fmt, ap);
+               break;
+       case ZFS_ERR_VDEV_TOO_BIG:
+               zfs_verror(hdl, EZFS_VDEV_TOO_BIG, fmt, ap);
+               break;
        default:
                zfs_error_aux(hdl, strerror(error));
                zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
@@ -604,23 +654,31 @@ zfs_nicenum_format(uint64_t num, char *buf, size_t buflen,
        const char *u;
        const char *units[3][7] = {
            [ZFS_NICENUM_1024] = {"", "K", "M", "G", "T", "P", "E"},
+           [ZFS_NICENUM_BYTES] = {"B", "K", "M", "G", "T", "P", "E"},
            [ZFS_NICENUM_TIME] = {"ns", "us", "ms", "s", "?", "?", "?"}
        };
 
        const int units_len[] = {[ZFS_NICENUM_1024] = 6,
+           [ZFS_NICENUM_BYTES] = 6,
            [ZFS_NICENUM_TIME] = 4};
 
        const int k_unit[] = {  [ZFS_NICENUM_1024] = 1024,
+           [ZFS_NICENUM_BYTES] = 1024,
            [ZFS_NICENUM_TIME] = 1000};
 
        double val;
 
        if (format == ZFS_NICENUM_RAW) {
-               snprintf(buf, buflen, "%llu", (u_longlong_t) num);
+               snprintf(buf, buflen, "%llu", (u_longlong_t)num);
+               return;
+       } else if (format == ZFS_NICENUM_RAWTIME && num > 0) {
+               snprintf(buf, buflen, "%llu", (u_longlong_t)num);
+               return;
+       } else if (format == ZFS_NICENUM_RAWTIME && num == 0) {
+               snprintf(buf, buflen, "%s", "-");
                return;
        }
 
-
        while (n >= k_unit[format] && index < units_len[format]) {
                n /= k_unit[format];
                index++;
@@ -628,16 +686,16 @@ zfs_nicenum_format(uint64_t num, char *buf, size_t buflen,
 
        u = units[format][index];
 
-       /* Don't print 0ns times */
+       /* Don't print zero latencies since they're invalid */
        if ((format == ZFS_NICENUM_TIME) && (num == 0)) {
                (void) snprintf(buf, buflen, "-");
        } else if ((index == 0) || ((num %
-           (uint64_t) powl(k_unit[format], index)) == 0)) {
+           (uint64_t)powl(k_unit[format], index)) == 0)) {
                /*
                 * If this is an even multiple of the base, always display
                 * without any decimal precision.
                 */
-               (void) snprintf(buf, buflen, "%llu%s", (u_longlong_t) n, u);
+               (void) snprintf(buf, buflen, "%llu%s", (u_longlong_t)n, u);
 
        } else {
                /*
@@ -651,8 +709,8 @@ zfs_nicenum_format(uint64_t num, char *buf, size_t buflen,
                 */
                int i;
                for (i = 2; i >= 0; i--) {
-                       val = (double) num /
-                           (uint64_t) powl(k_unit[format], index);
+                       val = (double)num /
+                           (uint64_t)powl(k_unit[format], index);
 
                        /*
                         * Don't print floating point values for time.  Note,
@@ -704,7 +762,14 @@ zfs_niceraw(uint64_t num, char *buf, size_t buflen)
        zfs_nicenum_format(num, buf, buflen, ZFS_NICENUM_RAW);
 }
 
-
+/*
+ * Convert a number of bytes to an appropriately human-readable output.
+ */
+void
+zfs_nicebytes(uint64_t num, char *buf, size_t buflen)
+{
+       zfs_nicenum_format(num, buf, buflen, ZFS_NICENUM_BYTES);
+}
 
 void
 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
@@ -724,43 +789,185 @@ libzfs_module_loaded(const char *module)
        return (access(path, F_OK) == 0);
 }
 
-int
-libzfs_run_process(const char *path, char *argv[], int flags)
+
+/*
+ * Read lines from an open file descriptor and store them in an array of
+ * strings until EOF.  lines[] will be allocated and populated with all the
+ * lines read.  All newlines are replaced with NULL terminators for
+ * convenience.  lines[] must be freed after use with libzfs_free_str_array().
+ *
+ * Returns the number of lines read.
+ */
+static int
+libzfs_read_stdout_from_fd(int fd, char **lines[])
+{
+
+       FILE *fp;
+       int lines_cnt = 0;
+       size_t len = 0;
+       char *line = NULL;
+       char **tmp_lines = NULL, **tmp;
+       char *nl = NULL;
+       int rc;
+
+       fp = fdopen(fd, "r");
+       if (fp == NULL)
+               return (0);
+       while (1) {
+               rc = getline(&line, &len, fp);
+               if (rc == -1)
+                       break;
+
+               tmp = realloc(tmp_lines, sizeof (*tmp_lines) * (lines_cnt + 1));
+               if (tmp == NULL) {
+                       /* Return the lines we were able to process */
+                       break;
+               }
+               tmp_lines = tmp;
+
+               /* Terminate newlines */
+               if ((nl = strchr(line, '\n')) != NULL)
+                       *nl = '\0';
+               tmp_lines[lines_cnt] = line;
+               lines_cnt++;
+               line = NULL;
+       }
+       fclose(fp);
+       *lines = tmp_lines;
+       return (lines_cnt);
+}
+
+static int
+libzfs_run_process_impl(const char *path, char *argv[], char *env[], int flags,
+    char **lines[], int *lines_cnt)
 {
        pid_t pid;
        int error, devnull_fd;
+       int link[2];
+
+       /*
+        * Setup a pipe between our child and parent process if we're
+        * reading stdout.
+        */
+       if ((lines != NULL) && pipe(link) == -1)
+               return (-ESTRPIPE);
 
        pid = vfork();
        if (pid == 0) {
+               /* Child process */
                devnull_fd = open("/dev/null", O_WRONLY);
 
                if (devnull_fd < 0)
                        _exit(-1);
 
-               if (!(flags & STDOUT_VERBOSE))
+               if (!(flags & STDOUT_VERBOSE) && (lines == NULL))
                        (void) dup2(devnull_fd, STDOUT_FILENO);
+               else if (lines != NULL) {
+                       /* Save the output to lines[] */
+                       dup2(link[1], STDOUT_FILENO);
+                       close(link[0]);
+                       close(link[1]);
+               }
 
                if (!(flags & STDERR_VERBOSE))
                        (void) dup2(devnull_fd, STDERR_FILENO);
 
                close(devnull_fd);
 
-               (void) execvp(path, argv);
+               if (flags & NO_DEFAULT_PATH) {
+                       if (env == NULL)
+                               execv(path, argv);
+                       else
+                               execve(path, argv, env);
+               } else {
+                       if (env == NULL)
+                               execvp(path, argv);
+                       else
+                               execvpe(path, argv, env);
+               }
+
                _exit(-1);
        } else if (pid > 0) {
+               /* Parent process */
                int status;
 
                while ((error = waitpid(pid, &status, 0)) == -1 &&
-                       errno == EINTR);
+                   errno == EINTR) { }
                if (error < 0 || !WIFEXITED(status))
                        return (-1);
 
+               if (lines != NULL) {
+                       close(link[1]);
+                       *lines_cnt = libzfs_read_stdout_from_fd(link[0], lines);
+               }
                return (WEXITSTATUS(status));
        }
 
        return (-1);
 }
 
+int
+libzfs_run_process(const char *path, char *argv[], int flags)
+{
+       return (libzfs_run_process_impl(path, argv, NULL, flags, NULL, NULL));
+}
+
+/*
+ * Run a command and store its stdout lines in an array of strings (lines[]).
+ * lines[] is allocated and populated for you, and the number of lines is set in
+ * lines_cnt.  lines[] must be freed after use with libzfs_free_str_array().
+ * All newlines (\n) in lines[] are terminated for convenience.
+ */
+int
+libzfs_run_process_get_stdout(const char *path, char *argv[], char *env[],
+    char **lines[], int *lines_cnt)
+{
+       return (libzfs_run_process_impl(path, argv, env, 0, lines, lines_cnt));
+}
+
+/*
+ * Same as libzfs_run_process_get_stdout(), but run without $PATH set.  This
+ * means that *path needs to be the full path to the executable.
+ */
+int
+libzfs_run_process_get_stdout_nopath(const char *path, char *argv[],
+    char *env[], char **lines[], int *lines_cnt)
+{
+       return (libzfs_run_process_impl(path, argv, env, NO_DEFAULT_PATH,
+           lines, lines_cnt));
+}
+
+/*
+ * Free an array of strings.  Free both the strings contained in the array and
+ * the array itself.
+ */
+void
+libzfs_free_str_array(char **strs, int count)
+{
+       while (--count >= 0)
+               free(strs[count]);
+
+       free(strs);
+}
+
+/*
+ * Returns 1 if environment variable is set to "YES", "yes", "ON", "on", or
+ * a non-zero number.
+ *
+ * Returns 0 otherwise.
+ */
+int
+libzfs_envvar_is_set(char *envvar)
+{
+       char *env = getenv(envvar);
+       if (env && (strtoul(env, NULL, 0) > 0 ||
+           (!strncasecmp(env, "YES", 3) && strnlen(env, 4) == 3) ||
+           (!strncasecmp(env, "ON", 2) && strnlen(env, 3) == 2)))
+               return (1);
+
+       return (0);
+}
+
 /*
  * Verify the required ZFS_DEV device is available and optionally attempt
  * to load the ZFS modules.  Under normal circumstances the modules
@@ -791,13 +998,14 @@ libzfs_load_module(const char *module)
                                load = 0;
                }
 
-               if (load && libzfs_run_process("/sbin/modprobe", argv, 0))
-                       return (ENOEXEC);
-       }
+               if (load) {
+                       if (libzfs_run_process("/sbin/modprobe", argv, 0))
+                               return (ENOEXEC);
 
-       /* Module loading is synchronous it must be available */
-       if (!libzfs_module_loaded(module))
-               return (ENXIO);
+                       if (!libzfs_module_loaded(module))
+                               return (ENXIO);
+               }
+       }
 
        /*
         * Device creation by udev is asynchronous and waiting may be
@@ -862,12 +1070,13 @@ libzfs_init(void)
                return (NULL);
        }
 
-       hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
+       hdl->libzfs_sharetab = fopen(ZFS_SHARETAB, "r");
 
        if (libzfs_core_init() != 0) {
                (void) close(hdl->libzfs_fd);
                (void) fclose(hdl->libzfs_mnttab);
-               (void) fclose(hdl->libzfs_sharetab);
+               if (hdl->libzfs_sharetab)
+                       (void) fclose(hdl->libzfs_sharetab);
                free(hdl);
                return (NULL);
        }
@@ -876,6 +1085,11 @@ libzfs_init(void)
        zpool_prop_init();
        zpool_feature_init();
        libzfs_mnttab_init(hdl);
+       fletcher_4_init();
+
+       if (getenv("ZFS_PROP_DEBUG") != NULL) {
+               hdl->libzfs_prop_debug = B_TRUE;
+       }
 
        return (hdl);
 }
@@ -894,10 +1108,10 @@ libzfs_fini(libzfs_handle_t *hdl)
                (void) fclose(hdl->libzfs_sharetab);
        zfs_uninit_libshare(hdl);
        zpool_free_handles(hdl);
-       libzfs_fru_clear(hdl, B_TRUE);
        namespace_clear(hdl);
        libzfs_mnttab_fini(hdl);
        libzfs_core_fini();
+       fletcher_4_fini();
        free(hdl);
 }
 
@@ -923,7 +1137,7 @@ zfs_get_pool_handle(const zfs_handle_t *zhp)
  * Given a name, determine whether or not it's a valid path
  * (starts with '/' or "./").  If so, walk the mnttab trying
  * to match the device number.  If not, treat the path as an
- * fs/vol/snap name.
+ * fs/vol/snap/bkmark name.
  */
 zfs_handle_t *
 zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
@@ -1107,8 +1321,8 @@ zfs_strcmp_pathname(char *name, char *cmp, int wholedisk)
        dup = strdup(cmp);
        dir = strtok(dup, "/");
        while (dir) {
-               strcat(cmp_name, "/");
-               strcat(cmp_name, dir);
+               strlcat(cmp_name, "/", sizeof (cmp_name));
+               strlcat(cmp_name, dir, sizeof (cmp_name));
                dir = strtok(NULL, "/");
        }
        free(dup);
@@ -1132,6 +1346,45 @@ zfs_strcmp_pathname(char *name, char *cmp, int wholedisk)
        return (0);
 }
 
+/*
+ * Given a full path to a device determine if that device appears in the
+ * import search path.  If it does return the first match and store the
+ * index in the passed 'order' variable, otherwise return an error.
+ */
+int
+zfs_path_order(char *name, int *order)
+{
+       int i = 0, error = ENOENT;
+       char *dir, *env, *envdup;
+
+       env = getenv("ZPOOL_IMPORT_PATH");
+       if (env) {
+               envdup = strdup(env);
+               dir = strtok(envdup, ":");
+               while (dir) {
+                       if (strncmp(name, dir, strlen(dir)) == 0) {
+                               *order = i;
+                               error = 0;
+                               break;
+                       }
+                       dir = strtok(NULL, ":");
+                       i++;
+               }
+               free(envdup);
+       } else {
+               for (i = 0; i < DEFAULT_IMPORT_PATH_SIZE; i++) {
+                       if (strncmp(name, zpool_default_import_path[i],
+                           strlen(zpool_default_import_path[i])) == 0) {
+                               *order = i;
+                               error = 0;
+                               break;
+                       }
+               }
+       }
+
+       return (error);
+}
+
 /*
  * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
  * an ioctl().
@@ -1422,6 +1675,10 @@ zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
                        case ZPROP_SRC_RECEIVED:
                                str = "received";
                                break;
+
+                       default:
+                               str = NULL;
+                               assert(!"unhandled zprop_source_t");
                        }
                        break;
 
@@ -1433,7 +1690,8 @@ zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
                        continue;
                }
 
-               if (cbp->cb_columns[i + 1] == GET_COL_NONE)
+               if (i == (ZFS_GET_NCOLS - 1) ||
+                   cbp->cb_columns[i + 1] == GET_COL_NONE)
                        (void) printf("%s", str);
                else if (cbp->cb_scripted)
                        (void) printf("%s\t", str);
@@ -1581,6 +1839,8 @@ zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
        const char *propname;
        char *value;
        boolean_t isnone = B_FALSE;
+       boolean_t isauto = B_FALSE;
+       int err = 0;
 
        if (type == ZFS_TYPE_POOL) {
                proptype = zpool_prop_get_type(prop);
@@ -1603,7 +1863,12 @@ zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
                            "'%s' must be a string"), nvpair_name(elem));
                        goto error;
                }
-               (void) nvpair_value_string(elem, svalp);
+               err = nvpair_value_string(elem, svalp);
+               if (err != 0) {
+                       zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
+                           "'%s' is invalid"), nvpair_name(elem));
+                       goto error;
+               }
                if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
                        zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
                            "'%s' is too long"), nvpair_name(elem));
@@ -1616,8 +1881,9 @@ zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
                        (void) nvpair_value_string(elem, &value);
                        if (strcmp(value, "none") == 0) {
                                isnone = B_TRUE;
-                       } else if (zfs_nicestrtonum(hdl, value, ivalp)
-                           != 0) {
+                       } else if (strcmp(value, "auto") == 0) {
+                               isauto = B_TRUE;
+                       } else if (zfs_nicestrtonum(hdl, value, ivalp) != 0) {
                                goto error;
                        }
                } else if (datatype == DATA_TYPE_UINT64) {
@@ -1647,6 +1913,31 @@ zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
                    prop == ZFS_PROP_SNAPSHOT_LIMIT)) {
                        *ivalp = UINT64_MAX;
                }
+
+               /*
+                * Special handling for setting 'refreservation' to 'auto'.  Use
+                * UINT64_MAX to tell the caller to use zfs_fix_auto_resv().
+                * 'auto' is only allowed on volumes.
+                */
+               if (isauto) {
+                       switch (prop) {
+                       case ZFS_PROP_REFRESERVATION:
+                               if ((type & ZFS_TYPE_VOLUME) == 0) {
+                                       zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
+                                           "'%s=auto' only allowed on "
+                                           "volumes"), nvpair_name(elem));
+                                       goto error;
+                               }
+                               *ivalp = UINT64_MAX;
+                               break;
+                       default:
+                               zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
+                                   "'auto' is invalid value for '%s'"),
+                                   nvpair_name(elem));
+                               goto error;
+                       }
+               }
+
                break;
 
        case PROP_TYPE_INDEX: