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 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 (0x1)
83 #define DMU_BACKUP_FEATURE_DEDUPPROPS (0x2)
84 #define DMU_BACKUP_FEATURE_SA_SPILL (0x4)
87 * Mask of all supported backup features
89 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
90 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL)
92 /* Are all features in the given flag word currently supported? */
93 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
96 * The drr_versioninfo field of the dmu_replay_record has the
99 * 64 56 48 40 32 24 16 8 0
100 * +-------+-------+-------+-------+-------+-------+-------+-------+
101 * | reserved | feature-flags |C|S|
102 * +-------+-------+-------+-------+-------+-------+-------+-------+
104 * The low order two bits indicate the header type: SUBSTREAM (0x1)
105 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
106 * this field used to be a version number, where the two version types
107 * were 1 and 2. Using two bits for this allows earlier versions of
108 * the code to be able to recognize send streams that don't use any
109 * of the features indicated by feature flags.
112 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
114 #define DRR_FLAG_CLONE (1<<0)
115 #define DRR_FLAG_CI_DATA (1<<1)
118 * flags in the drr_checksumflags field in the DRR_WRITE and
119 * DRR_WRITE_BYREF blocks
121 #define DRR_CHECKSUM_DEDUP (1<<0)
123 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
126 * zfs ioctl command structure
130 uint64_t drr_versioninfo; /* was drr_version */
131 uint64_t drr_creation_time;
132 dmu_objset_type_t drr_type;
135 uint64_t drr_fromguid;
136 char drr_toname[MAXNAMELEN];
140 zio_cksum_t drr_checksum;
146 dmu_object_type_t drr_type;
147 dmu_object_type_t drr_bonustype;
149 uint32_t drr_bonuslen;
150 uint8_t drr_checksumtype;
151 uint8_t drr_compress;
154 /* bonus content follows */
157 struct drr_freeobjects {
158 uint64_t drr_firstobj;
159 uint64_t drr_numobjs;
165 dmu_object_type_t drr_type;
170 uint8_t drr_checksumtype;
171 uint8_t drr_checksumflags;
173 ddt_key_t drr_key; /* deduplication key */
174 /* content follows */
184 struct drr_write_byref {
185 /* where to put the data */
190 /* where to find the prior copy of the data */
191 uint64_t drr_refguid;
192 uint64_t drr_refobject;
193 uint64_t drr_refoffset;
194 /* properties of the data */
195 uint8_t drr_checksumtype;
196 uint8_t drr_checksumflags;
198 ddt_key_t drr_key; /* deduplication key */
205 uint64_t drr_pad[4]; /* needed for crypto */
206 /* spill data follows */
209 typedef struct dmu_replay_record {
211 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
212 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
213 DRR_SPILL, DRR_NUMTYPES
215 uint32_t drr_payloadlen;
217 struct drr_begin drr_begin;
218 struct drr_end drr_end;
219 struct drr_object drr_object;
220 struct drr_freeobjects drr_freeobjects;
221 struct drr_write drr_write;
222 struct drr_free drr_free;
223 struct drr_write_byref drr_write_byref;
224 struct drr_spill drr_spill;
226 } dmu_replay_record_t;
228 /* diff record range types */
229 typedef enum diff_type {
236 * The diff reports back ranges of free or in-use objects.
238 typedef struct dmu_diff_record {
244 typedef struct zinject_record {
254 uint32_t zi_failfast;
255 char zi_func[MAXNAMELEN];
263 #define ZINJECT_NULL 0x1
264 #define ZINJECT_FLUSH_ARC 0x2
265 #define ZINJECT_UNLOAD_SPA 0x4
267 typedef enum zinject_type {
268 ZINJECT_UNINITIALIZED,
270 ZINJECT_DEVICE_FAULT,
272 ZINJECT_IGNORED_WRITES,
277 typedef struct zfs_share {
278 uint64_t z_exportdata;
279 uint64_t z_sharedata;
280 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
281 uint64_t z_sharemax; /* max length of share string */
285 * ZFS file systems may behave the usual, POSIX-compliant way, where
286 * name lookups are case-sensitive. They may also be set up so that
287 * all the name lookups are case-insensitive, or so that only some
288 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
290 typedef enum zfs_case {
292 ZFS_CASE_INSENSITIVE,
296 typedef struct zfs_cmd {
297 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
298 uint64_t zc_nvlist_src; /* really (char *) */
299 uint64_t zc_nvlist_src_size;
300 uint64_t zc_nvlist_dst; /* really (char *) */
301 uint64_t zc_nvlist_dst_size;
302 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
306 * The following members are for legacy ioctls which haven't been
307 * converted to the new method.
309 uint64_t zc_history; /* really (char *) */
310 char zc_value[MAXPATHLEN * 2];
311 char zc_string[MAXNAMELEN];
313 uint64_t zc_nvlist_conf; /* really (char *) */
314 uint64_t zc_nvlist_conf_size;
316 uint64_t zc_objset_type;
317 uint64_t zc_perm_action;
318 uint64_t zc_history_len;
319 uint64_t zc_history_offset;
321 uint64_t zc_iflags; /* internal to zfs(7fs) */
322 zfs_share_t zc_share;
324 dmu_objset_stats_t zc_objset_stats;
325 struct drr_begin zc_begin_record;
326 zinject_record_t zc_inject_record;
327 boolean_t zc_defer_destroy;
328 boolean_t zc_temphold;
329 uint64_t zc_action_handle;
332 uint8_t zc_pad[3]; /* alignment */
335 uint64_t zc_createtxg;
339 typedef struct zfs_useracct {
346 #define ZFSDEV_MAX_MINOR (1 << 16)
347 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
349 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
353 typedef struct zfs_creat {
354 nvlist_t *zct_zplprops;
358 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
359 extern int zfs_secpolicy_rename_perms(const char *from,
360 const char *to, cred_t *cr);
361 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
362 extern int zfs_busy(void);
363 extern int zfs_unmount_snap(const char *);
364 extern void zfs_destroy_unmount_origin(const char *);
367 * ZFS minor numbers can refer to either a control device instance or
368 * a zvol. Depending on the value of zss_type, zss_data points to either
369 * a zvol_state_t or a zfs_onexit_t.
371 enum zfs_soft_state_type {
376 typedef struct zfs_soft_state {
377 enum zfs_soft_state_type zss_type;
381 extern void *zfsdev_get_soft_state(minor_t minor,
382 enum zfs_soft_state_type which);
383 extern minor_t zfsdev_minor_alloc(void);
385 extern void *zfsdev_state;
393 #endif /* _SYS_ZFS_IOCTL_H */