X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Ftools%2Fvppapigen%2Fvppapigen.py;h=2d2097904c5e9cba2c5ea25429787d41db669ebc;hb=14a6c0e601b246601954ca18fb44d3cb346e331f;hp=8ae991c9c95daac6735be0a7f35ec4babb618449;hpb=7520e17bfa7d5ad69fe3559506ce9b71a66852ae;p=vpp.git diff --git a/src/tools/vppapigen/vppapigen.py b/src/tools/vppapigen/vppapigen.py index 8ae991c9c95..2d2097904c5 100755 --- a/src/tools/vppapigen/vppapigen.py +++ b/src/tools/vppapigen/vppapigen.py @@ -1,13 +1,19 @@ -#!/usr/bin/python3 +#!/usr/bin/env python3 -from __future__ import print_function import ply.lex as lex import ply.yacc as yacc import sys import argparse +import keyword import logging import binascii import os +import sys +from subprocess import Popen, PIPE + +assert sys.version_info >= (3, 6), \ + "Not supported Python version: {}".format(sys.version) +log = logging.getLogger('vppapigen') # Ensure we don't leave temporary files around sys.dont_write_bytecode = True @@ -19,10 +25,15 @@ sys.dont_write_bytecode = True # Global dictionary of new types (including enums) global_types = {} +seen_imports = {} + def global_type_add(name, obj): '''Add new type to the dictionary of types ''' type_name = 'vl_api_' + name + '_t' + if type_name in global_types: + raise KeyError("Attempted redefinition of {!r} with {!r}.".format( + name, obj)) global_types[type_name] = obj @@ -76,6 +87,16 @@ class VPPAPILexer(object): t_ignore_LINE_COMMENT = '//.*' + def t_FALSE(self, t): + r'false' + t.value = False + return t + + def t_TRUE(self, t): + r'false' + t.value = True + return t + def t_NUM(self, t): r'0[xX][0-9a-fA-F]+|-?\d+\.?\d*' base = 16 if t.value.startswith('0x') else 10 @@ -127,6 +148,33 @@ def crc_block_combine(block, crc): return binascii.crc32(s, crc) & 0xffffffff +def vla_is_last_check(name, block): + vla = False + for i, b in enumerate(block): + if isinstance(b, Array) and b.vla: + vla = True + if i + 1 < len(block): + raise ValueError( + 'VLA field "{}" must be the last field in message "{}"' + .format(b.fieldname, name)) + elif b.fieldtype.startswith('vl_api_'): + if global_types[b.fieldtype].vla: + vla = True + if i + 1 < len(block): + raise ValueError( + 'VLA field "{}" must be the last ' + 'field in message "{}"' + .format(b.fieldname, name)) + elif b.fieldtype == 'string' and b.length == 0: + vla = True + if i + 1 < len(block): + raise ValueError( + 'VLA field "{}" must be the last ' + 'field in message "{}"' + .format(b.fieldname, name)) + return vla + + class Service(): def __init__(self, caller, reply, events=None, stream=False): self.caller = caller @@ -148,21 +196,36 @@ class Typedef(): self.manual_print = True elif f == 'manual_endian': self.manual_endian = True + global_type_add(name, self) + self.vla = vla_is_last_check(name, block) + def __repr__(self): return self.name + str(self.flags) + str(self.block) class Using(): - def __init__(self, name, alias): + def __init__(self, name, flags, alias): self.name = name + self.vla = False + self.block = [] + self.manual_print = True + self.manual_endian = True + + self.manual_print = False + self.manual_endian = False + for f in flags: + if f == 'manual_print': + self.manual_print = True + elif f == 'manual_endian': + self.manual_endian = True if isinstance(alias, Array): - a = { 'type': alias.fieldtype, # noqa: E201 - 'length': alias.length } # noqa: E202 + a = {'type': alias.fieldtype, + 'length': alias.length} else: - a = { 'type': alias.fieldtype } # noqa: E201,E202 + a = {'type': alias.fieldtype} self.alias = a self.crc = str(alias).encode() global_type_add(name, self) @@ -172,13 +235,22 @@ class Using(): class Union(): - def __init__(self, name, block): + def __init__(self, name, flags, block): self.type = 'Union' self.manual_print = False self.manual_endian = False self.name = name + + for f in flags: + if f == 'manual_print': + self.manual_print = True + elif f == 'manual_endian': + self.manual_endian = True + self.block = block self.crc = str(block).encode() + self.vla = vla_is_last_check(name, block) + global_type_add(name, self) def __repr__(self): @@ -190,12 +262,12 @@ class Define(): self.name = name self.flags = flags self.block = block - self.crc = str(block).encode() self.dont_trace = False self.manual_print = False self.manual_endian = False self.autoreply = False self.singular = False + self.options = {} for f in flags: if f == 'dont_trace': self.dont_trace = True @@ -206,11 +278,19 @@ class Define(): elif f == 'autoreply': self.autoreply = True + remove = [] for b in block: if isinstance(b, Option): if b[1] == 'singular' and b[2] == 'true': self.singular = True - block.remove(b) + else: + self.options[b.option] = b.value + remove.append(b) + + block = [x for x in block if x not in remove] + self.block = block + self.vla = vla_is_last_check(name, block) + self.crc = str(block).encode() def __repr__(self): return self.name + str(self.flags) + str(self.block) @@ -220,6 +300,7 @@ class Enum(): def __init__(self, name, block, enumtype='u32'): self.name = name self.enumtype = enumtype + self.vla = False count = 0 for i, b in enumerate(block): @@ -238,31 +319,40 @@ class Enum(): class Import(): - def __init__(self, filename): - self.filename = filename - # Deal with imports - parser = VPPAPI(filename=filename) - dirlist = dirlist_get() - f = filename - for dir in dirlist: - f = os.path.join(dir, filename) - if os.path.exists(f): - break - if sys.version[0] == '2': - with open(f) as fd: - self.result = parser.parse_file(fd, None) + def __new__(cls, *args, **kwargs): + if args[0] not in seen_imports: + instance = super().__new__(cls) + instance._initialized = False + seen_imports[args[0]] = instance + + return seen_imports[args[0]] + + def __init__(self, filename, revision): + if self._initialized: + return else: - with open(f, encoding='utf-8') as fd: - self.result = parser.parse_file(fd, None) + self.filename = filename + # Deal with imports + parser = VPPAPI(filename=filename, revision=revision) + dirlist = dirlist_get() + f = filename + for dir in dirlist: + f = os.path.join(dir, filename) + if os.path.exists(f): + break + self.result = parser.parse_filename(f, None) + self._initialized = True def __repr__(self): return self.filename class Option(): - def __init__(self, option): + def __init__(self, option, value): + self.type = 'Option' self.option = option + self.value = value self.crc = str(option).encode() def __repr__(self): @@ -273,16 +363,19 @@ class Option(): class Array(): - def __init__(self, fieldtype, name, length): + def __init__(self, fieldtype, name, length, modern_vla=False): self.type = 'Array' self.fieldtype = fieldtype self.fieldname = name + self.modern_vla = modern_vla if type(length) is str: self.lengthfield = length self.length = 0 + self.vla = True else: self.length = length self.lengthfield = None + self.vla = False def __repr__(self): return str([self.fieldtype, self.fieldname, self.length, @@ -293,6 +386,14 @@ class Field(): def __init__(self, fieldtype, name, limit=None): self.type = 'Field' self.fieldtype = fieldtype + + if self.fieldtype == 'string': + raise ValueError("The string type {!r} is an " + "array type ".format(name)) + + if name in keyword.kwlist: + raise ValueError("Fieldname {!r} is a python keyword and is not " + "accessible via the python API. ".format(name)) self.fieldname = name self.limit = limit @@ -330,10 +431,11 @@ class ParseError(Exception): class VPPAPIParser(object): tokens = VPPAPILexer.tokens - def __init__(self, filename, logger): + def __init__(self, filename, logger, revision=None): self.filename = filename self.logger = logger self.fields = [] + self.revision = revision def _parse_error(self, msg, coord): raise ParseError("%s: %s" % (coord, msg)) @@ -378,7 +480,7 @@ class VPPAPIParser(object): def p_import(self, p): '''import : IMPORT STRING_LITERAL ';' ''' - p[0] = Import(p[2]) + p[0] = Import(p[2], revision=self.revision) def p_service(self, p): '''service : SERVICE '{' service_statements '}' ';' ''' @@ -448,7 +550,9 @@ class VPPAPIParser(object): '''define : flist DEFINE ID '{' block_statements_opt '}' ';' ''' # Legacy typedef if 'typeonly' in p[1]: - p[0] = Typedef(p[3], p[1], p[5]) + self._parse_error('legacy typedef. use typedef: {} {}[{}];' + .format(p[1], p[2], p[4]), + self._token_coord(p, 1)) else: p[0] = Define(p[3], p[1], p[5]) @@ -474,9 +578,17 @@ class VPPAPIParser(object): '''typedef : TYPEDEF ID '{' block_statements_opt '}' ';' ''' p[0] = Typedef(p[2], [], p[4]) + def p_typedef_flist(self, p): + '''typedef : flist TYPEDEF ID '{' block_statements_opt '}' ';' ''' + p[0] = Typedef(p[3], p[1], p[5]) + def p_typedef_alias(self, p): '''typedef : TYPEDEF declaration ''' - p[0] = Using(p[2].fieldname, p[2]) + p[0] = Using(p[2].fieldname, [], p[2]) + + def p_typedef_alias_flist(self, p): + '''typedef : flist TYPEDEF declaration ''' + p[0] = Using(p[3].fieldname, p[1], p[3]) def p_block_statements_opt(self, p): '''block_statements_opt : block_statements ''' @@ -517,13 +629,18 @@ class VPPAPIParser(object): if len(p) == 2: p[0] = p[1] else: - p[0] = { **p[1], **p[2] } + p[0] = {**p[1], **p[2]} def p_field_option(self, p): - '''field_option : ID '=' assignee ',' + '''field_option : ID + | ID '=' assignee ',' | ID '=' assignee + ''' - p[0] = { p[1]: p[3] } + if len(p) == 2: + p[0] = {p[1]: None} + else: + p[0] = {p[1]: p[3]} def p_declaration(self, p): '''declaration : type_specifier ID ';' @@ -533,12 +650,17 @@ class VPPAPIParser(object): elif len(p) == 4: p[0] = Field(p[1], p[2]) else: - self._parse_error('ERROR') + self._parse_error('ERROR', self._token_coord(p, 1)) self.fields.append(p[2]) + def p_declaration_array_vla(self, p): + '''declaration : type_specifier ID '[' ']' ';' ''' + p[0] = Array(p[1], p[2], 0, modern_vla=True) + def p_declaration_array(self, p): '''declaration : type_specifier ID '[' NUM ']' ';' | type_specifier ID '[' ID ']' ';' ''' + if len(p) != 7: return self._parse_error( 'array: %s' % p.value, @@ -560,7 +682,7 @@ class VPPAPIParser(object): def p_option(self, p): '''option : OPTION ID '=' assignee ';' ''' - p[0] = Option([p[1], p[2], p[4]]) + p[0] = Option(p[2], p[4]) def p_assignee(self, p): '''assignee : NUM @@ -593,7 +715,11 @@ class VPPAPIParser(object): def p_union(self, p): '''union : UNION ID '{' block_statements_opt '}' ';' ''' - p[0] = Union(p[2], p[4]) + p[0] = Union(p[2], [], p[4]) + + def p_union_flist(self, p): + '''union : flist UNION ID '{' block_statements_opt '}' ';' ''' + p[0] = Union(p[3], p[1], p[5]) # Error rule for syntax errors def p_error(self, p): @@ -607,23 +733,42 @@ class VPPAPIParser(object): class VPPAPI(object): - def __init__(self, debug=False, filename='', logger=None): + def __init__(self, debug=False, filename='', logger=None, revision=None): self.lexer = lex.lex(module=VPPAPILexer(filename), debug=debug) - self.parser = yacc.yacc(module=VPPAPIParser(filename, logger), + self.parser = yacc.yacc(module=VPPAPIParser(filename, logger, + revision=revision), write_tables=False, debug=debug) self.logger = logger + self.revision = revision + self.filename = filename def parse_string(self, code, debug=0, lineno=1): self.lexer.lineno = lineno return self.parser.parse(code, lexer=self.lexer, debug=debug) - def parse_file(self, fd, debug=0): + def parse_fd(self, fd, debug=0): data = fd.read() return self.parse_string(data, debug=debug) - def autoreply_block(self, name): + def parse_filename(self, filename, debug=0): + if self.revision: + git_show = f'git show {self.revision}:{filename}' + with Popen(git_show.split(), stdout=PIPE, encoding='utf-8') as git: + return self.parse_fd(git.stdout, None) + else: + try: + with open(filename, encoding='utf-8') as fd: + return self.parse_fd(fd, None) + except FileNotFoundError: + print(f'File not found: {filename}', file=sys.stderr) + sys.exit(2) + + def autoreply_block(self, name, parent): block = [Field('u32', 'context'), Field('i32', 'retval')] + # inherhit the parent's options + for k, v in parent.options.items(): + block.append(Option(k, v)) return Define(name + '_reply', [], block) def process(self, objs): @@ -633,30 +778,28 @@ class VPPAPI(object): s['Service'] = [] s['types'] = [] s['Import'] = [] - s['Alias'] = {} crc = 0 for o in objs: tname = o.__class__.__name__ try: - crc = binascii.crc32(o.crc, crc) + crc = binascii.crc32(o.crc, crc) & 0xffffffff except AttributeError: pass if isinstance(o, Define): s[tname].append(o) if o.autoreply: - s[tname].append(self.autoreply_block(o.name)) + s[tname].append(self.autoreply_block(o.name, o)) elif isinstance(o, Option): - s[tname][o[1]] = o[2] + s[tname][o.option] = o.value elif type(o) is list: for o2 in o: if isinstance(o2, Service): s['Service'].append(o2) elif (isinstance(o, Enum) or isinstance(o, Typedef) or + isinstance(o, Using) or isinstance(o, Union)): s['types'].append(o) - elif isinstance(o, Using): - s['Alias'][o.name] = o.alias else: if tname not in s: raise ValueError('Unknown class type: {} {}' @@ -742,9 +885,11 @@ class VPPAPI(object): isinstance(o, Using)): continue if isinstance(o, Import): - self.process_imports(o.result, True, result) + result.append(o) + result = self.process_imports(o.result, True, result) else: result.append(o) + return result # Add message ids to each message. @@ -766,6 +911,7 @@ def dirlist_add(dirs): def dirlist_get(): return dirlist + def foldup_blocks(block, crc): for b in block: # Look up CRC in user defined types @@ -775,40 +921,41 @@ def foldup_blocks(block, crc): try: crc = crc_block_combine(t.block, crc) return foldup_blocks(t.block, crc) - except: + except AttributeError: pass return crc + def foldup_crcs(s): for f in s: f.crc = foldup_blocks(f.block, - binascii.crc32(f.crc)) + binascii.crc32(f.crc) & 0xffffffff) + # # Main # def main(): + if sys.version_info < (3, 5,): + log.exception('vppapigen requires a supported version of python. ' + 'Please use version 3.5 or greater. ' + 'Using {}'.format(sys.version)) + return 1 + cliparser = argparse.ArgumentParser(description='VPP API generator') cliparser.add_argument('--pluginpath', default=""), cliparser.add_argument('--includedir', action='append'), - if sys.version[0] == '2': - cliparser.add_argument('--input', type=argparse.FileType('r'), - default=sys.stdin) - cliparser.add_argument('--output', nargs='?', - type=argparse.FileType('w'), - default=sys.stdout) - - else: - cliparser.add_argument('--input', - type=argparse.FileType('r', encoding='UTF-8'), - default=sys.stdin) - cliparser.add_argument('--output', nargs='?', - type=argparse.FileType('w', encoding='UTF-8'), - default=sys.stdout) + cliparser.add_argument('--outputdir', action='store'), + cliparser.add_argument('--input') + cliparser.add_argument('--output', nargs='?', + type=argparse.FileType('w', encoding='UTF-8'), + default=sys.stdout) cliparser.add_argument('output_module', nargs='?', default='C') cliparser.add_argument('--debug', action='store_true') cliparser.add_argument('--show-name', nargs=1) + cliparser.add_argument('--git-revision', + help="Git revision to use for opening files") args = cliparser.parse_args() dirlist_add(args.includedir) @@ -818,8 +965,8 @@ def main(): # Filename if args.show_name: filename = args.show_name[0] - elif args.input != sys.stdin: - filename = args.input.name + elif args.input: + filename = args.input else: filename = '' @@ -827,15 +974,27 @@ def main(): logging.basicConfig(stream=sys.stdout, level=logging.WARNING) else: logging.basicConfig() - log = logging.getLogger('vppapigen') - parser = VPPAPI(debug=args.debug, filename=filename, logger=log) - parsed_objects = parser.parse_file(args.input, log) + parser = VPPAPI(debug=args.debug, filename=filename, logger=log, + revision=args.git_revision) + + try: + if not args.input: + parsed_objects = parser.parse_fd(sys.stdin, log) + else: + parsed_objects = parser.parse_filename(args.input, log) + except ParseError as e: + print('Parse error: ', e, file=sys.stderr) + sys.exit(1) # Build a list of objects. Hash of lists. result = [] - parser.process_imports(parsed_objects, False, result) - s = parser.process(result) + + if args.output_module == 'C': + s = parser.process(parsed_objects) + else: + result = parser.process_imports(parsed_objects, False, result) + s = parser.process(result) # Add msg_id field s['Define'] = add_msg_id(s['Define']) @@ -874,7 +1033,8 @@ def main(): else: pluginpath = args.pluginpath + '/' if pluginpath == '': - raise Exception('Output plugin not found') + log.exception('Output plugin not found') + return 1 module_path = '{}vppapigen_{}.py'.format(pluginpath, args.output_module.lower()) @@ -882,16 +1042,19 @@ def main(): plugin = SourceFileLoader(args.output_module, module_path).load_module() except Exception as err: - raise Exception('Error importing output plugin: {}, {}' - .format(module_path, err)) + log.exception('Error importing output plugin: {}, {}' + .format(module_path, err)) + return 1 - result = plugin.run(filename, s) + result = plugin.run(args, filename, s) if result: print(result, file=args.output) else: - raise Exception('Running plugin failed: {} {}' - .format(filename, result)) + log.exception('Running plugin failed: {} {}' + .format(filename, result)) + return 1 + return 0 if __name__ == '__main__': - main() + sys.exit(main())