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