5 * The contents of this file are subject to the terms of the
6 * Common Development and Distribution License (the "License").
7 * You may not use this file except in compliance with the License.
9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 * or http://www.opensolaris.org/os/licensing.
11 * See the License for the specific language governing permissions
12 * and limitations under the License.
14 * When distributing Covered Code, include this CDDL HEADER in each
15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 * If applicable, add the following below this CDDL HEADER, with the
17 * fields enclosed by brackets "[]" replaced with your own identifying
18 * information: Portions Copyright [yyyy] [name of copyright owner]
24 * Copyright (c) 2012 by Delphix. All rights reserved.
27 #include <sys/nvpair.h>
29 #include <sys/zfs_context.h>
31 #include <sys/debug.h>
33 #include <sys/param.h>
34 #include <sys/debug.h>
38 * "Force" nvlist wrapper.
40 * These functions wrap the nvlist_* functions with assertions that assume
41 * the operation is successful. This allows the caller's code to be much
42 * more readable, especially for the fnvlist_lookup_* and fnvpair_value_*
43 * functions, which can return the requested value (rather than filling in
46 * These functions use NV_UNIQUE_NAME, encoding NV_ENCODE_NATIVE, and allocate
49 * More wrappers should be added as needed -- for example
50 * nvlist_lookup_*_array and nvpair_value_*_array.
57 VERIFY0(nvlist_alloc(&nvl, NV_UNIQUE_NAME, KM_SLEEP));
62 fnvlist_free(nvlist_t *nvl)
68 fnvlist_size(nvlist_t *nvl)
71 VERIFY0(nvlist_size(nvl, &size, NV_ENCODE_NATIVE));
76 * Returns allocated buffer of size *sizep. Caller must free the buffer with
77 * fnvlist_pack_free().
80 fnvlist_pack(nvlist_t *nvl, size_t *sizep)
83 VERIFY3U(nvlist_pack(nvl, &packed, sizep, NV_ENCODE_NATIVE,
90 fnvlist_pack_free(char *pack, size_t size)
93 kmem_free(pack, size);
100 fnvlist_unpack(char *buf, size_t buflen)
103 VERIFY0(nvlist_unpack(buf, buflen, &rv, KM_SLEEP));
108 fnvlist_dup(nvlist_t *nvl)
111 VERIFY0(nvlist_dup(nvl, &rv, KM_SLEEP));
116 fnvlist_merge(nvlist_t *dst, nvlist_t *src)
118 VERIFY0(nvlist_merge(dst, src, KM_SLEEP));
122 fnvlist_num_pairs(nvlist_t *nvl)
127 for (pair = nvlist_next_nvpair(nvl, 0); pair != NULL;
128 pair = nvlist_next_nvpair(nvl, pair))
134 fnvlist_add_boolean(nvlist_t *nvl, const char *name)
136 VERIFY0(nvlist_add_boolean(nvl, name));
140 fnvlist_add_boolean_value(nvlist_t *nvl, const char *name, boolean_t val)
142 VERIFY0(nvlist_add_boolean_value(nvl, name, val));
146 fnvlist_add_byte(nvlist_t *nvl, const char *name, uchar_t val)
148 VERIFY0(nvlist_add_byte(nvl, name, val));
152 fnvlist_add_int8(nvlist_t *nvl, const char *name, int8_t val)
154 VERIFY0(nvlist_add_int8(nvl, name, val));
158 fnvlist_add_uint8(nvlist_t *nvl, const char *name, uint8_t val)
160 VERIFY0(nvlist_add_uint8(nvl, name, val));
164 fnvlist_add_int16(nvlist_t *nvl, const char *name, int16_t val)
166 VERIFY0(nvlist_add_int16(nvl, name, val));
170 fnvlist_add_uint16(nvlist_t *nvl, const char *name, uint16_t val)
172 VERIFY0(nvlist_add_uint16(nvl, name, val));
176 fnvlist_add_int32(nvlist_t *nvl, const char *name, int32_t val)
178 VERIFY0(nvlist_add_int32(nvl, name, val));
182 fnvlist_add_uint32(nvlist_t *nvl, const char *name, uint32_t val)
184 VERIFY0(nvlist_add_uint32(nvl, name, val));
188 fnvlist_add_int64(nvlist_t *nvl, const char *name, int64_t val)
190 VERIFY0(nvlist_add_int64(nvl, name, val));
194 fnvlist_add_uint64(nvlist_t *nvl, const char *name, uint64_t val)
196 VERIFY0(nvlist_add_uint64(nvl, name, val));
200 fnvlist_add_string(nvlist_t *nvl, const char *name, const char *val)
202 VERIFY0(nvlist_add_string(nvl, name, val));
206 fnvlist_add_nvlist(nvlist_t *nvl, const char *name, nvlist_t *val)
208 VERIFY0(nvlist_add_nvlist(nvl, name, val));
212 fnvlist_add_nvpair(nvlist_t *nvl, nvpair_t *pair)
214 VERIFY0(nvlist_add_nvpair(nvl, pair));
218 fnvlist_add_boolean_array(nvlist_t *nvl, const char *name,
219 boolean_t *val, uint_t n)
221 VERIFY0(nvlist_add_boolean_array(nvl, name, val, n));
225 fnvlist_add_byte_array(nvlist_t *nvl, const char *name, uchar_t *val, uint_t n)
227 VERIFY0(nvlist_add_byte_array(nvl, name, val, n));
231 fnvlist_add_int8_array(nvlist_t *nvl, const char *name, int8_t *val, uint_t n)
233 VERIFY0(nvlist_add_int8_array(nvl, name, val, n));
237 fnvlist_add_uint8_array(nvlist_t *nvl, const char *name, uint8_t *val, uint_t n)
239 VERIFY0(nvlist_add_uint8_array(nvl, name, val, n));
243 fnvlist_add_int16_array(nvlist_t *nvl, const char *name, int16_t *val, uint_t n)
245 VERIFY0(nvlist_add_int16_array(nvl, name, val, n));
249 fnvlist_add_uint16_array(nvlist_t *nvl, const char *name,
250 uint16_t *val, uint_t n)
252 VERIFY0(nvlist_add_uint16_array(nvl, name, val, n));
256 fnvlist_add_int32_array(nvlist_t *nvl, const char *name, int32_t *val, uint_t n)
258 VERIFY0(nvlist_add_int32_array(nvl, name, val, n));
262 fnvlist_add_uint32_array(nvlist_t *nvl, const char *name,
263 uint32_t *val, uint_t n)
265 VERIFY0(nvlist_add_uint32_array(nvl, name, val, n));
269 fnvlist_add_int64_array(nvlist_t *nvl, const char *name, int64_t *val, uint_t n)
271 VERIFY0(nvlist_add_int64_array(nvl, name, val, n));
275 fnvlist_add_uint64_array(nvlist_t *nvl, const char *name,
276 uint64_t *val, uint_t n)
278 VERIFY0(nvlist_add_uint64_array(nvl, name, val, n));
282 fnvlist_add_string_array(nvlist_t *nvl, const char *name,
283 char * const *val, uint_t n)
285 VERIFY0(nvlist_add_string_array(nvl, name, val, n));
289 fnvlist_add_nvlist_array(nvlist_t *nvl, const char *name,
290 nvlist_t **val, uint_t n)
292 VERIFY0(nvlist_add_nvlist_array(nvl, name, val, n));
296 fnvlist_remove(nvlist_t *nvl, const char *name)
298 VERIFY0(nvlist_remove_all(nvl, name));
302 fnvlist_remove_nvpair(nvlist_t *nvl, nvpair_t *pair)
304 VERIFY0(nvlist_remove_nvpair(nvl, pair));
308 fnvlist_lookup_nvpair(nvlist_t *nvl, const char *name)
311 VERIFY0(nvlist_lookup_nvpair(nvl, name, &rv));
315 /* returns B_TRUE if the entry exists */
317 fnvlist_lookup_boolean(nvlist_t *nvl, const char *name)
319 return (nvlist_lookup_boolean(nvl, name) == 0);
323 fnvlist_lookup_boolean_value(nvlist_t *nvl, const char *name)
326 VERIFY0(nvlist_lookup_boolean_value(nvl, name, &rv));
331 fnvlist_lookup_byte(nvlist_t *nvl, const char *name)
334 VERIFY0(nvlist_lookup_byte(nvl, name, &rv));
339 fnvlist_lookup_int8(nvlist_t *nvl, const char *name)
342 VERIFY0(nvlist_lookup_int8(nvl, name, &rv));
347 fnvlist_lookup_int16(nvlist_t *nvl, const char *name)
350 VERIFY0(nvlist_lookup_int16(nvl, name, &rv));
355 fnvlist_lookup_int32(nvlist_t *nvl, const char *name)
358 VERIFY0(nvlist_lookup_int32(nvl, name, &rv));
363 fnvlist_lookup_int64(nvlist_t *nvl, const char *name)
366 VERIFY0(nvlist_lookup_int64(nvl, name, &rv));
371 fnvlist_lookup_uint8_t(nvlist_t *nvl, const char *name)
374 VERIFY0(nvlist_lookup_uint8(nvl, name, &rv));
379 fnvlist_lookup_uint16(nvlist_t *nvl, const char *name)
382 VERIFY0(nvlist_lookup_uint16(nvl, name, &rv));
387 fnvlist_lookup_uint32(nvlist_t *nvl, const char *name)
390 VERIFY0(nvlist_lookup_uint32(nvl, name, &rv));
395 fnvlist_lookup_uint64(nvlist_t *nvl, const char *name)
398 VERIFY0(nvlist_lookup_uint64(nvl, name, &rv));
403 fnvlist_lookup_string(nvlist_t *nvl, const char *name)
406 VERIFY0(nvlist_lookup_string(nvl, name, &rv));
411 fnvlist_lookup_nvlist(nvlist_t *nvl, const char *name)
414 VERIFY0(nvlist_lookup_nvlist(nvl, name, &rv));
419 fnvpair_value_boolean_value(nvpair_t *nvp)
422 VERIFY0(nvpair_value_boolean_value(nvp, &rv));
427 fnvpair_value_byte(nvpair_t *nvp)
430 VERIFY0(nvpair_value_byte(nvp, &rv));
435 fnvpair_value_int8(nvpair_t *nvp)
438 VERIFY0(nvpair_value_int8(nvp, &rv));
443 fnvpair_value_int16(nvpair_t *nvp)
446 VERIFY0(nvpair_value_int16(nvp, &rv));
451 fnvpair_value_int32(nvpair_t *nvp)
454 VERIFY0(nvpair_value_int32(nvp, &rv));
459 fnvpair_value_int64(nvpair_t *nvp)
462 VERIFY0(nvpair_value_int64(nvp, &rv));
467 fnvpair_value_uint8_t(nvpair_t *nvp)
470 VERIFY0(nvpair_value_uint8(nvp, &rv));
475 fnvpair_value_uint16(nvpair_t *nvp)
478 VERIFY0(nvpair_value_uint16(nvp, &rv));
483 fnvpair_value_uint32(nvpair_t *nvp)
486 VERIFY0(nvpair_value_uint32(nvp, &rv));
491 fnvpair_value_uint64(nvpair_t *nvp)
494 VERIFY0(nvpair_value_uint64(nvp, &rv));
499 fnvpair_value_string(nvpair_t *nvp)
502 VERIFY0(nvpair_value_string(nvp, &rv));
507 fnvpair_value_nvlist(nvpair_t *nvp)
510 VERIFY0(nvpair_value_nvlist(nvp, &rv));