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