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, 2014 by Delphix. All rights reserved.
26 #ifndef _SYS_ZFS_IOCTL_H
27 #define _SYS_ZFS_IOCTL_H
32 #include <sys/dsl_deleg.h>
34 #include <sys/zfs_stat.h>
37 #include <sys/nvpair.h>
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).
54 * Property values for snapdir
56 #define ZFS_SNAPDIR_HIDDEN 0
57 #define ZFS_SNAPDIR_VISIBLE 1
60 * Field manipulation macros for the drr_versioninfo field of the
65 * Header types for zfs send streams.
67 typedef enum drr_headertype {
69 DMU_COMPOUNDSTREAM = 0x2
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)
75 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
76 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
79 * Feature flags for zfs send streams (flags in drr_versioninfo)
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 /* flag #18 is reserved for a Delphix feature */
89 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1 << 19)
90 #define DMU_BACKUP_FEATURE_RESUMING (1 << 20)
93 * Mask of all supported backup features
95 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
96 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
97 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 | \
98 DMU_BACKUP_FEATURE_RESUMING | \
99 DMU_BACKUP_FEATURE_LARGE_BLOCKS)
101 /* Are all features in the given flag word currently supported? */
102 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
104 typedef enum dmu_send_resume_token_version {
105 ZFS_SEND_RESUME_TOKEN_VERSION = 1
106 } dmu_send_resume_token_version_t;
109 * The drr_versioninfo field of the dmu_replay_record has the
112 * 64 56 48 40 32 24 16 8 0
113 * +-------+-------+-------+-------+-------+-------+-------+-------+
114 * | reserved | feature-flags |C|S|
115 * +-------+-------+-------+-------+-------+-------+-------+-------+
117 * The low order two bits indicate the header type: SUBSTREAM (0x1)
118 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
119 * this field used to be a version number, where the two version types
120 * were 1 and 2. Using two bits for this allows earlier versions of
121 * the code to be able to recognize send streams that don't use any
122 * of the features indicated by feature flags.
125 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
127 #define DRR_FLAG_CLONE (1<<0)
128 #define DRR_FLAG_CI_DATA (1<<1)
131 * flags in the drr_checksumflags field in the DRR_WRITE and
132 * DRR_WRITE_BYREF blocks
134 #define DRR_CHECKSUM_DEDUP (1<<0)
136 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
139 * zfs ioctl command structure
143 uint64_t drr_versioninfo; /* was drr_version */
144 uint64_t drr_creation_time;
145 dmu_objset_type_t drr_type;
148 uint64_t drr_fromguid;
149 char drr_toname[MAXNAMELEN];
153 zio_cksum_t drr_checksum;
159 dmu_object_type_t drr_type;
160 dmu_object_type_t drr_bonustype;
162 uint32_t drr_bonuslen;
163 uint8_t drr_checksumtype;
164 uint8_t drr_compress;
167 /* bonus content follows */
170 struct drr_freeobjects {
171 uint64_t drr_firstobj;
172 uint64_t drr_numobjs;
178 dmu_object_type_t drr_type;
183 uint8_t drr_checksumtype;
184 uint8_t drr_checksumflags;
186 ddt_key_t drr_key; /* deduplication key */
187 /* content follows */
197 struct drr_write_byref {
198 /* where to put the data */
203 /* where to find the prior copy of the data */
204 uint64_t drr_refguid;
205 uint64_t drr_refobject;
206 uint64_t drr_refoffset;
207 /* properties of the data */
208 uint8_t drr_checksumtype;
209 uint8_t drr_checksumflags;
211 ddt_key_t drr_key; /* deduplication key */
218 uint64_t drr_pad[4]; /* needed for crypto */
219 /* spill data follows */
222 typedef struct dmu_replay_record {
224 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
225 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
226 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
228 uint32_t drr_payloadlen;
230 struct drr_begin drr_begin;
231 struct drr_end drr_end;
232 struct drr_object drr_object;
233 struct drr_freeobjects drr_freeobjects;
234 struct drr_write drr_write;
235 struct drr_free drr_free;
236 struct drr_write_byref drr_write_byref;
237 struct drr_spill drr_spill;
238 struct drr_write_embedded {
241 /* logical length, should equal blocksize */
244 uint8_t drr_compression;
247 uint32_t drr_lsize; /* uncompressed size of payload */
248 uint32_t drr_psize; /* compr. (real) size of payload */
249 /* (possibly compressed) content follows */
250 } drr_write_embedded;
253 * Nore: drr_checksum is overlaid with all record types
254 * except DRR_BEGIN. Therefore its (non-pad) members
255 * must not overlap with members from the other structs.
256 * We accomplish this by putting its members at the very
259 struct drr_checksum {
260 uint64_t drr_pad[34];
262 * fletcher-4 checksum of everything preceding the
265 zio_cksum_t drr_checksum;
268 } dmu_replay_record_t;
270 /* diff record range types */
271 typedef enum diff_type {
278 * The diff reports back ranges of free or in-use objects.
280 typedef struct dmu_diff_record {
286 typedef struct zinject_record {
296 uint32_t zi_failfast;
297 char zi_func[MAXNAMELEN];
305 #define ZINJECT_NULL 0x1
306 #define ZINJECT_FLUSH_ARC 0x2
307 #define ZINJECT_UNLOAD_SPA 0x4
309 typedef enum zinject_type {
310 ZINJECT_UNINITIALIZED,
312 ZINJECT_DEVICE_FAULT,
314 ZINJECT_IGNORED_WRITES,
319 typedef struct zfs_share {
320 uint64_t z_exportdata;
321 uint64_t z_sharedata;
322 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
323 uint64_t z_sharemax; /* max length of share string */
327 * ZFS file systems may behave the usual, POSIX-compliant way, where
328 * name lookups are case-sensitive. They may also be set up so that
329 * all the name lookups are case-insensitive, or so that only some
330 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
332 typedef enum zfs_case {
334 ZFS_CASE_INSENSITIVE,
338 typedef struct zfs_cmd {
339 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
340 uint64_t zc_nvlist_src; /* really (char *) */
341 uint64_t zc_nvlist_src_size;
342 uint64_t zc_nvlist_dst; /* really (char *) */
343 uint64_t zc_nvlist_dst_size;
344 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
348 * The following members are for legacy ioctls which haven't been
349 * converted to the new method.
351 uint64_t zc_history; /* really (char *) */
352 char zc_value[MAXPATHLEN * 2];
353 char zc_string[MAXNAMELEN];
355 uint64_t zc_nvlist_conf; /* really (char *) */
356 uint64_t zc_nvlist_conf_size;
358 uint64_t zc_objset_type;
359 uint64_t zc_perm_action;
360 uint64_t zc_history_len;
361 uint64_t zc_history_offset;
363 uint64_t zc_iflags; /* internal to zfs(7fs) */
364 zfs_share_t zc_share;
366 dmu_objset_stats_t zc_objset_stats;
367 dmu_replay_record_t zc_begin_record;
368 zinject_record_t zc_inject_record;
369 uint32_t zc_defer_destroy;
371 uint64_t zc_action_handle;
374 boolean_t zc_resumable;
377 uint64_t zc_createtxg;
381 typedef struct zfs_useracct {
388 #define ZFSDEV_MAX_MINOR (1 << 16)
389 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
391 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
395 typedef struct zfs_creat {
396 nvlist_t *zct_zplprops;
400 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
401 extern int zfs_secpolicy_rename_perms(const char *from,
402 const char *to, cred_t *cr);
403 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
404 extern int zfs_busy(void);
405 extern int zfs_unmount_snap(const char *);
406 extern void zfs_destroy_unmount_origin(const char *);
409 * ZFS minor numbers can refer to either a control device instance or
410 * a zvol. Depending on the value of zss_type, zss_data points to either
411 * a zvol_state_t or a zfs_onexit_t.
413 enum zfs_soft_state_type {
418 typedef struct zfs_soft_state {
419 enum zfs_soft_state_type zss_type;
423 extern void *zfsdev_get_soft_state(minor_t minor,
424 enum zfs_soft_state_type which);
425 extern minor_t zfsdev_minor_alloc(void);
427 extern void *zfsdev_state;
435 #endif /* _SYS_ZFS_IOCTL_H */