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