]> git.proxmox.com Git - mirror_zfs-debian.git/blame - include/sys/zfs_ioctl.h
Imported Upstream version 0.6.4.2
[mirror_zfs-debian.git] / include / sys / zfs_ioctl.h
CommitLineData
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.
ea04106b 23 * Copyright (c) 2013 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
41extern "C" {
42#endif
43
a08ee875
LG
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
a08ee875
LG
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 */
78typedef 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
ea04106b
AX
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)
428870ff
BB
99
100/*
101 * Mask of all supported backup features
102 */
103#define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
ea04106b
AX
104 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
105 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4)
428870ff
BB
106
107/* Are all features in the given flag word currently supported? */
108#define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
109
110/*
111 * The drr_versioninfo field of the dmu_replay_record has the
112 * following layout:
113 *
114 * 64 56 48 40 32 24 16 8 0
115 * +-------+-------+-------+-------+-------+-------+-------+-------+
116 * | reserved | feature-flags |C|S|
117 * +-------+-------+-------+-------+-------+-------+-------+-------+
118 *
119 * The low order two bits indicate the header type: SUBSTREAM (0x1)
120 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
121 * this field used to be a version number, where the two version types
122 * were 1 and 2. Using two bits for this allows earlier versions of
123 * the code to be able to recognize send streams that don't use any
124 * of the features indicated by feature flags.
125 */
126
34dc7c2f
BB
127#define DMU_BACKUP_MAGIC 0x2F5bacbacULL
128
129#define DRR_FLAG_CLONE (1<<0)
130#define DRR_FLAG_CI_DATA (1<<1)
131
428870ff
BB
132/*
133 * flags in the drr_checksumflags field in the DRR_WRITE and
134 * DRR_WRITE_BYREF blocks
135 */
136#define DRR_CHECKSUM_DEDUP (1<<0)
137
138#define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
139
34dc7c2f
BB
140/*
141 * zfs ioctl command structure
142 */
143typedef struct dmu_replay_record {
144 enum {
145 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
428870ff 146 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
ea04106b 147 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
34dc7c2f
BB
148 } drr_type;
149 uint32_t drr_payloadlen;
150 union {
151 struct drr_begin {
152 uint64_t drr_magic;
428870ff 153 uint64_t drr_versioninfo; /* was drr_version */
34dc7c2f
BB
154 uint64_t drr_creation_time;
155 dmu_objset_type_t drr_type;
156 uint32_t drr_flags;
157 uint64_t drr_toguid;
158 uint64_t drr_fromguid;
159 char drr_toname[MAXNAMELEN];
160 } drr_begin;
161 struct drr_end {
162 zio_cksum_t drr_checksum;
428870ff 163 uint64_t drr_toguid;
34dc7c2f
BB
164 } drr_end;
165 struct drr_object {
166 uint64_t drr_object;
167 dmu_object_type_t drr_type;
168 dmu_object_type_t drr_bonustype;
169 uint32_t drr_blksz;
170 uint32_t drr_bonuslen;
428870ff 171 uint8_t drr_checksumtype;
34dc7c2f
BB
172 uint8_t drr_compress;
173 uint8_t drr_pad[6];
428870ff 174 uint64_t drr_toguid;
34dc7c2f
BB
175 /* bonus content follows */
176 } drr_object;
177 struct drr_freeobjects {
178 uint64_t drr_firstobj;
179 uint64_t drr_numobjs;
428870ff 180 uint64_t drr_toguid;
34dc7c2f
BB
181 } drr_freeobjects;
182 struct drr_write {
183 uint64_t drr_object;
184 dmu_object_type_t drr_type;
185 uint32_t drr_pad;
186 uint64_t drr_offset;
187 uint64_t drr_length;
428870ff
BB
188 uint64_t drr_toguid;
189 uint8_t drr_checksumtype;
190 uint8_t drr_checksumflags;
191 uint8_t drr_pad2[6];
192 ddt_key_t drr_key; /* deduplication key */
34dc7c2f
BB
193 /* content follows */
194 } drr_write;
195 struct drr_free {
196 uint64_t drr_object;
197 uint64_t drr_offset;
198 uint64_t drr_length;
428870ff 199 uint64_t drr_toguid;
34dc7c2f 200 } drr_free;
428870ff
BB
201 struct drr_write_byref {
202 /* where to put the data */
203 uint64_t drr_object;
204 uint64_t drr_offset;
205 uint64_t drr_length;
206 uint64_t drr_toguid;
207 /* where to find the prior copy of the data */
208 uint64_t drr_refguid;
209 uint64_t drr_refobject;
210 uint64_t drr_refoffset;
211 /* properties of the data */
212 uint8_t drr_checksumtype;
213 uint8_t drr_checksumflags;
214 uint8_t drr_pad2[6];
215 ddt_key_t drr_key; /* deduplication key */
216 } drr_write_byref;
217 struct drr_spill {
218 uint64_t drr_object;
219 uint64_t drr_length;
220 uint64_t drr_toguid;
221 uint64_t drr_pad[4]; /* needed for crypto */
222 /* spill data follows */
223 } drr_spill;
ea04106b
AX
224 struct drr_write_embedded {
225 uint64_t drr_object;
226 uint64_t drr_offset;
227 /* logical length, should equal blocksize */
228 uint64_t drr_length;
229 uint64_t drr_toguid;
230 uint8_t drr_compression;
231 uint8_t drr_etype;
232 uint8_t drr_pad[6];
233 uint32_t drr_lsize; /* uncompressed size of payload */
234 uint32_t drr_psize; /* compr. (real) size of payload */
235 /* (possibly compressed) content follows */
236 } drr_write_embedded;
34dc7c2f
BB
237 } drr_u;
238} dmu_replay_record_t;
239
572e2857
BB
240/* diff record range types */
241typedef enum diff_type {
242 DDR_NONE = 0x1,
243 DDR_INUSE = 0x2,
244 DDR_FREE = 0x4
245} diff_type_t;
246
247/*
248 * The diff reports back ranges of free or in-use objects.
249 */
250typedef struct dmu_diff_record {
251 uint64_t ddr_type;
252 uint64_t ddr_first;
253 uint64_t ddr_last;
254} dmu_diff_record_t;
255
34dc7c2f
BB
256typedef struct zinject_record {
257 uint64_t zi_objset;
258 uint64_t zi_object;
259 uint64_t zi_start;
260 uint64_t zi_end;
261 uint64_t zi_guid;
262 uint32_t zi_level;
263 uint32_t zi_error;
264 uint64_t zi_type;
265 uint32_t zi_freq;
9babb374 266 uint32_t zi_failfast;
428870ff
BB
267 char zi_func[MAXNAMELEN];
268 uint32_t zi_iotype;
269 int32_t zi_duration;
270 uint64_t zi_timer;
c06d4368
AX
271 uint32_t zi_cmd;
272 uint32_t zi_pad;
34dc7c2f
BB
273} zinject_record_t;
274
275#define ZINJECT_NULL 0x1
276#define ZINJECT_FLUSH_ARC 0x2
277#define ZINJECT_UNLOAD_SPA 0x4
278
ea04106b 279#define ZEVENT_NONE 0x0
26685276
BB
280#define ZEVENT_NONBLOCK 0x1
281#define ZEVENT_SIZE 1024
282
ea04106b
AX
283#define ZEVENT_SEEK_START 0
284#define ZEVENT_SEEK_END UINT64_MAX
285
c06d4368
AX
286typedef enum zinject_type {
287 ZINJECT_UNINITIALIZED,
288 ZINJECT_DATA_FAULT,
289 ZINJECT_DEVICE_FAULT,
290 ZINJECT_LABEL_FAULT,
291 ZINJECT_IGNORED_WRITES,
292 ZINJECT_PANIC,
293 ZINJECT_DELAY_IO,
294} zinject_type_t;
295
34dc7c2f
BB
296typedef struct zfs_share {
297 uint64_t z_exportdata;
298 uint64_t z_sharedata;
299 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
300 uint64_t z_sharemax; /* max length of share string */
301} zfs_share_t;
302
303/*
304 * ZFS file systems may behave the usual, POSIX-compliant way, where
305 * name lookups are case-sensitive. They may also be set up so that
306 * all the name lookups are case-insensitive, or so that only some
307 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
308 */
309typedef enum zfs_case {
310 ZFS_CASE_SENSITIVE,
311 ZFS_CASE_INSENSITIVE,
312 ZFS_CASE_MIXED
313} zfs_case_t;
314
315typedef struct zfs_cmd {
a08ee875
LG
316 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
317 uint64_t zc_nvlist_src; /* really (char *) */
318 uint64_t zc_nvlist_src_size;
319 uint64_t zc_nvlist_dst; /* really (char *) */
320 uint64_t zc_nvlist_dst_size;
321 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
322 int zc_pad2;
323
324 /*
325 * The following members are for legacy ioctls which haven't been
326 * converted to the new method.
327 */
328 uint64_t zc_history; /* really (char *) */
34dc7c2f
BB
329 char zc_value[MAXPATHLEN * 2];
330 char zc_string[MAXNAMELEN];
331 uint64_t zc_guid;
332 uint64_t zc_nvlist_conf; /* really (char *) */
333 uint64_t zc_nvlist_conf_size;
34dc7c2f
BB
334 uint64_t zc_cookie;
335 uint64_t zc_objset_type;
336 uint64_t zc_perm_action;
a08ee875 337 uint64_t zc_history_len;
34dc7c2f
BB
338 uint64_t zc_history_offset;
339 uint64_t zc_obj;
9babb374 340 uint64_t zc_iflags; /* internal to zfs(7fs) */
34dc7c2f
BB
341 zfs_share_t zc_share;
342 dmu_objset_stats_t zc_objset_stats;
343 struct drr_begin zc_begin_record;
344 zinject_record_t zc_inject_record;
ea04106b
AX
345 uint32_t zc_defer_destroy;
346 uint32_t zc_flags;
572e2857
BB
347 uint64_t zc_action_handle;
348 int zc_cleanup_fd;
0cee2406
PJD
349 uint8_t zc_simple;
350 uint8_t zc_pad[3]; /* alignment */
572e2857
BB
351 uint64_t zc_sendobj;
352 uint64_t zc_fromobj;
353 uint64_t zc_createtxg;
354 zfs_stat_t zc_stat;
34dc7c2f
BB
355} zfs_cmd_t;
356
9babb374
BB
357typedef struct zfs_useracct {
358 char zu_domain[256];
359 uid_t zu_rid;
360 uint32_t zu_pad;
361 uint64_t zu_space;
362} zfs_useracct_t;
363
572e2857
BB
364#define ZFSDEV_MAX_MINOR (1 << 16)
365#define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
34dc7c2f 366
428870ff
BB
367#define ZPOOL_EXPORT_AFTER_SPLIT 0x1
368
34dc7c2f
BB
369#ifdef _KERNEL
370
371typedef struct zfs_creat {
372 nvlist_t *zct_zplprops;
373 nvlist_t *zct_props;
374} zfs_creat_t;
375
34dc7c2f
BB
376extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
377extern int zfs_secpolicy_rename_perms(const char *from,
378 const char *to, cred_t *cr);
379extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
a08ee875
LG
380extern int zfs_unmount_snap(const char *);
381extern void zfs_destroy_unmount_origin(const char *);
382
383extern boolean_t dataset_name_hidden(const char *name);
34dc7c2f 384
325f0235
BB
385enum zfsdev_state_type {
386 ZST_ONEXIT,
387 ZST_ZEVENT,
388 ZST_ALL,
572e2857
BB
389};
390
ea04106b
AX
391/*
392 * The zfsdev_state_t structure is managed as a singly-linked list
393 * from which items are never deleted. This allows for lock-free
394 * reading of the list so long as assignments to the zs_next and
395 * reads from zs_minor are performed atomically. Empty items are
396 * indicated by storing -1 into zs_minor.
397 */
325f0235 398typedef struct zfsdev_state {
ea04106b 399 struct zfsdev_state *zs_next; /* next zfsdev_state_t link */
325f0235
BB
400 struct file *zs_file; /* associated file struct */
401 minor_t zs_minor; /* made up minor number */
402 void *zs_onexit; /* onexit data */
403 void *zs_zevent; /* zevent data */
404} zfsdev_state_t;
572e2857 405
325f0235
BB
406extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
407extern minor_t zfsdev_getminor(struct file *filp);
572e2857
BB
408extern minor_t zfsdev_minor_alloc(void);
409
34dc7c2f
BB
410#endif /* _KERNEL */
411
412#ifdef __cplusplus
413}
414#endif
415
416#endif /* _SYS_ZFS_IOCTL_H */