1 /*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
21 /*
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 */
24
25 #ifndef _SYS_ZFS_IOCTL_H
26 #define _SYS_ZFS_IOCTL_H
27
28 #include <sys/cred.h>
29 #include <sys/dmu.h>
30 #include <sys/zio.h>
31 #include <sys/dsl_deleg.h>
32 #include <sys/spa.h>
33 #include <sys/zfs_stat.h>
34
35 #ifdef _KERNEL
36 #include <sys/nvpair.h>
37 #endif /* _KERNEL */
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /*
44 * Property values for snapdir
45 */
46 #define ZFS_SNAPDIR_HIDDEN 0
47 #define ZFS_SNAPDIR_VISIBLE 1
48
49 /*
50 * Field manipulation macros for the drr_versioninfo field of the
51 * send stream header.
52 */
53
54 /*
55 * Header types for zfs send streams.
56 */
57 typedef enum drr_headertype {
58 DMU_SUBSTREAM = 0x1,
59 DMU_COMPOUNDSTREAM = 0x2
60 } drr_headertype_t;
61
62 #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2)
63 #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x)
64
65 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
66 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
67
68 /*
69 * Feature flags for zfs send streams (flags in drr_versioninfo)
70 */
71
72 #define DMU_BACKUP_FEATURE_DEDUP (0x1)
73 #define DMU_BACKUP_FEATURE_DEDUPPROPS (0x2)
74 #define DMU_BACKUP_FEATURE_SA_SPILL (0x4)
75
76 /*
77 * Mask of all supported backup features
78 */
79 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
80 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL)
81
82 /* Are all features in the given flag word currently supported? */
83 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
84
85 /*
86 * The drr_versioninfo field of the dmu_replay_record has the
87 * following layout:
88 *
89 * 64 56 48 40 32 24 16 8 0
90 * +-------+-------+-------+-------+-------+-------+-------+-------+
91 * | reserved | feature-flags |C|S|
92 * +-------+-------+-------+-------+-------+-------+-------+-------+
93 *
94 * The low order two bits indicate the header type: SUBSTREAM (0x1)
95 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
96 * this field used to be a version number, where the two version types
97 * were 1 and 2. Using two bits for this allows earlier versions of
98 * the code to be able to recognize send streams that don't use any
99 * of the features indicated by feature flags.
100 */
101
102 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
103
104 #define DRR_FLAG_CLONE (1<<0)
105 #define DRR_FLAG_CI_DATA (1<<1)
106
107 /*
108 * flags in the drr_checksumflags field in the DRR_WRITE and
109 * DRR_WRITE_BYREF blocks
110 */
111 #define DRR_CHECKSUM_DEDUP (1<<0)
112
113 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
114
115 /*
116 * zfs ioctl command structure
117 */
118 typedef struct dmu_replay_record {
119 enum {
120 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
121 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
122 DRR_SPILL, DRR_NUMTYPES
123 } drr_type;
124 uint32_t drr_payloadlen;
125 union {
126 struct drr_begin {
127 uint64_t drr_magic;
128 uint64_t drr_versioninfo; /* was drr_version */
129 uint64_t drr_creation_time;
130 dmu_objset_type_t drr_type;
131 uint32_t drr_flags;
132 uint64_t drr_toguid;
133 uint64_t drr_fromguid;
134 char drr_toname[MAXNAMELEN];
135 } drr_begin;
136 struct drr_end {
137 zio_cksum_t drr_checksum;
138 uint64_t drr_toguid;
139 } drr_end;
140 struct drr_object {
141 uint64_t drr_object;
142 dmu_object_type_t drr_type;
143 dmu_object_type_t drr_bonustype;
144 uint32_t drr_blksz;
145 uint32_t drr_bonuslen;
146 uint8_t drr_checksumtype;
147 uint8_t drr_compress;
148 uint8_t drr_pad[6];
149 uint64_t drr_toguid;
150 /* bonus content follows */
151 } drr_object;
152 struct drr_freeobjects {
153 uint64_t drr_firstobj;
154 uint64_t drr_numobjs;
155 uint64_t drr_toguid;
156 } drr_freeobjects;
157 struct drr_write {
158 uint64_t drr_object;
159 dmu_object_type_t drr_type;
160 uint32_t drr_pad;
161 uint64_t drr_offset;
162 uint64_t drr_length;
163 uint64_t drr_toguid;
164 uint8_t drr_checksumtype;
165 uint8_t drr_checksumflags;
166 uint8_t drr_pad2[6];
167 ddt_key_t drr_key; /* deduplication key */
168 /* content follows */
169 } drr_write;
170 struct drr_free {
171 uint64_t drr_object;
172 uint64_t drr_offset;
173 uint64_t drr_length;
174 uint64_t drr_toguid;
175 } drr_free;
176 struct drr_write_byref {
177 /* where to put the data */
178 uint64_t drr_object;
179 uint64_t drr_offset;
180 uint64_t drr_length;
181 uint64_t drr_toguid;
182 /* where to find the prior copy of the data */
183 uint64_t drr_refguid;
184 uint64_t drr_refobject;
185 uint64_t drr_refoffset;
186 /* properties of the data */
187 uint8_t drr_checksumtype;
188 uint8_t drr_checksumflags;
189 uint8_t drr_pad2[6];
190 ddt_key_t drr_key; /* deduplication key */
191 } drr_write_byref;
192 struct drr_spill {
193 uint64_t drr_object;
194 uint64_t drr_length;
195 uint64_t drr_toguid;
196 uint64_t drr_pad[4]; /* needed for crypto */
197 /* spill data follows */
198 } drr_spill;
199 } drr_u;
200 } dmu_replay_record_t;
201
202 /* diff record range types */
203 typedef enum diff_type {
204 DDR_NONE = 0x1,
205 DDR_INUSE = 0x2,
206 DDR_FREE = 0x4
207 } diff_type_t;
208
209 /*
210 * The diff reports back ranges of free or in-use objects.
211 */
212 typedef struct dmu_diff_record {
213 uint64_t ddr_type;
214 uint64_t ddr_first;
215 uint64_t ddr_last;
216 } dmu_diff_record_t;
217
218 typedef struct zinject_record {
219 uint64_t zi_objset;
220 uint64_t zi_object;
221 uint64_t zi_start;
222 uint64_t zi_end;
223 uint64_t zi_guid;
224 uint32_t zi_level;
225 uint32_t zi_error;
226 uint64_t zi_type;
227 uint32_t zi_freq;
228 uint32_t zi_failfast;
229 char zi_func[MAXNAMELEN];
230 uint32_t zi_iotype;
231 int32_t zi_duration;
232 uint64_t zi_timer;
233 } zinject_record_t;
234
235 #define ZINJECT_NULL 0x1
236 #define ZINJECT_FLUSH_ARC 0x2
237 #define ZINJECT_UNLOAD_SPA 0x4
238
239 typedef struct zfs_share {
240 uint64_t z_exportdata;
241 uint64_t z_sharedata;
242 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
243 uint64_t z_sharemax; /* max length of share string */
244 } zfs_share_t;
245
246 /*
247 * ZFS file systems may behave the usual, POSIX-compliant way, where
248 * name lookups are case-sensitive. They may also be set up so that
249 * all the name lookups are case-insensitive, or so that only some
250 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
251 */
252 typedef enum zfs_case {
253 ZFS_CASE_SENSITIVE,
254 ZFS_CASE_INSENSITIVE,
255 ZFS_CASE_MIXED
256 } zfs_case_t;
257
258 typedef struct zfs_cmd {
259 char zc_name[MAXPATHLEN];
260 char zc_value[MAXPATHLEN * 2];
261 char zc_string[MAXNAMELEN];
262 char zc_top_ds[MAXPATHLEN];
263 uint64_t zc_guid;
264 uint64_t zc_nvlist_conf; /* really (char *) */
265 uint64_t zc_nvlist_conf_size;
266 uint64_t zc_nvlist_src; /* really (char *) */
267 uint64_t zc_nvlist_src_size;
268 uint64_t zc_nvlist_dst; /* really (char *) */
269 uint64_t zc_nvlist_dst_size;
270 uint64_t zc_cookie;
271 uint64_t zc_objset_type;
272 uint64_t zc_perm_action;
273 uint64_t zc_history; /* really (char *) */
274 uint64_t zc_history_len;
275 uint64_t zc_history_offset;
276 uint64_t zc_obj;
277 uint64_t zc_iflags; /* internal to zfs(7fs) */
278 zfs_share_t zc_share;
279 dmu_objset_stats_t zc_objset_stats;
280 struct drr_begin zc_begin_record;
281 zinject_record_t zc_inject_record;
282 boolean_t zc_defer_destroy;
283 boolean_t zc_temphold;
284 uint64_t zc_action_handle;
285 int zc_cleanup_fd;
286 uint8_t zc_pad[4]; /* alignment */
287 uint64_t zc_sendobj;
288 uint64_t zc_fromobj;
289 uint64_t zc_createtxg;
290 zfs_stat_t zc_stat;
291 } zfs_cmd_t;
292
293 typedef struct zfs_useracct {
294 char zu_domain[256];
295 uid_t zu_rid;
296 uint32_t zu_pad;
297 uint64_t zu_space;
298 } zfs_useracct_t;
299
300 #define ZFSDEV_MAX_MINOR (1 << 16)
301 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
302
303 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
304
305 #ifdef _KERNEL
306
307 typedef struct zfs_creat {
308 nvlist_t *zct_zplprops;
309 nvlist_t *zct_props;
310 } zfs_creat_t;
311
312 extern dev_info_t *zfs_dip;
313
314 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
315 extern int zfs_secpolicy_rename_perms(const char *from,
316 const char *to, cred_t *cr);
317 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
318 extern int zfs_busy(void);
319 extern int zfs_unmount_snap(const char *, void *);
320
321 /*
322 * ZFS minor numbers can refer to either a control device instance or
323 * a zvol. Depending on the value of zss_type, zss_data points to either
324 * a zvol_state_t or a zfs_onexit_t.
325 */
326 enum zfs_soft_state_type {
327 ZSST_ZVOL,
328 ZSST_CTLDEV
329 };
330
331 typedef struct zfs_soft_state {
332 enum zfs_soft_state_type zss_type;
333 void *zss_data;
334 } zfs_soft_state_t;
335
336 extern void *zfsdev_get_soft_state(minor_t minor,
337 enum zfs_soft_state_type which);
338 extern minor_t zfsdev_minor_alloc(void);
339
340 extern void *zfsdev_state;
341 extern kmutex_t zfsdev_state_lock;
342
343 #endif /* _KERNEL */
344
345 #ifdef __cplusplus
346 }
347 #endif
348
349 #endif /* _SYS_ZFS_IOCTL_H */