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 https://opensource.org/licenses/CDDL-1.0.
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
23#ifndef _ZFS_IOCTL_IMPL_H_
24#define	_ZFS_IOCTL_IMPL_H_
25
26extern kmutex_t zfsdev_state_lock;
27extern uint64_t zfs_max_nvlist_src_size;
28
29typedef int zfs_ioc_legacy_func_t(zfs_cmd_t *);
30typedef int zfs_ioc_func_t(const char *, nvlist_t *, nvlist_t *);
31typedef int zfs_secpolicy_func_t(zfs_cmd_t *, nvlist_t *, cred_t *);
32
33typedef enum {
34	POOL_CHECK_NONE		= 1 << 0,
35	POOL_CHECK_SUSPENDED	= 1 << 1,
36	POOL_CHECK_READONLY	= 1 << 2,
37} zfs_ioc_poolcheck_t;
38
39typedef enum {
40	NO_NAME,
41	POOL_NAME,
42	DATASET_NAME,
43	ENTITY_NAME
44} zfs_ioc_namecheck_t;
45
46/*
47 * IOC Keys are used to document and validate user->kernel interface inputs.
48 * See zfs_keys_recv_new for an example declaration. Any key name that is not
49 * listed will be rejected as input.
50 *
51 * The keyname 'optional' is always allowed, and must be an nvlist if present.
52 * Arguments which older kernels can safely ignore can be placed under the
53 * "optional" key.
54 *
55 * When adding new keys to an existing ioc for new functionality, consider:
56 *	- adding an entry into zfs_sysfs.c zfs_features[] list
57 *	- updating the libzfs_input_check.c test utility
58 *
59 * Note: in the ZK_WILDCARDLIST case, the name serves as documentation
60 * for the expected name (bookmark, snapshot, property, etc) but there
61 * is no validation in the preflight zfs_check_input_nvpairs() check.
62 */
63typedef enum {
64	ZK_OPTIONAL = 1 << 0,		/* pair is optional */
65	ZK_WILDCARDLIST = 1 << 1,	/* one or more unspecified key names */
66} ioc_key_flag_t;
67
68typedef struct zfs_ioc_key {
69	const char	*zkey_name;
70	data_type_t	zkey_type;
71	ioc_key_flag_t	zkey_flags;
72} zfs_ioc_key_t;
73
74int zfs_secpolicy_config(zfs_cmd_t *, nvlist_t *, cred_t *);
75
76void zfs_ioctl_register_dataset_nolog(zfs_ioc_t, zfs_ioc_legacy_func_t *,
77    zfs_secpolicy_func_t *, zfs_ioc_poolcheck_t);
78
79void zfs_ioctl_register(const char *, zfs_ioc_t, zfs_ioc_func_t *,
80    zfs_secpolicy_func_t *, zfs_ioc_namecheck_t, zfs_ioc_poolcheck_t,
81    boolean_t, boolean_t, const zfs_ioc_key_t *, size_t);
82
83uint64_t zfs_max_nvlist_src_size_os(void);
84void zfs_ioctl_update_mount_cache(const char *dsname);
85void zfs_ioctl_init_os(void);
86
87boolean_t zfs_vfs_held(zfsvfs_t *);
88int zfs_vfs_ref(zfsvfs_t **);
89void zfs_vfs_rele(zfsvfs_t *);
90
91long zfsdev_ioctl_common(uint_t, zfs_cmd_t *, int);
92int zfsdev_attach(void);
93void zfsdev_detach(void);
94void zfsdev_private_set_state(void *, zfsdev_state_t *);
95zfsdev_state_t *zfsdev_private_get_state(void *);
96int zfsdev_state_init(void *);
97void zfsdev_state_destroy(void *);
98int zfs_kmod_init(void);
99void zfs_kmod_fini(void);
100
101#endif
102