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