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 101 struct udev_device; 102 103 _LIBZUTIL_H int zfs_device_get_devid(struct udev_device *, char *, size_t); 104 _LIBZUTIL_H int zfs_device_get_physical(struct udev_device *, char *, size_t); 105 106 _LIBZUTIL_H void update_vdev_config_dev_strs(nvlist_t *); 107 108 /* 109 * Default device paths 110 */ 111 #define DISK_ROOT "/dev" 112 #define UDISK_ROOT "/dev/disk" 113 #define ZVOL_ROOT "/dev/zvol" 114 115 _LIBZUTIL_H int zfs_append_partition(char *path, size_t max_len); 116 _LIBZUTIL_H int zfs_resolve_shortname(const char *name, char *path, 117 size_t pathlen); 118 119 _LIBZUTIL_H char *zfs_strip_partition(const char *); 120 _LIBZUTIL_H const char *zfs_strip_path(const char *); 121 122 _LIBZUTIL_H int zfs_strcmp_pathname(const char *, const char *, int); 123 124 _LIBZUTIL_H boolean_t zfs_dev_is_dm(const char *); 125 _LIBZUTIL_H boolean_t zfs_dev_is_whole_disk(const char *); 126 _LIBZUTIL_H int zfs_dev_flush(int); 127 _LIBZUTIL_H char *zfs_get_underlying_path(const char *); 128 _LIBZUTIL_H char *zfs_get_enclosure_sysfs_path(const char *); 129 130 _LIBZUTIL_H boolean_t is_mpath_whole_disk(const char *); 131 132 _LIBZUTIL_H boolean_t zfs_isnumber(const char *); 133 134 /* 135 * Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-". 136 * 137 * ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa.. 138 * ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera... 139 * ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds... 140 * ZFS_NICENUM_RAW: Print the raw number without any formatting 141 * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero. 142 */ 143 enum zfs_nicenum_format { 144 ZFS_NICENUM_1024 = 0, 145 ZFS_NICENUM_BYTES = 1, 146 ZFS_NICENUM_TIME = 2, 147 ZFS_NICENUM_RAW = 3, 148 ZFS_NICENUM_RAWTIME = 4 149 }; 150 151 /* 152 * Convert a number to a human-readable form. 153 */ 154 _LIBZUTIL_H void zfs_nicebytes(uint64_t, char *, size_t); 155 _LIBZUTIL_H void zfs_nicenum(uint64_t, char *, size_t); 156 _LIBZUTIL_H void zfs_nicenum_format(uint64_t, char *, size_t, 157 enum zfs_nicenum_format); 158 _LIBZUTIL_H void zfs_nicetime(uint64_t, char *, size_t); 159 _LIBZUTIL_H void zfs_niceraw(uint64_t, char *, size_t); 160 161 #define nicenum(num, buf, size) zfs_nicenum(num, buf, size) 162 163 _LIBZUTIL_H void zpool_dump_ddt(const ddt_stat_t *, const ddt_histogram_t *); 164 _LIBZUTIL_H int zpool_history_unpack(char *, uint64_t, uint64_t *, nvlist_t ***, 165 uint_t *); 166 167 struct zfs_cmd; 168 169 /* 170 * List of colors to use 171 */ 172 #define ANSI_BLACK "\033[0;30m" 173 #define ANSI_RED "\033[0;31m" 174 #define ANSI_GREEN "\033[0;32m" 175 #define ANSI_YELLOW "\033[0;33m" 176 #define ANSI_BLUE "\033[0;34m" 177 #define ANSI_BOLD_BLUE "\033[1;34m" /* light blue */ 178 #define ANSI_MAGENTA "\033[0;35m" 179 #define ANSI_CYAN "\033[0;36m" 180 #define ANSI_GRAY "\033[0;37m" 181 182 #define ANSI_RESET "\033[0m" 183 #define ANSI_BOLD "\033[1m" 184 185 _LIBZUTIL_H int use_color(void); 186 _LIBZUTIL_H void color_start(const char *color); 187 _LIBZUTIL_H void color_end(void); 188 _LIBZUTIL_H int printf_color(const char *color, const char *format, ...); 189 190 _LIBZUTIL_H const char *zfs_basename(const char *path); 191 _LIBZUTIL_H ssize_t zfs_dirnamelen(const char *path); 192 #ifdef __linux__ 193 extern char **environ; 194 _LIBZUTIL_H void zfs_setproctitle_init(int argc, char *argv[], char *envp[]); 195 _LIBZUTIL_H void zfs_setproctitle(const char *fmt, ...); 196 #else 197 #define zfs_setproctitle(fmt, ...) setproctitle(fmt, ##__VA_ARGS__) 198 #define zfs_setproctitle_init(x, y, z) ((void)0) 199 #endif 200 201 /* 202 * These functions are used by the ZFS libraries and cmd/zpool code, but are 203 * not exported in the ABI. 204 */ 205 typedef int (*pool_vdev_iter_f)(void *, nvlist_t *, void *); 206 int for_each_vdev_cb(void *zhp, nvlist_t *nv, pool_vdev_iter_f func, 207 void *data); 208 int for_each_vdev_in_nvlist(nvlist_t *nvroot, pool_vdev_iter_f func, 209 void *data); 210 void update_vdevs_config_dev_sysfs_path(nvlist_t *config); 211 _LIBZUTIL_H void update_vdev_config_dev_sysfs_path(nvlist_t *nv, 212 const char *path, const char *key); 213 #ifdef __cplusplus 214 } 215 #endif 216 217 #endif /* _LIBZUTIL_H */ 218