sys/netgraph7/netgraph/ng_parse.c

   1 /*
   2  * ng_parse.c
   3  */
   4
   5 /*-
   6  * Copyright (c) 1999 Whistle Communications, Inc.
   7  * All rights reserved.
   8  *
   9  * Subject to the following obligations and disclaimer of warranty, use and
  10  * redistribution of this software, in source or object code forms, with or
  11  * without modifications are expressly permitted by Whistle Communications;
  12  * provided, however, that:
  13  * 1. Any and all reproductions of the source or object code must include the
  14  *    copyright notice above and the following disclaimer of warranties; and
  15  * 2. No rights are granted, in any manner or form, to use Whistle
  16  *    Communications, Inc. trademarks, including the mark "WHISTLE
  17  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  18  *    such appears in the above copyright notice or in the software.
  19  *
  20  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  21  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  22  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  23  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  25  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  26  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  27  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  28  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  29  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  30  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  31  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  32  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  36  * OF SUCH DAMAGE.
  37  *
  38  * Author: Archie Cobbs <archie@freebsd.org>
  39  *
  40  * $Whistle: ng_parse.c,v 1.3 1999/11/29 01:43:48 archie Exp $
  41  * $FreeBSD: src/sys/netgraph/ng_parse.c,v 1.30 2007/06/23 00:02:20 mjacob Exp $
  42  */
  43
  44 #include <sys/types.h>
  45 #include <sys/param.h>
  46 #include <sys/systm.h>
  47 #include <sys/kernel.h>
  48 #include <sys/errno.h>
  49 #include <sys/limits.h>
  50 #include <sys/malloc.h>
  51 #include <sys/mbuf.h>
  52 #include <sys/ctype.h>
  53 #include <sys/stdarg.h>
  54
  55 #include <net/ethernet.h>
  56
  57 #include <netinet/in.h>
  58
  59 #include <netgraph7/ng_message.h>
  60 #include <netgraph7/netgraph.h>
  61 #include <netgraph7/ng_parse.h>
  62
  63 #ifdef NG_SEPARATE_MALLOC
  64 MALLOC_DEFINE(M_NETGRAPH_PARSE, "netgraph_parse", "netgraph parse info");
  65 #else
  66 #define M_NETGRAPH_PARSE M_NETGRAPH
  67 #endif
  68
  69 /* Compute alignment for primitive integral types */
  70 struct int16_temp {
  71         char    x;
  72         int16_t y;
  73 };
  74
  75 struct int32_temp {
  76         char    x;
  77         int32_t y;
  78 };
  79
  80 struct int64_temp {
  81         char    x;
  82         int64_t y;
  83 };
  84
  85 #define INT8_ALIGNMENT          1
  86 #define INT16_ALIGNMENT         __offsetof(struct int16_temp, y)
  87 #define INT32_ALIGNMENT         __offsetof(struct int32_temp, y)
  88 #define INT64_ALIGNMENT         __offsetof(struct int64_temp, y)
  89
  90 /* Output format for integral types */
  91 #define INT_UNSIGNED            0
  92 #define INT_SIGNED              1
  93 #define INT_HEX                 2
  94
  95 /* Type of composite object: struct, array, or fixedarray */
  96 enum comptype {
  97         CT_STRUCT,
  98         CT_ARRAY,
  99         CT_FIXEDARRAY,
 100 };
 101
 102 /* Composite types helper functions */
 103 static int      ng_parse_composite(const struct ng_parse_type *type,
 104                         const char *s, int *off, const u_char *start,
 105                         u_char *const buf, int *buflen, enum comptype ctype);
 106 static int      ng_unparse_composite(const struct ng_parse_type *type,
 107                         const u_char *data, int *off, char *cbuf, int cbuflen,
 108                         enum comptype ctype);
 109 static int      ng_get_composite_elem_default(const struct ng_parse_type *type,
 110                         int index, const u_char *start, u_char *buf,
 111                         int *buflen, enum comptype ctype);
 112 static int      ng_get_composite_len(const struct ng_parse_type *type,
 113                         const u_char *start, const u_char *buf,
 114                         enum comptype ctype);
 115 static const    struct ng_parse_type *ng_get_composite_etype(const struct
 116                         ng_parse_type *type, int index, enum comptype ctype);
 117 static int      ng_parse_get_elem_pad(const struct ng_parse_type *type,
 118                         int index, enum comptype ctype, int posn);
 119
 120 /* Parsing helper functions */
 121 static int      ng_parse_skip_value(const char *s, int off, int *lenp);
 122 static int      ng_parse_append(char **cbufp, int *cbuflenp,
 123                         const char *fmt, ...) __printflike(3, 4);
 124
 125 /* Poor man's virtual method calls */
 126 #define METHOD(t,m)     (ng_get_ ## m ## _method(t))
 127 #define INVOKE(t,m)     (*METHOD(t,m))
 128
 129 static ng_parse_t       *ng_get_parse_method(const struct ng_parse_type *t);
 130 static ng_unparse_t     *ng_get_unparse_method(const struct ng_parse_type *t);
 131 static ng_getDefault_t  *ng_get_getDefault_method(const
 132                                 struct ng_parse_type *t);
 133 static ng_getAlign_t    *ng_get_getAlign_method(const struct ng_parse_type *t);
 134
 135 #define ALIGNMENT(t)    (METHOD(t, getAlign) == NULL ? \
 136                                 0 : INVOKE(t, getAlign)(t))
 137
 138 /************************************************************************
 139                         PUBLIC FUNCTIONS
 140  ************************************************************************/
 141
 142 /*
 143  * Convert an ASCII string to binary according to the supplied type descriptor
 144  */
 145 int
 146 ng_parse(const struct ng_parse_type *type,
 147         const char *string, int *off, u_char *buf, int *buflen)
 148 {
 149         return INVOKE(type, parse)(type, string, off, buf, buf, buflen);
 150 }
 151
 152 /*
 153  * Convert binary to an ASCII string according to the supplied type descriptor
 154  */
 155 int
 156 ng_unparse(const struct ng_parse_type *type,
 157         const u_char *data, char *cbuf, int cbuflen)
 158 {
 159         int off = 0;
 160
 161         return INVOKE(type, unparse)(type, data, &off, cbuf, cbuflen);
 162 }
 163
 164 /*
 165  * Fill in the default value according to the supplied type descriptor
 166  */
 167 int
 168 ng_parse_getDefault(const struct ng_parse_type *type, u_char *buf, int *buflen)
 169 {
 170         ng_getDefault_t *const func = METHOD(type, getDefault);
 171
 172         if (func == NULL)
 173                 return (EOPNOTSUPP);
 174         return (*func)(type, buf, buf, buflen);
 175 }
 176
 177
 178 /************************************************************************
 179                         STRUCTURE TYPE
 180  ************************************************************************/
 181
 182 static int
 183 ng_struct_parse(const struct ng_parse_type *type,
 184         const char *s, int *off, const u_char *const start,
 185         u_char *const buf, int *buflen)
 186 {
 187         return ng_parse_composite(type, s, off, start, buf, buflen, CT_STRUCT);
 188 }
 189
 190 static int
 191 ng_struct_unparse(const struct ng_parse_type *type,
 192         const u_char *data, int *off, char *cbuf, int cbuflen)
 193 {
 194         return ng_unparse_composite(type, data, off, cbuf, cbuflen, CT_STRUCT);
 195 }
 196
 197 static int
 198 ng_struct_getDefault(const struct ng_parse_type *type,
 199         const u_char *const start, u_char *buf, int *buflen)
 200 {
 201         int off = 0;
 202
 203         return ng_parse_composite(type,
 204             "{}", &off, start, buf, buflen, CT_STRUCT);
 205 }
 206
 207 static int
 208 ng_struct_getAlign(const struct ng_parse_type *type)
 209 {
 210         const struct ng_parse_struct_field *field;
 211         int align = 0;
 212
 213         for (field = type->info; field->name != NULL; field++) {
 214                 int falign = ALIGNMENT(field->type);
 215
 216                 if (falign > align)
 217                         align = falign;
 218         }
 219         return align;
 220 }
 221
 222 const struct ng_parse_type ng_parse_struct_type = {
 223         NULL,
 224         NULL,
 225         NULL,
 226         ng_struct_parse,
 227         ng_struct_unparse,
 228         ng_struct_getDefault,
 229         ng_struct_getAlign
 230 };
 231
 232 /************************************************************************
 233                         FIXED LENGTH ARRAY TYPE
 234  ************************************************************************/
 235
 236 static int
 237 ng_fixedarray_parse(const struct ng_parse_type *type,
 238         const char *s, int *off, const u_char *const start,
 239         u_char *const buf, int *buflen)
 240 {
 241         return ng_parse_composite(type,
 242             s, off, start, buf, buflen, CT_FIXEDARRAY);
 243 }
 244
 245 static int
 246 ng_fixedarray_unparse(const struct ng_parse_type *type,
 247         const u_char *data, int *off, char *cbuf, int cbuflen)
 248 {
 249         return ng_unparse_composite(type,
 250                 data, off, cbuf, cbuflen, CT_FIXEDARRAY);
 251 }
 252
 253 static int
 254 ng_fixedarray_getDefault(const struct ng_parse_type *type,
 255         const u_char *const start, u_char *buf, int *buflen)
 256 {
 257         int off = 0;
 258
 259         return ng_parse_composite(type,
 260             "[]", &off, start, buf, buflen, CT_FIXEDARRAY);
 261 }
 262
 263 static int
 264 ng_fixedarray_getAlign(const struct ng_parse_type *type)
 265 {
 266         const struct ng_parse_fixedarray_info *fi = type->info;
 267
 268         return ALIGNMENT(fi->elementType);
 269 }
 270
 271 const struct ng_parse_type ng_parse_fixedarray_type = {
 272         NULL,
 273         NULL,
 274         NULL,
 275         ng_fixedarray_parse,
 276         ng_fixedarray_unparse,
 277         ng_fixedarray_getDefault,
 278         ng_fixedarray_getAlign
 279 };
 280
 281 /************************************************************************
 282                         VARIABLE LENGTH ARRAY TYPE
 283  ************************************************************************/
 284
 285 static int
 286 ng_array_parse(const struct ng_parse_type *type,
 287         const char *s, int *off, const u_char *const start,
 288         u_char *const buf, int *buflen)
 289 {
 290         return ng_parse_composite(type, s, off, start, buf, buflen, CT_ARRAY);
 291 }
 292
 293 static int
 294 ng_array_unparse(const struct ng_parse_type *type,
 295         const u_char *data, int *off, char *cbuf, int cbuflen)
 296 {
 297         return ng_unparse_composite(type, data, off, cbuf, cbuflen, CT_ARRAY);
 298 }
 299
 300 static int
 301 ng_array_getDefault(const struct ng_parse_type *type,
 302         const u_char *const start, u_char *buf, int *buflen)
 303 {
 304         int off = 0;
 305
 306         return ng_parse_composite(type,
 307             "[]", &off, start, buf, buflen, CT_ARRAY);
 308 }
 309
 310 static int
 311 ng_array_getAlign(const struct ng_parse_type *type)
 312 {
 313         const struct ng_parse_array_info *ai = type->info;
 314
 315         return ALIGNMENT(ai->elementType);
 316 }
 317
 318 const struct ng_parse_type ng_parse_array_type = {
 319         NULL,
 320         NULL,
 321         NULL,
 322         ng_array_parse,
 323         ng_array_unparse,
 324         ng_array_getDefault,
 325         ng_array_getAlign
 326 };
 327
 328 /************************************************************************
 329                                 INT8 TYPE
 330  ************************************************************************/
 331
 332 static int
 333 ng_int8_parse(const struct ng_parse_type *type,
 334         const char *s, int *off, const u_char *const start,
 335         u_char *const buf, int *buflen)
 336 {
 337         long val;
 338         int8_t val8;
 339         char *eptr;
 340
 341         val = strtol(s + *off, &eptr, 0);
 342         if (val < (int8_t)0x80 || val > (u_int8_t)0xff || eptr == s + *off)
 343                 return (EINVAL);
 344         *off = eptr - s;
 345         val8 = (int8_t)val;
 346         bcopy(&val8, buf, sizeof(int8_t));
 347         *buflen = sizeof(int8_t);
 348         return (0);
 349 }
 350
 351 static int
 352 ng_int8_unparse(const struct ng_parse_type *type,
 353         const u_char *data, int *off, char *cbuf, int cbuflen)
 354 {
 355         const char *fmt;
 356         int fval;
 357         int error;
 358         int8_t val;
 359
 360         bcopy(data + *off, &val, sizeof(int8_t));
 361         switch ((intptr_t)type->info) {
 362         case INT_SIGNED:
 363                 fmt = "%d";
 364                 fval = val;
 365                 break;
 366         case INT_UNSIGNED:
 367                 fmt = "%u";
 368                 fval = (u_int8_t)val;
 369                 break;
 370         case INT_HEX:
 371                 fmt = "0x%x";
 372                 fval = (u_int8_t)val;
 373                 break;
 374         default:
 375                 panic("%s: unknown type", __func__);
 376 #ifdef  RESTARTABLE_PANICS
 377                 return(0);
 378 #endif
 379         }
 380         if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
 381                 return (error);
 382         *off += sizeof(int8_t);
 383         return (0);
 384 }
 385
 386 static int
 387 ng_int8_getDefault(const struct ng_parse_type *type,
 388         const u_char *const start, u_char *buf, int *buflen)
 389 {
 390         int8_t val;
 391
 392         if (*buflen < sizeof(int8_t))
 393                 return (ERANGE);
 394         val = 0;
 395         bcopy(&val, buf, sizeof(int8_t));
 396         *buflen = sizeof(int8_t);
 397         return (0);
 398 }
 399
 400 static int
 401 ng_int8_getAlign(const struct ng_parse_type *type)
 402 {
 403         return INT8_ALIGNMENT;
 404 }
 405
 406 const struct ng_parse_type ng_parse_int8_type = {
 407         NULL,
 408         (void *)INT_SIGNED,
 409         NULL,
 410         ng_int8_parse,
 411         ng_int8_unparse,
 412         ng_int8_getDefault,
 413         ng_int8_getAlign
 414 };
 415
 416 const struct ng_parse_type ng_parse_uint8_type = {
 417         &ng_parse_int8_type,
 418         (void *)INT_UNSIGNED
 419 };
 420
 421 const struct ng_parse_type ng_parse_hint8_type = {
 422         &ng_parse_int8_type,
 423         (void *)INT_HEX
 424 };
 425
 426 /************************************************************************
 427                                 INT16 TYPE
 428  ************************************************************************/
 429
 430 static int
 431 ng_int16_parse(const struct ng_parse_type *type,
 432         const char *s, int *off, const u_char *const start,
 433         u_char *const buf, int *buflen)
 434 {
 435         long val;
 436         int16_t val16;
 437         char *eptr;
 438
 439         val = strtol(s + *off, &eptr, 0);
 440         if (val < (int16_t)0x8000
 441             || val > (u_int16_t)0xffff || eptr == s + *off)
 442                 return (EINVAL);
 443         *off = eptr - s;
 444         val16 = (int16_t)val;
 445         bcopy(&val16, buf, sizeof(int16_t));
 446         *buflen = sizeof(int16_t);
 447         return (0);
 448 }
 449
 450 static int
 451 ng_int16_unparse(const struct ng_parse_type *type,
 452         const u_char *data, int *off, char *cbuf, int cbuflen)
 453 {
 454         const char *fmt;
 455         int fval;
 456         int error;
 457         int16_t val;
 458
 459         bcopy(data + *off, &val, sizeof(int16_t));
 460         switch ((intptr_t)type->info) {
 461         case INT_SIGNED:
 462                 fmt = "%d";
 463                 fval = val;
 464                 break;
 465         case INT_UNSIGNED:
 466                 fmt = "%u";
 467                 fval = (u_int16_t)val;
 468                 break;
 469         case INT_HEX:
 470                 fmt = "0x%x";
 471                 fval = (u_int16_t)val;
 472                 break;
 473         default:
 474                 panic("%s: unknown type", __func__);
 475 #ifdef  RESTARTABLE_PANICS
 476                 return(0);
 477 #endif
 478         }
 479         if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
 480                 return (error);
 481         *off += sizeof(int16_t);
 482         return (0);
 483 }
 484
 485 static int
 486 ng_int16_getDefault(const struct ng_parse_type *type,
 487         const u_char *const start, u_char *buf, int *buflen)
 488 {
 489         int16_t val;
 490
 491         if (*buflen < sizeof(int16_t))
 492                 return (ERANGE);
 493         val = 0;
 494         bcopy(&val, buf, sizeof(int16_t));
 495         *buflen = sizeof(int16_t);
 496         return (0);
 497 }
 498
 499 static int
 500 ng_int16_getAlign(const struct ng_parse_type *type)
 501 {
 502         return INT16_ALIGNMENT;
 503 }
 504
 505 const struct ng_parse_type ng_parse_int16_type = {
 506         NULL,
 507         (void *)INT_SIGNED,
 508         NULL,
 509         ng_int16_parse,
 510         ng_int16_unparse,
 511         ng_int16_getDefault,
 512         ng_int16_getAlign
 513 };
 514
 515 const struct ng_parse_type ng_parse_uint16_type = {
 516         &ng_parse_int16_type,
 517         (void *)INT_UNSIGNED
 518 };
 519
 520 const struct ng_parse_type ng_parse_hint16_type = {
 521         &ng_parse_int16_type,
 522         (void *)INT_HEX
 523 };
 524
 525 /************************************************************************
 526                                 INT32 TYPE
 527  ************************************************************************/
 528
 529 static int
 530 ng_int32_parse(const struct ng_parse_type *type,
 531         const char *s, int *off, const u_char *const start,
 532         u_char *const buf, int *buflen)
 533 {
 534         long val;                       /* assumes long is at least 32 bits */
 535         int32_t val32;
 536         char *eptr;
 537
 538         if ((intptr_t)type->info == INT_SIGNED)
 539                 val = strtol(s + *off, &eptr, 0);
 540         else
 541                 val = strtoul(s + *off, &eptr, 0);
 542         if (val < (int32_t)0x80000000
 543             || val > (u_int32_t)0xffffffff || eptr == s + *off)
 544                 return (EINVAL);
 545         *off = eptr - s;
 546         val32 = (int32_t)val;
 547         bcopy(&val32, buf, sizeof(int32_t));
 548         *buflen = sizeof(int32_t);
 549         return (0);
 550 }
 551
 552 static int
 553 ng_int32_unparse(const struct ng_parse_type *type,
 554         const u_char *data, int *off, char *cbuf, int cbuflen)
 555 {
 556         const char *fmt;
 557         long fval;
 558         int error;
 559         int32_t val;
 560
 561         bcopy(data + *off, &val, sizeof(int32_t));
 562         switch ((intptr_t)type->info) {
 563         case INT_SIGNED:
 564                 fmt = "%ld";
 565                 fval = val;
 566                 break;
 567         case INT_UNSIGNED:
 568                 fmt = "%lu";
 569                 fval = (u_int32_t)val;
 570                 break;
 571         case INT_HEX:
 572                 fmt = "0x%lx";
 573                 fval = (u_int32_t)val;
 574                 break;
 575         default:
 576                 panic("%s: unknown type", __func__);
 577 #ifdef  RESTARTABLE_PANICS
 578                 return(0);
 579 #endif
 580         }
 581         if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
 582                 return (error);
 583         *off += sizeof(int32_t);
 584         return (0);
 585 }
 586
 587 static int
 588 ng_int32_getDefault(const struct ng_parse_type *type,
 589         const u_char *const start, u_char *buf, int *buflen)
 590 {
 591         int32_t val;
 592
 593         if (*buflen < sizeof(int32_t))
 594                 return (ERANGE);
 595         val = 0;
 596         bcopy(&val, buf, sizeof(int32_t));
 597         *buflen = sizeof(int32_t);
 598         return (0);
 599 }
 600
 601 static int
 602 ng_int32_getAlign(const struct ng_parse_type *type)
 603 {
 604         return INT32_ALIGNMENT;
 605 }
 606
 607 const struct ng_parse_type ng_parse_int32_type = {
 608         NULL,
 609         (void *)INT_SIGNED,
 610         NULL,
 611         ng_int32_parse,
 612         ng_int32_unparse,
 613         ng_int32_getDefault,
 614         ng_int32_getAlign
 615 };
 616
 617 const struct ng_parse_type ng_parse_uint32_type = {
 618         &ng_parse_int32_type,
 619         (void *)INT_UNSIGNED
 620 };
 621
 622 const struct ng_parse_type ng_parse_hint32_type = {
 623         &ng_parse_int32_type,
 624         (void *)INT_HEX
 625 };
 626
 627 /************************************************************************
 628                                 INT64 TYPE
 629  ************************************************************************/
 630
 631 static int
 632 ng_int64_parse(const struct ng_parse_type *type,
 633         const char *s, int *off, const u_char *const start,
 634         u_char *const buf, int *buflen)
 635 {
 636         quad_t val;
 637         int64_t val64;
 638         char *eptr;
 639
 640         val = strtoq(s + *off, &eptr, 0);
 641         if (eptr == s + *off)
 642                 return (EINVAL);
 643         *off = eptr - s;
 644         val64 = (int64_t)val;
 645         bcopy(&val64, buf, sizeof(int64_t));
 646         *buflen = sizeof(int64_t);
 647         return (0);
 648 }
 649
 650 static int
 651 ng_int64_unparse(const struct ng_parse_type *type,
 652         const u_char *data, int *off, char *cbuf, int cbuflen)
 653 {
 654         const char *fmt;
 655         long long fval;
 656         int64_t val;
 657         int error;
 658
 659         bcopy(data + *off, &val, sizeof(int64_t));
 660         switch ((intptr_t)type->info) {
 661         case INT_SIGNED:
 662                 fmt = "%lld";
 663                 fval = val;
 664                 break;
 665         case INT_UNSIGNED:
 666                 fmt = "%llu";
 667                 fval = (u_int64_t)val;
 668                 break;
 669         case INT_HEX:
 670                 fmt = "0x%llx";
 671                 fval = (u_int64_t)val;
 672                 break;
 673         default:
 674                 panic("%s: unknown type", __func__);
 675 #ifdef  RESTARTABLE_PANICS
 676                 return(0);
 677 #endif
 678         }
 679         if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
 680                 return (error);
 681         *off += sizeof(int64_t);
 682         return (0);
 683 }
 684
 685 static int
 686 ng_int64_getDefault(const struct ng_parse_type *type,
 687         const u_char *const start, u_char *buf, int *buflen)
 688 {
 689         int64_t val;
 690
 691         if (*buflen < sizeof(int64_t))
 692                 return (ERANGE);
 693         val = 0;
 694         bcopy(&val, buf, sizeof(int64_t));
 695         *buflen = sizeof(int64_t);
 696         return (0);
 697 }
 698
 699 static int
 700 ng_int64_getAlign(const struct ng_parse_type *type)
 701 {
 702         return INT64_ALIGNMENT;
 703 }
 704
 705 const struct ng_parse_type ng_parse_int64_type = {
 706         NULL,
 707         (void *)INT_SIGNED,
 708         NULL,
 709         ng_int64_parse,
 710         ng_int64_unparse,
 711         ng_int64_getDefault,
 712         ng_int64_getAlign
 713 };
 714
 715 const struct ng_parse_type ng_parse_uint64_type = {
 716         &ng_parse_int64_type,
 717         (void *)INT_UNSIGNED
 718 };
 719
 720 const struct ng_parse_type ng_parse_hint64_type = {
 721         &ng_parse_int64_type,
 722         (void *)INT_HEX
 723 };
 724
 725 /************************************************************************
 726                                 STRING TYPE
 727  ************************************************************************/
 728
 729 static int
 730 ng_string_parse(const struct ng_parse_type *type,
 731         const char *s, int *off, const u_char *const start,
 732         u_char *const buf, int *buflen)
 733 {
 734         char *sval;
 735         int len;
 736         int slen;
 737
 738         if ((sval = ng_get_string_token(s, off, &len, &slen)) == NULL)
 739                 return (EINVAL);
 740         *off += len;
 741         bcopy(sval, buf, slen + 1);
 742         kfree(sval, M_NETGRAPH_PARSE);
 743         *buflen = slen + 1;
 744         return (0);
 745 }
 746
 747 static int
 748 ng_string_unparse(const struct ng_parse_type *type,
 749         const u_char *data, int *off, char *cbuf, int cbuflen)
 750 {
 751         const char *const raw = (const char *)data + *off;
 752         char *const s = ng_encode_string(raw, strlen(raw));
 753         int error;
 754
 755         if (s == NULL)
 756                 return (ENOMEM);
 757         if ((error = ng_parse_append(&cbuf, &cbuflen, "%s", s)) != 0) {
 758                 kfree(s, M_NETGRAPH_PARSE);
 759                 return (error);
 760         }
 761         *off += strlen(raw) + 1;
 762         kfree(s, M_NETGRAPH_PARSE);
 763         return (0);
 764 }
 765
 766 static int
 767 ng_string_getDefault(const struct ng_parse_type *type,
 768         const u_char *const start, u_char *buf, int *buflen)
 769 {
 770
 771         if (*buflen < 1)
 772                 return (ERANGE);
 773         buf[0] = (u_char)'\0';
 774         *buflen = 1;
 775         return (0);
 776 }
 777
 778 const struct ng_parse_type ng_parse_string_type = {
 779         NULL,
 780         NULL,
 781         NULL,
 782         ng_string_parse,
 783         ng_string_unparse,
 784         ng_string_getDefault,
 785         NULL
 786 };
 787
 788 /************************************************************************
 789                         FIXED BUFFER STRING TYPE
 790  ************************************************************************/
 791
 792 static int
 793 ng_fixedstring_parse(const struct ng_parse_type *type,
 794         const char *s, int *off, const u_char *const start,
 795         u_char *const buf, int *buflen)
 796 {
 797         const struct ng_parse_fixedstring_info *const fi = type->info;
 798         char *sval;
 799         int len;
 800         int slen;
 801
 802         if ((sval = ng_get_string_token(s, off, &len, &slen)) == NULL)
 803                 return (EINVAL);
 804         if (slen + 1 > fi->bufSize) {
 805                 kfree(sval, M_NETGRAPH_PARSE);
 806                 return (E2BIG);
 807         }
 808         *off += len;
 809         bcopy(sval, buf, slen);
 810         kfree(sval, M_NETGRAPH_PARSE);
 811         bzero(buf + slen, fi->bufSize - slen);
 812         *buflen = fi->bufSize;
 813         return (0);
 814 }
 815
 816 static int
 817 ng_fixedstring_unparse(const struct ng_parse_type *type,
 818         const u_char *data, int *off, char *cbuf, int cbuflen)
 819 {
 820         const struct ng_parse_fixedstring_info *const fi = type->info;
 821         int error, temp = *off;
 822
 823         if ((error = ng_string_unparse(type, data, &temp, cbuf, cbuflen)) != 0)
 824                 return (error);
 825         *off += fi->bufSize;
 826         return (0);
 827 }
 828
 829 static int
 830 ng_fixedstring_getDefault(const struct ng_parse_type *type,
 831         const u_char *const start, u_char *buf, int *buflen)
 832 {
 833         const struct ng_parse_fixedstring_info *const fi = type->info;
 834
 835         if (*buflen < fi->bufSize)
 836                 return (ERANGE);
 837         bzero(buf, fi->bufSize);
 838         *buflen = fi->bufSize;
 839         return (0);
 840 }
 841
 842 const struct ng_parse_type ng_parse_fixedstring_type = {
 843         NULL,
 844         NULL,
 845         NULL,
 846         ng_fixedstring_parse,
 847         ng_fixedstring_unparse,
 848         ng_fixedstring_getDefault,
 849         NULL
 850 };
 851
 852 const struct ng_parse_fixedstring_info ng_parse_nodebuf_info = {
 853         NG_NODESIZ
 854 };
 855 const struct ng_parse_type ng_parse_nodebuf_type = {
 856         &ng_parse_fixedstring_type,
 857         &ng_parse_nodebuf_info
 858 };
 859
 860 const struct ng_parse_fixedstring_info ng_parse_hookbuf_info = {
 861         NG_HOOKSIZ
 862 };
 863 const struct ng_parse_type ng_parse_hookbuf_type = {
 864         &ng_parse_fixedstring_type,
 865         &ng_parse_hookbuf_info
 866 };
 867
 868 const struct ng_parse_fixedstring_info ng_parse_pathbuf_info = {
 869         NG_PATHSIZ
 870 };
 871 const struct ng_parse_type ng_parse_pathbuf_type = {
 872         &ng_parse_fixedstring_type,
 873         &ng_parse_pathbuf_info
 874 };
 875
 876 const struct ng_parse_fixedstring_info ng_parse_typebuf_info = {
 877         NG_TYPESIZ
 878 };
 879 const struct ng_parse_type ng_parse_typebuf_type = {
 880         &ng_parse_fixedstring_type,
 881         &ng_parse_typebuf_info
 882 };
 883
 884 const struct ng_parse_fixedstring_info ng_parse_cmdbuf_info = {
 885         NG_CMDSTRSIZ
 886 };
 887 const struct ng_parse_type ng_parse_cmdbuf_type = {
 888         &ng_parse_fixedstring_type,
 889         &ng_parse_cmdbuf_info
 890 };
 891
 892 /************************************************************************
 893                         EXPLICITLY SIZED STRING TYPE
 894  ************************************************************************/
 895
 896 static int
 897 ng_sizedstring_parse(const struct ng_parse_type *type,
 898         const char *s, int *off, const u_char *const start,
 899         u_char *const buf, int *buflen)
 900 {
 901         char *sval;
 902         int len;
 903         int slen;
 904
 905         if ((sval = ng_get_string_token(s, off, &len, &slen)) == NULL)
 906                 return (EINVAL);
 907         if (slen > USHRT_MAX) {
 908                 kfree(sval, M_NETGRAPH_PARSE);
 909                 return (EINVAL);
 910         }
 911         *off += len;
 912         *((u_int16_t *)buf) = (u_int16_t)slen;
 913         bcopy(sval, buf + 2, slen);
 914         kfree(sval, M_NETGRAPH_PARSE);
 915         *buflen = 2 + slen;
 916         return (0);
 917 }
 918
 919 static int
 920 ng_sizedstring_unparse(const struct ng_parse_type *type,
 921         const u_char *data, int *off, char *cbuf, int cbuflen)
 922 {
 923         const char *const raw = (const char *)data + *off + 2;
 924         const int slen = *((const u_int16_t *)(data + *off));
 925         char *const s = ng_encode_string(raw, slen);
 926         int error;
 927
 928         if (s == NULL)
 929                 return (ENOMEM);
 930         if ((error = ng_parse_append(&cbuf, &cbuflen, "%s", s)) != 0) {
 931                 kfree(s, M_NETGRAPH_PARSE);
 932                 return (error);
 933         }
 934         kfree(s, M_NETGRAPH_PARSE);
 935         *off += slen + 2;
 936         return (0);
 937 }
 938
 939 static int
 940 ng_sizedstring_getDefault(const struct ng_parse_type *type,
 941         const u_char *const start, u_char *buf, int *buflen)
 942 {
 943         if (*buflen < 2)
 944                 return (ERANGE);
 945         bzero(buf, 2);
 946         *buflen = 2;
 947         return (0);
 948 }
 949
 950 const struct ng_parse_type ng_parse_sizedstring_type = {
 951         NULL,
 952         NULL,
 953         NULL,
 954         ng_sizedstring_parse,
 955         ng_sizedstring_unparse,
 956         ng_sizedstring_getDefault,
 957         NULL
 958 };
 959
 960 /************************************************************************
 961                         IP ADDRESS TYPE
 962  ************************************************************************/
 963
 964 static int
 965 ng_ipaddr_parse(const struct ng_parse_type *type,
 966         const char *s, int *off, const u_char *const start,
 967         u_char *const buf, int *buflen)
 968 {
 969         int i, error;
 970
 971         for (i = 0; i < 4; i++) {
 972                 if ((error = ng_int8_parse(&ng_parse_int8_type,
 973                     s, off, start, buf + i, buflen)) != 0)
 974                         return (error);
 975                 if (i < 3 && s[*off] != '.')
 976                         return (EINVAL);
 977                 (*off)++;
 978         }
 979         *buflen = 4;
 980         return (0);
 981 }
 982
 983 static int
 984 ng_ipaddr_unparse(const struct ng_parse_type *type,
 985         const u_char *data, int *off, char *cbuf, int cbuflen)
 986 {
 987         struct in_addr ip;
 988         int error;
 989
 990         bcopy(data + *off, &ip, sizeof(ip));
 991         if ((error = ng_parse_append(&cbuf, &cbuflen, "%d.%d.%d.%d",
 992             ((u_char *)&ip)[0], ((u_char *)&ip)[1],
 993             ((u_char *)&ip)[2], ((u_char *)&ip)[3])) != 0)
 994                 return (error);
 995         *off += sizeof(ip);
 996         return (0);
 997 }
 998
 999 static int
