mirror of https://gitee.com/openkylin/qemu.git
331 lines
9.8 KiB
Python
331 lines
9.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# QAPI code generation
|
|
#
|
|
# Copyright (c) 2015-2019 Red Hat Inc.
|
|
#
|
|
# Authors:
|
|
# Markus Armbruster <armbru@redhat.com>
|
|
# Marc-André Lureau <marcandre.lureau@redhat.com>
|
|
#
|
|
# This work is licensed under the terms of the GNU GPL, version 2.
|
|
# See the COPYING file in the top-level directory.
|
|
|
|
from contextlib import contextmanager
|
|
import os
|
|
import re
|
|
from typing import (
|
|
Dict,
|
|
Iterator,
|
|
List,
|
|
Optional,
|
|
Tuple,
|
|
)
|
|
|
|
from .common import (
|
|
c_fname,
|
|
c_name,
|
|
gen_endif,
|
|
gen_if,
|
|
guardend,
|
|
guardstart,
|
|
mcgen,
|
|
)
|
|
from .schema import QAPISchemaObjectType, QAPISchemaVisitor
|
|
from .source import QAPISourceInfo
|
|
|
|
|
|
class QAPIGen:
|
|
def __init__(self, fname: Optional[str]):
|
|
self.fname = fname
|
|
self._preamble = ''
|
|
self._body = ''
|
|
|
|
def preamble_add(self, text: str) -> None:
|
|
self._preamble += text
|
|
|
|
def add(self, text: str) -> None:
|
|
self._body += text
|
|
|
|
def get_content(self) -> str:
|
|
return self._top() + self._preamble + self._body + self._bottom()
|
|
|
|
def _top(self) -> str:
|
|
# pylint: disable=no-self-use
|
|
return ''
|
|
|
|
def _bottom(self) -> str:
|
|
# pylint: disable=no-self-use
|
|
return ''
|
|
|
|
def write(self, output_dir: str) -> None:
|
|
# Include paths starting with ../ are used to reuse modules of the main
|
|
# schema in specialised schemas. Don't overwrite the files that are
|
|
# already generated for the main schema.
|
|
if self.fname.startswith('../'):
|
|
return
|
|
pathname = os.path.join(output_dir, self.fname)
|
|
odir = os.path.dirname(pathname)
|
|
|
|
if odir:
|
|
os.makedirs(odir, exist_ok=True)
|
|
|
|
# use os.open for O_CREAT to create and read a non-existant file
|
|
fd = os.open(pathname, os.O_RDWR | os.O_CREAT, 0o666)
|
|
with os.fdopen(fd, 'r+', encoding='utf-8') as fp:
|
|
text = self.get_content()
|
|
oldtext = fp.read(len(text) + 1)
|
|
if text != oldtext:
|
|
fp.seek(0)
|
|
fp.truncate(0)
|
|
fp.write(text)
|
|
|
|
|
|
def _wrap_ifcond(ifcond: List[str], before: str, after: str) -> str:
|
|
if before == after:
|
|
return after # suppress empty #if ... #endif
|
|
|
|
assert after.startswith(before)
|
|
out = before
|
|
added = after[len(before):]
|
|
if added[0] == '\n':
|
|
out += '\n'
|
|
added = added[1:]
|
|
out += gen_if(ifcond)
|
|
out += added
|
|
out += gen_endif(ifcond)
|
|
return out
|
|
|
|
|
|
def build_params(arg_type: Optional[QAPISchemaObjectType],
|
|
boxed: bool,
|
|
extra: Optional[str] = None) -> str:
|
|
ret = ''
|
|
sep = ''
|
|
if boxed:
|
|
assert arg_type
|
|
ret += '%s arg' % arg_type.c_param_type()
|
|
sep = ', '
|
|
elif arg_type:
|
|
assert not arg_type.variants
|
|
for memb in arg_type.members:
|
|
ret += sep
|
|
sep = ', '
|
|
if memb.optional:
|
|
ret += 'bool has_%s, ' % c_name(memb.name)
|
|
ret += '%s %s' % (memb.type.c_param_type(),
|
|
c_name(memb.name))
|
|
if extra:
|
|
ret += sep + extra
|
|
return ret if ret else 'void'
|
|
|
|
|
|
class QAPIGenCCode(QAPIGen):
|
|
def __init__(self, fname: Optional[str]):
|
|
super().__init__(fname)
|
|
self._start_if: Optional[Tuple[List[str], str, str]] = None
|
|
|
|
def start_if(self, ifcond: List[str]) -> None:
|
|
assert self._start_if is None
|
|
self._start_if = (ifcond, self._body, self._preamble)
|
|
|
|
def end_if(self) -> None:
|
|
assert self._start_if
|
|
self._wrap_ifcond()
|
|
self._start_if = None
|
|
|
|
def _wrap_ifcond(self) -> None:
|
|
self._body = _wrap_ifcond(self._start_if[0],
|
|
self._start_if[1], self._body)
|
|
self._preamble = _wrap_ifcond(self._start_if[0],
|
|
self._start_if[2], self._preamble)
|
|
|
|
def get_content(self) -> str:
|
|
assert self._start_if is None
|
|
return super().get_content()
|
|
|
|
|
|
class QAPIGenC(QAPIGenCCode):
|
|
def __init__(self, fname: str, blurb: str, pydoc: str):
|
|
super().__init__(fname)
|
|
self._blurb = blurb
|
|
self._copyright = '\n * '.join(re.findall(r'^Copyright .*', pydoc,
|
|
re.MULTILINE))
|
|
|
|
def _top(self) -> str:
|
|
return mcgen('''
|
|
/* AUTOMATICALLY GENERATED, DO NOT MODIFY */
|
|
|
|
/*
|
|
%(blurb)s
|
|
*
|
|
* %(copyright)s
|
|
*
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
*/
|
|
|
|
''',
|
|
blurb=self._blurb, copyright=self._copyright)
|
|
|
|
def _bottom(self) -> str:
|
|
return mcgen('''
|
|
|
|
/* Dummy declaration to prevent empty .o file */
|
|
char qapi_dummy_%(name)s;
|
|
''',
|
|
name=c_fname(self.fname))
|
|
|
|
|
|
class QAPIGenH(QAPIGenC):
|
|
def _top(self) -> str:
|
|
return super()._top() + guardstart(self.fname)
|
|
|
|
def _bottom(self) -> str:
|
|
return guardend(self.fname)
|
|
|
|
|
|
@contextmanager
|
|
def ifcontext(ifcond: List[str], *args: QAPIGenCCode) -> Iterator[None]:
|
|
"""
|
|
A with-statement context manager that wraps with `start_if()` / `end_if()`.
|
|
|
|
:param ifcond: A list of conditionals, passed to `start_if()`.
|
|
:param args: any number of `QAPIGenCCode`.
|
|
|
|
Example::
|
|
|
|
with ifcontext(ifcond, self._genh, self._genc):
|
|
modify self._genh and self._genc ...
|
|
|
|
Is equivalent to calling::
|
|
|
|
self._genh.start_if(ifcond)
|
|
self._genc.start_if(ifcond)
|
|
modify self._genh and self._genc ...
|
|
self._genh.end_if()
|
|
self._genc.end_if()
|
|
"""
|
|
for arg in args:
|
|
arg.start_if(ifcond)
|
|
yield
|
|
for arg in args:
|
|
arg.end_if()
|
|
|
|
|
|
class QAPISchemaMonolithicCVisitor(QAPISchemaVisitor):
|
|
def __init__(self,
|
|
prefix: str,
|
|
what: str,
|
|
blurb: str,
|
|
pydoc: str):
|
|
self._prefix = prefix
|
|
self._what = what
|
|
self._genc = QAPIGenC(self._prefix + self._what + '.c',
|
|
blurb, pydoc)
|
|
self._genh = QAPIGenH(self._prefix + self._what + '.h',
|
|
blurb, pydoc)
|
|
|
|
def write(self, output_dir: str) -> None:
|
|
self._genc.write(output_dir)
|
|
self._genh.write(output_dir)
|
|
|
|
|
|
class QAPISchemaModularCVisitor(QAPISchemaVisitor):
|
|
def __init__(self,
|
|
prefix: str,
|
|
what: str,
|
|
user_blurb: str,
|
|
builtin_blurb: Optional[str],
|
|
pydoc: str):
|
|
self._prefix = prefix
|
|
self._what = what
|
|
self._user_blurb = user_blurb
|
|
self._builtin_blurb = builtin_blurb
|
|
self._pydoc = pydoc
|
|
self._genc: Optional[QAPIGenC] = None
|
|
self._genh: Optional[QAPIGenH] = None
|
|
self._module: Dict[Optional[str], Tuple[QAPIGenC, QAPIGenH]] = {}
|
|
self._main_module: Optional[str] = None
|
|
|
|
@staticmethod
|
|
def _is_user_module(name: Optional[str]) -> bool:
|
|
return bool(name and not name.startswith('./'))
|
|
|
|
@staticmethod
|
|
def _is_builtin_module(name: Optional[str]) -> bool:
|
|
return not name
|
|
|
|
def _module_dirname(self, name: Optional[str]) -> str:
|
|
if self._is_user_module(name):
|
|
return os.path.dirname(name)
|
|
return ''
|
|
|
|
def _module_basename(self, what: str, name: Optional[str]) -> str:
|
|
ret = '' if self._is_builtin_module(name) else self._prefix
|
|
if self._is_user_module(name):
|
|
basename = os.path.basename(name)
|
|
ret += what
|
|
if name != self._main_module:
|
|
ret += '-' + os.path.splitext(basename)[0]
|
|
else:
|
|
name = name[2:] if name else 'builtin'
|
|
ret += re.sub(r'-', '-' + name + '-', what)
|
|
return ret
|
|
|
|
def _module_filename(self, what: str, name: Optional[str]) -> str:
|
|
return os.path.join(self._module_dirname(name),
|
|
self._module_basename(what, name))
|
|
|
|
def _add_module(self, name: Optional[str], blurb: str) -> None:
|
|
basename = self._module_filename(self._what, name)
|
|
genc = QAPIGenC(basename + '.c', blurb, self._pydoc)
|
|
genh = QAPIGenH(basename + '.h', blurb, self._pydoc)
|
|
self._module[name] = (genc, genh)
|
|
self._genc, self._genh = self._module[name]
|
|
|
|
def _add_user_module(self, name: str, blurb: str) -> None:
|
|
assert self._is_user_module(name)
|
|
if self._main_module is None:
|
|
self._main_module = name
|
|
self._add_module(name, blurb)
|
|
|
|
def _add_system_module(self, name: Optional[str], blurb: str) -> None:
|
|
self._add_module(name and './' + name, blurb)
|
|
|
|
def write(self, output_dir: str, opt_builtins: bool = False) -> None:
|
|
for name in self._module:
|
|
if self._is_builtin_module(name) and not opt_builtins:
|
|
continue
|
|
(genc, genh) = self._module[name]
|
|
genc.write(output_dir)
|
|
genh.write(output_dir)
|
|
|
|
def _begin_system_module(self, name: None) -> None:
|
|
pass
|
|
|
|
def _begin_user_module(self, name: str) -> None:
|
|
pass
|
|
|
|
def visit_module(self, name: Optional[str]) -> None:
|
|
if name is None:
|
|
if self._builtin_blurb:
|
|
self._add_system_module(None, self._builtin_blurb)
|
|
self._begin_system_module(name)
|
|
else:
|
|
# The built-in module has not been created. No code may
|
|
# be generated.
|
|
self._genc = None
|
|
self._genh = None
|
|
else:
|
|
self._add_user_module(name, self._user_blurb)
|
|
self._begin_user_module(name)
|
|
|
|
def visit_include(self, name: str, info: QAPISourceInfo) -> None:
|
|
relname = os.path.relpath(self._module_filename(self._what, name),
|
|
os.path.dirname(self._genh.fname))
|
|
self._genh.preamble_add(mcgen('''
|
|
#include "%(relname)s.h"
|
|
''',
|
|
relname=relname))
|