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) 2013 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 * Property values for snapdev
62 #define ZFS_SNAPDEV_HIDDEN 0
63 #define ZFS_SNAPDEV_VISIBLE 1
65 * Property values for acltype
67 #define ZFS_ACLTYPE_OFF 0
68 #define ZFS_ACLTYPE_POSIXACL 1
71 * Field manipulation macros for the drr_versioninfo field of the
76 * Header types for zfs send streams.
78 typedef enum drr_headertype {
80 DMU_COMPOUNDSTREAM = 0x2
83 #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2)
84 #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x)
86 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
87 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
90 * Feature flags for zfs send streams (flags in drr_versioninfo)
93 #define DMU_BACKUP_FEATURE_DEDUP (1<<0)
94 #define DMU_BACKUP_FEATURE_DEDUPPROPS (1<<1)
95 #define DMU_BACKUP_FEATURE_SA_SPILL (1<<2)
96 /* flags #3 - #15 are reserved for incompatible closed-source implementations */
97 #define DMU_BACKUP_FEATURE_EMBED_DATA (1<<16)
98 #define DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 (1<<17)
99 /* flag #18 is reserved for a Delphix feature */
100 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1<<19)
103 * Mask of all supported backup features
105 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
106 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
107 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 | \
108 DMU_BACKUP_FEATURE_LARGE_BLOCKS)
110 /* Are all features in the given flag word currently supported? */
111 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
114 * The drr_versioninfo field of the dmu_replay_record has the
117 * 64 56 48 40 32 24 16 8 0
118 * +-------+-------+-------+-------+-------+-------+-------+-------+
119 * | reserved | feature-flags |C|S|
120 * +-------+-------+-------+-------+-------+-------+-------+-------+
122 * The low order two bits indicate the header type: SUBSTREAM (0x1)
123 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
124 * this field used to be a version number, where the two version types
125 * were 1 and 2. Using two bits for this allows earlier versions of
126 * the code to be able to recognize send streams that don't use any
127 * of the features indicated by feature flags.
130 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
132 #define DRR_FLAG_CLONE (1<<0)
133 #define DRR_FLAG_CI_DATA (1<<1)
136 * flags in the drr_checksumflags field in the DRR_WRITE and
137 * DRR_WRITE_BYREF blocks
139 #define DRR_CHECKSUM_DEDUP (1<<0)
141 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
144 * zfs ioctl command structure
146 typedef struct dmu_replay_record {
148 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
149 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
150 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
152 uint32_t drr_payloadlen;
156 uint64_t drr_versioninfo; /* was drr_version */
157 uint64_t drr_creation_time;
158 dmu_objset_type_t drr_type;
161 uint64_t drr_fromguid;
162 char drr_toname[MAXNAMELEN];
165 zio_cksum_t drr_checksum;
170 dmu_object_type_t drr_type;
171 dmu_object_type_t drr_bonustype;
173 uint32_t drr_bonuslen;
174 uint8_t drr_checksumtype;
175 uint8_t drr_compress;
178 /* bonus content follows */
180 struct drr_freeobjects {
181 uint64_t drr_firstobj;
182 uint64_t drr_numobjs;
187 dmu_object_type_t drr_type;
192 uint8_t drr_checksumtype;
193 uint8_t drr_checksumflags;
195 ddt_key_t drr_key; /* deduplication key */
196 /* content follows */
204 struct drr_write_byref {
205 /* where to put the data */
210 /* where to find the prior copy of the data */
211 uint64_t drr_refguid;
212 uint64_t drr_refobject;
213 uint64_t drr_refoffset;
214 /* properties of the data */
215 uint8_t drr_checksumtype;
216 uint8_t drr_checksumflags;
218 ddt_key_t drr_key; /* deduplication key */
224 uint64_t drr_pad[4]; /* needed for crypto */
225 /* spill data follows */
227 struct drr_write_embedded {
230 /* logical length, should equal blocksize */
233 uint8_t drr_compression;
236 uint32_t drr_lsize; /* uncompressed size of payload */
237 uint32_t drr_psize; /* compr. (real) size of payload */
238 /* (possibly compressed) content follows */
239 } drr_write_embedded;
241 } dmu_replay_record_t;
243 /* diff record range types */
244 typedef enum diff_type {
251 * The diff reports back ranges of free or in-use objects.
253 typedef struct dmu_diff_record {
259 typedef struct zinject_record {
269 uint32_t zi_failfast;
270 char zi_func[MAXNAMELEN];
278 #define ZINJECT_NULL 0x1
279 #define ZINJECT_FLUSH_ARC 0x2
280 #define ZINJECT_UNLOAD_SPA 0x4
282 #define ZEVENT_NONE 0x0
283 #define ZEVENT_NONBLOCK 0x1
284 #define ZEVENT_SIZE 1024
286 #define ZEVENT_SEEK_START 0
287 #define ZEVENT_SEEK_END UINT64_MAX
289 typedef enum zinject_type {
290 ZINJECT_UNINITIALIZED,
292 ZINJECT_DEVICE_FAULT,
294 ZINJECT_IGNORED_WRITES,
299 typedef struct zfs_share {
300 uint64_t z_exportdata;
301 uint64_t z_sharedata;
302 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
303 uint64_t z_sharemax; /* max length of share string */
307 * ZFS file systems may behave the usual, POSIX-compliant way, where
308 * name lookups are case-sensitive. They may also be set up so that
309 * all the name lookups are case-insensitive, or so that only some
310 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
312 typedef enum zfs_case {
314 ZFS_CASE_INSENSITIVE,
318 typedef struct zfs_cmd {
319 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
320 uint64_t zc_nvlist_src; /* really (char *) */
321 uint64_t zc_nvlist_src_size;
322 uint64_t zc_nvlist_dst; /* really (char *) */
323 uint64_t zc_nvlist_dst_size;
324 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
328 * The following members are for legacy ioctls which haven't been
329 * converted to the new method.
331 uint64_t zc_history; /* really (char *) */
332 char zc_value[MAXPATHLEN * 2];
333 char zc_string[MAXNAMELEN];
335 uint64_t zc_nvlist_conf; /* really (char *) */
336 uint64_t zc_nvlist_conf_size;
338 uint64_t zc_objset_type;
339 uint64_t zc_perm_action;
340 uint64_t zc_history_len;
341 uint64_t zc_history_offset;
343 uint64_t zc_iflags; /* internal to zfs(7fs) */
344 zfs_share_t zc_share;
345 dmu_objset_stats_t zc_objset_stats;
346 struct drr_begin zc_begin_record;
347 zinject_record_t zc_inject_record;
348 uint32_t zc_defer_destroy;
350 uint64_t zc_action_handle;
353 uint8_t zc_pad[3]; /* alignment */
356 uint64_t zc_createtxg;
360 typedef struct zfs_useracct {
367 #define ZFSDEV_MAX_MINOR (1 << 16)
368 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
370 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
374 typedef struct zfs_creat {
375 nvlist_t *zct_zplprops;
379 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
380 extern int zfs_secpolicy_rename_perms(const char *from,
381 const char *to, cred_t *cr);
382 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
383 extern int zfs_unmount_snap(const char *);
384 extern void zfs_destroy_unmount_origin(const char *);
386 extern boolean_t dataset_name_hidden(const char *name);
388 enum zfsdev_state_type {
395 * The zfsdev_state_t structure is managed as a singly-linked list
396 * from which items are never deleted. This allows for lock-free
397 * reading of the list so long as assignments to the zs_next and
398 * reads from zs_minor are performed atomically. Empty items are
399 * indicated by storing -1 into zs_minor.
401 typedef struct zfsdev_state {
402 struct zfsdev_state *zs_next; /* next zfsdev_state_t link */
403 struct file *zs_file; /* associated file struct */
404 minor_t zs_minor; /* made up minor number */
405 void *zs_onexit; /* onexit data */
406 void *zs_zevent; /* zevent data */
409 extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
410 extern minor_t zfsdev_getminor(struct file *filp);
411 extern minor_t zfsdev_minor_alloc(void);
419 #endif /* _SYS_ZFS_IOCTL_H */