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 typedef struct dmu_replay_record { 142 enum { 143 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS, 144 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF, 145 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES 146 } drr_type; 147 uint32_t drr_payloadlen; 148 union { 149 struct drr_begin { 150 uint64_t drr_magic; 151 uint64_t drr_versioninfo; /* was drr_version */ 152 uint64_t drr_creation_time; 153 dmu_objset_type_t drr_type; 154 uint32_t drr_flags; 155 uint64_t drr_toguid; 156 uint64_t drr_fromguid; 157 char drr_toname[MAXNAMELEN]; 158 } drr_begin; 159 struct drr_end { 160 zio_cksum_t drr_checksum; 161 uint64_t drr_toguid; 162 } drr_end; 163 struct drr_object { 164 uint64_t drr_object; 165 dmu_object_type_t drr_type; 166 dmu_object_type_t drr_bonustype; 167 uint32_t drr_blksz; 168 uint32_t drr_bonuslen; 169 uint8_t drr_checksumtype; 170 uint8_t drr_compress; 171 uint8_t drr_pad[6]; 172 uint64_t drr_toguid; 173 /* bonus content follows */ 174 } drr_object; 175 struct drr_freeobjects { 176 uint64_t drr_firstobj; 177 uint64_t drr_numobjs; 178 uint64_t drr_toguid; 179 } drr_freeobjects; 180 struct drr_write { 181 uint64_t drr_object; 182 dmu_object_type_t drr_type; 183 uint32_t drr_pad; 184 uint64_t drr_offset; 185 uint64_t drr_length; 186 uint64_t drr_toguid; 187 uint8_t drr_checksumtype; 188 uint8_t drr_checksumflags; 189 uint8_t drr_pad2[6]; 190 ddt_key_t drr_key; /* deduplication key */ 191 /* content follows */ 192 } drr_write; 193 struct drr_free { 194 uint64_t drr_object; 195 uint64_t drr_offset; 196 uint64_t drr_length; 197 uint64_t drr_toguid; 198 } drr_free; 199 struct drr_write_byref { 200 /* where to put the data */ 201 uint64_t drr_object; 202 uint64_t drr_offset; 203 uint64_t drr_length; 204 uint64_t drr_toguid; 205 /* where to find the prior copy of the data */ 206 uint64_t drr_refguid; 207 uint64_t drr_refobject; 208 uint64_t drr_refoffset; 209 /* properties of the data */ 210 uint8_t drr_checksumtype; 211 uint8_t drr_checksumflags; 212 uint8_t drr_pad2[6]; 213 ddt_key_t drr_key; /* deduplication key */ 214 } drr_write_byref; 215 struct drr_spill { 216 uint64_t drr_object; 217 uint64_t drr_length; 218 uint64_t drr_toguid; 219 uint64_t drr_pad[4]; /* needed for crypto */ 220 /* spill data follows */ 221 } drr_spill; 222 struct drr_write_embedded { 223 uint64_t drr_object; 224 uint64_t drr_offset; 225 /* logical length, should equal blocksize */ 226 uint64_t drr_length; 227 uint64_t drr_toguid; 228 uint8_t drr_compression; 229 uint8_t drr_etype; 230 uint8_t drr_pad[6]; 231 uint32_t drr_lsize; /* uncompressed size of payload */ 232 uint32_t drr_psize; /* compr. (real) size of payload */ 233 /* (possibly compressed) content follows */ 234 } drr_write_embedded; 235 236 /* 237 * Nore: drr_checksum is overlaid with all record types 238 * except DRR_BEGIN. Therefore its (non-pad) members 239 * must not overlap with members from the other structs. 240 * We accomplish this by putting its members at the very 241 * end of the struct. 242 */ 243 struct drr_checksum { 244 uint64_t drr_pad[34]; 245 /* 246 * fletcher-4 checksum of everything preceding the 247 * checksum. 248 */ 249 zio_cksum_t drr_checksum; 250 } drr_checksum; 251 } drr_u; 252 } dmu_replay_record_t; 253 254 /* diff record range types */ 255 typedef enum diff_type { 256 DDR_NONE = 0x1, 257 DDR_INUSE = 0x2, 258 DDR_FREE = 0x4 259 } diff_type_t; 260 261 /* 262 * The diff reports back ranges of free or in-use objects. 263 */ 264 typedef struct dmu_diff_record { 265 uint64_t ddr_type; 266 uint64_t ddr_first; 267 uint64_t ddr_last; 268 } dmu_diff_record_t; 269 270 typedef struct zinject_record { 271 uint64_t zi_objset; 272 uint64_t zi_object; 273 uint64_t zi_start; 274 uint64_t zi_end; 275 uint64_t zi_guid; 276 uint32_t zi_level; 277 uint32_t zi_error; 278 uint64_t zi_type; 279 uint32_t zi_freq; 280 uint32_t zi_failfast; 281 char zi_func[MAXNAMELEN]; 282 uint32_t zi_iotype; 283 int32_t zi_duration; 284 uint64_t zi_timer; 285 uint32_t zi_cmd; 286 uint32_t zi_pad; 287 } zinject_record_t; 288 289 #define ZINJECT_NULL 0x1 290 #define ZINJECT_FLUSH_ARC 0x2 291 #define ZINJECT_UNLOAD_SPA 0x4 292 293 typedef enum zinject_type { 294 ZINJECT_UNINITIALIZED, 295 ZINJECT_DATA_FAULT, 296 ZINJECT_DEVICE_FAULT, 297 ZINJECT_LABEL_FAULT, 298 ZINJECT_IGNORED_WRITES, 299 ZINJECT_PANIC, 300 ZINJECT_DELAY_IO, 301 } zinject_type_t; 302 303 typedef struct zfs_share { 304 uint64_t z_exportdata; 305 uint64_t z_sharedata; 306 uint64_t z_sharetype; /* 0 = share, 1 = unshare */ 307 uint64_t z_sharemax; /* max length of share string */ 308 } zfs_share_t; 309 310 /* 311 * ZFS file systems may behave the usual, POSIX-compliant way, where 312 * name lookups are case-sensitive. They may also be set up so that 313 * all the name lookups are case-insensitive, or so that only some 314 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive. 315 */ 316 typedef enum zfs_case { 317 ZFS_CASE_SENSITIVE, 318 ZFS_CASE_INSENSITIVE, 319 ZFS_CASE_MIXED 320 } zfs_case_t; 321 322 typedef struct zfs_cmd { 323 char zc_name[MAXPATHLEN]; /* name of pool or dataset */ 324 uint64_t zc_nvlist_src; /* really (char *) */ 325 uint64_t zc_nvlist_src_size; 326 uint64_t zc_nvlist_dst; /* really (char *) */ 327 uint64_t zc_nvlist_dst_size; 328 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */ 329 int zc_pad2; 330 331 /* 332 * The following members are for legacy ioctls which haven't been 333 * converted to the new method. 334 */ 335 uint64_t zc_history; /* really (char *) */ 336 char zc_value[MAXPATHLEN * 2]; 337 char zc_string[MAXNAMELEN]; 338 uint64_t zc_guid; 339 uint64_t zc_nvlist_conf; /* really (char *) */ 340 uint64_t zc_nvlist_conf_size; 341 uint64_t zc_cookie; 342 uint64_t zc_objset_type; 343 uint64_t zc_perm_action; 344 uint64_t zc_history_len; 345 uint64_t zc_history_offset; 346 uint64_t zc_obj; 347 uint64_t zc_iflags; /* internal to zfs(7fs) */ 348 zfs_share_t zc_share; 349 dmu_objset_stats_t zc_objset_stats; 350 dmu_replay_record_t zc_begin_record; 351 zinject_record_t zc_inject_record; 352 uint32_t zc_defer_destroy; 353 uint32_t zc_flags; 354 uint64_t zc_action_handle; 355 int zc_cleanup_fd; 356 boolean_t zc_resumable; 357 uint64_t zc_sendobj; 358 uint64_t zc_fromobj; 359 uint64_t zc_createtxg; 360 zfs_stat_t zc_stat; 361 } zfs_cmd_t; 362 363 typedef struct zfs_useracct { 364 char zu_domain[256]; 365 uid_t zu_rid; 366 uint32_t zu_pad; 367 uint64_t zu_space; 368 } zfs_useracct_t; 369 370 #define ZFSDEV_MAX_MINOR (1 << 16) 371 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1) 372 373 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1 374 375 #ifdef _KERNEL 376 377 typedef struct zfs_creat { 378 nvlist_t *zct_zplprops; 379 nvlist_t *zct_props; 380 } zfs_creat_t; 381 382 extern dev_info_t *zfs_dip; 383 384 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr); 385 extern int zfs_secpolicy_rename_perms(const char *from, 386 const char *to, cred_t *cr); 387 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr); 388 extern int zfs_busy(void); 389 extern int zfs_unmount_snap(const char *); 390 extern void zfs_destroy_unmount_origin(const char *); 391 392 /* 393 * ZFS minor numbers can refer to either a control device instance or 394 * a zvol. Depending on the value of zss_type, zss_data points to either 395 * a zvol_state_t or a zfs_onexit_t. 396 */ 397 enum zfs_soft_state_type { 398 ZSST_ZVOL, 399 ZSST_CTLDEV 400 }; 401 402 typedef struct zfs_soft_state { 403 enum zfs_soft_state_type zss_type; 404 void *zss_data; 405 } zfs_soft_state_t; 406 407 extern void *zfsdev_get_soft_state(minor_t minor, 408 enum zfs_soft_state_type which); 409 extern minor_t zfsdev_minor_alloc(void); 410 411 extern void *zfsdev_state; 412 extern kmutex_t zfsdev_state_lock; 413 414 #endif /* _KERNEL */ 415 416 #ifdef __cplusplus 417 } 418 #endif 419 420 #endif /* _SYS_ZFS_IOCTL_H */ 421