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