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