6 * Copyright (c) 1999 Whistle Communications, Inc.
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.
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
38 * Author: Archie Cobbs <archie@freebsd.org>
40 * $Whistle: ng_parse.c,v 1.3 1999/11/29 01:43:48 archie Exp $
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>
52 #include <sys/ctype.h>
54 #include <machine/stdarg.h>
56 #include <net/ethernet.h>
58 #include <netinet/in.h>
60 #include <netgraph/ng_message.h>
61 #include <netgraph/netgraph.h>
62 #include <netgraph/ng_parse.h>
64 #ifdef NG_SEPARATE_MALLOC
65 MALLOC_DEFINE(M_NETGRAPH_PARSE, "netgraph_parse", "netgraph parse info");
67 #define M_NETGRAPH_PARSE M_NETGRAPH
70 /* Compute alignment for primitive integral types */
86 #define INT8_ALIGNMENT 1
87 #define INT16_ALIGNMENT ((size_t)&((struct int16_temp *)0)->y)
88 #define INT32_ALIGNMENT ((size_t)&((struct int32_temp *)0)->y)
89 #define INT64_ALIGNMENT ((size_t)&((struct int64_temp *)0)->y)
91 /* Output format for integral types */
92 #define INT_UNSIGNED 0
96 /* Type of composite object: struct, array, or fixedarray */
103 /* Composite types helper functions */
104 static int ng_parse_composite(const struct ng_parse_type *type,
105 const char *s, int *off, const u_char *start,
106 u_char *const buf, int *buflen, enum comptype ctype);
107 static int ng_unparse_composite(const struct ng_parse_type *type,
108 const u_char *data, int *off, char *cbuf, int cbuflen,
109 enum comptype ctype);
110 static int ng_get_composite_elem_default(const struct ng_parse_type *type,
111 int index, const u_char *start, u_char *buf,
112 int *buflen, enum comptype ctype);
113 static int ng_get_composite_len(const struct ng_parse_type *type,
114 const u_char *start, const u_char *buf,
115 enum comptype ctype);
116 static const struct ng_parse_type *ng_get_composite_etype(const struct
117 ng_parse_type *type, int index, enum comptype ctype);
118 static int ng_parse_get_elem_pad(const struct ng_parse_type *type,
119 int index, enum comptype ctype, int posn);
121 /* Parsing helper functions */
122 static int ng_parse_skip_value(const char *s, int off, int *lenp);
123 static int ng_parse_append(char **cbufp, int *cbuflenp,
124 const char *fmt, ...);
126 /* Poor man's virtual method calls */
127 #define METHOD(t,m) (ng_get_ ## m ## _method(t))
128 #define INVOKE(t,m) (*METHOD(t,m))
130 static ng_parse_t *ng_get_parse_method(const struct ng_parse_type *t);
131 static ng_unparse_t *ng_get_unparse_method(const struct ng_parse_type *t);
132 static ng_getDefault_t *ng_get_getDefault_method(const
133 struct ng_parse_type *t);
134 static ng_getAlign_t *ng_get_getAlign_method(const struct ng_parse_type *t);
136 #define ALIGNMENT(t) (METHOD(t, getAlign) == NULL ? \
137 0 : INVOKE(t, getAlign)(t))
139 /************************************************************************
141 ************************************************************************/
144 * Convert an ASCII string to binary according to the supplied type descriptor
147 ng_parse(const struct ng_parse_type *type,
148 const char *string, int *off, u_char *buf, int *buflen)
150 return INVOKE(type, parse)(type, string, off, buf, buf, buflen);
154 * Convert binary to an ASCII string according to the supplied type descriptor
157 ng_unparse(const struct ng_parse_type *type,
158 const u_char *data, char *cbuf, int cbuflen)
162 return INVOKE(type, unparse)(type, data, &off, cbuf, cbuflen);
166 * Fill in the default value according to the supplied type descriptor
169 ng_parse_getDefault(const struct ng_parse_type *type, u_char *buf, int *buflen)
171 ng_getDefault_t *const func = METHOD(type, getDefault);
175 return (*func)(type, buf, buf, buflen);
179 /************************************************************************
181 ************************************************************************/
184 ng_struct_parse(const struct ng_parse_type *type,
185 const char *s, int *off, const u_char *const start,
186 u_char *const buf, int *buflen)
188 return ng_parse_composite(type, s, off, start, buf, buflen, CT_STRUCT);
192 ng_struct_unparse(const struct ng_parse_type *type,
193 const u_char *data, int *off, char *cbuf, int cbuflen)
195 return ng_unparse_composite(type, data, off, cbuf, cbuflen, CT_STRUCT);
199 ng_struct_getDefault(const struct ng_parse_type *type,
200 const u_char *const start, u_char *buf, int *buflen)
204 return ng_parse_composite(type,
205 "{}", &off, start, buf, buflen, CT_STRUCT);
209 ng_struct_getAlign(const struct ng_parse_type *type)
211 const struct ng_parse_struct_field *field;
214 for (field = type->info; field->name != NULL; field++) {
215 int falign = ALIGNMENT(field->type);
223 const struct ng_parse_type ng_parse_struct_type = {
229 ng_struct_getDefault,
233 /************************************************************************
234 FIXED LENGTH ARRAY TYPE
235 ************************************************************************/
238 ng_fixedarray_parse(const struct ng_parse_type *type,
239 const char *s, int *off, const u_char *const start,
240 u_char *const buf, int *buflen)
242 return ng_parse_composite(type,
243 s, off, start, buf, buflen, CT_FIXEDARRAY);
247 ng_fixedarray_unparse(const struct ng_parse_type *type,
248 const u_char *data, int *off, char *cbuf, int cbuflen)
250 return ng_unparse_composite(type,
251 data, off, cbuf, cbuflen, CT_FIXEDARRAY);
255 ng_fixedarray_getDefault(const struct ng_parse_type *type,
256 const u_char *const start, u_char *buf, int *buflen)
260 return ng_parse_composite(type,
261 "[]", &off, start, buf, buflen, CT_FIXEDARRAY);
265 ng_fixedarray_getAlign(const struct ng_parse_type *type)
267 const struct ng_parse_fixedarray_info *fi = type->info;
269 return ALIGNMENT(fi->elementType);
272 const struct ng_parse_type ng_parse_fixedarray_type = {
277 ng_fixedarray_unparse,
278 ng_fixedarray_getDefault,
279 ng_fixedarray_getAlign
282 /************************************************************************
283 VARIABLE LENGTH ARRAY TYPE
284 ************************************************************************/
287 ng_array_parse(const struct ng_parse_type *type,
288 const char *s, int *off, const u_char *const start,
289 u_char *const buf, int *buflen)
291 return ng_parse_composite(type, s, off, start, buf, buflen, CT_ARRAY);
295 ng_array_unparse(const struct ng_parse_type *type,
296 const u_char *data, int *off, char *cbuf, int cbuflen)
298 return ng_unparse_composite(type, data, off, cbuf, cbuflen, CT_ARRAY);
302 ng_array_getDefault(const struct ng_parse_type *type,
303 const u_char *const start, u_char *buf, int *buflen)
307 return ng_parse_composite(type,
308 "[]", &off, start, buf, buflen, CT_ARRAY);
312 ng_array_getAlign(const struct ng_parse_type *type)
314 const struct ng_parse_array_info *ai = type->info;
316 return ALIGNMENT(ai->elementType);
319 const struct ng_parse_type ng_parse_array_type = {
329 /************************************************************************
331 ************************************************************************/
334 ng_int8_parse(const struct ng_parse_type *type,
335 const char *s, int *off, const u_char *const start,
336 u_char *const buf, int *buflen)
342 val = strtol(s + *off, &eptr, 0);
343 if (val < (int8_t)0x80 || val > (u_int8_t)0xff || eptr == s + *off)
347 bcopy(&val8, buf, sizeof(int8_t));
348 *buflen = sizeof(int8_t);
353 ng_int8_unparse(const struct ng_parse_type *type,
354 const u_char *data, int *off, char *cbuf, int cbuflen)
361 bcopy(data + *off, &val, sizeof(int8_t));
362 switch ((intptr_t)type->info) {
369 fval = (u_int8_t)val;
373 fval = (u_int8_t)val;
376 panic("%s: unknown type", __func__);
377 #ifdef RESTARTABLE_PANICS
381 if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
383 *off += sizeof(int8_t);
388 ng_int8_getDefault(const struct ng_parse_type *type,
389 const u_char *const start, u_char *buf, int *buflen)
393 if (*buflen < sizeof(int8_t))
396 bcopy(&val, buf, sizeof(int8_t));
397 *buflen = sizeof(int8_t);
402 ng_int8_getAlign(const struct ng_parse_type *type)
404 return INT8_ALIGNMENT;
407 const struct ng_parse_type ng_parse_int8_type = {
417 const struct ng_parse_type ng_parse_uint8_type = {
422 const struct ng_parse_type ng_parse_hint8_type = {
427 /************************************************************************
429 ************************************************************************/
432 ng_int16_parse(const struct ng_parse_type *type,
433 const char *s, int *off, const u_char *const start,
434 u_char *const buf, int *buflen)
440 val = strtol(s + *off, &eptr, 0);
441 if (val < (int16_t)0x8000
442 || val > (u_int16_t)0xffff || eptr == s + *off)
445 val16 = (int16_t)val;
446 bcopy(&val16, buf, sizeof(int16_t));
447 *buflen = sizeof(int16_t);
452 ng_int16_unparse(const struct ng_parse_type *type,
453 const u_char *data, int *off, char *cbuf, int cbuflen)
460 bcopy(data + *off, &val, sizeof(int16_t));
461 switch ((intptr_t)type->info) {
468 fval = (u_int16_t)val;
472 fval = (u_int16_t)val;
475 panic("%s: unknown type", __func__);
476 #ifdef RESTARTABLE_PANICS
480 if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
482 *off += sizeof(int16_t);
487 ng_int16_getDefault(const struct ng_parse_type *type,
488 const u_char *const start, u_char *buf, int *buflen)
492 if (*buflen < sizeof(int16_t))
495 bcopy(&val, buf, sizeof(int16_t));
496 *buflen = sizeof(int16_t);
501 ng_int16_getAlign(const struct ng_parse_type *type)
503 return INT16_ALIGNMENT;
506 const struct ng_parse_type ng_parse_int16_type = {
516 const struct ng_parse_type ng_parse_uint16_type = {
517 &ng_parse_int16_type,
521 const struct ng_parse_type ng_parse_hint16_type = {
522 &ng_parse_int16_type,
526 /************************************************************************
528 ************************************************************************/
531 ng_int32_parse(const struct ng_parse_type *type,
532 const char *s, int *off, const u_char *const start,
533 u_char *const buf, int *buflen)
535 long val; /* assumes long is at least 32 bits */
539 if ((intptr_t)type->info == INT_SIGNED)
540 val = strtol(s + *off, &eptr, 0);
542 val = strtoul(s + *off, &eptr, 0);
543 if (val < (int32_t)0x80000000
544 || val > (u_int32_t)0xffffffff || eptr == s + *off)
547 val32 = (int32_t)val;
548 bcopy(&val32, buf, sizeof(int32_t));
549 *buflen = sizeof(int32_t);
554 ng_int32_unparse(const struct ng_parse_type *type,
555 const u_char *data, int *off, char *cbuf, int cbuflen)
562 bcopy(data + *off, &val, sizeof(int32_t));
563 switch ((intptr_t)type->info) {
570 fval = (u_int32_t)val;
574 fval = (u_int32_t)val;
577 panic("%s: unknown type", __func__);
578 #ifdef RESTARTABLE_PANICS
582 if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
584 *off += sizeof(int32_t);
589 ng_int32_getDefault(const struct ng_parse_type *type,
590 const u_char *const start, u_char *buf, int *buflen)
594 if (*buflen < sizeof(int32_t))
597 bcopy(&val, buf, sizeof(int32_t));
598 *buflen = sizeof(int32_t);
603 ng_int32_getAlign(const struct ng_parse_type *type)
605 return INT32_ALIGNMENT;
608 const struct ng_parse_type ng_parse_int32_type = {
618 const struct ng_parse_type ng_parse_uint32_type = {
619 &ng_parse_int32_type,
623 const struct ng_parse_type ng_parse_hint32_type = {
624 &ng_parse_int32_type,
628 /************************************************************************
630 ************************************************************************/
633 ng_int64_parse(const struct ng_parse_type *type,
634 const char *s, int *off, const u_char *const start,
635 u_char *const buf, int *buflen)
641 val = strtoq(s + *off, &eptr, 0);
642 if (eptr == s + *off)
645 val64 = (int64_t)val;
646 bcopy(&val64, buf, sizeof(int64_t));
647 *buflen = sizeof(int64_t);
652 ng_int64_unparse(const struct ng_parse_type *type,
653 const u_char *data, int *off, char *cbuf, int cbuflen)
660 bcopy(data + *off, &val, sizeof(int64_t));
661 switch ((intptr_t)type->info) {
668 fval = (u_int64_t)val;
672 fval = (u_int64_t)val;
675 panic("%s: unknown type", __func__);
676 #ifdef RESTARTABLE_PANICS
680 if ((error = ng_parse_append(&cbuf, &cbuflen, fmt, fval)) != 0)
682 *off += sizeof(int64_t);
687 ng_int64_getDefault(const struct ng_parse_type *type,
688 const u_char *const start, u_char *buf, int *buflen)
692 if (*buflen < sizeof(int64_t))
695 bcopy(&val, buf, sizeof(int64_t));
696 *buflen = sizeof(int64_t);
701 ng_int64_getAlign(const struct ng_parse_type *type)
703 return INT64_ALIGNMENT;
706 const struct ng_parse_type ng_parse_int64_type = {
716 const struct ng_parse_type ng_parse_uint64_type = {
717 &ng_parse_int64_type,
721 const struct ng_parse_type ng_parse_hint64_type = {
722 &ng_parse_int64_type,
726 /************************************************************************
728 ************************************************************************/
731 ng_string_parse(const struct ng_parse_type *type,
732 const char *s, int *off, const u_char *const start,
733 u_char *const buf, int *buflen)
739 if ((sval = ng_get_string_token(s, off, &len, &slen)) == NULL)
742 bcopy(sval, buf, slen + 1);
743 free(sval, M_NETGRAPH_PARSE);
749 ng_string_unparse(const struct ng_parse_type *type,
750 const u_char *data, int *off, char *cbuf, int cbuflen)
752 const char *const raw = (const char *)data + *off;
753 char *const s = ng_encode_string(raw, strlen(raw));
758 if ((error = ng_parse_append(&cbuf, &cbuflen, "%s", s)) != 0) {
759 free(s, M_NETGRAPH_PARSE);
762 *off += strlen(raw) + 1;
763 free(s, M_NETGRAPH_PARSE);
768 ng_string_getDefault(const struct ng_parse_type *type,
769 const u_char *const start, u_char *buf, int *buflen)
774 buf[0] = (u_char)'\0';
779 const struct ng_parse_type ng_parse_string_type = {
785 ng_string_getDefault,
789 /************************************************************************
790 FIXED BUFFER STRING TYPE
791 ************************************************************************/
794 ng_fixedstring_parse(const struct ng_parse_type *type,
795 const char *s, int *off, const u_char *const start,
796 u_char *const buf, int *buflen)
798 const struct ng_parse_fixedstring_info *const fi = type->info;
803 if ((sval = ng_get_string_token(s, off, &len, &slen)) == NULL)
805 if (slen + 1 > fi->bufSize) {
806 free(sval, M_NETGRAPH_PARSE);
810 bcopy(sval, buf, slen);
811 free(sval, M_NETGRAPH_PARSE);
812 bzero(buf + slen, fi->bufSize - slen);
813 *buflen = fi->bufSize;
818 ng_fixedstring_unparse(const struct ng_parse_type *type,
819 const u_char *data, int *off, char *cbuf, int cbuflen)
821 const struct ng_parse_fixedstring_info *const fi = type->info;
822 int error, temp = *off;
824 if ((error = ng_string_unparse(type, data, &temp, cbuf, cbuflen)) != 0)
831 ng_fixedstring_getDefault(const struct ng_parse_type *type,
832 const u_char *const start, u_char *buf, int *buflen)
834 const struct ng_parse_fixedstring_info *const fi = type->info;
836 if (*buflen < fi->bufSize)
838 bzero(buf, fi->bufSize);
839 *buflen = fi->bufSize;
843 const struct ng_parse_type ng_parse_fixedstring_type = {
847 ng_fixedstring_parse,
848 ng_fixedstring_unparse,
849 ng_fixedstring_getDefault,
853 const struct ng_parse_fixedstring_info ng_parse_nodebuf_info = {
856 const struct ng_parse_type ng_parse_nodebuf_type = {
857 &ng_parse_fixedstring_type,
858 &ng_parse_nodebuf_info
861 const struct ng_parse_fixedstring_info ng_parse_hookbuf_info = {
864 const struct ng_parse_type ng_parse_hookbuf_type = {
865 &ng_parse_fixedstring_type,
866 &ng_parse_hookbuf_info
869 const struct ng_parse_fixedstring_info ng_parse_pathbuf_info = {
872 const struct ng_parse_type ng_parse_pathbuf_type = {
873 &ng_parse_fixedstring_type,
874 &ng_parse_pathbuf_info
877 const struct ng_parse_fixedstring_info ng_parse_typebuf_info = {
880 const struct ng_parse_type ng_parse_typebuf_type = {
881 &ng_parse_fixedstring_type,
882 &ng_parse_typebuf_info
885 const struct ng_parse_fixedstring_info ng_parse_cmdbuf_info = {
888 const struct ng_parse_type ng_parse_cmdbuf_type = {
889 &ng_parse_fixedstring_type,
890 &ng_parse_cmdbuf_info
893 /************************************************************************
894 EXPLICITLY SIZED STRING TYPE
895 ************************************************************************/
898 ng_sizedstring_parse(const struct ng_parse_type *type,
899 const char *s, int *off, const u_char *const start,
900 u_char *const buf, int *buflen)
906 if ((sval = ng_get_string_token(s, off, &len, &slen)) == NULL)
908 if (slen > USHRT_MAX) {
909 free(sval, M_NETGRAPH_PARSE);
913 *((u_int16_t *)buf) = (u_int16_t)slen;
914 bcopy(sval, buf + 2, slen);
915 free(sval, M_NETGRAPH_PARSE);
921 ng_sizedstring_unparse(const struct ng_parse_type *type,
922 const u_char *data, int *off, char *cbuf, int cbuflen)
924 const char *const raw = (const char *)data + *off + 2;
925 const int slen = *((const u_int16_t *)(data + *off));
926 char *const s = ng_encode_string(raw, slen);
931 if ((error = ng_parse_append(&cbuf, &cbuflen, "%s", s)) != 0) {
932 free(s, M_NETGRAPH_PARSE);
935 free(s, M_NETGRAPH_PARSE);
941 ng_sizedstring_getDefault(const struct ng_parse_type *type,
942 const u_char *const start, u_char *buf, int *buflen)
951 const struct ng_parse_type ng_parse_sizedstring_type = {
955 ng_sizedstring_parse,
956 ng_sizedstring_unparse,
957 ng_sizedstring_getDefault,
961 /************************************************************************
963 ************************************************************************/
966 ng_ipaddr_parse(const struct ng_parse_type *type,
967 const char *s, int *off, const u_char *const start,
968 u_char *const buf, int *buflen)
972 for (i = 0; i < 4; i++) {
973 if ((error = ng_int8_parse(&ng_parse_int8_type,
974 s, off, start, buf + i, buflen)) != 0)
976 if (i < 3 && s[*off] != '.')
985 ng_ipaddr_unparse(const struct ng_parse_type *type,
986 const u_char *data, int *off, char *cbuf, int cbuflen)
991 bcopy(data + *off, &ip, sizeof(ip));
992 if ((error = ng_parse_append(&cbuf, &cbuflen, "%d.%d.%d.%d",
993 ((u_char *)&ip)[0], ((u_char *)&ip)[1],
994 ((u_char *)&ip)[2], ((u_char *)&ip)[3])) != 0)
1001 ng_ipaddr_getDefault(const struct ng_parse_type *type,
1002 const u_char *const start, u_char *buf, int *buflen)
1004 struct in_addr ip = { 0 };
1006 if (*buflen < sizeof(ip))
1008 bcopy(&ip, buf, sizeof(ip));
1009 *buflen = sizeof(ip);
1013 const struct ng_parse_type ng_parse_ipaddr_type = {
1019 ng_ipaddr_getDefault,
1023 /************************************************************************
1024 ETHERNET ADDRESS TYPE
1025 ************************************************************************/
1028 ng_enaddr_parse(const struct ng_parse_type *type,
1029 const char *s, int *const off, const u_char *const start,
1030 u_char *const buf, int *const buflen)
1036 if (*buflen < ETHER_ADDR_LEN)
1038 for (i = 0; i < ETHER_ADDR_LEN; i++) {
1039 val = strtoul(s + *off, &eptr, 16);
1040 if (val > 0xff || eptr == s + *off)
1042 buf[i] = (u_char)val;
1044 if (i < ETHER_ADDR_LEN - 1) {
1050 *buflen = ETHER_ADDR_LEN;
1055 ng_enaddr_unparse(const struct ng_parse_type *type,
1056 const u_char *data, int *off, char *cbuf, int cbuflen)
1060 len = snprintf(cbuf, cbuflen, "%02x:%02x:%02x:%02x:%02x:%02x",
1061 data[*off], data[*off + 1], data[*off + 2],
1062 data[*off + 3], data[*off + 4], data[*off + 5]);
1065 *off += ETHER_ADDR_LEN;
1069 const struct ng_parse_type ng_parse_enaddr_type = {
1079 /************************************************************************
1081 ************************************************************************/
1083 /* Get the length of a byte array */
1085 ng_parse_bytearray_subtype_getLength(const struct ng_parse_type *type,
1086 const u_char *start, const u_char *buf)
1088 ng_parse_array_getLength_t *const getLength = type->private;
1090 return (*getLength)(type, start, buf);
1093 /* Byte array element type is hex int8 */
1094 static const struct ng_parse_array_info ng_parse_bytearray_subtype_info = {
1095 &ng_parse_hint8_type,
1096 &ng_parse_bytearray_subtype_getLength,
1099 static const struct ng_parse_type ng_parse_bytearray_subtype = {
1100 &ng_parse_array_type,
1101 &ng_parse_bytearray_subtype_info
1105 ng_bytearray_parse(const struct ng_parse_type *type,
1106 const char *s, int *off, const u_char *const start,
1107 u_char *const buf, int *buflen)
1113 /* We accept either an array of bytes or a string constant */
1114 if ((str = ng_get_string_token(s, off, &toklen, &slen)) != NULL) {
1115 ng_parse_array_getLength_t *const getLength = type->info;
1118 arraylen = (*getLength)(type, start, buf);
1119 if (arraylen > *buflen) {
1120 free(str, M_NETGRAPH_PARSE);
1123 if (slen > arraylen) {
1124 free(str, M_NETGRAPH_PARSE);
1127 bcopy(str, buf, slen);
1128 bzero(buf + slen, arraylen - slen);
1129 free(str, M_NETGRAPH_PARSE);
1134 struct ng_parse_type subtype;
1136 subtype = ng_parse_bytearray_subtype;
1137 *(const void **)&subtype.private = type->info;
1138 return ng_array_parse(&subtype, s, off, start, buf, buflen);
1143 ng_bytearray_unparse(const struct ng_parse_type *type,
1144 const u_char *data, int *off, char *cbuf, int cbuflen)
1146 struct ng_parse_type subtype;
1148 subtype = ng_parse_bytearray_subtype;
1149 *(const void **)&subtype.private = type->info;
1150 return ng_array_unparse(&subtype, data, off, cbuf, cbuflen);
1154 ng_bytearray_getDefault(const struct ng_parse_type *type,
1155 const u_char *const start, u_char *buf, int *buflen)
1157 struct ng_parse_type subtype;
1159 subtype = ng_parse_bytearray_subtype;
1160 *(const void **)&subtype.private = type->info;
1161 return ng_array_getDefault(&subtype, start, buf, buflen);
1164 const struct ng_parse_type ng_parse_bytearray_type = {
1169 ng_bytearray_unparse,
1170 ng_bytearray_getDefault,
1174 /************************************************************************
1176 ************************************************************************/
1178 /* Get msg->header.arglen when "buf" is pointing to msg->data */
1180 ng_parse_ng_mesg_getLength(const struct ng_parse_type *type,
1181 const u_char *start, const u_char *buf)
1183 const struct ng_mesg *msg;
1185 msg = (const struct ng_mesg *)(buf - sizeof(*msg));
1186 return msg->header.arglen;
1189 /* Type for the variable length data portion of a struct ng_mesg */
1190 static const struct ng_parse_type ng_msg_data_type = {
1191 &ng_parse_bytearray_type,
1192 &ng_parse_ng_mesg_getLength
1195 /* Type for the entire struct ng_mesg header with data section */
1196 static const struct ng_parse_struct_field ng_parse_ng_mesg_type_fields[]
1197 = NG_GENERIC_NG_MESG_INFO(&ng_msg_data_type);
1198 const struct ng_parse_type ng_parse_ng_mesg_type = {
1199 &ng_parse_struct_type,
1200 &ng_parse_ng_mesg_type_fields,
1203 /************************************************************************
1204 COMPOSITE HELPER ROUTINES
1205 ************************************************************************/
1208 * Convert a structure or array from ASCII to binary
1211 ng_parse_composite(const struct ng_parse_type *type, const char *s,
1212 int *off, const u_char *const start, u_char *const buf, int *buflen,
1213 const enum comptype ctype)
1215 const int num = ng_get_composite_len(type, start, buf, ctype);
1216 int nextIndex = 0; /* next implicit array index */
1217 u_int index; /* field or element index */
1218 int *foff; /* field value offsets in string */
1219 int align, len, blen, error = 0;
1222 foff = malloc(num * sizeof(*foff), M_NETGRAPH_PARSE, M_NOWAIT | M_ZERO);
1228 /* Get opening brace/bracket */
1229 if (ng_parse_get_token(s, off, &len)
1230 != (ctype == CT_STRUCT ? T_LBRACE : T_LBRACKET)) {
1236 /* Get individual element value positions in the string */
1238 enum ng_parse_token tok;
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)) {
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) {
1254 /* If an opening brace/bracket, index is implied */
1255 if (tok == T_LBRACE || tok == T_LBRACKET) {
1256 index = nextIndex++;
1260 /* Might be an index, might be a value, either way... */
1261 if (tok != T_WORD) {
1266 /* If no equals sign follows, index is implied */
1268 if (ng_parse_get_token(s, &off2, &len2) != T_EQUALS) {
1269 index = nextIndex++;
1273 /* Index was specified explicitly; parse it */
1274 index = (u_int)strtoul(s + *off, &eptr, 0);
1275 if (index < 0 || eptr - (s + *off) != len) {
1279 nextIndex = index + 1;
1281 } else { /* a structure field */
1282 const struct ng_parse_struct_field *const
1283 fields = type->info;
1285 /* Find the field by name (required) in field list */
1286 if (tok != T_WORD) {
1290 for (index = 0; index < num; index++) {
1291 const struct ng_parse_struct_field *const
1292 field = &fields[index];
1294 if (strncmp(&s[*off], field->name, len) == 0
1295 && field->name[len] == '\0')
1304 /* Get equals sign */
1305 if (ng_parse_get_token(s, off, &len) != T_EQUALS) {
1313 /* Check array index */
1319 /* Save value's position and skip over it for now */
1320 if (foff[index] != 0) {
1321 error = EALREADY; /* duplicate */
1324 while (isspace(s[*off]))
1327 if ((error = ng_parse_skip_value(s, *off, &len)) != 0)
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);
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) {
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 */
1355 error = INVOKE(etype, parse)(etype,
1356 s, off, start, buf + blen, &vlen);
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) {
1378 free(foff, M_NETGRAPH_PARSE);
1383 * Convert an array or structure from binary to ASCII
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)
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;
1397 /* Get workspace for checking default values */
1398 workBuf = malloc(workSize, M_NETGRAPH_PARSE, M_NOWAIT);
1399 if (workBuf == NULL)
1402 /* Opening brace/bracket */
1403 if ((error = ng_parse_append(&cbuf, &cbuflen, "%c",
1404 (ctype == CT_STRUCT) ? '{' : '[')) != 0)
1408 for (index = 0; index < num; index++) {
1409 const struct ng_parse_type *const
1410 etype = ng_get_composite_etype(type, index, ctype);
1412 /* Skip any alignment pad bytes */
1413 *off += ng_parse_get_elem_pad(type, index, ctype, *off);
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.
1419 if (sizeof(*hdr) + *off < workSize) {
1420 int tempsize = workSize - sizeof(*hdr) - *off;
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) {
1434 if ((error = ng_parse_append(&cbuf, &cbuflen, " ")) != 0)
1436 if (ctype != CT_STRUCT) {
1437 if (index != nextIndex) {
1439 if ((error = ng_parse_append(&cbuf,
1440 &cbuflen, "%d=", index)) != 0)
1445 const struct ng_parse_struct_field *const
1446 fields = type->info;
1448 if ((error = ng_parse_append(&cbuf,
1449 &cbuflen, "%s=", fields[index].name)) != 0)
1454 if ((error = INVOKE(etype, unparse)
1455 (etype, data, off, cbuf, cbuflen)) != 0) {
1456 free(workBuf, M_NETGRAPH_PARSE);
1459 cbuflen -= strlen(cbuf);
1460 cbuf += strlen(cbuf);
1464 /* Closing brace/bracket */
1465 error = ng_parse_append(&cbuf, &cbuflen, "%s%c",
1466 didOne ? " " : "", (ctype == CT_STRUCT) ? '}' : ']');
1469 /* Clean up after failure */
1470 free(workBuf, M_NETGRAPH_PARSE);
1475 * Generate the default value for an element of an array or structure
1476 * Returns EOPNOTSUPP if default value is unspecified.
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)
1483 const struct ng_parse_type *etype;
1484 ng_getDefault_t *func;
1491 const struct ng_parse_array_info *const ai = type->info;
1493 if (ai->getDefault != NULL) {
1494 return (*ai->getDefault)(type,
1495 index, start, buf, buflen);
1501 const struct ng_parse_fixedarray_info *const fi = type->info;
1503 if (*fi->getDefault != NULL) {
1504 return (*fi->getDefault)(type,
1505 index, start, buf, buflen);
1510 panic("%s", __func__);
1513 /* Default to element type default */
1514 etype = ng_get_composite_etype(type, index, ctype);
1515 func = METHOD(etype, getDefault);
1517 return (EOPNOTSUPP);
1518 return (*func)(etype, start, buf, buflen);
1522 * Get the number of elements in a struct, variable or fixed array.
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)
1532 const struct ng_parse_struct_field *const fields = type->info;
1535 for (numFields = 0; ; numFields++) {
1536 const struct ng_parse_struct_field *const
1537 fi = &fields[numFields];
1539 if (fi->name == NULL)
1546 const struct ng_parse_array_info *const ai = type->info;
1548 return (*ai->getLength)(type, start, buf);
1552 const struct ng_parse_fixedarray_info *const fi = type->info;
1557 panic("%s", __func__);
1563 * Return the type of the index'th element of a composite structure
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)
1569 const struct ng_parse_type *etype = NULL;
1574 const struct ng_parse_struct_field *const fields = type->info;
1576 etype = fields[index].type;
1581 const struct ng_parse_array_info *const ai = type->info;
1583 etype = ai->elementType;
1588 const struct ng_parse_fixedarray_info *const fi = type->info;
1590 etype = fi->elementType;
1594 panic("%s", __func__);
1600 * Get the number of bytes to skip to align for the next
1601 * element in a composite structure.
1604 ng_parse_get_elem_pad(const struct ng_parse_type *type,
1605 int index, enum comptype ctype, int posn)
1607 const struct ng_parse_type *const
1608 etype = ng_get_composite_etype(type, index, ctype);
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;
1616 if (fields[index].alignment != 0)
1617 align = fields[index].alignment;
1620 /* Return number of bytes to skip to align */
1621 return (align ? (align - (posn % align)) % align : 0);
1624 /************************************************************************
1625 PARSING HELPER ROUTINES
1626 ************************************************************************/
1629 * Append to a fixed length string buffer.
1632 ng_parse_append(char **cbufp, int *cbuflenp, const char *fmt, ...)
1637 va_start(args, fmt);
1638 len = vsnprintf(*cbufp, *cbuflenp, fmt, args);
1640 if (len >= *cbuflenp)
1652 ng_parse_skip_value(const char *s, int off0, int *lenp)
1654 int len, nbracket, nbrace;
1657 len = nbracket = nbrace = 0;
1659 switch (ng_parse_get_token(s, &off, &len)) {
1667 if (nbracket-- == 0)
1680 } while (nbracket > 0 || nbrace > 0);
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.
1691 ng_parse_get_token(const char *s, int *startp, int *lenp)
1696 while (isspace(s[*startp]))
1698 switch (s[*startp]) {
1718 if ((t = ng_get_string_token(s, startp, lenp, NULL)) == NULL)
1720 free(t, M_NETGRAPH_PARSE);
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++)
1727 *lenp = i - *startp;
1733 * Get a string token, which must be enclosed in double quotes.
1734 * The normal C backslash escapes are recognized.
1737 ng_get_string_token(const char *s, int *startp, int *lenp, int *slenp)
1743 while (isspace(s[*startp]))
1746 if (s[*startp] != '"')
1748 cbuf = malloc(strlen(s + start), M_NETGRAPH_PARSE, M_NOWAIT);
1751 strcpy(cbuf, s + start + 1);
1752 for (slen = 0, off = 1, p = cbuf; *p != '\0'; slen++, off++, p++) {
1759 } else if (p[0] == '\\' && p[1] != '\0') {
1790 case '0': case '1': case '2': case '3':
1791 case '4': case '5': case '6': case '7':
1793 k < 3 && *v >= '0' && *v <= '7'; v++) {
1794 x = (x << 3) + (*v - '0');
1800 for (v++, x = k = 0;
1801 k < 2 && isxdigit(*v); v++) {
1802 x = (x << 4) + (isdigit(*v) ?
1804 (tolower(*v) - 'a' + 10));
1815 free(cbuf, M_NETGRAPH_PARSE);
1816 return (NULL); /* no closing quote */
1820 * Encode a string so it can be safely put in double quotes.
1821 * Caller must free the result. Exactly "slen" characters
1825 ng_encode_string(const char *raw, int slen)
1831 cbuf = malloc(strlen(raw) * 4 + 3, M_NETGRAPH_PARSE, M_NOWAIT);
1835 for (i = 0; i < slen; i++, raw++) {
1863 if (*raw < 0x20 || *raw > 0x7e) {
1864 off += sprintf(cbuf + off,
1865 "\\x%02x", (u_char)*raw);
1877 /************************************************************************
1878 VIRTUAL METHOD LOOKUP
1879 ************************************************************************/
1882 ng_get_parse_method(const struct ng_parse_type *t)
1884 while (t != NULL && t->parse == NULL)
1886 return (t ? t->parse : NULL);
1889 static ng_unparse_t *
1890 ng_get_unparse_method(const struct ng_parse_type *t)
1892 while (t != NULL && t->unparse == NULL)
1894 return (t ? t->unparse : NULL);
1897 static ng_getDefault_t *
1898 ng_get_getDefault_method(const struct ng_parse_type *t)
1900 while (t != NULL && t->getDefault == NULL)
1902 return (t ? t->getDefault : NULL);
1905 static ng_getAlign_t *
1906 ng_get_getAlign_method(const struct ng_parse_type *t)
1908 while (t != NULL && t->getAlign == NULL)
1910 return (t ? t->getAlign : NULL);