event_rpcgen.py 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717
  1. #!/usr/bin/env python2
  2. #
  3. # Copyright (c) 2005-2007 Niels Provos <provos@citi.umich.edu>
  4. # Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
  5. # All rights reserved.
  6. #
  7. # Generates marshaling code based on libevent.
  8. # TODO:
  9. # 1) use optparse to allow the strategy shell to parse options, and
  10. # to allow the instantiated factory (for the specific output language)
  11. # to parse remaining options
  12. # 2) move the globals into a class that manages execution (including the
  13. # progress outputs that space stderr at the moment)
  14. # 3) emit other languages
  15. import sys
  16. import re
  17. _NAME = "event_rpcgen.py"
  18. _VERSION = "0.1"
  19. # Globals
  20. line_count = 0
  21. white = re.compile(r'\s+')
  22. cppcomment = re.compile(r'\/\/.*$')
  23. nonident = re.compile(r'[^a-zA-Z0-9_]')
  24. structref = re.compile(r'^struct\[([a-zA-Z_][a-zA-Z0-9_]*)\]$')
  25. structdef = re.compile(r'^struct +[a-zA-Z_][a-zA-Z0-9_]* *{$')
  26. headerdirect = []
  27. cppdirect = []
  28. def TranslateList(mylist, mydict):
  29. return map(lambda x: x % mydict, mylist)
  30. # Exception class for parse errors
  31. class RpcGenError(Exception):
  32. def __init__(self, why):
  33. self.why = why
  34. def __str__(self):
  35. return str(self.why)
  36. # Holds everything that makes a struct
  37. class Struct:
  38. def __init__(self, name):
  39. self._name = name
  40. self._entries = []
  41. self._tags = {}
  42. print >>sys.stderr, ' Created struct: %s' % name
  43. def AddEntry(self, entry):
  44. if self._tags.has_key(entry.Tag()):
  45. raise RpcGenError(
  46. 'Entry "%s" duplicates tag number %d from "%s" '
  47. 'around line %d' % (entry.Name(), entry.Tag(),
  48. self._tags[entry.Tag()], line_count))
  49. self._entries.append(entry)
  50. self._tags[entry.Tag()] = entry.Name()
  51. print >>sys.stderr, ' Added entry: %s' % entry.Name()
  52. def Name(self):
  53. return self._name
  54. def EntryTagName(self, entry):
  55. """Creates the name inside an enumeration for distinguishing data
  56. types."""
  57. name = "%s_%s" % (self._name, entry.Name())
  58. return name.upper()
  59. def PrintIndented(self, file, ident, code):
  60. """Takes an array, add indentation to each entry and prints it."""
  61. for entry in code:
  62. print >>file, '%s%s' % (ident, entry)
  63. class StructCCode(Struct):
  64. """ Knows how to generate C code for a struct """
  65. def __init__(self, name):
  66. Struct.__init__(self, name)
  67. def PrintTags(self, file):
  68. """Prints the tag definitions for a structure."""
  69. print >>file, '/* Tag definition for %s */' % self._name
  70. print >>file, 'enum %s_ {' % self._name.lower()
  71. for entry in self._entries:
  72. print >>file, ' %s=%d,' % (self.EntryTagName(entry),
  73. entry.Tag())
  74. print >>file, ' %s_MAX_TAGS' % (self._name.upper())
  75. print >>file, '};\n'
  76. def PrintForwardDeclaration(self, file):
  77. print >>file, 'struct %s;' % self._name
  78. def PrintDeclaration(self, file):
  79. print >>file, '/* Structure declaration for %s */' % self._name
  80. print >>file, 'struct %s_access_ {' % self._name
  81. for entry in self._entries:
  82. dcl = entry.AssignDeclaration('(*%s_assign)' % entry.Name())
  83. dcl.extend(
  84. entry.GetDeclaration('(*%s_get)' % entry.Name()))
  85. if entry.Array():
  86. dcl.extend(
  87. entry.AddDeclaration('(*%s_add)' % entry.Name()))
  88. self.PrintIndented(file, ' ', dcl)
  89. print >>file, '};\n'
  90. print >>file, 'struct %s {' % self._name
  91. print >>file, ' struct %s_access_ *base;\n' % self._name
  92. for entry in self._entries:
  93. dcl = entry.Declaration()
  94. self.PrintIndented(file, ' ', dcl)
  95. print >>file, ''
  96. for entry in self._entries:
  97. print >>file, ' ev_uint8_t %s_set;' % entry.Name()
  98. print >>file, '};\n'
  99. print >>file, \
  100. """struct %(name)s *%(name)s_new(void);
  101. struct %(name)s *%(name)s_new_with_arg(void *);
  102. void %(name)s_free(struct %(name)s *);
  103. void %(name)s_clear(struct %(name)s *);
  104. void %(name)s_marshal(struct evbuffer *, const struct %(name)s *);
  105. int %(name)s_unmarshal(struct %(name)s *, struct evbuffer *);
  106. int %(name)s_complete(struct %(name)s *);
  107. void evtag_marshal_%(name)s(struct evbuffer *, ev_uint32_t,
  108. const struct %(name)s *);
  109. int evtag_unmarshal_%(name)s(struct evbuffer *, ev_uint32_t,
  110. struct %(name)s *);""" % { 'name' : self._name }
  111. # Write a setting function of every variable
  112. for entry in self._entries:
  113. self.PrintIndented(file, '', entry.AssignDeclaration(
  114. entry.AssignFuncName()))
  115. self.PrintIndented(file, '', entry.GetDeclaration(
  116. entry.GetFuncName()))
  117. if entry.Array():
  118. self.PrintIndented(file, '', entry.AddDeclaration(
  119. entry.AddFuncName()))
  120. print >>file, '/* --- %s done --- */\n' % self._name
  121. def PrintCode(self, file):
  122. print >>file, ('/*\n'
  123. ' * Implementation of %s\n'
  124. ' */\n') % self._name
  125. print >>file, \
  126. 'static struct %(name)s_access_ __%(name)s_base = {' % \
  127. { 'name' : self._name }
  128. for entry in self._entries:
  129. self.PrintIndented(file, ' ', entry.CodeBase())
  130. print >>file, '};\n'
  131. # Creation
  132. print >>file, (
  133. 'struct %(name)s *\n'
  134. '%(name)s_new(void)\n'
  135. '{\n'
  136. ' return %(name)s_new_with_arg(NULL);\n'
  137. '}\n'
  138. '\n'
  139. 'struct %(name)s *\n'
  140. '%(name)s_new_with_arg(void *unused)\n'
  141. '{\n'
  142. ' struct %(name)s *tmp;\n'
  143. ' if ((tmp = malloc(sizeof(struct %(name)s))) == NULL) {\n'
  144. ' event_warn("%%s: malloc", __func__);\n'
  145. ' return (NULL);\n'
  146. ' }\n'
  147. ' tmp->base = &__%(name)s_base;\n') % { 'name' : self._name }
  148. for entry in self._entries:
  149. self.PrintIndented(file, ' ', entry.CodeInitialize('tmp'))
  150. print >>file, ' tmp->%s_set = 0;\n' % entry.Name()
  151. print >>file, (
  152. ' return (tmp);\n'
  153. '}\n')
  154. # Adding
  155. for entry in self._entries:
  156. if entry.Array():
  157. self.PrintIndented(file, '', entry.CodeAdd())
  158. print >>file, ''
  159. # Assigning
  160. for entry in self._entries:
  161. self.PrintIndented(file, '', entry.CodeAssign())
  162. print >>file, ''
  163. # Getting
  164. for entry in self._entries:
  165. self.PrintIndented(file, '', entry.CodeGet())
  166. print >>file, ''
  167. # Clearing
  168. print >>file, ( 'void\n'
  169. '%(name)s_clear(struct %(name)s *tmp)\n'
  170. '{'
  171. ) % { 'name' : self._name }
  172. for entry in self._entries:
  173. self.PrintIndented(file, ' ', entry.CodeClear('tmp'))
  174. print >>file, '}\n'
  175. # Freeing
  176. print >>file, ( 'void\n'
  177. '%(name)s_free(struct %(name)s *tmp)\n'
  178. '{'
  179. ) % { 'name' : self._name }
  180. for entry in self._entries:
  181. self.PrintIndented(file, ' ', entry.CodeFree('tmp'))
  182. print >>file, (' free(tmp);\n'
  183. '}\n')
  184. # Marshaling
  185. print >>file, ('void\n'
  186. '%(name)s_marshal(struct evbuffer *evbuf, '
  187. 'const struct %(name)s *tmp)'
  188. '{') % { 'name' : self._name }
  189. for entry in self._entries:
  190. indent = ' '
  191. # Optional entries do not have to be set
  192. if entry.Optional():
  193. indent += ' '
  194. print >>file, ' if (tmp->%s_set) {' % entry.Name()
  195. self.PrintIndented(
  196. file, indent,
  197. entry.CodeMarshal('evbuf', self.EntryTagName(entry),
  198. entry.GetVarName('tmp'),
  199. entry.GetVarLen('tmp')))
  200. if entry.Optional():
  201. print >>file, ' }'
  202. print >>file, '}\n'
  203. # Unmarshaling
  204. print >>file, ('int\n'
  205. '%(name)s_unmarshal(struct %(name)s *tmp, '
  206. ' struct evbuffer *evbuf)\n'
  207. '{\n'
  208. ' ev_uint32_t tag;\n'
  209. ' while (evbuffer_get_length(evbuf) > 0) {\n'
  210. ' if (evtag_peek(evbuf, &tag) == -1)\n'
  211. ' return (-1);\n'
  212. ' switch (tag) {\n'
  213. ) % { 'name' : self._name }
  214. for entry in self._entries:
  215. print >>file, ' case %s:\n' % self.EntryTagName(entry)
  216. if not entry.Array():
  217. print >>file, (
  218. ' if (tmp->%s_set)\n'
  219. ' return (-1);'
  220. ) % (entry.Name())
  221. self.PrintIndented(
  222. file, ' ',
  223. entry.CodeUnmarshal('evbuf',
  224. self.EntryTagName(entry),
  225. entry.GetVarName('tmp'),
  226. entry.GetVarLen('tmp')))
  227. print >>file, ( ' tmp->%s_set = 1;\n' % entry.Name() +
  228. ' break;\n' )
  229. print >>file, ( ' default:\n'
  230. ' return -1;\n'
  231. ' }\n'
  232. ' }\n' )
  233. # Check if it was decoded completely
  234. print >>file, ( ' if (%(name)s_complete(tmp) == -1)\n'
  235. ' return (-1);'
  236. ) % { 'name' : self._name }
  237. # Successfully decoded
  238. print >>file, ( ' return (0);\n'
  239. '}\n')
  240. # Checking if a structure has all the required data
  241. print >>file, (
  242. 'int\n'
  243. '%(name)s_complete(struct %(name)s *msg)\n'
  244. '{' ) % { 'name' : self._name }
  245. for entry in self._entries:
  246. if not entry.Optional():
  247. code = [
  248. 'if (!msg->%(name)s_set)',
  249. ' return (-1);' ]
  250. code = TranslateList(code, entry.GetTranslation())
  251. self.PrintIndented(
  252. file, ' ', code)
  253. self.PrintIndented(
  254. file, ' ',
  255. entry.CodeComplete('msg', entry.GetVarName('msg')))
  256. print >>file, (
  257. ' return (0);\n'
  258. '}\n' )
  259. # Complete message unmarshaling
  260. print >>file, (
  261. 'int\n'
  262. 'evtag_unmarshal_%(name)s(struct evbuffer *evbuf, '
  263. 'ev_uint32_t need_tag, struct %(name)s *msg)\n'
  264. '{\n'
  265. ' ev_uint32_t tag;\n'
  266. ' int res = -1;\n'
  267. '\n'
  268. ' struct evbuffer *tmp = evbuffer_new();\n'
  269. '\n'
  270. ' if (evtag_unmarshal(evbuf, &tag, tmp) == -1'
  271. ' || tag != need_tag)\n'
  272. ' goto error;\n'
  273. '\n'
  274. ' if (%(name)s_unmarshal(msg, tmp) == -1)\n'
  275. ' goto error;\n'
  276. '\n'
  277. ' res = 0;\n'
  278. '\n'
  279. ' error:\n'
  280. ' evbuffer_free(tmp);\n'
  281. ' return (res);\n'
  282. '}\n' ) % { 'name' : self._name }
  283. # Complete message marshaling
  284. print >>file, (
  285. 'void\n'
  286. 'evtag_marshal_%(name)s(struct evbuffer *evbuf, ev_uint32_t tag, '
  287. 'const struct %(name)s *msg)\n'
  288. '{\n'
  289. ' struct evbuffer *_buf = evbuffer_new();\n'
  290. ' assert(_buf != NULL);\n'
  291. ' %(name)s_marshal(_buf, msg);\n'
  292. ' evtag_marshal_buffer(evbuf, tag, _buf);\n '
  293. ' evbuffer_free(_buf);\n'
  294. '}\n' ) % { 'name' : self._name }
  295. class Entry:
  296. def __init__(self, type, name, tag):
  297. self._type = type
  298. self._name = name
  299. self._tag = int(tag)
  300. self._ctype = type
  301. self._optional = 0
  302. self._can_be_array = 0
  303. self._array = 0
  304. self._line_count = -1
  305. self._struct = None
  306. self._refname = None
  307. self._optpointer = True
  308. self._optaddarg = True
  309. def GetInitializer(self):
  310. assert 0, "Entry does not provide initializer"
  311. def SetStruct(self, struct):
  312. self._struct = struct
  313. def LineCount(self):
  314. assert self._line_count != -1
  315. return self._line_count
  316. def SetLineCount(self, number):
  317. self._line_count = number
  318. def Array(self):
  319. return self._array
  320. def Optional(self):
  321. return self._optional
  322. def Tag(self):
  323. return self._tag
  324. def Name(self):
  325. return self._name
  326. def Type(self):
  327. return self._type
  328. def MakeArray(self, yes=1):
  329. self._array = yes
  330. def MakeOptional(self):
  331. self._optional = 1
  332. def Verify(self):
  333. if self.Array() and not self._can_be_array:
  334. raise RpcGenError(
  335. 'Entry "%s" cannot be created as an array '
  336. 'around line %d' % (self._name, self.LineCount()))
  337. if not self._struct:
  338. raise RpcGenError(
  339. 'Entry "%s" does not know which struct it belongs to '
  340. 'around line %d' % (self._name, self.LineCount()))
  341. if self._optional and self._array:
  342. raise RpcGenError(
  343. 'Entry "%s" has illegal combination of optional and array '
  344. 'around line %d' % (self._name, self.LineCount()))
  345. def GetTranslation(self, extradict = {}):
  346. mapping = {
  347. "parent_name" : self._struct.Name(),
  348. "name" : self._name,
  349. "ctype" : self._ctype,
  350. "refname" : self._refname,
  351. "optpointer" : self._optpointer and "*" or "",
  352. "optreference" : self._optpointer and "&" or "",
  353. "optaddarg" :
  354. self._optaddarg and ", const %s value" % self._ctype or ""
  355. }
  356. for (k, v) in extradict.items():
  357. mapping[k] = v
  358. return mapping
  359. def GetVarName(self, var):
  360. return '%(var)s->%(name)s_data' % self.GetTranslation({ 'var' : var })
  361. def GetVarLen(self, var):
  362. return 'sizeof(%s)' % self._ctype
  363. def GetFuncName(self):
  364. return '%s_%s_get' % (self._struct.Name(), self._name)
  365. def GetDeclaration(self, funcname):
  366. code = [ 'int %s(struct %s *, %s *);' % (
  367. funcname, self._struct.Name(), self._ctype ) ]
  368. return code
  369. def CodeGet(self):
  370. code = (
  371. 'int',
  372. '%(parent_name)s_%(name)s_get(struct %(parent_name)s *msg, '
  373. '%(ctype)s *value)',
  374. '{',
  375. ' if (msg->%(name)s_set != 1)',
  376. ' return (-1);',
  377. ' *value = msg->%(name)s_data;',
  378. ' return (0);',
  379. '}' )
  380. code = '\n'.join(code)
  381. code = code % self.GetTranslation()
  382. return code.split('\n')
  383. def AssignFuncName(self):
  384. return '%s_%s_assign' % (self._struct.Name(), self._name)
  385. def AddFuncName(self):
  386. return '%s_%s_add' % (self._struct.Name(), self._name)
  387. def AssignDeclaration(self, funcname):
  388. code = [ 'int %s(struct %s *, const %s);' % (
  389. funcname, self._struct.Name(), self._ctype ) ]
  390. return code
  391. def CodeAssign(self):
  392. code = [ 'int',
  393. '%(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg,'
  394. ' const %(ctype)s value)',
  395. '{',
  396. ' msg->%(name)s_set = 1;',
  397. ' msg->%(name)s_data = value;',
  398. ' return (0);',
  399. '}' ]
  400. code = '\n'.join(code)
  401. code = code % self.GetTranslation()
  402. return code.split('\n')
  403. def CodeClear(self, structname):
  404. code = [ '%s->%s_set = 0;' % (structname, self.Name()) ]
  405. return code
  406. def CodeComplete(self, structname, var_name):
  407. return []
  408. def CodeFree(self, name):
  409. return []
  410. def CodeBase(self):
  411. code = [
  412. '%(parent_name)s_%(name)s_assign,',
  413. '%(parent_name)s_%(name)s_get,'
  414. ]
  415. if self.Array():
  416. code.append('%(parent_name)s_%(name)s_add,')
  417. code = '\n'.join(code)
  418. code = code % self.GetTranslation()
  419. return code.split('\n')
  420. class EntryBytes(Entry):
  421. def __init__(self, type, name, tag, length):
  422. # Init base class
  423. Entry.__init__(self, type, name, tag)
  424. self._length = length
  425. self._ctype = 'ev_uint8_t'
  426. def GetInitializer(self):
  427. return "NULL"
  428. def GetVarLen(self, var):
  429. return '(%s)' % self._length
  430. def CodeArrayAdd(self, varname, value):
  431. # XXX: copy here
  432. return [ '%(varname)s = NULL;' % { 'varname' : varname } ]
  433. def GetDeclaration(self, funcname):
  434. code = [ 'int %s(struct %s *, %s **);' % (
  435. funcname, self._struct.Name(), self._ctype ) ]
  436. return code
  437. def AssignDeclaration(self, funcname):
  438. code = [ 'int %s(struct %s *, const %s *);' % (
  439. funcname, self._struct.Name(), self._ctype ) ]
  440. return code
  441. def Declaration(self):
  442. dcl = ['ev_uint8_t %s_data[%s];' % (self._name, self._length)]
  443. return dcl
  444. def CodeGet(self):
  445. name = self._name
  446. code = [ 'int',
  447. '%s_%s_get(struct %s *msg, %s **value)' % (
  448. self._struct.Name(), name,
  449. self._struct.Name(), self._ctype),
  450. '{',
  451. ' if (msg->%s_set != 1)' % name,
  452. ' return (-1);',
  453. ' *value = msg->%s_data;' % name,
  454. ' return (0);',
  455. '}' ]
  456. return code
  457. def CodeAssign(self):
  458. name = self._name
  459. code = [ 'int',
  460. '%s_%s_assign(struct %s *msg, const %s *value)' % (
  461. self._struct.Name(), name,
  462. self._struct.Name(), self._ctype),
  463. '{',
  464. ' msg->%s_set = 1;' % name,
  465. ' memcpy(msg->%s_data, value, %s);' % (
  466. name, self._length),
  467. ' return (0);',
  468. '}' ]
  469. return code
  470. def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
  471. code = [ 'if (evtag_unmarshal_fixed(%(buf)s, %(tag)s, '
  472. '%(var)s, %(varlen)s) == -1) {',
  473. ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
  474. ' return (-1);',
  475. '}'
  476. ]
  477. return TranslateList(code,
  478. self.GetTranslation({
  479. 'var' : var_name,
  480. 'varlen' : var_len,
  481. 'buf' : buf,
  482. 'tag' : tag_name }))
  483. def CodeMarshal(self, buf, tag_name, var_name, var_len):
  484. code = ['evtag_marshal(%s, %s, %s, %s);' % (
  485. buf, tag_name, var_name, var_len)]
  486. return code
  487. def CodeClear(self, structname):
  488. code = [ '%s->%s_set = 0;' % (structname, self.Name()),
  489. 'memset(%s->%s_data, 0, sizeof(%s->%s_data));' % (
  490. structname, self._name, structname, self._name)]
  491. return code
  492. def CodeInitialize(self, name):
  493. code = ['memset(%s->%s_data, 0, sizeof(%s->%s_data));' % (
  494. name, self._name, name, self._name)]
  495. return code
  496. def Verify(self):
  497. if not self._length:
  498. raise RpcGenError(
  499. 'Entry "%s" needs a length '
  500. 'around line %d' % (self._name, self.LineCount()))
  501. Entry.Verify(self)
  502. class EntryInt(Entry):
  503. def __init__(self, type, name, tag, bits=32):
  504. # Init base class
  505. Entry.__init__(self, type, name, tag)
  506. self._can_be_array = 1
  507. if bits == 32:
  508. self._ctype = 'ev_uint32_t'
  509. self._marshal_type = 'int'
  510. if bits == 64:
  511. self._ctype = 'ev_uint64_t'
  512. self._marshal_type = 'int64'
  513. def GetInitializer(self):
  514. return "0"
  515. def CodeArrayFree(self, var):
  516. return []
  517. def CodeArrayAssign(self, varname, srcvar):
  518. return [ '%(varname)s = %(srcvar)s;' % { 'varname' : varname,
  519. 'srcvar' : srcvar } ]
  520. def CodeArrayAdd(self, varname, value):
  521. """Returns a new entry of this type."""
  522. return [ '%(varname)s = %(value)s;' % { 'varname' : varname,
  523. 'value' : value } ]
  524. def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
  525. code = [
  526. 'if (evtag_unmarshal_%(ma)s(%(buf)s, %(tag)s, &%(var)s) == -1) {',
  527. ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
  528. ' return (-1);',
  529. '}' ]
  530. code = '\n'.join(code) % self.GetTranslation({
  531. 'ma' : self._marshal_type,
  532. 'buf' : buf,
  533. 'tag' : tag_name,
  534. 'var' : var_name })
  535. return code.split('\n')
  536. def CodeMarshal(self, buf, tag_name, var_name, var_len):
  537. code = [
  538. 'evtag_marshal_%s(%s, %s, %s);' % (
  539. self._marshal_type, buf, tag_name, var_name)]
  540. return code
  541. def Declaration(self):
  542. dcl = ['%s %s_data;' % (self._ctype, self._name)]
  543. return dcl
  544. def CodeInitialize(self, name):
  545. code = ['%s->%s_data = 0;' % (name, self._name)]
  546. return code
  547. class EntryString(Entry):
  548. def __init__(self, type, name, tag):
  549. # Init base class
  550. Entry.__init__(self, type, name, tag)
  551. self._can_be_array = 1
  552. self._ctype = 'char *'
  553. def GetInitializer(self):
  554. return "NULL"
  555. def CodeArrayFree(self, varname):
  556. code = [
  557. 'if (%(var)s != NULL) free(%(var)s);' ]
  558. return TranslateList(code, { 'var' : varname })
  559. def CodeArrayAssign(self, varname, srcvar):
  560. code = [
  561. 'if (%(var)s != NULL)',
  562. ' free(%(var)s);',
  563. '%(var)s = strdup(%(srcvar)s);',
  564. 'if (%(var)s == NULL) {',
  565. ' event_warnx("%%s: strdup", __func__);',
  566. ' return (-1);',
  567. '}' ]
  568. return TranslateList(code, { 'var' : varname,
  569. 'srcvar' : srcvar })
  570. def CodeArrayAdd(self, varname, value):
  571. code = [
  572. 'if (%(value)s != NULL) {',
  573. ' %(var)s = strdup(%(value)s);',
  574. ' if (%(var)s == NULL) {',
  575. ' goto error;',
  576. ' }',
  577. '} else {',
  578. ' %(var)s = NULL;',
  579. '}' ]
  580. return TranslateList(code, { 'var' : varname,
  581. 'value' : value })
  582. def GetVarLen(self, var):
  583. return 'strlen(%s)' % self.GetVarName(var)
  584. def CodeMakeInitalize(self, varname):
  585. return '%(varname)s = NULL;' % { 'varname' : varname }
  586. def CodeAssign(self):
  587. name = self._name
  588. code = """int
  589. %(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg,
  590. const %(ctype)s value)
  591. {
  592. if (msg->%(name)s_data != NULL)
  593. free(msg->%(name)s_data);
  594. if ((msg->%(name)s_data = strdup(value)) == NULL)
  595. return (-1);
  596. msg->%(name)s_set = 1;
  597. return (0);
  598. }""" % self.GetTranslation()
  599. return code.split('\n')
  600. def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
  601. code = ['if (evtag_unmarshal_string(%(buf)s, %(tag)s, &%(var)s) == -1) {',
  602. ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
  603. ' return (-1);',
  604. '}'
  605. ]
  606. code = '\n'.join(code) % self.GetTranslation({
  607. 'buf' : buf,
  608. 'tag' : tag_name,
  609. 'var' : var_name })
  610. return code.split('\n')
  611. def CodeMarshal(self, buf, tag_name, var_name, var_len):
  612. code = ['evtag_marshal_string(%s, %s, %s);' % (
  613. buf, tag_name, var_name)]
  614. return code
  615. def CodeClear(self, structname):
  616. code = [ 'if (%s->%s_set == 1) {' % (structname, self.Name()),
  617. ' free(%s->%s_data);' % (structname, self.Name()),
  618. ' %s->%s_data = NULL;' % (structname, self.Name()),
  619. ' %s->%s_set = 0;' % (structname, self.Name()),
  620. '}'
  621. ]
  622. return code
  623. def CodeInitialize(self, name):
  624. code = ['%s->%s_data = NULL;' % (name, self._name)]
  625. return code
  626. def CodeFree(self, name):
  627. code = ['if (%s->%s_data != NULL)' % (name, self._name),
  628. ' free (%s->%s_data);' % (name, self._name)]
  629. return code
  630. def Declaration(self):
  631. dcl = ['char *%s_data;' % self._name]
  632. return dcl
  633. class EntryStruct(Entry):
  634. def __init__(self, type, name, tag, refname):
  635. # Init base class
  636. Entry.__init__(self, type, name, tag)
  637. self._optpointer = False
  638. self._can_be_array = 1
  639. self._refname = refname
  640. self._ctype = 'struct %s*' % refname
  641. self._optaddarg = False
  642. def GetInitializer(self):
  643. return "NULL"
  644. def GetVarLen(self, var):
  645. return '-1'
  646. def CodeArrayAdd(self, varname, value):
  647. code = [
  648. '%(varname)s = %(refname)s_new();',
  649. 'if (%(varname)s == NULL)',
  650. ' goto error;' ]
  651. return TranslateList(code, self.GetTranslation({ 'varname' : varname }))
  652. def CodeArrayFree(self, var):
  653. code = [ '%(refname)s_free(%(var)s);' % self.GetTranslation(
  654. { 'var' : var }) ]
  655. return code
  656. def CodeArrayAssign(self, var, srcvar):
  657. code = [
  658. 'int had_error = 0;',
  659. 'struct evbuffer *tmp = NULL;',
  660. '%(refname)s_clear(%(var)s);',
  661. 'if ((tmp = evbuffer_new()) == NULL) {',
  662. ' event_warn("%%s: evbuffer_new()", __func__);',
  663. ' had_error = 1;',
  664. ' goto done;',
  665. '}',
  666. '%(refname)s_marshal(tmp, %(srcvar)s);',
  667. 'if (%(refname)s_unmarshal(%(var)s, tmp) == -1) {',
  668. ' event_warnx("%%s: %(refname)s_unmarshal", __func__);',
  669. ' had_error = 1;',
  670. ' goto done;',
  671. '}',
  672. 'done:'
  673. 'if (tmp != NULL)',
  674. ' evbuffer_free(tmp);',
  675. 'if (had_error) {',
  676. ' %(refname)s_clear(%(var)s);',
  677. ' return (-1);',
  678. '}' ]
  679. return TranslateList(code, self.GetTranslation({
  680. 'var' : var,
  681. 'srcvar' : srcvar}))
  682. def CodeGet(self):
  683. name = self._name
  684. code = [ 'int',
  685. '%s_%s_get(struct %s *msg, %s *value)' % (
  686. self._struct.Name(), name,
  687. self._struct.Name(), self._ctype),
  688. '{',
  689. ' if (msg->%s_set != 1) {' % name,
  690. ' msg->%s_data = %s_new();' % (name, self._refname),
  691. ' if (msg->%s_data == NULL)' % name,
  692. ' return (-1);',
  693. ' msg->%s_set = 1;' % name,
  694. ' }',
  695. ' *value = msg->%s_data;' % name,
  696. ' return (0);',
  697. '}' ]
  698. return code
  699. def CodeAssign(self):
  700. name = self._name
  701. code = """int
  702. %(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg,
  703. const %(ctype)s value)
  704. {
  705. struct evbuffer *tmp = NULL;
  706. if (msg->%(name)s_set) {
  707. %(refname)s_clear(msg->%(name)s_data);
  708. msg->%(name)s_set = 0;
  709. } else {
  710. msg->%(name)s_data = %(refname)s_new();
  711. if (msg->%(name)s_data == NULL) {
  712. event_warn("%%s: %(refname)s_new()", __func__);
  713. goto error;
  714. }
  715. }
  716. if ((tmp = evbuffer_new()) == NULL) {
  717. event_warn("%%s: evbuffer_new()", __func__);
  718. goto error;
  719. }
  720. %(refname)s_marshal(tmp, value);
  721. if (%(refname)s_unmarshal(msg->%(name)s_data, tmp) == -1) {
  722. event_warnx("%%s: %(refname)s_unmarshal", __func__);
  723. goto error;
  724. }
  725. msg->%(name)s_set = 1;
  726. evbuffer_free(tmp);
  727. return (0);
  728. error:
  729. if (tmp != NULL)
  730. evbuffer_free(tmp);
  731. if (msg->%(name)s_data != NULL) {
  732. %(refname)s_free(msg->%(name)s_data);
  733. msg->%(name)s_data = NULL;
  734. }
  735. return (-1);
  736. }""" % self.GetTranslation()
  737. return code.split('\n')
  738. def CodeComplete(self, structname, var_name):
  739. code = [ 'if (%(structname)s->%(name)s_set && '
  740. '%(refname)s_complete(%(var)s) == -1)',
  741. ' return (-1);' ]
  742. return TranslateList(code, self.GetTranslation({
  743. 'structname' : structname,
  744. 'var' : var_name }))
  745. def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
  746. code = ['%(var)s = %(refname)s_new();',
  747. 'if (%(var)s == NULL)',
  748. ' return (-1);',
  749. 'if (evtag_unmarshal_%(refname)s(%(buf)s, %(tag)s, '
  750. '%(var)s) == -1) {',
  751. ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
  752. ' return (-1);',
  753. '}'
  754. ]
  755. code = '\n'.join(code) % self.GetTranslation({
  756. 'buf' : buf,
  757. 'tag' : tag_name,
  758. 'var' : var_name })
  759. return code.split('\n')
  760. def CodeMarshal(self, buf, tag_name, var_name, var_len):
  761. code = ['evtag_marshal_%s(%s, %s, %s);' % (
  762. self._refname, buf, tag_name, var_name)]
  763. return code
  764. def CodeClear(self, structname):
  765. code = [ 'if (%s->%s_set == 1) {' % (structname, self.Name()),
  766. ' %s_free(%s->%s_data);' % (
  767. self._refname, structname, self.Name()),
  768. ' %s->%s_data = NULL;' % (structname, self.Name()),
  769. ' %s->%s_set = 0;' % (structname, self.Name()),
  770. '}'
  771. ]
  772. return code
  773. def CodeInitialize(self, name):
  774. code = ['%s->%s_data = NULL;' % (name, self._name)]
  775. return code
  776. def CodeFree(self, name):
  777. code = ['if (%s->%s_data != NULL)' % (name, self._name),
  778. ' %s_free(%s->%s_data);' % (
  779. self._refname, name, self._name)]
  780. return code
  781. def Declaration(self):
  782. dcl = ['%s %s_data;' % (self._ctype, self._name)]
  783. return dcl
  784. class EntryVarBytes(Entry):
  785. def __init__(self, type, name, tag):
  786. # Init base class
  787. Entry.__init__(self, type, name, tag)
  788. self._ctype = 'ev_uint8_t *'
  789. def GetInitializer(self):
  790. return "NULL"
  791. def GetVarLen(self, var):
  792. return '%(var)s->%(name)s_length' % self.GetTranslation({ 'var' : var })
  793. def CodeArrayAdd(self, varname, value):
  794. # xxx: copy
  795. return [ '%(varname)s = NULL;' % { 'varname' : varname } ]
  796. def GetDeclaration(self, funcname):
  797. code = [ 'int %s(struct %s *, %s *, ev_uint32_t *);' % (
  798. funcname, self._struct.Name(), self._ctype ) ]
  799. return code
  800. def AssignDeclaration(self, funcname):
  801. code = [ 'int %s(struct %s *, const %s, ev_uint32_t);' % (
  802. funcname, self._struct.Name(), self._ctype ) ]
  803. return code
  804. def CodeAssign(self):
  805. name = self._name
  806. code = [ 'int',
  807. '%s_%s_assign(struct %s *msg, '
  808. 'const %s value, ev_uint32_t len)' % (
  809. self._struct.Name(), name,
  810. self._struct.Name(), self._ctype),
  811. '{',
  812. ' if (msg->%s_data != NULL)' % name,
  813. ' free (msg->%s_data);' % name,
  814. ' msg->%s_data = malloc(len);' % name,
  815. ' if (msg->%s_data == NULL)' % name,
  816. ' return (-1);',
  817. ' msg->%s_set = 1;' % name,
  818. ' msg->%s_length = len;' % name,
  819. ' memcpy(msg->%s_data, value, len);' % name,
  820. ' return (0);',
  821. '}' ]
  822. return code
  823. def CodeGet(self):
  824. name = self._name
  825. code = [ 'int',
  826. '%s_%s_get(struct %s *msg, %s *value, ev_uint32_t *plen)' % (
  827. self._struct.Name(), name,
  828. self._struct.Name(), self._ctype),
  829. '{',
  830. ' if (msg->%s_set != 1)' % name,
  831. ' return (-1);',
  832. ' *value = msg->%s_data;' % name,
  833. ' *plen = msg->%s_length;' % name,
  834. ' return (0);',
  835. '}' ]
  836. return code
  837. def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
  838. code = ['if (evtag_payload_length(%(buf)s, &%(varlen)s) == -1)',
  839. ' return (-1);',
  840. # We do not want DoS opportunities
  841. 'if (%(varlen)s > evbuffer_get_length(%(buf)s))',
  842. ' return (-1);',
  843. 'if ((%(var)s = malloc(%(varlen)s)) == NULL)',
  844. ' return (-1);',
  845. 'if (evtag_unmarshal_fixed(%(buf)s, %(tag)s, %(var)s, '
  846. '%(varlen)s) == -1) {',
  847. ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
  848. ' return (-1);',
  849. '}'
  850. ]
  851. code = '\n'.join(code) % self.GetTranslation({
  852. 'buf' : buf,
  853. 'tag' : tag_name,
  854. 'var' : var_name,
  855. 'varlen' : var_len })
  856. return code.split('\n')
  857. def CodeMarshal(self, buf, tag_name, var_name, var_len):
  858. code = ['evtag_marshal(%s, %s, %s, %s);' % (
  859. buf, tag_name, var_name, var_len)]
  860. return code
  861. def CodeClear(self, structname):
  862. code = [ 'if (%s->%s_set == 1) {' % (structname, self.Name()),
  863. ' free (%s->%s_data);' % (structname, self.Name()),
  864. ' %s->%s_data = NULL;' % (structname, self.Name()),
  865. ' %s->%s_length = 0;' % (structname, self.Name()),
  866. ' %s->%s_set = 0;' % (structname, self.Name()),
  867. '}'
  868. ]
  869. return code
  870. def CodeInitialize(self, name):
  871. code = ['%s->%s_data = NULL;' % (name, self._name),
  872. '%s->%s_length = 0;' % (name, self._name) ]
  873. return code
  874. def CodeFree(self, name):
  875. code = ['if (%s->%s_data != NULL)' % (name, self._name),
  876. ' free(%s->%s_data);' % (name, self._name)]
  877. return code
  878. def Declaration(self):
  879. dcl = ['ev_uint8_t *%s_data;' % self._name,
  880. 'ev_uint32_t %s_length;' % self._name]
  881. return dcl
  882. class EntryArray(Entry):
  883. def __init__(self, entry):
  884. # Init base class
  885. Entry.__init__(self, entry._type, entry._name, entry._tag)
  886. self._entry = entry
  887. self._refname = entry._refname
  888. self._ctype = self._entry._ctype
  889. self._optional = True
  890. self._optpointer = self._entry._optpointer
  891. self._optaddarg = self._entry._optaddarg
  892. # provide a new function for accessing the variable name
  893. def GetVarName(var_name):
  894. return '%(var)s->%(name)s_data[%(index)s]' % \
  895. self._entry.GetTranslation({'var' : var_name,
  896. 'index' : self._index})
  897. self._entry.GetVarName = GetVarName
  898. def GetInitializer(self):
  899. return "NULL"
  900. def GetVarName(self, var_name):
  901. return var_name
  902. def GetVarLen(self, var_name):
  903. return '-1'
  904. def GetDeclaration(self, funcname):
  905. """Allows direct access to elements of the array."""
  906. code = [
  907. 'int %(funcname)s(struct %(parent_name)s *, int, %(ctype)s *);' %
  908. self.GetTranslation({ 'funcname' : funcname }) ]
  909. return code
  910. def AssignDeclaration(self, funcname):
  911. code = [ 'int %s(struct %s *, int, const %s);' % (
  912. funcname, self._struct.Name(), self._ctype ) ]
  913. return code
  914. def AddDeclaration(self, funcname):
  915. code = [
  916. '%(ctype)s %(optpointer)s '
  917. '%(funcname)s(struct %(parent_name)s *msg%(optaddarg)s);' % \
  918. self.GetTranslation({ 'funcname' : funcname }) ]
  919. return code
  920. def CodeGet(self):
  921. code = """int
  922. %(parent_name)s_%(name)s_get(struct %(parent_name)s *msg, int offset,
  923. %(ctype)s *value)
  924. {
  925. if (!msg->%(name)s_set || offset < 0 || offset >= msg->%(name)s_length)
  926. return (-1);
  927. *value = msg->%(name)s_data[offset];
  928. return (0);
  929. }""" % self.GetTranslation()
  930. return code.split('\n')
  931. def CodeAssign(self):
  932. code = [
  933. 'int',
  934. '%(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg, int off,',
  935. ' const %(ctype)s value)',
  936. '{',
  937. ' if (!msg->%(name)s_set || off < 0 || off >= msg->%(name)s_length)',
  938. ' return (-1);\n',
  939. ' {' ]
  940. code = TranslateList(code, self.GetTranslation())
  941. codearrayassign = self._entry.CodeArrayAssign(
  942. 'msg->%(name)s_data[off]' % self.GetTranslation(), 'value')
  943. code += map(lambda x: ' ' + x, codearrayassign)
  944. code += TranslateList([
  945. ' }',
  946. ' return (0);',
  947. '}' ], self.GetTranslation())
  948. return code
  949. def CodeAdd(self):
  950. codearrayadd = self._entry.CodeArrayAdd(
  951. 'msg->%(name)s_data[msg->%(name)s_length - 1]' % self.GetTranslation(),
  952. 'value')
  953. code = [
  954. 'static int',
  955. '%(parent_name)s_%(name)s_expand_to_hold_more('
  956. 'struct %(parent_name)s *msg)',
  957. '{',
  958. ' int tobe_allocated = msg->%(name)s_num_allocated;',
  959. ' %(ctype)s* new_data = NULL;',
  960. ' tobe_allocated = !tobe_allocated ? 1 : tobe_allocated << 1;',
  961. ' new_data = (%(ctype)s*) realloc(msg->%(name)s_data,',
  962. ' tobe_allocated * sizeof(%(ctype)s));',
  963. ' if (new_data == NULL)',
  964. ' return -1;',
  965. ' msg->%(name)s_data = new_data;',
  966. ' msg->%(name)s_num_allocated = tobe_allocated;',
  967. ' return 0;'
  968. '}',
  969. '',
  970. '%(ctype)s %(optpointer)s',
  971. '%(parent_name)s_%(name)s_add('
  972. 'struct %(parent_name)s *msg%(optaddarg)s)',
  973. '{',
  974. ' if (++msg->%(name)s_length >= msg->%(name)s_num_allocated) {',
  975. ' if (%(parent_name)s_%(name)s_expand_to_hold_more(msg)<0)',
  976. ' goto error;',
  977. ' }' ]
  978. code = TranslateList(code, self.GetTranslation())
  979. code += map(lambda x: ' ' + x, codearrayadd)
  980. code += TranslateList([
  981. ' msg->%(name)s_set = 1;',
  982. ' return %(optreference)s(msg->%(name)s_data['
  983. 'msg->%(name)s_length - 1]);',
  984. 'error:',
  985. ' --msg->%(name)s_length;',
  986. ' return (NULL);',
  987. '}' ], self.GetTranslation())
  988. return code
  989. def CodeComplete(self, structname, var_name):
  990. self._index = 'i'
  991. tmp = self._entry.CodeComplete(structname, self._entry.GetVarName(var_name))
  992. # skip the whole loop if there is nothing to check
  993. if not tmp:
  994. return []
  995. translate = self.GetTranslation({ 'structname' : structname })
  996. code = [
  997. '{',
  998. ' int i;',
  999. ' for (i = 0; i < %(structname)s->%(name)s_length; ++i) {' ]
  1000. code = TranslateList(code, translate)
  1001. code += map(lambda x: ' ' + x, tmp)
  1002. code += [
  1003. ' }',
  1004. '}' ]
  1005. return code
  1006. def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
  1007. translate = self.GetTranslation({ 'var' : var_name,
  1008. 'buf' : buf,
  1009. 'tag' : tag_name,
  1010. 'init' : self._entry.GetInitializer()})
  1011. code = [
  1012. 'if (%(var)s->%(name)s_length >= %(var)s->%(name)s_num_allocated &&',
  1013. ' %(parent_name)s_%(name)s_expand_to_hold_more(%(var)s) < 0) {',
  1014. ' puts("HEY NOW");',
  1015. ' return (-1);',
  1016. '}']
  1017. # the unmarshal code directly returns
  1018. code = TranslateList(code, translate)
  1019. self._index = '%(var)s->%(name)s_length' % translate
  1020. code += self._entry.CodeUnmarshal(buf, tag_name,
  1021. self._entry.GetVarName(var_name),
  1022. self._entry.GetVarLen(var_name))
  1023. code += [ '++%(var)s->%(name)s_length;' % translate ]
  1024. return code
  1025. def CodeMarshal(self, buf, tag_name, var_name, var_len):
  1026. code = ['{',
  1027. ' int i;',
  1028. ' for (i = 0; i < %(var)s->%(name)s_length; ++i) {' ]
  1029. self._index = 'i'
  1030. code += self._entry.CodeMarshal(buf, tag_name,
  1031. self._entry.GetVarName(var_name),
  1032. self._entry.GetVarLen(var_name))
  1033. code += [' }',
  1034. '}'
  1035. ]
  1036. code = "\n".join(code) % self.GetTranslation({ 'var' : var_name })
  1037. return code.split('\n')
  1038. def CodeClear(self, structname):
  1039. translate = self.GetTranslation({ 'structname' : structname })
  1040. codearrayfree = self._entry.CodeArrayFree(
  1041. '%(structname)s->%(name)s_data[i]' % self.GetTranslation(
  1042. { 'structname' : structname } ))
  1043. code = [ 'if (%(structname)s->%(name)s_set == 1) {' ]
  1044. if codearrayfree:
  1045. code += [
  1046. ' int i;',
  1047. ' for (i = 0; i < %(structname)s->%(name)s_length; ++i) {' ]
  1048. code = TranslateList(code, translate)
  1049. if codearrayfree:
  1050. code += map(lambda x: ' ' + x, codearrayfree)
  1051. code += [
  1052. ' }' ]
  1053. code += TranslateList([
  1054. ' free(%(structname)s->%(name)s_data);',
  1055. ' %(structname)s->%(name)s_data = NULL;',
  1056. ' %(structname)s->%(name)s_set = 0;',
  1057. ' %(structname)s->%(name)s_length = 0;',
  1058. ' %(structname)s->%(name)s_num_allocated = 0;',
  1059. '}'
  1060. ], translate)
  1061. return code
  1062. def CodeInitialize(self, name):
  1063. code = ['%s->%s_data = NULL;' % (name, self._name),
  1064. '%s->%s_length = 0;' % (name, self._name),
  1065. '%s->%s_num_allocated = 0;' % (name, self._name)]
  1066. return code
  1067. def CodeFree(self, structname):
  1068. code = self.CodeClear(structname);
  1069. code += TranslateList([
  1070. 'free(%(structname)s->%(name)s_data);' ],
  1071. self.GetTranslation({'structname' : structname }))
  1072. return code
  1073. def Declaration(self):
  1074. dcl = ['%s *%s_data;' % (self._ctype, self._name),
  1075. 'int %s_length;' % self._name,
  1076. 'int %s_num_allocated;' % self._name ]
  1077. return dcl
  1078. def NormalizeLine(line):
  1079. global white
  1080. global cppcomment
  1081. line = cppcomment.sub('', line)
  1082. line = line.strip()
  1083. line = white.sub(' ', line)
  1084. return line
  1085. def ProcessOneEntry(factory, newstruct, entry):
  1086. optional = 0
  1087. array = 0
  1088. entry_type = ''
  1089. name = ''
  1090. tag = ''
  1091. tag_set = None
  1092. separator = ''
  1093. fixed_length = ''
  1094. tokens = entry.split(' ')
  1095. while tokens:
  1096. token = tokens[0]
  1097. tokens = tokens[1:]
  1098. if not entry_type:
  1099. if not optional and token == 'optional':
  1100. optional = 1
  1101. continue
  1102. if not array and token == 'array':
  1103. array = 1
  1104. continue
  1105. if not entry_type:
  1106. entry_type = token
  1107. continue
  1108. if not name:
  1109. res = re.match(r'^([^\[\]]+)(\[.*\])?$', token)
  1110. if not res:
  1111. raise RpcGenError(
  1112. 'Cannot parse name: \"%s\" '
  1113. 'around line %d' % (entry, line_count))
  1114. name = res.group(1)
  1115. fixed_length = res.group(2)
  1116. if fixed_length:
  1117. fixed_length = fixed_length[1:-1]
  1118. continue
  1119. if not separator:
  1120. separator = token
  1121. if separator != '=':
  1122. raise RpcGenError('Expected "=" after name \"%s\" got %s'
  1123. % (name, token))
  1124. continue
  1125. if not tag_set:
  1126. tag_set = 1
  1127. if not re.match(r'^(0x)?[0-9]+$', token):
  1128. raise RpcGenError('Expected tag number: \"%s\"' % entry)
  1129. tag = int(token, 0)
  1130. continue
  1131. raise RpcGenError('Cannot parse \"%s\"' % entry)
  1132. if not tag_set:
  1133. raise RpcGenError('Need tag number: \"%s\"' % entry)
  1134. # Create the right entry
  1135. if entry_type == 'bytes':
  1136. if fixed_length:
  1137. newentry = factory.EntryBytes(entry_type, name, tag, fixed_length)
  1138. else:
  1139. newentry = factory.EntryVarBytes(entry_type, name, tag)
  1140. elif entry_type == 'int' and not fixed_length:
  1141. newentry = factory.EntryInt(entry_type, name, tag)
  1142. elif entry_type == 'int64' and not fixed_length:
  1143. newentry = factory.EntryInt(entry_type, name, tag, bits=64)
  1144. elif entry_type == 'string' and not fixed_length:
  1145. newentry = factory.EntryString(entry_type, name, tag)
  1146. else:
  1147. res = structref.match(entry_type)
  1148. if res:
  1149. # References another struct defined in our file
  1150. newentry = factory.EntryStruct(entry_type, name, tag, res.group(1))
  1151. else:
  1152. raise RpcGenError('Bad type: "%s" in "%s"' % (entry_type, entry))
  1153. structs = []
  1154. if optional:
  1155. newentry.MakeOptional()
  1156. if array:
  1157. newentry.MakeArray()
  1158. newentry.SetStruct(newstruct)
  1159. newentry.SetLineCount(line_count)
  1160. newentry.Verify()
  1161. if array:
  1162. # We need to encapsulate this entry into a struct
  1163. newname = newentry.Name()+ '_array'
  1164. # Now borgify the new entry.
  1165. newentry = factory.EntryArray(newentry)
  1166. newentry.SetStruct(newstruct)
  1167. newentry.SetLineCount(line_count)
  1168. newentry.MakeArray()
  1169. newstruct.AddEntry(newentry)
  1170. return structs
  1171. def ProcessStruct(factory, data):
  1172. tokens = data.split(' ')
  1173. # First three tokens are: 'struct' 'name' '{'
  1174. newstruct = factory.Struct(tokens[1])
  1175. inside = ' '.join(tokens[3:-1])
  1176. tokens = inside.split(';')
  1177. structs = []
  1178. for entry in tokens:
  1179. entry = NormalizeLine(entry)
  1180. if not entry:
  1181. continue
  1182. # It's possible that new structs get defined in here
  1183. structs.extend(ProcessOneEntry(factory, newstruct, entry))
  1184. structs.append(newstruct)
  1185. return structs
  1186. def GetNextStruct(file):
  1187. global line_count
  1188. global cppdirect
  1189. got_struct = 0
  1190. processed_lines = []
  1191. have_c_comment = 0
  1192. data = ''
  1193. while 1:
  1194. line = file.readline()
  1195. if not line:
  1196. break
  1197. line_count += 1
  1198. line = line[:-1]
  1199. if not have_c_comment and re.search(r'/\*', line):
  1200. if re.search(r'/\*.*?\*/', line):
  1201. line = re.sub(r'/\*.*?\*/', '', line)
  1202. else:
  1203. line = re.sub(r'/\*.*$', '', line)
  1204. have_c_comment = 1
  1205. if have_c_comment:
  1206. if not re.search(r'\*/', line):
  1207. continue
  1208. have_c_comment = 0
  1209. line = re.sub(r'^.*\*/', '', line)
  1210. line = NormalizeLine(line)
  1211. if not line:
  1212. continue
  1213. if not got_struct:
  1214. if re.match(r'#include ["<].*[>"]', line):
  1215. cppdirect.append(line)
  1216. continue
  1217. if re.match(r'^#(if( |def)|endif)', line):
  1218. cppdirect.append(line)
  1219. continue
  1220. if re.match(r'^#define', line):
  1221. headerdirect.append(line)
  1222. continue
  1223. if not structdef.match(line):
  1224. raise RpcGenError('Missing struct on line %d: %s'
  1225. % (line_count, line))
  1226. else:
  1227. got_struct = 1
  1228. data += line
  1229. continue
  1230. # We are inside the struct
  1231. tokens = line.split('}')
  1232. if len(tokens) == 1:
  1233. data += ' ' + line
  1234. continue
  1235. if len(tokens[1]):
  1236. raise RpcGenError('Trailing garbage after struct on line %d'
  1237. % line_count)
  1238. # We found the end of the struct
  1239. data += ' %s}' % tokens[0]
  1240. break
  1241. # Remove any comments, that might be in there
  1242. data = re.sub(r'/\*.*\*/', '', data)
  1243. return data
  1244. def Parse(factory, file):
  1245. """
  1246. Parses the input file and returns C code and corresponding header file.
  1247. """
  1248. entities = []
  1249. while 1:
  1250. # Just gets the whole struct nicely formatted
  1251. data = GetNextStruct(file)
  1252. if not data:
  1253. break
  1254. entities.extend(ProcessStruct(factory, data))
  1255. return entities
  1256. class CCodeGenerator:
  1257. def __init__(self):
  1258. pass
  1259. def GuardName(self, name):
  1260. # Use the complete provided path to the input file, with all
  1261. # non-identifier characters replaced with underscores, to
  1262. # reduce the chance of a collision between guard macros.
  1263. return '_' + nonident.sub('_', name).upper() + '_'
  1264. def HeaderPreamble(self, name):
  1265. guard = self.GuardName(name)
  1266. pre = (
  1267. '/*\n'
  1268. ' * Automatically generated from %s\n'
  1269. ' */\n\n'
  1270. '#ifndef %s\n'
  1271. '#define %s\n\n' ) % (
  1272. name, guard, guard)
  1273. for statement in headerdirect:
  1274. pre += '%s\n' % statement
  1275. if headerdirect:
  1276. pre += '\n'
  1277. pre += (
  1278. '#include <event2/util.h> /* for ev_uint*_t */\n'
  1279. '#include <event2/rpc.h>\n'
  1280. )
  1281. return pre
  1282. def HeaderPostamble(self, name):
  1283. guard = self.GuardName(name)
  1284. return '#endif /* %s */' % guard
  1285. def BodyPreamble(self, name, header_file):
  1286. global _NAME
  1287. global _VERSION
  1288. slash = header_file.rfind('/')
  1289. if slash != -1:
  1290. header_file = header_file[slash+1:]
  1291. pre = ( '/*\n'
  1292. ' * Automatically generated from %s\n'
  1293. ' * by %s/%s. DO NOT EDIT THIS FILE.\n'
  1294. ' */\n\n' ) % (name, _NAME, _VERSION)
  1295. pre += ( '#include <stdlib.h>\n'
  1296. '#include <string.h>\n'
  1297. '#include <assert.h>\n'
  1298. '#include <event2/event-config.h>\n'
  1299. '#include <event2/event.h>\n'
  1300. '#include <event2/buffer.h>\n'
  1301. '#include <event2/tag.h>\n\n'
  1302. '#ifdef _EVENT___func__\n'
  1303. '#define __func__ _EVENT___func__\n'
  1304. '#endif\n\n'
  1305. )
  1306. for statement in cppdirect:
  1307. pre += '%s\n' % statement
  1308. pre += '\n#include "%s"\n\n' % header_file
  1309. pre += 'void event_warn(const char *fmt, ...);\n'
  1310. pre += 'void event_warnx(const char *fmt, ...);\n\n'
  1311. return pre
  1312. def HeaderFilename(self, filename):
  1313. return '.'.join(filename.split('.')[:-1]) + '.h'
  1314. def CodeFilename(self, filename):
  1315. return '.'.join(filename.split('.')[:-1]) + '.gen.c'
  1316. def Struct(self, name):
  1317. return StructCCode(name)
  1318. def EntryBytes(self, entry_type, name, tag, fixed_length):
  1319. return EntryBytes(entry_type, name, tag, fixed_length)
  1320. def EntryVarBytes(self, entry_type, name, tag):
  1321. return EntryVarBytes(entry_type, name, tag)
  1322. def EntryInt(self, entry_type, name, tag, bits=32):
  1323. return EntryInt(entry_type, name, tag, bits)
  1324. def EntryString(self, entry_type, name, tag):
  1325. return EntryString(entry_type, name, tag)
  1326. def EntryStruct(self, entry_type, name, tag, struct_name):
  1327. return EntryStruct(entry_type, name, tag, struct_name)
  1328. def EntryArray(self, entry):
  1329. return EntryArray(entry)
  1330. class Usage(RpcGenError):
  1331. def __init__(self, argv0):
  1332. RpcGenError.__init__("usage: %s input.rpc [[output.h] output.c]"
  1333. % argv0)
  1334. class CommandLine:
  1335. def __init__(self, argv):
  1336. """Initialize a command-line to launch event_rpcgen, as if
  1337. from a command-line with CommandLine(sys.argv). If you're
  1338. calling this directly, remember to provide a dummy value
  1339. for sys.argv[0]
  1340. """
  1341. self.filename = None
  1342. self.header_file = None
  1343. self.impl_file = None
  1344. self.factory = CCodeGenerator()
  1345. if len(argv) < 2 or len(argv) > 4:
  1346. raise Usage(argv[0])
  1347. self.filename = argv[1].replace('\\', '/')
  1348. if len(argv) == 3:
  1349. self.impl_file = argv[2].replace('\\', '/')
  1350. if len(argv) == 4:
  1351. self.header_file = argv[2].replace('\\', '/')
  1352. self.impl_file = argv[3].replace('\\', '/')
  1353. if not self.filename:
  1354. raise Usage(argv[0])
  1355. if not self.impl_file:
  1356. self.impl_file = self.factory.CodeFilename(self.filename)
  1357. if not self.header_file:
  1358. self.header_file = self.factory.HeaderFilename(self.impl_file)
  1359. if not self.impl_file.endswith('.c'):
  1360. raise RpcGenError("can only generate C implementation files")
  1361. if not self.header_file.endswith('.h'):
  1362. raise RpcGenError("can only generate C header files")
  1363. def run(self):
  1364. filename = self.filename
  1365. header_file = self.header_file
  1366. impl_file = self.impl_file
  1367. factory = self.factory
  1368. print >>sys.stderr, 'Reading \"%s\"' % filename
  1369. fp = open(filename, 'r')
  1370. entities = Parse(factory, fp)
  1371. fp.close()
  1372. print >>sys.stderr, '... creating "%s"' % header_file
  1373. header_fp = open(header_file, 'w')
  1374. print >>header_fp, factory.HeaderPreamble(filename)
  1375. # Create forward declarations: allows other structs to reference
  1376. # each other
  1377. for entry in entities:
  1378. entry.PrintForwardDeclaration(header_fp)
  1379. print >>header_fp, ''
  1380. for entry in entities:
  1381. entry.PrintTags(header_fp)
  1382. entry.PrintDeclaration(header_fp)
  1383. print >>header_fp, factory.HeaderPostamble(filename)
  1384. header_fp.close()
  1385. print >>sys.stderr, '... creating "%s"' % impl_file
  1386. impl_fp = open(impl_file, 'w')
  1387. print >>impl_fp, factory.BodyPreamble(filename, header_file)
  1388. for entry in entities:
  1389. entry.PrintCode(impl_fp)
  1390. impl_fp.close()
  1391. if __name__ == '__main__':
  1392. try:
  1393. CommandLine(sys.argv).run()
  1394. sys.exit(0)
  1395. except RpcGenError, e:
  1396. print >>sys.stderr, e
  1397. sys.exit(1)
  1398. except EnvironmentError, e:
  1399. if e.filename and e.strerror:
  1400. print >>sys.stderr, "%s: %s" % (e.filename, e.strerror)
  1401. sys.exit(1)
  1402. elif e.strerror:
  1403. print >> sys.stderr, e.strerror
  1404. sys.exit(1)
  1405. else:
  1406. raise