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