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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2018 by Delphix. All rights reserved.
29 #include <sys/nvpair.h>
30 #include <sys/fs/zfs.h>
37 * Default wait time for a device name to be created.
39 #define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */
43 * Pool Config Operations
45 * These are specific to the library libzfs or libzpool instance.
47 typedef nvlist_t
*refresh_config_func_t(void *, nvlist_t
*);
49 typedef int pool_active_func_t(void *, const char *, uint64_t, boolean_t
*);
51 typedef const struct pool_config_ops
{
52 refresh_config_func_t
*pco_refresh_config
;
53 pool_active_func_t
*pco_pool_active
;
57 * An instance of pool_config_ops_t is expected in the caller's binary.
59 extern const pool_config_ops_t libzfs_config_ops
;
60 extern const pool_config_ops_t libzpool_config_ops
;
62 typedef struct importargs
{
63 char **path
; /* a list of paths to search */
64 int paths
; /* number of paths to search */
65 const char *poolname
; /* name of a pool to find */
66 uint64_t guid
; /* guid of a pool to find */
67 const char *cachefile
; /* cachefile to use for import */
68 boolean_t can_be_active
; /* can the pool be active? */
69 boolean_t scan
; /* prefer scanning to libblkid cache */
70 nvlist_t
*policy
; /* load policy (max txg, rewind, etc.) */
73 extern nvlist_t
*zpool_search_import(void *, importargs_t
*,
74 const pool_config_ops_t
*);
75 extern int zpool_find_config(void *, const char *, nvlist_t
**, importargs_t
*,
76 const pool_config_ops_t
*);
78 extern const char * const * zpool_default_search_paths(size_t *count
);
79 extern int zpool_read_label(int, nvlist_t
**, int *);
80 extern int zpool_label_disk_wait(const char *, int);
85 extern int zfs_device_get_devid(struct udev_device
*, char *, size_t);
86 extern int zfs_device_get_physical(struct udev_device
*, char *, size_t);
88 #define zfs_device_get_devid(dev, bufptr, buflen) (ENODATA)
89 #define zfs_device_get_physical(dev, bufptr, buflen) (ENODATA)
92 extern void update_vdev_config_dev_strs(nvlist_t
*);
95 * Default device paths
97 #define DISK_ROOT "/dev"
98 #define UDISK_ROOT "/dev/disk"
99 #define ZVOL_ROOT "/dev/zvol"
101 extern int zfs_append_partition(char *path
, size_t max_len
);
102 extern int zfs_resolve_shortname(const char *name
, char *path
, size_t pathlen
);
104 extern char *zfs_strip_partition(char *);
105 extern char *zfs_strip_partition_path(char *);
107 extern int zfs_strcmp_pathname(const char *, const char *, int);
109 extern int zfs_dev_is_dm(const char *);
110 extern int zfs_dev_is_whole_disk(const char *);
111 extern char *zfs_get_underlying_path(const char *);
112 extern char *zfs_get_enclosure_sysfs_path(const char *);
115 extern boolean_t
is_mpath_whole_disk(const char *);
117 #define is_mpath_whole_disk(path) (B_FALSE)
121 * Formats for iostat numbers. Examples: "12K", "30ms", "4B", "2321234", "-".
123 * ZFS_NICENUM_1024: Print kilo, mega, tera, peta, exa..
124 * ZFS_NICENUM_BYTES: Print single bytes ("13B"), kilo, mega, tera...
125 * ZFS_NICENUM_TIME: Print nanosecs, microsecs, millisecs, seconds...
126 * ZFS_NICENUM_RAW: Print the raw number without any formatting
127 * ZFS_NICENUM_RAWTIME: Same as RAW, but print dashes ('-') for zero.
129 enum zfs_nicenum_format
{
130 ZFS_NICENUM_1024
= 0,
131 ZFS_NICENUM_BYTES
= 1,
132 ZFS_NICENUM_TIME
= 2,
134 ZFS_NICENUM_RAWTIME
= 4
138 * Convert a number to a human-readable form.
140 extern void zfs_nicebytes(uint64_t, char *, size_t);
141 extern void zfs_nicenum(uint64_t, char *, size_t);
142 extern void zfs_nicenum_format(uint64_t, char *, size_t,
143 enum zfs_nicenum_format
);
144 extern void zfs_nicetime(uint64_t, char *, size_t);
146 #define nicenum(num, buf, size) zfs_nicenum(num, buf, size)
148 extern void zpool_dump_ddt(const ddt_stat_t
*, const ddt_histogram_t
*);
149 extern int zpool_history_unpack(char *, uint64_t, uint64_t *, nvlist_t
***,
156 #endif /* _LIBZUTIL_H */