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 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2017 by Delphix. All rights reserved.
24 */
25
26/*
27 * This file is intended for functions that ought to be common between user
28 * land (libzfs) and the kernel. When many common routines need to be shared
29 * then a separate file should be created.
30 */
31
32#if !defined(_KERNEL)
33#include <string.h>
34#endif
35
36#include <sys/types.h>
37#include <sys/fs/zfs.h>
38#include <sys/nvpair.h>
39#include "zfs_comutil.h"
40#include <sys/zfs_ratelimit.h>
41
42/*
43 * Are there allocatable vdevs?
44 */
45boolean_t
46zfs_allocatable_devs(nvlist_t *nv)
47{
48	uint64_t is_log;
49	uint_t c;
50	nvlist_t **child;
51	uint_t children;
52
53	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
54	    &child, &children) != 0) {
55		return (B_FALSE);
56	}
57	for (c = 0; c < children; c++) {
58		is_log = 0;
59		(void) nvlist_lookup_uint64(child[c], ZPOOL_CONFIG_IS_LOG,
60		    &is_log);
61		if (!is_log)
62			return (B_TRUE);
63	}
64	return (B_FALSE);
65}
66
67/*
68 * Are there special vdevs?
69 */
70boolean_t
71zfs_special_devs(nvlist_t *nv, const char *type)
72{
73	const char *bias;
74	uint_t c;
75	nvlist_t **child;
76	uint_t children;
77
78	if (nvlist_lookup_nvlist_array(nv, ZPOOL_CONFIG_CHILDREN,
79	    &child, &children) != 0) {
80		return (B_FALSE);
81	}
82	for (c = 0; c < children; c++) {
83		if (nvlist_lookup_string(child[c], ZPOOL_CONFIG_ALLOCATION_BIAS,
84		    &bias) == 0) {
85			if (strcmp(bias, VDEV_ALLOC_BIAS_SPECIAL) == 0 ||
86			    strcmp(bias, VDEV_ALLOC_BIAS_DEDUP) == 0) {
87				if (type == NULL ||
88				    (type != NULL && strcmp(bias, type) == 0))
89					return (B_TRUE);
90			}
91		}
92	}
93	return (B_FALSE);
94}
95
96void
97zpool_get_load_policy(nvlist_t *nvl, zpool_load_policy_t *zlpp)
98{
99	nvlist_t *policy;
100	nvpair_t *elem;
101	const char *nm;
102
103	/* Defaults */
104	zlpp->zlp_rewind = ZPOOL_NO_REWIND;
105	zlpp->zlp_maxmeta = 0;
106	zlpp->zlp_maxdata = UINT64_MAX;
107	zlpp->zlp_txg = UINT64_MAX;
108
109	if (nvl == NULL)
110		return;
111
112	elem = NULL;
113	while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
114		nm = nvpair_name(elem);
115		if (strcmp(nm, ZPOOL_LOAD_POLICY) == 0) {
116			if (nvpair_value_nvlist(elem, &policy) == 0)
117				zpool_get_load_policy(policy, zlpp);
118			return;
119		} else if (strcmp(nm, ZPOOL_LOAD_REWIND_POLICY) == 0) {
120			if (nvpair_value_uint32(elem, &zlpp->zlp_rewind) == 0)
121				if (zlpp->zlp_rewind & ~ZPOOL_REWIND_POLICIES)
122					zlpp->zlp_rewind = ZPOOL_NO_REWIND;
123		} else if (strcmp(nm, ZPOOL_LOAD_REQUEST_TXG) == 0) {
124			(void) nvpair_value_uint64(elem, &zlpp->zlp_txg);
125		} else if (strcmp(nm, ZPOOL_LOAD_META_THRESH) == 0) {
126			(void) nvpair_value_uint64(elem, &zlpp->zlp_maxmeta);
127		} else if (strcmp(nm, ZPOOL_LOAD_DATA_THRESH) == 0) {
128			(void) nvpair_value_uint64(elem, &zlpp->zlp_maxdata);
129		}
130	}
131	if (zlpp->zlp_rewind == 0)
132		zlpp->zlp_rewind = ZPOOL_NO_REWIND;
133}
134
135typedef struct zfs_version_spa_map {
136	int	version_zpl;
137	int	version_spa;
138} zfs_version_spa_map_t;
139
140/*
141 * Keep this table in monotonically increasing version number order.
142 */
143static zfs_version_spa_map_t zfs_version_table[] = {
144	{ZPL_VERSION_INITIAL, SPA_VERSION_INITIAL},
145	{ZPL_VERSION_DIRENT_TYPE, SPA_VERSION_INITIAL},
146	{ZPL_VERSION_FUID, SPA_VERSION_FUID},
147	{ZPL_VERSION_USERSPACE, SPA_VERSION_USERSPACE},
148	{ZPL_VERSION_SA, SPA_VERSION_SA},
149	{0, 0}
150};
151
152/*
153 * Return the max zpl version for a corresponding spa version
154 * -1 is returned if no mapping exists.
155 */
156int
157zfs_zpl_version_map(int spa_version)
158{
159	int version = -1;
160
161	for (int i = 0; zfs_version_table[i].version_spa; i++)
162		if (spa_version >= zfs_version_table[i].version_spa)
163			version = zfs_version_table[i].version_zpl;
164
165	return (version);
166}
167
168/*
169 * Return the min spa version for a corresponding spa version
170 * -1 is returned if no mapping exists.
171 */
172int
173zfs_spa_version_map(int zpl_version)
174{
175	for (int i = 0; zfs_version_table[i].version_zpl; i++)
176		if (zfs_version_table[i].version_zpl >= zpl_version)
177			return (zfs_version_table[i].version_spa);
178
179	return (-1);
180}
181
182/*
183 * This is the table of legacy internal event names; it should not be modified.
184 * The internal events are now stored in the history log as strings.
185 */
186const char *const zfs_history_event_names[ZFS_NUM_LEGACY_HISTORY_EVENTS] = {
187	"invalid event",
188	"pool create",
189	"vdev add",
190	"pool remove",
191	"pool destroy",
192	"pool export",
193	"pool import",
194	"vdev attach",
195	"vdev replace",
196	"vdev detach",
197	"vdev online",
198	"vdev offline",
199	"vdev upgrade",
200	"pool clear",
201	"pool scrub",
202	"pool property set",
203	"create",
204	"clone",
205	"destroy",
206	"destroy_begin_sync",
207	"inherit",
208	"property set",
209	"quota set",
210	"permission update",
211	"permission remove",
212	"permission who remove",
213	"promote",
214	"receive",
215	"rename",
216	"reservation set",
217	"replay_inc_sync",
218	"replay_full_sync",
219	"rollback",
220	"snapshot",
221	"filesystem version upgrade",
222	"refquota set",
223	"refreservation set",
224	"pool scrub done",
225	"user hold",
226	"user release",
227	"pool split",
228};
229
230boolean_t
231zfs_dataset_name_hidden(const char *name)
232{
233	/*
234	 * Skip over datasets that are not visible in this zone,
235	 * internal datasets (which have a $ in their name), and
236	 * temporary datasets (which have a % in their name).
237	 */
238	if (strpbrk(name, "$%") != NULL)
239		return (B_TRUE);
240	if (!INGLOBALZONE(curproc) && !zone_dataset_visible(name, NULL))
241		return (B_TRUE);
242	return (B_FALSE);
243}
244
245#if defined(_KERNEL)
246EXPORT_SYMBOL(zfs_allocatable_devs);
247EXPORT_SYMBOL(zfs_special_devs);
248EXPORT_SYMBOL(zpool_get_load_policy);
249EXPORT_SYMBOL(zfs_zpl_version_map);
250EXPORT_SYMBOL(zfs_spa_version_map);
251EXPORT_SYMBOL(zfs_history_event_names);
252EXPORT_SYMBOL(zfs_dataset_name_hidden);
253#endif
254