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_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)
96 * Mask of all supported backup features
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)
104 /* Are all features in the given flag word currently supported? */
105 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
107 typedef enum dmu_send_resume_token_version {
108 ZFS_SEND_RESUME_TOKEN_VERSION = 1
109 } dmu_send_resume_token_version_t;
112 * The drr_versioninfo field of the dmu_replay_record has the
115 * 64 56 48 40 32 24 16 8 0
116 * +-------+-------+-------+-------+-------+-------+-------+-------+
117 * | reserved | feature-flags |C|S|
118 * +-------+-------+-------+-------+-------+-------+-------+-------+
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.
128 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
131 * Send stream flags. Bits 24-31 are reserved for vendor-specific
132 * implementations and should not be used.
134 #define DRR_FLAG_CLONE (1<<0)
135 #define DRR_FLAG_CI_DATA (1<<1)
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.
145 #define DRR_FLAG_FREERECORDS (1<<2)
148 * flags in the drr_checksumflags field in the DRR_WRITE and
149 * DRR_WRITE_BYREF blocks
151 #define DRR_CHECKSUM_DEDUP (1<<0)
153 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
156 * zfs ioctl command structure
160 uint64_t drr_versioninfo; /* was drr_version */
161 uint64_t drr_creation_time;
162 dmu_objset_type_t drr_type;
165 uint64_t drr_fromguid;
166 char drr_toname[MAXNAMELEN];
170 zio_cksum_t drr_checksum;
176 dmu_object_type_t drr_type;
177 dmu_object_type_t drr_bonustype;
179 uint32_t drr_bonuslen;
180 uint8_t drr_checksumtype;
181 uint8_t drr_compress;
184 /* bonus content follows */
187 struct drr_freeobjects {
188 uint64_t drr_firstobj;
189 uint64_t drr_numobjs;
195 dmu_object_type_t drr_type;
200 uint8_t drr_checksumtype;
201 uint8_t drr_checksumflags;
203 ddt_key_t drr_key; /* deduplication key */
204 /* content follows */
214 struct drr_write_byref {
215 /* where to put the data */
220 /* where to find the prior copy of the data */
221 uint64_t drr_refguid;
222 uint64_t drr_refobject;
223 uint64_t drr_refoffset;
224 /* properties of the data */
225 uint8_t drr_checksumtype;
226 uint8_t drr_checksumflags;
228 ddt_key_t drr_key; /* deduplication key */
235 uint64_t drr_pad[4]; /* needed for crypto */
236 /* spill data follows */
239 typedef struct dmu_replay_record {
241 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
242 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
243 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
245 uint32_t drr_payloadlen;
247 struct drr_begin drr_begin;
248 struct drr_end drr_end;
249 struct drr_object drr_object;
250 struct drr_freeobjects drr_freeobjects;
251 struct drr_write drr_write;
252 struct drr_free drr_free;
253 struct drr_write_byref drr_write_byref;
254 struct drr_spill drr_spill;
255 struct drr_write_embedded {
258 /* logical length, should equal blocksize */
261 uint8_t drr_compression;
264 uint32_t drr_lsize; /* uncompressed size of payload */
265 uint32_t drr_psize; /* compr. (real) size of payload */
266 /* (possibly compressed) content follows */
267 } drr_write_embedded;
270 * Nore: drr_checksum is overlaid with all record types
271 * except DRR_BEGIN. Therefore its (non-pad) members
272 * must not overlap with members from the other structs.
273 * We accomplish this by putting its members at the very
276 struct drr_checksum {
277 uint64_t drr_pad[34];
279 * fletcher-4 checksum of everything preceding the
282 zio_cksum_t drr_checksum;
285 } dmu_replay_record_t;
287 /* diff record range types */
288 typedef enum diff_type {
295 * The diff reports back ranges of free or in-use objects.
297 typedef struct dmu_diff_record {
303 typedef struct zinject_record {
313 uint32_t zi_failfast;
314 char zi_func[MAXNAMELEN];
323 #define ZINJECT_NULL 0x1
324 #define ZINJECT_FLUSH_ARC 0x2
325 #define ZINJECT_UNLOAD_SPA 0x4
327 typedef enum zinject_type {
328 ZINJECT_UNINITIALIZED,
330 ZINJECT_DEVICE_FAULT,
332 ZINJECT_IGNORED_WRITES,
337 typedef struct zfs_share {
338 uint64_t z_exportdata;
339 uint64_t z_sharedata;
340 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
341 uint64_t z_sharemax; /* max length of share string */
345 * ZFS file systems may behave the usual, POSIX-compliant way, where
346 * name lookups are case-sensitive. They may also be set up so that
347 * all the name lookups are case-insensitive, or so that only some
348 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
350 typedef enum zfs_case {
352 ZFS_CASE_INSENSITIVE,
357 * Note: this struct must have the same layout in 32-bit and 64-bit, so
358 * that 32-bit processes (like /sbin/zfs) can pass it to the 64-bit
359 * kernel. Therefore, we add padding to it so that no "hidden" padding
360 * is automatically added on 64-bit (but not on 32-bit).
362 typedef struct zfs_cmd {
363 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
364 uint64_t zc_nvlist_src; /* really (char *) */
365 uint64_t zc_nvlist_src_size;
366 uint64_t zc_nvlist_dst; /* really (char *) */
367 uint64_t zc_nvlist_dst_size;
368 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
372 * The following members are for legacy ioctls which haven't been
373 * converted to the new method.
375 uint64_t zc_history; /* really (char *) */
376 char zc_value[MAXPATHLEN * 2];
377 char zc_string[MAXNAMELEN];
379 uint64_t zc_nvlist_conf; /* really (char *) */
380 uint64_t zc_nvlist_conf_size;
382 uint64_t zc_objset_type;
383 uint64_t zc_perm_action;
384 uint64_t zc_history_len;
385 uint64_t zc_history_offset;
387 uint64_t zc_iflags; /* internal to zfs(7fs) */
388 zfs_share_t zc_share;
390 dmu_objset_stats_t zc_objset_stats;
391 dmu_replay_record_t zc_begin_record;
392 zinject_record_t zc_inject_record;
393 uint32_t zc_defer_destroy;
395 uint64_t zc_action_handle;
399 boolean_t zc_resumable;
403 uint64_t zc_createtxg;
407 typedef struct zfs_useracct {
414 #define ZFSDEV_MAX_MINOR (1 << 16)
415 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
417 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
421 typedef struct zfs_creat {
422 nvlist_t *zct_zplprops;
426 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
427 extern int zfs_secpolicy_rename_perms(const char *from,
428 const char *to, cred_t *cr);
429 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
430 extern int zfs_busy(void);
431 extern int zfs_unmount_snap(const char *);
432 extern void zfs_destroy_unmount_origin(const char *);
435 * ZFS minor numbers can refer to either a control device instance or
436 * a zvol. Depending on the value of zss_type, zss_data points to either
437 * a zvol_state_t or a zfs_onexit_t.
439 enum zfs_soft_state_type {
444 typedef struct zfs_soft_state {
445 enum zfs_soft_state_type zss_type;
449 extern void *zfsdev_get_soft_state(minor_t minor,
450 enum zfs_soft_state_type which);
451 extern minor_t zfsdev_minor_alloc(void);
453 extern void *zfsdev_state;
461 #endif /* _SYS_ZFS_IOCTL_H */