src/tools/vppapigen/vppapigen.py

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