include/libzutil.h

   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 https://opensource.org/licenses/CDDL-1.0.
  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  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2018 by Delphix. All rights reserved.
  24  */
  25
  26 #ifndef _LIBZUTIL_H
  27 #define _LIBZUTIL_H extern __attribute__((visibility("default")))
  28
  29 #include <sys/nvpair.h>
  30 #include <sys/fs/zfs.h>
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /*
  37  * Default wait time in milliseconds for a device name to be created.
  38  */
  39 #define DISK_LABEL_WAIT         (30 * 1000)  /* 30 seconds */
  40
  41
  42 /*
  43  * Pool Config Operations
  44  *
  45  * These are specific to the library libzfs or libzpool instance.
  46  */
  47 typedef nvlist_t *refresh_config_func_t(void *, nvlist_t *);
  48
  49 typedef int pool_active_func_t(void *, const char *, uint64_t, boolean_t *);
  50
  51 typedef const struct pool_config_ops {
  52         refresh_config_func_t   *pco_refresh_config;
  53         pool_active_func_t      *pco_pool_active;
  54 } pool_config_ops_t;
  55
  56 /*
  57  * An instance of pool_config_ops_t is expected in the caller's binary.
  58  */
  59 _LIBZUTIL_H pool_config_ops_t libzfs_config_ops;
  60 _LIBZUTIL_H pool_config_ops_t libzpool_config_ops;
  61
  62 typedef enum lpc_error {
  63         LPC_SUCCESS = 0,        /* no error -- success */
  64         LPC_BADCACHE = 2000,    /* out of memory */
  65         LPC_BADPATH,    /* must be an absolute path */
  66         LPC_NOMEM,      /* out of memory */
  67         LPC_EACCESS,    /* some devices require root privileges */
  68         LPC_UNKNOWN
  69 } lpc_error_t;
  70
  71 typedef struct importargs {
  72         char **path;            /* a list of paths to search            */
  73         int paths;              /* number of paths to search            */
  74         const char *poolname;   /* name of a pool to find               */
  75         uint64_t guid;          /* guid of a pool to find               */
  76         const char *cachefile;  /* cachefile to use for import          */
  77         boolean_t can_be_active; /* can the pool be active?             */
  78         boolean_t scan;         /* prefer scanning to libblkid cache    */
  79         nvlist_t *policy;       /* load policy (max txg, rewind, etc.)  */
  80 } importargs_t;
  81
  82 typedef struct libpc_handle {
  83         int lpc_error;
  84         boolean_t lpc_printerr;
  85         boolean_t lpc_open_access_error;
  86         boolean_t lpc_desc_active;
  87         char lpc_desc[1024];
  88         pool_config_ops_t *lpc_ops;
  89         void *lpc_lib_handle;
  90 } libpc_handle_t;
  91
  92 _LIBZUTIL_H const char *libpc_error_description(libpc_handle_t *);
  93 _LIBZUTIL_H nvlist_t *zpool_search_import(libpc_handle_t *, importargs_t *);
  94 _LIBZUTIL_H int zpool_find_config(libpc_handle_t *, const char *, nvlist_t **,
  95     importargs_t *);
  96
  97 _LIBZUTIL_H const char * const * zpool_default_search_paths(size_t *count);
  98 _LIBZUTIL_H int zpool_read_label(int, nvlist_t **, int *);
  99 _LIBZUTIL_H int zpool_label_disk_wait(const char *, int);
 100 _LIBZUTIL_H int zpool_disk_wait(const char *);
 101
 102 struct udev_device;
 103
 104 _LIBZUTIL_H int zfs_device_get_devid(struct udev_device *, char *, size_t);
 105 _LIBZUTIL_H int zfs_device_get_physical(struct udev_device *, char *, size_t);
 106
 107 _LIBZUTIL_H void update_vdev_config_dev_strs(nvlist_t *);
 108
 109 /*
 110  * Default device paths
 111  */
 112 #define DISK_ROOT       "/dev"
 113 #define UDISK_ROOT      "/dev/disk"
 114 #define ZVOL_ROOT       "/dev/zvol"
 115
 116 _LIBZUTIL_H int zfs_append_partition(char *path, size_t max_len);
 117 _LIBZUTIL_H int zfs_resolve_shortname(const char *name, char *path,
 118     size_t pathlen);
 119
 120 _LIBZUTIL_H char *zfs_strip_partition(const char *);
 121 _LIBZUTIL_H const char *zfs_strip_path(const char *);
 122
 123 _LIBZUTIL_H int zfs_strcmp_pathname(const char *, const char *, int);
 124
 125 _LIBZUTIL_H boolean_t zfs_dev_is_dm(const char *);
 126 _LIBZUTIL_H boolean_t zfs_dev_is_whole_disk(const char *);
 127 _LIBZUTIL_H int zfs_dev_flush(int);
 128 _LIBZUTIL_H char *zfs_get_underlying_path(const char *);
 129 _LIBZUTIL_H char *zfs_get_enclosure_sysfs_path(const char *);
 130
 131 _LIBZUTIL_H boolean_t is_mpath_whole_disk(const char *);
 132
 133 _LIBZUTIL_H boolean_t zfs_isnumber(const char *);
 134
 135 /*
 136  * Formats for iostat numbers.  Examples: "12K", "30ms", "4B", "2321234", "-".
 137  *
 138  * ZFS_NICENUM_1024:    Print kilo, mega, tera, peta, exa..
 139  * ZFS_NICENUM_BYTES:   Print single bytes ("13B"), kilo, mega, tera...
 140  * ZFS_NICENUM_TIME:    Print nanosecs, microsecs, millisecs, seconds...
 141  * ZFS_NICENUM_RAW:     Print the raw number without any formatting
 142  * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero.
 143  */
 144 enum zfs_nicenum_format {
 145         ZFS_NICENUM_1024 = 0,
 146         ZFS_NICENUM_BYTES = 1,
 147         ZFS_NICENUM_TIME = 2,
 148         ZFS_NICENUM_RAW = 3,
 149         ZFS_NICENUM_RAWTIME = 4
 150 };
 151
 152 /*
 153  * Convert a number to a human-readable form.
 154  */
 155 _LIBZUTIL_H void zfs_nicebytes(uint64_t, char *, size_t);
 156 _LIBZUTIL_H void zfs_nicenum(uint64_t, char *, size_t);
 157 _LIBZUTIL_H void zfs_nicenum_format(uint64_t, char *, size_t,
 158     enum zfs_nicenum_format);
 159 _LIBZUTIL_H void zfs_nicetime(uint64_t, char *, size_t);
 160 _LIBZUTIL_H void zfs_niceraw(uint64_t, char *, size_t);
 161
 162 #define nicenum(num, buf, size) zfs_nicenum(num, buf, size)
 163
 164 _LIBZUTIL_H void zpool_dump_ddt(const ddt_stat_t *, const ddt_histogram_t *);
 165 _LIBZUTIL_H int zpool_history_unpack(char *, uint64_t, uint64_t *, nvlist_t ***,
 166     uint_t *);
 167 _LIBZUTIL_H void fsleep(float sec);
 168 _LIBZUTIL_H int zpool_getenv_int(const char *env, int default_val);
 169
 170 struct zfs_cmd;
 171
 172 /*
 173  * List of colors to use
 174  */
 175 #define ANSI_BLACK      "\033[0;30m"
 176 #define ANSI_RED        "\033[0;31m"
 177 #define ANSI_GREEN      "\033[0;32m"
 178 #define ANSI_YELLOW     "\033[0;33m"
 179 #define ANSI_BLUE       "\033[0;34m"
 180 #define ANSI_BOLD_BLUE  "\033[1;34m" /* light blue */
 181 #define ANSI_MAGENTA    "\033[0;35m"
 182 #define ANSI_CYAN       "\033[0;36m"
 183 #define ANSI_GRAY       "\033[0;37m"
 184
 185 #define ANSI_RESET      "\033[0m"
 186 #define ANSI_BOLD       "\033[1m"
 187
 188 _LIBZUTIL_H int use_color(void);
 189 _LIBZUTIL_H void color_start(const char *color);
 190 _LIBZUTIL_H void color_end(void);
 191 _LIBZUTIL_H int printf_color(const char *color, const char *format, ...);
 192
 193 _LIBZUTIL_H const char *zfs_basename(const char *path);
 194 _LIBZUTIL_H ssize_t zfs_dirnamelen(const char *path);
 195 #ifdef __linux__
 196 extern char **environ;
 197 _LIBZUTIL_H void zfs_setproctitle_init(int argc, char *argv[], char *envp[]);
 198 _LIBZUTIL_H void zfs_setproctitle(const char *fmt, ...);
 199 #else
 200 #define zfs_setproctitle(fmt, ...)      setproctitle(fmt, ##__VA_ARGS__)
 201 #define zfs_setproctitle_init(x, y, z)  ((void)0)
 202 #endif
 203
 204 /*
 205  * These functions are used by the ZFS libraries and cmd/zpool code, but are
 206  * not exported in the ABI.
 207  */
 208 typedef int (*pool_vdev_iter_f)(void *, nvlist_t *, void *);
 209 int for_each_vdev_cb(void *zhp, nvlist_t *nv, pool_vdev_iter_f func,
 210     void *data);
 211 int for_each_vdev_macro_helper_func(void *zhp_data, nvlist_t *nv, void *data);
 212 int for_each_real_leaf_vdev_macro_helper_func(void *zhp_data, nvlist_t *nv,
 213     void *data);
 214 /*
 215  * Often you'll want to iterate over all the vdevs in the pool, but don't want
 216  * to use for_each_vdev() since it requires a callback function.
 217  *
 218  * Instead you can use FOR_EACH_VDEV():
 219  *
 220  *     zpool_handle_t *zhp      // Assume this is initialized
 221  *     nvlist_t *nv
 222  *     ...
 223  *     FOR_EACH_VDEV(zhp, nv) {
 224  *       const char *path = NULL;
 225  *       nvlist_lookup_string(nv, ZPOOL_CONFIG_PATH, &path);
 226  *       printf("Looking at vdev %s\n", path);
 227  *     }
 228  *
 229  * Note: FOR_EACH_VDEV runs in O(n^2) time where n = number of vdevs.  However,
 230  * there's an upper limit of 256 vdevs per dRAID top-level vdevs (TLDs), 255 for
 231  * raidz2 TLDs, a real world limit of ~500 vdevs for mirrors, so this shouldn't
 232  * really be an issue.
 233  *
 234  * Here are some micro-benchmarks of a complete FOR_EACH_VDEV loop on a RAID0
 235  * pool:
 236  *
 237  * 100  vdevs = 0.7ms
 238  * 500  vdevs = 17ms
 239  * 750  vdevs = 40ms
 240  * 1000 vdevs = 82ms
 241  *
 242  * The '__nv += 0' at the end of the for() loop gets around a "comma or
 243  * semicolon followed by non-blank" checkstyle error.  Note on most compliers
 244  * the '__nv += 0' can just be replaced with 'NULL', but gcc on Centos 7
 245  * will give a 'warning: statement with no effect' error if you do that.
 246  */
 247 #define __FOR_EACH_VDEV(__zhp, __nv, __func) { \
 248         __nv = zpool_get_config(__zhp, NULL); \
 249         VERIFY0(nvlist_lookup_nvlist(__nv, ZPOOL_CONFIG_VDEV_TREE, &__nv)); \
 250         } \
 251         for (nvlist_t *__root_nv = __nv, *__state = (nvlist_t *)0; \
 252             for_each_vdev_cb(&__state, __root_nv, __func, &__nv) == 1; \
 253             __nv += 0)
 254
 255 #define FOR_EACH_VDEV(__zhp, __nv) \
 256         __FOR_EACH_VDEV(__zhp, __nv, for_each_vdev_macro_helper_func)
 257
 258 /*
 259  * "real leaf" vdevs are leaf vdevs that are real devices (disks or files).
 260  * This excludes leaf vdevs like like draid spares.
 261  */
 262 #define FOR_EACH_REAL_LEAF_VDEV(__zhp, __nv) \
 263         __FOR_EACH_VDEV(__zhp, __nv, for_each_real_leaf_vdev_macro_helper_func)
 264
 265 int for_each_vdev_in_nvlist(nvlist_t *nvroot, pool_vdev_iter_f func,
 266     void *data);
 267 void update_vdevs_config_dev_sysfs_path(nvlist_t *config);
 268 _LIBZUTIL_H void update_vdev_config_dev_sysfs_path(nvlist_t *nv,
 269     const char *path, const char *key);
 270 #ifdef  __cplusplus
 271 }
 272 #endif
 273
 274 #endif  /* _LIBZUTIL_H */