src/tools/vppapigen/vppapigen_c.py

   1 # C generation
   2 import datetime
   3 import os
   4 import time
   5 import sys
   6 from io import StringIO
   7 import shutil
   8
   9 datestring = datetime.datetime.utcfromtimestamp(
  10     int(os.environ.get('SOURCE_DATE_EPOCH', time.time())))
  11 input_filename = 'inputfil'
  12 top_boilerplate = '''\
  13 /*
  14  * VLIB API definitions {datestring}
  15  * Input file: {input_filename}
  16  * Automatically generated: please edit the input file NOT this file!
  17  */
  18
  19 #include <stdbool.h>
  20 #if defined(vl_msg_id)||defined(vl_union_id) \\
  21     || defined(vl_printfun) ||defined(vl_endianfun) \\
  22     || defined(vl_api_version)||defined(vl_typedefs) \\
  23     || defined(vl_msg_name)||defined(vl_msg_name_crc_list) \\
  24     || defined(vl_api_version_tuple)
  25 /* ok, something was selected */
  26 #else
  27 #warning no content included from {input_filename}
  28 #endif
  29
  30 #define VL_API_PACKED(x) x __attribute__ ((packed))
  31 '''
  32
  33 bottom_boilerplate = '''\
  34 /****** API CRC (whole file) *****/
  35
  36 #ifdef vl_api_version
  37 vl_api_version({input_filename}, {file_crc:#08x})
  38
  39 #endif
  40 '''
  41
  42
  43 def msg_ids(s):
  44     output = '''\
  45
  46 /****** Message ID / handler enum ******/
  47
  48 #ifdef vl_msg_id
  49 '''
  50
  51     for t in s['Define']:
  52         output += "vl_msg_id(VL_API_%s, vl_api_%s_t_handler)\n" % \
  53                   (t.name.upper(), t.name)
  54     output += "#endif"
  55
  56     return output
  57
  58
  59 def msg_names(s):
  60     output = '''\
  61
  62 /****** Message names ******/
  63
  64 #ifdef vl_msg_name
  65 '''
  66
  67     for t in s['Define']:
  68         dont_trace = 0 if t.dont_trace else 1
  69         output += "vl_msg_name(vl_api_%s_t, %d)\n" % (t.name, dont_trace)
  70     output += "#endif"
  71
  72     return output
  73
  74
  75 def msg_name_crc_list(s, suffix):
  76     output = '''\
  77
  78 /****** Message name, crc list ******/
  79
  80 #ifdef vl_msg_name_crc_list
  81 '''
  82     output += "#define foreach_vl_msg_name_crc_%s " % suffix
  83
  84     for t in s['Define']:
  85         output += "\\\n_(VL_API_%s, %s, %08x) " % \
  86                    (t.name.upper(), t.name, t.crc)
  87     output += "\n#endif"
  88
  89     return output
  90
  91
  92 def api2c(fieldtype):
  93     mappingtable = {'string': 'vl_api_string_t', }
  94     if fieldtype in mappingtable:
  95         return mappingtable[fieldtype]
  96     return fieldtype
  97
  98
  99 def typedefs(filename):
 100
 101     output = '''\
 102
 103 /****** Typedefs ******/
 104
 105 #ifdef vl_typedefs
 106 #include "{include}.api_types.h"
 107 #endif
 108 '''.format(include=filename)
 109     return output
 110
 111
 112 format_strings = {'u8': '%u',
 113                   'bool': '%u',
 114                   'i8': '%d',
 115                   'u16': '%u',
 116                   'i16': '%d',
 117                   'u32': '%u',
 118                   'i32': '%ld',
 119                   'u64': '%llu',
 120                   'i64': '%lld',
 121                   'f64': '%.2f'}
 122
 123 noprint_fields = {'_vl_msg_id': None,
 124                   'client_index': None,
 125                   'context': None}
 126
 127
 128 class Printfun():
 129     _dispatch = {}
 130
 131     def __init__(self, stream):
 132         self.stream = stream
 133
 134     def print_string(self, o, stream):
 135         write = stream.write
 136         if o.modern_vla:
 137             write('    if (vl_api_string_len(&a->{f}) > 0) {{\n'
 138                   .format(f=o.fieldname))
 139             write('        s = format(s, "\\n%U{f}: %U", '
 140                   'format_white_space, indent, '
 141                   'vl_api_format_string, (&a->{f}));\n'.format(f=o.fieldname))
 142             write('    } else {\n')
 143             write('        s = format(s, "\\n%U{f}:", '
 144                   'format_white_space, indent);\n'.format(f=o.fieldname))
 145             write('    }\n')
 146         else:
 147             write('    s = format(s, "\\n%U{f}: %s", '
 148                   'format_white_space, indent, a->{f});\n'
 149                   .format(f=o.fieldname))
 150
 151     def print_field(self, o, stream):
 152         write = stream.write
 153         if o.fieldname in noprint_fields:
 154             return
 155         if o.fieldtype in format_strings:
 156             f = format_strings[o.fieldtype]
 157             write('    s = format(s, "\\n%U{n}: {f}", '
 158                   'format_white_space, indent, a->{n});\n'
 159                   .format(n=o.fieldname, f=f))
 160         else:
 161             write('    s = format(s, "\\n%U{n}: %U", '
 162                   'format_white_space, indent, '
 163                   'format_{t}, &a->{n}, indent);\n'
 164                   .format(n=o.fieldname, t=o.fieldtype))
 165
 166     _dispatch['Field'] = print_field
 167
 168     def print_array(self, o, stream):
 169         write = stream.write
 170
 171         forloop = '''\
 172     for (i = 0; i < {lfield}; i++) {{
 173         s = format(s, "\\n%U{n}: %U",
 174                    format_white_space, indent, format_{t}, &a->{n}[i], indent);
 175     }}
 176 '''
 177
 178         forloop_format = '''\
 179     for (i = 0; i < {lfield}; i++) {{
 180         s = format(s, "\\n%U{n}: {t}",
 181                    format_white_space, indent, a->{n}[i]);
 182     }}
 183 '''
 184
 185         if o.fieldtype == 'string':
 186             return self.print_string(o, stream)
 187
 188         if o.fieldtype == 'u8':
 189             if o.lengthfield:
 190                 write('    s = format(s, "\\n%U{n}: %U", format_white_space, '
 191                       'indent, format_hex_bytes, a->{n}, a->{lfield});\n'
 192                       .format(n=o.fieldname, lfield=o.lengthfield))
 193             else:
 194                 write('    s = format(s, "\\n%U{n}: %U", format_white_space, '
 195                       'indent, format_hex_bytes, a, {lfield});\n'
 196                       .format(n=o.fieldname, lfield=o.length))
 197             return
 198
 199         lfield = 'a->' + o.lengthfield if o.lengthfield else o.length
 200         if o.fieldtype in format_strings:
 201             write(forloop_format.format(lfield=lfield,
 202                                         t=format_strings[o.fieldtype],
 203                                         n=o.fieldname))
 204         else:
 205             write(forloop.format(lfield=lfield, t=o.fieldtype, n=o.fieldname))
 206
 207     _dispatch['Array'] = print_array
 208
 209     def print_alias(self, k, v, stream):
 210         write = stream.write
 211         if ('length' in v.alias and v.alias['length'] and
 212                 v.alias['type'] == 'u8'):
 213             write('    return format(s, "%U", format_hex_bytes, a, {});\n'
 214                   .format(v.alias['length']))
 215         elif v.alias['type'] in format_strings:
 216             write('    return format(s, "{}", *a);\n'
 217                   .format(format_strings[v.alias['type']]))
 218         else:
 219             write('    return format(s, "{} (print not implemented)");\n'
 220                   .format(k))
 221
 222     def print_enum(self, o, stream):
 223         write = stream.write
 224         write("    switch(*a) {\n")
 225         for b in o:
 226             write("    case %s:\n" % b[1])
 227             write('        return format(s, "{}");\n'.format(b[0]))
 228         write('    }\n')
 229
 230     _dispatch['Enum'] = print_enum
 231
 232     def print_obj(self, o, stream):
 233         write = stream.write
 234
 235         if o.type in self._dispatch:
 236             self._dispatch[o.type](self, o, stream)
 237         else:
 238             write('    s = format(s, "\\n{} {} {} (print not implemented");\n'
 239                   .format(o.type, o.fieldtype, o.fieldname))
 240
 241
 242 def printfun(objs, stream, modulename):
 243     write = stream.write
 244
 245     h = '''\
 246 /****** Print functions *****/
 247 #ifdef vl_printfun
 248 #ifndef included_{module}_printfun
 249 #define included_{module}_printfun
 250
 251 #ifdef LP64
 252 #define _uword_fmt \"%lld\"
 253 #define _uword_cast (long long)
 254 #else
 255 #define _uword_fmt \"%ld\"
 256 #define _uword_cast long
 257 #endif
 258
 259 '''
 260
 261     signature = '''\
 262 static inline void *vl_api_{name}_t_print (vl_api_{name}_t *a, void *handle)
 263 {{
 264     u8 *s = 0;
 265     u32 indent __attribute__((unused)) = 2;
 266     int i __attribute__((unused));
 267 '''
 268
 269     h = h.format(module=modulename)
 270     write(h)
 271
 272     pp = Printfun(stream)
 273     for t in objs:
 274         if t.manual_print:
 275             write("/***** manual: vl_api_%s_t_print  *****/\n\n" % t.name)
 276             continue
 277         write(signature.format(name=t.name))
 278         write('    /* Message definition: vl_api_{}_t: */\n'.format(t.name))
 279         write("    s = format(s, \"vl_api_%s_t:\");\n" % t.name)
 280         for o in t.block:
 281             pp.print_obj(o, stream)
 282         write('    vec_add1(s, 0);\n')
 283         write('    vl_print (handle, (char *)s);\n')
 284         write('    vec_free (s);\n')
 285         write('    return handle;\n')
 286         write('}\n\n')
 287
 288     write("\n#endif")
 289     write("\n#endif /* vl_printfun */\n")
 290
 291     return ''
 292
 293
 294 def printfun_types(objs, stream, modulename):
 295     write = stream.write
 296     pp = Printfun(stream)
 297
 298     h = '''\
 299 /****** Print functions *****/
 300 #ifdef vl_printfun
 301 #ifndef included_{module}_printfun_types
 302 #define included_{module}_printfun_types
 303
 304 '''
 305     h = h.format(module=modulename)
 306     write(h)
 307
 308     signature = '''\
 309 static inline u8 *format_vl_api_{name}_t (u8 *s, va_list * args)
 310 {{
 311     vl_api_{name}_t *a = va_arg (*args, vl_api_{name}_t *);
 312     u32 indent __attribute__((unused)) = va_arg (*args, u32);
 313     int i __attribute__((unused));
 314     indent += 2;
 315 '''
 316
 317     for t in objs:
 318         if t.__class__.__name__ == 'Enum':
 319             write(signature.format(name=t.name))
 320             pp.print_enum(t.block, stream)
 321             write('    return s;\n')
 322             write('}\n\n')
 323             continue
 324
 325         if t.manual_print:
 326             write("/***** manual: vl_api_%s_t_print  *****/\n\n" % t.name)
 327             continue
 328
 329         if t.__class__.__name__ == 'Using':
 330             write(signature.format(name=t.name))
 331             pp.print_alias(t.name, t, stream)
 332             write('}\n\n')
 333             continue
 334
 335         write(signature.format(name=t.name))
 336         for o in t.block:
 337             pp.print_obj(o, stream)
 338
 339         write('    return s;\n')
 340         write('}\n\n')
 341
 342     write("\n#endif")
 343     write("\n#endif /* vl_printfun_types */\n")
 344
 345
 346 def imports(imports):
 347     output = '/* Imported API files */\n'
 348     output += '#ifndef vl_api_version\n'
 349
 350     for i in imports:
 351         s = i.filename.replace('plugins/', '')
 352         output += '#include <{}.h>\n'.format(s)
 353     output += '#endif\n'
 354     return output
 355
 356
 357 endian_strings = {
 358     'u16': 'clib_net_to_host_u16',
 359     'u32': 'clib_net_to_host_u32',
 360     'u64': 'clib_net_to_host_u64',
 361     'i16': 'clib_net_to_host_i16',
 362     'i32': 'clib_net_to_host_i32',
 363     'i64': 'clib_net_to_host_i64',
 364     'f64': 'clib_net_to_host_f64',
 365 }
 366
 367
 368 def endianfun_array(o):
 369     forloop = '''\
 370     for (i = 0; i < {length}; i++) {{
 371         a->{name}[i] = {format}(a->{name}[i]);
 372     }}
 373 '''
 374
 375     forloop_format = '''\
 376     for (i = 0; i < {length}; i++) {{
 377         {type}_endian(&a->{name}[i]);
 378     }}
 379 '''
 380
 381     output = ''
 382     if o.fieldtype == 'u8' or o.fieldtype == 'string':
 383         output += '    /* a->{n} = a->{n} (no-op) */\n'.format(n=o.fieldname)
 384     else:
 385         lfield = 'a->' + o.lengthfield if o.lengthfield else o.length
 386         if o.fieldtype in endian_strings:
 387             output += (forloop
 388                        .format(length=lfield,
 389                                format=endian_strings[o.fieldtype],
 390                                name=o.fieldname))
 391         else:
 392             output += (forloop_format
 393                        .format(length=lfield, type=o.fieldtype,
 394                                name=o.fieldname))
 395     return output
 396
 397 no_endian_conversion = {'client_index': None}
 398
 399 def endianfun_obj(o):
 400     output = ''
 401     if o.type == 'Array':
 402         return endianfun_array(o)
 403     elif o.type != 'Field':
 404         output += ('    s = format(s, "\\n{} {} {} (print not implemented");\n'
 405                    .format(o.type, o.fieldtype, o.fieldname))
 406         return output
 407     if o.fieldname in no_endian_conversion:
 408         output += '    /* a->{n} = a->{n} (no-op) */\n'.format(n=o.fieldname)
 409         return output
 410     if o.fieldtype in endian_strings:
 411         output += ('    a->{name} = {format}(a->{name});\n'
 412                    .format(name=o.fieldname,
 413                            format=endian_strings[o.fieldtype]))
 414     elif o.fieldtype.startswith('vl_api_'):
 415         output += ('    {type}_endian(&a->{name});\n'
 416                    .format(type=o.fieldtype, name=o.fieldname))
 417     else:
 418         output += '    /* a->{n} = a->{n} (no-op) */\n'.format(n=o.fieldname)
 419
 420     return output
 421
 422
 423 def endianfun(objs, modulename):
 424     output = '''\
 425
 426 /****** Endian swap functions *****/\n\
 427 #ifdef vl_endianfun
 428 #ifndef included_{module}_endianfun
 429 #define included_{module}_endianfun
 430
 431 #undef clib_net_to_host_uword
 432 #ifdef LP64
 433 #define clib_net_to_host_uword clib_net_to_host_u64
 434 #else
 435 #define clib_net_to_host_uword clib_net_to_host_u32
 436 #endif
 437
 438 '''
 439     output = output.format(module=modulename)
 440
 441     signature = '''\
 442 static inline void vl_api_{name}_t_endian (vl_api_{name}_t *a)
 443 {{
 444     int i __attribute__((unused));
 445 '''
 446
 447     for t in objs:
 448         if t.__class__.__name__ == 'Enum':
 449             output += signature.format(name=t.name)
 450             if t.enumtype in endian_strings:
 451                 output += ('    *a = {}(*a);\n'
 452                            .format(endian_strings[t.enumtype]))
 453             else:
 454                 output += ('    /* a->{name} = a->{name} (no-op) */\n'
 455                            .format(name=t.name))
 456
 457             output += '}\n\n'
 458             continue
 459
 460         if t.manual_endian:
 461             output += "/***** manual: vl_api_%s_t_endian  *****/\n\n" % t.name
 462             continue
 463
 464         if t.__class__.__name__ == 'Using':
 465             output += signature.format(name=t.name)
 466             if ('length' in t.alias and t.alias['length'] and
 467                     t.alias['type'] == 'u8'):
 468                 output += ('    /* a->{name} = a->{name} (no-op) */\n'
 469                            .format(name=t.name))
 470             elif t.alias['type'] in format_strings:
 471                 output += ('    *a = {}(*a);\n'
 472                            .format(endian_strings[t.alias['type']]))
 473             else:
 474                 output += '    /* Not Implemented yet {} */'.format(t.name)
 475             output += '}\n\n'
 476             continue
 477
 478         output += signature.format(name=t.name)
 479
 480         for o in t.block:
 481             output += endianfun_obj(o)
 482         output += '}\n\n'
 483
 484     output += "\n#endif"
 485     output += "\n#endif /* vl_endianfun */\n\n"
 486
 487     return output
 488
 489
 490 def version_tuple(s, module):
 491     output = '''\
 492 /****** Version tuple *****/
 493
 494 #ifdef vl_api_version_tuple
 495
 496 '''
 497     if 'version' in s['Option']:
 498         v = s['Option']['version']
 499         (major, minor, patch) = v.split('.')
 500         output += "vl_api_version_tuple(%s, %s, %s, %s)\n" % \
 501                   (module, major, minor, patch)
 502
 503     output += "\n#endif /* vl_api_version_tuple */\n\n"
 504
 505     return output
 506
 507
 508 def generate_include_enum(s, module, stream):
 509     write = stream.write
 510
 511     if len(s['Define']):
 512         write('typedef enum {\n')
 513         for t in s['Define']:
 514             write('   VL_API_{},\n'.format(t.name.upper()))
 515         write('   VL_MSG_{}_LAST\n'.format(module.upper()))
 516         write('}} vl_api_{}_enum_t;\n'.format(module))
 517
 518
 519 def generate_include_counters(s, module, stream):
 520     write = stream.write
 521
 522     for counters in s:
 523         csetname = counters.name
 524         write('typedef enum {\n')
 525         for c in counters.block:
 526             write('   {}_ERROR_{},\n'
 527                   .format(csetname.upper(), c['name'].upper()))
 528         write('   {}_N_ERROR\n'.format(csetname.upper()))
 529         write('}} vl_counter_{}_enum_t;\n'.format(csetname))
 530
 531         # write('extern char *{}_error_strings[];\n'.format(csetname))
 532         # write('extern char *{}_description_strings[];\n'.format(csetname))
 533         write('extern vl_counter_t {}_error_counters[];\n'.format(csetname))
 534
 535 #
 536 # Generate separate API _types file.
 537 #
 538 def generate_include_types(s, module, stream):
 539     write = stream.write
 540
 541     write('#ifndef included_{module}_api_types_h\n'.format(module=module))
 542     write('#define included_{module}_api_types_h\n'.format(module=module))
 543
 544     if 'version' in s['Option']:
 545         v = s['Option']['version']
 546         (major, minor, patch) = v.split('.')
 547         write('#define VL_API_{m}_API_VERSION_MAJOR {v}\n'.format(m=module.upper(), v=major))
 548         write('#define VL_API_{m}_API_VERSION_MINOR {v}\n'.format(m=module.upper(), v=minor))
 549         write('#define VL_API_{m}_API_VERSION_PATCH {v}\n'.format(m=module.upper(), v=patch))
 550
 551     if len(s['Import']):
 552         write('/* Imported API files */\n')
 553         for i in s['Import']:
 554             filename = i.filename.replace('plugins/', '')
 555             write('#include <{}_types.h>\n'.format(filename))
 556
 557     for o in s['types'] + s['Define']:
 558         tname = o.__class__.__name__
 559         if tname == 'Using':
 560             if 'length' in o.alias:
 561                 write('typedef %s vl_api_%s_t[%s];\n' % (o.alias['type'], o.name, o.alias['length']))
 562             else:
 563                 write('typedef %s vl_api_%s_t;\n' % (o.alias['type'], o.name))
 564         elif tname == 'Enum':
 565             if o.enumtype == 'u32':
 566                 write("typedef enum {\n")
 567             else:
 568                 write("typedef enum __attribute__((packed)) {\n")
 569
 570             for b in o.block:
 571                 write("    %s = %s,\n" % (b[0], b[1]))
 572             write('} vl_api_%s_t;\n' % o.name)
 573             if o.enumtype != 'u32':
 574                 size1 = 'sizeof(vl_api_%s_t)' % o.name
 575                 size2 = 'sizeof(%s)' % o.enumtype
 576                 err_str = 'size of API enum %s is wrong' % o.name
 577                 write('STATIC_ASSERT(%s == %s, "%s");\n'
 578                       % (size1, size2, err_str))
 579         else:
 580             if tname == 'Union':
 581                 write("typedef union __attribute__ ((packed)) _vl_api_%s {\n" % o.name)
 582             else:
 583                 write(("typedef struct __attribute__ ((packed)) _vl_api_%s {\n")
 584                            % o.name)
 585             for b in o.block:
 586                 if b.type == 'Option':
 587                     continue
 588                 if b.type == 'Field':
 589                       write("    %s %s;\n" % (api2c(b.fieldtype),
 590                                               b.fieldname))
 591                 elif b.type == 'Array':
 592                     if b.lengthfield:
 593                       write("    %s %s[0];\n" % (api2c(b.fieldtype),
 594                                                  b.fieldname))
 595                     else:
 596                         # Fixed length strings decay to nul terminated u8
 597                         if b.fieldtype == 'string':
 598                             if b.modern_vla:
 599                                 write('    {} {};\n'
 600                                       .format(api2c(b.fieldtype),
 601                                               b.fieldname))
 602                             else:
 603                                 write('    u8 {}[{}];\n'
 604                                       .format(b.fieldname, b.length))
 605                         else:
 606                             write("    %s %s[%s];\n" %
 607                                   (api2c(b.fieldtype), b.fieldname,
 608                                    b.length))
 609                 else:
 610                     raise ValueError("Error in processing type {} for {}"
 611                                      .format(b, o.name))
 612
 613             write('} vl_api_%s_t;\n' % o.name)
 614
 615     for t in s['Define']:
 616         write('#define VL_API_{ID}_CRC "{n}_{crc:08x}"\n'
 617               .format(n=t.name, ID=t.name.upper(), crc=t.crc))
 618
 619     write("\n#endif\n")
 620
 621
 622 def generate_c_boilerplate(services, defines, counters, file_crc,
 623                            module, stream):
 624     write = stream.write
 625     define_hash = {d.name: d for d in defines}
 626
 627     hdr = '''\
 628 #define vl_endianfun            /* define message structures */
 629 #include "{module}.api.h"
 630 #undef vl_endianfun
 631
 632 /* instantiate all the print functions we know about */
 633 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
 634 #define vl_printfun
 635 #include "{module}.api.h"
 636 #undef vl_printfun
 637
 638 '''
 639
 640     write(hdr.format(module=module))
 641     write('static u16\n')
 642     write('setup_message_id_table (void) {\n')
 643     write('   api_main_t *am = my_api_main;\n')
 644     write('   vl_msg_api_msg_config_t c;\n')
 645     write('   u16 msg_id_base = vl_msg_api_get_msg_ids ("{}_{crc:08x}", VL_MSG_{m}_LAST);\n'
 646           .format(module, crc=file_crc, m=module.upper()))
 647
 648
 649     for d in defines:
 650         write('   vl_msg_api_add_msg_name_crc (am, "{n}_{crc:08x}",\n'
 651               '                                VL_API_{ID} + msg_id_base);\n'
 652               .format(n=d.name, ID=d.name.upper(), crc=d.crc))
 653     for s in services:
 654         d = define_hash[s.caller]
 655         write('   c = (vl_msg_api_msg_config_t) {{.id = VL_API_{ID} + msg_id_base,\n'
 656               '                                  .name = "{n}",\n'
 657               '                                  .handler = vl_api_{n}_t_handler,\n'
 658               '                                  .cleanup = vl_noop_handler,\n'
 659               '                                  .endian = vl_api_{n}_t_endian,\n'
 660               '                                  .print = vl_api_{n}_t_print,\n'
 661               '                                  .is_autoendian = 0}};\n'
 662               .format(n=s.caller, ID=s.caller.upper()))
 663         write('   vl_msg_api_config (&c);\n')
 664         try:
 665             d = define_hash[s.reply]
 666             write('   c = (vl_msg_api_msg_config_t) {{.id = VL_API_{ID} + msg_id_base,\n'
 667                   '                                  .name = "{n}",\n'
 668                   '                                  .handler = 0,\n'
 669                   '                                  .cleanup = vl_noop_handler,\n'
 670                   '                                  .endian = vl_api_{n}_t_endian,\n'
 671                   '                                  .print = vl_api_{n}_t_print,\n'
 672                   '                                  .is_autoendian = 0}};\n'
 673                   .format(n=s.reply, ID=s.reply.upper()))
 674             write('   vl_msg_api_config (&c);\n')
 675         except KeyError:
 676             pass
 677
 678     write('   return msg_id_base;\n')
 679     write('}\n')
 680
 681     severity = {'error': 'VL_COUNTER_SEVERITY_ERROR',
 682                 'info': 'VL_COUNTER_SEVERITY_INFO',
 683                 'warn': 'VL_COUNTER_SEVERITY_WARN'}
 684
 685     for cnt in counters:
 686         csetname = cnt.name
 687         '''
 688         write('char *{}_error_strings[] = {{\n'.format(csetname))
 689         for c in cnt.block:
 690             write('   "{}",\n'.format(c['name']))
 691         write('};\n')
 692         write('char *{}_description_strings[] = {{\n'.format(csetname))
 693         for c in cnt.block:
 694             write('   "{}",\n'.format(c['description']))
 695         write('};\n')
 696         '''
 697         write('vl_counter_t {}_error_counters[] = {{\n'.format(csetname))
 698         for c in cnt.block:
 699             write('  {\n')
 700             write('   .name = "{}",\n'.format(c['name']))
 701             write('   .desc = "{}",\n'.format(c['description']))
 702             write('   .severity = {},\n'.format(severity[c['severity']]))
 703             write('  },\n')
 704         write('};\n')
 705
 706 def generate_c_test_boilerplate(services, defines, file_crc, module, plugin, stream):
 707     write = stream.write
 708
 709     define_hash = {d.name:d for d in defines}
 710     replies = {}
 711
 712     hdr = '''\
 713 #define vl_endianfun            /* define message structures */
 714 #include "{module}.api.h"
 715 #undef vl_endianfun
 716
 717 /* instantiate all the print functions we know about */
 718 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
 719 #define vl_printfun
 720 #include "{module}.api.h"
 721 #undef vl_printfun
 722
 723 '''
 724
 725     write(hdr.format(module=module))
 726     for s in services:
 727         try:
 728             d = define_hash[s.reply]
 729         except:
 730             continue
 731         if d.manual_print:
 732             write('/* Manual definition requested for: vl_api_{n}_t_handler() */\n'
 733                   .format(n=s.reply))
 734             continue
 735         if not define_hash[s.caller].autoreply:
 736             write('/* Only autoreply is supported (vl_api_{n}_t_handler()) */\n'
 737                   .format(n=s.reply))
 738             continue
 739         write('#ifndef VL_API_{n}_T_HANDLER\n'.format(n=s.reply.upper()))
 740         write('static void\n')
 741         write('vl_api_{n}_t_handler (vl_api_{n}_t * mp) {{\n'.format(n=s.reply))
 742         write('   vat_main_t * vam = {}_test_main.vat_main;\n'.format(module))
 743         write('   i32 retval = ntohl(mp->retval);\n')
 744         write('   if (vam->async_mode) {\n')
 745         write('      vam->async_errors += (retval < 0);\n')
 746         write('   } else {\n')
 747         write('      vam->retval = retval;\n')
 748         write('      vam->result_ready = 1;\n')
 749         write('   }\n')
 750         write('}\n')
 751         write('#endif\n')
 752
 753         for e in s.events:
 754             if define_hash[e].manual_print:
 755                 continue
 756             write('static void\n')
 757             write('vl_api_{n}_t_handler (vl_api_{n}_t * mp) {{\n'.format(n=e))
 758             write('    vl_print(0, "{n} event called:");\n'.format(n=e))
 759             write('    vl_api_{n}_t_print(mp, 0);\n'.format(n=e))
 760             write('}\n')
 761
 762     write('static void\n')
 763     write('setup_message_id_table (vat_main_t * vam, u16 msg_id_base) {\n')
 764     for s in services:
 765         write('   vl_msg_api_set_handlers(VL_API_{ID} + msg_id_base, "{n}",\n'
 766               '                           vl_api_{n}_t_handler, vl_noop_handler,\n'
 767               '                           vl_api_{n}_t_endian, vl_api_{n}_t_print,\n'
 768               '                           sizeof(vl_api_{n}_t), 1);\n'
 769               .format(n=s.reply, ID=s.reply.upper()))
 770         write('   hash_set_mem (vam->function_by_name, "{n}", api_{n});\n'.format(n=s.caller))
 771         try:
 772             write('   hash_set_mem (vam->help_by_name, "{n}", "{help}");\n'
 773                   .format(n=s.caller, help=define_hash[s.caller].options['vat_help']))
 774         except:
 775             pass
 776
 777         # Events
 778         for e in s.events:
 779             write('   vl_msg_api_set_handlers(VL_API_{ID} + msg_id_base, "{n}",\n'
 780                   '                           vl_api_{n}_t_handler, vl_noop_handler,\n'
 781                   '                           vl_api_{n}_t_endian, vl_api_{n}_t_print,\n'
 782                   '                           sizeof(vl_api_{n}_t), 1);\n'
 783                   .format(n=e, ID=e.upper()))
 784
 785     write('}\n')
 786     if plugin:
 787         write('clib_error_t * vat_plugin_register (vat_main_t *vam)\n')
 788     else:
 789         write('clib_error_t * vat_{}_plugin_register (vat_main_t *vam)\n'.format(module))
 790     write('{\n')
 791     write('   {n}_test_main_t * mainp = &{n}_test_main;\n'.format(n=module))
 792     write('   mainp->vat_main = vam;\n')
 793     write('   mainp->msg_id_base = vl_client_get_first_plugin_msg_id ("{n}_{crc:08x}");\n'
 794           .format(n=module, crc=file_crc))
 795     write('   if (mainp->msg_id_base == (u16) ~0)\n')
 796     write('      return clib_error_return (0, "{} plugin not loaded...");\n'.format(module))
 797     write('   setup_message_id_table (vam, mainp->msg_id_base);\n')
 798     write('#ifdef VL_API_LOCAL_SETUP_MESSAGE_ID_TABLE\n')
 799     write('    VL_API_LOCAL_SETUP_MESSAGE_ID_TABLE(vam);\n')
 800     write('#endif\n')
 801     write('   return 0;\n')
 802     write('}\n')
 803
 804 #
 805 # Plugin entry point
 806 #
 807 def run(args, input_filename, s):
 808     stream = StringIO()
 809
 810     if not args.outputdir:
 811         sys.stderr.write('Missing --outputdir argument')
 812         return None
 813
 814     basename = os.path.basename(input_filename)
 815     filename, file_extension = os.path.splitext(basename)
 816     modulename = filename.replace('.', '_')
 817     filename_enum = os.path.join(args.outputdir + '/' + basename + '_enum.h')
 818     filename_types = os.path.join(args.outputdir + '/' + basename + '_types.h')
 819     filename_c = os.path.join(args.outputdir + '/' + basename + '.c')
 820     filename_c_test = os.path.join(args.outputdir + '/' + basename + '_test.c')
 821
 822     # Generate separate types file
 823     st = StringIO()
 824     generate_include_types(s, modulename, st)
 825     with open (filename_types, 'w') as fd:
 826         st.seek (0)
 827         shutil.copyfileobj (st, fd)
 828     st.close()
 829
 830     # Generate separate enum file
 831     st = StringIO()
 832     st.write('#ifndef included_{}_api_enum_h\n'.format(modulename))
 833     st.write('#define included_{}_api_enum_h\n'.format(modulename))
 834     generate_include_enum(s, modulename, st)
 835     generate_include_counters(s['Counters'], modulename, st)
 836     st.write('#endif\n')
 837     with open (filename_enum, 'w') as fd:
 838         st.seek (0)
 839         shutil.copyfileobj (st, fd)
 840     st.close()
 841
 842     # Generate separate C file
 843     st = StringIO()
 844     generate_c_boilerplate(s['Service'], s['Define'], s['Counters'],
 845                            s['file_crc'], modulename, st)
 846     with open (filename_c, 'w') as fd:
 847         st.seek (0)
 848         shutil.copyfileobj(st, fd)
 849     st.close()
 850
 851     # Generate separate C test file
 852     st = StringIO()
 853     plugin = True if 'plugin' in input_filename else False
 854     generate_c_test_boilerplate(s['Service'], s['Define'], s['file_crc'],
 855                                 modulename, plugin, st)
 856     with open (filename_c_test, 'w') as fd:
 857         st.seek (0)
 858         shutil.copyfileobj(st, fd)
 859     st.close()
 860
 861     output = top_boilerplate.format(datestring=datestring,
 862                                     input_filename=basename)
 863     output += imports(s['Import'])
 864     output += msg_ids(s)
 865     output += msg_names(s)
 866     output += msg_name_crc_list(s, filename)
 867     output += typedefs(modulename)
 868     printfun_types(s['types'], stream, modulename)
 869     printfun(s['Define'], stream, modulename)
 870     output += stream.getvalue()
 871     stream.close()
 872     output += endianfun(s['types'] + s['Define'], modulename)
 873     output += version_tuple(s, basename)
 874     output += bottom_boilerplate.format(input_filename=basename,
 875                                         file_crc=s['file_crc'])
 876
 877     return output