xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_ioctl.h (revision d62bc4badc1c1f1549c961cfb8b420e650e1272b)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_ZFS_IOCTL_H
27 #define	_SYS_ZFS_IOCTL_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/cred.h>
32 #include <sys/dmu.h>
33 #include <sys/zio.h>
34 #include <sys/dsl_deleg.h>
35 
36 #ifdef _KERNEL
37 #include <sys/nvpair.h>
38 #endif	/* _KERNEL */
39 
40 #ifdef	__cplusplus
41 extern "C" {
42 #endif
43 
44 /*
45  * Property values for snapdir
46  */
47 #define	ZFS_SNAPDIR_HIDDEN		0
48 #define	ZFS_SNAPDIR_VISIBLE		1
49 
50 #define	DMU_BACKUP_STREAM_VERSION (1ULL)
51 #define	DMU_BACKUP_HEADER_VERSION (2ULL)
52 #define	DMU_BACKUP_MAGIC 0x2F5bacbacULL
53 
54 #define	DRR_FLAG_CLONE (1<<0)
55 
56 /*
57  * zfs ioctl command structure
58  */
59 typedef struct dmu_replay_record {
60 	enum {
61 		DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
62 		DRR_WRITE, DRR_FREE, DRR_END,
63 	} drr_type;
64 	uint32_t drr_payloadlen;
65 	union {
66 		struct drr_begin {
67 			uint64_t drr_magic;
68 			uint64_t drr_version;
69 			uint64_t drr_creation_time;
70 			dmu_objset_type_t drr_type;
71 			uint32_t drr_flags;
72 			uint64_t drr_toguid;
73 			uint64_t drr_fromguid;
74 			char drr_toname[MAXNAMELEN];
75 		} drr_begin;
76 		struct drr_end {
77 			zio_cksum_t drr_checksum;
78 		} drr_end;
79 		struct drr_object {
80 			uint64_t drr_object;
81 			dmu_object_type_t drr_type;
82 			dmu_object_type_t drr_bonustype;
83 			uint32_t drr_blksz;
84 			uint32_t drr_bonuslen;
85 			uint8_t drr_checksum;
86 			uint8_t drr_compress;
87 			uint8_t drr_pad[6];
88 			/* bonus content follows */
89 		} drr_object;
90 		struct drr_freeobjects {
91 			uint64_t drr_firstobj;
92 			uint64_t drr_numobjs;
93 		} drr_freeobjects;
94 		struct drr_write {
95 			uint64_t drr_object;
96 			dmu_object_type_t drr_type;
97 			uint32_t drr_pad;
98 			uint64_t drr_offset;
99 			uint64_t drr_length;
100 			/* content follows */
101 		} drr_write;
102 		struct drr_free {
103 			uint64_t drr_object;
104 			uint64_t drr_offset;
105 			uint64_t drr_length;
106 		} drr_free;
107 	} drr_u;
108 } dmu_replay_record_t;
109 
110 typedef struct zinject_record {
111 	uint64_t	zi_objset;
112 	uint64_t	zi_object;
113 	uint64_t	zi_start;
114 	uint64_t	zi_end;
115 	uint64_t	zi_guid;
116 	uint32_t	zi_level;
117 	uint32_t	zi_error;
118 	uint64_t	zi_type;
119 	uint32_t	zi_freq;
120 	uint32_t	zi_pad;	/* pad out to 64 bit alignment */
121 } zinject_record_t;
122 
123 #define	ZINJECT_NULL		0x1
124 #define	ZINJECT_FLUSH_ARC	0x2
125 #define	ZINJECT_UNLOAD_SPA	0x4
126 
127 typedef struct zfs_share {
128 	uint64_t	z_exportdata;
129 	uint64_t	z_sharedata;
130 	uint64_t	z_sharetype;	/* 0 = share, 1 = unshare */
131 	uint64_t	z_sharemax;  /* max length of share string */
132 } zfs_share_t;
133 
134 /*
135  * ZFS file systems may behave the usual, POSIX-compliant way, where
136  * name lookups are case-sensitive.  They may also be set up so that
137  * all the name lookups are case-insensitive, or so that only some
138  * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
139  */
140 typedef enum zfs_case {
141 	ZFS_CASE_SENSITIVE,
142 	ZFS_CASE_INSENSITIVE,
143 	ZFS_CASE_MIXED
144 } zfs_case_t;
145 
146 typedef struct zfs_cmd {
147 	char		zc_name[MAXPATHLEN];
148 	char		zc_value[MAXPATHLEN * 2];
149 	char		zc_string[MAXNAMELEN];
150 	uint64_t	zc_guid;
151 	uint64_t	zc_nvlist_conf;		/* really (char *) */
152 	uint64_t	zc_nvlist_conf_size;
153 	uint64_t	zc_nvlist_src;		/* really (char *) */
154 	uint64_t	zc_nvlist_src_size;
155 	uint64_t	zc_nvlist_dst;		/* really (char *) */
156 	uint64_t	zc_nvlist_dst_size;
157 	uint64_t	zc_cookie;
158 	uint64_t	zc_objset_type;
159 	uint64_t	zc_perm_action;
160 	uint64_t 	zc_history;		/* really (char *) */
161 	uint64_t 	zc_history_len;
162 	uint64_t	zc_history_offset;
163 	uint64_t	zc_obj;
164 	zfs_share_t	zc_share;
165 	dmu_objset_stats_t zc_objset_stats;
166 	struct drr_begin zc_begin_record;
167 	zinject_record_t zc_inject_record;
168 } zfs_cmd_t;
169 
170 #define	ZVOL_MAX_MINOR	(1 << 16)
171 #define	ZFS_MIN_MINOR	(ZVOL_MAX_MINOR + 1)
172 
173 #ifdef _KERNEL
174 
175 typedef struct zfs_creat {
176 	nvlist_t	*zct_zplprops;
177 	nvlist_t	*zct_props;
178 } zfs_creat_t;
179 
180 extern dev_info_t *zfs_dip;
181 
182 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
183 extern int zfs_secpolicy_rename_perms(const char *from,
184     const char *to, cred_t *cr);
185 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
186 extern int zfs_busy(void);
187 extern int zfs_unmount_snap(char *, void *);
188 
189 #endif	/* _KERNEL */
190 
191 #ifdef	__cplusplus
192 }
193 #endif
194 
195 #endif	/* _SYS_ZFS_IOCTL_H */
196