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