4 import ply.yacc as yacc
12 from subprocess import Popen, PIPE
14 assert sys.version_info >= (3, 5), \
15 "Not supported Python version: {}".format(sys.version)
16 log = logging.getLogger('vppapigen')
18 # Ensure we don't leave temporary files around
19 sys.dont_write_bytecode = True
25 # Global dictionary of new types (including enums)
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(
37 global_types[type_name] = obj
40 # All your trace are belong to us!
41 def exception_handler(exception_type, exception, traceback):
42 print("%s: %s" % (exception_type.__name__, exception))
48 class VPPAPILexer(object):
49 def __init__(self, filename):
50 self.filename = filename
62 'typeonly': 'TYPEONLY',
63 'manual_print': 'MANUAL_PRINT',
64 'manual_endian': 'MANUAL_ENDIAN',
65 'dont_trace': 'DONT_TRACE',
66 'autoreply': 'AUTOREPLY',
85 tokens = ['STRING_LITERAL',
86 'ID', 'NUM'] + list(reserved.values())
88 t_ignore_LINE_COMMENT = '//.*'
101 r'0[xX][0-9a-fA-F]+|-?\d+\.?\d*'
102 base = 16 if t.value.startswith('0x') else 10
104 t.value = float(t.value)
106 t.value = int(t.value, base)
110 r'[a-zA-Z_][a-zA-Z_0-9]*'
111 # Check for reserved words
112 t.type = VPPAPILexer.reserved.get(t.value, 'ID')
116 def t_STRING_LITERAL(self, t):
117 r'\"([^\\\n]|(\\.))*?\"'
118 t.value = str(t.value).replace("\"", "")
121 # C or C++ comment (ignore)
122 def t_comment(self, t):
123 r'(/\*(.|\n)*?\*/)|(//.*)'
124 t.lexer.lineno += t.value.count('\n')
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])),
134 # Define a rule so we can track line numbers
135 def t_newline(self, t):
137 t.lexer.lineno += len(t.value)
139 literals = ":{}[];=.,"
141 # A string containing ignored characters (spaces and tabs)
145 def vla_is_last_check(name, block):
147 for i, b in enumerate(block):
148 if isinstance(b, Array) and b.vla:
150 if i + 1 < len(block):
152 'VLA field "{}" must be the last field in message "{}"'
153 .format(b.fieldname, name))
154 elif b.fieldtype.startswith('vl_api_'):
155 if global_types[b.fieldtype].vla:
157 if i + 1 < len(block):
159 'VLA field "{}" must be the last '
160 'field in message "{}"'
161 .format(b.fieldname, name))
162 elif b.fieldtype == 'string' and b.length == 0:
164 if i + 1 < len(block):
166 'VLA field "{}" must be the last '
167 'field in message "{}"'
168 .format(b.fieldname, name))
173 def __init__(self, caller, reply, events=None, stream_message=None, stream=False):
177 self.stream_message = stream_message
178 self.events = [] if events is None else events
182 def __init__(self, name, flags, block):
186 self.crc = str(block).encode()
187 self.manual_print = False
188 self.manual_endian = False
190 if f == 'manual_print':
191 self.manual_print = True
192 elif f == 'manual_endian':
193 self.manual_endian = True
195 global_type_add(name, self)
197 self.vla = vla_is_last_check(name, block)
200 return self.name + str(self.flags) + str(self.block)
204 def __init__(self, name, flags, alias):
208 self.manual_print = True
209 self.manual_endian = True
211 self.manual_print = False
212 self.manual_endian = False
214 if f == 'manual_print':
215 self.manual_print = True
216 elif f == 'manual_endian':
217 self.manual_endian = True
219 if isinstance(alias, Array):
220 a = {'type': alias.fieldtype,
221 'length': alias.length}
223 a = {'type': alias.fieldtype}
227 # self.crc = str(alias).encode()
228 # but to be backwards compatible use the block ([])
230 self.crc = str(self.block).encode()
231 global_type_add(name, self)
234 return self.name + str(self.alias)
238 def __init__(self, name, flags, block):
240 self.manual_print = False
241 self.manual_endian = False
245 if f == 'manual_print':
246 self.manual_print = True
247 elif f == 'manual_endian':
248 self.manual_endian = True
251 self.crc = str(block).encode()
252 self.vla = vla_is_last_check(name, block)
254 global_type_add(name, self)
257 return str(self.block)
261 def __init__(self, name, flags, block):
265 self.dont_trace = False
266 self.manual_print = False
267 self.manual_endian = False
268 self.autoreply = False
269 self.singular = False
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
283 if isinstance(b, Option):
284 if b[1] == 'singular' and b[2] == 'true':
287 self.options[b.option] = b.value
290 block = [x for x in block if x not in remove]
292 self.vla = vla_is_last_check(name, block)
293 self.crc = str(block).encode()
296 return self.name + str(self.flags) + str(self.block)
300 def __init__(self, name, block, enumtype='u32'):
302 self.enumtype = enumtype
315 block2.append([b['id'], count])
317 if b['option']['backwards_compatible']:
321 block3.append([b['id'], count])
323 raise ValueError("Backward compatible enum must be last {!r} {!r}"
324 .format(name, b['id']))
326 self.crc = str(block3).encode()
327 global_type_add(name, self)
330 return self.name + str(self.block)
335 def __new__(cls, *args, **kwargs):
336 if args[0] not in seen_imports:
337 instance = super().__new__(cls)
338 instance._initialized = False
339 seen_imports[args[0]] = instance
341 return seen_imports[args[0]]
343 def __init__(self, filename, revision):
344 if self._initialized:
347 self.filename = filename
349 parser = VPPAPI(filename=filename, revision=revision)
350 dirlist = dirlist_get()
353 f = os.path.join(dir, filename)
354 if os.path.exists(f):
356 self.result = parser.parse_filename(f, None)
357 self._initialized = True
364 def __init__(self, option, value=None):
368 self.crc = str(option).encode()
371 return str(self.option)
373 def __getitem__(self, index):
374 return self.option[index]
378 def __init__(self, fieldtype, name, length, modern_vla=False):
380 self.fieldtype = fieldtype
381 self.fieldname = name
382 self.modern_vla = modern_vla
383 if type(length) is str:
384 self.lengthfield = length
389 self.lengthfield = None
393 return str([self.fieldtype, self.fieldname, self.length,
398 def __init__(self, fieldtype, name, limit=None):
400 self.fieldtype = fieldtype
402 if self.fieldtype == 'string':
403 raise ValueError("The string type {!r} is an "
404 "array type ".format(name))
406 if name in keyword.kwlist:
407 raise ValueError("Fieldname {!r} is a python keyword and is not "
408 "accessible via the python API. ".format(name))
409 self.fieldname = name
413 return str([self.fieldtype, self.fieldname])
417 """ Coordinates of a syntactic element. Consists of:
420 - (optional) column number, for the Lexer
422 __slots__ = ('file', 'line', 'column', '__weakref__')
424 def __init__(self, file, line, column=None):
430 str = "%s:%s" % (self.file, self.line)
432 str += ":%s" % self.column
436 class ParseError(Exception):
443 class VPPAPIParser(object):
444 tokens = VPPAPILexer.tokens
446 def __init__(self, filename, logger, revision=None):
447 self.filename = filename
450 self.revision = revision
452 def _parse_error(self, msg, coord):
453 raise ParseError("%s: %s" % (coord, msg))
455 def _parse_warning(self, msg, coord):
457 self.logger.warning("%s: %s" % (coord, msg))
459 def _coord(self, lineno, column=None):
462 line=lineno, column=column)
464 def _token_coord(self, p, token_idx):
465 """ Returns the coordinates for the YaccProduction object 'p' indexed
466 with 'token_idx'. The coordinate includes the 'lineno' and
467 'column'. Both follow the lex semantic, starting from 1.
469 last_cr = p.lexer.lexdata.rfind('\n', 0, p.lexpos(token_idx))
472 column = (p.lexpos(token_idx) - (last_cr))
473 return self._coord(p.lineno(token_idx), column)
475 def p_slist(self, p):
493 def p_import(self, p):
494 '''import : IMPORT STRING_LITERAL ';' '''
495 p[0] = Import(p[2], revision=self.revision)
497 def p_service(self, p):
498 '''service : SERVICE '{' service_statements '}' ';' '''
501 def p_service_statements(self, p):
502 '''service_statements : service_statement
503 | service_statements service_statement'''
509 def p_service_statement(self, p):
510 '''service_statement : RPC ID RETURNS NULL ';'
511 | RPC ID RETURNS ID ';'
512 | RPC ID RETURNS STREAM ID ';'
513 | RPC ID RETURNS ID EVENTS event_list ';' '''
515 # Verify that caller and reply differ
517 'Reply ID ({}) should not be equal to Caller ID'.format(p[2]),
518 self._token_coord(p, 1))
520 p[0] = Service(p[2], p[4], p[6])
522 p[0] = Service(p[2], p[5], stream=True)
524 p[0] = Service(p[2], p[4])
526 def p_service_statement2(self, p):
527 '''service_statement : RPC ID RETURNS ID STREAM ID ';' '''
528 p[0] = Service(p[2], p[4], stream_message=p[6], stream=True)
530 def p_event_list(self, p):
531 '''event_list : events
532 | event_list events '''
538 def p_event(self, p):
544 '''enum : ENUM ID '{' enum_statements '}' ';' '''
545 p[0] = Enum(p[2], p[4])
547 def p_enum_type(self, p):
548 ''' enum : ENUM ID ':' enum_size '{' enum_statements '}' ';' '''
550 p[0] = Enum(p[2], p[6], enumtype=p[4])
552 p[0] = Enum(p[2], p[4])
554 def p_enum_size(self, p):
560 def p_define(self, p):
561 '''define : DEFINE ID '{' block_statements_opt '}' ';' '''
563 p[0] = Define(p[2], [], p[4])
565 def p_define_flist(self, p):
566 '''define : flist DEFINE ID '{' block_statements_opt '}' ';' '''
568 if 'typeonly' in p[1]:
569 self._parse_error('legacy typedef. use typedef: {} {}[{}];'
570 .format(p[1], p[2], p[4]),
571 self._token_coord(p, 1))
573 p[0] = Define(p[3], p[1], p[5])
575 def p_flist(self, p):
584 '''flag : MANUAL_PRINT
593 def p_typedef(self, p):
594 '''typedef : TYPEDEF ID '{' block_statements_opt '}' ';' '''
595 p[0] = Typedef(p[2], [], p[4])
597 def p_typedef_flist(self, p):
598 '''typedef : flist TYPEDEF ID '{' block_statements_opt '}' ';' '''
599 p[0] = Typedef(p[3], p[1], p[5])
601 def p_typedef_alias(self, p):
602 '''typedef : TYPEDEF declaration '''
603 p[0] = Using(p[2].fieldname, [], p[2])
605 def p_typedef_alias_flist(self, p):
606 '''typedef : flist TYPEDEF declaration '''
607 p[0] = Using(p[3].fieldname, p[1], p[3])
609 def p_block_statements_opt(self, p):
610 '''block_statements_opt : block_statements '''
613 def p_block_statements(self, p):
614 '''block_statements : block_statement
615 | block_statements block_statement'''
621 def p_block_statement(self, p):
622 '''block_statement : declaration
626 def p_enum_statements(self, p):
627 '''enum_statements : enum_statement
628 | enum_statements enum_statement'''
634 def p_enum_statement(self, p):
635 '''enum_statement : ID '=' NUM ','
637 | ID '[' field_options ']' ','
638 | ID '=' NUM '[' field_options ']' ',' '''
642 p[0] = {'id': p[1], 'value': p[3]}
644 p[0] = {'id': p[1], 'option': p[3]}
646 p[0] = {'id': p[1], 'value': p[3], 'option': p[5]}
648 self._parse_error('ERROR', self._token_coord(p, 1))
650 def p_field_options(self, p):
651 '''field_options : field_option
652 | field_options field_option'''
656 p[0] = {**p[1], **p[2]}
658 def p_field_option(self, p):
660 | ID '=' assignee ','
669 def p_declaration(self, p):
670 '''declaration : type_specifier ID ';'
671 | type_specifier ID '[' field_options ']' ';' '''
673 p[0] = Field(p[1], p[2], p[4])
675 p[0] = Field(p[1], p[2])
677 self._parse_error('ERROR', self._token_coord(p, 1))
678 self.fields.append(p[2])
680 def p_declaration_array_vla(self, p):
681 '''declaration : type_specifier ID '[' ']' ';' '''
682 p[0] = Array(p[1], p[2], 0, modern_vla=True)
684 def p_declaration_array(self, p):
685 '''declaration : type_specifier ID '[' NUM ']' ';'
686 | type_specifier ID '[' ID ']' ';' '''
689 return self._parse_error(
690 'array: %s' % p.value,
691 self._coord(lineno=p.lineno))
693 # Make this error later
694 if type(p[4]) is int and p[4] == 0:
695 # XXX: Line number is wrong
696 self._parse_warning('Old Style VLA: {} {}[{}];'
697 .format(p[1], p[2], p[4]),
698 self._token_coord(p, 1))
700 if type(p[4]) is str and p[4] not in self.fields:
701 # Verify that length field exists
702 self._parse_error('Missing length field: {} {}[{}];'
703 .format(p[1], p[2], p[4]),
704 self._token_coord(p, 1))
705 p[0] = Array(p[1], p[2], p[4])
707 def p_option(self, p):
708 '''option : OPTION ID '=' assignee ';'
713 p[0] = Option(p[2], p[4])
715 def p_assignee(self, p):
722 def p_type_specifier(self, p):
723 '''type_specifier : U8
736 # Do a second pass later to verify that user defined types are defined
737 def p_typedef_specifier(self, p):
738 '''type_specifier : ID '''
739 if p[1] not in global_types:
740 self._parse_error('Undefined type: {}'.format(p[1]),
741 self._token_coord(p, 1))
744 def p_union(self, p):
745 '''union : UNION ID '{' block_statements_opt '}' ';' '''
746 p[0] = Union(p[2], [], p[4])
748 def p_union_flist(self, p):
749 '''union : flist UNION ID '{' block_statements_opt '}' ';' '''
750 p[0] = Union(p[3], p[1], p[5])
752 # Error rule for syntax errors
753 def p_error(self, p):
756 'before: %s' % p.value,
757 self._coord(lineno=p.lineno))
759 self._parse_error('At end of input', self.filename)
762 class VPPAPI(object):
764 def __init__(self, debug=False, filename='', logger=None, revision=None):
765 self.lexer = lex.lex(module=VPPAPILexer(filename), debug=debug)
766 self.parser = yacc.yacc(module=VPPAPIParser(filename, logger,
768 write_tables=False, debug=debug)
770 self.revision = revision
771 self.filename = filename
773 def parse_string(self, code, debug=0, lineno=1):
774 self.lexer.lineno = lineno
775 return self.parser.parse(code, lexer=self.lexer, debug=debug)
777 def parse_fd(self, fd, debug=0):
779 return self.parse_string(data, debug=debug)
781 def parse_filename(self, filename, debug=0):
783 git_show = 'git show {}:{}'.format(self.revision, filename)
784 proc = Popen(git_show.split(), stdout=PIPE, encoding='utf-8')
786 data, errs = proc.communicate()
787 if proc.returncode != 0:
788 print('File not found: {}:{}'.format(self.revision,
789 filename), file=sys.stderr)
791 return self.parse_string(data, debug=debug)
792 except Exception as e:
796 with open(filename, encoding='utf-8') as fd:
797 return self.parse_fd(fd, None)
798 except FileNotFoundError:
799 print('File not found: {}'.format(filename), file=sys.stderr)
802 def autoreply_block(self, name, parent):
803 block = [Field('u32', 'context'),
804 Field('i32', 'retval')]
805 # inherhit the parent's options
806 for k, v in parent.options.items():
807 block.append(Option(k, v))
808 return Define(name + '_reply', [], block)
810 def process(self, objs):
819 tname = o.__class__.__name__
821 crc = binascii.crc32(o.crc, crc) & 0xffffffff
822 except AttributeError:
824 if isinstance(o, Define):
827 s[tname].append(self.autoreply_block(o.name, o))
828 elif isinstance(o, Option):
829 s[tname][o.option] = o.value
830 elif type(o) is list:
832 if isinstance(o2, Service):
833 s['Service'].append(o2)
834 elif (isinstance(o, Enum) or
835 isinstance(o, Typedef) or
836 isinstance(o, Using) or
837 isinstance(o, Union)):
841 raise ValueError('Unknown class type: {} {}'
845 msgs = {d.name: d for d in s['Define']}
846 svcs = {s.caller: s for s in s['Service']}
847 replies = {s.reply: s for s in s['Service']}
853 if service not in msgs:
855 'Service definition refers to unknown message'
856 ' definition: {}'.format(service))
857 if svcs[service].reply != 'null' and \
858 svcs[service].reply not in msgs:
859 raise ValueError('Service definition refers to unknown message'
860 ' definition in reply: {}'
861 .format(svcs[service].reply))
862 if service in replies:
863 raise ValueError('Service definition refers to message'
864 ' marked as reply: {}'.format(service))
865 for event in svcs[service].events:
866 if event not in msgs:
867 raise ValueError('Service definition refers to unknown '
868 'event: {} in message: {}'
869 .format(event, service))
870 seen_services[event] = True
872 # Create services implicitly
874 if d in seen_services:
876 if msgs[d].singular is True:
878 if d.endswith('_reply'):
881 if d[:-6] not in msgs:
882 raise ValueError('{} missing calling message'
885 if d.endswith('_dump'):
888 if d[:-5]+'_details' in msgs:
889 s['Service'].append(Service(d, d[:-5]+'_details',
892 raise ValueError('{} missing details message'
896 if d.endswith('_details'):
897 if d[:-8]+'_dump' not in msgs:
898 raise ValueError('{} missing dump message'
904 if d+'_reply' in msgs:
905 s['Service'].append(Service(d, d+'_reply'))
908 '{} missing reply message ({}) or service definition'
909 .format(d, d+'_reply'))
913 def process_imports(self, objs, in_import, result):
916 # Only allow the following object types from imported file
917 if in_import and not (isinstance(o, Enum) or
918 isinstance(o, Union) or
919 isinstance(o, Typedef) or
920 isinstance(o, Import) or
921 isinstance(o, Using)):
923 if isinstance(o, Import):
925 result = self.process_imports(o.result, True, result)
931 # Add message ids to each message.
934 o.block.insert(0, Field('u16', '_vl_msg_id'))
941 def dirlist_add(dirs):
944 dirlist = dirlist + dirs
951 def foldup_blocks(block, crc):
953 # Look up CRC in user defined types
954 if b.fieldtype.startswith('vl_api_'):
956 t = global_types[b.fieldtype]
958 crc = binascii.crc32(t.crc, crc) & 0xffffffff
959 crc = foldup_blocks(t.block, crc)
960 except AttributeError:
965 # keep the CRCs of the existing types of messages compatible with the
966 # old "erroneous" way of calculating the CRC. For that - make a pointed
967 # adjustment of the CRC function.
968 # This is the purpose of the first element of the per-message dictionary.
969 # The second element is there to avoid weakening the duplicate-detecting
970 # properties of crc32. This way, if the new way of calculating the CRC
971 # happens to collide with the old (buggy) way - we will still get
972 # a different result and fail the comparison.
975 "abf_policy_add_del": { 0xc6131197: 0xee66f93e },
976 "abf_policy_details": { 0xb7487fa4: 0x6769e504 },
977 "acl_add_replace": { 0xee5c2f18: 0x1cabdeab },
978 "acl_details": { 0x95babae0: 0x7a97f21c },
979 "macip_acl_add": { 0xce6fbad0: 0xd648fd0a },
980 "macip_acl_add_replace": { 0x2a461dd4: 0xe34402a7 },
981 "macip_acl_details": { 0x27135b59: 0x57c7482f },
982 "dhcp_proxy_config": { 0x4058a689: 0x6767230e },
983 "dhcp_client_config": { 0x1af013ea: 0x959b80a3 },
984 "dhcp_compl_event": { 0x554a44e5: 0xe908fd1d },
985 "dhcp_client_details": { 0x3c5cd28a: 0xacd82f5a },
986 "dhcp_proxy_details": { 0xdcbaf540: 0xce16f044 },
987 "dhcp6_send_client_message": { 0xf8222476: 0xf6f14ef0 },
988 "dhcp6_pd_send_client_message": { 0x3739fd8d: 0x64badb8 },
989 "dhcp6_reply_event": { 0x85b7b17e: 0x9f3af9e5 },
990 "dhcp6_pd_reply_event": { 0x5e878029: 0xcb3e462b },
991 "ip6_add_del_address_using_prefix": { 0x3982f30a: 0x9b3d11e0 },
992 "gbp_bridge_domain_add": { 0x918e8c01: 0x8454bfdf },
993 "gbp_bridge_domain_details": { 0x51d51be9: 0x2acd15f9 },
994 "gbp_route_domain_add": { 0x204c79e1: 0x2d0afe38 },
995 "gbp_route_domain_details": { 0xa78bfbca: 0x8ab11375 },
996 "gbp_endpoint_add": { 0x7b3af7de: 0x9ce16d5a },
997 "gbp_endpoint_details": { 0x8dd8fbd3: 0x8aecb60 },
998 "gbp_endpoint_group_add": { 0x301ddf15: 0x8e0f4054 },
999 "gbp_endpoint_group_details": { 0xab71d723: 0x8f38292c },
1000 "gbp_subnet_add_del": { 0xa8803c80: 0x888aca35 },
1001 "gbp_subnet_details": { 0xcbc5ca18: 0x4ed84156 },
1002 "gbp_contract_add_del": { 0xaa8d652d: 0x553e275b },
1003 "gbp_contract_details": { 0x65dec325: 0x2a18db6e },
1004 "gbp_ext_itf_add_del": { 0x7606d0e1: 0x12ed5700 },
1005 "gbp_ext_itf_details": { 0x519c3d3c: 0x408a45c0 },
1006 "gtpu_add_del_tunnel": { 0xca983a2b: 0x9a9c0426 },
1007 "gtpu_tunnel_update_tteid": { 0x79f33816: 0x8a2db108 },
1008 "gtpu_tunnel_details": { 0x27f434ae: 0x4535cf95 },
1009 "igmp_listen": { 0x19a49f1e: 0x3f93a51a },
1010 "igmp_details": { 0x38f09929: 0x52f12a89 },
1011 "igmp_event": { 0x85fe93ec: 0xd7696eaf },
1012 "igmp_group_prefix_set": { 0x5b14a5ce: 0xd4f20ac5 },
1013 "igmp_group_prefix_details": { 0x259ccd81: 0xc3b3c526 },
1014 "ikev2_set_responder": { 0xb9aa4d4e: 0xf0d3dc80 },
1015 "vxlan_gpe_ioam_export_enable_disable": { 0xd4c76d3a: 0xe4d4ebfa },
1016 "ioam_export_ip6_enable_disable": { 0xd4c76d3a: 0xe4d4ebfa },
1017 "vxlan_gpe_ioam_vni_enable": { 0xfbb5fb1: 0x997161fb },
1018 "vxlan_gpe_ioam_vni_disable": { 0xfbb5fb1: 0x997161fb },
1019 "vxlan_gpe_ioam_transit_enable": { 0x3d3ec657: 0x553f5b7b },
1020 "vxlan_gpe_ioam_transit_disable": { 0x3d3ec657: 0x553f5b7b },
1021 "udp_ping_add_del": { 0xfa2628fc: 0xc692b188 },
1022 "l3xc_update": { 0xe96aabdf: 0x787b1d3 },
1023 "l3xc_details": { 0xbc5bf852: 0xd4f69627 },
1024 "sw_interface_lacp_details": { 0xd9a83d2f: 0x745ae0ba },
1025 "lb_conf": { 0x56cd3261: 0x22ddb739 },
1026 "lb_add_del_vip": { 0x6fa569c7: 0xd15b7ddc },
1027 "lb_add_del_as": { 0x35d72500: 0x78628987 },
1028 "lb_vip_dump": { 0x56110cb7: 0xc7bcb124 },
1029 "lb_vip_details": { 0x1329ec9b: 0x8f39bed },
1030 "lb_as_details": { 0x8d24c29e: 0x9c39f60e },
1031 "mactime_add_del_range": { 0xcb56e877: 0x101858ef },
1032 "mactime_details": { 0xda25b13a: 0x44921c06 },
1033 "map_add_domain": { 0x249f195c: 0x7a5a18c9 },
1034 "map_domain_details": { 0x796edb50: 0xfc1859dd },
1035 "map_param_add_del_pre_resolve": { 0xdae5af03: 0x17008c66 },
1036 "map_param_get_reply": { 0x26272c90: 0x28092156 },
1037 "memif_details": { 0xda34feb9: 0xd0382c4c },
1038 "dslite_add_del_pool_addr_range": { 0xde2a5b02: 0xc448457a },
1039 "dslite_set_aftr_addr": { 0x78b50fdf: 0x1e955f8d },
1040 "dslite_get_aftr_addr_reply": { 0x8e23608e: 0x38e30db1 },
1041 "dslite_set_b4_addr": { 0x78b50fdf: 0x1e955f8d },
1042 "dslite_get_b4_addr_reply": { 0x8e23608e: 0x38e30db1 },
1043 "nat44_add_del_address_range": { 0x6f2b8055: 0xd4c7568c },
1044 "nat44_address_details": { 0xd1beac1: 0x45410ac4 },
1045 "nat44_add_del_static_mapping": { 0x5ae5f03e: 0xe165e83b },
1046 "nat44_static_mapping_details": { 0x6cb40b2: 0x1a433ef7 },
1047 "nat44_add_del_identity_mapping": { 0x2faaa22: 0x8e12743f },
1048 "nat44_identity_mapping_details": { 0x2a52a030: 0x36d21351 },
1049 "nat44_add_del_interface_addr": { 0x4aed50c0: 0xfc835325 },
1050 "nat44_interface_addr_details": { 0xe4aca9ca: 0x3e687514 },
1051 "nat44_user_session_details": { 0x2cf6e16d: 0x1965fd69 },
1052 "nat44_add_del_lb_static_mapping": { 0x4f68ee9d: 0x53b24611 },
1053 "nat44_lb_static_mapping_add_del_local": { 0x7ca47547: 0x2910a151 },
1054 "nat44_lb_static_mapping_details": { 0xed5ce876: 0x2267b9e8 },
1055 "nat44_del_session": { 0x15a5bf8c: 0x4c49c387 },
1056 "nat_det_add_del_map": { 0x1150a190: 0x112fde05 },
1057 "nat_det_map_details": { 0xad91dc83: 0x88000ee1 },
1058 "nat_det_close_session_out": { 0xf6b259d1: 0xc1b6cbfb },
1059 "nat_det_close_session_in": { 0x3c68e073: 0xa10ef64 },
1060 "nat64_add_del_pool_addr_range": { 0xa3b944e3: 0x21234ef3 },
1061 "nat64_add_del_static_bib": { 0x1c404de5: 0x90fae58a },
1062 "nat64_bib_details": { 0x43bc3ddf: 0x62c8541d },
1063 "nat64_st_details": { 0xdd3361ed: 0xc770d620 },
1064 "nat66_add_del_static_mapping": { 0x3ed88f71: 0xfb64e50b },
1065 "nat66_static_mapping_details": { 0xdf39654b: 0x5c568448 },
1066 "nsh_add_del_map": { 0xa0f42b0: 0x898d857d },
1067 "nsh_map_details": { 0x2fefcf49: 0xb34ac8a1 },
1068 "nsim_cross_connect_enable_disable": { 0x9c3ead86: 0x16f70bdf },
1069 "pppoe_add_del_session": { 0xf6fd759e: 0x46ace853 },
1070 "pppoe_session_details": { 0x4b8e8a4a: 0x332bc742 },
1071 "stn_add_del_rule": { 0x224c6edd: 0x53f751e6 },
1072 "stn_rules_details": { 0xa51935a6: 0xb0f6606c },
1073 "svs_route_add_del": { 0xe49bc63c: 0xd39e31fc },
1074 "svs_details": { 0x6282cd55: 0xb8523d64 },
1075 "vmxnet3_details": { 0x6a1a5498: 0x829ba055 },
1076 "vrrp_vr_add_del": { 0xc5cf15aa: 0x6dc4b881 },
1077 "vrrp_vr_details": { 0x46edcebd: 0x412fa71 },
1078 "vrrp_vr_set_peers": { 0x20bec71f: 0xbaa2e52b },
1079 "vrrp_vr_peer_details": { 0x3d99c108: 0xabd9145e },
1080 "vrrp_vr_track_if_add_del": { 0xd67df299: 0x337f4ba4 },
1081 "vrrp_vr_track_if_details": { 0x73c36f81: 0x99bcca9c },
1082 "proxy_arp_add_del": { 0x1823c3e7: 0x85486cbd },
1083 "proxy_arp_details": { 0x5b948673: 0x9228c150 },
1084 "bfd_udp_get_echo_source_reply": { 0xe3d736a1: 0x1e00cfce },
1085 "bfd_udp_add": { 0x939cd26a: 0x7a6d1185 },
1086 "bfd_udp_mod": { 0x913df085: 0x783a3ff6 },
1087 "bfd_udp_del": { 0xdcb13a89: 0x8096514d },
1088 "bfd_udp_session_details": { 0x9fb2f2d: 0x60653c02 },
1089 "bfd_udp_session_set_flags": { 0x4b4bdfd: 0xcf313851 },
1090 "bfd_udp_auth_activate": { 0x21fd1bdb: 0x493ee0ec },
1091 "bfd_udp_auth_deactivate": { 0x9a05e2e0: 0x99978c32 },
1092 "bier_route_add_del": { 0xfd02f3ea: 0xf29edca0 },
1093 "bier_route_details": { 0x4008caee: 0x39ee6a56 },
1094 "bier_disp_entry_add_del": { 0x9eb80cb4: 0x648323eb },
1095 "bier_disp_entry_details": { 0x84c218f1: 0xe5b039a9 },
1096 "bond_create": { 0xf1dbd4ff: 0x48883c7e },
1097 "bond_enslave": { 0xe7d14948: 0x76ecfa7 },
1098 "sw_interface_bond_details": { 0xbb7c929b: 0xf5ef2106 },
1099 "pipe_create_reply": { 0xb7ce310c: 0xd4c2c2b3 },
1100 "pipe_details": { 0xc52b799d: 0x43ac107a },
1101 "tap_create_v2": { 0x2d0d6570: 0x445835fd },
1102 "sw_interface_tap_v2_details": { 0x1e2b2a47: 0xe53c16de },
1103 "sw_interface_vhost_user_details": { 0xcee1e53: 0x98530df1 },
1104 "virtio_pci_create": { 0x1944f8db: 0xa9f1370c },
1105 "sw_interface_virtio_pci_details": { 0x6ca9c167: 0x16187f3a },
1106 "p2p_ethernet_add": { 0x36a1a6dc: 0xeeb8e717 },
1107 "p2p_ethernet_del": { 0x62f81c8c: 0xb62c386 },
1108 "geneve_add_del_tunnel": { 0x99445831: 0x976693b5 },
1109 "geneve_tunnel_details": { 0x6b16eb24: 0xe27e2748 },
1110 "gre_tunnel_add_del": { 0xa27d7f17: 0x6efc9c22 },
1111 "gre_tunnel_details": { 0x24435433: 0x3bfbf1 },
1112 "sw_interface_set_flags": { 0xf5aec1b8: 0x6a2b491a },
1113 "sw_interface_event": { 0x2d3d95a7: 0xf709f78d },
1114 "sw_interface_details": { 0x6c221fc7: 0x17b69fa2 },
1115 "sw_interface_add_del_address": { 0x5463d73b: 0x5803d5c4 },
1116 "sw_interface_set_unnumbered": { 0x154a6439: 0x938ef33b },
1117 "sw_interface_set_mac_address": { 0xc536e7eb: 0x6aca746a },
1118 "sw_interface_set_rx_mode": { 0xb04d1cfe: 0x780f5cee },
1119 "sw_interface_rx_placement_details": { 0x9e44a7ce: 0xf6d7d024 },
1120 "create_subif": { 0x790ca755: 0xcb371063 },
1121 "ip_neighbor_add_del": { 0x607c257: 0x105518b6 },
1122 "ip_neighbor_dump": { 0xd817a484: 0xcd831298 },
1123 "ip_neighbor_details": { 0xe29d79f0: 0x870e80b9 },
1124 "want_ip_neighbor_events": { 0x73e70a86: 0x1a312870 },
1125 "ip_neighbor_event": { 0xbdb092b2: 0x83933131 },
1126 "ip_route_add_del": { 0xb8ecfe0d: 0xc1ff832d },
1127 "ip_route_details": { 0xbda8f315: 0xd1ffaae1 },
1128 "ip_route_lookup": { 0x710d6471: 0xe2986185 },
1129 "ip_route_lookup_reply": { 0x5d8febcb: 0xae99de8e },
1130 "ip_mroute_add_del": { 0x85d762f3: 0xf6627d17 },
1131 "ip_mroute_details": { 0x99341a45: 0xc1cb4b44 },
1132 "ip_address_details": { 0xee29b797: 0xb1199745 },
1133 "ip_unnumbered_details": { 0xcc59bd42: 0xaa12a483 },
1134 "mfib_signal_details": { 0x6f4a4cfb: 0x64398a9a },
1135 "ip_punt_redirect": { 0x6580f635: 0xa9a5592c },
1136 "ip_punt_redirect_details": { 0x2cef63e7: 0x3924f5d3 },
1137 "ip_container_proxy_add_del": { 0x7df1dff1: 0x91189f40 },
1138 "ip_container_proxy_details": { 0xa8085523: 0xee460e8 },
1139 "ip_source_and_port_range_check_add_del": { 0x92a067e3: 0x8bfc76f2 },
1140 "sw_interface_ip6_set_link_local_address": { 0x1c10f15f: 0x2931d9fa },
1141 "ip_reassembly_enable_disable": { 0xeb77968d: 0x885c85a6 },
1142 "set_punt": { 0xaa83d523: 0x83799618 },
1143 "punt_socket_register": { 0x95268cbf: 0xc8cd10fa },
1144 "punt_socket_details": { 0xde575080: 0x1de0ce75 },
1145 "punt_socket_deregister": { 0x98fc9102: 0x98a444f4 },
1146 "sw_interface_ip6nd_ra_prefix": { 0x82cc1b28: 0xe098785f },
1147 "ip6nd_proxy_add_del": { 0xc2e4a686: 0x3fdf6659 },
1148 "ip6nd_proxy_details": { 0x30b9ff4a: 0xd35be8ff },
1149 "ip6_ra_event": { 0x364c1c5: 0x47e8cfbe },
1150 "set_ipfix_exporter": { 0x5530c8a0: 0x69284e07 },
1151 "ipfix_exporter_details": { 0xdedbfe4: 0x11e07413 },
1152 "ipip_add_tunnel": { 0x2ac399f5: 0xa9decfcd },
1153 "ipip_6rd_add_tunnel": { 0xb9ec1863: 0x56e93cc0 },
1154 "ipip_tunnel_details": { 0xd31cb34e: 0x53236d75 },
1155 "ipsec_spd_entry_add_del": { 0x338b7411: 0x9f384b8d },
1156 "ipsec_spd_details": { 0x5813d7a2: 0xf2222790 },
1157 "ipsec_sad_entry_add_del": { 0xab64b5c6: 0xb8def364 },
1158 "ipsec_tunnel_protect_update": { 0x30d5f133: 0x143f155d },
1159 "ipsec_tunnel_protect_del": { 0xcd239930: 0xddd2ba36 },
1160 "ipsec_tunnel_protect_details": { 0x21663a50: 0xac6c823b },
1161 "ipsec_tunnel_if_add_del": { 0x20e353fa: 0x2b135e68 },
1162 "ipsec_sa_details": { 0x345d14a7: 0xb30c7f41 },
1163 "l2_xconnect_details": { 0x472b6b67: 0xc8aa6b37 },
1164 "l2_fib_table_details": { 0xa44ef6b8: 0xe8d2fc72 },
1165 "l2fib_add_del": { 0xeddda487: 0xf29d796c },
1166 "l2_macs_event": { 0x44b8fd64: 0x2eadfc8b },
1167 "bridge_domain_details": { 0xfa506fd: 0x979f549d },
1168 "l2_interface_pbb_tag_rewrite": { 0x38e802a8: 0x612efa5a },
1169 "l2_patch_add_del": { 0xa1f6a6f3: 0x522f3445 },
1170 "sw_interface_set_l2_xconnect": { 0x4fa28a85: 0x1aaa2dbb },
1171 "sw_interface_set_l2_bridge": { 0xd0678b13: 0x2e483cd0 },
1172 "bd_ip_mac_add_del": { 0x257c869: 0x5f2b84e2 },
1173 "bd_ip_mac_details": { 0x545af86a: 0xa52f8044 },
1174 "l2_arp_term_event": { 0x6963e07a: 0x85ff71ea },
1175 "l2tpv3_create_tunnel": { 0x15bed0c2: 0x596892cb },
1176 "sw_if_l2tpv3_tunnel_details": { 0x50b88993: 0x1dab5c7e },
1177 "lisp_add_del_local_eid": { 0x4e5a83a2: 0x21f573bd },
1178 "lisp_add_del_map_server": { 0xce19e32d: 0x6598ea7c },
1179 "lisp_add_del_map_resolver": { 0xce19e32d: 0x6598ea7c },
1180 "lisp_use_petr": { 0xd87dbad9: 0x9e141831 },
1181 "show_lisp_use_petr_reply": { 0x22b9a4b0: 0xdcad8a81 },
1182 "lisp_add_del_remote_mapping": { 0x6d5c789e: 0xfae8ed77 },
1183 "lisp_add_del_adjacency": { 0x2ce0e6f6: 0xcf5edb61 },
1184 "lisp_locator_details": { 0x2c620ffe: 0xc0c4c2a7 },
1185 "lisp_eid_table_details": { 0x1c29f792: 0x4bc32e3a },
1186 "lisp_eid_table_dump": { 0x629468b5: 0xb959b73b },
1187 "lisp_adjacencies_get_reply": { 0x807257bf: 0x3f97bcdd },
1188 "lisp_map_resolver_details": { 0x3e78fc57: 0x82a09deb },
1189 "lisp_map_server_details": { 0x3e78fc57: 0x82a09deb },
1190 "one_add_del_local_eid": { 0x4e5a83a2: 0x21f573bd },
1191 "one_add_del_map_server": { 0xce19e32d: 0x6598ea7c },
1192 "one_add_del_map_resolver": { 0xce19e32d: 0x6598ea7c },
1193 "one_use_petr": { 0xd87dbad9: 0x9e141831 },
1194 "show_one_use_petr_reply": { 0x84a03528: 0x10e744a6 },
1195 "one_add_del_remote_mapping": { 0x6d5c789e: 0xfae8ed77 },
1196 "one_add_del_l2_arp_entry": { 0x1aa5e8b3: 0x33209078 },
1197 "one_l2_arp_entries_get_reply": { 0xb0dd200f: 0xb0a47bbe },
1198 "one_add_del_ndp_entry": { 0xf8a287c: 0xd1629a2f },
1199 "one_ndp_entries_get_reply": { 0x70719b1a: 0xbd34161 },
1200 "one_add_del_adjacency": { 0x9e830312: 0xe48e7afe },
1201 "one_locator_details": { 0x2c620ffe: 0xc0c4c2a7 },
1202 "one_eid_table_details": { 0x1c29f792: 0x4bc32e3a },
1203 "one_eid_table_dump": { 0xbd190269: 0x95151038 },
1204 "one_adjacencies_get_reply": { 0x85bab89: 0xa8ed89a5 },
1205 "one_map_resolver_details": { 0x3e78fc57: 0x82a09deb },
1206 "one_map_server_details": { 0x3e78fc57: 0x82a09deb },
1207 "one_stats_details": { 0x2eb74678: 0xff6ef238 },
1208 "gpe_add_del_fwd_entry": { 0xf0847644: 0xde6df50f },
1209 "gpe_fwd_entries_get_reply": { 0xc4844876: 0xf9f53f1b },
1210 "gpe_fwd_entry_path_details": { 0x483df51a: 0xee80b19a },
1211 "gpe_add_del_native_fwd_rpath": { 0x43fc8b54: 0x812da2f2 },
1212 "gpe_native_fwd_rpaths_get_reply": { 0x7a1ca5a2: 0x79d54eb9 },
1213 "sw_interface_set_lldp": { 0x57afbcd4: 0xd646ae0f },
1214 "mpls_ip_bind_unbind": { 0xc7533b32: 0x48249a27 },
1215 "mpls_tunnel_add_del": { 0x44350ac1: 0xe57ce61d },
1216 "mpls_tunnel_details": { 0x57118ae3: 0xf3c0928e },
1217 "mpls_route_add_del": { 0x8e1d1e07: 0x343cff54 },
1218 "mpls_route_details": { 0x9b5043dc: 0xd0ac384c },
1219 "policer_add_del": { 0x2b31dd38: 0xcb948f6e },
1220 "policer_details": { 0x72d0e248: 0xa43f781a },
1221 "qos_store_enable_disable": { 0xf3abcc8b: 0x3507235e },
1222 "qos_store_details": { 0x3ee0aad7: 0x38a6d48 },
1223 "qos_record_enable_disable": { 0x2f1a4a38: 0x25b33f88 },
1224 "qos_record_details": { 0xa425d4d3: 0x4956ccdd },
1225 "session_rule_add_del": { 0xe4895422: 0xe31f9443 },
1226 "session_rules_details": { 0x28d71830: 0x304b91f0 },
1227 "sw_interface_span_enable_disable": { 0x23ddd96b: 0xacc8fea1 },
1228 "sw_interface_span_details": { 0x8a20e79f: 0x55643fc },
1229 "sr_mpls_steering_add_del": { 0x64acff63: 0x7d1b0a0b },
1230 "sr_mpls_policy_assign_endpoint_color": { 0xe7eb978: 0x5e1c5c13 },
1231 "sr_localsid_add_del": { 0x5a36c324: 0x26fa3309 },
1232 "sr_policy_add": { 0x44ac92e8: 0xec79ee6a },
1233 "sr_policy_mod": { 0xb97bb56e: 0xe531a102 },
1234 "sr_steering_add_del": { 0xe46b0a0f: 0x3711dace },
1235 "sr_localsids_details": { 0x2e9221b9: 0x6a6c0265 },
1236 "sr_policies_details": { 0xdb6ff2a1: 0x7ec2d93 },
1237 "sr_steering_pol_details": { 0xd41258c9: 0x1c1ee786 },
1238 "syslog_set_sender": { 0xb8011d0b: 0xbb641285 },
1239 "syslog_get_sender_reply": { 0x424cfa4e: 0xd3da60ac },
1240 "tcp_configure_src_addresses": { 0x67eede0d: 0x4b02b946 },
1241 "teib_entry_add_del": { 0x8016cfd2: 0x5aa0a538 },
1242 "teib_details": { 0x981ee1a1: 0xe3b6a503 },
1243 "udp_encap_add": { 0xf74a60b1: 0x61d5fc48 },
1244 "udp_encap_details": { 0x8cfb9c76: 0x87c82821 },
1245 "vxlan_gbp_tunnel_add_del": { 0x6c743427: 0x8c819166 },
1246 "vxlan_gbp_tunnel_details": { 0x66e94a89: 0x1da24016 },
1247 "vxlan_gpe_add_del_tunnel": { 0xa645b2b0: 0x7c6da6ae },
1248 "vxlan_gpe_tunnel_details": { 0x968fc8b: 0x57712346 },
1249 "vxlan_add_del_tunnel": { 0xc09dc80: 0xa35dc8f5 },
1250 "vxlan_tunnel_details": { 0xc3916cb1: 0xe782f70f },
1251 "vxlan_offload_rx": { 0x9cc95087: 0x89a1564b },
1252 "log_details": { 0x3d61cc0: 0x255827a1 },
1258 f.crc = foldup_blocks(f.block,
1259 binascii.crc32(f.crc) & 0xffffffff)
1261 # fixup the CRCs to make the fix seamless
1262 if f.name in fixup_crc_dict:
1263 if f.crc in fixup_crc_dict.get(f.name):
1264 f.crc = fixup_crc_dict.get(f.name).get(f.crc)
1270 if sys.version_info < (3, 5,):
1271 log.exception('vppapigen requires a supported version of python. '
1272 'Please use version 3.5 or greater. '
1273 'Using {}'.format(sys.version))
1276 cliparser = argparse.ArgumentParser(description='VPP API generator')
1277 cliparser.add_argument('--pluginpath', default=""),
1278 cliparser.add_argument('--includedir', action='append'),
1279 cliparser.add_argument('--outputdir', action='store'),
1280 cliparser.add_argument('--input')
1281 cliparser.add_argument('--output', nargs='?',
1282 type=argparse.FileType('w', encoding='UTF-8'),
1285 cliparser.add_argument('output_module', nargs='?', default='C')
1286 cliparser.add_argument('--debug', action='store_true')
1287 cliparser.add_argument('--show-name', nargs=1)
1288 cliparser.add_argument('--git-revision',
1289 help="Git revision to use for opening files")
1290 args = cliparser.parse_args()
1292 dirlist_add(args.includedir)
1294 sys.excepthook = exception_handler
1298 filename = args.show_name[0]
1300 filename = args.input
1305 logging.basicConfig(stream=sys.stdout, level=logging.WARNING)
1307 logging.basicConfig()
1309 parser = VPPAPI(debug=args.debug, filename=filename, logger=log,
1310 revision=args.git_revision)
1314 parsed_objects = parser.parse_fd(sys.stdin, log)
1316 parsed_objects = parser.parse_filename(args.input, log)
1317 except ParseError as e:
1318 print('Parse error: ', e, file=sys.stderr)
1321 # Build a list of objects. Hash of lists.
1324 if args.output_module == 'C':
1325 s = parser.process(parsed_objects)
1327 result = parser.process_imports(parsed_objects, False, result)
1328 s = parser.process(result)
1331 s['Define'] = add_msg_id(s['Define'])
1334 foldup_crcs(s['Define'])
1340 pp = pprint.PrettyPrinter(indent=4, stream=sys.stderr)
1341 for t in s['Define']:
1342 pp.pprint([t.name, t.flags, t.block])
1343 for t in s['types']:
1344 pp.pprint([t.name, t.block])
1347 # Generate representation
1349 from importlib.machinery import SourceFileLoader
1353 if not args.pluginpath:
1355 cand.append(os.path.dirname(os.path.realpath(__file__)))
1356 cand.append(os.path.dirname(os.path.realpath(__file__)) +
1360 if os.path.isfile('{}vppapigen_{}.py'
1361 .format(c, args.output_module.lower())):
1365 pluginpath = args.pluginpath + '/'
1366 if pluginpath == '':
1367 log.exception('Output plugin not found')
1369 module_path = '{}vppapigen_{}.py'.format(pluginpath,
1370 args.output_module.lower())
1373 plugin = SourceFileLoader(args.output_module,
1374 module_path).load_module()
1375 except Exception as err:
1376 log.exception('Error importing output plugin: {}, {}'
1377 .format(module_path, err))
1380 result = plugin.run(args, filename, s)
1382 print(result, file=args.output)
1384 log.exception('Running plugin failed: {} {}'
1385 .format(filename, result))
1390 if __name__ == '__main__':