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