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, 2015 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 (1 << 0)
83 #define DMU_BACKUP_FEATURE_DEDUPPROPS (1 << 1)
84 #define DMU_BACKUP_FEATURE_SA_SPILL (1 << 2)
85 /* flags #3 - #15 are reserved for incompatible closed-source implementations */
86 #define DMU_BACKUP_FEATURE_EMBED_DATA (1 << 16)
87 #define DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 (1 << 17)
88 /* flag #18 is reserved for a Delphix feature */
89 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1 << 19)
90 #define DMU_BACKUP_FEATURE_RESUMING (1 << 20)
91
92 /*
93 * Mask of all supported backup features
94 */
95 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
96 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
97 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 | \
98 DMU_BACKUP_FEATURE_RESUMING | \
99 DMU_BACKUP_FEATURE_LARGE_BLOCKS)
100
101 /* Are all features in the given flag word currently supported? */
102 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
103
104 typedef enum dmu_send_resume_token_version {
105 ZFS_SEND_RESUME_TOKEN_VERSION = 1
106 } dmu_send_resume_token_version_t;
107
108 /*
109 * The drr_versioninfo field of the dmu_replay_record has the
110 * following layout:
111 *
112 * 64 56 48 40 32 24 16 8 0
113 * +-------+-------+-------+-------+-------+-------+-------+-------+
114 * | reserved | feature-flags |C|S|
115 * +-------+-------+-------+-------+-------+-------+-------+-------+
116 *
117 * The low order two bits indicate the header type: SUBSTREAM (0x1)
118 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
119 * this field used to be a version number, where the two version types
120 * were 1 and 2. Using two bits for this allows earlier versions of
121 * the code to be able to recognize send streams that don't use any
122 * of the features indicated by feature flags.
123 */
124
125 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
126
127 #define DRR_FLAG_CLONE (1<<0)
128 #define DRR_FLAG_CI_DATA (1<<1)
129 /*
130 * This send stream, if it is a full send, includes the FREE and FREEOBJECT
131 * records that are created by the sending process. This means that the send
132 * stream can be received as a clone, even though it is not an incremental.
133 * This is not implemented as a feature flag, because the receiving side does
134 * not need to have implemented it to receive this stream; it is fully backwards
135 * compatible. We need a flag, though, because full send streams without it
136 * cannot necessarily be received as a clone correctly.
137 */
138 #define DRR_FLAG_FREERECORDS (1<<2)
139
140 /*
141 * flags in the drr_checksumflags field in the DRR_WRITE and
142 * DRR_WRITE_BYREF blocks
143 */
144 #define DRR_CHECKSUM_DEDUP (1<<0)
145
146 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
147
148 /*
149 * zfs ioctl command structure
150 */
151 typedef struct dmu_replay_record {
152 enum {
153 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
154 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
155 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
156 } drr_type;
157 uint32_t drr_payloadlen;
158 union {
159 struct drr_begin {
160 uint64_t drr_magic;
161 uint64_t drr_versioninfo; /* was drr_version */
162 uint64_t drr_creation_time;
163 dmu_objset_type_t drr_type;
164 uint32_t drr_flags;
165 uint64_t drr_toguid;
166 uint64_t drr_fromguid;
167 char drr_toname[MAXNAMELEN];
168 } drr_begin;
169 struct drr_end {
170 zio_cksum_t drr_checksum;
171 uint64_t drr_toguid;
172 } drr_end;
173 struct drr_object {
174 uint64_t drr_object;
175 dmu_object_type_t drr_type;
176 dmu_object_type_t drr_bonustype;
177 uint32_t drr_blksz;
178 uint32_t drr_bonuslen;
179 uint8_t drr_checksumtype;
180 uint8_t drr_compress;
181 uint8_t drr_pad[6];
182 uint64_t drr_toguid;
183 /* bonus content follows */
184 } drr_object;
185 struct drr_freeobjects {
186 uint64_t drr_firstobj;
187 uint64_t drr_numobjs;
188 uint64_t drr_toguid;
189 } drr_freeobjects;
190 struct drr_write {
191 uint64_t drr_object;
192 dmu_object_type_t drr_type;
193 uint32_t drr_pad;
194 uint64_t drr_offset;
195 uint64_t drr_length;
196 uint64_t drr_toguid;
197 uint8_t drr_checksumtype;
198 uint8_t drr_checksumflags;
199 uint8_t drr_pad2[6];
200 ddt_key_t drr_key; /* deduplication key */
201 /* content follows */
202 } drr_write;
203 struct drr_free {
204 uint64_t drr_object;
205 uint64_t drr_offset;
206 uint64_t drr_length;
207 uint64_t drr_toguid;
208 } drr_free;
209 struct drr_write_byref {
210 /* where to put the data */
211 uint64_t drr_object;
212 uint64_t drr_offset;
213 uint64_t drr_length;
214 uint64_t drr_toguid;
215 /* where to find the prior copy of the data */
216 uint64_t drr_refguid;
217 uint64_t drr_refobject;
218 uint64_t drr_refoffset;
219 /* properties of the data */
220 uint8_t drr_checksumtype;
221 uint8_t drr_checksumflags;
222 uint8_t drr_pad2[6];
223 ddt_key_t drr_key; /* deduplication key */
224 } drr_write_byref;
225 struct drr_spill {
226 uint64_t drr_object;
227 uint64_t drr_length;
228 uint64_t drr_toguid;
229 uint64_t drr_pad[4]; /* needed for crypto */
230 /* spill data follows */
231 } drr_spill;
232 struct drr_write_embedded {
233 uint64_t drr_object;
234 uint64_t drr_offset;
235 /* logical length, should equal blocksize */
236 uint64_t drr_length;
237 uint64_t drr_toguid;
238 uint8_t drr_compression;
239 uint8_t drr_etype;
240 uint8_t drr_pad[6];
241 uint32_t drr_lsize; /* uncompressed size of payload */
242 uint32_t drr_psize; /* compr. (real) size of payload */
243 /* (possibly compressed) content follows */
244 } drr_write_embedded;
245
246 /*
247 * Nore: drr_checksum is overlaid with all record types
248 * except DRR_BEGIN. Therefore its (non-pad) members
249 * must not overlap with members from the other structs.
250 * We accomplish this by putting its members at the very
251 * end of the struct.
252 */
253 struct drr_checksum {
254 uint64_t drr_pad[34];
255 /*
256 * fletcher-4 checksum of everything preceding the
257 * checksum.
258 */
259 zio_cksum_t drr_checksum;
260 } drr_checksum;
261 } drr_u;
262 } dmu_replay_record_t;
263
264 /* diff record range types */
265 typedef enum diff_type {
266 DDR_NONE = 0x1,
267 DDR_INUSE = 0x2,
268 DDR_FREE = 0x4
269 } diff_type_t;
270
271 /*
272 * The diff reports back ranges of free or in-use objects.
273 */
274 typedef struct dmu_diff_record {
275 uint64_t ddr_type;
276 uint64_t ddr_first;
277 uint64_t ddr_last;
278 } dmu_diff_record_t;
279
280 typedef struct zinject_record {
281 uint64_t zi_objset;
282 uint64_t zi_object;
283 uint64_t zi_start;
284 uint64_t zi_end;
285 uint64_t zi_guid;
286 uint32_t zi_level;
287 uint32_t zi_error;
288 uint64_t zi_type;
289 uint32_t zi_freq;
290 uint32_t zi_failfast;
291 char zi_func[MAXNAMELEN];
292 uint32_t zi_iotype;
293 int32_t zi_duration;
294 uint64_t zi_timer;
295 uint64_t zi_nlanes;
296 uint32_t zi_cmd;
297 uint32_t zi_pad;
298 } zinject_record_t;
299
300 #define ZINJECT_NULL 0x1
301 #define ZINJECT_FLUSH_ARC 0x2
302 #define ZINJECT_UNLOAD_SPA 0x4
303
304 typedef enum zinject_type {
305 ZINJECT_UNINITIALIZED,
306 ZINJECT_DATA_FAULT,
307 ZINJECT_DEVICE_FAULT,
308 ZINJECT_LABEL_FAULT,
309 ZINJECT_IGNORED_WRITES,
310 ZINJECT_PANIC,
311 ZINJECT_DELAY_IO,
312 } zinject_type_t;
313
314 typedef struct zfs_share {
315 uint64_t z_exportdata;
316 uint64_t z_sharedata;
317 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
318 uint64_t z_sharemax; /* max length of share string */
319 } zfs_share_t;
320
321 /*
322 * ZFS file systems may behave the usual, POSIX-compliant way, where
323 * name lookups are case-sensitive. They may also be set up so that
324 * all the name lookups are case-insensitive, or so that only some
325 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
326 */
327 typedef enum zfs_case {
328 ZFS_CASE_SENSITIVE,
329 ZFS_CASE_INSENSITIVE,
330 ZFS_CASE_MIXED
331 } zfs_case_t;
332
333 typedef struct zfs_cmd {
334 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
335 uint64_t zc_nvlist_src; /* really (char *) */
336 uint64_t zc_nvlist_src_size;
337 uint64_t zc_nvlist_dst; /* really (char *) */
338 uint64_t zc_nvlist_dst_size;
339 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
340 int zc_pad2;
341
342 /*
343 * The following members are for legacy ioctls which haven't been
344 * converted to the new method.
345 */
346 uint64_t zc_history; /* really (char *) */
347 char zc_value[MAXPATHLEN * 2];
348 char zc_string[MAXNAMELEN];
349 uint64_t zc_guid;
350 uint64_t zc_nvlist_conf; /* really (char *) */
351 uint64_t zc_nvlist_conf_size;
352 uint64_t zc_cookie;
353 uint64_t zc_objset_type;
354 uint64_t zc_perm_action;
355 uint64_t zc_history_len;
356 uint64_t zc_history_offset;
357 uint64_t zc_obj;
358 uint64_t zc_iflags; /* internal to zfs(7fs) */
359 zfs_share_t zc_share;
360 dmu_objset_stats_t zc_objset_stats;
361 dmu_replay_record_t zc_begin_record;
362 zinject_record_t zc_inject_record;
363 uint32_t zc_defer_destroy;
364 uint32_t zc_flags;
365 uint64_t zc_action_handle;
366 int zc_cleanup_fd;
367 boolean_t zc_resumable;
368 uint64_t zc_sendobj;
369 uint64_t zc_fromobj;
370 uint64_t zc_createtxg;
371 zfs_stat_t zc_stat;
372 } zfs_cmd_t;
373
374 typedef struct zfs_useracct {
375 char zu_domain[256];
376 uid_t zu_rid;
377 uint32_t zu_pad;
378 uint64_t zu_space;
379 } zfs_useracct_t;
380
381 #define ZFSDEV_MAX_MINOR (1 << 16)
382 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
383
384 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
385
386 #ifdef _KERNEL
387
388 typedef struct zfs_creat {
389 nvlist_t *zct_zplprops;
390 nvlist_t *zct_props;
391 } zfs_creat_t;
392
393 extern dev_info_t *zfs_dip;
394
395 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
396 extern int zfs_secpolicy_rename_perms(const char *from,
397 const char *to, cred_t *cr);
398 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
399 extern int zfs_busy(void);
400 extern int zfs_unmount_snap(const char *);
401 extern void zfs_destroy_unmount_origin(const char *);
402
403 /*
404 * ZFS minor numbers can refer to either a control device instance or
405 * a zvol. Depending on the value of zss_type, zss_data points to either
406 * a zvol_state_t or a zfs_onexit_t.
407 */
408 enum zfs_soft_state_type {
409 ZSST_ZVOL,
410 ZSST_CTLDEV
411 };
412
413 typedef struct zfs_soft_state {
414 enum zfs_soft_state_type zss_type;
415 void *zss_data;
416 } zfs_soft_state_t;
417
418 extern void *zfsdev_get_soft_state(minor_t minor,
419 enum zfs_soft_state_type which);
420 extern minor_t zfsdev_minor_alloc(void);
421
422 extern void *zfsdev_state;
423 extern kmutex_t zfsdev_state_lock;
424
425 #endif /* _KERNEL */
426
427 #ifdef __cplusplus
428 }
429 #endif
430
431 #endif /* _SYS_ZFS_IOCTL_H */