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) 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]
29 #ifndef _SYS_ZFS_IOCTL_H
30 #define _SYS_ZFS_IOCTL_H
35 #include <sys/dsl_deleg.h>
37 #include <sys/zfs_stat.h>
40 #include <sys/nvpair.h>
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).
57 * Property values for snapdir
59 #define ZFS_SNAPDIR_HIDDEN 0
60 #define ZFS_SNAPDIR_VISIBLE 1
63 * Field manipulation macros for the drr_versioninfo field of the
68 * Header types for zfs send streams.
70 typedef enum drr_headertype {
72 DMU_COMPOUNDSTREAM = 0x2
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)
78 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
79 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
82 * Feature flags for zfs send streams (flags in drr_versioninfo)
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_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 /* flag #21 is reserved for a Delphix feature */
95 #define DMU_BACKUP_FEATURE_COMPRESSED (1 << 22)
96 /* flag #23 is reserved for the large dnode feature */
99 * Mask of all supported backup features
101 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
102 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
103 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_LZ4 | \
104 DMU_BACKUP_FEATURE_RESUMING | \
105 DMU_BACKUP_FEATURE_LARGE_BLOCKS | \
106 DMU_BACKUP_FEATURE_COMPRESSED)
108 /* Are all features in the given flag word currently supported? */
109 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
111 typedef enum dmu_send_resume_token_version {
112 ZFS_SEND_RESUME_TOKEN_VERSION = 1
113 } dmu_send_resume_token_version_t;
116 * The drr_versioninfo field of the dmu_replay_record has the
119 * 64 56 48 40 32 24 16 8 0
120 * +-------+-------+-------+-------+-------+-------+-------+-------+
121 * | reserved | feature-flags |C|S|
122 * +-------+-------+-------+-------+-------+-------+-------+-------+
124 * The low order two bits indicate the header type: SUBSTREAM (0x1)
125 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
126 * this field used to be a version number, where the two version types
127 * were 1 and 2. Using two bits for this allows earlier versions of
128 * the code to be able to recognize send streams that don't use any
129 * of the features indicated by feature flags.
132 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
135 * Send stream flags. Bits 24-31 are reserved for vendor-specific
136 * implementations and should not be used.
138 #define DRR_FLAG_CLONE (1<<0)
139 #define DRR_FLAG_CI_DATA (1<<1)
141 * This send stream, if it is a full send, includes the FREE and FREEOBJECT
142 * records that are created by the sending process. This means that the send
143 * stream can be received as a clone, even though it is not an incremental.
144 * This is not implemented as a feature flag, because the receiving side does
145 * not need to have implemented it to receive this stream; it is fully backwards
146 * compatible. We need a flag, though, because full send streams without it
147 * cannot necessarily be received as a clone correctly.
149 #define DRR_FLAG_FREERECORDS (1<<2)
152 * flags in the drr_checksumflags field in the DRR_WRITE and
153 * DRR_WRITE_BYREF blocks
155 #define DRR_CHECKSUM_DEDUP (1<<0)
157 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
159 /* deal with compressed drr_write replay records */
160 #define DRR_WRITE_COMPRESSED(drrw) ((drrw)->drr_compressiontype != 0)
161 #define DRR_WRITE_PAYLOAD_SIZE(drrw) \
162 (DRR_WRITE_COMPRESSED(drrw) ? (drrw)->drr_compressed_size : \
163 (drrw)->drr_logical_size)
165 typedef struct dmu_replay_record {
167 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
168 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
169 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
171 uint32_t drr_payloadlen;
175 uint64_t drr_versioninfo; /* was drr_version */
176 uint64_t drr_creation_time;
177 dmu_objset_type_t drr_type;
180 uint64_t drr_fromguid;
181 char drr_toname[MAXNAMELEN];
184 zio_cksum_t drr_checksum;
189 dmu_object_type_t drr_type;
190 dmu_object_type_t drr_bonustype;
192 uint32_t drr_bonuslen;
193 uint8_t drr_checksumtype;
194 uint8_t drr_compress;
197 /* bonus content follows */
199 struct drr_freeobjects {
200 uint64_t drr_firstobj;
201 uint64_t drr_numobjs;
206 dmu_object_type_t drr_type;
209 uint64_t drr_logical_size;
211 uint8_t drr_checksumtype;
212 uint8_t drr_checksumflags;
213 uint8_t drr_compressiontype;
215 /* deduplication key */
217 /* only nonzero if drr_compressiontype is not 0 */
218 uint64_t drr_compressed_size;
219 /* content follows */
227 struct drr_write_byref {
228 /* where to put the data */
233 /* where to find the prior copy of the data */
234 uint64_t drr_refguid;
235 uint64_t drr_refobject;
236 uint64_t drr_refoffset;
237 /* properties of the data */
238 uint8_t drr_checksumtype;
239 uint8_t drr_checksumflags;
241 ddt_key_t drr_key; /* deduplication key */
247 uint64_t drr_pad[4]; /* needed for crypto */
248 /* spill data follows */
250 struct drr_write_embedded {
253 /* logical length, should equal blocksize */
256 uint8_t drr_compression;
259 uint32_t drr_lsize; /* uncompressed size of payload */
260 uint32_t drr_psize; /* compr. (real) size of payload */
261 /* (possibly compressed) content follows */
262 } drr_write_embedded;
265 * Nore: drr_checksum is overlaid with all record types
266 * except DRR_BEGIN. Therefore its (non-pad) members
267 * must not overlap with members from the other structs.
268 * We accomplish this by putting its members at the very
271 struct drr_checksum {
272 uint64_t drr_pad[34];
274 * fletcher-4 checksum of everything preceding the
277 zio_cksum_t drr_checksum;
280 } dmu_replay_record_t;
282 /* diff record range types */
283 typedef enum diff_type {
290 * The diff reports back ranges of free or in-use objects.
292 typedef struct dmu_diff_record {
298 typedef struct zinject_record {
308 uint32_t zi_failfast;
309 char zi_func[MAXNAMELEN];
318 #define ZINJECT_NULL 0x1
319 #define ZINJECT_FLUSH_ARC 0x2
320 #define ZINJECT_UNLOAD_SPA 0x4
322 typedef enum zinject_type {
323 ZINJECT_UNINITIALIZED,
325 ZINJECT_DEVICE_FAULT,
327 ZINJECT_IGNORED_WRITES,
332 typedef struct zfs_share {
333 uint64_t z_exportdata;
334 uint64_t z_sharedata;
335 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
336 uint64_t z_sharemax; /* max length of share string */
340 * ZFS file systems may behave the usual, POSIX-compliant way, where
341 * name lookups are case-sensitive. They may also be set up so that
342 * all the name lookups are case-insensitive, or so that only some
343 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
345 typedef enum zfs_case {
347 ZFS_CASE_INSENSITIVE,
352 * Note: this struct must have the same layout in 32-bit and 64-bit, so
353 * that 32-bit processes (like /sbin/zfs) can pass it to the 64-bit
354 * kernel. Therefore, we add padding to it so that no "hidden" padding
355 * is automatically added on 64-bit (but not on 32-bit).
357 typedef struct zfs_cmd {
358 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
359 uint64_t zc_nvlist_src; /* really (char *) */
360 uint64_t zc_nvlist_src_size;
361 uint64_t zc_nvlist_dst; /* really (char *) */
362 uint64_t zc_nvlist_dst_size;
363 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
367 * The following members are for legacy ioctls which haven't been
368 * converted to the new method.
370 uint64_t zc_history; /* really (char *) */
371 char zc_value[MAXPATHLEN * 2];
372 char zc_string[MAXNAMELEN];
374 uint64_t zc_nvlist_conf; /* really (char *) */
375 uint64_t zc_nvlist_conf_size;
377 uint64_t zc_objset_type;
378 uint64_t zc_perm_action;
379 uint64_t zc_history_len;
380 uint64_t zc_history_offset;
382 uint64_t zc_iflags; /* internal to zfs(7fs) */
383 zfs_share_t zc_share;
385 dmu_objset_stats_t zc_objset_stats;
386 dmu_replay_record_t zc_begin_record;
387 zinject_record_t zc_inject_record;
388 uint32_t zc_defer_destroy;
390 uint64_t zc_action_handle;
394 boolean_t zc_resumable;
398 uint64_t zc_createtxg;
402 typedef struct zfs_useracct {
409 #define ZFSDEV_MAX_MINOR (1 << 16)
410 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
412 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
416 typedef struct zfs_creat {
417 nvlist_t *zct_zplprops;
421 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
422 extern int zfs_secpolicy_rename_perms(const char *from,
423 const char *to, cred_t *cr);
424 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
425 extern int zfs_busy(void);
426 extern int zfs_unmount_snap(const char *);
427 extern void zfs_destroy_unmount_origin(const char *);
430 * ZFS minor numbers can refer to either a control device instance or
431 * a zvol. Depending on the value of zss_type, zss_data points to either
432 * a zvol_state_t or a zfs_onexit_t.
434 enum zfs_soft_state_type {
439 typedef struct zfs_soft_state {
440 enum zfs_soft_state_type zss_type;
444 extern void *zfsdev_get_soft_state(minor_t minor,
445 enum zfs_soft_state_type which);
446 extern minor_t zfsdev_minor_alloc(void);
448 extern void *zfsdev_state;
456 #endif /* _SYS_ZFS_IOCTL_H */