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.
25 #ifndef _SYS_ZFS_IOCTL_H
26 #define _SYS_ZFS_IOCTL_H
31 #include <sys/dsl_deleg.h>
33 #include <sys/zfs_stat.h>
36 #include <sys/nvpair.h>
44 * Property values for snapdir
46 #define ZFS_SNAPDIR_HIDDEN 0
47 #define ZFS_SNAPDIR_VISIBLE 1
50 * Property values for snapdev
52 #define ZFS_SNAPDEV_HIDDEN 0
53 #define ZFS_SNAPDEV_VISIBLE 1
56 * Field manipulation macros for the drr_versioninfo field of the
61 * Header types for zfs send streams.
63 typedef enum drr_headertype
{
65 DMU_COMPOUNDSTREAM
= 0x2
68 #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2)
69 #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x)
71 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
72 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
75 * Feature flags for zfs send streams (flags in drr_versioninfo)
78 #define DMU_BACKUP_FEATURE_DEDUP (0x1)
79 #define DMU_BACKUP_FEATURE_DEDUPPROPS (0x2)
80 #define DMU_BACKUP_FEATURE_SA_SPILL (0x4)
83 * Mask of all supported backup features
85 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
86 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL)
88 /* Are all features in the given flag word currently supported? */
89 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
92 * The drr_versioninfo field of the dmu_replay_record has the
95 * 64 56 48 40 32 24 16 8 0
96 * +-------+-------+-------+-------+-------+-------+-------+-------+
97 * | reserved | feature-flags |C|S|
98 * +-------+-------+-------+-------+-------+-------+-------+-------+
100 * The low order two bits indicate the header type: SUBSTREAM (0x1)
101 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
102 * this field used to be a version number, where the two version types
103 * were 1 and 2. Using two bits for this allows earlier versions of
104 * the code to be able to recognize send streams that don't use any
105 * of the features indicated by feature flags.
108 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
110 #define DRR_FLAG_CLONE (1<<0)
111 #define DRR_FLAG_CI_DATA (1<<1)
114 * flags in the drr_checksumflags field in the DRR_WRITE and
115 * DRR_WRITE_BYREF blocks
117 #define DRR_CHECKSUM_DEDUP (1<<0)
119 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
122 * zfs ioctl command structure
124 typedef struct dmu_replay_record
{
126 DRR_BEGIN
, DRR_OBJECT
, DRR_FREEOBJECTS
,
127 DRR_WRITE
, DRR_FREE
, DRR_END
, DRR_WRITE_BYREF
,
128 DRR_SPILL
, DRR_NUMTYPES
130 uint32_t drr_payloadlen
;
134 uint64_t drr_versioninfo
; /* was drr_version */
135 uint64_t drr_creation_time
;
136 dmu_objset_type_t drr_type
;
139 uint64_t drr_fromguid
;
140 char drr_toname
[MAXNAMELEN
];
143 zio_cksum_t drr_checksum
;
148 dmu_object_type_t drr_type
;
149 dmu_object_type_t drr_bonustype
;
151 uint32_t drr_bonuslen
;
152 uint8_t drr_checksumtype
;
153 uint8_t drr_compress
;
156 /* bonus content follows */
158 struct drr_freeobjects
{
159 uint64_t drr_firstobj
;
160 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 */
182 struct drr_write_byref
{
183 /* where to put the data */
188 /* where to find the prior copy of the data */
189 uint64_t drr_refguid
;
190 uint64_t drr_refobject
;
191 uint64_t drr_refoffset
;
192 /* properties of the data */
193 uint8_t drr_checksumtype
;
194 uint8_t drr_checksumflags
;
196 ddt_key_t drr_key
; /* deduplication key */
202 uint64_t drr_pad
[4]; /* needed for crypto */
203 /* spill data follows */
206 } dmu_replay_record_t
;
208 /* diff record range types */
209 typedef enum diff_type
{
216 * The diff reports back ranges of free or in-use objects.
218 typedef struct dmu_diff_record
{
224 typedef struct zinject_record
{
234 uint32_t zi_failfast
;
235 char zi_func
[MAXNAMELEN
];
241 #define ZINJECT_NULL 0x1
242 #define ZINJECT_FLUSH_ARC 0x2
243 #define ZINJECT_UNLOAD_SPA 0x4
245 #define ZEVENT_NONBLOCK 0x1
246 #define ZEVENT_SIZE 1024
248 typedef struct zfs_share
{
249 uint64_t z_exportdata
;
250 uint64_t z_sharedata
;
251 uint64_t z_sharetype
; /* 0 = share, 1 = unshare */
252 uint64_t z_sharemax
; /* max length of share string */
256 * ZFS file systems may behave the usual, POSIX-compliant way, where
257 * name lookups are case-sensitive. They may also be set up so that
258 * all the name lookups are case-insensitive, or so that only some
259 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
261 typedef enum zfs_case
{
263 ZFS_CASE_INSENSITIVE
,
267 typedef struct zfs_cmd
{
268 char zc_name
[MAXPATHLEN
];
269 char zc_value
[MAXPATHLEN
* 2];
270 char zc_string
[MAXNAMELEN
];
271 char zc_top_ds
[MAXPATHLEN
];
273 uint64_t zc_nvlist_conf
; /* really (char *) */
274 uint64_t zc_nvlist_conf_size
;
275 uint64_t zc_nvlist_src
; /* really (char *) */
276 uint64_t zc_nvlist_src_size
;
277 uint64_t zc_nvlist_dst
; /* really (char *) */
278 uint64_t zc_nvlist_dst_size
;
280 uint64_t zc_objset_type
;
281 uint64_t zc_perm_action
;
282 uint64_t zc_history
; /* really (char *) */
283 uint64_t zc_history_len
;
284 uint64_t zc_history_offset
;
286 uint64_t zc_iflags
; /* internal to zfs(7fs) */
287 zfs_share_t zc_share
;
288 dmu_objset_stats_t zc_objset_stats
;
289 struct drr_begin zc_begin_record
;
290 zinject_record_t zc_inject_record
;
291 boolean_t zc_defer_destroy
;
292 boolean_t zc_temphold
;
293 uint64_t zc_action_handle
;
296 uint8_t zc_pad
[3]; /* alignment */
299 uint64_t zc_createtxg
;
303 typedef struct zfs_useracct
{
310 #define ZFSDEV_MAX_MINOR (1 << 16)
311 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
313 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
317 typedef struct zfs_creat
{
318 nvlist_t
*zct_zplprops
;
322 extern int zfs_secpolicy_snapshot_perms(const char *name
, cred_t
*cr
);
323 extern int zfs_secpolicy_rename_perms(const char *from
,
324 const char *to
, cred_t
*cr
);
325 extern int zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
);
326 extern int zfs_unmount_snap(const char *, void *);
328 enum zfsdev_state_type
{
334 typedef struct zfsdev_state
{
335 list_node_t zs_next
; /* next zfsdev_state_t link */
336 struct file
*zs_file
; /* associated file struct */
337 minor_t zs_minor
; /* made up minor number */
338 void *zs_onexit
; /* onexit data */
339 void *zs_zevent
; /* zevent data */
342 extern void *zfsdev_get_state(minor_t minor
, enum zfsdev_state_type which
);
343 extern minor_t
zfsdev_getminor(struct file
*filp
);
344 extern minor_t
zfsdev_minor_alloc(void);
352 #endif /* _SYS_ZFS_IOCTL_H */