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 http://www.opensolaris.org/os/licensing. 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 2006 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _LIBZFS_H 27 #define _LIBZFS_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #include <assert.h> 32 #include <libnvpair.h> 33 #include <sys/param.h> 34 #include <sys/types.h> 35 #include <sys/varargs.h> 36 #include <sys/fs/zfs.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * Miscellaneous ZFS constants 44 */ 45 #define ZFS_MAXNAMELEN MAXNAMELEN 46 #define ZPOOL_MAXNAMELEN MAXNAMELEN 47 #define ZFS_MAXPROPLEN MAXPATHLEN 48 49 /* 50 * libzfs errors 51 */ 52 enum { 53 EZFS_NOMEM = 2000, /* out of memory */ 54 EZFS_BADPROP, /* invalid property value */ 55 EZFS_PROPREADONLY, /* cannot set readonly property */ 56 EZFS_PROPTYPE, /* property does not apply to dataset type */ 57 EZFS_PROPNONINHERIT, /* property is not inheritable */ 58 EZFS_PROPSPACE, /* bad quota or reservation */ 59 EZFS_BADTYPE, /* dataset is not of appropriate type */ 60 EZFS_BUSY, /* pool or dataset is busy */ 61 EZFS_EXISTS, /* pool or dataset already exists */ 62 EZFS_NOENT, /* no such pool or dataset */ 63 EZFS_BADSTREAM, /* bad backup stream */ 64 EZFS_DSREADONLY, /* dataset is readonly */ 65 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 66 EZFS_VOLHASDATA, /* volume already contains data */ 67 EZFS_INVALIDNAME, /* invalid dataset name */ 68 EZFS_BADRESTORE, /* unable to restore to destination */ 69 EZFS_BADBACKUP, /* backup failed */ 70 EZFS_BADTARGET, /* bad attach/detach/replace target */ 71 EZFS_NODEVICE, /* no such device in pool */ 72 EZFS_BADDEV, /* invalid device to add */ 73 EZFS_NOREPLICAS, /* no valid replicas */ 74 EZFS_RESILVERING, /* currently resilvering */ 75 EZFS_BADVERSION, /* unsupported version */ 76 EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 77 EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 78 EZFS_BADPATH, /* must be an absolute path */ 79 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 80 EZFS_ZONED, /* used improperly in local zone */ 81 EZFS_MOUNTFAILED, /* failed to mount dataset */ 82 EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 83 EZFS_UNSHAREFAILED, /* unshare(1M) failed */ 84 EZFS_SHAREFAILED, /* share(1M) failed */ 85 EZFS_DEVLINKS, /* failed to create zvol links */ 86 EZFS_PERM, /* permission denied */ 87 EZFS_NOSPC, /* out of space */ 88 EZFS_IO, /* I/O error */ 89 EZFS_INTR, /* signal received */ 90 EZFS_ISSPARE, /* device is a hot spare */ 91 EZFS_INVALCONFIG, /* invalid vdev configuration */ 92 EZFS_UNKNOWN /* unknown error */ 93 }; 94 95 /* 96 * Basic handle types 97 */ 98 typedef struct zfs_handle zfs_handle_t; 99 typedef struct zpool_handle zpool_handle_t; 100 typedef struct libzfs_handle libzfs_handle_t; 101 102 /* 103 * Library initialization 104 */ 105 extern libzfs_handle_t *libzfs_init(void); 106 extern void libzfs_fini(libzfs_handle_t *); 107 108 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 109 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 110 111 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 112 113 extern int libzfs_errno(libzfs_handle_t *); 114 extern const char *libzfs_error_action(libzfs_handle_t *); 115 extern const char *libzfs_error_description(libzfs_handle_t *); 116 117 /* 118 * Basic handle functions 119 */ 120 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 121 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 122 extern void zpool_close(zpool_handle_t *); 123 extern const char *zpool_get_name(zpool_handle_t *); 124 extern uint64_t zpool_get_guid(zpool_handle_t *); 125 extern uint64_t zpool_get_space_used(zpool_handle_t *); 126 extern uint64_t zpool_get_space_total(zpool_handle_t *); 127 extern int zpool_get_root(zpool_handle_t *, char *, size_t); 128 extern int zpool_get_state(zpool_handle_t *); 129 extern uint64_t zpool_get_version(zpool_handle_t *); 130 131 /* 132 * Iterate over all active pools in the system. 133 */ 134 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 135 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 136 137 /* 138 * Functions to create and destroy pools 139 */ 140 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 141 const char *); 142 extern int zpool_destroy(zpool_handle_t *); 143 extern int zpool_add(zpool_handle_t *, nvlist_t *); 144 145 /* 146 * Functions to manipulate pool and vdev state 147 */ 148 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 149 150 extern int zpool_vdev_online(zpool_handle_t *, const char *); 151 extern int zpool_vdev_offline(zpool_handle_t *, const char *, int); 152 extern int zpool_vdev_attach(zpool_handle_t *, const char *, const char *, 153 nvlist_t *, int); 154 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 155 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 156 extern int zpool_clear(zpool_handle_t *, const char *); 157 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 158 159 /* 160 * Pool health statistics. 161 */ 162 typedef enum { 163 /* 164 * The following correspond to faults as defined in the (fault.fs.zfs.*) 165 * event namespace. Each is associated with a corresponding message ID. 166 */ 167 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 168 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 169 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 170 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 171 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 172 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 173 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 174 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 175 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 176 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 177 178 /* 179 * The following are not faults per se, but still an error possibly 180 * requiring administrative attention. There is no corresponding 181 * message ID. 182 */ 183 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 184 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 185 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 186 187 /* 188 * Finally, the following indicates a healthy pool. 189 */ 190 ZPOOL_STATUS_OK 191 } zpool_status_t; 192 193 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 194 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 195 196 /* 197 * Statistics and configuration functions. 198 */ 199 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 200 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 201 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t ***, size_t *); 202 203 #define ZPOOL_ERR_DATASET "dataset" 204 #define ZPOOL_ERR_OBJECT "object" 205 #define ZPOOL_ERR_RANGE "range" 206 207 /* 208 * Import and export functions 209 */ 210 extern int zpool_export(zpool_handle_t *); 211 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 212 const char *); 213 214 /* 215 * Search for pools to import 216 */ 217 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 218 219 /* 220 * Miscellaneous pool functions 221 */ 222 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 223 extern int zpool_upgrade(zpool_handle_t *); 224 225 /* 226 * Basic handle manipulations. These functions do not create or destroy the 227 * underlying datasets, only the references to them. 228 */ 229 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 230 extern void zfs_close(zfs_handle_t *); 231 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 232 extern const char *zfs_get_name(const zfs_handle_t *); 233 234 typedef enum { 235 ZFS_SRC_NONE = 0x1, 236 ZFS_SRC_DEFAULT = 0x2, 237 ZFS_SRC_TEMPORARY = 0x4, 238 ZFS_SRC_LOCAL = 0x8, 239 ZFS_SRC_INHERITED = 0x10 240 } zfs_source_t; 241 242 #define ZFS_SRC_ALL 0x1f 243 244 /* 245 * Property management functions. Some functions are shared with the kernel, 246 * and are found in sys/fs/zfs.h. 247 */ 248 const char *zfs_prop_to_name(zfs_prop_t); 249 int zfs_prop_set(zfs_handle_t *, zfs_prop_t, const char *); 250 int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, zfs_source_t *, 251 char *, size_t, boolean_t); 252 int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, zfs_source_t *, 253 char *, size_t); 254 uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 255 int zfs_prop_validate(libzfs_handle_t *, zfs_prop_t, const char *, uint64_t *); 256 int zfs_prop_inheritable(zfs_prop_t); 257 int zfs_prop_inherit(zfs_handle_t *, zfs_prop_t); 258 const char *zfs_prop_values(zfs_prop_t); 259 int zfs_prop_valid_for_type(zfs_prop_t, int); 260 const char *zfs_prop_default_string(zfs_prop_t prop); 261 uint64_t zfs_prop_default_numeric(zfs_prop_t); 262 int zfs_prop_is_string(zfs_prop_t prop); 263 const char *zfs_prop_column_name(zfs_prop_t); 264 const char *zfs_prop_column_format(zfs_prop_t); 265 int zfs_get_proplist(char *fields, zfs_prop_t *proplist, int max, int *count, 266 char **badopt); 267 268 #define ZFS_MOUNTPOINT_NONE "none" 269 #define ZFS_MOUNTPOINT_LEGACY "legacy" 270 271 /* 272 * Iterator functions. 273 */ 274 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 275 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 276 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 277 extern int zfs_iter_dependents(zfs_handle_t *, zfs_iter_f, void *); 278 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 279 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 280 281 /* 282 * Functions to create and destroy datasets. 283 */ 284 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 285 const char *, const char *); 286 extern int zfs_destroy(zfs_handle_t *); 287 extern int zfs_clone(zfs_handle_t *, const char *); 288 extern int zfs_snapshot(libzfs_handle_t *, const char *); 289 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 290 extern int zfs_rename(zfs_handle_t *, const char *); 291 extern int zfs_send(zfs_handle_t *, zfs_handle_t *); 292 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int); 293 extern int zfs_promote(zfs_handle_t *); 294 295 /* 296 * Miscellaneous functions. 297 */ 298 extern const char *zfs_type_to_name(zfs_type_t); 299 extern void zfs_refresh_properties(zfs_handle_t *); 300 extern int zfs_name_valid(const char *, zfs_type_t); 301 302 /* 303 * Mount support functions. 304 */ 305 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 306 extern int zfs_mount(zfs_handle_t *, const char *, int); 307 extern int zfs_unmount(zfs_handle_t *, const char *, int); 308 extern int zfs_unmountall(zfs_handle_t *, int); 309 310 /* 311 * Share support functions. 312 */ 313 extern boolean_t zfs_is_shared(zfs_handle_t *, char **); 314 extern int zfs_share(zfs_handle_t *); 315 extern int zfs_unshare(zfs_handle_t *, const char *); 316 extern int zfs_unshareall(zfs_handle_t *); 317 318 /* 319 * When dealing with nvlists, verify() is extremely useful 320 */ 321 #ifdef NDEBUG 322 #define verify(EX) ((void)(EX)) 323 #else 324 #define verify(EX) assert(EX) 325 #endif 326 327 /* 328 * Utility function to convert a number to a human-readable form. 329 */ 330 extern void zfs_nicenum(uint64_t, char *, size_t); 331 extern int zfs_nicestrtonum(const char *, uint64_t *); 332 333 /* 334 * Pool destroy special. Remove the device information without destroying 335 * the underlying dataset. 336 */ 337 extern int zfs_remove_link(zfs_handle_t *); 338 339 /* 340 * Given a device or file, determine if it is part of a pool. 341 */ 342 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 343 boolean_t *); 344 345 /* 346 * ftyp special. Read the label from a given device. 347 */ 348 extern int zpool_read_label(int, nvlist_t **); 349 350 /* 351 * Create and remove zvol /dev links 352 */ 353 extern int zpool_create_zvol_links(zpool_handle_t *); 354 extern int zpool_remove_zvol_links(zpool_handle_t *); 355 356 #ifdef __cplusplus 357 } 358 #endif 359 360 #endif /* _LIBZFS_H */ 361