zfs_ioctl.h revision 297108 
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
41extern "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 */
67typedef 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
104typedef 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 */
151struct drr_begin {
152	uint64_t drr_magic;
153	uint64_t drr_versioninfo; /* was drr_version */
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};
161
162struct drr_end {
163	zio_cksum_t drr_checksum;
164	uint64_t drr_toguid;
165};
166
167struct drr_object {
168	uint64_t drr_object;
169	dmu_object_type_t drr_type;
170	dmu_object_type_t drr_bonustype;
171	uint32_t drr_blksz;
172	uint32_t drr_bonuslen;
173	uint8_t drr_checksumtype;
174	uint8_t drr_compress;
175	uint8_t drr_pad[6];
176	uint64_t drr_toguid;
177	/* bonus content follows */
178};
179
180struct drr_freeobjects {
181	uint64_t drr_firstobj;
182	uint64_t drr_numobjs;
183	uint64_t drr_toguid;
184};
185
186struct drr_write {
187	uint64_t drr_object;
188	dmu_object_type_t drr_type;
189	uint32_t drr_pad;
190	uint64_t drr_offset;
191	uint64_t drr_length;
192	uint64_t drr_toguid;
193	uint8_t drr_checksumtype;
194	uint8_t drr_checksumflags;
195	uint8_t drr_pad2[6];
196	ddt_key_t drr_key; /* deduplication key */
197	/* content follows */
198};
199
200struct drr_free {
201	uint64_t drr_object;
202	uint64_t drr_offset;
203	uint64_t drr_length;
204	uint64_t drr_toguid;
205};
206
207struct drr_write_byref {
208	/* where to put the data */
209	uint64_t drr_object;
210	uint64_t drr_offset;
211	uint64_t drr_length;
212	uint64_t drr_toguid;
213	/* where to find the prior copy of the data */
214	uint64_t drr_refguid;
215	uint64_t drr_refobject;
216	uint64_t drr_refoffset;
217	/* properties of the data */
218	uint8_t drr_checksumtype;
219	uint8_t drr_checksumflags;
220	uint8_t drr_pad2[6];
221	ddt_key_t drr_key; /* deduplication key */
222};
223
224struct drr_spill {
225	uint64_t drr_object;
226	uint64_t drr_length;
227	uint64_t drr_toguid;
228	uint64_t drr_pad[4]; /* needed for crypto */
229	/* spill data follows */
230};
231
232typedef struct dmu_replay_record {
233	enum {
234		DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
235		DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
236		DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
237	} drr_type;
238	uint32_t drr_payloadlen;
239	union {
240		struct drr_begin drr_begin;
241		struct drr_end drr_end;
242		struct drr_object drr_object;
243		struct drr_freeobjects drr_freeobjects;
244		struct drr_write drr_write;
245		struct drr_free drr_free;
246		struct drr_write_byref drr_write_byref;
247		struct drr_spill drr_spill;
248		struct drr_write_embedded {
249			uint64_t drr_object;
250			uint64_t drr_offset;
251			/* logical length, should equal blocksize */
252			uint64_t drr_length;
253			uint64_t drr_toguid;
254			uint8_t drr_compression;
255			uint8_t drr_etype;
256			uint8_t drr_pad[6];
257			uint32_t drr_lsize; /* uncompressed size of payload */
258			uint32_t drr_psize; /* compr. (real) size of payload */
259			/* (possibly compressed) content follows */
260		} drr_write_embedded;
261
262		/*
263		 * Nore: drr_checksum is overlaid with all record types
264		 * except DRR_BEGIN.  Therefore its (non-pad) members
265		 * must not overlap with members from the other structs.
266		 * We accomplish this by putting its members at the very
267		 * end of the struct.
268		 */
269		struct drr_checksum {
270			uint64_t drr_pad[34];
271			/*
272			 * fletcher-4 checksum of everything preceding the
273			 * checksum.
274			 */
275			zio_cksum_t drr_checksum;
276		} drr_checksum;
277	} drr_u;
278} dmu_replay_record_t;
279
280/* diff record range types */
281typedef enum diff_type {
282	DDR_NONE = 0x1,
283	DDR_INUSE = 0x2,
284	DDR_FREE = 0x4
285} diff_type_t;
286
287/*
288 * The diff reports back ranges of free or in-use objects.
289 */
290typedef struct dmu_diff_record {
291	uint64_t ddr_type;
292	uint64_t ddr_first;
293	uint64_t ddr_last;
294} dmu_diff_record_t;
295
296typedef struct zinject_record {
297	uint64_t	zi_objset;
298	uint64_t	zi_object;
299	uint64_t	zi_start;
300	uint64_t	zi_end;
301	uint64_t	zi_guid;
302	uint32_t	zi_level;
303	uint32_t	zi_error;
304	uint64_t	zi_type;
305	uint32_t	zi_freq;
306	uint32_t	zi_failfast;
307	char		zi_func[MAXNAMELEN];
308	uint32_t	zi_iotype;
309	int32_t		zi_duration;
310	uint64_t	zi_timer;
311	uint64_t	zi_nlanes;
312	uint32_t	zi_cmd;
313	uint32_t	zi_pad;
314} zinject_record_t;
315
316#define	ZINJECT_NULL		0x1
317#define	ZINJECT_FLUSH_ARC	0x2
318#define	ZINJECT_UNLOAD_SPA	0x4
319
320typedef enum zinject_type {
321	ZINJECT_UNINITIALIZED,
322	ZINJECT_DATA_FAULT,
323	ZINJECT_DEVICE_FAULT,
324	ZINJECT_LABEL_FAULT,
325	ZINJECT_IGNORED_WRITES,
326	ZINJECT_PANIC,
327	ZINJECT_DELAY_IO,
328} zinject_type_t;
329
330typedef struct zfs_share {
331	uint64_t	z_exportdata;
332	uint64_t	z_sharedata;
333	uint64_t	z_sharetype;	/* 0 = share, 1 = unshare */
334	uint64_t	z_sharemax;  /* max length of share string */
335} zfs_share_t;
336
337/*
338 * ZFS file systems may behave the usual, POSIX-compliant way, where
339 * name lookups are case-sensitive.  They may also be set up so that
340 * all the name lookups are case-insensitive, or so that only some
341 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
342 */
343typedef enum zfs_case {
344	ZFS_CASE_SENSITIVE,
345	ZFS_CASE_INSENSITIVE,
346	ZFS_CASE_MIXED
347} zfs_case_t;
348
349typedef struct zfs_cmd {
350	char		zc_name[MAXPATHLEN];	/* name of pool or dataset */
351	uint64_t	zc_nvlist_src;		/* really (char *) */
352	uint64_t	zc_nvlist_src_size;
353	uint64_t	zc_nvlist_dst;		/* really (char *) */
354	uint64_t	zc_nvlist_dst_size;
355	boolean_t	zc_nvlist_dst_filled;	/* put an nvlist in dst? */
356	int		zc_pad2;
357
358	/*
359	 * The following members are for legacy ioctls which haven't been
360	 * converted to the new method.
361	 */
362	uint64_t	zc_history;		/* really (char *) */
363	char		zc_value[MAXPATHLEN * 2];
364	char		zc_string[MAXNAMELEN];
365	uint64_t	zc_guid;
366	uint64_t	zc_nvlist_conf;		/* really (char *) */
367	uint64_t	zc_nvlist_conf_size;
368	uint64_t	zc_cookie;
369	uint64_t	zc_objset_type;
370	uint64_t	zc_perm_action;
371	uint64_t	zc_history_len;
372	uint64_t	zc_history_offset;
373	uint64_t	zc_obj;
374	uint64_t	zc_iflags;		/* internal to zfs(7fs) */
375	zfs_share_t	zc_share;
376	uint64_t	zc_jailid;
377	dmu_objset_stats_t zc_objset_stats;
378	dmu_replay_record_t zc_begin_record;
379	zinject_record_t zc_inject_record;
380	uint32_t	zc_defer_destroy;
381	uint32_t	zc_flags;
382	uint64_t	zc_action_handle;
383	int		zc_cleanup_fd;
384	uint8_t		zc_simple;
385	boolean_t	zc_resumable;
386	uint64_t	zc_sendobj;
387	uint64_t	zc_fromobj;
388	uint64_t	zc_createtxg;
389	zfs_stat_t	zc_stat;
390} zfs_cmd_t;
391
392typedef struct zfs_useracct {
393	char zu_domain[256];
394	uid_t zu_rid;
395	uint32_t zu_pad;
396	uint64_t zu_space;
397} zfs_useracct_t;
398
399#define	ZFSDEV_MAX_MINOR	(1 << 16)
400#define	ZFS_MIN_MINOR	(ZFSDEV_MAX_MINOR + 1)
401
402#define	ZPOOL_EXPORT_AFTER_SPLIT 0x1
403
404#ifdef _KERNEL
405
406typedef struct zfs_creat {
407	nvlist_t	*zct_zplprops;
408	nvlist_t	*zct_props;
409} zfs_creat_t;
410
411extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
412extern int zfs_secpolicy_rename_perms(const char *from,
413    const char *to, cred_t *cr);
414extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
415extern int zfs_busy(void);
416extern int zfs_unmount_snap(const char *);
417extern void zfs_destroy_unmount_origin(const char *);
418
419/*
420 * ZFS minor numbers can refer to either a control device instance or
421 * a zvol. Depending on the value of zss_type, zss_data points to either
422 * a zvol_state_t or a zfs_onexit_t.
423 */
424enum zfs_soft_state_type {
425	ZSST_ZVOL,
426	ZSST_CTLDEV
427};
428
429typedef struct zfs_soft_state {
430	enum zfs_soft_state_type zss_type;
431	void *zss_data;
432} zfs_soft_state_t;
433
434extern void *zfsdev_get_soft_state(minor_t minor,
435    enum zfs_soft_state_type which);
436extern minor_t zfsdev_minor_alloc(void);
437
438extern void *zfsdev_state;
439
440#endif	/* _KERNEL */
441
442#ifdef	__cplusplus
443}
444#endif
445
446#endif	/* _SYS_ZFS_IOCTL_H */
447