src/tools/vppapigen/vppapigen.py

   1 #!/usr/bin/env python3
   2
   3 import ply.lex as lex
   4 import ply.yacc as yacc
   5 import sys
   6 import argparse
   7 import keyword
   8 import logging
   9 import binascii
  10 import os
  11 import sys
  12 from subprocess import Popen, PIPE
  13
  14 assert sys.version_info >= (3, 6), \
  15     "Not supported Python version: {}".format(sys.version)
  16 log = logging.getLogger('vppapigen')
  17
  18 # Ensure we don't leave temporary files around
  19 sys.dont_write_bytecode = True
  20
  21 #
  22 # VPP API language
  23 #
  24
  25 # Global dictionary of new types (including enums)
  26 global_types = {}
  27
  28 seen_imports = {}
  29
  30
  31 def global_type_add(name, obj):
  32     '''Add new type to the dictionary of types '''
  33     type_name = 'vl_api_' + name + '_t'
  34     if type_name in global_types:
  35         raise KeyError("Attempted redefinition of {!r} with {!r}.".format(
  36             name, obj))
  37     global_types[type_name] = obj
  38
  39
  40 # All your trace are belong to us!
  41 def exception_handler(exception_type, exception, traceback):
  42     print("%s: %s" % (exception_type.__name__, exception))
  43
  44
  45 #
  46 # Lexer
  47 #
  48 class VPPAPILexer(object):
  49     def __init__(self, filename):
  50         self.filename = filename
  51
  52     reserved = {
  53         'service': 'SERVICE',
  54         'rpc': 'RPC',
  55         'returns': 'RETURNS',
  56         'null': 'NULL',
  57         'stream': 'STREAM',
  58         'events': 'EVENTS',
  59         'define': 'DEFINE',
  60         'typedef': 'TYPEDEF',
  61         'enum': 'ENUM',
  62         'typeonly': 'TYPEONLY',
  63         'manual_print': 'MANUAL_PRINT',
  64         'manual_endian': 'MANUAL_ENDIAN',
  65         'dont_trace': 'DONT_TRACE',
  66         'autoreply': 'AUTOREPLY',
  67         'option': 'OPTION',
  68         'u8': 'U8',
  69         'u16': 'U16',
  70         'u32': 'U32',
  71         'u64': 'U64',
  72         'i8': 'I8',
  73         'i16': 'I16',
  74         'i32': 'I32',
  75         'i64': 'I64',
  76         'f64': 'F64',
  77         'bool': 'BOOL',
  78         'string': 'STRING',
  79         'import': 'IMPORT',
  80         'true': 'TRUE',
  81         'false': 'FALSE',
  82         'union': 'UNION',
  83     }
  84
  85     tokens = ['STRING_LITERAL',
  86               'ID', 'NUM'] + list(reserved.values())
  87
  88     t_ignore_LINE_COMMENT = '//.*'
  89
  90     def t_FALSE(self, t):
  91         r'false'
  92         t.value = False
  93         return t
  94
  95     def t_TRUE(self, t):
  96         r'false'
  97         t.value = True
  98         return t
  99
 100     def t_NUM(self, t):
 101         r'0[xX][0-9a-fA-F]+|-?\d+\.?\d*'
 102         base = 16 if t.value.startswith('0x') else 10
 103         if '.' in t.value:
 104             t.value = float(t.value)
 105         else:
 106             t.value = int(t.value, base)
 107         return t
 108
 109     def t_ID(self, t):
 110         r'[a-zA-Z_][a-zA-Z_0-9]*'
 111         # Check for reserved words
 112         t.type = VPPAPILexer.reserved.get(t.value, 'ID')
 113         return t
 114
 115     # C string
 116     def t_STRING_LITERAL(self, t):
 117         r'\"([^\\\n]|(\\.))*?\"'
 118         t.value = str(t.value).replace("\"", "")
 119         return t
 120
 121     # C or C++ comment (ignore)
 122     def t_comment(self, t):
 123         r'(/\*(.|\n)*?\*/)|(//.*)'
 124         t.lexer.lineno += t.value.count('\n')
 125
 126     # Error handling rule
 127     def t_error(self, t):
 128         raise ParseError("Illegal character '{}' ({})"
 129                          "in {}: line {}".format(t.value[0],
 130                                                  hex(ord(t.value[0])),
 131                                                  self.filename,
 132                                                  t.lexer.lineno))
 133
 134     # Define a rule so we can track line numbers
 135     def t_newline(self, t):
 136         r'\n+'
 137         t.lexer.lineno += len(t.value)
 138
 139     literals = ":{}[];=.,"
 140
 141     # A string containing ignored characters (spaces and tabs)
 142     t_ignore = ' \t'
 143
 144
 145 def crc_block_combine(block, crc):
 146     s = str(block).encode()
 147     return binascii.crc32(s, crc) & 0xffffffff
 148
 149
 150 def vla_is_last_check(name, block):
 151     vla = False
 152     for i, b in enumerate(block):
 153         if isinstance(b, Array) and b.vla:
 154             vla = True
 155             if i + 1 < len(block):
 156                 raise ValueError(
 157                     'VLA field "{}" must be the last field in message "{}"'
 158                     .format(b.fieldname, name))
 159         elif b.fieldtype.startswith('vl_api_'):
 160             if global_types[b.fieldtype].vla:
 161                 vla = True
 162                 if i + 1 < len(block):
 163                     raise ValueError(
 164                         'VLA field "{}" must be the last '
 165                         'field in message "{}"'
 166                         .format(b.fieldname, name))
 167         elif b.fieldtype == 'string' and b.length == 0:
 168             vla = True
 169             if i + 1 < len(block):
 170                 raise ValueError(
 171                     'VLA field "{}" must be the last '
 172                     'field in message "{}"'
 173                     .format(b.fieldname, name))
 174     return vla
 175
 176
 177 class Service():
 178     def __init__(self, caller, reply, events=None, stream_message=None, stream=False):
 179         self.caller = caller
 180         self.reply = reply
 181         self.stream = stream
 182         self.stream_message = stream_message
 183         self.events = [] if events is None else events
 184
 185
 186 class Typedef():
 187     def __init__(self, name, flags, block):
 188         self.name = name
 189         self.flags = flags
 190         self.block = block
 191         self.crc = str(block).encode()
 192         self.manual_print = False
 193         self.manual_endian = False
 194         for f in flags:
 195             if f == 'manual_print':
 196                 self.manual_print = True
 197             elif f == 'manual_endian':
 198                 self.manual_endian = True
 199
 200         global_type_add(name, self)
 201
 202         self.vla = vla_is_last_check(name, block)
 203
 204     def __repr__(self):
 205         return self.name + str(self.flags) + str(self.block)
 206
 207
 208 class Using():
 209     def __init__(self, name, flags, alias):
 210         self.name = name
 211         self.vla = False
 212         self.block = []
 213         self.manual_print = True
 214         self.manual_endian = True
 215
 216         self.manual_print = False
 217         self.manual_endian = False
 218         for f in flags:
 219             if f == 'manual_print':
 220                 self.manual_print = True
 221             elif f == 'manual_endian':
 222                 self.manual_endian = True
 223
 224         if isinstance(alias, Array):
 225             a = {'type': alias.fieldtype,
 226                  'length': alias.length}
 227         else:
 228             a = {'type': alias.fieldtype}
 229         self.alias = a
 230         self.crc = str(alias).encode()
 231         global_type_add(name, self)
 232
 233     def __repr__(self):
 234         return self.name + str(self.alias)
 235
 236
 237 class Union():
 238     def __init__(self, name, flags, block):
 239         self.type = 'Union'
 240         self.manual_print = False
 241         self.manual_endian = False
 242         self.name = name
 243
 244         for f in flags:
 245             if f == 'manual_print':
 246                 self.manual_print = True
 247             elif f == 'manual_endian':
 248                 self.manual_endian = True
 249
 250         self.block = block
 251         self.crc = str(block).encode()
 252         self.vla = vla_is_last_check(name, block)
 253
 254         global_type_add(name, self)
 255
 256     def __repr__(self):
 257         return str(self.block)
 258
 259
 260 class Define():
 261     def __init__(self, name, flags, block):
 262         self.name = name
 263         self.flags = flags
 264         self.block = block
 265         self.dont_trace = False
 266         self.manual_print = False
 267         self.manual_endian = False
 268         self.autoreply = False
 269         self.singular = False
 270         self.options = {}
 271         for f in flags:
 272             if f == 'dont_trace':
 273                 self.dont_trace = True
 274             elif f == 'manual_print':
 275                 self.manual_print = True
 276             elif f == 'manual_endian':
 277                 self.manual_endian = True
 278             elif f == 'autoreply':
 279                 self.autoreply = True
 280
 281         remove = []
 282         for b in block:
 283             if isinstance(b, Option):
 284                 if b[1] == 'singular' and b[2] == 'true':
 285                     self.singular = True
 286                 else:
 287                     self.options[b.option] = b.value
 288                 remove.append(b)
 289
 290         block = [x for x in block if x not in remove]
 291         self.block = block
 292         self.vla = vla_is_last_check(name, block)
 293         self.crc = str(block).encode()
 294
 295     def __repr__(self):
 296         return self.name + str(self.flags) + str(self.block)
 297
 298
 299 class Enum():
 300     def __init__(self, name, block, enumtype='u32'):
 301         self.name = name
 302         self.enumtype = enumtype
 303         self.vla = False
 304
 305         count = 0
 306         for i, b in enumerate(block):
 307             if type(b) is list:
 308                 count = b[1]
 309             else:
 310                 count += 1
 311                 block[i] = [b, count]
 312
 313         self.block = block
 314         self.crc = str(block).encode()
 315         global_type_add(name, self)
 316
 317     def __repr__(self):
 318         return self.name + str(self.block)
 319
 320
 321 class Import():
 322
 323     def __new__(cls, *args, **kwargs):
 324         if args[0] not in seen_imports:
 325             instance = super().__new__(cls)
 326             instance._initialized = False
 327             seen_imports[args[0]] = instance
 328
 329         return seen_imports[args[0]]
 330
 331     def __init__(self, filename, revision):
 332         if self._initialized:
 333             return
 334         else:
 335             self.filename = filename
 336             # Deal with imports
 337             parser = VPPAPI(filename=filename, revision=revision)
 338             dirlist = dirlist_get()
 339             f = filename
 340             for dir in dirlist:
 341                 f = os.path.join(dir, filename)
 342                 if os.path.exists(f):
 343                     break
 344             self.result = parser.parse_filename(f, None)
 345             self._initialized = True
 346
 347     def __repr__(self):
 348         return self.filename
 349
 350
 351 class Option():
 352     def __init__(self, option, value=None):
 353         self.type = 'Option'
 354         self.option = option
 355         self.value = value
 356         self.crc = str(option).encode()
 357
 358     def __repr__(self):
 359         return str(self.option)
 360
 361     def __getitem__(self, index):
 362         return self.option[index]
 363
 364
 365 class Array():
 366     def __init__(self, fieldtype, name, length, modern_vla=False):
 367         self.type = 'Array'
 368         self.fieldtype = fieldtype
 369         self.fieldname = name
 370         self.modern_vla = modern_vla
 371         if type(length) is str:
 372             self.lengthfield = length
 373             self.length = 0
 374             self.vla = True
 375         else:
 376             self.length = length
 377             self.lengthfield = None
 378             self.vla = False
 379
 380     def __repr__(self):
 381         return str([self.fieldtype, self.fieldname, self.length,
 382                     self.lengthfield])
 383
 384
 385 class Field():
 386     def __init__(self, fieldtype, name, limit=None):
 387         self.type = 'Field'
 388         self.fieldtype = fieldtype
 389
 390         if self.fieldtype == 'string':
 391             raise ValueError("The string type {!r} is an "
 392                              "array type ".format(name))
 393
 394         if name in keyword.kwlist:
 395             raise ValueError("Fieldname {!r} is a python keyword and is not "
 396                              "accessible via the python API. ".format(name))
 397         self.fieldname = name
 398         self.limit = limit
 399
 400     def __repr__(self):
 401         return str([self.fieldtype, self.fieldname])
 402
 403
 404 class Coord(object):
 405     """ Coordinates of a syntactic element. Consists of:
 406             - File name
 407             - Line number
 408             - (optional) column number, for the Lexer
 409     """
 410     __slots__ = ('file', 'line', 'column', '__weakref__')
 411
 412     def __init__(self, file, line, column=None):
 413         self.file = file
 414         self.line = line
 415         self.column = column
 416
 417     def __str__(self):
 418         str = "%s:%s" % (self.file, self.line)
 419         if self.column:
 420             str += ":%s" % self.column
 421         return str
 422
 423
 424 class ParseError(Exception):
 425     pass
 426
 427
 428 #
 429 # Grammar rules
 430 #
 431 class VPPAPIParser(object):
 432     tokens = VPPAPILexer.tokens
 433
 434     def __init__(self, filename, logger, revision=None):
 435         self.filename = filename
 436         self.logger = logger
 437         self.fields = []
 438         self.revision = revision
 439
 440     def _parse_error(self, msg, coord):
 441         raise ParseError("%s: %s" % (coord, msg))
 442
 443     def _parse_warning(self, msg, coord):
 444         if self.logger:
 445             self.logger.warning("%s: %s" % (coord, msg))
 446
 447     def _coord(self, lineno, column=None):
 448         return Coord(
 449                 file=self.filename,
 450                 line=lineno, column=column)
 451
 452     def _token_coord(self, p, token_idx):
 453         """ Returns the coordinates for the YaccProduction object 'p' indexed
 454             with 'token_idx'. The coordinate includes the 'lineno' and
 455             'column'. Both follow the lex semantic, starting from 1.
 456         """
 457         last_cr = p.lexer.lexdata.rfind('\n', 0, p.lexpos(token_idx))
 458         if last_cr < 0:
 459             last_cr = -1
 460         column = (p.lexpos(token_idx) - (last_cr))
 461         return self._coord(p.lineno(token_idx), column)
 462
 463     def p_slist(self, p):
 464         '''slist : stmt
 465                  | slist stmt'''
 466         if len(p) == 2:
 467             p[0] = [p[1]]
 468         else:
 469             p[0] = p[1] + [p[2]]
 470
 471     def p_stmt(self, p):
 472         '''stmt : define
 473                 | typedef
 474                 | option
 475                 | import
 476                 | enum
 477                 | union
 478                 | service'''
 479         p[0] = p[1]
 480
 481     def p_import(self, p):
 482         '''import : IMPORT STRING_LITERAL ';' '''
 483         p[0] = Import(p[2], revision=self.revision)
 484
 485     def p_service(self, p):
 486         '''service : SERVICE '{' service_statements '}' ';' '''
 487         p[0] = p[3]
 488
 489     def p_service_statements(self, p):
 490         '''service_statements : service_statement
 491                         | service_statements service_statement'''
 492         if len(p) == 2:
 493             p[0] = [p[1]]
 494         else:
 495             p[0] = p[1] + [p[2]]
 496
 497     def p_service_statement(self, p):
 498         '''service_statement : RPC ID RETURNS NULL ';'
 499                              | RPC ID RETURNS ID ';'
 500                              | RPC ID RETURNS STREAM ID ';'
 501                              | RPC ID RETURNS ID EVENTS event_list ';' '''
 502         if p[2] == p[4]:
 503             # Verify that caller and reply differ
 504             self._parse_error(
 505                 'Reply ID ({}) should not be equal to Caller ID'.format(p[2]),
 506                 self._token_coord(p, 1))
 507         if len(p) == 8:
 508             p[0] = Service(p[2], p[4], p[6])
 509         elif len(p) == 7:
 510             p[0] = Service(p[2], p[5], stream=True)
 511         else:
 512             p[0] = Service(p[2], p[4])
 513
 514     def p_service_statement2(self, p):
 515         '''service_statement : RPC ID RETURNS ID STREAM ID ';' '''
 516         p[0] = Service(p[2], p[4], stream_message=p[6], stream=True)
 517
 518     def p_event_list(self, p):
 519         '''event_list : events
 520                       | event_list events '''
 521         if len(p) == 2:
 522             p[0] = [p[1]]
 523         else:
 524             p[0] = p[1] + [p[2]]
 525
 526     def p_event(self, p):
 527         '''events : ID
 528                   | ID ',' '''
 529         p[0] = p[1]
 530
 531     def p_enum(self, p):
 532         '''enum : ENUM ID '{' enum_statements '}' ';' '''
 533         p[0] = Enum(p[2], p[4])
 534
 535     def p_enum_type(self, p):
 536         ''' enum : ENUM ID ':' enum_size '{' enum_statements '}' ';' '''
 537         if len(p) == 9:
 538             p[0] = Enum(p[2], p[6], enumtype=p[4])
 539         else:
 540             p[0] = Enum(p[2], p[4])
 541
 542     def p_enum_size(self, p):
 543         ''' enum_size : U8
 544                       | U16
 545                       | U32 '''
 546         p[0] = p[1]
 547
 548     def p_define(self, p):
 549         '''define : DEFINE ID '{' block_statements_opt '}' ';' '''
 550         self.fields = []
 551         p[0] = Define(p[2], [], p[4])
 552
 553     def p_define_flist(self, p):
 554         '''define : flist DEFINE ID '{' block_statements_opt '}' ';' '''
 555         # Legacy typedef
 556         if 'typeonly' in p[1]:
 557             self._parse_error('legacy typedef. use typedef: {} {}[{}];'
 558                               .format(p[1], p[2], p[4]),
 559                               self._token_coord(p, 1))
 560         else:
 561             p[0] = Define(p[3], p[1], p[5])
 562
 563     def p_flist(self, p):
 564         '''flist : flag
 565                  | flist flag'''
 566         if len(p) == 2:
 567             p[0] = [p[1]]
 568         else:
 569             p[0] = p[1] + [p[2]]
 570
 571     def p_flag(self, p):
 572         '''flag : MANUAL_PRINT
 573                 | MANUAL_ENDIAN
 574                 | DONT_TRACE
 575                 | TYPEONLY
 576                 | AUTOREPLY'''
 577         if len(p) == 1:
 578             return
 579         p[0] = p[1]
 580
 581     def p_typedef(self, p):
 582         '''typedef : TYPEDEF ID '{' block_statements_opt '}' ';' '''
 583         p[0] = Typedef(p[2], [], p[4])
 584
 585     def p_typedef_flist(self, p):
 586         '''typedef : flist TYPEDEF ID '{' block_statements_opt '}' ';' '''
 587         p[0] = Typedef(p[3], p[1], p[5])
 588
 589     def p_typedef_alias(self, p):
 590         '''typedef : TYPEDEF declaration '''
 591         p[0] = Using(p[2].fieldname, [], p[2])
 592
 593     def p_typedef_alias_flist(self, p):
 594         '''typedef : flist TYPEDEF declaration '''
 595         p[0] = Using(p[3].fieldname, p[1], p[3])
 596
 597     def p_block_statements_opt(self, p):
 598         '''block_statements_opt : block_statements '''
 599         p[0] = p[1]
 600
 601     def p_block_statements(self, p):
 602         '''block_statements : block_statement
 603                             | block_statements block_statement'''
 604         if len(p) == 2:
 605             p[0] = [p[1]]
 606         else:
 607             p[0] = p[1] + [p[2]]
 608
 609     def p_block_statement(self, p):
 610         '''block_statement : declaration
 611                            | option '''
 612         p[0] = p[1]
 613
 614     def p_enum_statements(self, p):
 615         '''enum_statements : enum_statement
 616                            | enum_statements enum_statement'''
 617         if len(p) == 2:
 618             p[0] = [p[1]]
 619         else:
 620             p[0] = p[1] + [p[2]]
 621
 622     def p_enum_statement(self, p):
 623         '''enum_statement : ID '=' NUM ','
 624                           | ID ',' '''
 625         if len(p) == 5:
 626             p[0] = [p[1], p[3]]
 627         else:
 628             p[0] = p[1]
 629
 630     def p_field_options(self, p):
 631         '''field_options : field_option
 632                            | field_options field_option'''
 633         if len(p) == 2:
 634             p[0] = p[1]
 635         else:
 636             p[0] = {**p[1], **p[2]}
 637
 638     def p_field_option(self, p):
 639         '''field_option : ID
 640                         | ID '=' assignee ','
 641                         | ID '=' assignee
 642
 643         '''
 644         if len(p) == 2:
 645             p[0] = {p[1]: None}
 646         else:
 647             p[0] = {p[1]: p[3]}
 648
 649     def p_declaration(self, p):
 650         '''declaration : type_specifier ID ';'
 651                        | type_specifier ID '[' field_options ']' ';' '''
 652         if len(p) == 7:
 653             p[0] = Field(p[1], p[2], p[4])
 654         elif len(p) == 4:
 655             p[0] = Field(p[1], p[2])
 656         else:
 657             self._parse_error('ERROR', self._token_coord(p, 1))
 658         self.fields.append(p[2])
 659
 660     def p_declaration_array_vla(self, p):
 661         '''declaration : type_specifier ID '[' ']' ';' '''
 662         p[0] = Array(p[1], p[2], 0, modern_vla=True)
 663
 664     def p_declaration_array(self, p):
 665         '''declaration : type_specifier ID '[' NUM ']' ';'
 666                        | type_specifier ID '[' ID ']' ';' '''
 667
 668         if len(p) != 7:
 669             return self._parse_error(
 670                 'array: %s' % p.value,
 671                 self._coord(lineno=p.lineno))
 672
 673         # Make this error later
 674         if type(p[4]) is int and p[4] == 0:
 675             # XXX: Line number is wrong
 676             self._parse_warning('Old Style VLA: {} {}[{}];'
 677                                 .format(p[1], p[2], p[4]),
 678                                 self._token_coord(p, 1))
 679
 680         if type(p[4]) is str and p[4] not in self.fields:
 681             # Verify that length field exists
 682             self._parse_error('Missing length field: {} {}[{}];'
 683                               .format(p[1], p[2], p[4]),
 684                               self._token_coord(p, 1))
 685         p[0] = Array(p[1], p[2], p[4])
 686
 687     def p_option(self, p):
 688         '''option : OPTION ID '=' assignee ';'
 689                   | OPTION ID ';' '''
 690         if len(p) == 4:
 691             p[0] = Option(p[2])
 692         else:
 693             p[0] = Option(p[2], p[4])
 694
 695     def p_assignee(self, p):
 696         '''assignee : NUM
 697                     | TRUE
 698                     | FALSE
 699                     | STRING_LITERAL '''
 700         p[0] = p[1]
 701
 702     def p_type_specifier(self, p):
 703         '''type_specifier : U8
 704                           | U16
 705                           | U32
 706                           | U64
 707                           | I8
 708                           | I16
 709                           | I32
 710                           | I64
 711                           | F64
 712                           | BOOL
 713                           | STRING'''
 714         p[0] = p[1]
 715
 716     # Do a second pass later to verify that user defined types are defined
 717     def p_typedef_specifier(self, p):
 718         '''type_specifier : ID '''
 719         if p[1] not in global_types:
 720             self._parse_error('Undefined type: {}'.format(p[1]),
 721                               self._token_coord(p, 1))
 722         p[0] = p[1]
 723
 724     def p_union(self, p):
 725         '''union : UNION ID '{' block_statements_opt '}' ';' '''
 726         p[0] = Union(p[2], [], p[4])
 727
 728     def p_union_flist(self, p):
 729         '''union : flist UNION ID '{' block_statements_opt '}' ';' '''
 730         p[0] = Union(p[3], p[1], p[5])
 731
 732     # Error rule for syntax errors
 733     def p_error(self, p):
 734         if p:
 735             self._parse_error(
 736                 'before: %s' % p.value,
 737                 self._coord(lineno=p.lineno))
 738         else:
 739             self._parse_error('At end of input', self.filename)
 740
 741
 742 class VPPAPI(object):
 743
 744     def __init__(self, debug=False, filename='', logger=None, revision=None):
 745         self.lexer = lex.lex(module=VPPAPILexer(filename), debug=debug)
 746         self.parser = yacc.yacc(module=VPPAPIParser(filename, logger,
 747                                                     revision=revision),
 748                                 write_tables=False, debug=debug)
 749         self.logger = logger
 750         self.revision = revision
 751         self.filename = filename
 752
 753     def parse_string(self, code, debug=0, lineno=1):
 754         self.lexer.lineno = lineno
 755         return self.parser.parse(code, lexer=self.lexer, debug=debug)
 756
 757     def parse_fd(self, fd, debug=0):
 758         data = fd.read()
 759         return self.parse_string(data, debug=debug)
 760
 761     def parse_filename(self, filename, debug=0):
 762         if self.revision:
 763             git_show = f'git show  {self.revision}:{filename}'
 764             proc = Popen(git_show.split(), stdout=PIPE, encoding='utf-8')
 765             try:
 766                 data, errs = proc.communicate()
 767                 if proc.returncode != 0:
 768                     print(f'File not found: {self.revision}:{filename}', file=sys.stderr)
 769                     sys.exit(2)
 770                 return self.parse_string(data, debug=debug)
 771             except Exception as e:
 772                 sys.exit(3)
 773         else:
 774             try:
 775                 with open(filename, encoding='utf-8') as fd:
 776                     return self.parse_fd(fd, None)
 777             except FileNotFoundError:
 778                 print(f'File not found: {filename}', file=sys.stderr)
 779                 sys.exit(2)
 780
 781     def autoreply_block(self, name, parent):
 782         block = [Field('u32', 'context'),
 783                  Field('i32', 'retval')]
 784         # inherhit the parent's options
 785         for k, v in parent.options.items():
 786             block.append(Option(k, v))
 787         return Define(name + '_reply', [], block)
 788
 789     def process(self, objs):
 790         s = {}
 791         s['Option'] = {}
 792         s['Define'] = []
 793         s['Service'] = []
 794         s['types'] = []
 795         s['Import'] = []
 796         crc = 0
 797         for o in objs:
 798             tname = o.__class__.__name__
 799             try:
 800                 crc = binascii.crc32(o.crc, crc) & 0xffffffff
 801             except AttributeError:
 802                 pass
 803             if isinstance(o, Define):
 804                 s[tname].append(o)
 805                 if o.autoreply:
 806                     s[tname].append(self.autoreply_block(o.name, o))
 807             elif isinstance(o, Option):
 808                 s[tname][o.option] = o.value
 809             elif type(o) is list:
 810                 for o2 in o:
 811                     if isinstance(o2, Service):
 812                         s['Service'].append(o2)
 813             elif (isinstance(o, Enum) or
 814                   isinstance(o, Typedef) or
 815                   isinstance(o, Using) or
 816                   isinstance(o, Union)):
 817                 s['types'].append(o)
 818             else:
 819                 if tname not in s:
 820                     raise ValueError('Unknown class type: {} {}'
 821                                      .format(tname, o))
 822                 s[tname].append(o)
 823
 824         msgs = {d.name: d for d in s['Define']}
 825         svcs = {s.caller: s for s in s['Service']}
 826         replies = {s.reply: s for s in s['Service']}
 827         seen_services = {}
 828
 829         s['file_crc'] = crc
 830
 831         for service in svcs:
 832             if service not in msgs:
 833                 raise ValueError(
 834                     'Service definition refers to unknown message'
 835                     ' definition: {}'.format(service))
 836             if svcs[service].reply != 'null' and \
 837                svcs[service].reply not in msgs:
 838                 raise ValueError('Service definition refers to unknown message'
 839                                  ' definition in reply: {}'
 840                                  .format(svcs[service].reply))
 841             if service in replies:
 842                 raise ValueError('Service definition refers to message'
 843                                  ' marked as reply: {}'.format(service))
 844             for event in svcs[service].events:
 845                 if event not in msgs:
 846                     raise ValueError('Service definition refers to unknown '
 847                                      'event: {} in message: {}'
 848                                      .format(event, service))
 849                 seen_services[event] = True
 850
 851         # Create services implicitly
 852         for d in msgs:
 853             if d in seen_services:
 854                 continue
 855             if msgs[d].singular is True:
 856                 continue
 857             if d.endswith('_reply'):
 858                 if d[:-6] in svcs:
 859                     continue
 860                 if d[:-6] not in msgs:
 861                     raise ValueError('{} missing calling message'
 862                                      .format(d))
 863                 continue
 864             if d.endswith('_dump'):
 865                 if d in svcs:
 866                     continue
 867                 if d[:-5]+'_details' in msgs:
 868                     s['Service'].append(Service(d, d[:-5]+'_details',
 869                                                 stream=True))
 870                 else:
 871                     raise ValueError('{} missing details message'
 872                                      .format(d))
 873                 continue
 874
 875             if d.endswith('_details'):
 876                 if d[:-8]+'_dump' not in msgs:
 877                     raise ValueError('{} missing dump message'
 878                                      .format(d))
 879                 continue
 880
 881             if d in svcs:
 882                 continue
 883             if d+'_reply' in msgs:
 884                 s['Service'].append(Service(d, d+'_reply'))
 885             else:
 886                 raise ValueError(
 887                     '{} missing reply message ({}) or service definition'
 888                     .format(d, d+'_reply'))
 889
 890         return s
 891
 892     def process_imports(self, objs, in_import, result):
 893         imported_objs = []
 894         for o in objs:
 895             # Only allow the following object types from imported file
 896             if in_import and not (isinstance(o, Enum) or
 897                                   isinstance(o, Union) or
 898                                   isinstance(o, Typedef) or
 899                                   isinstance(o, Import) or
 900                                   isinstance(o, Using)):
 901                 continue
 902             if isinstance(o, Import):
 903                 result.append(o)
 904                 result = self.process_imports(o.result, True, result)
 905             else:
 906                 result.append(o)
 907         return result
 908
 909
 910 # Add message ids to each message.
 911 def add_msg_id(s):
 912     for o in s:
 913         o.block.insert(0, Field('u16', '_vl_msg_id'))
 914     return s
 915
 916
 917 dirlist = []
 918
 919
 920 def dirlist_add(dirs):
 921     global dirlist
 922     if dirs:
 923         dirlist = dirlist + dirs
 924
 925
 926 def dirlist_get():
 927     return dirlist
 928
 929
 930 def foldup_blocks(block, crc):
 931     for b in block:
 932         # Look up CRC in user defined types
 933         if b.fieldtype.startswith('vl_api_'):
 934             # Recursively
 935             t = global_types[b.fieldtype]
 936             try:
 937                 crc = crc_block_combine(t.block, crc)
 938                 crc = foldup_blocks(t.block, crc)
 939             except AttributeError:
 940                 pass
 941     return crc
 942
 943
 944 # keep the CRCs of the existing types of messages compatible with the
 945 # old "erroneous" way of calculating the CRC. For that - make a pointed
 946 # adjustment of the CRC function.
 947 # This is the purpose of the first element of the per-message dictionary.
 948 # The second element is there to avoid weakening the duplicate-detecting
 949 # properties of crc32. This way, if the new way of calculating the CRC
 950 # happens to collide with the old (buggy) way - we will still get
 951 # a different result and fail the comparison.
 952
 953 fixup_crc_dict = {
 954         "abf_policy_add_del": { 0xc6131197: 0xee66f93e },
 955         "abf_policy_details": { 0xb7487fa4: 0x6769e504 },
 956         "acl_add_replace": { 0xee5c2f18: 0x1cabdeab },
 957         "acl_details": { 0x95babae0: 0x7a97f21c },
 958         "macip_acl_add": { 0xce6fbad0: 0xd648fd0a },
 959         "macip_acl_add_replace": { 0x2a461dd4: 0xe34402a7 },
 960         "macip_acl_details": { 0x27135b59: 0x57c7482f },
 961         "dhcp_proxy_config": { 0x4058a689: 0x6767230e },
 962         "dhcp_client_config": { 0x1af013ea: 0x959b80a3 },
 963         "dhcp_compl_event": { 0x554a44e5: 0xe908fd1d },
 964         "dhcp_client_details": { 0x3c5cd28a: 0xacd82f5a },
 965         "dhcp_proxy_details": { 0xdcbaf540: 0xce16f044 },
 966         "dhcp6_send_client_message": { 0xf8222476: 0xf6f14ef0 },
 967         "dhcp6_pd_send_client_message": { 0x3739fd8d: 0x64badb8 },
 968         "dhcp6_reply_event": { 0x85b7b17e: 0x9f3af9e5 },
 969         "dhcp6_pd_reply_event": { 0x5e878029: 0xcb3e462b },
 970         "ip6_add_del_address_using_prefix": { 0x3982f30a: 0x9b3d11e0 },
 971         "gbp_bridge_domain_add": { 0x918e8c01: 0x8454bfdf },
 972         "gbp_bridge_domain_details": { 0x51d51be9: 0x2acd15f9 },
 973         "gbp_route_domain_add": { 0x204c79e1: 0x2d0afe38 },
 974         "gbp_route_domain_details": { 0xa78bfbca: 0x8ab11375 },
 975         "gbp_endpoint_add": { 0x7b3af7de: 0x9ce16d5a },
 976         "gbp_endpoint_details": { 0x8dd8fbd3: 0x8aecb60 },
 977         "gbp_endpoint_group_add": { 0x301ddf15: 0x8e0f4054 },
 978         "gbp_endpoint_group_details": { 0xab71d723: 0x8f38292c },
 979         "gbp_subnet_add_del": { 0xa8803c80: 0x888aca35 },
 980         "gbp_subnet_details": { 0xcbc5ca18: 0x4ed84156 },
 981         "gbp_contract_add_del": { 0xaa8d652d: 0x553e275b },
 982         "gbp_contract_details": { 0x65dec325: 0x2a18db6e },
 983         "gbp_ext_itf_add_del": { 0x7606d0e1: 0x12ed5700 },
 984         "gbp_ext_itf_details": { 0x519c3d3c: 0x408a45c0 },
 985         "gtpu_add_del_tunnel": { 0xca983a2b: 0x9a9c0426 },
 986         "gtpu_tunnel_update_tteid": { 0x79f33816: 0x8a2db108 },
 987         "gtpu_tunnel_details": { 0x27f434ae: 0x4535cf95 },
 988         "igmp_listen": { 0x19a49f1e: 0x3f93a51a },
 989         "igmp_details": { 0x38f09929: 0x52f12a89 },
 990         "igmp_event": { 0x85fe93ec: 0xd7696eaf },
 991         "igmp_group_prefix_set": { 0x5b14a5ce: 0xd4f20ac5 },
 992         "igmp_group_prefix_details": { 0x259ccd81: 0xc3b3c526 },
 993         "ikev2_set_responder": { 0xb9aa4d4e: 0xf0d3dc80 },
 994         "vxlan_gpe_ioam_export_enable_disable": { 0xd4c76d3a: 0xe4d4ebfa },
 995         "ioam_export_ip6_enable_disable": { 0xd4c76d3a: 0xe4d4ebfa },
 996         "vxlan_gpe_ioam_vni_enable": { 0xfbb5fb1: 0x997161fb },
 997         "vxlan_gpe_ioam_vni_disable": { 0xfbb5fb1: 0x997161fb },
 998         "vxlan_gpe_ioam_transit_enable": { 0x3d3ec657: 0x553f5b7b },
 999         "vxlan_gpe_ioam_transit_disable": { 0x3d3ec657: 0x553f5b7b },
1000         "udp_ping_add_del": { 0xfa2628fc: 0xc692b188 },
1001         "l3xc_update": { 0xe96aabdf: 0x787b1d3 },
1002         "l3xc_details": { 0xbc5bf852: 0xd4f69627 },
1003         "sw_interface_lacp_details": { 0xd9a83d2f: 0x745ae0ba },
1004         "lb_conf": { 0x56cd3261: 0x22ddb739 },
1005         "lb_add_del_vip": { 0x6fa569c7: 0xd15b7ddc },
1006         "lb_add_del_as": { 0x35d72500: 0x78628987 },
1007         "lb_vip_dump": { 0x56110cb7: 0xc7bcb124 },
1008         "lb_vip_details": { 0x1329ec9b: 0x8f39bed },
1009         "lb_as_details": { 0x8d24c29e: 0x9c39f60e },
1010         "mactime_add_del_range": { 0xcb56e877: 0x101858ef },
1011         "mactime_details": { 0xda25b13a: 0x44921c06 },
1012         "map_add_domain": { 0x249f195c: 0x7a5a18c9 },
1013         "map_domain_details": { 0x796edb50: 0xfc1859dd },
1014         "map_param_add_del_pre_resolve": { 0xdae5af03: 0x17008c66 },
1015         "map_param_get_reply": { 0x26272c90: 0x28092156 },
1016         "memif_details": { 0xda34feb9: 0xd0382c4c },
1017         "dslite_add_del_pool_addr_range": { 0xde2a5b02: 0xc448457a },
1018         "dslite_set_aftr_addr": { 0x78b50fdf: 0x1e955f8d },
1019         "dslite_get_aftr_addr_reply": { 0x8e23608e: 0x38e30db1 },
1020         "dslite_set_b4_addr": { 0x78b50fdf: 0x1e955f8d },
1021         "dslite_get_b4_addr_reply": { 0x8e23608e: 0x38e30db1 },
1022         "nat44_add_del_address_range": { 0x6f2b8055: 0xd4c7568c },
1023         "nat44_address_details": { 0xd1beac1: 0x45410ac4 },
1024         "nat44_add_del_static_mapping": { 0x5ae5f03e: 0xe165e83b },
1025         "nat44_static_mapping_details": { 0x6cb40b2: 0x1a433ef7 },
1026         "nat44_add_del_identity_mapping": { 0x2faaa22: 0x8e12743f },
1027         "nat44_identity_mapping_details": { 0x2a52a030: 0x36d21351 },
1028         "nat44_add_del_interface_addr": { 0x4aed50c0: 0xfc835325 },
1029         "nat44_interface_addr_details": { 0xe4aca9ca: 0x3e687514 },
1030         "nat44_user_session_details": { 0x2cf6e16d: 0x1965fd69 },
1031         "nat44_add_del_lb_static_mapping": { 0x4f68ee9d: 0x53b24611 },
1032         "nat44_lb_static_mapping_add_del_local": { 0x7ca47547: 0x2910a151 },
1033         "nat44_lb_static_mapping_details": { 0xed5ce876: 0x2267b9e8 },
1034         "nat44_del_session": { 0x15a5bf8c: 0x4c49c387 },
1035         "nat_det_add_del_map": { 0x1150a190: 0x112fde05 },
1036         "nat_det_map_details": { 0xad91dc83: 0x88000ee1 },
1037         "nat_det_close_session_out": { 0xf6b259d1: 0xc1b6cbfb },
1038         "nat_det_close_session_in": { 0x3c68e073: 0xa10ef64 },
1039         "nat64_add_del_pool_addr_range": { 0xa3b944e3: 0x21234ef3 },
1040         "nat64_add_del_static_bib": { 0x1c404de5: 0x90fae58a },
1041         "nat64_bib_details": { 0x43bc3ddf: 0x62c8541d },
1042         "nat64_st_details": { 0xdd3361ed: 0xc770d620 },
1043         "nat66_add_del_static_mapping": { 0x3ed88f71: 0xfb64e50b },
1044         "nat66_static_mapping_details": { 0xdf39654b: 0x5c568448 },
1045         "nsh_add_del_map": { 0xa0f42b0: 0x898d857d },
1046         "nsh_map_details": { 0x2fefcf49: 0xb34ac8a1 },
1047         "nsim_cross_connect_enable_disable": { 0x9c3ead86: 0x16f70bdf },
1048         "pppoe_add_del_session": { 0xf6fd759e: 0x46ace853 },
1049         "pppoe_session_details": { 0x4b8e8a4a: 0x332bc742 },
1050         "stn_add_del_rule": { 0x224c6edd: 0x53f751e6 },
1051         "stn_rules_details": { 0xa51935a6: 0xb0f6606c },
1052         "svs_route_add_del": { 0xe49bc63c: 0xd39e31fc },
1053         "svs_details": { 0x6282cd55: 0xb8523d64 },
1054         "vmxnet3_details": { 0x6a1a5498: 0x829ba055 },
1055         "vrrp_vr_add_del": { 0xc5cf15aa: 0x6dc4b881 },
1056         "vrrp_vr_details": { 0x46edcebd: 0x412fa71 },
1057         "vrrp_vr_set_peers": { 0x20bec71f: 0xbaa2e52b },
1058         "vrrp_vr_peer_details": { 0x3d99c108: 0xabd9145e },
1059         "vrrp_vr_track_if_add_del": { 0xd67df299: 0x337f4ba4 },
1060         "vrrp_vr_track_if_details": { 0x73c36f81: 0x99bcca9c },
1061         "proxy_arp_add_del": { 0x1823c3e7: 0x85486cbd },
1062         "proxy_arp_details": { 0x5b948673: 0x9228c150 },
1063         "bfd_udp_get_echo_source_reply": { 0xe3d736a1: 0x1e00cfce },
1064         "bfd_udp_add": { 0x939cd26a: 0x7a6d1185 },
1065         "bfd_udp_mod": { 0x913df085: 0x783a3ff6 },
1066         "bfd_udp_del": { 0xdcb13a89: 0x8096514d },
1067         "bfd_udp_session_details": { 0x9fb2f2d: 0x60653c02 },
1068         "bfd_udp_session_set_flags": { 0x4b4bdfd: 0xcf313851 },
1069         "bfd_udp_auth_activate": { 0x21fd1bdb: 0x493ee0ec },
1070         "bfd_udp_auth_deactivate": { 0x9a05e2e0: 0x99978c32 },
1071         "bier_route_add_del": { 0xfd02f3ea: 0xf29edca0 },
1072         "bier_route_details": { 0x4008caee: 0x39ee6a56 },
1073         "bier_disp_entry_add_del": { 0x9eb80cb4: 0x648323eb },
1074         "bier_disp_entry_details": { 0x84c218f1: 0xe5b039a9 },
1075         "bond_create": { 0xf1dbd4ff: 0x48883c7e },
1076         "bond_enslave": { 0xe7d14948: 0x76ecfa7 },
1077         "sw_interface_bond_details": { 0xbb7c929b: 0xf5ef2106 },
1078         "pipe_create_reply": { 0xb7ce310c: 0xd4c2c2b3 },
1079         "pipe_details": { 0xc52b799d: 0x43ac107a },
1080         "tap_create_v2": { 0x2d0d6570: 0x445835fd },
1081         "sw_interface_tap_v2_details": { 0x1e2b2a47: 0xe53c16de },
1082         "sw_interface_vhost_user_details": { 0xcee1e53: 0x98530df1 },
1083         "virtio_pci_create": { 0x1944f8db: 0xa9f1370c },
1084         "sw_interface_virtio_pci_details": { 0x6ca9c167: 0x16187f3a },
1085         "p2p_ethernet_add": { 0x36a1a6dc: 0xeeb8e717 },
1086         "p2p_ethernet_del": { 0x62f81c8c: 0xb62c386 },
1087         "geneve_add_del_tunnel": { 0x99445831: 0x976693b5 },
1088         "geneve_tunnel_details": { 0x6b16eb24: 0xe27e2748 },
1089         "gre_tunnel_add_del": { 0xa27d7f17: 0x6efc9c22 },
1090         "gre_tunnel_details": { 0x24435433: 0x3bfbf1 },
1091         "sw_interface_set_flags": { 0xf5aec1b8: 0x6a2b491a },
1092         "sw_interface_event": { 0x2d3d95a7: 0xf709f78d },
1093         "sw_interface_details": { 0x6c221fc7: 0x17b69fa2 },
1094         "sw_interface_add_del_address": { 0x5463d73b: 0x5803d5c4 },
1095         "sw_interface_set_unnumbered": { 0x154a6439: 0x938ef33b },
1096         "sw_interface_set_mac_address": { 0xc536e7eb: 0x6aca746a },
1097         "sw_interface_set_rx_mode": { 0xb04d1cfe: 0x780f5cee },
1098         "sw_interface_rx_placement_details": { 0x9e44a7ce: 0xf6d7d024 },
1099         "create_subif": { 0x790ca755: 0xcb371063 },
1100         "ip_neighbor_add_del": { 0x607c257: 0x105518b6 },
1101         "ip_neighbor_dump": { 0xd817a484: 0xcd831298 },
1102         "ip_neighbor_details": { 0xe29d79f0: 0x870e80b9 },
1103         "want_ip_neighbor_events": { 0x73e70a86: 0x1a312870 },
1104         "ip_neighbor_event": { 0xbdb092b2: 0x83933131 },
1105         "ip_route_add_del": { 0xb8ecfe0d: 0xc1ff832d },
1106         "ip_route_details": { 0xbda8f315: 0xd1ffaae1 },
1107         "ip_route_lookup": { 0x710d6471: 0xe2986185 },
1108         "ip_route_lookup_reply": { 0x5d8febcb: 0xae99de8e },
1109         "ip_mroute_add_del": { 0x85d762f3: 0xf6627d17 },
1110         "ip_mroute_details": { 0x99341a45: 0xc1cb4b44 },
1111         "ip_address_details": { 0xee29b797: 0xb1199745 },
1112         "ip_unnumbered_details": { 0xcc59bd42: 0xaa12a483 },
1113         "mfib_signal_details": { 0x6f4a4cfb: 0x64398a9a },
1114         "ip_punt_redirect": { 0x6580f635: 0xa9a5592c },
1115         "ip_punt_redirect_details": { 0x2cef63e7: 0x3924f5d3 },
1116         "ip_container_proxy_add_del": { 0x7df1dff1: 0x91189f40 },
1117         "ip_container_proxy_details": { 0xa8085523: 0xee460e8 },
1118         "ip_source_and_port_range_check_add_del": { 0x92a067e3: 0x8bfc76f2 },
1119         "sw_interface_ip6_set_link_local_address": { 0x1c10f15f: 0x2931d9fa },
1120         "ip_reassembly_enable_disable": { 0xeb77968d: 0x885c85a6 },
1121         "set_punt": { 0xaa83d523: 0x83799618 },
1122         "punt_socket_register": { 0x95268cbf: 0xc8cd10fa },
1123         "punt_socket_details": { 0xde575080: 0x1de0ce75 },
1124         "punt_socket_deregister": { 0x98fc9102: 0x98a444f4 },
1125         "sw_interface_ip6nd_ra_prefix": { 0x82cc1b28: 0xe098785f },
1126         "ip6nd_proxy_add_del": { 0xc2e4a686: 0x3fdf6659 },
1127         "ip6nd_proxy_details": { 0x30b9ff4a: 0xd35be8ff },
1128         "ip6_ra_event": { 0x364c1c5: 0x47e8cfbe },
1129         "set_ipfix_exporter": { 0x5530c8a0: 0x69284e07 },
1130         "ipfix_exporter_details": { 0xdedbfe4: 0x11e07413 },
1131         "ipip_add_tunnel": { 0x2ac399f5: 0xa9decfcd },
1132         "ipip_6rd_add_tunnel": { 0xb9ec1863: 0x56e93cc0 },
1133         "ipip_tunnel_details": { 0xd31cb34e: 0x53236d75 },
1134         "ipsec_spd_entry_add_del": { 0x338b7411: 0x9f384b8d },
1135         "ipsec_spd_details": { 0x5813d7a2: 0xf2222790 },
1136         "ipsec_sad_entry_add_del": { 0xab64b5c6: 0xb8def364 },
1137         "ipsec_tunnel_protect_update": { 0x30d5f133: 0x143f155d },
1138         "ipsec_tunnel_protect_del": { 0xcd239930: 0xddd2ba36 },
1139         "ipsec_tunnel_protect_details": { 0x21663a50: 0xac6c823b },
1140         "ipsec_tunnel_if_add_del": { 0x20e353fa: 0x2b135e68 },
1141         "ipsec_sa_details": { 0x345d14a7: 0xb30c7f41 },
1142         "l2_xconnect_details": { 0x472b6b67: 0xc8aa6b37 },
1143         "l2_fib_table_details": { 0xa44ef6b8: 0xe8d2fc72 },
1144         "l2fib_add_del": { 0xeddda487: 0xf29d796c },
1145         "l2_macs_event": { 0x44b8fd64: 0x2eadfc8b },
1146         "bridge_domain_details": { 0xfa506fd: 0x979f549d },
1147         "l2_interface_pbb_tag_rewrite": { 0x38e802a8: 0x612efa5a },
1148         "l2_patch_add_del": { 0xa1f6a6f3: 0x522f3445 },
1149         "sw_interface_set_l2_xconnect": { 0x4fa28a85: 0x1aaa2dbb },
1150         "sw_interface_set_l2_bridge": { 0xd0678b13: 0x2e483cd0 },
1151         "bd_ip_mac_add_del": { 0x257c869: 0x5f2b84e2 },
1152         "bd_ip_mac_details": { 0x545af86a: 0xa52f8044 },
1153         "l2_arp_term_event": { 0x6963e07a: 0x85ff71ea },
1154         "l2tpv3_create_tunnel": { 0x15bed0c2: 0x596892cb },
1155         "sw_if_l2tpv3_tunnel_details": { 0x50b88993: 0x1dab5c7e },
1156         "lisp_add_del_local_eid": { 0x4e5a83a2: 0x21f573bd },
1157         "lisp_add_del_map_server": { 0xce19e32d: 0x6598ea7c },
1158         "lisp_add_del_map_resolver": { 0xce19e32d: 0x6598ea7c },
1159         "lisp_use_petr": { 0xd87dbad9: 0x9e141831 },
1160         "show_lisp_use_petr_reply": { 0x22b9a4b0: 0xdcad8a81 },
1161         "lisp_add_del_remote_mapping": { 0x6d5c789e: 0xfae8ed77 },
1162         "lisp_add_del_adjacency": { 0x2ce0e6f6: 0xcf5edb61 },
1163         "lisp_locator_details": { 0x2c620ffe: 0xc0c4c2a7 },
1164         "lisp_eid_table_details": { 0x1c29f792: 0x4bc32e3a },
1165         "lisp_eid_table_dump": { 0x629468b5: 0xb959b73b },
1166         "lisp_adjacencies_get_reply": { 0x807257bf: 0x3f97bcdd },
1167         "lisp_map_resolver_details": { 0x3e78fc57: 0x82a09deb },
1168         "lisp_map_server_details": { 0x3e78fc57: 0x82a09deb },
1169         "one_add_del_local_eid": { 0x4e5a83a2: 0x21f573bd },
1170         "one_add_del_map_server": { 0xce19e32d: 0x6598ea7c },
1171         "one_add_del_map_resolver": { 0xce19e32d: 0x6598ea7c },
1172         "one_use_petr": { 0xd87dbad9: 0x9e141831 },
1173         "show_one_use_petr_reply": { 0x84a03528: 0x10e744a6 },
1174         "one_add_del_remote_mapping": { 0x6d5c789e: 0xfae8ed77 },
1175         "one_add_del_l2_arp_entry": { 0x1aa5e8b3: 0x33209078 },
1176         "one_l2_arp_entries_get_reply": { 0xb0dd200f: 0xb0a47bbe },
1177         "one_add_del_ndp_entry": { 0xf8a287c: 0xd1629a2f },
1178         "one_ndp_entries_get_reply": { 0x70719b1a: 0xbd34161 },
1179         "one_add_del_adjacency": { 0x9e830312: 0xe48e7afe },
1180         "one_locator_details": { 0x2c620ffe: 0xc0c4c2a7 },
1181         "one_eid_table_details": { 0x1c29f792: 0x4bc32e3a },
1182         "one_eid_table_dump": { 0xbd190269: 0x95151038 },
1183         "one_adjacencies_get_reply": { 0x85bab89: 0xa8ed89a5 },
1184         "one_map_resolver_details": { 0x3e78fc57: 0x82a09deb },
1185         "one_map_server_details": { 0x3e78fc57: 0x82a09deb },
1186         "one_stats_details": { 0x2eb74678: 0xff6ef238 },
1187         "gpe_add_del_fwd_entry": { 0xf0847644: 0xde6df50f },
1188         "gpe_fwd_entries_get_reply": { 0xc4844876: 0xf9f53f1b },
1189         "gpe_fwd_entry_path_details": { 0x483df51a: 0xee80b19a },
1190         "gpe_add_del_native_fwd_rpath": { 0x43fc8b54: 0x812da2f2 },
1191         "gpe_native_fwd_rpaths_get_reply": { 0x7a1ca5a2: 0x79d54eb9 },
1192         "sw_interface_set_lldp": { 0x57afbcd4: 0xd646ae0f },
1193         "mpls_ip_bind_unbind": { 0xc7533b32: 0x48249a27 },
1194         "mpls_tunnel_add_del": { 0x44350ac1: 0xe57ce61d },
1195         "mpls_tunnel_details": { 0x57118ae3: 0xf3c0928e },
1196         "mpls_route_add_del": { 0x8e1d1e07: 0x343cff54 },
1197         "mpls_route_details": { 0x9b5043dc: 0xd0ac384c },
1198         "policer_add_del": { 0x2b31dd38: 0xcb948f6e },
1199         "policer_details": { 0x72d0e248: 0xa43f781a },
1200         "qos_store_enable_disable": { 0xf3abcc8b: 0x3507235e },
1201         "qos_store_details": { 0x3ee0aad7: 0x38a6d48 },
1202         "qos_record_enable_disable": { 0x2f1a4a38: 0x25b33f88 },
1203         "qos_record_details": { 0xa425d4d3: 0x4956ccdd },
1204         "session_rule_add_del": { 0xe4895422: 0xe31f9443 },
1205         "session_rules_details": { 0x28d71830: 0x304b91f0 },
1206         "sw_interface_span_enable_disable": { 0x23ddd96b: 0xacc8fea1 },
1207         "sw_interface_span_details": { 0x8a20e79f: 0x55643fc },
1208         "sr_mpls_steering_add_del": { 0x64acff63: 0x7d1b0a0b },
1209         "sr_mpls_policy_assign_endpoint_color": { 0xe7eb978: 0x5e1c5c13 },
1210         "sr_localsid_add_del": { 0x5a36c324: 0x26fa3309 },
1211         "sr_policy_add": { 0x44ac92e8: 0xec79ee6a },
1212         "sr_policy_mod": { 0xb97bb56e: 0xe531a102 },
1213         "sr_steering_add_del": { 0xe46b0a0f: 0x3711dace },
1214         "sr_localsids_details": { 0x2e9221b9: 0x6a6c0265 },
1215         "sr_policies_details": { 0xdb6ff2a1: 0x7ec2d93 },
1216         "sr_steering_pol_details": { 0xd41258c9: 0x1c1ee786 },
1217         "syslog_set_sender": { 0xb8011d0b: 0xbb641285 },
1218         "syslog_get_sender_reply": { 0x424cfa4e: 0xd3da60ac },
1219         "tcp_configure_src_addresses": { 0x67eede0d: 0x4b02b946 },
1220         "teib_entry_add_del": { 0x8016cfd2: 0x5aa0a538 },
1221         "teib_details": { 0x981ee1a1: 0xe3b6a503 },
1222         "udp_encap_add": { 0xf74a60b1: 0x61d5fc48 },
1223         "udp_encap_details": { 0x8cfb9c76: 0x87c82821 },
1224         "vxlan_gbp_tunnel_add_del": { 0x6c743427: 0x8c819166 },
1225         "vxlan_gbp_tunnel_details": { 0x66e94a89: 0x1da24016 },
1226         "vxlan_gpe_add_del_tunnel": { 0xa645b2b0: 0x7c6da6ae },
1227         "vxlan_gpe_tunnel_details": { 0x968fc8b: 0x57712346 },
1228         "vxlan_add_del_tunnel": { 0xc09dc80: 0xa35dc8f5 },
1229         "vxlan_tunnel_details": { 0xc3916cb1: 0xe782f70f },
1230         "vxlan_offload_rx": { 0x9cc95087: 0x89a1564b },
1231         "log_details": { 0x3d61cc0: 0x255827a1 },
1232 }
1233
1234
1235 def foldup_crcs(s):
1236     for f in s:
1237         f.crc = foldup_blocks(f.block,
1238                               binascii.crc32(f.crc) & 0xffffffff)
1239
1240         # fixup the CRCs to make the fix seamless
1241         if f.name in fixup_crc_dict:
1242             if f.crc in fixup_crc_dict.get(f.name):
1243                 f.crc = fixup_crc_dict.get(f.name).get(f.crc)
1244
1245 #
1246 # Main
1247 #
1248 def main():
1249     if sys.version_info < (3, 5,):
1250         log.exception('vppapigen requires a supported version of python. '
1251                       'Please use version 3.5 or greater. '
1252                       'Using {}'.format(sys.version))
1253         return 1
1254
1255     cliparser = argparse.ArgumentParser(description='VPP API generator')
1256     cliparser.add_argument('--pluginpath', default=""),
1257     cliparser.add_argument('--includedir', action='append'),
1258     cliparser.add_argument('--outputdir', action='store'),
1259     cliparser.add_argument('--input')
1260     cliparser.add_argument('--output', nargs='?',
1261                            type=argparse.FileType('w', encoding='UTF-8'),
1262                            default=sys.stdout)
1263
1264     cliparser.add_argument('output_module', nargs='?', default='C')
1265     cliparser.add_argument('--debug', action='store_true')
1266     cliparser.add_argument('--show-name', nargs=1)
1267     cliparser.add_argument('--git-revision',
1268                            help="Git revision to use for opening files")
1269     args = cliparser.parse_args()
1270
1271     dirlist_add(args.includedir)
1272     if not args.debug:
1273         sys.excepthook = exception_handler
1274
1275     # Filename
1276     if args.show_name:
1277         filename = args.show_name[0]
1278     elif args.input:
1279         filename = args.input
1280     else:
1281         filename = ''
1282
1283     if args.debug:
1284         logging.basicConfig(stream=sys.stdout, level=logging.WARNING)
1285     else:
1286         logging.basicConfig()
1287
1288     parser = VPPAPI(debug=args.debug, filename=filename, logger=log,
1289                     revision=args.git_revision)
1290
1291     try:
1292         if not args.input:
1293             parsed_objects = parser.parse_fd(sys.stdin, log)
1294         else:
1295             parsed_objects = parser.parse_filename(args.input, log)
1296     except ParseError as e:
1297         print('Parse error: ', e, file=sys.stderr)
1298         sys.exit(1)
1299
1300     # Build a list of objects. Hash of lists.
1301     result = []
1302
1303     if args.output_module == 'C':
1304         s = parser.process(parsed_objects)
1305     else:
1306         result = parser.process_imports(parsed_objects, False, result)
1307         s = parser.process(result)
1308
1309     # Add msg_id field
1310     s['Define'] = add_msg_id(s['Define'])
1311
1312     # Fold up CRCs
1313     foldup_crcs(s['Define'])
1314
1315     #
1316     # Debug
1317     if args.debug:
1318         import pprint
1319         pp = pprint.PrettyPrinter(indent=4, stream=sys.stderr)
1320         for t in s['Define']:
1321             pp.pprint([t.name, t.flags, t.block])
1322         for t in s['types']:
1323             pp.pprint([t.name, t.block])
1324
1325     #
1326     # Generate representation
1327     #
1328     from importlib.machinery import SourceFileLoader
1329
1330     # Default path
1331     pluginpath = ''
1332     if not args.pluginpath:
1333         cand = []
1334         cand.append(os.path.dirname(os.path.realpath(__file__)))
1335         cand.append(os.path.dirname(os.path.realpath(__file__)) +
1336                     '/../share/vpp/')
1337         for c in cand:
1338             c += '/'
1339             if os.path.isfile('{}vppapigen_{}.py'
1340                               .format(c, args.output_module.lower())):
1341                 pluginpath = c
1342                 break
1343     else:
1344         pluginpath = args.pluginpath + '/'
1345     if pluginpath == '':
1346         log.exception('Output plugin not found')
1347         return 1
1348     module_path = '{}vppapigen_{}.py'.format(pluginpath,
1349                                              args.output_module.lower())
1350
1351     try:
1352         plugin = SourceFileLoader(args.output_module,
1353                                   module_path).load_module()
1354     except Exception as err:
1355         log.exception('Error importing output plugin: {}, {}'
1356                       .format(module_path, err))
1357         return 1
1358
1359     result = plugin.run(args, filename, s)
1360     if result:
1361         print(result, file=args.output)
1362     else:
1363         log.exception('Running plugin failed: {} {}'
1364                       .format(filename, result))
1365         return 1
1366     return 0
1367
1368
1369 if __name__ == '__main__':
1370     sys.exit(main())