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.
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.
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]
23 * Copyright (c) 2012 by Delphix. All rights reserved.
26 #include <sys/nvpair.h>
28 #include <sys/debug.h>
34 * "Force" nvlist wrapper.
36 * These functions wrap the nvlist_* functions with assertions that assume
37 * the operation is successful. This allows the caller's code to be much
38 * more readable, especially for the fnvlist_lookup_* and fnvpair_value_*
39 * functions, which can return the requested value (rather than filling in
42 * These functions use NV_UNIQUE_NAME, encoding NV_ENCODE_NATIVE, and allocate
45 * More wrappers should be added as needed -- for example
46 * nvlist_lookup_*_array and nvpair_value_*_array.
53 VERIFY3U(nvlist_alloc(&nvl
, NV_UNIQUE_NAME
, KM_SLEEP
), ==, 0);
58 fnvlist_free(nvlist_t
*nvl
)
64 fnvlist_size(nvlist_t
*nvl
)
67 VERIFY3U(nvlist_size(nvl
, &size
, NV_ENCODE_NATIVE
), ==, 0);
72 * Returns allocated buffer of size *sizep. Caller must free the buffer with
73 * fnvlist_pack_free().
76 fnvlist_pack(nvlist_t
*nvl
, size_t *sizep
)
79 VERIFY3U(nvlist_pack(nvl
, &packed
, sizep
, NV_ENCODE_NATIVE
,
86 fnvlist_pack_free(char *pack
, size_t size
)
89 kmem_free(pack
, size
);
96 fnvlist_unpack(char *buf
, size_t buflen
)
99 VERIFY3U(nvlist_unpack(buf
, buflen
, &rv
, KM_SLEEP
), ==, 0);
104 fnvlist_dup(nvlist_t
*nvl
)
107 VERIFY3U(nvlist_dup(nvl
, &rv
, KM_SLEEP
), ==, 0);
112 fnvlist_merge(nvlist_t
*dst
, nvlist_t
*src
)
114 VERIFY3U(nvlist_merge(dst
, src
, KM_SLEEP
), ==, 0);
118 fnvlist_add_boolean(nvlist_t
*nvl
, const char *name
)
120 VERIFY3U(nvlist_add_boolean(nvl
, name
), ==, 0);
124 fnvlist_add_boolean_value(nvlist_t
*nvl
, const char *name
, boolean_t val
)
126 VERIFY3U(nvlist_add_boolean_value(nvl
, name
, val
), ==, 0);
130 fnvlist_add_byte(nvlist_t
*nvl
, const char *name
, uchar_t val
)
132 VERIFY3U(nvlist_add_byte(nvl
, name
, val
), ==, 0);
136 fnvlist_add_int8(nvlist_t
*nvl
, const char *name
, int8_t val
)
138 VERIFY3U(nvlist_add_int8(nvl
, name
, val
), ==, 0);
142 fnvlist_add_uint8(nvlist_t
*nvl
, const char *name
, uint8_t val
)
144 VERIFY3U(nvlist_add_uint8(nvl
, name
, val
), ==, 0);
148 fnvlist_add_int16(nvlist_t
*nvl
, const char *name
, int16_t val
)
150 VERIFY3U(nvlist_add_int16(nvl
, name
, val
), ==, 0);
154 fnvlist_add_uint16(nvlist_t
*nvl
, const char *name
, uint16_t val
)
156 VERIFY3U(nvlist_add_uint16(nvl
, name
, val
), ==, 0);
160 fnvlist_add_int32(nvlist_t
*nvl
, const char *name
, int32_t val
)
162 VERIFY3U(nvlist_add_int32(nvl
, name
, val
), ==, 0);
166 fnvlist_add_uint32(nvlist_t
*nvl
, const char *name
, uint32_t val
)
168 VERIFY3U(nvlist_add_uint32(nvl
, name
, val
), ==, 0);
172 fnvlist_add_int64(nvlist_t
*nvl
, const char *name
, int64_t val
)
174 VERIFY3U(nvlist_add_int64(nvl
, name
, val
), ==, 0);
178 fnvlist_add_uint64(nvlist_t
*nvl
, const char *name
, uint64_t val
)
180 VERIFY3U(nvlist_add_uint64(nvl
, name
, val
), ==, 0);
184 fnvlist_add_string(nvlist_t
*nvl
, const char *name
, const char *val
)
186 VERIFY3U(nvlist_add_string(nvl
, name
, val
), ==, 0);
190 fnvlist_add_nvlist(nvlist_t
*nvl
, const char *name
, nvlist_t
*val
)
192 VERIFY3U(nvlist_add_nvlist(nvl
, name
, val
), ==, 0);
196 fnvlist_add_nvpair(nvlist_t
*nvl
, nvpair_t
*pair
)
198 VERIFY3U(nvlist_add_nvpair(nvl
, pair
), ==, 0);
202 fnvlist_add_boolean_array(nvlist_t
*nvl
, const char *name
,
203 boolean_t
*val
, uint_t n
)
205 VERIFY3U(nvlist_add_boolean_array(nvl
, name
, val
, n
), ==, 0);
209 fnvlist_add_byte_array(nvlist_t
*nvl
, const char *name
, uchar_t
*val
, uint_t n
)
211 VERIFY3U(nvlist_add_byte_array(nvl
, name
, val
, n
), ==, 0);
215 fnvlist_add_int8_array(nvlist_t
*nvl
, const char *name
, int8_t *val
, uint_t n
)
217 VERIFY3U(nvlist_add_int8_array(nvl
, name
, val
, n
), ==, 0);
221 fnvlist_add_uint8_array(nvlist_t
*nvl
, const char *name
, uint8_t *val
, uint_t n
)
223 VERIFY3U(nvlist_add_uint8_array(nvl
, name
, val
, n
), ==, 0);
227 fnvlist_add_int16_array(nvlist_t
*nvl
, const char *name
, int16_t *val
, uint_t n
)
229 VERIFY3U(nvlist_add_int16_array(nvl
, name
, val
, n
), ==, 0);
233 fnvlist_add_uint16_array(nvlist_t
*nvl
, const char *name
,
234 uint16_t *val
, uint_t n
)
236 VERIFY3U(nvlist_add_uint16_array(nvl
, name
, val
, n
), ==, 0);
240 fnvlist_add_int32_array(nvlist_t
*nvl
, const char *name
, int32_t *val
, uint_t n
)
242 VERIFY3U(nvlist_add_int32_array(nvl
, name
, val
, n
), ==, 0);
246 fnvlist_add_uint32_array(nvlist_t
*nvl
, const char *name
,
247 uint32_t *val
, uint_t n
)
249 VERIFY3U(nvlist_add_uint32_array(nvl
, name
, val
, n
), ==, 0);
253 fnvlist_add_int64_array(nvlist_t
*nvl
, const char *name
, int64_t *val
, uint_t n
)
255 VERIFY3U(nvlist_add_int64_array(nvl
, name
, val
, n
), ==, 0);
259 fnvlist_add_uint64_array(nvlist_t
*nvl
, const char *name
,
260 uint64_t *val
, uint_t n
)
262 VERIFY3U(nvlist_add_uint64_array(nvl
, name
, val
, n
), ==, 0);
266 fnvlist_add_string_array(nvlist_t
*nvl
, const char *name
,
267 char * const *val
, uint_t n
)
269 VERIFY3U(nvlist_add_string_array(nvl
, name
, val
, n
), ==, 0);
273 fnvlist_add_nvlist_array(nvlist_t
*nvl
, const char *name
,
274 nvlist_t
**val
, uint_t n
)
276 VERIFY3U(nvlist_add_nvlist_array(nvl
, name
, val
, n
), ==, 0);
280 fnvlist_remove(nvlist_t
*nvl
, const char *name
)
282 VERIFY3U(nvlist_remove_all(nvl
, name
), ==, 0);
286 fnvlist_remove_nvpair(nvlist_t
*nvl
, nvpair_t
*pair
)
288 VERIFY3U(nvlist_remove_nvpair(nvl
, pair
), ==, 0);
292 fnvlist_lookup_nvpair(nvlist_t
*nvl
, const char *name
)
295 VERIFY3U(nvlist_lookup_nvpair(nvl
, name
, &rv
), ==, 0);
299 /* returns B_TRUE if the entry exists */
301 fnvlist_lookup_boolean(nvlist_t
*nvl
, const char *name
)
303 return (nvlist_lookup_boolean(nvl
, name
) == 0);
307 fnvlist_lookup_boolean_value(nvlist_t
*nvl
, const char *name
)
310 VERIFY3U(nvlist_lookup_boolean_value(nvl
, name
, &rv
), ==, 0);
315 fnvlist_lookup_byte(nvlist_t
*nvl
, const char *name
)
318 VERIFY3U(nvlist_lookup_byte(nvl
, name
, &rv
), ==, 0);
323 fnvlist_lookup_int8(nvlist_t
*nvl
, const char *name
)
326 VERIFY3U(nvlist_lookup_int8(nvl
, name
, &rv
), ==, 0);
331 fnvlist_lookup_int16(nvlist_t
*nvl
, const char *name
)
334 VERIFY3U(nvlist_lookup_int16(nvl
, name
, &rv
), ==, 0);
339 fnvlist_lookup_int32(nvlist_t
*nvl
, const char *name
)
342 VERIFY3U(nvlist_lookup_int32(nvl
, name
, &rv
), ==, 0);
347 fnvlist_lookup_int64(nvlist_t
*nvl
, const char *name
)
350 VERIFY3U(nvlist_lookup_int64(nvl
, name
, &rv
), ==, 0);
355 fnvlist_lookup_uint8(nvlist_t
*nvl
, const char *name
)
358 VERIFY3U(nvlist_lookup_uint8(nvl
, name
, &rv
), ==, 0);
363 fnvlist_lookup_uint16(nvlist_t
*nvl
, const char *name
)
366 VERIFY3U(nvlist_lookup_uint16(nvl
, name
, &rv
), ==, 0);
371 fnvlist_lookup_uint32(nvlist_t
*nvl
, const char *name
)
374 VERIFY3U(nvlist_lookup_uint32(nvl
, name
, &rv
), ==, 0);
379 fnvlist_lookup_uint64(nvlist_t
*nvl
, const char *name
)
382 VERIFY3U(nvlist_lookup_uint64(nvl
, name
, &rv
), ==, 0);
387 fnvlist_lookup_string(nvlist_t
*nvl
, const char *name
)
390 VERIFY3U(nvlist_lookup_string(nvl
, name
, &rv
), ==, 0);
395 fnvlist_lookup_nvlist(nvlist_t
*nvl
, const char *name
)
398 VERIFY3U(nvlist_lookup_nvlist(nvl
, name
, &rv
), ==, 0);
403 fnvpair_value_boolean_value(nvpair_t
*nvp
)
406 VERIFY3U(nvpair_value_boolean_value(nvp
, &rv
), ==, 0);
411 fnvpair_value_byte(nvpair_t
*nvp
)
414 VERIFY3U(nvpair_value_byte(nvp
, &rv
), ==, 0);
419 fnvpair_value_int8(nvpair_t
*nvp
)
422 VERIFY3U(nvpair_value_int8(nvp
, &rv
), ==, 0);
427 fnvpair_value_int16(nvpair_t
*nvp
)
430 VERIFY3U(nvpair_value_int16(nvp
, &rv
), ==, 0);
435 fnvpair_value_int32(nvpair_t
*nvp
)
438 VERIFY3U(nvpair_value_int32(nvp
, &rv
), ==, 0);
443 fnvpair_value_int64(nvpair_t
*nvp
)
446 VERIFY3U(nvpair_value_int64(nvp
, &rv
), ==, 0);
451 fnvpair_value_uint8(nvpair_t
*nvp
)
454 VERIFY3U(nvpair_value_uint8(nvp
, &rv
), ==, 0);
459 fnvpair_value_uint16(nvpair_t
*nvp
)
462 VERIFY3U(nvpair_value_uint16(nvp
, &rv
), ==, 0);
467 fnvpair_value_uint32(nvpair_t
*nvp
)
470 VERIFY3U(nvpair_value_uint32(nvp
, &rv
), ==, 0);
475 fnvpair_value_uint64(nvpair_t
*nvp
)
478 VERIFY3U(nvpair_value_uint64(nvp
, &rv
), ==, 0);
483 fnvpair_value_string(nvpair_t
*nvp
)
486 VERIFY3U(nvpair_value_string(nvp
, &rv
), ==, 0);
491 fnvpair_value_nvlist(nvpair_t
*nvp
)
494 VERIFY3U(nvpair_value_nvlist(nvp
, &rv
), ==, 0);
498 #if defined(_KERNEL) && defined(HAVE_SPL)
500 EXPORT_SYMBOL(fnvlist_alloc
);
501 EXPORT_SYMBOL(fnvlist_free
);
502 EXPORT_SYMBOL(fnvlist_size
);
503 EXPORT_SYMBOL(fnvlist_pack
);
504 EXPORT_SYMBOL(fnvlist_unpack
);
505 EXPORT_SYMBOL(fnvlist_dup
);
506 EXPORT_SYMBOL(fnvlist_merge
);
508 EXPORT_SYMBOL(fnvlist_add_nvpair
);
509 EXPORT_SYMBOL(fnvlist_add_boolean
);
510 EXPORT_SYMBOL(fnvlist_add_boolean_value
);
511 EXPORT_SYMBOL(fnvlist_add_byte
);
512 EXPORT_SYMBOL(fnvlist_add_int8
);
513 EXPORT_SYMBOL(fnvlist_add_uint8
);
514 EXPORT_SYMBOL(fnvlist_add_int16
);
515 EXPORT_SYMBOL(fnvlist_add_uint16
);
516 EXPORT_SYMBOL(fnvlist_add_int32
);
517 EXPORT_SYMBOL(fnvlist_add_uint32
);
518 EXPORT_SYMBOL(fnvlist_add_int64
);
519 EXPORT_SYMBOL(fnvlist_add_uint64
);
520 EXPORT_SYMBOL(fnvlist_add_string
);
521 EXPORT_SYMBOL(fnvlist_add_nvlist
);
522 EXPORT_SYMBOL(fnvlist_add_boolean_array
);
523 EXPORT_SYMBOL(fnvlist_add_byte_array
);
524 EXPORT_SYMBOL(fnvlist_add_int8_array
);
525 EXPORT_SYMBOL(fnvlist_add_uint8_array
);
526 EXPORT_SYMBOL(fnvlist_add_int16_array
);
527 EXPORT_SYMBOL(fnvlist_add_uint16_array
);
528 EXPORT_SYMBOL(fnvlist_add_int32_array
);
529 EXPORT_SYMBOL(fnvlist_add_uint32_array
);
530 EXPORT_SYMBOL(fnvlist_add_int64_array
);
531 EXPORT_SYMBOL(fnvlist_add_uint64_array
);
532 EXPORT_SYMBOL(fnvlist_add_string_array
);
533 EXPORT_SYMBOL(fnvlist_add_nvlist_array
);
535 EXPORT_SYMBOL(fnvlist_remove
);
536 EXPORT_SYMBOL(fnvlist_remove_nvpair
);
538 EXPORT_SYMBOL(fnvlist_lookup_nvpair
);
539 EXPORT_SYMBOL(fnvlist_lookup_boolean
);
540 EXPORT_SYMBOL(fnvlist_lookup_boolean_value
);
541 EXPORT_SYMBOL(fnvlist_lookup_byte
);
542 EXPORT_SYMBOL(fnvlist_lookup_int8
);
543 EXPORT_SYMBOL(fnvlist_lookup_uint8
);
544 EXPORT_SYMBOL(fnvlist_lookup_int16
);
545 EXPORT_SYMBOL(fnvlist_lookup_uint16
);
546 EXPORT_SYMBOL(fnvlist_lookup_int32
);
547 EXPORT_SYMBOL(fnvlist_lookup_uint32
);
548 EXPORT_SYMBOL(fnvlist_lookup_int64
);
549 EXPORT_SYMBOL(fnvlist_lookup_uint64
);
550 EXPORT_SYMBOL(fnvlist_lookup_string
);
551 EXPORT_SYMBOL(fnvlist_lookup_nvlist
);
553 EXPORT_SYMBOL(fnvpair_value_boolean_value
);
554 EXPORT_SYMBOL(fnvpair_value_byte
);
555 EXPORT_SYMBOL(fnvpair_value_int8
);
556 EXPORT_SYMBOL(fnvpair_value_uint8
);
557 EXPORT_SYMBOL(fnvpair_value_int16
);
558 EXPORT_SYMBOL(fnvpair_value_uint16
);
559 EXPORT_SYMBOL(fnvpair_value_int32
);
560 EXPORT_SYMBOL(fnvpair_value_uint32
);
561 EXPORT_SYMBOL(fnvpair_value_int64
);
562 EXPORT_SYMBOL(fnvpair_value_uint64
);
563 EXPORT_SYMBOL(fnvpair_value_string
);
564 EXPORT_SYMBOL(fnvpair_value_nvlist
);