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