qapi.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  1. #
  2. # QAPI helper library
  3. #
  4. # Copyright IBM, Corp. 2011
  5. # Copyright (c) 2013 Red Hat Inc.
  6. #
  7. # Authors:
  8. # Anthony Liguori <aliguori@us.ibm.com>
  9. # Markus Armbruster <armbru@redhat.com>
  10. #
  11. # This work is licensed under the terms of the GNU GPL, version 2.
  12. # See the COPYING file in the top-level directory.
  13. from ordereddict import OrderedDict
  14. import sys
  15. builtin_types = [
  16. 'str', 'int', 'number', 'bool',
  17. 'int8', 'int16', 'int32', 'int64',
  18. 'uint8', 'uint16', 'uint32', 'uint64'
  19. ]
  20. builtin_type_qtypes = {
  21. 'str': 'QTYPE_QSTRING',
  22. 'int': 'QTYPE_QINT',
  23. 'number': 'QTYPE_QFLOAT',
  24. 'bool': 'QTYPE_QBOOL',
  25. 'int8': 'QTYPE_QINT',
  26. 'int16': 'QTYPE_QINT',
  27. 'int32': 'QTYPE_QINT',
  28. 'int64': 'QTYPE_QINT',
  29. 'uint8': 'QTYPE_QINT',
  30. 'uint16': 'QTYPE_QINT',
  31. 'uint32': 'QTYPE_QINT',
  32. 'uint64': 'QTYPE_QINT',
  33. }
  34. class QAPISchemaError(Exception):
  35. def __init__(self, schema, msg):
  36. self.fp = schema.fp
  37. self.msg = msg
  38. self.col = 1
  39. self.line = schema.line
  40. for ch in schema.src[schema.line_pos:schema.pos]:
  41. if ch == '\t':
  42. self.col = (self.col + 7) % 8 + 1
  43. else:
  44. self.col += 1
  45. def __str__(self):
  46. return "%s:%s:%s: %s" % (self.fp.name, self.line, self.col, self.msg)
  47. class QAPISchema:
  48. def __init__(self, fp):
  49. self.fp = fp
  50. self.src = fp.read()
  51. if self.src == '' or self.src[-1] != '\n':
  52. self.src += '\n'
  53. self.cursor = 0
  54. self.line = 1
  55. self.line_pos = 0
  56. self.exprs = []
  57. self.accept()
  58. while self.tok != None:
  59. self.exprs.append(self.get_expr(False))
  60. def accept(self):
  61. while True:
  62. self.tok = self.src[self.cursor]
  63. self.pos = self.cursor
  64. self.cursor += 1
  65. self.val = None
  66. if self.tok == '#':
  67. self.cursor = self.src.find('\n', self.cursor)
  68. elif self.tok in ['{', '}', ':', ',', '[', ']']:
  69. return
  70. elif self.tok == "'":
  71. string = ''
  72. esc = False
  73. while True:
  74. ch = self.src[self.cursor]
  75. self.cursor += 1
  76. if ch == '\n':
  77. raise QAPISchemaError(self,
  78. 'Missing terminating "\'"')
  79. if esc:
  80. string += ch
  81. esc = False
  82. elif ch == "\\":
  83. esc = True
  84. elif ch == "'":
  85. self.val = string
  86. return
  87. else:
  88. string += ch
  89. elif self.tok == '\n':
  90. if self.cursor == len(self.src):
  91. self.tok = None
  92. return
  93. self.line += 1
  94. self.line_pos = self.cursor
  95. elif not self.tok.isspace():
  96. raise QAPISchemaError(self, 'Stray "%s"' % self.tok)
  97. def get_members(self):
  98. expr = OrderedDict()
  99. if self.tok == '}':
  100. self.accept()
  101. return expr
  102. if self.tok != "'":
  103. raise QAPISchemaError(self, 'Expected string or "}"')
  104. while True:
  105. key = self.val
  106. self.accept()
  107. if self.tok != ':':
  108. raise QAPISchemaError(self, 'Expected ":"')
  109. self.accept()
  110. if key in expr:
  111. raise QAPISchemaError(self, 'Duplicate key "%s"' % key)
  112. expr[key] = self.get_expr(True)
  113. if self.tok == '}':
  114. self.accept()
  115. return expr
  116. if self.tok != ',':
  117. raise QAPISchemaError(self, 'Expected "," or "}"')
  118. self.accept()
  119. if self.tok != "'":
  120. raise QAPISchemaError(self, 'Expected string')
  121. def get_values(self):
  122. expr = []
  123. if self.tok == ']':
  124. self.accept()
  125. return expr
  126. if not self.tok in [ '{', '[', "'" ]:
  127. raise QAPISchemaError(self, 'Expected "{", "[", "]" or string')
  128. while True:
  129. expr.append(self.get_expr(True))
  130. if self.tok == ']':
  131. self.accept()
  132. return expr
  133. if self.tok != ',':
  134. raise QAPISchemaError(self, 'Expected "," or "]"')
  135. self.accept()
  136. def get_expr(self, nested):
  137. if self.tok != '{' and not nested:
  138. raise QAPISchemaError(self, 'Expected "{"')
  139. if self.tok == '{':
  140. self.accept()
  141. expr = self.get_members()
  142. elif self.tok == '[':
  143. self.accept()
  144. expr = self.get_values()
  145. elif self.tok == "'":
  146. expr = self.val
  147. self.accept()
  148. else:
  149. raise QAPISchemaError(self, 'Expected "{", "[" or string')
  150. return expr
  151. def parse_schema(fp):
  152. try:
  153. schema = QAPISchema(fp)
  154. except QAPISchemaError, e:
  155. print >>sys.stderr, e
  156. exit(1)
  157. exprs = []
  158. for expr in schema.exprs:
  159. if expr.has_key('enum'):
  160. add_enum(expr['enum'], expr['data'])
  161. elif expr.has_key('union'):
  162. add_union(expr)
  163. add_enum('%sKind' % expr['union'])
  164. elif expr.has_key('type'):
  165. add_struct(expr)
  166. exprs.append(expr)
  167. return exprs
  168. def parse_args(typeinfo):
  169. if isinstance(typeinfo, basestring):
  170. struct = find_struct(typeinfo)
  171. assert struct != None
  172. typeinfo = struct['data']
  173. for member in typeinfo:
  174. argname = member
  175. argentry = typeinfo[member]
  176. optional = False
  177. structured = False
  178. if member.startswith('*'):
  179. argname = member[1:]
  180. optional = True
  181. if isinstance(argentry, OrderedDict):
  182. structured = True
  183. yield (argname, argentry, optional, structured)
  184. def de_camel_case(name):
  185. new_name = ''
  186. for ch in name:
  187. if ch.isupper() and new_name:
  188. new_name += '_'
  189. if ch == '-':
  190. new_name += '_'
  191. else:
  192. new_name += ch.lower()
  193. return new_name
  194. def camel_case(name):
  195. new_name = ''
  196. first = True
  197. for ch in name:
  198. if ch in ['_', '-']:
  199. first = True
  200. elif first:
  201. new_name += ch.upper()
  202. first = False
  203. else:
  204. new_name += ch.lower()
  205. return new_name
  206. def c_var(name, protect=True):
  207. # ANSI X3J11/88-090, 3.1.1
  208. c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue',
  209. 'default', 'do', 'double', 'else', 'enum', 'extern', 'float',
  210. 'for', 'goto', 'if', 'int', 'long', 'register', 'return',
  211. 'short', 'signed', 'sizeof', 'static', 'struct', 'switch',
  212. 'typedef', 'union', 'unsigned', 'void', 'volatile', 'while'])
  213. # ISO/IEC 9899:1999, 6.4.1
  214. c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
  215. # ISO/IEC 9899:2011, 6.4.1
  216. c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn',
  217. '_Static_assert', '_Thread_local'])
  218. # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
  219. # excluding _.*
  220. gcc_words = set(['asm', 'typeof'])
  221. # C++ ISO/IEC 14882:2003 2.11
  222. cpp_words = set(['bool', 'catch', 'class', 'const_cast', 'delete',
  223. 'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
  224. 'namespace', 'new', 'operator', 'private', 'protected',
  225. 'public', 'reinterpret_cast', 'static_cast', 'template',
  226. 'this', 'throw', 'true', 'try', 'typeid', 'typename',
  227. 'using', 'virtual', 'wchar_t',
  228. # alternative representations
  229. 'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
  230. 'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
  231. # namespace pollution:
  232. polluted_words = set(['unix', 'errno'])
  233. if protect and (name in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words):
  234. return "q_" + name
  235. return name.replace('-', '_').lstrip("*")
  236. def c_fun(name, protect=True):
  237. return c_var(name, protect).replace('.', '_')
  238. def c_list_type(name):
  239. return '%sList' % name
  240. def type_name(name):
  241. if type(name) == list:
  242. return c_list_type(name[0])
  243. return name
  244. enum_types = []
  245. struct_types = []
  246. union_types = []
  247. def add_struct(definition):
  248. global struct_types
  249. struct_types.append(definition)
  250. def find_struct(name):
  251. global struct_types
  252. for struct in struct_types:
  253. if struct['type'] == name:
  254. return struct
  255. return None
  256. def add_union(definition):
  257. global union_types
  258. union_types.append(definition)
  259. def find_union(name):
  260. global union_types
  261. for union in union_types:
  262. if union['union'] == name:
  263. return union
  264. return None
  265. def add_enum(name, enum_values = None):
  266. global enum_types
  267. enum_types.append({"enum_name": name, "enum_values": enum_values})
  268. def find_enum(name):
  269. global enum_types
  270. for enum in enum_types:
  271. if enum['enum_name'] == name:
  272. return enum
  273. return None
  274. def is_enum(name):
  275. return find_enum(name) != None
  276. def c_type(name):
  277. if name == 'str':
  278. return 'char *'
  279. elif name == 'int':
  280. return 'int64_t'
  281. elif (name == 'int8' or name == 'int16' or name == 'int32' or
  282. name == 'int64' or name == 'uint8' or name == 'uint16' or
  283. name == 'uint32' or name == 'uint64'):
  284. return name + '_t'
  285. elif name == 'size':
  286. return 'uint64_t'
  287. elif name == 'bool':
  288. return 'bool'
  289. elif name == 'number':
  290. return 'double'
  291. elif type(name) == list:
  292. return '%s *' % c_list_type(name[0])
  293. elif is_enum(name):
  294. return name
  295. elif name == None or len(name) == 0:
  296. return 'void'
  297. elif name == name.upper():
  298. return '%sEvent *' % camel_case(name)
  299. else:
  300. return '%s *' % name
  301. def genindent(count):
  302. ret = ""
  303. for i in range(count):
  304. ret += " "
  305. return ret
  306. indent_level = 0
  307. def push_indent(indent_amount=4):
  308. global indent_level
  309. indent_level += indent_amount
  310. def pop_indent(indent_amount=4):
  311. global indent_level
  312. indent_level -= indent_amount
  313. def cgen(code, **kwds):
  314. indent = genindent(indent_level)
  315. lines = code.split('\n')
  316. lines = map(lambda x: indent + x, lines)
  317. return '\n'.join(lines) % kwds + '\n'
  318. def mcgen(code, **kwds):
  319. return cgen('\n'.join(code.split('\n')[1:-1]), **kwds)
  320. def basename(filename):
  321. return filename.split("/")[-1]
  322. def guardname(filename):
  323. guard = basename(filename).rsplit(".", 1)[0]
  324. for substr in [".", " ", "-"]:
  325. guard = guard.replace(substr, "_")
  326. return guard.upper() + '_H'
  327. def guardstart(name):
  328. return mcgen('''
  329. #ifndef %(name)s
  330. #define %(name)s
  331. ''',
  332. name=guardname(name))
  333. def guardend(name):
  334. return mcgen('''
  335. #endif /* %(name)s */
  336. ''',
  337. name=guardname(name))