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, 2014 by Delphix. All rights reserved. 24 */ 25 26 #ifndef _SYS_ZFS_IOCTL_H 27 #define _SYS_ZFS_IOCTL_H 28 29 #include <sys/cred.h> 30 #include <sys/dmu.h> 31 #include <sys/zio.h> 32 #include <sys/dsl_deleg.h> 33 #include <sys/spa.h> 34 #include <sys/zfs_stat.h> 35 36 #ifdef _KERNEL 37 #include <sys/nvpair.h> 38 #endif /* _KERNEL */ 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* 45 * The structures in this file are passed between userland and the 46 * kernel. Userland may be running a 32-bit process, while the kernel 47 * is 64-bit. Therefore, these structures need to compile the same in 48 * 32-bit and 64-bit. This means not using type "long", and adding 49 * explicit padding so that the 32-bit structure will not be packed more 50 * tightly than the 64-bit structure (which requires 64-bit alignment). 51 */ 52 53 /* 54 * Property values for snapdir 55 */ 56 #define ZFS_SNAPDIR_HIDDEN 0 57 #define ZFS_SNAPDIR_VISIBLE 1 58 59 /* 60 * Field manipulation macros for the drr_versioninfo field of the 61 * send stream header. 62 */ 63 64 /* 65 * Header types for zfs send streams. 66 */ 67 typedef enum drr_headertype { 68 DMU_SUBSTREAM = 0x1, 69 DMU_COMPOUNDSTREAM = 0x2 70 } drr_headertype_t; 71 72 #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2) 73 #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x) 74 75 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30) 76 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x) 77 78 /* 79 * Feature flags for zfs send streams (flags in drr_versioninfo) 80 */ 81 82 #define DMU_BACKUP_FEATURE_DEDUP (1 << 0) 83 #define DMU_BACKUP_FEATURE_DEDUPPROPS (1 << 1) 84 #define DMU_BACKUP_FEATURE_SA_SPILL (1 << 2) 85 /* flags #3 - #15 are reserved for incompatible closed-source implementations */ 86 #define DMU_BACKUP_FEATURE_EMBED_DATA (1 << 16) 87 #define DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 (1 << 17) 88 /* flag #18 is reserved for a Delphix feature */ 89 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1 << 19) 90 #define DMU_BACKUP_FEATURE_RESUMING (1 << 20) 91 92 /* 93 * Mask of all supported backup features 94 */ 95 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \ 96 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \ 97 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 | \ 98 DMU_BACKUP_FEATURE_RESUMING | \ 99 DMU_BACKUP_FEATURE_LARGE_BLOCKS) 100 101 /* Are all features in the given flag word currently supported? */ 102 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK)) 103 104 typedef enum dmu_send_resume_token_version { 105 ZFS_SEND_RESUME_TOKEN_VERSION = 1 106 } dmu_send_resume_token_version_t; 107 108 /* 109 * The drr_versioninfo field of the dmu_replay_record has the 110 * following layout: 111 * 112 * 64 56 48 40 32 24 16 8 0 113 * +-------+-------+-------+-------+-------+-------+-------+-------+ 114 * | reserved | feature-flags |C|S| 115 * +-------+-------+-------+-------+-------+-------+-------+-------+ 116 * 117 * The low order two bits indicate the header type: SUBSTREAM (0x1) 118 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical: 119 * this field used to be a version number, where the two version types 120 * were 1 and 2. Using two bits for this allows earlier versions of 121 * the code to be able to recognize send streams that don't use any 122 * of the features indicated by feature flags. 123 */ 124 125 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL 126 127 #define DRR_FLAG_CLONE (1<<0) 128 #define DRR_FLAG_CI_DATA (1<<1) 129 130 /* 131 * flags in the drr_checksumflags field in the DRR_WRITE and 132 * DRR_WRITE_BYREF blocks 133 */ 134 #define DRR_CHECKSUM_DEDUP (1<<0) 135 136 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP) 137 138 /* 139 * zfs ioctl command structure 140 */ 141 struct drr_begin { 142 uint64_t drr_magic; 143 uint64_t drr_versioninfo; /* was drr_version */ 144 uint64_t drr_creation_time; 145 dmu_objset_type_t drr_type; 146 uint32_t drr_flags; 147 uint64_t drr_toguid; 148 uint64_t drr_fromguid; 149 char drr_toname[MAXNAMELEN]; 150 }; 151 152 struct drr_end { 153 zio_cksum_t drr_checksum; 154 uint64_t drr_toguid; 155 }; 156 157 struct drr_object { 158 uint64_t drr_object; 159 dmu_object_type_t drr_type; 160 dmu_object_type_t drr_bonustype; 161 uint32_t drr_blksz; 162 uint32_t drr_bonuslen; 163 uint8_t drr_checksumtype; 164 uint8_t drr_compress; 165 uint8_t drr_pad[6]; 166 uint64_t drr_toguid; 167 /* bonus content follows */ 168 }; 169 170 struct drr_freeobjects { 171 uint64_t drr_firstobj; 172 uint64_t drr_numobjs; 173 uint64_t drr_toguid; 174 }; 175 176 struct drr_write { 177 uint64_t drr_object; 178 dmu_object_type_t drr_type; 179 uint32_t drr_pad; 180 uint64_t drr_offset; 181 uint64_t drr_length; 182 uint64_t drr_toguid; 183 uint8_t drr_checksumtype; 184 uint8_t drr_checksumflags; 185 uint8_t drr_pad2[6]; 186 ddt_key_t drr_key; /* deduplication key */ 187 /* content follows */ 188 }; 189 190 struct drr_free { 191 uint64_t drr_object; 192 uint64_t drr_offset; 193 uint64_t drr_length; 194 uint64_t drr_toguid; 195 }; 196 197 struct drr_write_byref { 198 /* where to put the data */ 199 uint64_t drr_object; 200 uint64_t drr_offset; 201 uint64_t drr_length; 202 uint64_t drr_toguid; 203 /* where to find the prior copy of the data */ 204 uint64_t drr_refguid; 205 uint64_t drr_refobject; 206 uint64_t drr_refoffset; 207 /* properties of the data */ 208 uint8_t drr_checksumtype; 209 uint8_t drr_checksumflags; 210 uint8_t drr_pad2[6]; 211 ddt_key_t drr_key; /* deduplication key */ 212 }; 213 214 struct drr_spill { 215 uint64_t drr_object; 216 uint64_t drr_length; 217 uint64_t drr_toguid; 218 uint64_t drr_pad[4]; /* needed for crypto */ 219 /* spill data follows */ 220 }; 221 222 typedef struct dmu_replay_record { 223 enum { 224 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS, 225 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF, 226 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES 227 } drr_type; 228 uint32_t drr_payloadlen; 229 union { 230 struct drr_begin drr_begin; 231 struct drr_end drr_end; 232 struct drr_object drr_object; 233 struct drr_freeobjects drr_freeobjects; 234 struct drr_write drr_write; 235 struct drr_free drr_free; 236 struct drr_write_byref drr_write_byref; 237 struct drr_spill 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 uint32_t zi_cmd; 302 uint32_t zi_pad; 303 } zinject_record_t; 304 305 #define ZINJECT_NULL 0x1 306 #define ZINJECT_FLUSH_ARC 0x2 307 #define ZINJECT_UNLOAD_SPA 0x4 308 309 typedef enum zinject_type { 310 ZINJECT_UNINITIALIZED, 311 ZINJECT_DATA_FAULT, 312 ZINJECT_DEVICE_FAULT, 313 ZINJECT_LABEL_FAULT, 314 ZINJECT_IGNORED_WRITES, 315 ZINJECT_PANIC, 316 ZINJECT_DELAY_IO, 317 } zinject_type_t; 318 319 typedef struct zfs_share { 320 uint64_t z_exportdata; 321 uint64_t z_sharedata; 322 uint64_t z_sharetype; /* 0 = share, 1 = unshare */ 323 uint64_t z_sharemax; /* max length of share string */ 324 } zfs_share_t; 325 326 /* 327 * ZFS file systems may behave the usual, POSIX-compliant way, where 328 * name lookups are case-sensitive. They may also be set up so that 329 * all the name lookups are case-insensitive, or so that only some 330 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive. 331 */ 332 typedef enum zfs_case { 333 ZFS_CASE_SENSITIVE, 334 ZFS_CASE_INSENSITIVE, 335 ZFS_CASE_MIXED 336 } zfs_case_t; 337 338 typedef struct zfs_cmd { 339 char zc_name[MAXPATHLEN]; /* name of pool or dataset */ 340 uint64_t zc_nvlist_src; /* really (char *) */ 341 uint64_t zc_nvlist_src_size; 342 uint64_t zc_nvlist_dst; /* really (char *) */ 343 uint64_t zc_nvlist_dst_size; 344 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */ 345 int zc_pad2; 346 347 /* 348 * The following members are for legacy ioctls which haven't been 349 * converted to the new method. 350 */ 351 uint64_t zc_history; /* really (char *) */ 352 char zc_value[MAXPATHLEN * 2]; 353 char zc_string[MAXNAMELEN]; 354 uint64_t zc_guid; 355 uint64_t zc_nvlist_conf; /* really (char *) */ 356 uint64_t zc_nvlist_conf_size; 357 uint64_t zc_cookie; 358 uint64_t zc_objset_type; 359 uint64_t zc_perm_action; 360 uint64_t zc_history_len; 361 uint64_t zc_history_offset; 362 uint64_t zc_obj; 363 uint64_t zc_iflags; /* internal to zfs(7fs) */ 364 zfs_share_t zc_share; 365 uint64_t zc_jailid; 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 uint8_t zc_simple; 374 boolean_t zc_resumable; 375 uint64_t zc_sendobj; 376 uint64_t zc_fromobj; 377 uint64_t zc_createtxg; 378 zfs_stat_t zc_stat; 379 } zfs_cmd_t; 380 381 typedef struct zfs_useracct { 382 char zu_domain[256]; 383 uid_t zu_rid; 384 uint32_t zu_pad; 385 uint64_t zu_space; 386 } zfs_useracct_t; 387 388 #define ZFSDEV_MAX_MINOR (1 << 16) 389 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1) 390 391 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1 392 393 #ifdef _KERNEL 394 395 typedef struct zfs_creat { 396 nvlist_t *zct_zplprops; 397 nvlist_t *zct_props; 398 } zfs_creat_t; 399 400 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr); 401 extern int zfs_secpolicy_rename_perms(const char *from, 402 const char *to, cred_t *cr); 403 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr); 404 extern int zfs_busy(void); 405 extern int zfs_unmount_snap(const char *); 406 extern void zfs_destroy_unmount_origin(const char *); 407 408 /* 409 * ZFS minor numbers can refer to either a control device instance or 410 * a zvol. Depending on the value of zss_type, zss_data points to either 411 * a zvol_state_t or a zfs_onexit_t. 412 */ 413 enum zfs_soft_state_type { 414 ZSST_ZVOL, 415 ZSST_CTLDEV 416 }; 417 418 typedef struct zfs_soft_state { 419 enum zfs_soft_state_type zss_type; 420 void *zss_data; 421 } zfs_soft_state_t; 422 423 extern void *zfsdev_get_soft_state(minor_t minor, 424 enum zfs_soft_state_type which); 425 extern minor_t zfsdev_minor_alloc(void); 426 427 extern void *zfsdev_state; 428 429 #endif /* _KERNEL */ 430 431 #ifdef __cplusplus 432 } 433 #endif 434 435 #endif /* _SYS_ZFS_IOCTL_H */ 436