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