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