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_RECURSIVE, /* recursive dependency */ 93 EZFS_UNKNOWN /* unknown error */ 94 }; 95 96 /* 97 * Basic handle types 98 */ 99 typedef struct zfs_handle zfs_handle_t; 100 typedef struct zpool_handle zpool_handle_t; 101 typedef struct libzfs_handle libzfs_handle_t; 102 103 /* 104 * Library initialization 105 */ 106 extern libzfs_handle_t *libzfs_init(void); 107 extern void libzfs_fini(libzfs_handle_t *); 108 109 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 110 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 111 112 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 113 114 extern int libzfs_errno(libzfs_handle_t *); 115 extern const char *libzfs_error_action(libzfs_handle_t *); 116 extern const char *libzfs_error_description(libzfs_handle_t *); 117 118 /* 119 * Basic handle functions 120 */ 121 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 122 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 123 extern void zpool_close(zpool_handle_t *); 124 extern const char *zpool_get_name(zpool_handle_t *); 125 extern uint64_t zpool_get_guid(zpool_handle_t *); 126 extern uint64_t zpool_get_space_used(zpool_handle_t *); 127 extern uint64_t zpool_get_space_total(zpool_handle_t *); 128 extern int zpool_get_root(zpool_handle_t *, char *, size_t); 129 extern int zpool_get_state(zpool_handle_t *); 130 extern uint64_t zpool_get_version(zpool_handle_t *); 131 132 /* 133 * Iterate over all active pools in the system. 134 */ 135 typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 136 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 137 138 /* 139 * Functions to create and destroy pools 140 */ 141 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 142 const char *); 143 extern int zpool_destroy(zpool_handle_t *); 144 extern int zpool_add(zpool_handle_t *, nvlist_t *); 145 146 /* 147 * Functions to manipulate pool and vdev state 148 */ 149 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t); 150 151 extern int zpool_vdev_online(zpool_handle_t *, const char *); 152 extern int zpool_vdev_offline(zpool_handle_t *, const char *, int); 153 extern int zpool_vdev_attach(zpool_handle_t *, const char *, const char *, 154 nvlist_t *, int); 155 extern int zpool_vdev_detach(zpool_handle_t *, const char *); 156 extern int zpool_vdev_remove(zpool_handle_t *, const char *); 157 extern int zpool_clear(zpool_handle_t *, const char *); 158 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *); 159 160 /* 161 * Pool health statistics. 162 */ 163 typedef enum { 164 /* 165 * The following correspond to faults as defined in the (fault.fs.zfs.*) 166 * event namespace. Each is associated with a corresponding message ID. 167 */ 168 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 169 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 170 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 171 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 172 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 173 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 174 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 175 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 176 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 177 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 178 179 /* 180 * The following are not faults per se, but still an error possibly 181 * requiring administrative attention. There is no corresponding 182 * message ID. 183 */ 184 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */ 185 ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 186 ZPOOL_STATUS_OFFLINE_DEV, /* device online */ 187 188 /* 189 * Finally, the following indicates a healthy pool. 190 */ 191 ZPOOL_STATUS_OK 192 } zpool_status_t; 193 194 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 195 extern zpool_status_t zpool_import_status(nvlist_t *, char **); 196 197 /* 198 * Statistics and configuration functions. 199 */ 200 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 201 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 202 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t ***, size_t *); 203 204 /* 205 * Import and export functions 206 */ 207 extern int zpool_export(zpool_handle_t *); 208 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 209 const char *); 210 211 /* 212 * Search for pools to import 213 */ 214 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 215 216 /* 217 * Miscellaneous pool functions 218 */ 219 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *); 220 extern int zpool_upgrade(zpool_handle_t *); 221 222 /* 223 * Basic handle manipulations. These functions do not create or destroy the 224 * underlying datasets, only the references to them. 225 */ 226 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 227 extern void zfs_close(zfs_handle_t *); 228 extern zfs_type_t zfs_get_type(const zfs_handle_t *); 229 extern const char *zfs_get_name(const zfs_handle_t *); 230 231 typedef enum { 232 ZFS_SRC_NONE = 0x1, 233 ZFS_SRC_DEFAULT = 0x2, 234 ZFS_SRC_TEMPORARY = 0x4, 235 ZFS_SRC_LOCAL = 0x8, 236 ZFS_SRC_INHERITED = 0x10 237 } zfs_source_t; 238 239 #define ZFS_SRC_ALL 0x1f 240 241 /* 242 * Property management functions. Some functions are shared with the kernel, 243 * and are found in sys/fs/zfs.h. 244 */ 245 extern const char *zfs_prop_to_name(zfs_prop_t); 246 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 247 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 248 zfs_source_t *, char *, size_t, boolean_t); 249 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 250 zfs_source_t *, char *, size_t); 251 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 252 extern const char *zfs_prop_get_string(zfs_handle_t *, zfs_prop_t); 253 extern int zfs_prop_inherit(zfs_handle_t *, const char *); 254 extern const char *zfs_prop_values(zfs_prop_t); 255 extern int zfs_prop_valid_for_type(zfs_prop_t, int); 256 extern const char *zfs_prop_default_string(zfs_prop_t prop); 257 extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 258 extern int zfs_prop_is_string(zfs_prop_t prop); 259 extern const char *zfs_prop_column_name(zfs_prop_t); 260 extern boolean_t zfs_prop_align_right(zfs_prop_t); 261 262 typedef struct zfs_proplist { 263 zfs_prop_t pl_prop; 264 char *pl_user_prop; 265 struct zfs_proplist *pl_next; 266 boolean_t pl_all; 267 size_t pl_width; 268 boolean_t pl_fixed; 269 } zfs_proplist_t; 270 271 extern int zfs_get_proplist(libzfs_handle_t *, char *, zfs_proplist_t **); 272 extern void zfs_free_proplist(zfs_proplist_t *); 273 extern int zfs_expand_proplist(zfs_handle_t *, zfs_proplist_t **); 274 extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 275 276 #define ZFS_MOUNTPOINT_NONE "none" 277 #define ZFS_MOUNTPOINT_LEGACY "legacy" 278 279 /* 280 * Iterator functions. 281 */ 282 typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 283 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 284 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 285 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 286 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 287 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *); 288 289 /* 290 * Functions to create and destroy datasets. 291 */ 292 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 293 nvlist_t *); 294 extern int zfs_destroy(zfs_handle_t *); 295 extern int zfs_destroy_snaps(zfs_handle_t *, char *); 296 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 297 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t); 298 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int); 299 extern int zfs_rename(zfs_handle_t *, const char *); 300 extern int zfs_send(zfs_handle_t *, zfs_handle_t *); 301 extern int zfs_receive(libzfs_handle_t *, const char *, int, int, int, 302 boolean_t); 303 extern int zfs_promote(zfs_handle_t *); 304 305 /* 306 * Miscellaneous functions. 307 */ 308 extern const char *zfs_type_to_name(zfs_type_t); 309 extern void zfs_refresh_properties(zfs_handle_t *); 310 extern int zfs_name_valid(const char *, zfs_type_t); 311 312 /* 313 * Mount support functions. 314 */ 315 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 316 extern int zfs_mount(zfs_handle_t *, const char *, int); 317 extern int zfs_unmount(zfs_handle_t *, const char *, int); 318 extern int zfs_unmountall(zfs_handle_t *, int); 319 320 /* 321 * Share support functions. 322 */ 323 extern boolean_t zfs_is_shared(zfs_handle_t *, char **); 324 extern int zfs_share(zfs_handle_t *); 325 extern int zfs_unshare(zfs_handle_t *, const char *); 326 extern int zfs_unshareall(zfs_handle_t *); 327 328 /* 329 * When dealing with nvlists, verify() is extremely useful 330 */ 331 #ifdef NDEBUG 332 #define verify(EX) ((void)(EX)) 333 #else 334 #define verify(EX) assert(EX) 335 #endif 336 337 /* 338 * Utility function to convert a number to a human-readable form. 339 */ 340 extern void zfs_nicenum(uint64_t, char *, size_t); 341 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 342 343 /* 344 * Pool destroy special. Remove the device information without destroying 345 * the underlying dataset. 346 */ 347 extern int zfs_remove_link(zfs_handle_t *); 348 349 /* 350 * Given a device or file, determine if it is part of a pool. 351 */ 352 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 353 boolean_t *); 354 355 /* 356 * ftyp special. Read the label from a given device. 357 */ 358 extern int zpool_read_label(int, nvlist_t **); 359 360 /* 361 * Create and remove zvol /dev links 362 */ 363 extern int zpool_create_zvol_links(zpool_handle_t *); 364 extern int zpool_remove_zvol_links(zpool_handle_t *); 365 366 /* 367 * Mount and unmount datasets within a pool 368 */ 369 extern int zpool_mount_datasets(zpool_handle_t *, const char *, int); 370 extern int zpool_unmount_datasets(zpool_handle_t *, boolean_t); 371 372 #ifdef __cplusplus 373 } 374 #endif 375 376 #endif /* _LIBZFS_H */ 377