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)
101 * Mask of all supported backup features
103 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
104 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
105 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4)
107 /* Are all features in the given flag word currently supported? */
108 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
111 * The drr_versioninfo field of the dmu_replay_record has the
114 * 64 56 48 40 32 24 16 8 0
115 * +-------+-------+-------+-------+-------+-------+-------+-------+
116 * | reserved | feature-flags |C|S|
117 * +-------+-------+-------+-------+-------+-------+-------+-------+
119 * The low order two bits indicate the header type: SUBSTREAM (0x1)
120 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
121 * this field used to be a version number, where the two version types
122 * were 1 and 2. Using two bits for this allows earlier versions of
123 * the code to be able to recognize send streams that don't use any
124 * of the features indicated by feature flags.
127 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
129 #define DRR_FLAG_CLONE (1<<0)
130 #define DRR_FLAG_CI_DATA (1<<1)
133 * flags in the drr_checksumflags field in the DRR_WRITE and
134 * DRR_WRITE_BYREF blocks
136 #define DRR_CHECKSUM_DEDUP (1<<0)
138 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
141 * zfs ioctl command structure
143 typedef struct dmu_replay_record
{
145 DRR_BEGIN
, DRR_OBJECT
, DRR_FREEOBJECTS
,
146 DRR_WRITE
, DRR_FREE
, DRR_END
, DRR_WRITE_BYREF
,
147 DRR_SPILL
, DRR_WRITE_EMBEDDED
, DRR_NUMTYPES
149 uint32_t drr_payloadlen
;
153 uint64_t drr_versioninfo
; /* was drr_version */
154 uint64_t drr_creation_time
;
155 dmu_objset_type_t drr_type
;
158 uint64_t drr_fromguid
;
159 char drr_toname
[MAXNAMELEN
];
162 zio_cksum_t drr_checksum
;
167 dmu_object_type_t drr_type
;
168 dmu_object_type_t drr_bonustype
;
170 uint32_t drr_bonuslen
;
171 uint8_t drr_checksumtype
;
172 uint8_t drr_compress
;
175 /* bonus content follows */
177 struct drr_freeobjects
{
178 uint64_t drr_firstobj
;
179 uint64_t drr_numobjs
;
184 dmu_object_type_t drr_type
;
189 uint8_t drr_checksumtype
;
190 uint8_t drr_checksumflags
;
192 ddt_key_t drr_key
; /* deduplication key */
193 /* content follows */
201 struct drr_write_byref
{
202 /* where to put the data */
207 /* where to find the prior copy of the data */
208 uint64_t drr_refguid
;
209 uint64_t drr_refobject
;
210 uint64_t drr_refoffset
;
211 /* properties of the data */
212 uint8_t drr_checksumtype
;
213 uint8_t drr_checksumflags
;
215 ddt_key_t drr_key
; /* deduplication key */
221 uint64_t drr_pad
[4]; /* needed for crypto */
222 /* spill data follows */
224 struct drr_write_embedded
{
227 /* logical length, should equal blocksize */
230 uint8_t drr_compression
;
233 uint32_t drr_lsize
; /* uncompressed size of payload */
234 uint32_t drr_psize
; /* compr. (real) size of payload */
235 /* (possibly compressed) content follows */
236 } drr_write_embedded
;
238 } dmu_replay_record_t
;
240 /* diff record range types */
241 typedef enum diff_type
{
248 * The diff reports back ranges of free or in-use objects.
250 typedef struct dmu_diff_record
{
256 typedef struct zinject_record
{
266 uint32_t zi_failfast
;
267 char zi_func
[MAXNAMELEN
];
275 #define ZINJECT_NULL 0x1
276 #define ZINJECT_FLUSH_ARC 0x2
277 #define ZINJECT_UNLOAD_SPA 0x4
279 #define ZEVENT_NONE 0x0
280 #define ZEVENT_NONBLOCK 0x1
281 #define ZEVENT_SIZE 1024
283 #define ZEVENT_SEEK_START 0
284 #define ZEVENT_SEEK_END UINT64_MAX
286 typedef enum zinject_type
{
287 ZINJECT_UNINITIALIZED
,
289 ZINJECT_DEVICE_FAULT
,
291 ZINJECT_IGNORED_WRITES
,
296 typedef struct zfs_share
{
297 uint64_t z_exportdata
;
298 uint64_t z_sharedata
;
299 uint64_t z_sharetype
; /* 0 = share, 1 = unshare */
300 uint64_t z_sharemax
; /* max length of share string */
304 * ZFS file systems may behave the usual, POSIX-compliant way, where
305 * name lookups are case-sensitive. They may also be set up so that
306 * all the name lookups are case-insensitive, or so that only some
307 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
309 typedef enum zfs_case
{
311 ZFS_CASE_INSENSITIVE
,
315 typedef struct zfs_cmd
{
316 char zc_name
[MAXPATHLEN
]; /* name of pool or dataset */
317 uint64_t zc_nvlist_src
; /* really (char *) */
318 uint64_t zc_nvlist_src_size
;
319 uint64_t zc_nvlist_dst
; /* really (char *) */
320 uint64_t zc_nvlist_dst_size
;
321 boolean_t zc_nvlist_dst_filled
; /* put an nvlist in dst? */
325 * The following members are for legacy ioctls which haven't been
326 * converted to the new method.
328 uint64_t zc_history
; /* really (char *) */
329 char zc_value
[MAXPATHLEN
* 2];
330 char zc_string
[MAXNAMELEN
];
332 uint64_t zc_nvlist_conf
; /* really (char *) */
333 uint64_t zc_nvlist_conf_size
;
335 uint64_t zc_objset_type
;
336 uint64_t zc_perm_action
;
337 uint64_t zc_history_len
;
338 uint64_t zc_history_offset
;
340 uint64_t zc_iflags
; /* internal to zfs(7fs) */
341 zfs_share_t zc_share
;
342 dmu_objset_stats_t zc_objset_stats
;
343 struct drr_begin zc_begin_record
;
344 zinject_record_t zc_inject_record
;
345 uint32_t zc_defer_destroy
;
347 uint64_t zc_action_handle
;
350 uint8_t zc_pad
[3]; /* alignment */
353 uint64_t zc_createtxg
;
357 typedef struct zfs_useracct
{
364 #define ZFSDEV_MAX_MINOR (1 << 16)
365 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
367 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
371 typedef struct zfs_creat
{
372 nvlist_t
*zct_zplprops
;
376 extern int zfs_secpolicy_snapshot_perms(const char *name
, cred_t
*cr
);
377 extern int zfs_secpolicy_rename_perms(const char *from
,
378 const char *to
, cred_t
*cr
);
379 extern int zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
);
380 extern int zfs_unmount_snap(const char *);
381 extern void zfs_destroy_unmount_origin(const char *);
383 extern boolean_t
dataset_name_hidden(const char *name
);
385 enum zfsdev_state_type
{
392 * The zfsdev_state_t structure is managed as a singly-linked list
393 * from which items are never deleted. This allows for lock-free
394 * reading of the list so long as assignments to the zs_next and
395 * reads from zs_minor are performed atomically. Empty items are
396 * indicated by storing -1 into zs_minor.
398 typedef struct zfsdev_state
{
399 struct zfsdev_state
*zs_next
; /* next zfsdev_state_t link */
400 struct file
*zs_file
; /* associated file struct */
401 minor_t zs_minor
; /* made up minor number */
402 void *zs_onexit
; /* onexit data */
403 void *zs_zevent
; /* zevent data */
406 extern void *zfsdev_get_state(minor_t minor
, enum zfsdev_state_type which
);
407 extern minor_t
zfsdev_getminor(struct file
*filp
);
408 extern minor_t
zfsdev_minor_alloc(void);
416 #endif /* _SYS_ZFS_IOCTL_H */