1000 ng_ipaddr_getDefault(const struct ng_parse_type *type,
1001         const u_char *const start, u_char *buf, int *buflen)
1002 {
1003         struct in_addr ip = { 0 };
1004
1005         if (*buflen < sizeof(ip))
1006                 return (ERANGE);
1007         bcopy(&ip, buf, sizeof(ip));
1008         *buflen = sizeof(ip);
1009         return (0);
1010 }
1011
1012 const struct ng_parse_type ng_parse_ipaddr_type = {
1013         NULL,
1014         NULL,
1015         NULL,
1016         ng_ipaddr_parse,
1017         ng_ipaddr_unparse,
1018         ng_ipaddr_getDefault,
1019         ng_int32_getAlign
1020 };
1021
1022 /************************************************************************
1023                         ETHERNET ADDRESS TYPE
1024  ************************************************************************/
1025
1026 static int
1027 ng_enaddr_parse(const struct ng_parse_type *type,
1028         const char *s, int *const off, const u_char *const start,
1029         u_char *const buf, int *const buflen)
1030 {
1031         char *eptr;
1032         u_long val;
1033         int i;
1034
1035         if (*buflen < ETHER_ADDR_LEN)
1036                 return (ERANGE);
1037         for (i = 0; i < ETHER_ADDR_LEN; i++) {
1038                 val = strtoul(s + *off, &eptr, 16);
1039                 if (val > 0xff || eptr == s + *off)
1040                         return (EINVAL);
1041                 buf[i] = (u_char)val;
1042                 *off = (eptr - s);
1043                 if (i < ETHER_ADDR_LEN - 1) {
1044                         if (*eptr != ':')
1045                                 return (EINVAL);
1046                         (*off)++;
1047                 }
1048         }
1049         *buflen = ETHER_ADDR_LEN;
1050         return (0);
1051 }
1052
1053 static int
1054 ng_enaddr_unparse(const struct ng_parse_type *type,
1055         const u_char *data, int *off, char *cbuf, int cbuflen)
1056 {
1057         int len;
1058
1059         len = ksnprintf(cbuf, cbuflen, "%02x:%02x:%02x:%02x:%02x:%02x",
1060             data[*off], data[*off + 1], data[*off + 2],
1061             data[*off + 3], data[*off + 4], data[*off + 5]);
1062         if (len >= cbuflen)
1063                 return (ERANGE);
1064         *off += ETHER_ADDR_LEN;
1065         return (0);
1066 }
1067
1068 const struct ng_parse_type ng_parse_enaddr_type = {
1069         NULL,
1070         NULL,
1071         NULL,
1072         ng_enaddr_parse,
1073         ng_enaddr_unparse,
1074         NULL,
1075         0
1076 };
1077
1078 /************************************************************************
1079                         BYTE ARRAY TYPE
1080  ************************************************************************/
1081
1082 /* Get the length of a byte array */
1083 static int
1084 ng_parse_bytearray_subtype_getLength(const struct ng_parse_type *type,
1085         const u_char *start, const u_char *buf)
1086 {
1087         ng_parse_array_getLength_t *const getLength = type->private;
1088
1089         return (*getLength)(type, start, buf);
1090 }
1091
1092 /* Byte array element type is hex int8 */
1093 static const struct ng_parse_array_info ng_parse_bytearray_subtype_info = {
1094         &ng_parse_hint8_type,
1095         &ng_parse_bytearray_subtype_getLength,
1096         NULL
1097 };
1098 static const struct ng_parse_type ng_parse_bytearray_subtype = {
1099         &ng_parse_array_type,
1100         &ng_parse_bytearray_subtype_info
1101 };
1102
1103 static int
1104 ng_bytearray_parse(const struct ng_parse_type *type,
1105         const char *s, int *off, const u_char *const start,
1106         u_char *const buf, int *buflen)
1107 {
1108         char *str;
1109         int toklen;
1110         int slen;
1111
1112         /* We accept either an array of bytes or a string constant */
1113         if ((str = ng_get_string_token(s, off, &toklen, &slen)) != NULL) {
1114                 ng_parse_array_getLength_t *const getLength = type->info;
1115                 int arraylen;
1116
1117                 arraylen = (*getLength)(type, start, buf);
1118                 if (arraylen > *buflen) {
1119                         kfree(str, M_NETGRAPH_PARSE);
1120                         return (ERANGE);
1121                 }
1122                 if (slen > arraylen) {
1123                         kfree(str, M_NETGRAPH_PARSE);
1124                         return (E2BIG);
1125                 }
1126                 bcopy(str, buf, slen);
1127                 bzero(buf + slen, arraylen - slen);
1128                 kfree(str, M_NETGRAPH_PARSE);
1129                 *off += toklen;
1130                 *buflen = arraylen;
1131                 return (0);
1132         } else {
1133                 struct ng_parse_type subtype;
1134
1135                 subtype = ng_parse_bytearray_subtype;
1136                 *(const void **)(void *)&subtype.private = type->info;
1137                 return ng_array_parse(&subtype, s, off, start, buf, buflen);
1138         }
1139 }
1140
1141 static int
1142 ng_bytearray_unparse(const struct ng_parse_type *type,
1143         const u_char *data, int *off, char *cbuf, int cbuflen)
1144 {
1145         struct ng_parse_type subtype;
1146
1147         subtype = ng_parse_bytearray_subtype;
1148         *(const void **)(void *)&subtype.private = type->info;
1149         return ng_array_unparse(&subtype, data, off, cbuf, cbuflen);
1150 }
1151
1152 static int
1153 ng_bytearray_getDefault(const struct ng_parse_type *type,
1154         const u_char *const start, u_char *buf, int *buflen)
1155 {
1156         struct ng_parse_type subtype;
1157
1158         subtype = ng_parse_bytearray_subtype;
1159         *(const void **)(void *)&subtype.private = type->info;
1160         return ng_array_getDefault(&subtype, start, buf, buflen);
1161 }
1162
1163 const struct ng_parse_type ng_parse_bytearray_type = {
1164         NULL,
1165         NULL,
1166         NULL,
1167         ng_bytearray_parse,
1168         ng_bytearray_unparse,
1169         ng_bytearray_getDefault,
1170         NULL
1171 };
1172
1173 /************************************************************************
1174                         STRUCT NG_MESG TYPE
1175  ************************************************************************/
1176
1177 /* Get msg->header.arglen when "buf" is pointing to msg->data */
1178 static int
1179 ng_parse_ng_mesg_getLength(const struct ng_parse_type *type,
1180         const u_char *start, const u_char *buf)
1181 {
1182         const struct ng_mesg *msg;
1183
1184         msg = (const struct ng_mesg *)(buf - sizeof(*msg));
1185         return msg->header.arglen;
1186 }
1187
1188 /* Type for the variable length data portion of a struct ng_mesg */
1189 static const struct ng_parse_type ng_msg_data_type = {
1190         &ng_parse_bytearray_type,
1191         &ng_parse_ng_mesg_getLength
1192 };
1193
1194 /* Type for the entire struct ng_mesg header with data section */
1195 static const struct ng_parse_struct_field ng_parse_ng_mesg_type_fields[]
1196         = NG_GENERIC_NG_MESG_INFO(&ng_msg_data_type);
1197 const struct ng_parse_type ng_parse_ng_mesg_type = {
1198         &ng_parse_struct_type,
1199         &ng_parse_ng_mesg_type_fields,
1200 };
1201
1202 /************************************************************************
1203                         COMPOSITE HELPER ROUTINES
1204  ************************************************************************/
1205
1206 /*
1207  * Convert a structure or array from ASCII to binary
1208  */
1209 static int
1210 ng_parse_composite(const struct ng_parse_type *type, const char *s,
1211         int *off, const u_char *const start, u_char *const buf, int *buflen,
1212         const enum comptype ctype)
1213 {
1214         const int num = ng_get_composite_len(type, start, buf, ctype);
1215         int nextIndex = 0;              /* next implicit array index */
1216         u_int index;                    /* field or element index */
1217         int *foff;                      /* field value offsets in string */
1218         int align, len, blen, error = 0;
1219
1220         /* Initialize */
1221         foff = kmalloc(num * sizeof(*foff), M_NETGRAPH_PARSE,
1222                        M_WAITOK | M_NULLOK | M_ZERO);
1223         if (foff == NULL) {
1224                 error = ENOMEM;
1225                 goto done;
1226         }
1227
1228         /* Get opening brace/bracket */
1229         if (ng_parse_get_token(s, off, &len)
1230             != (ctype == CT_STRUCT ? T_LBRACE : T_LBRACKET)) {
1231                 error = EINVAL;
1232                 goto done;
1233         }
1234         *off += len;
1235
1236         /* Get individual element value positions in the string */
1237         for (;;) {
1238                 enum ng_parse_token tok;
1239
1240                 /* Check for closing brace/bracket */
1241                 tok = ng_parse_get_token(s, off, &len);
1242                 if (tok == (ctype == CT_STRUCT ? T_RBRACE : T_RBRACKET)) {
1243                         *off += len;
1244                         break;
1245                 }
1246
1247                 /* For arrays, the 'name' (ie, index) is optional, so
1248                    distinguish name from values by seeing if the next
1249                    token is an equals sign */
1250                 if (ctype != CT_STRUCT) {
1251                         int len2, off2;
1252                         char *eptr;
1253
1254                         /* If an opening brace/bracket, index is implied */
1255                         if (tok == T_LBRACE || tok == T_LBRACKET) {
1256                                 index = nextIndex++;
1257                                 goto gotIndex;
1258                         }
1259
1260                         /* Might be an index, might be a value, either way... */
1261                         if (tok != T_WORD) {
1262                                 error = EINVAL;
1263                                 goto done;
1264                         }
1265
1266                         /* If no equals sign follows, index is implied */
1267                         off2 = *off + len;
1268                         if (ng_parse_get_token(s, &off2, &len2) != T_EQUALS) {
1269                                 index = nextIndex++;
1270                                 goto gotIndex;
1271                         }
1272
1273                         /* Index was specified explicitly; parse it */
1274                         index = (u_int)strtoul(s + *off, &eptr, 0);
1275                         if (index < 0 || eptr - (s + *off) != len) {
1276                                 error = EINVAL;
1277                                 goto done;
1278                         }
1279                         nextIndex = index + 1;
1280                         *off += len + len2;
1281                 } else {                        /* a structure field */
1282                         const struct ng_parse_struct_field *const
1283                             fields = type->info;
1284
1285                         /* Find the field by name (required) in field list */
1286                         if (tok != T_WORD) {
1287                                 error = EINVAL;
1288                                 goto done;
1289                         }
1290                         for (index = 0; index < num; index++) {
1291                                 const struct ng_parse_struct_field *const
1292                                     field = &fields[index];
1293
1294                                 if (strncmp(&s[*off], field->name, len) == 0
1295                                     && field->name[len] == '\0')
1296                                         break;
1297                         }
1298                         if (index == num) {
1299                                 error = ENOENT;
1300                                 goto done;
1301                         }
1302                         *off += len;
1303
1304                         /* Get equals sign */
1305                         if (ng_parse_get_token(s, off, &len) != T_EQUALS) {
1306                                 error = EINVAL;
1307                                 goto done;
1308                         }
1309                         *off += len;
1310                 }
1311 gotIndex:
1312
1313                 /* Check array index */
1314                 if (index >= num) {
1315                         error = E2BIG;
1316                         goto done;
1317                 }
1318
1319                 /* Save value's position and skip over it for now */
1320                 if (foff[index] != 0) {
1321                         error = EALREADY;               /* duplicate */
1322                         goto done;
1323                 }
1324                 while (isspace(s[*off]))
1325                         (*off)++;
1326                 foff[index] = *off;
1327                 if ((error = ng_parse_skip_value(s, *off, &len)) != 0)
1328                         goto done;
1329                 *off += len;
1330         }
1331
1332         /* Now build binary structure from supplied values and defaults */
1333         for (blen = index = 0; index < num; index++) {
1334                 const struct ng_parse_type *const
1335                     etype = ng_get_composite_etype(type, index, ctype);
1336                 int k, pad, vlen;
1337
1338                 /* Zero-pad any alignment bytes */
1339                 pad = ng_parse_get_elem_pad(type, index, ctype, blen);
1340                 for (k = 0; k < pad; k++) {
1341                         if (blen >= *buflen) {
1342                                 error = ERANGE;
1343                                 goto done;
1344                         }
1345                         buf[blen++] = 0;
1346                 }
1347
1348                 /* Get value */
1349                 vlen = *buflen - blen;
1350                 if (foff[index] == 0) {         /* use default value */
1351                         error = ng_get_composite_elem_default(type, index,
1352                             start, buf + blen, &vlen, ctype);
1353                 } else {                        /* parse given value */
1354                         *off = foff[index];
1355                         error = INVOKE(etype, parse)(etype,
1356                             s, off, start, buf + blen, &vlen);
1357                 }
1358                 if (error != 0)
1359                         goto done;
1360                 blen += vlen;
1361         }
1362
1363         /* Make total composite structure size a multiple of its alignment */
1364         if ((align = ALIGNMENT(type)) != 0) {
1365                 while (blen % align != 0) {
1366                         if (blen >= *buflen) {
1367                                 error = ERANGE;
1368                                 goto done;
1369                         }
1370                         buf[blen++] = 0;
1371                 }
1372         }
1373
1374         /* Done */
1375         *buflen = blen;
1376 done:
1377         if (foff != NULL)
1378                 kfree(foff, M_NETGRAPH_PARSE);
1379         return (error);
1380 }
1381
1382 /*
1383  * Convert an array or structure from binary to ASCII
1384  */
1385 static int
1386 ng_unparse_composite(const struct ng_parse_type *type, const u_char *data,
1387         int *off, char *cbuf, int cbuflen, const enum comptype ctype)
1388 {
1389         const struct ng_mesg *const hdr
1390             = (const struct ng_mesg *)(data - sizeof(*hdr));
1391         const int num = ng_get_composite_len(type, data, data + *off, ctype);
1392         const int workSize = 20 * 1024;         /* XXX hard coded constant */
1393         int nextIndex = 0, didOne = 0;
1394         int error, index;
1395         u_char *workBuf;
1396
1397         /* Get workspace for checking default values */
1398         workBuf = kmalloc(workSize, M_NETGRAPH_PARSE, M_WAITOK | M_NULLOK);
1399         if (workBuf == NULL)
1400                 return (ENOMEM);
1401
1402         /* Opening brace/bracket */
1403         if ((error = ng_parse_append(&cbuf, &cbuflen, "%c",
1404             (ctype == CT_STRUCT) ? '{' : '[')) != 0)
1405                 goto fail;
1406
1407         /* Do each item */
1408         for (index = 0; index < num; index++) {
1409                 const struct ng_parse_type *const
1410                     etype = ng_get_composite_etype(type, index, ctype);
1411
1412                 /* Skip any alignment pad bytes */
1413                 *off += ng_parse_get_elem_pad(type, index, ctype, *off);
1414
1415                 /*
1416                  * See if element is equal to its default value; skip if so.
1417                  * Copy struct ng_mesg header for types that peek into it.
1418                  */
1419                 if (sizeof(*hdr) + *off < workSize) {
1420                         int tempsize = workSize - sizeof(*hdr) - *off;
1421
1422                         bcopy(hdr, workBuf, sizeof(*hdr) + *off);
1423                         if (ng_get_composite_elem_default(type, index, workBuf
1424                               + sizeof(*hdr), workBuf + sizeof(*hdr) + *off,
1425                               &tempsize, ctype) == 0
1426                             && bcmp(workBuf + sizeof(*hdr) + *off,
1427                               data + *off, tempsize) == 0) {
1428                                 *off += tempsize;
1429                                 continue;
1430                         }
1431                 }
1432
1433                 /* Print name= */
1434                 if ((error = ng_parse_append(&cbuf, &cbuflen, " ")) != 0)
1435                         goto fail;
1436                 if (ctype != CT_STRUCT) {
1437                         if (index != nextIndex) {
1438                                 nextIndex = index;
1439                                 if ((error = ng_parse_append(&cbuf,
1440                                     &cbuflen, "%d=", index)) != 0)
1441                                         goto fail;
1442                         }
1443                         nextIndex++;
1444                 } else {
1445                         const struct ng_parse_struct_field *const
1446                             fields = type->info;
1447
1448                         if ((error = ng_parse_append(&cbuf,
1449                             &cbuflen, "%s=", fields[index].name)) != 0)
1450                                 goto fail;
1451                 }
1452
1453                 /* Print value */
1454                 if ((error = INVOKE(etype, unparse)
1455                     (etype, data, off, cbuf, cbuflen)) != 0) {
1456                         kfree(workBuf, M_NETGRAPH_PARSE);
1457                         return (error);
1458                 }
1459                 cbuflen -= strlen(cbuf);
1460                 cbuf += strlen(cbuf);
1461                 didOne = 1;
1462         }
1463
1464         /* Closing brace/bracket */
1465         error = ng_parse_append(&cbuf, &cbuflen, "%s%c",
1466             didOne ? " " : "", (ctype == CT_STRUCT) ? '}' : ']');
1467
1468 fail:
1469         /* Clean up after failure */
1470         kfree(workBuf, M_NETGRAPH_PARSE);
1471         return (error);
1472 }
1473
1474 /*
1475  * Generate the default value for an element of an array or structure
1476  * Returns EOPNOTSUPP if default value is unspecified.
1477  */
1478 static int
1479 ng_get_composite_elem_default(const struct ng_parse_type *type,
1480         int index, const u_char *const start, u_char *buf, int *buflen,
1481         const enum comptype ctype)
1482 {
1483         const struct ng_parse_type *etype;
1484         ng_getDefault_t *func;
1485
1486         switch (ctype) {
1487         case CT_STRUCT:
1488                 break;
1489         case CT_ARRAY:
1490             {
1491                 const struct ng_parse_array_info *const ai = type->info;
1492
1493                 if (ai->getDefault != NULL) {
1494                         return (*ai->getDefault)(type,
1495                             index, start, buf, buflen);
1496                 }
1497                 break;
1498             }
1499         case CT_FIXEDARRAY:
1500             {
1501                 const struct ng_parse_fixedarray_info *const fi = type->info;
1502
1503                 if (*fi->getDefault != NULL) {
1504                         return (*fi->getDefault)(type,
1505                             index, start, buf, buflen);
1506                 }
1507                 break;
1508             }
1509         default:
1510             panic("%s", __func__);
1511         }
1512
1513         /* Default to element type default */
1514         etype = ng_get_composite_etype(type, index, ctype);
1515         func = METHOD(etype, getDefault);
1516         if (func == NULL)
1517                 return (EOPNOTSUPP);
1518         return (*func)(etype, start, buf, buflen);
1519 }
1520
1521 /*
1522  * Get the number of elements in a struct, variable or fixed array.
1523  */
1524 static int
1525 ng_get_composite_len(const struct ng_parse_type *type,
1526         const u_char *const start, const u_char *buf,
1527         const enum comptype ctype)
1528 {
1529         switch (ctype) {
1530         case CT_STRUCT:
1531             {
1532                 const struct ng_parse_struct_field *const fields = type->info;
1533                 int numFields = 0;
1534
1535                 for (numFields = 0; ; numFields++) {
1536                         const struct ng_parse_struct_field *const
1537                                 fi = &fields[numFields];
1538
1539                         if (fi->name == NULL)
1540                                 break;
1541                 }
1542                 return (numFields);
1543             }
1544         case CT_ARRAY:
1545             {
1546                 const struct ng_parse_array_info *const ai = type->info;
1547
1548                 return (*ai->getLength)(type, start, buf);
1549             }
1550         case CT_FIXEDARRAY:
1551             {
1552                 const struct ng_parse_fixedarray_info *const fi = type->info;
1553
1554                 return fi->length;
1555             }
1556         default:
1557             panic("%s", __func__);
1558         }
1559         return (0);
1560 }
1561
1562 /*
1563  * Return the type of the index'th element of a composite structure
1564  */
1565 static const struct ng_parse_type *
1566 ng_get_composite_etype(const struct ng_parse_type *type,
1567         int index, const enum comptype ctype)
1568 {
1569         const struct ng_parse_type *etype = NULL;
1570
1571         switch (ctype) {
1572         case CT_STRUCT:
1573             {
1574                 const struct ng_parse_struct_field *const fields = type->info;
1575
1576                 etype = fields[index].type;
1577                 break;
1578             }
1579         case CT_ARRAY:
1580             {
1581                 const struct ng_parse_array_info *const ai = type->info;
1582
1583                 etype = ai->elementType;
1584                 break;
1585             }
1586         case CT_FIXEDARRAY:
1587             {
1588                 const struct ng_parse_fixedarray_info *const fi = type->info;
1589
1590                 etype = fi->elementType;
1591                 break;
1592             }
1593         default:
1594             panic("%s", __func__);
1595         }
1596         return (etype);
1597 }
1598
1599 /*
1600  * Get the number of bytes to skip to align for the next
1601  * element in a composite structure.
1602  */
1603 static int
1604 ng_parse_get_elem_pad(const struct ng_parse_type *type,
1605         int index, enum comptype ctype, int posn)
1606 {
1607         const struct ng_parse_type *const
1608             etype = ng_get_composite_etype(type, index, ctype);
1609         int align;
1610
1611         /* Get element's alignment, and possibly override */
1612         align = ALIGNMENT(etype);
1613         if (ctype == CT_STRUCT) {
1614                 const struct ng_parse_struct_field *const fields = type->info;
1615
1616                 if (fields[index].alignment != 0)
1617                         align = fields[index].alignment;
1618         }
1619
1620         /* Return number of bytes to skip to align */
1621         return (align ? (align - (posn % align)) % align : 0);
1622 }
1623
1624 /************************************************************************
1625                         PARSING HELPER ROUTINES
1626  ************************************************************************/
1627
1628 /*
1629  * Append to a fixed length string buffer.
1630  */
1631 static int
1632 ng_parse_append(char **cbufp, int *cbuflenp, const char *fmt, ...)
1633 {
1634         va_list args;
1635         int len;
1636
1637         va_start(args, fmt);
1638         len = kvsnprintf(*cbufp, *cbuflenp, fmt, args);
1639         va_end(args);
1640         if (len >= *cbuflenp)
1641                 return ERANGE;
1642         *cbufp += len;
1643         *cbuflenp -= len;
1644
1645         return (0);
1646 }
1647
1648 /*
1649  * Skip over a value
1650  */
1651 static int
1652 ng_parse_skip_value(const char *s, int off0, int *lenp)
1653 {
1654         int len, nbracket, nbrace;
1655         int off = off0;
1656
1657         len = nbracket = nbrace = 0;
1658         do {
1659                 switch (ng_parse_get_token(s, &off, &len)) {
1660                 case T_LBRACKET:
1661                         nbracket++;
1662                         break;
1663                 case T_LBRACE:
1664                         nbrace++;
1665                         break;
1666                 case T_RBRACKET:
1667                         if (nbracket-- == 0)
1668                                 return (EINVAL);
1669                         break;
1670                 case T_RBRACE:
1671                         if (nbrace-- == 0)
1672                                 return (EINVAL);
1673                         break;
1674                 case T_EOF:
1675                         return (EINVAL);
1676                 default:
1677                         break;
1678                 }
1679                 off += len;
1680         } while (nbracket > 0 || nbrace > 0);
1681         *lenp = off - off0;
1682         return (0);
1683 }
1684
1685 /*
1686  * Find the next token in the string, starting at offset *startp.
1687  * Returns the token type, with *startp pointing to the first char
1688  * and *lenp the length.
1689  */
1690 enum ng_parse_token
1691 ng_parse_get_token(const char *s, int *startp, int *lenp)
1692 {
1693         char *t;
1694         int i;
1695
1696         while (isspace(s[*startp]))
1697                 (*startp)++;
1698         switch (s[*startp]) {
1699         case '\0':
1700                 *lenp = 0;
1701                 return T_EOF;
1702         case '{':
1703                 *lenp = 1;
1704                 return T_LBRACE;
1705         case '}':
1706                 *lenp = 1;
1707                 return T_RBRACE;
1708         case '[':
1709                 *lenp = 1;
1710                 return T_LBRACKET;
1711         case ']':
1712                 *lenp = 1;
1713                 return T_RBRACKET;
1714         case '=':
1715                 *lenp = 1;
1716                 return T_EQUALS;
1717         case '"':
1718                 if ((t = ng_get_string_token(s, startp, lenp, NULL)) == NULL)
1719                         return T_ERROR;
1720                 kfree(t, M_NETGRAPH_PARSE);
1721                 return T_STRING;
1722         default:
1723                 for (i = *startp + 1; s[i] != '\0' && !isspace(s[i])
1724                     && s[i] != '{' && s[i] != '}' && s[i] != '['
1725                     && s[i] != ']' && s[i] != '=' && s[i] != '"'; i++)
1726                         ;
1727                 *lenp = i - *startp;
1728                 return T_WORD;
1729         }
1730 }
1731
1732 /*
1733  * Get a string token, which must be enclosed in double quotes.
1734  * The normal C backslash escapes are recognized.
1735  */
1736 char *
1737 ng_get_string_token(const char *s, int *startp, int *lenp, int *slenp)
1738 {
1739         char *cbuf, *p;
1740         int start, off;
1741         int slen;
1742
1743         while (isspace(s[*startp]))
1744                 (*startp)++;
1745         start = *startp;
1746         if (s[*startp] != '"')
1747                 return (NULL);
1748         cbuf = kmalloc(strlen(s + start), M_NETGRAPH_PARSE,
1749                        M_WAITOK | M_NULLOK);
1750         if (cbuf == NULL)
1751                 return (NULL);
1752         strcpy(cbuf, s + start + 1);
1753         for (slen = 0, off = 1, p = cbuf; *p != '\0'; slen++, off++, p++) {
1754                 if (*p == '"') {
1755                         *p = '\0';
1756                         *lenp = off + 1;
1757                         if (slenp != NULL)
1758                                 *slenp = slen;
1759                         return (cbuf);
1760                 } else if (p[0] == '\\' && p[1] != '\0') {
1761                         int x, k;
1762                         char *v;
1763
1764                         strcpy(p, p + 1);
1765                         v = p;
1766                         switch (*p) {
1767                         case 't':
1768                                 *v = '\t';
1769                                 off++;
1770                                 continue;
1771                         case 'n':
1772                                 *v = '\n';
1773                                 off++;
1774                                 continue;
1775                         case 'r':
1776                                 *v = '\r';
1777                                 off++;
1778                                 continue;
1779                         case 'v':
1780                                 *v =  '\v';
1781                                 off++;
1782                                 continue;
1783                         case 'f':
1784                                 *v =  '\f';
1785                                 off++;
1786                                 continue;
1787                         case '"':
1788                                 *v =  '"';
1789                                 off++;
1790                                 continue;
1791                         case '0': case '1': case '2': case '3':
1792                         case '4': case '5': case '6': case '7':
1793                                 for (x = k = 0;
1794                                     k < 3 && *v >= '0' && *v <= '7'; v++) {
1795                                         x = (x << 3) + (*v - '0');
1796                                         off++;
1797                                 }
1798                                 *--v = (char)x;
1799                                 break;
1800                         case 'x':
1801                                 for (v++, x = k = 0;
1802                                     k < 2 && isxdigit(*v); v++) {
1803                                         x = (x << 4) + (isdigit(*v) ?
1804                                               (*v - '0') :
1805                                               (tolower(*v) - 'a' + 10));
1806                                         off++;
1807                                 }
1808                                 *--v = (char)x;
1809                                 break;
1810                         default:
1811                                 continue;
1812                         }
1813                         strcpy(p, v);
1814                 }
1815         }
1816         kfree(cbuf, M_NETGRAPH_PARSE);
1817         return (NULL);          /* no closing quote */
1818 }
1819
1820 /*
1821  * Encode a string so it can be safely put in double quotes.
1822  * Caller must free the result. Exactly "slen" characters
1823  * are encoded.
1824  */
1825 char *
1826 ng_encode_string(const char *raw, int slen)
1827 {
1828         char *cbuf;
1829         int off = 0;
1830         int i;
1831
1832         cbuf = kmalloc(strlen(raw) * 4 + 3, M_NETGRAPH_PARSE,
1833                        M_WAITOK | M_NULLOK);
1834         if (cbuf == NULL)
1835                 return (NULL);
1836         cbuf[off++] = '"';
1837         for (i = 0; i < slen; i++, raw++) {
1838                 switch (*raw) {
1839                 case '\t':
1840                         cbuf[off++] = '\\';
1841                         cbuf[off++] = 't';
1842                         break;
1843                 case '\f':
1844                         cbuf[off++] = '\\';
1845                         cbuf[off++] = 'f';
1846                         break;
1847                 case '\n':
1848                         cbuf[off++] = '\\';
1849                         cbuf[off++] = 'n';
1850                         break;
1851                 case '\r':
1852                         cbuf[off++] = '\\';
1853                         cbuf[off++] = 'r';
1854                         break;
1855                 case '\v':
1856                         cbuf[off++] = '\\';
1857                         cbuf[off++] = 'v';
1858                         break;
1859                 case '"':
1860                 case '\\':
1861                         cbuf[off++] = '\\';
1862                         cbuf[off++] = *raw;
1863                         break;
1864                 default:
1865                         if (*raw < 0x20 || *raw > 0x7e) {
1866                                 off += ksprintf(cbuf + off,
1867                                     "\\x%02x", (u_char)*raw);
1868                                 break;
1869                         }
1870                         cbuf[off++] = *raw;
1871                         break;
1872                 }
1873         }
1874         cbuf[off++] = '"';
1875         cbuf[off] = '\0';
1876         return (cbuf);
1877 }
1878
1879 /************************************************************************
1880                         VIRTUAL METHOD LOOKUP
1881  ************************************************************************/
1882
1883 static ng_parse_t *
1884 ng_get_parse_method(const struct ng_parse_type *t)
1885 {
1886         while (t != NULL && t->parse == NULL)
1887                 t = t->supertype;
1888         return (t ? t->parse : NULL);
1889 }
1890
1891 static ng_unparse_t *
1892 ng_get_unparse_method(const struct ng_parse_type *t)
1893 {
1894         while (t != NULL && t->unparse == NULL)
1895                 t = t->supertype;
1896         return (t ? t->unparse : NULL);
1897 }
1898
1899 static ng_getDefault_t *
1900 ng_get_getDefault_method(const struct ng_parse_type *t)
1901 {
1902         while (t != NULL && t->getDefault == NULL)
1903                 t = t->supertype;
1904         return (t ? t->getDefault : NULL);
1905 }
1906
1907 static ng_getAlign_t *
1908 ng_get_getAlign_method(const struct ng_parse_type *t)
1909 {
1910         while (t != NULL && t->getAlign == NULL)
1911                 t = t->supertype;
1912         return (t ? t->getAlign : NULL);
1913 }
1914