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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright (c) 2012, 2015 by Delphix. All rights reserved. 24 * Copyright 2016 RackTop Systems. 25 * Copyright (c) 2014 Integros [integros.com] 26 */ 27 28 #ifndef _SYS_ZFS_IOCTL_H 29 #define _SYS_ZFS_IOCTL_H 30 31 #include <sys/cred.h> 32 #include <sys/dmu.h> 33 #include <sys/zio.h> 34 #include <sys/dsl_deleg.h> 35 #include <sys/spa.h> 36 #include <sys/zfs_stat.h> 37 38 #ifdef _KERNEL 39 #include <sys/nvpair.h> 40 #endif /* _KERNEL */ 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 /* 47 * The structures in this file are passed between userland and the 48 * kernel. Userland may be running a 32-bit process, while the kernel 49 * is 64-bit. Therefore, these structures need to compile the same in 50 * 32-bit and 64-bit. This means not using type "long", and adding 51 * explicit padding so that the 32-bit structure will not be packed more 52 * tightly than the 64-bit structure (which requires 64-bit alignment). 53 */ 54 55 /* 56 * Property values for snapdir 57 */ 58 #define ZFS_SNAPDIR_HIDDEN 0 59 #define ZFS_SNAPDIR_VISIBLE 1 60 61 /* 62 * Field manipulation macros for the drr_versioninfo field of the 63 * send stream header. 64 */ 65 66 /* 67 * Header types for zfs send streams. 68 */ 69 typedef enum drr_headertype { 70 DMU_SUBSTREAM = 0x1, 71 DMU_COMPOUNDSTREAM = 0x2 72 } drr_headertype_t; 73 74 #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2) 75 #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x) 76 77 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30) 78 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x) 79 80 /* 81 * Feature flags for zfs send streams (flags in drr_versioninfo) 82 */ 83 84 #define DMU_BACKUP_FEATURE_DEDUP (1 << 0) 85 #define DMU_BACKUP_FEATURE_DEDUPPROPS (1 << 1) 86 #define DMU_BACKUP_FEATURE_SA_SPILL (1 << 2) 87 /* flags #3 - #15 are reserved for incompatible closed-source implementations */ 88 #define DMU_BACKUP_FEATURE_EMBED_DATA (1 << 16) 89 #define DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 (1 << 17) 90 /* flag #18 is reserved for a Delphix feature */ 91 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1 << 19) 92 #define DMU_BACKUP_FEATURE_RESUMING (1 << 20) 93 94 /* 95 * Mask of all supported backup features 96 */ 97 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \ 98 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \ 99 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 | \ 100 DMU_BACKUP_FEATURE_RESUMING | \ 101 DMU_BACKUP_FEATURE_LARGE_BLOCKS) 102 103 /* Are all features in the given flag word currently supported? */ 104 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK)) 105 106 typedef enum dmu_send_resume_token_version { 107 ZFS_SEND_RESUME_TOKEN_VERSION = 1 108 } dmu_send_resume_token_version_t; 109 110 /* 111 * The drr_versioninfo field of the dmu_replay_record has the 112 * following layout: 113 * 114 * 64 56 48 40 32 24 16 8 0 115 * +-------+-------+-------+-------+-------+-------+-------+-------+ 116 * | reserved | feature-flags |C|S| 117 * +-------+-------+-------+-------+-------+-------+-------+-------+ 118 * 119 * The low order two bits indicate the header type: SUBSTREAM (0x1) 120 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical: 121 * this field used to be a version number, where the two version types 122 * were 1 and 2. Using two bits for this allows earlier versions of 123 * the code to be able to recognize send streams that don't use any 124 * of the features indicated by feature flags. 125 */ 126 127 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL 128 129 /* 130 * Send stream flags. Bits 24-31 are reserved for vendor-specific 131 * implementations and should not be used. 132 */ 133 #define DRR_FLAG_CLONE (1<<0) 134 #define DRR_FLAG_CI_DATA (1<<1) 135 /* 136 * This send stream, if it is a full send, includes the FREE and FREEOBJECT 137 * records that are created by the sending process. This means that the send 138 * stream can be received as a clone, even though it is not an incremental. 139 * This is not implemented as a feature flag, because the receiving side does 140 * not need to have implemented it to receive this stream; it is fully backwards 141 * compatible. We need a flag, though, because full send streams without it 142 * cannot necessarily be received as a clone correctly. 143 */ 144 #define DRR_FLAG_FREERECORDS (1<<2) 145 146 /* 147 * flags in the drr_checksumflags field in the DRR_WRITE and 148 * DRR_WRITE_BYREF blocks 149 */ 150 #define DRR_CHECKSUM_DEDUP (1<<0) 151 152 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP) 153 154 /* 155 * zfs ioctl command structure 156 */ 157 typedef struct dmu_replay_record { 158 enum { 159 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS, 160 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF, 161 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES 162 } drr_type; 163 uint32_t drr_payloadlen; 164 union { 165 struct drr_begin { 166 uint64_t drr_magic; 167 uint64_t drr_versioninfo; /* was drr_version */ 168 uint64_t drr_creation_time; 169 dmu_objset_type_t drr_type; 170 uint32_t drr_flags; 171 uint64_t drr_toguid; 172 uint64_t drr_fromguid; 173 char drr_toname[MAXNAMELEN]; 174 } drr_begin; 175 struct drr_end { 176 zio_cksum_t drr_checksum; 177 uint64_t drr_toguid; 178 } drr_end; 179 struct drr_object { 180 uint64_t drr_object; 181 dmu_object_type_t drr_type; 182 dmu_object_type_t drr_bonustype; 183 uint32_t drr_blksz; 184 uint32_t drr_bonuslen; 185 uint8_t drr_checksumtype; 186 uint8_t drr_compress; 187 uint8_t drr_pad[6]; 188 uint64_t drr_toguid; 189 /* bonus content follows */ 190 } drr_object; 191 struct drr_freeobjects { 192 uint64_t drr_firstobj; 193 uint64_t drr_numobjs; 194 uint64_t drr_toguid; 195 } drr_freeobjects; 196 struct drr_write { 197 uint64_t drr_object; 198 dmu_object_type_t drr_type; 199 uint32_t drr_pad; 200 uint64_t drr_offset; 201 uint64_t drr_length; 202 uint64_t drr_toguid; 203 uint8_t drr_checksumtype; 204 uint8_t drr_checksumflags; 205 uint8_t drr_pad2[6]; 206 ddt_key_t drr_key; /* deduplication key */ 207 /* content follows */ 208 } drr_write; 209 struct drr_free { 210 uint64_t drr_object; 211 uint64_t drr_offset; 212 uint64_t drr_length; 213 uint64_t drr_toguid; 214 } drr_free; 215 struct drr_write_byref { 216 /* where to put the data */ 217 uint64_t drr_object; 218 uint64_t drr_offset; 219 uint64_t drr_length; 220 uint64_t drr_toguid; 221 /* where to find the prior copy of the data */ 222 uint64_t drr_refguid; 223 uint64_t drr_refobject; 224 uint64_t drr_refoffset; 225 /* properties of the data */ 226 uint8_t drr_checksumtype; 227 uint8_t drr_checksumflags; 228 uint8_t drr_pad2[6]; 229 ddt_key_t drr_key; /* deduplication key */ 230 } drr_write_byref; 231 struct drr_spill { 232 uint64_t drr_object; 233 uint64_t drr_length; 234 uint64_t drr_toguid; 235 uint64_t drr_pad[4]; /* needed for crypto */ 236 /* spill data follows */ 237 } drr_spill; 238 struct drr_write_embedded { 239 uint64_t drr_object; 240 uint64_t drr_offset; 241 /* logical length, should equal blocksize */ 242 uint64_t drr_length; 243 uint64_t drr_toguid; 244 uint8_t drr_compression; 245 uint8_t drr_etype; 246 uint8_t drr_pad[6]; 247 uint32_t drr_lsize; /* uncompressed size of payload */ 248 uint32_t drr_psize; /* compr. (real) size of payload */ 249 /* (possibly compressed) content follows */ 250 } drr_write_embedded; 251 252 /* 253 * Nore: drr_checksum is overlaid with all record types 254 * except DRR_BEGIN. Therefore its (non-pad) members 255 * must not overlap with members from the other structs. 256 * We accomplish this by putting its members at the very 257 * end of the struct. 258 */ 259 struct drr_checksum { 260 uint64_t drr_pad[34]; 261 /* 262 * fletcher-4 checksum of everything preceding the 263 * checksum. 264 */ 265 zio_cksum_t drr_checksum; 266 } drr_checksum; 267 } drr_u; 268 } dmu_replay_record_t; 269 270 /* diff record range types */ 271 typedef enum diff_type { 272 DDR_NONE = 0x1, 273 DDR_INUSE = 0x2, 274 DDR_FREE = 0x4 275 } diff_type_t; 276 277 /* 278 * The diff reports back ranges of free or in-use objects. 279 */ 280 typedef struct dmu_diff_record { 281 uint64_t ddr_type; 282 uint64_t ddr_first; 283 uint64_t ddr_last; 284 } dmu_diff_record_t; 285 286 typedef struct zinject_record { 287 uint64_t zi_objset; 288 uint64_t zi_object; 289 uint64_t zi_start; 290 uint64_t zi_end; 291 uint64_t zi_guid; 292 uint32_t zi_level; 293 uint32_t zi_error; 294 uint64_t zi_type; 295 uint32_t zi_freq; 296 uint32_t zi_failfast; 297 char zi_func[MAXNAMELEN]; 298 uint32_t zi_iotype; 299 int32_t zi_duration; 300 uint64_t zi_timer; 301 uint64_t zi_nlanes; 302 uint32_t zi_cmd; 303 uint32_t zi_pad; 304 } zinject_record_t; 305 306 #define ZINJECT_NULL 0x1 307 #define ZINJECT_FLUSH_ARC 0x2 308 #define ZINJECT_UNLOAD_SPA 0x4 309 310 typedef enum zinject_type { 311 ZINJECT_UNINITIALIZED, 312 ZINJECT_DATA_FAULT, 313 ZINJECT_DEVICE_FAULT, 314 ZINJECT_LABEL_FAULT, 315 ZINJECT_IGNORED_WRITES, 316 ZINJECT_PANIC, 317 ZINJECT_DELAY_IO, 318 } zinject_type_t; 319 320 typedef struct zfs_share { 321 uint64_t z_exportdata; 322 uint64_t z_sharedata; 323 uint64_t z_sharetype; /* 0 = share, 1 = unshare */ 324 uint64_t z_sharemax; /* max length of share string */ 325 } zfs_share_t; 326 327 /* 328 * ZFS file systems may behave the usual, POSIX-compliant way, where 329 * name lookups are case-sensitive. They may also be set up so that 330 * all the name lookups are case-insensitive, or so that only some 331 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive. 332 */ 333 typedef enum zfs_case { 334 ZFS_CASE_SENSITIVE, 335 ZFS_CASE_INSENSITIVE, 336 ZFS_CASE_MIXED 337 } zfs_case_t; 338 339 typedef struct zfs_cmd { 340 char zc_name[MAXPATHLEN]; /* name of pool or dataset */ 341 uint64_t zc_nvlist_src; /* really (char *) */ 342 uint64_t zc_nvlist_src_size; 343 uint64_t zc_nvlist_dst; /* really (char *) */ 344 uint64_t zc_nvlist_dst_size; 345 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */ 346 int zc_pad2; 347 348 /* 349 * The following members are for legacy ioctls which haven't been 350 * converted to the new method. 351 */ 352 uint64_t zc_history; /* really (char *) */ 353 char zc_value[MAXPATHLEN * 2]; 354 char zc_string[MAXNAMELEN]; 355 uint64_t zc_guid; 356 uint64_t zc_nvlist_conf; /* really (char *) */ 357 uint64_t zc_nvlist_conf_size; 358 uint64_t zc_cookie; 359 uint64_t zc_objset_type; 360 uint64_t zc_perm_action; 361 uint64_t zc_history_len; 362 uint64_t zc_history_offset; 363 uint64_t zc_obj; 364 uint64_t zc_iflags; /* internal to zfs(7fs) */ 365 zfs_share_t zc_share; 366 dmu_objset_stats_t zc_objset_stats; 367 dmu_replay_record_t zc_begin_record; 368 zinject_record_t zc_inject_record; 369 uint32_t zc_defer_destroy; 370 uint32_t zc_flags; 371 uint64_t zc_action_handle; 372 int zc_cleanup_fd; 373 boolean_t zc_resumable; 374 uint64_t zc_sendobj; 375 uint64_t zc_fromobj; 376 uint64_t zc_createtxg; 377 zfs_stat_t zc_stat; 378 } zfs_cmd_t; 379 380 typedef struct zfs_useracct { 381 char zu_domain[256]; 382 uid_t zu_rid; 383 uint32_t zu_pad; 384 uint64_t zu_space; 385 } zfs_useracct_t; 386 387 #define ZFSDEV_MAX_MINOR (1 << 16) 388 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1) 389 390 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1 391 392 typedef enum arc_info_state { 393 AIS_UNKNOWN, 394 AIS_ANON, 395 AIS_MRU, 396 AIS_MRU_GHOST, 397 AIS_MFU, 398 AIS_MFU_GHOST, 399 AIS_L2C_ONLY, 400 AIS_NO_L1HDR 401 } arc_info_state_t; 402 403 typedef struct arc_info_hdr { 404 uint64_t aih_buckets; 405 uint64_t aih_buf_locks; 406 uint64_t aih_entries; 407 uint64_t aih_next; 408 } arc_info_hdr_t; 409 410 typedef struct arc_info { 411 dva_t ai_dva; 412 uint64_t ai_birth; 413 uint64_t ai_flags; 414 uint64_t ai_spa; 415 uint32_t ai_size; 416 arc_info_state_t ai_state; 417 } arc_info_t; 418 419 #ifdef _KERNEL 420 421 typedef struct zfs_creat { 422 nvlist_t *zct_zplprops; 423 nvlist_t *zct_props; 424 } zfs_creat_t; 425 426 extern dev_info_t *zfs_dip; 427 428 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr); 429 extern int zfs_secpolicy_rename_perms(const char *from, 430 const char *to, cred_t *cr); 431 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr); 432 extern int zfs_busy(void); 433 extern int zfs_unmount_snap(const char *); 434 extern void zfs_destroy_unmount_origin(const char *); 435 436 /* 437 * ZFS minor numbers can refer to either a control device instance or 438 * a zvol. Depending on the value of zss_type, zss_data points to either 439 * a zvol_state_t or a zfs_onexit_t. 440 */ 441 enum zfs_soft_state_type { 442 ZSST_ZVOL, 443 ZSST_CTLDEV 444 }; 445 446 typedef struct zfs_soft_state { 447 enum zfs_soft_state_type zss_type; 448 void *zss_data; 449 } zfs_soft_state_t; 450 451 extern void *zfsdev_get_soft_state(minor_t minor, 452 enum zfs_soft_state_type which); 453 extern minor_t zfsdev_minor_alloc(void); 454 455 extern void *zfsdev_state; 456 extern kmutex_t zfsdev_state_lock; 457 458 #endif /* _KERNEL */ 459 460 #ifdef __cplusplus 461 } 462 #endif 463 464 #endif /* _SYS_ZFS_IOCTL_H */ 465