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