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.
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.
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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2017 by Delphix. All rights reserved.
24 * Copyright 2016 RackTop Systems.
25 * Copyright (c) 2017, Intel Corporation.
28 #ifndef _SYS_ZFS_IOCTL_H
29 #define _SYS_ZFS_IOCTL_H
34 #include <sys/dsl_deleg.h>
36 #include <sys/zfs_stat.h>
39 #include <sys/nvpair.h>
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).
56 * Property values for snapdir
58 #define ZFS_SNAPDIR_HIDDEN 0
59 #define ZFS_SNAPDIR_VISIBLE 1
62 * Property values for snapdev
64 #define ZFS_SNAPDEV_HIDDEN 0
65 #define ZFS_SNAPDEV_VISIBLE 1
67 * Property values for acltype
69 #define ZFS_ACLTYPE_OFF 0
70 #define ZFS_ACLTYPE_POSIXACL 1
73 * Field manipulation macros for the drr_versioninfo field of the
78 * Header types for zfs send streams.
80 typedef enum drr_headertype {
82 DMU_COMPOUNDSTREAM = 0x2
85 #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2)
86 #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x)
88 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
89 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
92 * Feature flags for zfs send streams (flags in drr_versioninfo)
95 #define DMU_BACKUP_FEATURE_DEDUP (1 << 0)
96 #define DMU_BACKUP_FEATURE_DEDUPPROPS (1 << 1)
97 #define DMU_BACKUP_FEATURE_SA_SPILL (1 << 2)
98 /* flags #3 - #15 are reserved for incompatible closed-source implementations */
99 #define DMU_BACKUP_FEATURE_EMBED_DATA (1 << 16)
100 #define DMU_BACKUP_FEATURE_LZ4 (1 << 17)
101 /* flag #18 is reserved for a Delphix feature */
102 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1 << 19)
103 #define DMU_BACKUP_FEATURE_RESUMING (1 << 20)
104 /* flag #21 is reserved for a Delphix feature */
105 #define DMU_BACKUP_FEATURE_COMPRESSED (1 << 22)
106 #define DMU_BACKUP_FEATURE_LARGE_DNODE (1 << 23)
107 #define DMU_BACKUP_FEATURE_RAW (1 << 24)
110 * Mask of all supported backup features
112 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
113 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
114 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_LZ4 | \
115 DMU_BACKUP_FEATURE_RESUMING | DMU_BACKUP_FEATURE_LARGE_BLOCKS | \
116 DMU_BACKUP_FEATURE_COMPRESSED | DMU_BACKUP_FEATURE_LARGE_DNODE | \
117 DMU_BACKUP_FEATURE_RAW)
119 /* Are all features in the given flag word currently supported? */
120 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
122 typedef enum dmu_send_resume_token_version {
123 ZFS_SEND_RESUME_TOKEN_VERSION = 1
124 } dmu_send_resume_token_version_t;
127 * The drr_versioninfo field of the dmu_replay_record has the
130 * 64 56 48 40 32 24 16 8 0
131 * +-------+-------+-------+-------+-------+-------+-------+-------+
132 * | reserved | feature-flags |C|S|
133 * +-------+-------+-------+-------+-------+-------+-------+-------+
135 * The low order two bits indicate the header type: SUBSTREAM (0x1)
136 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
137 * this field used to be a version number, where the two version types
138 * were 1 and 2. Using two bits for this allows earlier versions of
139 * the code to be able to recognize send streams that don't use any
140 * of the features indicated by feature flags.
143 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
146 * Send stream flags. Bits 24-31 are reserved for vendor-specific
147 * implementations and should not be used.
149 #define DRR_FLAG_CLONE (1<<0)
150 #define DRR_FLAG_CI_DATA (1<<1)
152 * This send stream, if it is a full send, includes the FREE and FREEOBJECT
153 * records that are created by the sending process. This means that the send
154 * stream can be received as a clone, even though it is not an incremental.
155 * This is not implemented as a feature flag, because the receiving side does
156 * not need to have implemented it to receive this stream; it is fully backwards
157 * compatible. We need a flag, though, because full send streams without it
158 * cannot necessarily be received as a clone correctly.
160 #define DRR_FLAG_FREERECORDS (1<<2)
163 * flags in the drr_flags field in the DRR_WRITE, DRR_SPILL, DRR_OBJECT,
164 * DRR_WRITE_BYREF, and DRR_OBJECT_RANGE blocks
166 #define DRR_CHECKSUM_DEDUP (1<<0) /* not used for DRR_SPILL blocks */
167 #define DRR_RAW_BYTESWAP (1<<1)
169 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
170 #define DRR_IS_RAW_BYTESWAPPED(flags) ((flags) & DRR_RAW_BYTESWAP)
172 /* deal with compressed drr_write replay records */
173 #define DRR_WRITE_COMPRESSED(drrw) ((drrw)->drr_compressiontype != 0)
174 #define DRR_WRITE_PAYLOAD_SIZE(drrw) \
175 (DRR_WRITE_COMPRESSED(drrw) ? (drrw)->drr_compressed_size : \
176 (drrw)->drr_logical_size)
177 #define DRR_SPILL_PAYLOAD_SIZE(drrs) \
178 ((drrs)->drr_compressed_size ? \
179 (drrs)->drr_compressed_size : (drrs)->drr_length)
180 #define DRR_OBJECT_PAYLOAD_SIZE(drro) \
181 ((drro)->drr_raw_bonuslen != 0 ? \
182 (drro)->drr_raw_bonuslen : P2ROUNDUP((drro)->drr_bonuslen, 8))
185 * zfs ioctl command structure
187 typedef struct dmu_replay_record {
189 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
190 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
191 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_OBJECT_RANGE,
194 uint32_t drr_payloadlen;
198 uint64_t drr_versioninfo; /* was drr_version */
199 uint64_t drr_creation_time;
200 dmu_objset_type_t drr_type;
203 uint64_t drr_fromguid;
204 char drr_toname[MAXNAMELEN];
207 zio_cksum_t drr_checksum;
212 dmu_object_type_t drr_type;
213 dmu_object_type_t drr_bonustype;
215 uint32_t drr_bonuslen;
216 uint8_t drr_checksumtype;
217 uint8_t drr_compress;
218 uint8_t drr_dn_slots;
220 uint32_t drr_raw_bonuslen;
222 /* only (possibly) nonzero for raw streams */
223 uint8_t drr_indblkshift;
227 uint64_t drr_maxblkid;
228 /* bonus content follows */
230 struct drr_freeobjects {
231 uint64_t drr_firstobj;
232 uint64_t drr_numobjs;
237 dmu_object_type_t drr_type;
240 uint64_t drr_logical_size;
242 uint8_t drr_checksumtype;
244 uint8_t drr_compressiontype;
246 /* deduplication key */
248 /* only nonzero if drr_compressiontype is not 0 */
249 uint64_t drr_compressed_size;
250 /* only nonzero for raw streams */
251 uint8_t drr_salt[ZIO_DATA_SALT_LEN];
252 uint8_t drr_iv[ZIO_DATA_IV_LEN];
253 uint8_t drr_mac[ZIO_DATA_MAC_LEN];
254 /* content follows */
262 struct drr_write_byref {
263 /* where to put the data */
268 /* where to find the prior copy of the data */
269 uint64_t drr_refguid;
270 uint64_t drr_refobject;
271 uint64_t drr_refoffset;
272 /* properties of the data */
273 uint8_t drr_checksumtype;
276 ddt_key_t drr_key; /* deduplication key */
283 uint8_t drr_compressiontype;
285 /* only nonzero for raw streams */
286 uint64_t drr_compressed_size;
287 uint8_t drr_salt[ZIO_DATA_SALT_LEN];
288 uint8_t drr_iv[ZIO_DATA_IV_LEN];
289 uint8_t drr_mac[ZIO_DATA_MAC_LEN];
290 dmu_object_type_t drr_type;
291 /* spill data follows */
293 struct drr_write_embedded {
296 /* logical length, should equal blocksize */
299 uint8_t drr_compression;
302 uint32_t drr_lsize; /* uncompressed size of payload */
303 uint32_t drr_psize; /* compr. (real) size of payload */
304 /* (possibly compressed) content follows */
305 } drr_write_embedded;
306 struct drr_object_range {
307 uint64_t drr_firstobj;
308 uint64_t drr_numslots;
310 uint8_t drr_salt[ZIO_DATA_SALT_LEN];
311 uint8_t drr_iv[ZIO_DATA_IV_LEN];
312 uint8_t drr_mac[ZIO_DATA_MAC_LEN];
318 * Nore: drr_checksum is overlaid with all record types
319 * except DRR_BEGIN. Therefore its (non-pad) members
320 * must not overlap with members from the other structs.
321 * We accomplish this by putting its members at the very
324 struct drr_checksum {
325 uint64_t drr_pad[34];
327 * fletcher-4 checksum of everything preceding the
330 zio_cksum_t drr_checksum;
333 } dmu_replay_record_t;
335 /* diff record range types */
336 typedef enum diff_type {
343 * The diff reports back ranges of free or in-use objects.
345 typedef struct dmu_diff_record {
351 typedef struct zinject_record {
361 uint32_t zi_failfast;
362 char zi_func[MAXNAMELEN];
371 #define ZINJECT_NULL 0x1
372 #define ZINJECT_FLUSH_ARC 0x2
373 #define ZINJECT_UNLOAD_SPA 0x4
375 #define ZEVENT_NONE 0x0
376 #define ZEVENT_NONBLOCK 0x1
377 #define ZEVENT_SIZE 1024
379 #define ZEVENT_SEEK_START 0
380 #define ZEVENT_SEEK_END UINT64_MAX
382 /* scaled frequency ranges */
383 #define ZI_PERCENTAGE_MIN 4294UL
384 #define ZI_PERCENTAGE_MAX UINT32_MAX
386 typedef enum zinject_type {
387 ZINJECT_UNINITIALIZED,
389 ZINJECT_DEVICE_FAULT,
391 ZINJECT_IGNORED_WRITES,
394 ZINJECT_DECRYPT_FAULT,
397 typedef struct zfs_share {
398 uint64_t z_exportdata;
399 uint64_t z_sharedata;
400 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
401 uint64_t z_sharemax; /* max length of share string */
405 * ZFS file systems may behave the usual, POSIX-compliant way, where
406 * name lookups are case-sensitive. They may also be set up so that
407 * all the name lookups are case-insensitive, or so that only some
408 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
410 typedef enum zfs_case {
412 ZFS_CASE_INSENSITIVE,
417 * Note: this struct must have the same layout in 32-bit and 64-bit, so
418 * that 32-bit processes (like /sbin/zfs) can pass it to the 64-bit
419 * kernel. Therefore, we add padding to it so that no "hidden" padding
420 * is automatically added on 64-bit (but not on 32-bit).
422 typedef struct zfs_cmd {
423 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
424 uint64_t zc_nvlist_src; /* really (char *) */
425 uint64_t zc_nvlist_src_size;
426 uint64_t zc_nvlist_dst; /* really (char *) */
427 uint64_t zc_nvlist_dst_size;
428 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
432 * The following members are for legacy ioctls which haven't been
433 * converted to the new method.
435 uint64_t zc_history; /* really (char *) */
436 char zc_value[MAXPATHLEN * 2];
437 char zc_string[MAXNAMELEN];
439 uint64_t zc_nvlist_conf; /* really (char *) */
440 uint64_t zc_nvlist_conf_size;
442 uint64_t zc_objset_type;
443 uint64_t zc_perm_action;
444 uint64_t zc_history_len;
445 uint64_t zc_history_offset;
447 uint64_t zc_iflags; /* internal to zfs(7fs) */
448 zfs_share_t zc_share;
449 dmu_objset_stats_t zc_objset_stats;
450 struct drr_begin zc_begin_record;
451 zinject_record_t zc_inject_record;
452 uint32_t zc_defer_destroy;
454 uint64_t zc_action_handle;
457 uint8_t zc_pad[3]; /* alignment */
460 uint64_t zc_createtxg;
464 typedef struct zfs_useracct {
471 #define ZFSDEV_MAX_MINOR (1 << 16)
472 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
474 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
480 typedef struct zfs_creat {
481 nvlist_t *zct_zplprops;
485 extern int zfs_secpolicy_snapshot_perms(const char *, cred_t *);
486 extern int zfs_secpolicy_rename_perms(const char *, const char *, cred_t *);
487 extern int zfs_secpolicy_destroy_perms(const char *, cred_t *);
488 extern void zfs_unmount_snap(const char *);
489 extern void zfs_destroy_unmount_origin(const char *);
490 extern boolean_t dataset_name_hidden(const char *);
491 extern int getzfsvfs_impl(struct objset *, struct zfsvfs **);
492 extern int getzfsvfs(const char *, struct zfsvfs **);
494 enum zfsdev_state_type {
501 * The zfsdev_state_t structure is managed as a singly-linked list
502 * from which items are never deleted. This allows for lock-free
503 * reading of the list so long as assignments to the zs_next and
504 * reads from zs_minor are performed atomically. Empty items are
505 * indicated by storing -1 into zs_minor.
507 typedef struct zfsdev_state {
508 struct zfsdev_state *zs_next; /* next zfsdev_state_t link */
509 struct file *zs_file; /* associated file struct */
510 minor_t zs_minor; /* made up minor number */
511 void *zs_onexit; /* onexit data */
512 void *zs_zevent; /* zevent data */
515 extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
516 extern int zfsdev_getminor(struct file *filp, minor_t *minorp);
517 extern minor_t zfsdev_minor_alloc(void);
525 #endif /* _SYS_ZFS_IOCTL_H */