Print this page
6447 handful of nvpair cleanups
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/common/nvpair/nvpair.c
+++ new/usr/src/common/nvpair/nvpair.c
1 1 /*
2 2 * CDDL HEADER START
3 3 *
4 4 * The contents of this file are subject to the terms of the
5 5 * Common Development and Distribution License (the "License").
6 6 * You may not use this file except in compliance with the License.
7 7 *
8 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 * or http://www.opensolaris.org/os/licensing.
10 10 * See the License for the specific language governing permissions
11 11 * and limitations under the License.
12 12 *
13 13 * When distributing Covered Code, include this CDDL HEADER in each
14 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 * If applicable, add the following below this CDDL HEADER, with the
16 16 * fields enclosed by brackets "[]" replaced with your own identifying
17 17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21
22 22 /*
23 23 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
24 24 */
25 25
26 26 #include <sys/stropts.h>
27 27 #include <sys/debug.h>
28 28 #include <sys/isa_defs.h>
29 29 #include <sys/int_limits.h>
30 30 #include <sys/nvpair.h>
31 31 #include <sys/nvpair_impl.h>
32 32 #include <rpc/types.h>
33 33 #include <rpc/xdr.h>
34 34
35 35 #if defined(_KERNEL) && !defined(_BOOT)
36 36 #include <sys/varargs.h>
37 37 #include <sys/ddi.h>
38 38 #include <sys/sunddi.h>
39 39 #else
40 40 #include <stdarg.h>
41 41 #include <stdlib.h>
42 42 #include <string.h>
43 43 #include <strings.h>
44 44 #endif
45 45
46 46 #ifndef offsetof
47 47 #define offsetof(s, m) ((size_t)(&(((s *)0)->m)))
48 48 #endif
49 49 #define skip_whitespace(p) while ((*(p) == ' ') || (*(p) == '\t')) p++
50 50
51 51 /*
52 52 * nvpair.c - Provides kernel & userland interfaces for manipulating
53 53 * name-value pairs.
54 54 *
55 55 * Overview Diagram
56 56 *
57 57 * +--------------+
58 58 * | nvlist_t |
59 59 * |--------------|
60 60 * | nvl_version |
61 61 * | nvl_nvflag |
62 62 * | nvl_priv -+-+
63 63 * | nvl_flag | |
64 64 * | nvl_pad | |
65 65 * +--------------+ |
66 66 * V
67 67 * +--------------+ last i_nvp in list
68 68 * | nvpriv_t | +--------------------->
69 69 * |--------------| |
70 70 * +--+- nvp_list | | +------------+
71 71 * | | nvp_last -+--+ + nv_alloc_t |
72 72 * | | nvp_curr | |------------|
73 73 * | | nvp_nva -+----> | nva_ops |
74 74 * | | nvp_stat | | nva_arg |
75 75 * | +--------------+ +------------+
76 76 * |
77 77 * +-------+
78 78 * V
79 79 * +---------------------+ +-------------------+
80 80 * | i_nvp_t | +-->| i_nvp_t | +-->
81 81 * |---------------------| | |-------------------| |
82 82 * | nvi_next -+--+ | nvi_next -+--+
83 83 * | nvi_prev (NULL) | <----+ nvi_prev |
84 84 * | . . . . . . . . . . | | . . . . . . . . . |
85 85 * | nvp (nvpair_t) | | nvp (nvpair_t) |
86 86 * | - nvp_size | | - nvp_size |
87 87 * | - nvp_name_sz | | - nvp_name_sz |
88 88 * | - nvp_value_elem | | - nvp_value_elem |
89 89 * | - nvp_type | | - nvp_type |
90 90 * | - data ... | | - data ... |
91 91 * +---------------------+ +-------------------+
92 92 *
93 93 *
94 94 *
95 95 * +---------------------+ +---------------------+
96 96 * | i_nvp_t | +--> +-->| i_nvp_t (last) |
97 97 * |---------------------| | | |---------------------|
98 98 * | nvi_next -+--+ ... --+ | nvi_next (NULL) |
99 99 * <-+- nvi_prev |<-- ... <----+ nvi_prev |
100 100 * | . . . . . . . . . | | . . . . . . . . . |
101 101 * | nvp (nvpair_t) | | nvp (nvpair_t) |
102 102 * | - nvp_size | | - nvp_size |
103 103 * | - nvp_name_sz | | - nvp_name_sz |
104 104 * | - nvp_value_elem | | - nvp_value_elem |
105 105 * | - DATA_TYPE_NVLIST | | - nvp_type |
106 106 * | - data (embedded) | | - data ... |
107 107 * | nvlist name | +---------------------+
108 108 * | +--------------+ |
109 109 * | | nvlist_t | |
110 110 * | |--------------| |
111 111 * | | nvl_version | |
112 112 * | | nvl_nvflag | |
113 113 * | | nvl_priv --+---+---->
114 114 * | | nvl_flag | |
115 115 * | | nvl_pad | |
116 116 * | +--------------+ |
117 117 * +---------------------+
118 118 *
119 119 *
120 120 * N.B. nvpair_t may be aligned on 4 byte boundary, so +4 will
121 121 * allow value to be aligned on 8 byte boundary
122 122 *
123 123 * name_len is the length of the name string including the null terminator
124 124 * so it must be >= 1
125 125 */
126 126 #define NVP_SIZE_CALC(name_len, data_len) \
127 127 (NV_ALIGN((sizeof (nvpair_t)) + name_len) + NV_ALIGN(data_len))
128 128
129 129 static int i_get_value_size(data_type_t type, const void *data, uint_t nelem);
130 130 static int nvlist_add_common(nvlist_t *nvl, const char *name, data_type_t type,
131 131 uint_t nelem, const void *data);
132 132
133 133 #define NV_STAT_EMBEDDED 0x1
134 134 #define EMBEDDED_NVL(nvp) ((nvlist_t *)(void *)NVP_VALUE(nvp))
135 135 #define EMBEDDED_NVL_ARRAY(nvp) ((nvlist_t **)(void *)NVP_VALUE(nvp))
136 136
137 137 #define NVP_VALOFF(nvp) (NV_ALIGN(sizeof (nvpair_t) + (nvp)->nvp_name_sz))
138 138 #define NVPAIR2I_NVP(nvp) \
139 139 ((i_nvp_t *)((size_t)(nvp) - offsetof(i_nvp_t, nvi_nvp)))
140 140
141 141
142 142 int
143 143 nv_alloc_init(nv_alloc_t *nva, const nv_alloc_ops_t *nvo, /* args */ ...)
144 144 {
145 145 va_list valist;
146 146 int err = 0;
147 147
148 148 nva->nva_ops = nvo;
149 149 nva->nva_arg = NULL;
150 150
151 151 va_start(valist, nvo);
152 152 if (nva->nva_ops->nv_ao_init != NULL)
153 153 err = nva->nva_ops->nv_ao_init(nva, valist);
154 154 va_end(valist);
155 155
156 156 return (err);
157 157 }
158 158
159 159 void
160 160 nv_alloc_reset(nv_alloc_t *nva)
161 161 {
162 162 if (nva->nva_ops->nv_ao_reset != NULL)
163 163 nva->nva_ops->nv_ao_reset(nva);
164 164 }
165 165
166 166 void
167 167 nv_alloc_fini(nv_alloc_t *nva)
168 168 {
169 169 if (nva->nva_ops->nv_ao_fini != NULL)
170 170 nva->nva_ops->nv_ao_fini(nva);
171 171 }
172 172
173 173 nv_alloc_t *
174 174 nvlist_lookup_nv_alloc(nvlist_t *nvl)
175 175 {
176 176 nvpriv_t *priv;
177 177
178 178 if (nvl == NULL ||
179 179 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
180 180 return (NULL);
181 181
182 182 return (priv->nvp_nva);
183 183 }
184 184
185 185 static void *
186 186 nv_mem_zalloc(nvpriv_t *nvp, size_t size)
187 187 {
188 188 nv_alloc_t *nva = nvp->nvp_nva;
189 189 void *buf;
190 190
191 191 if ((buf = nva->nva_ops->nv_ao_alloc(nva, size)) != NULL)
192 192 bzero(buf, size);
193 193
194 194 return (buf);
195 195 }
196 196
197 197 static void
198 198 nv_mem_free(nvpriv_t *nvp, void *buf, size_t size)
199 199 {
200 200 nv_alloc_t *nva = nvp->nvp_nva;
201 201
202 202 nva->nva_ops->nv_ao_free(nva, buf, size);
203 203 }
204 204
205 205 static void
206 206 nv_priv_init(nvpriv_t *priv, nv_alloc_t *nva, uint32_t stat)
207 207 {
208 208 bzero(priv, sizeof (nvpriv_t));
209 209
210 210 priv->nvp_nva = nva;
211 211 priv->nvp_stat = stat;
212 212 }
213 213
214 214 static nvpriv_t *
215 215 nv_priv_alloc(nv_alloc_t *nva)
216 216 {
217 217 nvpriv_t *priv;
218 218
219 219 /*
220 220 * nv_mem_alloc() cannot called here because it needs the priv
221 221 * argument.
222 222 */
223 223 if ((priv = nva->nva_ops->nv_ao_alloc(nva, sizeof (nvpriv_t))) == NULL)
224 224 return (NULL);
225 225
226 226 nv_priv_init(priv, nva, 0);
227 227
228 228 return (priv);
229 229 }
230 230
231 231 /*
232 232 * Embedded lists need their own nvpriv_t's. We create a new
233 233 * nvpriv_t using the parameters and allocator from the parent
234 234 * list's nvpriv_t.
235 235 */
236 236 static nvpriv_t *
237 237 nv_priv_alloc_embedded(nvpriv_t *priv)
238 238 {
239 239 nvpriv_t *emb_priv;
240 240
241 241 if ((emb_priv = nv_mem_zalloc(priv, sizeof (nvpriv_t))) == NULL)
242 242 return (NULL);
243 243
244 244 nv_priv_init(emb_priv, priv->nvp_nva, NV_STAT_EMBEDDED);
245 245
246 246 return (emb_priv);
247 247 }
248 248
249 249 static void
250 250 nvlist_init(nvlist_t *nvl, uint32_t nvflag, nvpriv_t *priv)
251 251 {
252 252 nvl->nvl_version = NV_VERSION;
253 253 nvl->nvl_nvflag = nvflag & (NV_UNIQUE_NAME|NV_UNIQUE_NAME_TYPE);
254 254 nvl->nvl_priv = (uint64_t)(uintptr_t)priv;
255 255 nvl->nvl_flag = 0;
256 256 nvl->nvl_pad = 0;
257 257 }
258 258
259 259 uint_t
260 260 nvlist_nvflag(nvlist_t *nvl)
261 261 {
262 262 return (nvl->nvl_nvflag);
263 263 }
264 264
265 265 /*
266 266 * nvlist_alloc - Allocate nvlist.
267 267 */
268 268 /*ARGSUSED1*/
269 269 int
270 270 nvlist_alloc(nvlist_t **nvlp, uint_t nvflag, int kmflag)
271 271 {
272 272 #if defined(_KERNEL) && !defined(_BOOT)
273 273 return (nvlist_xalloc(nvlp, nvflag,
274 274 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
275 275 #else
276 276 return (nvlist_xalloc(nvlp, nvflag, nv_alloc_nosleep));
277 277 #endif
278 278 }
279 279
280 280 int
281 281 nvlist_xalloc(nvlist_t **nvlp, uint_t nvflag, nv_alloc_t *nva)
282 282 {
283 283 nvpriv_t *priv;
284 284
285 285 if (nvlp == NULL || nva == NULL)
286 286 return (EINVAL);
287 287
288 288 if ((priv = nv_priv_alloc(nva)) == NULL)
289 289 return (ENOMEM);
290 290
291 291 if ((*nvlp = nv_mem_zalloc(priv,
292 292 NV_ALIGN(sizeof (nvlist_t)))) == NULL) {
293 293 nv_mem_free(priv, priv, sizeof (nvpriv_t));
294 294 return (ENOMEM);
295 295 }
296 296
297 297 nvlist_init(*nvlp, nvflag, priv);
298 298
299 299 return (0);
300 300 }
301 301
302 302 /*
303 303 * nvp_buf_alloc - Allocate i_nvp_t for storing a new nv pair.
304 304 */
305 305 static nvpair_t *
306 306 nvp_buf_alloc(nvlist_t *nvl, size_t len)
307 307 {
308 308 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
309 309 i_nvp_t *buf;
310 310 nvpair_t *nvp;
311 311 size_t nvsize;
312 312
313 313 /*
314 314 * Allocate the buffer
315 315 */
316 316 nvsize = len + offsetof(i_nvp_t, nvi_nvp);
317 317
318 318 if ((buf = nv_mem_zalloc(priv, nvsize)) == NULL)
319 319 return (NULL);
320 320
321 321 nvp = &buf->nvi_nvp;
322 322 nvp->nvp_size = len;
323 323
324 324 return (nvp);
325 325 }
326 326
327 327 /*
328 328 * nvp_buf_free - de-Allocate an i_nvp_t.
329 329 */
330 330 static void
331 331 nvp_buf_free(nvlist_t *nvl, nvpair_t *nvp)
332 332 {
333 333 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
334 334 size_t nvsize = nvp->nvp_size + offsetof(i_nvp_t, nvi_nvp);
335 335
336 336 nv_mem_free(priv, NVPAIR2I_NVP(nvp), nvsize);
337 337 }
338 338
339 339 /*
340 340 * nvp_buf_link - link a new nv pair into the nvlist.
341 341 */
342 342 static void
343 343 nvp_buf_link(nvlist_t *nvl, nvpair_t *nvp)
344 344 {
345 345 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
346 346 i_nvp_t *curr = NVPAIR2I_NVP(nvp);
347 347
348 348 /* Put element at end of nvlist */
349 349 if (priv->nvp_list == NULL) {
350 350 priv->nvp_list = priv->nvp_last = curr;
351 351 } else {
352 352 curr->nvi_prev = priv->nvp_last;
353 353 priv->nvp_last->nvi_next = curr;
354 354 priv->nvp_last = curr;
355 355 }
356 356 }
357 357
358 358 /*
359 359 * nvp_buf_unlink - unlink an removed nvpair out of the nvlist.
360 360 */
361 361 static void
362 362 nvp_buf_unlink(nvlist_t *nvl, nvpair_t *nvp)
363 363 {
364 364 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
365 365 i_nvp_t *curr = NVPAIR2I_NVP(nvp);
366 366
367 367 /*
368 368 * protect nvlist_next_nvpair() against walking on freed memory.
369 369 */
370 370 if (priv->nvp_curr == curr)
371 371 priv->nvp_curr = curr->nvi_next;
372 372
373 373 if (curr == priv->nvp_list)
374 374 priv->nvp_list = curr->nvi_next;
375 375 else
376 376 curr->nvi_prev->nvi_next = curr->nvi_next;
377 377
378 378 if (curr == priv->nvp_last)
379 379 priv->nvp_last = curr->nvi_prev;
380 380 else
381 381 curr->nvi_next->nvi_prev = curr->nvi_prev;
382 382 }
383 383
384 384 /*
385 385 * take a nvpair type and number of elements and make sure the are valid
386 386 */
387 387 static int
388 388 i_validate_type_nelem(data_type_t type, uint_t nelem)
389 389 {
390 390 switch (type) {
391 391 case DATA_TYPE_BOOLEAN:
392 392 if (nelem != 0)
393 393 return (EINVAL);
394 394 break;
395 395 case DATA_TYPE_BOOLEAN_VALUE:
396 396 case DATA_TYPE_BYTE:
397 397 case DATA_TYPE_INT8:
398 398 case DATA_TYPE_UINT8:
399 399 case DATA_TYPE_INT16:
400 400 case DATA_TYPE_UINT16:
401 401 case DATA_TYPE_INT32:
402 402 case DATA_TYPE_UINT32:
403 403 case DATA_TYPE_INT64:
404 404 case DATA_TYPE_UINT64:
405 405 case DATA_TYPE_STRING:
406 406 case DATA_TYPE_HRTIME:
407 407 case DATA_TYPE_NVLIST:
408 408 #if !defined(_KERNEL)
409 409 case DATA_TYPE_DOUBLE:
410 410 #endif
411 411 if (nelem != 1)
412 412 return (EINVAL);
413 413 break;
414 414 case DATA_TYPE_BOOLEAN_ARRAY:
415 415 case DATA_TYPE_BYTE_ARRAY:
416 416 case DATA_TYPE_INT8_ARRAY:
417 417 case DATA_TYPE_UINT8_ARRAY:
418 418 case DATA_TYPE_INT16_ARRAY:
419 419 case DATA_TYPE_UINT16_ARRAY:
420 420 case DATA_TYPE_INT32_ARRAY:
421 421 case DATA_TYPE_UINT32_ARRAY:
422 422 case DATA_TYPE_INT64_ARRAY:
423 423 case DATA_TYPE_UINT64_ARRAY:
424 424 case DATA_TYPE_STRING_ARRAY:
425 425 case DATA_TYPE_NVLIST_ARRAY:
426 426 /* we allow arrays with 0 elements */
427 427 break;
428 428 default:
429 429 return (EINVAL);
430 430 }
431 431 return (0);
432 432 }
433 433
434 434 /*
435 435 * Verify nvp_name_sz and check the name string length.
436 436 */
437 437 static int
438 438 i_validate_nvpair_name(nvpair_t *nvp)
439 439 {
440 440 if ((nvp->nvp_name_sz <= 0) ||
441 441 (nvp->nvp_size < NVP_SIZE_CALC(nvp->nvp_name_sz, 0)))
442 442 return (EFAULT);
443 443
444 444 /* verify the name string, make sure its terminated */
445 445 if (NVP_NAME(nvp)[nvp->nvp_name_sz - 1] != '\0')
446 446 return (EFAULT);
447 447
448 448 return (strlen(NVP_NAME(nvp)) == nvp->nvp_name_sz - 1 ? 0 : EFAULT);
449 449 }
450 450
451 451 static int
452 452 i_validate_nvpair_value(data_type_t type, uint_t nelem, const void *data)
453 453 {
454 454 switch (type) {
455 455 case DATA_TYPE_BOOLEAN_VALUE:
456 456 if (*(boolean_t *)data != B_TRUE &&
457 457 *(boolean_t *)data != B_FALSE)
458 458 return (EINVAL);
459 459 break;
460 460 case DATA_TYPE_BOOLEAN_ARRAY: {
461 461 int i;
462 462
463 463 for (i = 0; i < nelem; i++)
464 464 if (((boolean_t *)data)[i] != B_TRUE &&
465 465 ((boolean_t *)data)[i] != B_FALSE)
466 466 return (EINVAL);
467 467 break;
468 468 }
469 469 default:
470 470 break;
471 471 }
472 472
473 473 return (0);
474 474 }
475 475
476 476 /*
477 477 * This function takes a pointer to what should be a nvpair and it's size
478 478 * and then verifies that all the nvpair fields make sense and can be
479 479 * trusted. This function is used when decoding packed nvpairs.
480 480 */
481 481 static int
482 482 i_validate_nvpair(nvpair_t *nvp)
483 483 {
484 484 data_type_t type = NVP_TYPE(nvp);
485 485 int size1, size2;
486 486
487 487 /* verify nvp_name_sz, check the name string length */
488 488 if (i_validate_nvpair_name(nvp) != 0)
489 489 return (EFAULT);
490 490
491 491 if (i_validate_nvpair_value(type, NVP_NELEM(nvp), NVP_VALUE(nvp)) != 0)
492 492 return (EFAULT);
493 493
494 494 /*
495 495 * verify nvp_type, nvp_value_elem, and also possibly
496 496 * verify string values and get the value size.
497 497 */
498 498 size2 = i_get_value_size(type, NVP_VALUE(nvp), NVP_NELEM(nvp));
499 499 size1 = nvp->nvp_size - NVP_VALOFF(nvp);
500 500 if (size2 < 0 || size1 != NV_ALIGN(size2))
501 501 return (EFAULT);
502 502
503 503 return (0);
504 504 }
505 505
506 506 static int
507 507 nvlist_copy_pairs(nvlist_t *snvl, nvlist_t *dnvl)
508 508 {
509 509 nvpriv_t *priv;
510 510 i_nvp_t *curr;
511 511
512 512 if ((priv = (nvpriv_t *)(uintptr_t)snvl->nvl_priv) == NULL)
513 513 return (EINVAL);
514 514
515 515 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
516 516 nvpair_t *nvp = &curr->nvi_nvp;
517 517 int err;
518 518
519 519 if ((err = nvlist_add_common(dnvl, NVP_NAME(nvp), NVP_TYPE(nvp),
520 520 NVP_NELEM(nvp), NVP_VALUE(nvp))) != 0)
521 521 return (err);
522 522 }
523 523
524 524 return (0);
525 525 }
526 526
527 527 /*
528 528 * Frees all memory allocated for an nvpair (like embedded lists) with
529 529 * the exception of the nvpair buffer itself.
530 530 */
531 531 static void
532 532 nvpair_free(nvpair_t *nvp)
533 533 {
534 534 switch (NVP_TYPE(nvp)) {
535 535 case DATA_TYPE_NVLIST:
536 536 nvlist_free(EMBEDDED_NVL(nvp));
537 537 break;
538 538 case DATA_TYPE_NVLIST_ARRAY: {
539 539 nvlist_t **nvlp = EMBEDDED_NVL_ARRAY(nvp);
540 540 int i;
541 541
542 542 for (i = 0; i < NVP_NELEM(nvp); i++)
543 543 if (nvlp[i] != NULL)
544 544 nvlist_free(nvlp[i]);
545 545 break;
546 546 }
547 547 default:
548 548 break;
549 549 }
550 550 }
551 551
552 552 /*
553 553 * nvlist_free - free an unpacked nvlist
554 554 */
555 555 void
556 556 nvlist_free(nvlist_t *nvl)
557 557 {
558 558 nvpriv_t *priv;
559 559 i_nvp_t *curr;
560 560
561 561 if (nvl == NULL ||
562 562 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
563 563 return;
564 564
565 565 /*
566 566 * Unpacked nvlist are linked through i_nvp_t
567 567 */
568 568 curr = priv->nvp_list;
569 569 while (curr != NULL) {
570 570 nvpair_t *nvp = &curr->nvi_nvp;
571 571 curr = curr->nvi_next;
572 572
573 573 nvpair_free(nvp);
574 574 nvp_buf_free(nvl, nvp);
575 575 }
576 576
577 577 if (!(priv->nvp_stat & NV_STAT_EMBEDDED))
578 578 nv_mem_free(priv, nvl, NV_ALIGN(sizeof (nvlist_t)));
579 579 else
580 580 nvl->nvl_priv = 0;
581 581
582 582 nv_mem_free(priv, priv, sizeof (nvpriv_t));
583 583 }
584 584
585 585 static int
586 586 nvlist_contains_nvp(nvlist_t *nvl, nvpair_t *nvp)
587 587 {
588 588 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
589 589 i_nvp_t *curr;
590 590
591 591 if (nvp == NULL)
592 592 return (0);
593 593
594 594 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next)
595 595 if (&curr->nvi_nvp == nvp)
596 596 return (1);
597 597
598 598 return (0);
599 599 }
600 600
601 601 /*
602 602 * Make a copy of nvlist
603 603 */
604 604 /*ARGSUSED1*/
605 605 int
606 606 nvlist_dup(nvlist_t *nvl, nvlist_t **nvlp, int kmflag)
607 607 {
608 608 #if defined(_KERNEL) && !defined(_BOOT)
609 609 return (nvlist_xdup(nvl, nvlp,
610 610 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
611 611 #else
612 612 return (nvlist_xdup(nvl, nvlp, nv_alloc_nosleep));
613 613 #endif
614 614 }
615 615
616 616 int
617 617 nvlist_xdup(nvlist_t *nvl, nvlist_t **nvlp, nv_alloc_t *nva)
618 618 {
619 619 int err;
620 620 nvlist_t *ret;
621 621
622 622 if (nvl == NULL || nvlp == NULL)
623 623 return (EINVAL);
624 624
625 625 if ((err = nvlist_xalloc(&ret, nvl->nvl_nvflag, nva)) != 0)
626 626 return (err);
627 627
628 628 if ((err = nvlist_copy_pairs(nvl, ret)) != 0)
629 629 nvlist_free(ret);
630 630 else
631 631 *nvlp = ret;
632 632
633 633 return (err);
634 634 }
635 635
636 636 /*
637 637 * Remove all with matching name
638 638 */
639 639 int
640 640 nvlist_remove_all(nvlist_t *nvl, const char *name)
641 641 {
642 642 nvpriv_t *priv;
643 643 i_nvp_t *curr;
644 644 int error = ENOENT;
645 645
646 646 if (nvl == NULL || name == NULL ||
647 647 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
648 648 return (EINVAL);
649 649
650 650 curr = priv->nvp_list;
651 651 while (curr != NULL) {
652 652 nvpair_t *nvp = &curr->nvi_nvp;
653 653
654 654 curr = curr->nvi_next;
655 655 if (strcmp(name, NVP_NAME(nvp)) != 0)
656 656 continue;
657 657
658 658 nvp_buf_unlink(nvl, nvp);
659 659 nvpair_free(nvp);
660 660 nvp_buf_free(nvl, nvp);
661 661
662 662 error = 0;
663 663 }
664 664
665 665 return (error);
666 666 }
667 667
668 668 /*
669 669 * Remove first one with matching name and type
670 670 */
671 671 int
672 672 nvlist_remove(nvlist_t *nvl, const char *name, data_type_t type)
673 673 {
674 674 nvpriv_t *priv;
675 675 i_nvp_t *curr;
676 676
677 677 if (nvl == NULL || name == NULL ||
678 678 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
679 679 return (EINVAL);
680 680
681 681 curr = priv->nvp_list;
682 682 while (curr != NULL) {
683 683 nvpair_t *nvp = &curr->nvi_nvp;
684 684
685 685 if (strcmp(name, NVP_NAME(nvp)) == 0 && NVP_TYPE(nvp) == type) {
686 686 nvp_buf_unlink(nvl, nvp);
687 687 nvpair_free(nvp);
688 688 nvp_buf_free(nvl, nvp);
689 689
690 690 return (0);
691 691 }
692 692 curr = curr->nvi_next;
693 693 }
694 694
695 695 return (ENOENT);
696 696 }
697 697
698 698 int
699 699 nvlist_remove_nvpair(nvlist_t *nvl, nvpair_t *nvp)
700 700 {
701 701 if (nvl == NULL || nvp == NULL)
702 702 return (EINVAL);
703 703
704 704 nvp_buf_unlink(nvl, nvp);
705 705 nvpair_free(nvp);
706 706 nvp_buf_free(nvl, nvp);
707 707 return (0);
708 708 }
709 709
710 710 /*
711 711 * This function calculates the size of an nvpair value.
712 712 *
713 713 * The data argument controls the behavior in case of the data types
714 714 * DATA_TYPE_STRING and
715 715 * DATA_TYPE_STRING_ARRAY
716 716 * Is data == NULL then the size of the string(s) is excluded.
717 717 */
718 718 static int
719 719 i_get_value_size(data_type_t type, const void *data, uint_t nelem)
720 720 {
721 721 uint64_t value_sz;
722 722
723 723 if (i_validate_type_nelem(type, nelem) != 0)
724 724 return (-1);
725 725
726 726 /* Calculate required size for holding value */
727 727 switch (type) {
728 728 case DATA_TYPE_BOOLEAN:
729 729 value_sz = 0;
730 730 break;
731 731 case DATA_TYPE_BOOLEAN_VALUE:
732 732 value_sz = sizeof (boolean_t);
733 733 break;
734 734 case DATA_TYPE_BYTE:
735 735 value_sz = sizeof (uchar_t);
736 736 break;
737 737 case DATA_TYPE_INT8:
738 738 value_sz = sizeof (int8_t);
739 739 break;
740 740 case DATA_TYPE_UINT8:
741 741 value_sz = sizeof (uint8_t);
742 742 break;
743 743 case DATA_TYPE_INT16:
744 744 value_sz = sizeof (int16_t);
745 745 break;
746 746 case DATA_TYPE_UINT16:
747 747 value_sz = sizeof (uint16_t);
748 748 break;
749 749 case DATA_TYPE_INT32:
750 750 value_sz = sizeof (int32_t);
751 751 break;
752 752 case DATA_TYPE_UINT32:
753 753 value_sz = sizeof (uint32_t);
754 754 break;
755 755 case DATA_TYPE_INT64:
756 756 value_sz = sizeof (int64_t);
757 757 break;
758 758 case DATA_TYPE_UINT64:
759 759 value_sz = sizeof (uint64_t);
760 760 break;
761 761 #if !defined(_KERNEL)
762 762 case DATA_TYPE_DOUBLE:
763 763 value_sz = sizeof (double);
764 764 break;
765 765 #endif
766 766 case DATA_TYPE_STRING:
767 767 if (data == NULL)
768 768 value_sz = 0;
769 769 else
770 770 value_sz = strlen(data) + 1;
771 771 break;
772 772 case DATA_TYPE_BOOLEAN_ARRAY:
773 773 value_sz = (uint64_t)nelem * sizeof (boolean_t);
774 774 break;
775 775 case DATA_TYPE_BYTE_ARRAY:
776 776 value_sz = (uint64_t)nelem * sizeof (uchar_t);
777 777 break;
778 778 case DATA_TYPE_INT8_ARRAY:
779 779 value_sz = (uint64_t)nelem * sizeof (int8_t);
780 780 break;
781 781 case DATA_TYPE_UINT8_ARRAY:
782 782 value_sz = (uint64_t)nelem * sizeof (uint8_t);
783 783 break;
784 784 case DATA_TYPE_INT16_ARRAY:
785 785 value_sz = (uint64_t)nelem * sizeof (int16_t);
786 786 break;
787 787 case DATA_TYPE_UINT16_ARRAY:
788 788 value_sz = (uint64_t)nelem * sizeof (uint16_t);
789 789 break;
790 790 case DATA_TYPE_INT32_ARRAY:
791 791 value_sz = (uint64_t)nelem * sizeof (int32_t);
792 792 break;
793 793 case DATA_TYPE_UINT32_ARRAY:
794 794 value_sz = (uint64_t)nelem * sizeof (uint32_t);
795 795 break;
796 796 case DATA_TYPE_INT64_ARRAY:
797 797 value_sz = (uint64_t)nelem * sizeof (int64_t);
798 798 break;
799 799 case DATA_TYPE_UINT64_ARRAY:
800 800 value_sz = (uint64_t)nelem * sizeof (uint64_t);
801 801 break;
802 802 case DATA_TYPE_STRING_ARRAY:
803 803 value_sz = (uint64_t)nelem * sizeof (uint64_t);
804 804
805 805 if (data != NULL) {
806 806 char *const *strs = data;
807 807 uint_t i;
808 808
809 809 /* no alignment requirement for strings */
810 810 for (i = 0; i < nelem; i++) {
811 811 if (strs[i] == NULL)
812 812 return (-1);
813 813 value_sz += strlen(strs[i]) + 1;
814 814 }
815 815 }
816 816 break;
817 817 case DATA_TYPE_HRTIME:
818 818 value_sz = sizeof (hrtime_t);
819 819 break;
820 820 case DATA_TYPE_NVLIST:
821 821 value_sz = NV_ALIGN(sizeof (nvlist_t));
822 822 break;
823 823 case DATA_TYPE_NVLIST_ARRAY:
824 824 value_sz = (uint64_t)nelem * sizeof (uint64_t) +
825 825 (uint64_t)nelem * NV_ALIGN(sizeof (nvlist_t));
826 826 break;
827 827 default:
828 828 return (-1);
829 829 }
830 830
831 831 return (value_sz > INT32_MAX ? -1 : (int)value_sz);
832 832 }
833 833
834 834 static int
835 835 nvlist_copy_embedded(nvlist_t *nvl, nvlist_t *onvl, nvlist_t *emb_nvl)
836 836 {
837 837 nvpriv_t *priv;
838 838 int err;
839 839
840 840 if ((priv = nv_priv_alloc_embedded((nvpriv_t *)(uintptr_t)
841 841 nvl->nvl_priv)) == NULL)
842 842 return (ENOMEM);
843 843
844 844 nvlist_init(emb_nvl, onvl->nvl_nvflag, priv);
845 845
846 846 if ((err = nvlist_copy_pairs(onvl, emb_nvl)) != 0) {
847 847 nvlist_free(emb_nvl);
848 848 emb_nvl->nvl_priv = 0;
849 849 }
850 850
851 851 return (err);
852 852 }
853 853
854 854 /*
855 855 * nvlist_add_common - Add new <name,value> pair to nvlist
856 856 */
857 857 static int
858 858 nvlist_add_common(nvlist_t *nvl, const char *name,
859 859 data_type_t type, uint_t nelem, const void *data)
860 860 {
861 861 nvpair_t *nvp;
862 862 uint_t i;
863 863
864 864 int nvp_sz, name_sz, value_sz;
865 865 int err = 0;
866 866
867 867 if (name == NULL || nvl == NULL || nvl->nvl_priv == 0)
868 868 return (EINVAL);
869 869
870 870 if (nelem != 0 && data == NULL)
871 871 return (EINVAL);
872 872
873 873 /*
874 874 * Verify type and nelem and get the value size.
875 875 * In case of data types DATA_TYPE_STRING and DATA_TYPE_STRING_ARRAY
876 876 * is the size of the string(s) included.
877 877 */
878 878 if ((value_sz = i_get_value_size(type, data, nelem)) < 0)
879 879 return (EINVAL);
880 880
881 881 if (i_validate_nvpair_value(type, nelem, data) != 0)
882 882 return (EINVAL);
883 883
884 884 /*
885 885 * If we're adding an nvlist or nvlist array, ensure that we are not
886 886 * adding the input nvlist to itself, which would cause recursion,
887 887 * and ensure that no NULL nvlist pointers are present.
888 888 */
889 889 switch (type) {
890 890 case DATA_TYPE_NVLIST:
891 891 if (data == nvl || data == NULL)
892 892 return (EINVAL);
893 893 break;
894 894 case DATA_TYPE_NVLIST_ARRAY: {
895 895 nvlist_t **onvlp = (nvlist_t **)data;
896 896 for (i = 0; i < nelem; i++) {
897 897 if (onvlp[i] == nvl || onvlp[i] == NULL)
898 898 return (EINVAL);
899 899 }
900 900 break;
901 901 }
902 902 default:
903 903 break;
904 904 }
905 905
906 906 /* calculate sizes of the nvpair elements and the nvpair itself */
907 907 name_sz = strlen(name) + 1;
908 908
909 909 nvp_sz = NVP_SIZE_CALC(name_sz, value_sz);
910 910
911 911 if ((nvp = nvp_buf_alloc(nvl, nvp_sz)) == NULL)
912 912 return (ENOMEM);
913 913
914 914 ASSERT(nvp->nvp_size == nvp_sz);
915 915 nvp->nvp_name_sz = name_sz;
916 916 nvp->nvp_value_elem = nelem;
917 917 nvp->nvp_type = type;
918 918 bcopy(name, NVP_NAME(nvp), name_sz);
919 919
920 920 switch (type) {
921 921 case DATA_TYPE_BOOLEAN:
922 922 break;
923 923 case DATA_TYPE_STRING_ARRAY: {
924 924 char *const *strs = data;
925 925 char *buf = NVP_VALUE(nvp);
926 926 char **cstrs = (void *)buf;
927 927
928 928 /* skip pre-allocated space for pointer array */
929 929 buf += nelem * sizeof (uint64_t);
930 930 for (i = 0; i < nelem; i++) {
931 931 int slen = strlen(strs[i]) + 1;
932 932 bcopy(strs[i], buf, slen);
933 933 cstrs[i] = buf;
934 934 buf += slen;
935 935 }
936 936 break;
937 937 }
938 938 case DATA_TYPE_NVLIST: {
939 939 nvlist_t *nnvl = EMBEDDED_NVL(nvp);
940 940 nvlist_t *onvl = (nvlist_t *)data;
941 941
942 942 if ((err = nvlist_copy_embedded(nvl, onvl, nnvl)) != 0) {
943 943 nvp_buf_free(nvl, nvp);
944 944 return (err);
945 945 }
946 946 break;
947 947 }
948 948 case DATA_TYPE_NVLIST_ARRAY: {
949 949 nvlist_t **onvlp = (nvlist_t **)data;
950 950 nvlist_t **nvlp = EMBEDDED_NVL_ARRAY(nvp);
951 951 nvlist_t *embedded = (nvlist_t *)
952 952 ((uintptr_t)nvlp + nelem * sizeof (uint64_t));
953 953
954 954 for (i = 0; i < nelem; i++) {
955 955 if ((err = nvlist_copy_embedded(nvl,
956 956 onvlp[i], embedded)) != 0) {
957 957 /*
958 958 * Free any successfully created lists
959 959 */
960 960 nvpair_free(nvp);
961 961 nvp_buf_free(nvl, nvp);
962 962 return (err);
963 963 }
964 964
965 965 nvlp[i] = embedded++;
966 966 }
967 967 break;
968 968 }
969 969 default:
970 970 bcopy(data, NVP_VALUE(nvp), value_sz);
971 971 }
972 972
973 973 /* if unique name, remove before add */
974 974 if (nvl->nvl_nvflag & NV_UNIQUE_NAME)
975 975 (void) nvlist_remove_all(nvl, name);
976 976 else if (nvl->nvl_nvflag & NV_UNIQUE_NAME_TYPE)
977 977 (void) nvlist_remove(nvl, name, type);
978 978
979 979 nvp_buf_link(nvl, nvp);
980 980
981 981 return (0);
982 982 }
983 983
984 984 int
985 985 nvlist_add_boolean(nvlist_t *nvl, const char *name)
986 986 {
987 987 return (nvlist_add_common(nvl, name, DATA_TYPE_BOOLEAN, 0, NULL));
988 988 }
989 989
990 990 int
991 991 nvlist_add_boolean_value(nvlist_t *nvl, const char *name, boolean_t val)
992 992 {
993 993 return (nvlist_add_common(nvl, name, DATA_TYPE_BOOLEAN_VALUE, 1, &val));
994 994 }
995 995
996 996 int
997 997 nvlist_add_byte(nvlist_t *nvl, const char *name, uchar_t val)
998 998 {
999 999 return (nvlist_add_common(nvl, name, DATA_TYPE_BYTE, 1, &val));
1000 1000 }
1001 1001
1002 1002 int
1003 1003 nvlist_add_int8(nvlist_t *nvl, const char *name, int8_t val)
1004 1004 {
1005 1005 return (nvlist_add_common(nvl, name, DATA_TYPE_INT8, 1, &val));
1006 1006 }
1007 1007
1008 1008 int
1009 1009 nvlist_add_uint8(nvlist_t *nvl, const char *name, uint8_t val)
1010 1010 {
1011 1011 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT8, 1, &val));
1012 1012 }
1013 1013
1014 1014 int
1015 1015 nvlist_add_int16(nvlist_t *nvl, const char *name, int16_t val)
1016 1016 {
1017 1017 return (nvlist_add_common(nvl, name, DATA_TYPE_INT16, 1, &val));
1018 1018 }
1019 1019
1020 1020 int
1021 1021 nvlist_add_uint16(nvlist_t *nvl, const char *name, uint16_t val)
1022 1022 {
1023 1023 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT16, 1, &val));
1024 1024 }
1025 1025
1026 1026 int
1027 1027 nvlist_add_int32(nvlist_t *nvl, const char *name, int32_t val)
1028 1028 {
1029 1029 return (nvlist_add_common(nvl, name, DATA_TYPE_INT32, 1, &val));
1030 1030 }
1031 1031
1032 1032 int
1033 1033 nvlist_add_uint32(nvlist_t *nvl, const char *name, uint32_t val)
1034 1034 {
1035 1035 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT32, 1, &val));
1036 1036 }
1037 1037
1038 1038 int
1039 1039 nvlist_add_int64(nvlist_t *nvl, const char *name, int64_t val)
1040 1040 {
1041 1041 return (nvlist_add_common(nvl, name, DATA_TYPE_INT64, 1, &val));
1042 1042 }
1043 1043
1044 1044 int
1045 1045 nvlist_add_uint64(nvlist_t *nvl, const char *name, uint64_t val)
1046 1046 {
1047 1047 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT64, 1, &val));
1048 1048 }
1049 1049
1050 1050 #if !defined(_KERNEL)
1051 1051 int
1052 1052 nvlist_add_double(nvlist_t *nvl, const char *name, double val)
1053 1053 {
1054 1054 return (nvlist_add_common(nvl, name, DATA_TYPE_DOUBLE, 1, &val));
1055 1055 }
1056 1056 #endif
1057 1057
1058 1058 int
1059 1059 nvlist_add_string(nvlist_t *nvl, const char *name, const char *val)
1060 1060 {
1061 1061 return (nvlist_add_common(nvl, name, DATA_TYPE_STRING, 1, (void *)val));
1062 1062 }
1063 1063
1064 1064 int
1065 1065 nvlist_add_boolean_array(nvlist_t *nvl, const char *name,
1066 1066 boolean_t *a, uint_t n)
1067 1067 {
1068 1068 return (nvlist_add_common(nvl, name, DATA_TYPE_BOOLEAN_ARRAY, n, a));
1069 1069 }
1070 1070
1071 1071 int
1072 1072 nvlist_add_byte_array(nvlist_t *nvl, const char *name, uchar_t *a, uint_t n)
1073 1073 {
1074 1074 return (nvlist_add_common(nvl, name, DATA_TYPE_BYTE_ARRAY, n, a));
1075 1075 }
1076 1076
1077 1077 int
1078 1078 nvlist_add_int8_array(nvlist_t *nvl, const char *name, int8_t *a, uint_t n)
1079 1079 {
1080 1080 return (nvlist_add_common(nvl, name, DATA_TYPE_INT8_ARRAY, n, a));
1081 1081 }
1082 1082
1083 1083 int
1084 1084 nvlist_add_uint8_array(nvlist_t *nvl, const char *name, uint8_t *a, uint_t n)
1085 1085 {
1086 1086 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT8_ARRAY, n, a));
1087 1087 }
1088 1088
1089 1089 int
1090 1090 nvlist_add_int16_array(nvlist_t *nvl, const char *name, int16_t *a, uint_t n)
1091 1091 {
1092 1092 return (nvlist_add_common(nvl, name, DATA_TYPE_INT16_ARRAY, n, a));
1093 1093 }
1094 1094
1095 1095 int
1096 1096 nvlist_add_uint16_array(nvlist_t *nvl, const char *name, uint16_t *a, uint_t n)
1097 1097 {
1098 1098 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT16_ARRAY, n, a));
1099 1099 }
1100 1100
1101 1101 int
1102 1102 nvlist_add_int32_array(nvlist_t *nvl, const char *name, int32_t *a, uint_t n)
1103 1103 {
1104 1104 return (nvlist_add_common(nvl, name, DATA_TYPE_INT32_ARRAY, n, a));
1105 1105 }
1106 1106
1107 1107 int
1108 1108 nvlist_add_uint32_array(nvlist_t *nvl, const char *name, uint32_t *a, uint_t n)
1109 1109 {
1110 1110 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT32_ARRAY, n, a));
1111 1111 }
1112 1112
1113 1113 int
1114 1114 nvlist_add_int64_array(nvlist_t *nvl, const char *name, int64_t *a, uint_t n)
1115 1115 {
1116 1116 return (nvlist_add_common(nvl, name, DATA_TYPE_INT64_ARRAY, n, a));
1117 1117 }
1118 1118
1119 1119 int
1120 1120 nvlist_add_uint64_array(nvlist_t *nvl, const char *name, uint64_t *a, uint_t n)
1121 1121 {
1122 1122 return (nvlist_add_common(nvl, name, DATA_TYPE_UINT64_ARRAY, n, a));
1123 1123 }
1124 1124
1125 1125 int
1126 1126 nvlist_add_string_array(nvlist_t *nvl, const char *name,
1127 1127 char *const *a, uint_t n)
1128 1128 {
1129 1129 return (nvlist_add_common(nvl, name, DATA_TYPE_STRING_ARRAY, n, a));
1130 1130 }
1131 1131
1132 1132 int
1133 1133 nvlist_add_hrtime(nvlist_t *nvl, const char *name, hrtime_t val)
1134 1134 {
1135 1135 return (nvlist_add_common(nvl, name, DATA_TYPE_HRTIME, 1, &val));
1136 1136 }
1137 1137
1138 1138 int
1139 1139 nvlist_add_nvlist(nvlist_t *nvl, const char *name, nvlist_t *val)
1140 1140 {
1141 1141 return (nvlist_add_common(nvl, name, DATA_TYPE_NVLIST, 1, val));
1142 1142 }
1143 1143
1144 1144 int
1145 1145 nvlist_add_nvlist_array(nvlist_t *nvl, const char *name, nvlist_t **a, uint_t n)
1146 1146 {
1147 1147 return (nvlist_add_common(nvl, name, DATA_TYPE_NVLIST_ARRAY, n, a));
1148 1148 }
1149 1149
1150 1150 /* reading name-value pairs */
1151 1151 nvpair_t *
1152 1152 nvlist_next_nvpair(nvlist_t *nvl, nvpair_t *nvp)
1153 1153 {
1154 1154 nvpriv_t *priv;
1155 1155 i_nvp_t *curr;
1156 1156
1157 1157 if (nvl == NULL ||
1158 1158 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1159 1159 return (NULL);
1160 1160
1161 1161 curr = NVPAIR2I_NVP(nvp);
1162 1162
1163 1163 /*
1164 1164 * Ensure that nvp is a valid nvpair on this nvlist.
1165 1165 * NB: nvp_curr is used only as a hint so that we don't always
1166 1166 * have to walk the list to determine if nvp is still on the list.
1167 1167 */
1168 1168 if (nvp == NULL)
1169 1169 curr = priv->nvp_list;
1170 1170 else if (priv->nvp_curr == curr || nvlist_contains_nvp(nvl, nvp))
1171 1171 curr = curr->nvi_next;
1172 1172 else
1173 1173 curr = NULL;
1174 1174
1175 1175 priv->nvp_curr = curr;
1176 1176
1177 1177 return (curr != NULL ? &curr->nvi_nvp : NULL);
1178 1178 }
1179 1179
1180 1180 nvpair_t *
1181 1181 nvlist_prev_nvpair(nvlist_t *nvl, nvpair_t *nvp)
1182 1182 {
1183 1183 nvpriv_t *priv;
1184 1184 i_nvp_t *curr;
1185 1185
1186 1186 if (nvl == NULL ||
1187 1187 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1188 1188 return (NULL);
1189 1189
1190 1190 curr = NVPAIR2I_NVP(nvp);
1191 1191
1192 1192 if (nvp == NULL)
1193 1193 curr = priv->nvp_last;
1194 1194 else if (priv->nvp_curr == curr || nvlist_contains_nvp(nvl, nvp))
1195 1195 curr = curr->nvi_prev;
1196 1196 else
1197 1197 curr = NULL;
1198 1198
1199 1199 priv->nvp_curr = curr;
1200 1200
1201 1201 return (curr != NULL ? &curr->nvi_nvp : NULL);
1202 1202 }
1203 1203
1204 1204 boolean_t
1205 1205 nvlist_empty(nvlist_t *nvl)
1206 1206 {
1207 1207 nvpriv_t *priv;
1208 1208
1209 1209 if (nvl == NULL ||
1210 1210 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1211 1211 return (B_TRUE);
1212 1212
1213 1213 return (priv->nvp_list == NULL);
1214 1214 }
1215 1215
1216 1216 char *
1217 1217 nvpair_name(nvpair_t *nvp)
1218 1218 {
1219 1219 return (NVP_NAME(nvp));
1220 1220 }
1221 1221
1222 1222 data_type_t
1223 1223 nvpair_type(nvpair_t *nvp)
1224 1224 {
1225 1225 return (NVP_TYPE(nvp));
1226 1226 }
1227 1227
1228 1228 int
1229 1229 nvpair_type_is_array(nvpair_t *nvp)
1230 1230 {
1231 1231 data_type_t type = NVP_TYPE(nvp);
1232 1232
1233 1233 if ((type == DATA_TYPE_BYTE_ARRAY) ||
1234 1234 (type == DATA_TYPE_UINT8_ARRAY) ||
1235 1235 (type == DATA_TYPE_INT16_ARRAY) ||
1236 1236 (type == DATA_TYPE_UINT16_ARRAY) ||
1237 1237 (type == DATA_TYPE_INT32_ARRAY) ||
1238 1238 (type == DATA_TYPE_UINT32_ARRAY) ||
1239 1239 (type == DATA_TYPE_INT64_ARRAY) ||
1240 1240 (type == DATA_TYPE_UINT64_ARRAY) ||
1241 1241 (type == DATA_TYPE_BOOLEAN_ARRAY) ||
1242 1242 (type == DATA_TYPE_STRING_ARRAY) ||
1243 1243 (type == DATA_TYPE_NVLIST_ARRAY))
1244 1244 return (1);
1245 1245 return (0);
1246 1246
1247 1247 }
1248 1248
1249 1249 static int
1250 1250 nvpair_value_common(nvpair_t *nvp, data_type_t type, uint_t *nelem, void *data)
1251 1251 {
1252 1252 if (nvp == NULL || nvpair_type(nvp) != type)
1253 1253 return (EINVAL);
1254 1254
1255 1255 /*
1256 1256 * For non-array types, we copy the data.
1257 1257 * For array types (including string), we set a pointer.
1258 1258 */
1259 1259 switch (type) {
1260 1260 case DATA_TYPE_BOOLEAN:
1261 1261 if (nelem != NULL)
1262 1262 *nelem = 0;
1263 1263 break;
1264 1264
1265 1265 case DATA_TYPE_BOOLEAN_VALUE:
1266 1266 case DATA_TYPE_BYTE:
1267 1267 case DATA_TYPE_INT8:
1268 1268 case DATA_TYPE_UINT8:
1269 1269 case DATA_TYPE_INT16:
1270 1270 case DATA_TYPE_UINT16:
1271 1271 case DATA_TYPE_INT32:
1272 1272 case DATA_TYPE_UINT32:
1273 1273 case DATA_TYPE_INT64:
1274 1274 case DATA_TYPE_UINT64:
1275 1275 case DATA_TYPE_HRTIME:
1276 1276 #if !defined(_KERNEL)
1277 1277 case DATA_TYPE_DOUBLE:
1278 1278 #endif
1279 1279 if (data == NULL)
1280 1280 return (EINVAL);
1281 1281 bcopy(NVP_VALUE(nvp), data,
1282 1282 (size_t)i_get_value_size(type, NULL, 1));
1283 1283 if (nelem != NULL)
1284 1284 *nelem = 1;
1285 1285 break;
1286 1286
1287 1287 case DATA_TYPE_NVLIST:
1288 1288 case DATA_TYPE_STRING:
1289 1289 if (data == NULL)
1290 1290 return (EINVAL);
1291 1291 *(void **)data = (void *)NVP_VALUE(nvp);
1292 1292 if (nelem != NULL)
1293 1293 *nelem = 1;
1294 1294 break;
1295 1295
1296 1296 case DATA_TYPE_BOOLEAN_ARRAY:
1297 1297 case DATA_TYPE_BYTE_ARRAY:
1298 1298 case DATA_TYPE_INT8_ARRAY:
1299 1299 case DATA_TYPE_UINT8_ARRAY:
1300 1300 case DATA_TYPE_INT16_ARRAY:
1301 1301 case DATA_TYPE_UINT16_ARRAY:
1302 1302 case DATA_TYPE_INT32_ARRAY:
1303 1303 case DATA_TYPE_UINT32_ARRAY:
1304 1304 case DATA_TYPE_INT64_ARRAY:
1305 1305 case DATA_TYPE_UINT64_ARRAY:
1306 1306 case DATA_TYPE_STRING_ARRAY:
1307 1307 case DATA_TYPE_NVLIST_ARRAY:
1308 1308 if (nelem == NULL || data == NULL)
1309 1309 return (EINVAL);
1310 1310 if ((*nelem = NVP_NELEM(nvp)) != 0)
1311 1311 *(void **)data = (void *)NVP_VALUE(nvp);
1312 1312 else
1313 1313 *(void **)data = NULL;
1314 1314 break;
1315 1315
1316 1316 default:
1317 1317 return (ENOTSUP);
1318 1318 }
1319 1319
1320 1320 return (0);
1321 1321 }
1322 1322
1323 1323 static int
1324 1324 nvlist_lookup_common(nvlist_t *nvl, const char *name, data_type_t type,
1325 1325 uint_t *nelem, void *data)
1326 1326 {
1327 1327 nvpriv_t *priv;
1328 1328 nvpair_t *nvp;
1329 1329 i_nvp_t *curr;
1330 1330
1331 1331 if (name == NULL || nvl == NULL ||
1332 1332 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1333 1333 return (EINVAL);
1334 1334
1335 1335 if (!(nvl->nvl_nvflag & (NV_UNIQUE_NAME | NV_UNIQUE_NAME_TYPE)))
1336 1336 return (ENOTSUP);
1337 1337
1338 1338 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
1339 1339 nvp = &curr->nvi_nvp;
1340 1340
1341 1341 if (strcmp(name, NVP_NAME(nvp)) == 0 && NVP_TYPE(nvp) == type)
1342 1342 return (nvpair_value_common(nvp, type, nelem, data));
1343 1343 }
1344 1344
1345 1345 return (ENOENT);
1346 1346 }
1347 1347
1348 1348 int
1349 1349 nvlist_lookup_boolean(nvlist_t *nvl, const char *name)
1350 1350 {
1351 1351 return (nvlist_lookup_common(nvl, name, DATA_TYPE_BOOLEAN, NULL, NULL));
1352 1352 }
1353 1353
1354 1354 int
1355 1355 nvlist_lookup_boolean_value(nvlist_t *nvl, const char *name, boolean_t *val)
1356 1356 {
1357 1357 return (nvlist_lookup_common(nvl, name,
1358 1358 DATA_TYPE_BOOLEAN_VALUE, NULL, val));
1359 1359 }
1360 1360
1361 1361 int
1362 1362 nvlist_lookup_byte(nvlist_t *nvl, const char *name, uchar_t *val)
1363 1363 {
1364 1364 return (nvlist_lookup_common(nvl, name, DATA_TYPE_BYTE, NULL, val));
1365 1365 }
1366 1366
1367 1367 int
1368 1368 nvlist_lookup_int8(nvlist_t *nvl, const char *name, int8_t *val)
1369 1369 {
1370 1370 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT8, NULL, val));
1371 1371 }
1372 1372
1373 1373 int
1374 1374 nvlist_lookup_uint8(nvlist_t *nvl, const char *name, uint8_t *val)
1375 1375 {
1376 1376 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT8, NULL, val));
1377 1377 }
1378 1378
1379 1379 int
1380 1380 nvlist_lookup_int16(nvlist_t *nvl, const char *name, int16_t *val)
1381 1381 {
1382 1382 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT16, NULL, val));
1383 1383 }
1384 1384
1385 1385 int
1386 1386 nvlist_lookup_uint16(nvlist_t *nvl, const char *name, uint16_t *val)
1387 1387 {
1388 1388 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT16, NULL, val));
1389 1389 }
1390 1390
1391 1391 int
1392 1392 nvlist_lookup_int32(nvlist_t *nvl, const char *name, int32_t *val)
1393 1393 {
1394 1394 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT32, NULL, val));
1395 1395 }
1396 1396
1397 1397 int
1398 1398 nvlist_lookup_uint32(nvlist_t *nvl, const char *name, uint32_t *val)
1399 1399 {
1400 1400 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT32, NULL, val));
1401 1401 }
1402 1402
1403 1403 int
1404 1404 nvlist_lookup_int64(nvlist_t *nvl, const char *name, int64_t *val)
1405 1405 {
1406 1406 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT64, NULL, val));
1407 1407 }
1408 1408
1409 1409 int
1410 1410 nvlist_lookup_uint64(nvlist_t *nvl, const char *name, uint64_t *val)
1411 1411 {
1412 1412 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT64, NULL, val));
1413 1413 }
1414 1414
1415 1415 #if !defined(_KERNEL)
1416 1416 int
1417 1417 nvlist_lookup_double(nvlist_t *nvl, const char *name, double *val)
1418 1418 {
1419 1419 return (nvlist_lookup_common(nvl, name, DATA_TYPE_DOUBLE, NULL, val));
1420 1420 }
1421 1421 #endif
1422 1422
1423 1423 int
1424 1424 nvlist_lookup_string(nvlist_t *nvl, const char *name, char **val)
1425 1425 {
1426 1426 return (nvlist_lookup_common(nvl, name, DATA_TYPE_STRING, NULL, val));
1427 1427 }
1428 1428
1429 1429 int
1430 1430 nvlist_lookup_nvlist(nvlist_t *nvl, const char *name, nvlist_t **val)
1431 1431 {
1432 1432 return (nvlist_lookup_common(nvl, name, DATA_TYPE_NVLIST, NULL, val));
1433 1433 }
1434 1434
1435 1435 int
1436 1436 nvlist_lookup_boolean_array(nvlist_t *nvl, const char *name,
1437 1437 boolean_t **a, uint_t *n)
1438 1438 {
1439 1439 return (nvlist_lookup_common(nvl, name,
1440 1440 DATA_TYPE_BOOLEAN_ARRAY, n, a));
1441 1441 }
1442 1442
1443 1443 int
1444 1444 nvlist_lookup_byte_array(nvlist_t *nvl, const char *name,
1445 1445 uchar_t **a, uint_t *n)
1446 1446 {
1447 1447 return (nvlist_lookup_common(nvl, name, DATA_TYPE_BYTE_ARRAY, n, a));
1448 1448 }
1449 1449
1450 1450 int
1451 1451 nvlist_lookup_int8_array(nvlist_t *nvl, const char *name, int8_t **a, uint_t *n)
1452 1452 {
1453 1453 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT8_ARRAY, n, a));
1454 1454 }
1455 1455
1456 1456 int
1457 1457 nvlist_lookup_uint8_array(nvlist_t *nvl, const char *name,
1458 1458 uint8_t **a, uint_t *n)
1459 1459 {
1460 1460 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT8_ARRAY, n, a));
1461 1461 }
1462 1462
1463 1463 int
1464 1464 nvlist_lookup_int16_array(nvlist_t *nvl, const char *name,
1465 1465 int16_t **a, uint_t *n)
1466 1466 {
1467 1467 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT16_ARRAY, n, a));
1468 1468 }
1469 1469
1470 1470 int
1471 1471 nvlist_lookup_uint16_array(nvlist_t *nvl, const char *name,
1472 1472 uint16_t **a, uint_t *n)
1473 1473 {
1474 1474 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT16_ARRAY, n, a));
1475 1475 }
1476 1476
1477 1477 int
1478 1478 nvlist_lookup_int32_array(nvlist_t *nvl, const char *name,
1479 1479 int32_t **a, uint_t *n)
1480 1480 {
1481 1481 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT32_ARRAY, n, a));
1482 1482 }
1483 1483
1484 1484 int
1485 1485 nvlist_lookup_uint32_array(nvlist_t *nvl, const char *name,
1486 1486 uint32_t **a, uint_t *n)
1487 1487 {
1488 1488 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT32_ARRAY, n, a));
1489 1489 }
1490 1490
1491 1491 int
1492 1492 nvlist_lookup_int64_array(nvlist_t *nvl, const char *name,
1493 1493 int64_t **a, uint_t *n)
1494 1494 {
1495 1495 return (nvlist_lookup_common(nvl, name, DATA_TYPE_INT64_ARRAY, n, a));
1496 1496 }
1497 1497
1498 1498 int
1499 1499 nvlist_lookup_uint64_array(nvlist_t *nvl, const char *name,
1500 1500 uint64_t **a, uint_t *n)
1501 1501 {
1502 1502 return (nvlist_lookup_common(nvl, name, DATA_TYPE_UINT64_ARRAY, n, a));
1503 1503 }
1504 1504
1505 1505 int
1506 1506 nvlist_lookup_string_array(nvlist_t *nvl, const char *name,
1507 1507 char ***a, uint_t *n)
1508 1508 {
1509 1509 return (nvlist_lookup_common(nvl, name, DATA_TYPE_STRING_ARRAY, n, a));
1510 1510 }
1511 1511
1512 1512 int
1513 1513 nvlist_lookup_nvlist_array(nvlist_t *nvl, const char *name,
1514 1514 nvlist_t ***a, uint_t *n)
1515 1515 {
1516 1516 return (nvlist_lookup_common(nvl, name, DATA_TYPE_NVLIST_ARRAY, n, a));
1517 1517 }
1518 1518
1519 1519 int
1520 1520 nvlist_lookup_hrtime(nvlist_t *nvl, const char *name, hrtime_t *val)
1521 1521 {
1522 1522 return (nvlist_lookup_common(nvl, name, DATA_TYPE_HRTIME, NULL, val));
1523 1523 }
1524 1524
1525 1525 int
1526 1526 nvlist_lookup_pairs(nvlist_t *nvl, int flag, ...)
1527 1527 {
1528 1528 va_list ap;
1529 1529 char *name;
1530 1530 int noentok = (flag & NV_FLAG_NOENTOK ? 1 : 0);
1531 1531 int ret = 0;
1532 1532
1533 1533 va_start(ap, flag);
1534 1534 while (ret == 0 && (name = va_arg(ap, char *)) != NULL) {
1535 1535 data_type_t type;
1536 1536 void *val;
1537 1537 uint_t *nelem;
1538 1538
1539 1539 switch (type = va_arg(ap, data_type_t)) {
1540 1540 case DATA_TYPE_BOOLEAN:
1541 1541 ret = nvlist_lookup_common(nvl, name, type, NULL, NULL);
1542 1542 break;
1543 1543
1544 1544 case DATA_TYPE_BOOLEAN_VALUE:
1545 1545 case DATA_TYPE_BYTE:
1546 1546 case DATA_TYPE_INT8:
1547 1547 case DATA_TYPE_UINT8:
1548 1548 case DATA_TYPE_INT16:
1549 1549 case DATA_TYPE_UINT16:
1550 1550 case DATA_TYPE_INT32:
1551 1551 case DATA_TYPE_UINT32:
1552 1552 case DATA_TYPE_INT64:
1553 1553 case DATA_TYPE_UINT64:
1554 1554 case DATA_TYPE_HRTIME:
1555 1555 case DATA_TYPE_STRING:
1556 1556 case DATA_TYPE_NVLIST:
1557 1557 #if !defined(_KERNEL)
1558 1558 case DATA_TYPE_DOUBLE:
1559 1559 #endif
1560 1560 val = va_arg(ap, void *);
1561 1561 ret = nvlist_lookup_common(nvl, name, type, NULL, val);
1562 1562 break;
1563 1563
1564 1564 case DATA_TYPE_BYTE_ARRAY:
1565 1565 case DATA_TYPE_BOOLEAN_ARRAY:
1566 1566 case DATA_TYPE_INT8_ARRAY:
1567 1567 case DATA_TYPE_UINT8_ARRAY:
1568 1568 case DATA_TYPE_INT16_ARRAY:
1569 1569 case DATA_TYPE_UINT16_ARRAY:
1570 1570 case DATA_TYPE_INT32_ARRAY:
1571 1571 case DATA_TYPE_UINT32_ARRAY:
1572 1572 case DATA_TYPE_INT64_ARRAY:
1573 1573 case DATA_TYPE_UINT64_ARRAY:
1574 1574 case DATA_TYPE_STRING_ARRAY:
1575 1575 case DATA_TYPE_NVLIST_ARRAY:
1576 1576 val = va_arg(ap, void *);
1577 1577 nelem = va_arg(ap, uint_t *);
1578 1578 ret = nvlist_lookup_common(nvl, name, type, nelem, val);
1579 1579 break;
1580 1580
1581 1581 default:
1582 1582 ret = EINVAL;
1583 1583 }
1584 1584
1585 1585 if (ret == ENOENT && noentok)
1586 1586 ret = 0;
1587 1587 }
1588 1588 va_end(ap);
1589 1589
1590 1590 return (ret);
1591 1591 }
1592 1592
1593 1593 /*
1594 1594 * Find the 'name'ed nvpair in the nvlist 'nvl'. If 'name' found, the function
1595 1595 * returns zero and a pointer to the matching nvpair is returned in '*ret'
1596 1596 * (given 'ret' is non-NULL). If 'sep' is specified then 'name' will penitrate
1597 1597 * multiple levels of embedded nvlists, with 'sep' as the separator. As an
1598 1598 * example, if sep is '.', name might look like: "a" or "a.b" or "a.c[3]" or
1599 1599 * "a.d[3].e[1]". This matches the C syntax for array embed (for convience,
1600 1600 * code also supports "a.d[3]e[1]" syntax).
1601 1601 *
1602 1602 * If 'ip' is non-NULL and the last name component is an array, return the
1603 1603 * value of the "...[index]" array index in *ip. For an array reference that
1604 1604 * is not indexed, *ip will be returned as -1. If there is a syntax error in
1605 1605 * 'name', and 'ep' is non-NULL then *ep will be set to point to the location
1606 1606 * inside the 'name' string where the syntax error was detected.
1607 1607 */
1608 1608 static int
1609 1609 nvlist_lookup_nvpair_ei_sep(nvlist_t *nvl, const char *name, const char sep,
1610 1610 nvpair_t **ret, int *ip, char **ep)
1611 1611 {
1612 1612 nvpair_t *nvp;
1613 1613 const char *np;
1614 1614 char *sepp;
1615 1615 char *idxp, *idxep;
1616 1616 nvlist_t **nva;
1617 1617 long idx;
|
↓ open down ↓ |
1617 lines elided |
↑ open up ↑ |
1618 1618 int n;
1619 1619
1620 1620 if (ip)
1621 1621 *ip = -1; /* not indexed */
1622 1622 if (ep)
1623 1623 *ep = NULL;
1624 1624
1625 1625 if ((nvl == NULL) || (name == NULL))
1626 1626 return (EINVAL);
1627 1627
1628 + sepp = NULL;
1629 + idx = 0;
1628 1630 /* step through components of name */
1629 1631 for (np = name; np && *np; np = sepp) {
1630 1632 /* ensure unique names */
1631 1633 if (!(nvl->nvl_nvflag & NV_UNIQUE_NAME))
1632 1634 return (ENOTSUP);
1633 1635
1634 1636 /* skip white space */
1635 1637 skip_whitespace(np);
1636 1638 if (*np == 0)
1637 1639 break;
1638 1640
1639 1641 /* set 'sepp' to end of current component 'np' */
1640 1642 if (sep)
1641 1643 sepp = strchr(np, sep);
1642 1644 else
1643 1645 sepp = NULL;
1644 1646
1645 1647 /* find start of next "[ index ]..." */
1646 1648 idxp = strchr(np, '[');
1647 1649
1648 1650 /* if sepp comes first, set idxp to NULL */
1649 1651 if (sepp && idxp && (sepp < idxp))
1650 1652 idxp = NULL;
1651 1653
1652 1654 /*
1653 1655 * At this point 'idxp' is set if there is an index
1654 1656 * expected for the current component.
1655 1657 */
1656 1658 if (idxp) {
1657 1659 /* set 'n' to length of current 'np' name component */
1658 1660 n = idxp++ - np;
1659 1661
1660 1662 /* keep sepp up to date for *ep use as we advance */
1661 1663 skip_whitespace(idxp);
1662 1664 sepp = idxp;
1663 1665
1664 1666 /* determine the index value */
1665 1667 #if defined(_KERNEL) && !defined(_BOOT)
1666 1668 if (ddi_strtol(idxp, &idxep, 0, &idx))
1667 1669 goto fail;
1668 1670 #else
1669 1671 idx = strtol(idxp, &idxep, 0);
1670 1672 #endif
1671 1673 if (idxep == idxp)
1672 1674 goto fail;
1673 1675
1674 1676 /* keep sepp up to date for *ep use as we advance */
1675 1677 sepp = idxep;
1676 1678
1677 1679 /* skip white space index value and check for ']' */
1678 1680 skip_whitespace(sepp);
1679 1681 if (*sepp++ != ']')
1680 1682 goto fail;
1681 1683
1682 1684 /* for embedded arrays, support C syntax: "a[1].b" */
1683 1685 skip_whitespace(sepp);
1684 1686 if (sep && (*sepp == sep))
1685 1687 sepp++;
1686 1688 } else if (sepp) {
1687 1689 n = sepp++ - np;
1688 1690 } else {
1689 1691 n = strlen(np);
1690 1692 }
1691 1693
1692 1694 /* trim trailing whitespace by reducing length of 'np' */
1693 1695 if (n == 0)
1694 1696 goto fail;
1695 1697 for (n--; (np[n] == ' ') || (np[n] == '\t'); n--)
1696 1698 ;
1697 1699 n++;
1698 1700
1699 1701 /* skip whitespace, and set sepp to NULL if complete */
1700 1702 if (sepp) {
1701 1703 skip_whitespace(sepp);
1702 1704 if (*sepp == 0)
1703 1705 sepp = NULL;
1704 1706 }
1705 1707
1706 1708 /*
1707 1709 * At this point:
1708 1710 * o 'n' is the length of current 'np' component.
1709 1711 * o 'idxp' is set if there was an index, and value 'idx'.
1710 1712 * o 'sepp' is set to the beginning of the next component,
1711 1713 * and set to NULL if we have no more components.
1712 1714 *
1713 1715 * Search for nvpair with matching component name.
1714 1716 */
1715 1717 for (nvp = nvlist_next_nvpair(nvl, NULL); nvp != NULL;
1716 1718 nvp = nvlist_next_nvpair(nvl, nvp)) {
1717 1719
1718 1720 /* continue if no match on name */
1719 1721 if (strncmp(np, nvpair_name(nvp), n) ||
1720 1722 (strlen(nvpair_name(nvp)) != n))
1721 1723 continue;
1722 1724
1723 1725 /* if indexed, verify type is array oriented */
1724 1726 if (idxp && !nvpair_type_is_array(nvp))
1725 1727 goto fail;
1726 1728
1727 1729 /*
1728 1730 * Full match found, return nvp and idx if this
1729 1731 * was the last component.
1730 1732 */
1731 1733 if (sepp == NULL) {
1732 1734 if (ret)
1733 1735 *ret = nvp;
1734 1736 if (ip && idxp)
1735 1737 *ip = (int)idx; /* return index */
1736 1738 return (0); /* found */
1737 1739 }
1738 1740
1739 1741 /*
1740 1742 * More components: current match must be
1741 1743 * of DATA_TYPE_NVLIST or DATA_TYPE_NVLIST_ARRAY
1742 1744 * to support going deeper.
1743 1745 */
1744 1746 if (nvpair_type(nvp) == DATA_TYPE_NVLIST) {
1745 1747 nvl = EMBEDDED_NVL(nvp);
1746 1748 break;
1747 1749 } else if (nvpair_type(nvp) == DATA_TYPE_NVLIST_ARRAY) {
1748 1750 (void) nvpair_value_nvlist_array(nvp,
1749 1751 &nva, (uint_t *)&n);
1750 1752 if ((n < 0) || (idx >= n))
1751 1753 goto fail;
1752 1754 nvl = nva[idx];
1753 1755 break;
1754 1756 }
1755 1757
1756 1758 /* type does not support more levels */
1757 1759 goto fail;
1758 1760 }
1759 1761 if (nvp == NULL)
1760 1762 goto fail; /* 'name' not found */
1761 1763
1762 1764 /* search for match of next component in embedded 'nvl' list */
1763 1765 }
1764 1766
1765 1767 fail: if (ep && sepp)
1766 1768 *ep = sepp;
1767 1769 return (EINVAL);
1768 1770 }
1769 1771
1770 1772 /*
1771 1773 * Return pointer to nvpair with specified 'name'.
1772 1774 */
1773 1775 int
1774 1776 nvlist_lookup_nvpair(nvlist_t *nvl, const char *name, nvpair_t **ret)
1775 1777 {
1776 1778 return (nvlist_lookup_nvpair_ei_sep(nvl, name, 0, ret, NULL, NULL));
1777 1779 }
1778 1780
1779 1781 /*
1780 1782 * Determine if named nvpair exists in nvlist (use embedded separator of '.'
1781 1783 * and return array index). See nvlist_lookup_nvpair_ei_sep for more detailed
1782 1784 * description.
1783 1785 */
1784 1786 int nvlist_lookup_nvpair_embedded_index(nvlist_t *nvl,
1785 1787 const char *name, nvpair_t **ret, int *ip, char **ep)
1786 1788 {
1787 1789 return (nvlist_lookup_nvpair_ei_sep(nvl, name, '.', ret, ip, ep));
1788 1790 }
1789 1791
1790 1792 boolean_t
1791 1793 nvlist_exists(nvlist_t *nvl, const char *name)
1792 1794 {
1793 1795 nvpriv_t *priv;
1794 1796 nvpair_t *nvp;
1795 1797 i_nvp_t *curr;
1796 1798
1797 1799 if (name == NULL || nvl == NULL ||
1798 1800 (priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
1799 1801 return (B_FALSE);
1800 1802
1801 1803 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
1802 1804 nvp = &curr->nvi_nvp;
1803 1805
1804 1806 if (strcmp(name, NVP_NAME(nvp)) == 0)
1805 1807 return (B_TRUE);
1806 1808 }
1807 1809
1808 1810 return (B_FALSE);
1809 1811 }
1810 1812
1811 1813 int
1812 1814 nvpair_value_boolean_value(nvpair_t *nvp, boolean_t *val)
1813 1815 {
1814 1816 return (nvpair_value_common(nvp, DATA_TYPE_BOOLEAN_VALUE, NULL, val));
1815 1817 }
1816 1818
1817 1819 int
1818 1820 nvpair_value_byte(nvpair_t *nvp, uchar_t *val)
1819 1821 {
1820 1822 return (nvpair_value_common(nvp, DATA_TYPE_BYTE, NULL, val));
1821 1823 }
1822 1824
1823 1825 int
1824 1826 nvpair_value_int8(nvpair_t *nvp, int8_t *val)
1825 1827 {
1826 1828 return (nvpair_value_common(nvp, DATA_TYPE_INT8, NULL, val));
1827 1829 }
1828 1830
1829 1831 int
1830 1832 nvpair_value_uint8(nvpair_t *nvp, uint8_t *val)
1831 1833 {
1832 1834 return (nvpair_value_common(nvp, DATA_TYPE_UINT8, NULL, val));
1833 1835 }
1834 1836
1835 1837 int
1836 1838 nvpair_value_int16(nvpair_t *nvp, int16_t *val)
1837 1839 {
1838 1840 return (nvpair_value_common(nvp, DATA_TYPE_INT16, NULL, val));
1839 1841 }
1840 1842
1841 1843 int
1842 1844 nvpair_value_uint16(nvpair_t *nvp, uint16_t *val)
1843 1845 {
1844 1846 return (nvpair_value_common(nvp, DATA_TYPE_UINT16, NULL, val));
1845 1847 }
1846 1848
1847 1849 int
1848 1850 nvpair_value_int32(nvpair_t *nvp, int32_t *val)
1849 1851 {
1850 1852 return (nvpair_value_common(nvp, DATA_TYPE_INT32, NULL, val));
1851 1853 }
1852 1854
1853 1855 int
1854 1856 nvpair_value_uint32(nvpair_t *nvp, uint32_t *val)
1855 1857 {
1856 1858 return (nvpair_value_common(nvp, DATA_TYPE_UINT32, NULL, val));
1857 1859 }
1858 1860
1859 1861 int
1860 1862 nvpair_value_int64(nvpair_t *nvp, int64_t *val)
1861 1863 {
1862 1864 return (nvpair_value_common(nvp, DATA_TYPE_INT64, NULL, val));
1863 1865 }
1864 1866
1865 1867 int
1866 1868 nvpair_value_uint64(nvpair_t *nvp, uint64_t *val)
1867 1869 {
1868 1870 return (nvpair_value_common(nvp, DATA_TYPE_UINT64, NULL, val));
1869 1871 }
1870 1872
1871 1873 #if !defined(_KERNEL)
1872 1874 int
1873 1875 nvpair_value_double(nvpair_t *nvp, double *val)
1874 1876 {
1875 1877 return (nvpair_value_common(nvp, DATA_TYPE_DOUBLE, NULL, val));
1876 1878 }
1877 1879 #endif
1878 1880
1879 1881 int
1880 1882 nvpair_value_string(nvpair_t *nvp, char **val)
1881 1883 {
1882 1884 return (nvpair_value_common(nvp, DATA_TYPE_STRING, NULL, val));
1883 1885 }
1884 1886
1885 1887 int
1886 1888 nvpair_value_nvlist(nvpair_t *nvp, nvlist_t **val)
1887 1889 {
1888 1890 return (nvpair_value_common(nvp, DATA_TYPE_NVLIST, NULL, val));
1889 1891 }
1890 1892
1891 1893 int
1892 1894 nvpair_value_boolean_array(nvpair_t *nvp, boolean_t **val, uint_t *nelem)
1893 1895 {
1894 1896 return (nvpair_value_common(nvp, DATA_TYPE_BOOLEAN_ARRAY, nelem, val));
1895 1897 }
1896 1898
1897 1899 int
1898 1900 nvpair_value_byte_array(nvpair_t *nvp, uchar_t **val, uint_t *nelem)
1899 1901 {
1900 1902 return (nvpair_value_common(nvp, DATA_TYPE_BYTE_ARRAY, nelem, val));
1901 1903 }
1902 1904
1903 1905 int
1904 1906 nvpair_value_int8_array(nvpair_t *nvp, int8_t **val, uint_t *nelem)
1905 1907 {
1906 1908 return (nvpair_value_common(nvp, DATA_TYPE_INT8_ARRAY, nelem, val));
1907 1909 }
1908 1910
1909 1911 int
1910 1912 nvpair_value_uint8_array(nvpair_t *nvp, uint8_t **val, uint_t *nelem)
1911 1913 {
1912 1914 return (nvpair_value_common(nvp, DATA_TYPE_UINT8_ARRAY, nelem, val));
1913 1915 }
1914 1916
1915 1917 int
1916 1918 nvpair_value_int16_array(nvpair_t *nvp, int16_t **val, uint_t *nelem)
1917 1919 {
1918 1920 return (nvpair_value_common(nvp, DATA_TYPE_INT16_ARRAY, nelem, val));
1919 1921 }
1920 1922
1921 1923 int
1922 1924 nvpair_value_uint16_array(nvpair_t *nvp, uint16_t **val, uint_t *nelem)
1923 1925 {
1924 1926 return (nvpair_value_common(nvp, DATA_TYPE_UINT16_ARRAY, nelem, val));
1925 1927 }
1926 1928
1927 1929 int
1928 1930 nvpair_value_int32_array(nvpair_t *nvp, int32_t **val, uint_t *nelem)
1929 1931 {
1930 1932 return (nvpair_value_common(nvp, DATA_TYPE_INT32_ARRAY, nelem, val));
1931 1933 }
1932 1934
1933 1935 int
1934 1936 nvpair_value_uint32_array(nvpair_t *nvp, uint32_t **val, uint_t *nelem)
1935 1937 {
1936 1938 return (nvpair_value_common(nvp, DATA_TYPE_UINT32_ARRAY, nelem, val));
1937 1939 }
1938 1940
1939 1941 int
1940 1942 nvpair_value_int64_array(nvpair_t *nvp, int64_t **val, uint_t *nelem)
1941 1943 {
1942 1944 return (nvpair_value_common(nvp, DATA_TYPE_INT64_ARRAY, nelem, val));
1943 1945 }
1944 1946
1945 1947 int
1946 1948 nvpair_value_uint64_array(nvpair_t *nvp, uint64_t **val, uint_t *nelem)
1947 1949 {
1948 1950 return (nvpair_value_common(nvp, DATA_TYPE_UINT64_ARRAY, nelem, val));
1949 1951 }
1950 1952
1951 1953 int
1952 1954 nvpair_value_string_array(nvpair_t *nvp, char ***val, uint_t *nelem)
1953 1955 {
1954 1956 return (nvpair_value_common(nvp, DATA_TYPE_STRING_ARRAY, nelem, val));
1955 1957 }
1956 1958
1957 1959 int
1958 1960 nvpair_value_nvlist_array(nvpair_t *nvp, nvlist_t ***val, uint_t *nelem)
1959 1961 {
1960 1962 return (nvpair_value_common(nvp, DATA_TYPE_NVLIST_ARRAY, nelem, val));
1961 1963 }
1962 1964
1963 1965 int
1964 1966 nvpair_value_hrtime(nvpair_t *nvp, hrtime_t *val)
1965 1967 {
1966 1968 return (nvpair_value_common(nvp, DATA_TYPE_HRTIME, NULL, val));
1967 1969 }
1968 1970
1969 1971 /*
1970 1972 * Add specified pair to the list.
1971 1973 */
1972 1974 int
1973 1975 nvlist_add_nvpair(nvlist_t *nvl, nvpair_t *nvp)
1974 1976 {
1975 1977 if (nvl == NULL || nvp == NULL)
1976 1978 return (EINVAL);
1977 1979
1978 1980 return (nvlist_add_common(nvl, NVP_NAME(nvp), NVP_TYPE(nvp),
1979 1981 NVP_NELEM(nvp), NVP_VALUE(nvp)));
1980 1982 }
1981 1983
1982 1984 /*
1983 1985 * Merge the supplied nvlists and put the result in dst.
1984 1986 * The merged list will contain all names specified in both lists,
1985 1987 * the values are taken from nvl in the case of duplicates.
1986 1988 * Return 0 on success.
1987 1989 */
1988 1990 /*ARGSUSED*/
1989 1991 int
1990 1992 nvlist_merge(nvlist_t *dst, nvlist_t *nvl, int flag)
1991 1993 {
1992 1994 if (nvl == NULL || dst == NULL)
1993 1995 return (EINVAL);
1994 1996
1995 1997 if (dst != nvl)
1996 1998 return (nvlist_copy_pairs(nvl, dst));
1997 1999
1998 2000 return (0);
1999 2001 }
2000 2002
2001 2003 /*
2002 2004 * Encoding related routines
2003 2005 */
2004 2006 #define NVS_OP_ENCODE 0
2005 2007 #define NVS_OP_DECODE 1
2006 2008 #define NVS_OP_GETSIZE 2
2007 2009
2008 2010 typedef struct nvs_ops nvs_ops_t;
2009 2011
2010 2012 typedef struct {
2011 2013 int nvs_op;
2012 2014 const nvs_ops_t *nvs_ops;
2013 2015 void *nvs_private;
2014 2016 nvpriv_t *nvs_priv;
2015 2017 } nvstream_t;
2016 2018
2017 2019 /*
2018 2020 * nvs operations are:
2019 2021 * - nvs_nvlist
2020 2022 * encoding / decoding of a nvlist header (nvlist_t)
2021 2023 * calculates the size used for header and end detection
2022 2024 *
2023 2025 * - nvs_nvpair
2024 2026 * responsible for the first part of encoding / decoding of an nvpair
2025 2027 * calculates the decoded size of an nvpair
2026 2028 *
2027 2029 * - nvs_nvp_op
2028 2030 * second part of encoding / decoding of an nvpair
2029 2031 *
2030 2032 * - nvs_nvp_size
2031 2033 * calculates the encoding size of an nvpair
2032 2034 *
2033 2035 * - nvs_nvl_fini
2034 2036 * encodes the end detection mark (zeros).
2035 2037 */
2036 2038 struct nvs_ops {
2037 2039 int (*nvs_nvlist)(nvstream_t *, nvlist_t *, size_t *);
2038 2040 int (*nvs_nvpair)(nvstream_t *, nvpair_t *, size_t *);
2039 2041 int (*nvs_nvp_op)(nvstream_t *, nvpair_t *);
2040 2042 int (*nvs_nvp_size)(nvstream_t *, nvpair_t *, size_t *);
2041 2043 int (*nvs_nvl_fini)(nvstream_t *);
2042 2044 };
2043 2045
2044 2046 typedef struct {
2045 2047 char nvh_encoding; /* nvs encoding method */
2046 2048 char nvh_endian; /* nvs endian */
2047 2049 char nvh_reserved1; /* reserved for future use */
2048 2050 char nvh_reserved2; /* reserved for future use */
2049 2051 } nvs_header_t;
2050 2052
2051 2053 static int
2052 2054 nvs_encode_pairs(nvstream_t *nvs, nvlist_t *nvl)
2053 2055 {
2054 2056 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
2055 2057 i_nvp_t *curr;
2056 2058
2057 2059 /*
2058 2060 * Walk nvpair in list and encode each nvpair
2059 2061 */
2060 2062 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next)
2061 2063 if (nvs->nvs_ops->nvs_nvpair(nvs, &curr->nvi_nvp, NULL) != 0)
2062 2064 return (EFAULT);
2063 2065
2064 2066 return (nvs->nvs_ops->nvs_nvl_fini(nvs));
2065 2067 }
2066 2068
2067 2069 static int
2068 2070 nvs_decode_pairs(nvstream_t *nvs, nvlist_t *nvl)
2069 2071 {
2070 2072 nvpair_t *nvp;
2071 2073 size_t nvsize;
2072 2074 int err;
2073 2075
2074 2076 /*
2075 2077 * Get decoded size of next pair in stream, alloc
2076 2078 * memory for nvpair_t, then decode the nvpair
2077 2079 */
2078 2080 while ((err = nvs->nvs_ops->nvs_nvpair(nvs, NULL, &nvsize)) == 0) {
2079 2081 if (nvsize == 0) /* end of list */
2080 2082 break;
2081 2083
2082 2084 /* make sure len makes sense */
2083 2085 if (nvsize < NVP_SIZE_CALC(1, 0))
2084 2086 return (EFAULT);
2085 2087
2086 2088 if ((nvp = nvp_buf_alloc(nvl, nvsize)) == NULL)
2087 2089 return (ENOMEM);
2088 2090
2089 2091 if ((err = nvs->nvs_ops->nvs_nvp_op(nvs, nvp)) != 0) {
2090 2092 nvp_buf_free(nvl, nvp);
2091 2093 return (err);
2092 2094 }
2093 2095
2094 2096 if (i_validate_nvpair(nvp) != 0) {
2095 2097 nvpair_free(nvp);
2096 2098 nvp_buf_free(nvl, nvp);
2097 2099 return (EFAULT);
2098 2100 }
2099 2101
2100 2102 nvp_buf_link(nvl, nvp);
2101 2103 }
2102 2104 return (err);
2103 2105 }
2104 2106
2105 2107 static int
2106 2108 nvs_getsize_pairs(nvstream_t *nvs, nvlist_t *nvl, size_t *buflen)
2107 2109 {
2108 2110 nvpriv_t *priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv;
2109 2111 i_nvp_t *curr;
2110 2112 uint64_t nvsize = *buflen;
2111 2113 size_t size;
2112 2114
2113 2115 /*
2114 2116 * Get encoded size of nvpairs in nvlist
2115 2117 */
2116 2118 for (curr = priv->nvp_list; curr != NULL; curr = curr->nvi_next) {
2117 2119 if (nvs->nvs_ops->nvs_nvp_size(nvs, &curr->nvi_nvp, &size) != 0)
2118 2120 return (EINVAL);
2119 2121
2120 2122 if ((nvsize += size) > INT32_MAX)
2121 2123 return (EINVAL);
2122 2124 }
2123 2125
2124 2126 *buflen = nvsize;
2125 2127 return (0);
2126 2128 }
2127 2129
2128 2130 static int
2129 2131 nvs_operation(nvstream_t *nvs, nvlist_t *nvl, size_t *buflen)
2130 2132 {
2131 2133 int err;
2132 2134
2133 2135 if (nvl->nvl_priv == 0)
2134 2136 return (EFAULT);
2135 2137
2136 2138 /*
2137 2139 * Perform the operation, starting with header, then each nvpair
2138 2140 */
2139 2141 if ((err = nvs->nvs_ops->nvs_nvlist(nvs, nvl, buflen)) != 0)
2140 2142 return (err);
2141 2143
2142 2144 switch (nvs->nvs_op) {
2143 2145 case NVS_OP_ENCODE:
2144 2146 err = nvs_encode_pairs(nvs, nvl);
2145 2147 break;
2146 2148
2147 2149 case NVS_OP_DECODE:
2148 2150 err = nvs_decode_pairs(nvs, nvl);
2149 2151 break;
2150 2152
2151 2153 case NVS_OP_GETSIZE:
2152 2154 err = nvs_getsize_pairs(nvs, nvl, buflen);
2153 2155 break;
2154 2156
2155 2157 default:
2156 2158 err = EINVAL;
2157 2159 }
2158 2160
2159 2161 return (err);
2160 2162 }
2161 2163
2162 2164 static int
2163 2165 nvs_embedded(nvstream_t *nvs, nvlist_t *embedded)
2164 2166 {
2165 2167 switch (nvs->nvs_op) {
2166 2168 case NVS_OP_ENCODE:
2167 2169 return (nvs_operation(nvs, embedded, NULL));
2168 2170
2169 2171 case NVS_OP_DECODE: {
2170 2172 nvpriv_t *priv;
2171 2173 int err;
2172 2174
2173 2175 if (embedded->nvl_version != NV_VERSION)
2174 2176 return (ENOTSUP);
2175 2177
2176 2178 if ((priv = nv_priv_alloc_embedded(nvs->nvs_priv)) == NULL)
2177 2179 return (ENOMEM);
2178 2180
2179 2181 nvlist_init(embedded, embedded->nvl_nvflag, priv);
2180 2182
2181 2183 if ((err = nvs_operation(nvs, embedded, NULL)) != 0)
2182 2184 nvlist_free(embedded);
2183 2185 return (err);
2184 2186 }
2185 2187 default:
2186 2188 break;
2187 2189 }
2188 2190
2189 2191 return (EINVAL);
2190 2192 }
2191 2193
2192 2194 static int
2193 2195 nvs_embedded_nvl_array(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
2194 2196 {
2195 2197 size_t nelem = NVP_NELEM(nvp);
2196 2198 nvlist_t **nvlp = EMBEDDED_NVL_ARRAY(nvp);
2197 2199 int i;
2198 2200
2199 2201 switch (nvs->nvs_op) {
2200 2202 case NVS_OP_ENCODE:
2201 2203 for (i = 0; i < nelem; i++)
2202 2204 if (nvs_embedded(nvs, nvlp[i]) != 0)
2203 2205 return (EFAULT);
2204 2206 break;
2205 2207
2206 2208 case NVS_OP_DECODE: {
2207 2209 size_t len = nelem * sizeof (uint64_t);
2208 2210 nvlist_t *embedded = (nvlist_t *)((uintptr_t)nvlp + len);
2209 2211
2210 2212 bzero(nvlp, len); /* don't trust packed data */
2211 2213 for (i = 0; i < nelem; i++) {
2212 2214 if (nvs_embedded(nvs, embedded) != 0) {
2213 2215 nvpair_free(nvp);
2214 2216 return (EFAULT);
2215 2217 }
2216 2218
2217 2219 nvlp[i] = embedded++;
2218 2220 }
2219 2221 break;
2220 2222 }
2221 2223 case NVS_OP_GETSIZE: {
2222 2224 uint64_t nvsize = 0;
2223 2225
2224 2226 for (i = 0; i < nelem; i++) {
2225 2227 size_t nvp_sz = 0;
2226 2228
2227 2229 if (nvs_operation(nvs, nvlp[i], &nvp_sz) != 0)
2228 2230 return (EINVAL);
2229 2231
2230 2232 if ((nvsize += nvp_sz) > INT32_MAX)
2231 2233 return (EINVAL);
2232 2234 }
2233 2235
2234 2236 *size = nvsize;
2235 2237 break;
2236 2238 }
2237 2239 default:
2238 2240 return (EINVAL);
2239 2241 }
2240 2242
2241 2243 return (0);
2242 2244 }
2243 2245
2244 2246 static int nvs_native(nvstream_t *, nvlist_t *, char *, size_t *);
2245 2247 static int nvs_xdr(nvstream_t *, nvlist_t *, char *, size_t *);
2246 2248
2247 2249 /*
2248 2250 * Common routine for nvlist operations:
2249 2251 * encode, decode, getsize (encoded size).
2250 2252 */
2251 2253 static int
2252 2254 nvlist_common(nvlist_t *nvl, char *buf, size_t *buflen, int encoding,
2253 2255 int nvs_op)
2254 2256 {
2255 2257 int err = 0;
2256 2258 nvstream_t nvs;
2257 2259 int nvl_endian;
2258 2260 #ifdef _LITTLE_ENDIAN
2259 2261 int host_endian = 1;
2260 2262 #else
2261 2263 int host_endian = 0;
2262 2264 #endif /* _LITTLE_ENDIAN */
2263 2265 nvs_header_t *nvh = (void *)buf;
2264 2266
2265 2267 if (buflen == NULL || nvl == NULL ||
2266 2268 (nvs.nvs_priv = (nvpriv_t *)(uintptr_t)nvl->nvl_priv) == NULL)
2267 2269 return (EINVAL);
2268 2270
2269 2271 nvs.nvs_op = nvs_op;
2270 2272
2271 2273 /*
2272 2274 * For NVS_OP_ENCODE and NVS_OP_DECODE make sure an nvlist and
2273 2275 * a buffer is allocated. The first 4 bytes in the buffer are
2274 2276 * used for encoding method and host endian.
2275 2277 */
2276 2278 switch (nvs_op) {
2277 2279 case NVS_OP_ENCODE:
2278 2280 if (buf == NULL || *buflen < sizeof (nvs_header_t))
2279 2281 return (EINVAL);
2280 2282
2281 2283 nvh->nvh_encoding = encoding;
2282 2284 nvh->nvh_endian = nvl_endian = host_endian;
2283 2285 nvh->nvh_reserved1 = 0;
2284 2286 nvh->nvh_reserved2 = 0;
2285 2287 break;
2286 2288
2287 2289 case NVS_OP_DECODE:
2288 2290 if (buf == NULL || *buflen < sizeof (nvs_header_t))
2289 2291 return (EINVAL);
2290 2292
2291 2293 /* get method of encoding from first byte */
2292 2294 encoding = nvh->nvh_encoding;
2293 2295 nvl_endian = nvh->nvh_endian;
2294 2296 break;
2295 2297
2296 2298 case NVS_OP_GETSIZE:
2297 2299 nvl_endian = host_endian;
2298 2300
2299 2301 /*
2300 2302 * add the size for encoding
2301 2303 */
2302 2304 *buflen = sizeof (nvs_header_t);
2303 2305 break;
2304 2306
2305 2307 default:
2306 2308 return (ENOTSUP);
2307 2309 }
2308 2310
2309 2311 /*
2310 2312 * Create an nvstream with proper encoding method
2311 2313 */
2312 2314 switch (encoding) {
2313 2315 case NV_ENCODE_NATIVE:
2314 2316 /*
2315 2317 * check endianness, in case we are unpacking
2316 2318 * from a file
2317 2319 */
2318 2320 if (nvl_endian != host_endian)
2319 2321 return (ENOTSUP);
2320 2322 err = nvs_native(&nvs, nvl, buf, buflen);
2321 2323 break;
2322 2324 case NV_ENCODE_XDR:
2323 2325 err = nvs_xdr(&nvs, nvl, buf, buflen);
2324 2326 break;
2325 2327 default:
2326 2328 err = ENOTSUP;
2327 2329 break;
2328 2330 }
2329 2331
2330 2332 return (err);
2331 2333 }
2332 2334
2333 2335 int
2334 2336 nvlist_size(nvlist_t *nvl, size_t *size, int encoding)
2335 2337 {
2336 2338 return (nvlist_common(nvl, NULL, size, encoding, NVS_OP_GETSIZE));
2337 2339 }
2338 2340
2339 2341 /*
2340 2342 * Pack nvlist into contiguous memory
2341 2343 */
2342 2344 /*ARGSUSED1*/
2343 2345 int
2344 2346 nvlist_pack(nvlist_t *nvl, char **bufp, size_t *buflen, int encoding,
2345 2347 int kmflag)
2346 2348 {
2347 2349 #if defined(_KERNEL) && !defined(_BOOT)
2348 2350 return (nvlist_xpack(nvl, bufp, buflen, encoding,
2349 2351 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
2350 2352 #else
2351 2353 return (nvlist_xpack(nvl, bufp, buflen, encoding, nv_alloc_nosleep));
2352 2354 #endif
2353 2355 }
2354 2356
2355 2357 int
2356 2358 nvlist_xpack(nvlist_t *nvl, char **bufp, size_t *buflen, int encoding,
2357 2359 nv_alloc_t *nva)
2358 2360 {
2359 2361 nvpriv_t nvpriv;
2360 2362 size_t alloc_size;
2361 2363 char *buf;
2362 2364 int err;
2363 2365
2364 2366 if (nva == NULL || nvl == NULL || bufp == NULL || buflen == NULL)
2365 2367 return (EINVAL);
2366 2368
2367 2369 if (*bufp != NULL)
2368 2370 return (nvlist_common(nvl, *bufp, buflen, encoding,
2369 2371 NVS_OP_ENCODE));
2370 2372
2371 2373 /*
2372 2374 * Here is a difficult situation:
2373 2375 * 1. The nvlist has fixed allocator properties.
2374 2376 * All other nvlist routines (like nvlist_add_*, ...) use
|
↓ open down ↓ |
737 lines elided |
↑ open up ↑ |
2375 2377 * these properties.
2376 2378 * 2. When using nvlist_pack() the user can specify his own
2377 2379 * allocator properties (e.g. by using KM_NOSLEEP).
2378 2380 *
2379 2381 * We use the user specified properties (2). A clearer solution
2380 2382 * will be to remove the kmflag from nvlist_pack(), but we will
2381 2383 * not change the interface.
2382 2384 */
2383 2385 nv_priv_init(&nvpriv, nva, 0);
2384 2386
2385 - if (err = nvlist_size(nvl, &alloc_size, encoding))
2387 + if ((err = nvlist_size(nvl, &alloc_size, encoding)))
2386 2388 return (err);
2387 2389
2388 2390 if ((buf = nv_mem_zalloc(&nvpriv, alloc_size)) == NULL)
2389 2391 return (ENOMEM);
2390 2392
2391 2393 if ((err = nvlist_common(nvl, buf, &alloc_size, encoding,
2392 2394 NVS_OP_ENCODE)) != 0) {
2393 2395 nv_mem_free(&nvpriv, buf, alloc_size);
2394 2396 } else {
2395 2397 *buflen = alloc_size;
2396 2398 *bufp = buf;
2397 2399 }
2398 2400
2399 2401 return (err);
2400 2402 }
2401 2403
2402 2404 /*
2403 2405 * Unpack buf into an nvlist_t
2404 2406 */
2405 2407 /*ARGSUSED1*/
2406 2408 int
2407 2409 nvlist_unpack(char *buf, size_t buflen, nvlist_t **nvlp, int kmflag)
2408 2410 {
2409 2411 #if defined(_KERNEL) && !defined(_BOOT)
2410 2412 return (nvlist_xunpack(buf, buflen, nvlp,
2411 2413 (kmflag == KM_SLEEP ? nv_alloc_sleep : nv_alloc_nosleep)));
2412 2414 #else
2413 2415 return (nvlist_xunpack(buf, buflen, nvlp, nv_alloc_nosleep));
2414 2416 #endif
2415 2417 }
2416 2418
2417 2419 int
2418 2420 nvlist_xunpack(char *buf, size_t buflen, nvlist_t **nvlp, nv_alloc_t *nva)
2419 2421 {
2420 2422 nvlist_t *nvl;
2421 2423 int err;
2422 2424
2423 2425 if (nvlp == NULL)
2424 2426 return (EINVAL);
2425 2427
2426 2428 if ((err = nvlist_xalloc(&nvl, 0, nva)) != 0)
2427 2429 return (err);
2428 2430
2429 2431 if ((err = nvlist_common(nvl, buf, &buflen, 0, NVS_OP_DECODE)) != 0)
2430 2432 nvlist_free(nvl);
2431 2433 else
2432 2434 *nvlp = nvl;
2433 2435
2434 2436 return (err);
2435 2437 }
2436 2438
2437 2439 /*
2438 2440 * Native encoding functions
2439 2441 */
2440 2442 typedef struct {
2441 2443 /*
2442 2444 * This structure is used when decoding a packed nvpair in
2443 2445 * the native format. n_base points to a buffer containing the
2444 2446 * packed nvpair. n_end is a pointer to the end of the buffer.
2445 2447 * (n_end actually points to the first byte past the end of the
2446 2448 * buffer.) n_curr is a pointer that lies between n_base and n_end.
2447 2449 * It points to the current data that we are decoding.
2448 2450 * The amount of data left in the buffer is equal to n_end - n_curr.
2449 2451 * n_flag is used to recognize a packed embedded list.
2450 2452 */
2451 2453 caddr_t n_base;
2452 2454 caddr_t n_end;
2453 2455 caddr_t n_curr;
2454 2456 uint_t n_flag;
2455 2457 } nvs_native_t;
2456 2458
2457 2459 static int
2458 2460 nvs_native_create(nvstream_t *nvs, nvs_native_t *native, char *buf,
2459 2461 size_t buflen)
2460 2462 {
2461 2463 switch (nvs->nvs_op) {
2462 2464 case NVS_OP_ENCODE:
2463 2465 case NVS_OP_DECODE:
2464 2466 nvs->nvs_private = native;
2465 2467 native->n_curr = native->n_base = buf;
2466 2468 native->n_end = buf + buflen;
2467 2469 native->n_flag = 0;
2468 2470 return (0);
2469 2471
2470 2472 case NVS_OP_GETSIZE:
2471 2473 nvs->nvs_private = native;
2472 2474 native->n_curr = native->n_base = native->n_end = NULL;
2473 2475 native->n_flag = 0;
2474 2476 return (0);
2475 2477 default:
2476 2478 return (EINVAL);
2477 2479 }
2478 2480 }
2479 2481
2480 2482 /*ARGSUSED*/
2481 2483 static void
2482 2484 nvs_native_destroy(nvstream_t *nvs)
2483 2485 {
2484 2486 }
2485 2487
2486 2488 static int
2487 2489 native_cp(nvstream_t *nvs, void *buf, size_t size)
2488 2490 {
2489 2491 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2490 2492
2491 2493 if (native->n_curr + size > native->n_end)
2492 2494 return (EFAULT);
2493 2495
2494 2496 /*
2495 2497 * The bcopy() below eliminates alignment requirement
2496 2498 * on the buffer (stream) and is preferred over direct access.
2497 2499 */
2498 2500 switch (nvs->nvs_op) {
2499 2501 case NVS_OP_ENCODE:
2500 2502 bcopy(buf, native->n_curr, size);
2501 2503 break;
2502 2504 case NVS_OP_DECODE:
2503 2505 bcopy(native->n_curr, buf, size);
2504 2506 break;
2505 2507 default:
2506 2508 return (EINVAL);
2507 2509 }
2508 2510
2509 2511 native->n_curr += size;
2510 2512 return (0);
2511 2513 }
2512 2514
2513 2515 /*
2514 2516 * operate on nvlist_t header
2515 2517 */
2516 2518 static int
2517 2519 nvs_native_nvlist(nvstream_t *nvs, nvlist_t *nvl, size_t *size)
2518 2520 {
2519 2521 nvs_native_t *native = nvs->nvs_private;
2520 2522
2521 2523 switch (nvs->nvs_op) {
2522 2524 case NVS_OP_ENCODE:
2523 2525 case NVS_OP_DECODE:
2524 2526 if (native->n_flag)
2525 2527 return (0); /* packed embedded list */
2526 2528
2527 2529 native->n_flag = 1;
2528 2530
2529 2531 /* copy version and nvflag of the nvlist_t */
2530 2532 if (native_cp(nvs, &nvl->nvl_version, sizeof (int32_t)) != 0 ||
2531 2533 native_cp(nvs, &nvl->nvl_nvflag, sizeof (int32_t)) != 0)
2532 2534 return (EFAULT);
2533 2535
2534 2536 return (0);
2535 2537
2536 2538 case NVS_OP_GETSIZE:
2537 2539 /*
2538 2540 * if calculate for packed embedded list
2539 2541 * 4 for end of the embedded list
2540 2542 * else
2541 2543 * 2 * sizeof (int32_t) for nvl_version and nvl_nvflag
2542 2544 * and 4 for end of the entire list
2543 2545 */
2544 2546 if (native->n_flag) {
2545 2547 *size += 4;
2546 2548 } else {
2547 2549 native->n_flag = 1;
2548 2550 *size += 2 * sizeof (int32_t) + 4;
2549 2551 }
2550 2552
2551 2553 return (0);
2552 2554
2553 2555 default:
2554 2556 return (EINVAL);
2555 2557 }
2556 2558 }
2557 2559
2558 2560 static int
2559 2561 nvs_native_nvl_fini(nvstream_t *nvs)
2560 2562 {
2561 2563 if (nvs->nvs_op == NVS_OP_ENCODE) {
2562 2564 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2563 2565 /*
2564 2566 * Add 4 zero bytes at end of nvlist. They are used
2565 2567 * for end detection by the decode routine.
2566 2568 */
2567 2569 if (native->n_curr + sizeof (int) > native->n_end)
2568 2570 return (EFAULT);
2569 2571
2570 2572 bzero(native->n_curr, sizeof (int));
2571 2573 native->n_curr += sizeof (int);
2572 2574 }
2573 2575
2574 2576 return (0);
2575 2577 }
2576 2578
2577 2579 static int
2578 2580 nvpair_native_embedded(nvstream_t *nvs, nvpair_t *nvp)
2579 2581 {
2580 2582 if (nvs->nvs_op == NVS_OP_ENCODE) {
2581 2583 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2582 2584 nvlist_t *packed = (void *)
2583 2585 (native->n_curr - nvp->nvp_size + NVP_VALOFF(nvp));
2584 2586 /*
2585 2587 * Null out the pointer that is meaningless in the packed
2586 2588 * structure. The address may not be aligned, so we have
2587 2589 * to use bzero.
2588 2590 */
2589 2591 bzero(&packed->nvl_priv, sizeof (packed->nvl_priv));
2590 2592 }
2591 2593
2592 2594 return (nvs_embedded(nvs, EMBEDDED_NVL(nvp)));
2593 2595 }
2594 2596
2595 2597 static int
2596 2598 nvpair_native_embedded_array(nvstream_t *nvs, nvpair_t *nvp)
2597 2599 {
2598 2600 if (nvs->nvs_op == NVS_OP_ENCODE) {
2599 2601 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2600 2602 char *value = native->n_curr - nvp->nvp_size + NVP_VALOFF(nvp);
2601 2603 size_t len = NVP_NELEM(nvp) * sizeof (uint64_t);
2602 2604 nvlist_t *packed = (nvlist_t *)((uintptr_t)value + len);
2603 2605 int i;
2604 2606 /*
2605 2607 * Null out pointers that are meaningless in the packed
2606 2608 * structure. The addresses may not be aligned, so we have
2607 2609 * to use bzero.
2608 2610 */
2609 2611 bzero(value, len);
2610 2612
2611 2613 for (i = 0; i < NVP_NELEM(nvp); i++, packed++)
2612 2614 /*
2613 2615 * Null out the pointer that is meaningless in the
2614 2616 * packed structure. The address may not be aligned,
2615 2617 * so we have to use bzero.
2616 2618 */
2617 2619 bzero(&packed->nvl_priv, sizeof (packed->nvl_priv));
2618 2620 }
2619 2621
2620 2622 return (nvs_embedded_nvl_array(nvs, nvp, NULL));
2621 2623 }
2622 2624
2623 2625 static void
2624 2626 nvpair_native_string_array(nvstream_t *nvs, nvpair_t *nvp)
2625 2627 {
2626 2628 switch (nvs->nvs_op) {
2627 2629 case NVS_OP_ENCODE: {
2628 2630 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2629 2631 uint64_t *strp = (void *)
2630 2632 (native->n_curr - nvp->nvp_size + NVP_VALOFF(nvp));
2631 2633 /*
2632 2634 * Null out pointers that are meaningless in the packed
2633 2635 * structure. The addresses may not be aligned, so we have
2634 2636 * to use bzero.
2635 2637 */
2636 2638 bzero(strp, NVP_NELEM(nvp) * sizeof (uint64_t));
2637 2639 break;
2638 2640 }
2639 2641 case NVS_OP_DECODE: {
2640 2642 char **strp = (void *)NVP_VALUE(nvp);
2641 2643 char *buf = ((char *)strp + NVP_NELEM(nvp) * sizeof (uint64_t));
2642 2644 int i;
2643 2645
2644 2646 for (i = 0; i < NVP_NELEM(nvp); i++) {
2645 2647 strp[i] = buf;
2646 2648 buf += strlen(buf) + 1;
2647 2649 }
2648 2650 break;
2649 2651 }
2650 2652 }
2651 2653 }
2652 2654
2653 2655 static int
2654 2656 nvs_native_nvp_op(nvstream_t *nvs, nvpair_t *nvp)
2655 2657 {
2656 2658 data_type_t type;
2657 2659 int value_sz;
2658 2660 int ret = 0;
2659 2661
2660 2662 /*
2661 2663 * We do the initial bcopy of the data before we look at
2662 2664 * the nvpair type, because when we're decoding, we won't
2663 2665 * have the correct values for the pair until we do the bcopy.
2664 2666 */
2665 2667 switch (nvs->nvs_op) {
2666 2668 case NVS_OP_ENCODE:
2667 2669 case NVS_OP_DECODE:
2668 2670 if (native_cp(nvs, nvp, nvp->nvp_size) != 0)
2669 2671 return (EFAULT);
2670 2672 break;
2671 2673 default:
2672 2674 return (EINVAL);
2673 2675 }
2674 2676
2675 2677 /* verify nvp_name_sz, check the name string length */
2676 2678 if (i_validate_nvpair_name(nvp) != 0)
2677 2679 return (EFAULT);
2678 2680
2679 2681 type = NVP_TYPE(nvp);
2680 2682
2681 2683 /*
2682 2684 * Verify type and nelem and get the value size.
2683 2685 * In case of data types DATA_TYPE_STRING and DATA_TYPE_STRING_ARRAY
2684 2686 * is the size of the string(s) excluded.
2685 2687 */
2686 2688 if ((value_sz = i_get_value_size(type, NULL, NVP_NELEM(nvp))) < 0)
2687 2689 return (EFAULT);
2688 2690
2689 2691 if (NVP_SIZE_CALC(nvp->nvp_name_sz, value_sz) > nvp->nvp_size)
2690 2692 return (EFAULT);
2691 2693
2692 2694 switch (type) {
2693 2695 case DATA_TYPE_NVLIST:
2694 2696 ret = nvpair_native_embedded(nvs, nvp);
2695 2697 break;
2696 2698 case DATA_TYPE_NVLIST_ARRAY:
2697 2699 ret = nvpair_native_embedded_array(nvs, nvp);
2698 2700 break;
2699 2701 case DATA_TYPE_STRING_ARRAY:
2700 2702 nvpair_native_string_array(nvs, nvp);
2701 2703 break;
2702 2704 default:
2703 2705 break;
2704 2706 }
2705 2707
2706 2708 return (ret);
2707 2709 }
2708 2710
2709 2711 static int
2710 2712 nvs_native_nvp_size(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
2711 2713 {
2712 2714 uint64_t nvp_sz = nvp->nvp_size;
2713 2715
2714 2716 switch (NVP_TYPE(nvp)) {
2715 2717 case DATA_TYPE_NVLIST: {
2716 2718 size_t nvsize = 0;
2717 2719
2718 2720 if (nvs_operation(nvs, EMBEDDED_NVL(nvp), &nvsize) != 0)
2719 2721 return (EINVAL);
2720 2722
2721 2723 nvp_sz += nvsize;
2722 2724 break;
2723 2725 }
2724 2726 case DATA_TYPE_NVLIST_ARRAY: {
2725 2727 size_t nvsize;
2726 2728
2727 2729 if (nvs_embedded_nvl_array(nvs, nvp, &nvsize) != 0)
2728 2730 return (EINVAL);
2729 2731
2730 2732 nvp_sz += nvsize;
2731 2733 break;
2732 2734 }
2733 2735 default:
2734 2736 break;
2735 2737 }
2736 2738
2737 2739 if (nvp_sz > INT32_MAX)
2738 2740 return (EINVAL);
2739 2741
2740 2742 *size = nvp_sz;
2741 2743
2742 2744 return (0);
2743 2745 }
2744 2746
2745 2747 static int
2746 2748 nvs_native_nvpair(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
2747 2749 {
2748 2750 switch (nvs->nvs_op) {
2749 2751 case NVS_OP_ENCODE:
2750 2752 return (nvs_native_nvp_op(nvs, nvp));
2751 2753
2752 2754 case NVS_OP_DECODE: {
2753 2755 nvs_native_t *native = (nvs_native_t *)nvs->nvs_private;
2754 2756 int32_t decode_len;
2755 2757
2756 2758 /* try to read the size value from the stream */
2757 2759 if (native->n_curr + sizeof (int32_t) > native->n_end)
2758 2760 return (EFAULT);
2759 2761 bcopy(native->n_curr, &decode_len, sizeof (int32_t));
2760 2762
2761 2763 /* sanity check the size value */
2762 2764 if (decode_len < 0 ||
2763 2765 decode_len > native->n_end - native->n_curr)
2764 2766 return (EFAULT);
2765 2767
2766 2768 *size = decode_len;
2767 2769
2768 2770 /*
2769 2771 * If at the end of the stream then move the cursor
2770 2772 * forward, otherwise nvpair_native_op() will read
2771 2773 * the entire nvpair at the same cursor position.
2772 2774 */
2773 2775 if (*size == 0)
2774 2776 native->n_curr += sizeof (int32_t);
2775 2777 break;
2776 2778 }
2777 2779
2778 2780 default:
2779 2781 return (EINVAL);
2780 2782 }
2781 2783
2782 2784 return (0);
2783 2785 }
2784 2786
2785 2787 static const nvs_ops_t nvs_native_ops = {
2786 2788 nvs_native_nvlist,
2787 2789 nvs_native_nvpair,
2788 2790 nvs_native_nvp_op,
2789 2791 nvs_native_nvp_size,
2790 2792 nvs_native_nvl_fini
2791 2793 };
2792 2794
2793 2795 static int
2794 2796 nvs_native(nvstream_t *nvs, nvlist_t *nvl, char *buf, size_t *buflen)
2795 2797 {
2796 2798 nvs_native_t native;
2797 2799 int err;
2798 2800
2799 2801 nvs->nvs_ops = &nvs_native_ops;
2800 2802
2801 2803 if ((err = nvs_native_create(nvs, &native, buf + sizeof (nvs_header_t),
2802 2804 *buflen - sizeof (nvs_header_t))) != 0)
2803 2805 return (err);
2804 2806
2805 2807 err = nvs_operation(nvs, nvl, buflen);
2806 2808
2807 2809 nvs_native_destroy(nvs);
2808 2810
2809 2811 return (err);
2810 2812 }
2811 2813
2812 2814 /*
2813 2815 * XDR encoding functions
2814 2816 *
2815 2817 * An xdr packed nvlist is encoded as:
2816 2818 *
2817 2819 * - encoding methode and host endian (4 bytes)
2818 2820 * - nvl_version (4 bytes)
2819 2821 * - nvl_nvflag (4 bytes)
2820 2822 *
2821 2823 * - encoded nvpairs, the format of one xdr encoded nvpair is:
2822 2824 * - encoded size of the nvpair (4 bytes)
2823 2825 * - decoded size of the nvpair (4 bytes)
2824 2826 * - name string, (4 + sizeof(NV_ALIGN4(string))
2825 2827 * a string is coded as size (4 bytes) and data
2826 2828 * - data type (4 bytes)
2827 2829 * - number of elements in the nvpair (4 bytes)
2828 2830 * - data
2829 2831 *
2830 2832 * - 2 zero's for end of the entire list (8 bytes)
2831 2833 */
2832 2834 static int
2833 2835 nvs_xdr_create(nvstream_t *nvs, XDR *xdr, char *buf, size_t buflen)
2834 2836 {
2835 2837 /* xdr data must be 4 byte aligned */
2836 2838 if ((ulong_t)buf % 4 != 0)
2837 2839 return (EFAULT);
2838 2840
2839 2841 switch (nvs->nvs_op) {
2840 2842 case NVS_OP_ENCODE:
2841 2843 xdrmem_create(xdr, buf, (uint_t)buflen, XDR_ENCODE);
2842 2844 nvs->nvs_private = xdr;
2843 2845 return (0);
2844 2846 case NVS_OP_DECODE:
2845 2847 xdrmem_create(xdr, buf, (uint_t)buflen, XDR_DECODE);
2846 2848 nvs->nvs_private = xdr;
2847 2849 return (0);
2848 2850 case NVS_OP_GETSIZE:
2849 2851 nvs->nvs_private = NULL;
2850 2852 return (0);
2851 2853 default:
2852 2854 return (EINVAL);
2853 2855 }
2854 2856 }
2855 2857
2856 2858 static void
2857 2859 nvs_xdr_destroy(nvstream_t *nvs)
2858 2860 {
2859 2861 switch (nvs->nvs_op) {
2860 2862 case NVS_OP_ENCODE:
2861 2863 case NVS_OP_DECODE:
2862 2864 xdr_destroy((XDR *)nvs->nvs_private);
2863 2865 break;
2864 2866 default:
2865 2867 break;
2866 2868 }
2867 2869 }
2868 2870
2869 2871 static int
2870 2872 nvs_xdr_nvlist(nvstream_t *nvs, nvlist_t *nvl, size_t *size)
2871 2873 {
2872 2874 switch (nvs->nvs_op) {
2873 2875 case NVS_OP_ENCODE:
2874 2876 case NVS_OP_DECODE: {
2875 2877 XDR *xdr = nvs->nvs_private;
2876 2878
2877 2879 if (!xdr_int(xdr, &nvl->nvl_version) ||
2878 2880 !xdr_u_int(xdr, &nvl->nvl_nvflag))
2879 2881 return (EFAULT);
2880 2882 break;
2881 2883 }
2882 2884 case NVS_OP_GETSIZE: {
2883 2885 /*
2884 2886 * 2 * 4 for nvl_version + nvl_nvflag
2885 2887 * and 8 for end of the entire list
2886 2888 */
2887 2889 *size += 2 * 4 + 8;
2888 2890 break;
2889 2891 }
2890 2892 default:
2891 2893 return (EINVAL);
2892 2894 }
2893 2895 return (0);
2894 2896 }
2895 2897
2896 2898 static int
2897 2899 nvs_xdr_nvl_fini(nvstream_t *nvs)
2898 2900 {
2899 2901 if (nvs->nvs_op == NVS_OP_ENCODE) {
2900 2902 XDR *xdr = nvs->nvs_private;
2901 2903 int zero = 0;
2902 2904
2903 2905 if (!xdr_int(xdr, &zero) || !xdr_int(xdr, &zero))
2904 2906 return (EFAULT);
2905 2907 }
2906 2908
2907 2909 return (0);
2908 2910 }
2909 2911
2910 2912 /*
2911 2913 * The format of xdr encoded nvpair is:
2912 2914 * encode_size, decode_size, name string, data type, nelem, data
2913 2915 */
2914 2916 static int
2915 2917 nvs_xdr_nvp_op(nvstream_t *nvs, nvpair_t *nvp)
2916 2918 {
2917 2919 data_type_t type;
2918 2920 char *buf;
2919 2921 char *buf_end = (char *)nvp + nvp->nvp_size;
2920 2922 int value_sz;
2921 2923 uint_t nelem, buflen;
2922 2924 bool_t ret = FALSE;
2923 2925 XDR *xdr = nvs->nvs_private;
2924 2926
2925 2927 ASSERT(xdr != NULL && nvp != NULL);
2926 2928
2927 2929 /* name string */
2928 2930 if ((buf = NVP_NAME(nvp)) >= buf_end)
2929 2931 return (EFAULT);
2930 2932 buflen = buf_end - buf;
2931 2933
2932 2934 if (!xdr_string(xdr, &buf, buflen - 1))
2933 2935 return (EFAULT);
2934 2936 nvp->nvp_name_sz = strlen(buf) + 1;
2935 2937
2936 2938 /* type and nelem */
2937 2939 if (!xdr_int(xdr, (int *)&nvp->nvp_type) ||
2938 2940 !xdr_int(xdr, &nvp->nvp_value_elem))
2939 2941 return (EFAULT);
2940 2942
2941 2943 type = NVP_TYPE(nvp);
2942 2944 nelem = nvp->nvp_value_elem;
2943 2945
2944 2946 /*
2945 2947 * Verify type and nelem and get the value size.
2946 2948 * In case of data types DATA_TYPE_STRING and DATA_TYPE_STRING_ARRAY
2947 2949 * is the size of the string(s) excluded.
2948 2950 */
2949 2951 if ((value_sz = i_get_value_size(type, NULL, nelem)) < 0)
2950 2952 return (EFAULT);
2951 2953
2952 2954 /* if there is no data to extract then return */
2953 2955 if (nelem == 0)
2954 2956 return (0);
2955 2957
2956 2958 /* value */
2957 2959 if ((buf = NVP_VALUE(nvp)) >= buf_end)
2958 2960 return (EFAULT);
2959 2961 buflen = buf_end - buf;
2960 2962
2961 2963 if (buflen < value_sz)
2962 2964 return (EFAULT);
2963 2965
2964 2966 switch (type) {
2965 2967 case DATA_TYPE_NVLIST:
2966 2968 if (nvs_embedded(nvs, (void *)buf) == 0)
2967 2969 return (0);
2968 2970 break;
2969 2971
2970 2972 case DATA_TYPE_NVLIST_ARRAY:
2971 2973 if (nvs_embedded_nvl_array(nvs, nvp, NULL) == 0)
2972 2974 return (0);
2973 2975 break;
2974 2976
2975 2977 case DATA_TYPE_BOOLEAN:
2976 2978 ret = TRUE;
2977 2979 break;
2978 2980
2979 2981 case DATA_TYPE_BYTE:
2980 2982 case DATA_TYPE_INT8:
2981 2983 case DATA_TYPE_UINT8:
2982 2984 ret = xdr_char(xdr, buf);
2983 2985 break;
2984 2986
2985 2987 case DATA_TYPE_INT16:
2986 2988 ret = xdr_short(xdr, (void *)buf);
2987 2989 break;
2988 2990
2989 2991 case DATA_TYPE_UINT16:
2990 2992 ret = xdr_u_short(xdr, (void *)buf);
2991 2993 break;
2992 2994
2993 2995 case DATA_TYPE_BOOLEAN_VALUE:
2994 2996 case DATA_TYPE_INT32:
2995 2997 ret = xdr_int(xdr, (void *)buf);
2996 2998 break;
2997 2999
2998 3000 case DATA_TYPE_UINT32:
2999 3001 ret = xdr_u_int(xdr, (void *)buf);
3000 3002 break;
3001 3003
3002 3004 case DATA_TYPE_INT64:
3003 3005 ret = xdr_longlong_t(xdr, (void *)buf);
3004 3006 break;
3005 3007
3006 3008 case DATA_TYPE_UINT64:
3007 3009 ret = xdr_u_longlong_t(xdr, (void *)buf);
3008 3010 break;
3009 3011
3010 3012 case DATA_TYPE_HRTIME:
3011 3013 /*
3012 3014 * NOTE: must expose the definition of hrtime_t here
3013 3015 */
3014 3016 ret = xdr_longlong_t(xdr, (void *)buf);
3015 3017 break;
3016 3018 #if !defined(_KERNEL)
3017 3019 case DATA_TYPE_DOUBLE:
3018 3020 ret = xdr_double(xdr, (void *)buf);
3019 3021 break;
3020 3022 #endif
3021 3023 case DATA_TYPE_STRING:
3022 3024 ret = xdr_string(xdr, &buf, buflen - 1);
3023 3025 break;
3024 3026
3025 3027 case DATA_TYPE_BYTE_ARRAY:
3026 3028 ret = xdr_opaque(xdr, buf, nelem);
3027 3029 break;
3028 3030
3029 3031 case DATA_TYPE_INT8_ARRAY:
3030 3032 case DATA_TYPE_UINT8_ARRAY:
3031 3033 ret = xdr_array(xdr, &buf, &nelem, buflen, sizeof (int8_t),
3032 3034 (xdrproc_t)xdr_char);
3033 3035 break;
3034 3036
3035 3037 case DATA_TYPE_INT16_ARRAY:
3036 3038 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (int16_t),
3037 3039 sizeof (int16_t), (xdrproc_t)xdr_short);
3038 3040 break;
3039 3041
3040 3042 case DATA_TYPE_UINT16_ARRAY:
3041 3043 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (uint16_t),
3042 3044 sizeof (uint16_t), (xdrproc_t)xdr_u_short);
3043 3045 break;
3044 3046
3045 3047 case DATA_TYPE_BOOLEAN_ARRAY:
3046 3048 case DATA_TYPE_INT32_ARRAY:
3047 3049 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (int32_t),
3048 3050 sizeof (int32_t), (xdrproc_t)xdr_int);
3049 3051 break;
3050 3052
3051 3053 case DATA_TYPE_UINT32_ARRAY:
3052 3054 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (uint32_t),
3053 3055 sizeof (uint32_t), (xdrproc_t)xdr_u_int);
3054 3056 break;
3055 3057
3056 3058 case DATA_TYPE_INT64_ARRAY:
3057 3059 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (int64_t),
3058 3060 sizeof (int64_t), (xdrproc_t)xdr_longlong_t);
3059 3061 break;
3060 3062
3061 3063 case DATA_TYPE_UINT64_ARRAY:
3062 3064 ret = xdr_array(xdr, &buf, &nelem, buflen / sizeof (uint64_t),
3063 3065 sizeof (uint64_t), (xdrproc_t)xdr_u_longlong_t);
3064 3066 break;
3065 3067
3066 3068 case DATA_TYPE_STRING_ARRAY: {
3067 3069 size_t len = nelem * sizeof (uint64_t);
3068 3070 char **strp = (void *)buf;
3069 3071 int i;
3070 3072
3071 3073 if (nvs->nvs_op == NVS_OP_DECODE)
3072 3074 bzero(buf, len); /* don't trust packed data */
3073 3075
3074 3076 for (i = 0; i < nelem; i++) {
3075 3077 if (buflen <= len)
3076 3078 return (EFAULT);
3077 3079
3078 3080 buf += len;
3079 3081 buflen -= len;
3080 3082
3081 3083 if (xdr_string(xdr, &buf, buflen - 1) != TRUE)
3082 3084 return (EFAULT);
3083 3085
3084 3086 if (nvs->nvs_op == NVS_OP_DECODE)
3085 3087 strp[i] = buf;
3086 3088 len = strlen(buf) + 1;
3087 3089 }
3088 3090 ret = TRUE;
3089 3091 break;
3090 3092 }
3091 3093 default:
3092 3094 break;
3093 3095 }
3094 3096
3095 3097 return (ret == TRUE ? 0 : EFAULT);
3096 3098 }
3097 3099
3098 3100 static int
3099 3101 nvs_xdr_nvp_size(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
3100 3102 {
3101 3103 data_type_t type = NVP_TYPE(nvp);
3102 3104 /*
3103 3105 * encode_size + decode_size + name string size + data type + nelem
3104 3106 * where name string size = 4 + NV_ALIGN4(strlen(NVP_NAME(nvp)))
3105 3107 */
3106 3108 uint64_t nvp_sz = 4 + 4 + 4 + NV_ALIGN4(strlen(NVP_NAME(nvp))) + 4 + 4;
3107 3109
3108 3110 switch (type) {
3109 3111 case DATA_TYPE_BOOLEAN:
3110 3112 break;
3111 3113
3112 3114 case DATA_TYPE_BOOLEAN_VALUE:
3113 3115 case DATA_TYPE_BYTE:
3114 3116 case DATA_TYPE_INT8:
3115 3117 case DATA_TYPE_UINT8:
3116 3118 case DATA_TYPE_INT16:
3117 3119 case DATA_TYPE_UINT16:
3118 3120 case DATA_TYPE_INT32:
3119 3121 case DATA_TYPE_UINT32:
3120 3122 nvp_sz += 4; /* 4 is the minimum xdr unit */
3121 3123 break;
3122 3124
3123 3125 case DATA_TYPE_INT64:
3124 3126 case DATA_TYPE_UINT64:
3125 3127 case DATA_TYPE_HRTIME:
3126 3128 #if !defined(_KERNEL)
3127 3129 case DATA_TYPE_DOUBLE:
3128 3130 #endif
3129 3131 nvp_sz += 8;
3130 3132 break;
3131 3133
3132 3134 case DATA_TYPE_STRING:
3133 3135 nvp_sz += 4 + NV_ALIGN4(strlen((char *)NVP_VALUE(nvp)));
3134 3136 break;
3135 3137
3136 3138 case DATA_TYPE_BYTE_ARRAY:
3137 3139 nvp_sz += NV_ALIGN4(NVP_NELEM(nvp));
3138 3140 break;
3139 3141
3140 3142 case DATA_TYPE_BOOLEAN_ARRAY:
3141 3143 case DATA_TYPE_INT8_ARRAY:
3142 3144 case DATA_TYPE_UINT8_ARRAY:
3143 3145 case DATA_TYPE_INT16_ARRAY:
3144 3146 case DATA_TYPE_UINT16_ARRAY:
3145 3147 case DATA_TYPE_INT32_ARRAY:
3146 3148 case DATA_TYPE_UINT32_ARRAY:
3147 3149 nvp_sz += 4 + 4 * (uint64_t)NVP_NELEM(nvp);
3148 3150 break;
3149 3151
3150 3152 case DATA_TYPE_INT64_ARRAY:
3151 3153 case DATA_TYPE_UINT64_ARRAY:
3152 3154 nvp_sz += 4 + 8 * (uint64_t)NVP_NELEM(nvp);
3153 3155 break;
3154 3156
3155 3157 case DATA_TYPE_STRING_ARRAY: {
3156 3158 int i;
3157 3159 char **strs = (void *)NVP_VALUE(nvp);
3158 3160
3159 3161 for (i = 0; i < NVP_NELEM(nvp); i++)
3160 3162 nvp_sz += 4 + NV_ALIGN4(strlen(strs[i]));
3161 3163
3162 3164 break;
3163 3165 }
3164 3166
3165 3167 case DATA_TYPE_NVLIST:
3166 3168 case DATA_TYPE_NVLIST_ARRAY: {
3167 3169 size_t nvsize = 0;
3168 3170 int old_nvs_op = nvs->nvs_op;
3169 3171 int err;
3170 3172
3171 3173 nvs->nvs_op = NVS_OP_GETSIZE;
3172 3174 if (type == DATA_TYPE_NVLIST)
3173 3175 err = nvs_operation(nvs, EMBEDDED_NVL(nvp), &nvsize);
3174 3176 else
3175 3177 err = nvs_embedded_nvl_array(nvs, nvp, &nvsize);
3176 3178 nvs->nvs_op = old_nvs_op;
3177 3179
3178 3180 if (err != 0)
3179 3181 return (EINVAL);
3180 3182
3181 3183 nvp_sz += nvsize;
3182 3184 break;
3183 3185 }
3184 3186
3185 3187 default:
3186 3188 return (EINVAL);
3187 3189 }
3188 3190
3189 3191 if (nvp_sz > INT32_MAX)
3190 3192 return (EINVAL);
3191 3193
3192 3194 *size = nvp_sz;
3193 3195
3194 3196 return (0);
3195 3197 }
3196 3198
3197 3199
3198 3200 /*
3199 3201 * The NVS_XDR_MAX_LEN macro takes a packed xdr buffer of size x and estimates
3200 3202 * the largest nvpair that could be encoded in the buffer.
3201 3203 *
3202 3204 * See comments above nvpair_xdr_op() for the format of xdr encoding.
3203 3205 * The size of a xdr packed nvpair without any data is 5 words.
3204 3206 *
3205 3207 * Using the size of the data directly as an estimate would be ok
3206 3208 * in all cases except one. If the data type is of DATA_TYPE_STRING_ARRAY
3207 3209 * then the actual nvpair has space for an array of pointers to index
3208 3210 * the strings. These pointers are not encoded into the packed xdr buffer.
3209 3211 *
3210 3212 * If the data is of type DATA_TYPE_STRING_ARRAY and all the strings are
3211 3213 * of length 0, then each string is endcoded in xdr format as a single word.
3212 3214 * Therefore when expanded to an nvpair there will be 2.25 word used for
3213 3215 * each string. (a int64_t allocated for pointer usage, and a single char
3214 3216 * for the null termination.)
3215 3217 *
3216 3218 * This is the calculation performed by the NVS_XDR_MAX_LEN macro.
3217 3219 */
3218 3220 #define NVS_XDR_HDR_LEN ((size_t)(5 * 4))
3219 3221 #define NVS_XDR_DATA_LEN(y) (((size_t)(y) <= NVS_XDR_HDR_LEN) ? \
3220 3222 0 : ((size_t)(y) - NVS_XDR_HDR_LEN))
3221 3223 #define NVS_XDR_MAX_LEN(x) (NVP_SIZE_CALC(1, 0) + \
3222 3224 (NVS_XDR_DATA_LEN(x) * 2) + \
3223 3225 NV_ALIGN4((NVS_XDR_DATA_LEN(x) / 4)))
3224 3226
3225 3227 static int
3226 3228 nvs_xdr_nvpair(nvstream_t *nvs, nvpair_t *nvp, size_t *size)
3227 3229 {
3228 3230 XDR *xdr = nvs->nvs_private;
3229 3231 int32_t encode_len, decode_len;
3230 3232
3231 3233 switch (nvs->nvs_op) {
3232 3234 case NVS_OP_ENCODE: {
3233 3235 size_t nvsize;
3234 3236
3235 3237 if (nvs_xdr_nvp_size(nvs, nvp, &nvsize) != 0)
3236 3238 return (EFAULT);
3237 3239
3238 3240 decode_len = nvp->nvp_size;
3239 3241 encode_len = nvsize;
3240 3242 if (!xdr_int(xdr, &encode_len) || !xdr_int(xdr, &decode_len))
3241 3243 return (EFAULT);
3242 3244
3243 3245 return (nvs_xdr_nvp_op(nvs, nvp));
3244 3246 }
3245 3247 case NVS_OP_DECODE: {
3246 3248 struct xdr_bytesrec bytesrec;
3247 3249
3248 3250 /* get the encode and decode size */
3249 3251 if (!xdr_int(xdr, &encode_len) || !xdr_int(xdr, &decode_len))
3250 3252 return (EFAULT);
3251 3253 *size = decode_len;
3252 3254
3253 3255 /* are we at the end of the stream? */
3254 3256 if (*size == 0)
3255 3257 return (0);
3256 3258
3257 3259 /* sanity check the size parameter */
3258 3260 if (!xdr_control(xdr, XDR_GET_BYTES_AVAIL, &bytesrec))
3259 3261 return (EFAULT);
3260 3262
3261 3263 if (*size > NVS_XDR_MAX_LEN(bytesrec.xc_num_avail))
3262 3264 return (EFAULT);
3263 3265 break;
3264 3266 }
3265 3267
3266 3268 default:
3267 3269 return (EINVAL);
3268 3270 }
3269 3271 return (0);
3270 3272 }
3271 3273
3272 3274 static const struct nvs_ops nvs_xdr_ops = {
3273 3275 nvs_xdr_nvlist,
3274 3276 nvs_xdr_nvpair,
3275 3277 nvs_xdr_nvp_op,
3276 3278 nvs_xdr_nvp_size,
3277 3279 nvs_xdr_nvl_fini
3278 3280 };
3279 3281
3280 3282 static int
3281 3283 nvs_xdr(nvstream_t *nvs, nvlist_t *nvl, char *buf, size_t *buflen)
3282 3284 {
3283 3285 XDR xdr;
3284 3286 int err;
3285 3287
3286 3288 nvs->nvs_ops = &nvs_xdr_ops;
3287 3289
3288 3290 if ((err = nvs_xdr_create(nvs, &xdr, buf + sizeof (nvs_header_t),
3289 3291 *buflen - sizeof (nvs_header_t))) != 0)
3290 3292 return (err);
3291 3293
3292 3294 err = nvs_operation(nvs, nvl, buflen);
3293 3295
3294 3296 nvs_xdr_destroy(nvs);
3295 3297
3296 3298 return (err);
3297 3299 }
|
↓ open down ↓ |
902 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX