3 # Copyright (c) 2005-2007 Niels Provos <provos@citi.umich.edu>
4 # Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
7 # Generates marshaling code based on libevent.
10 # 1) use optparse to allow the strategy shell to parse options, and
11 # to allow the instantiated factory (for the specific output language)
12 # to parse remaining options
13 # 2) move the globals into a class that manages execution (including the
14 # progress outputs that space stderr at the moment)
15 # 3) emit other languages
20 _NAME = "event_rpcgen.py"
26 white = re.compile(r'\s+')
27 cppcomment = re.compile(r'\/\/.*$')
28 nonident = re.compile(r'[^a-zA-Z0-9_]')
29 structref = re.compile(r'^struct\[([a-zA-Z_][a-zA-Z0-9_]*)\]$')
30 structdef = re.compile(r'^struct +[a-zA-Z_][a-zA-Z0-9_]* *{$')
41 def TranslateList(mylist, mydict):
42 return map(lambda x: x % mydict, mylist)
44 # Exception class for parse errors
45 class RpcGenError(Exception):
46 def __init__(self, why):
51 # Holds everything that makes a struct
53 def __init__(self, name):
57 declare(' Created struct: %s' % name)
59 def AddEntry(self, entry):
60 if self._tags.has_key(entry.Tag()):
62 'Entry "%s" duplicates tag number %d from "%s" '
63 'around line %d' % (entry.Name(), entry.Tag(),
64 self._tags[entry.Tag()], line_count))
65 self._entries.append(entry)
66 self._tags[entry.Tag()] = entry.Name()
67 declare(' Added entry: %s' % entry.Name())
72 def EntryTagName(self, entry):
73 """Creates the name inside an enumeration for distinguishing data
75 name = "%s_%s" % (self._name, entry.Name())
78 def PrintIndented(self, file, ident, code):
79 """Takes an array, add indentation to each entry and prints it."""
81 print >>file, '%s%s' % (ident, entry)
83 class StructCCode(Struct):
84 """ Knows how to generate C code for a struct """
86 def __init__(self, name):
87 Struct.__init__(self, name)
89 def PrintTags(self, file):
90 """Prints the tag definitions for a structure."""
91 print >>file, '/* Tag definition for %s */' % self._name
92 print >>file, 'enum %s_ {' % self._name.lower()
93 for entry in self._entries:
94 print >>file, ' %s=%d,' % (self.EntryTagName(entry),
96 print >>file, ' %s_MAX_TAGS' % (self._name.upper())
99 def PrintForwardDeclaration(self, file):
100 print >>file, 'struct %s;' % self._name
102 def PrintDeclaration(self, file):
103 print >>file, '/* Structure declaration for %s */' % self._name
104 print >>file, 'struct %s_access_ {' % self._name
105 for entry in self._entries:
106 dcl = entry.AssignDeclaration('(*%s_assign)' % entry.Name())
108 entry.GetDeclaration('(*%s_get)' % entry.Name()))
111 entry.AddDeclaration('(*%s_add)' % entry.Name()))
112 self.PrintIndented(file, ' ', dcl)
115 print >>file, 'struct %s {' % self._name
116 print >>file, ' struct %s_access_ *base;\n' % self._name
117 for entry in self._entries:
118 dcl = entry.Declaration()
119 self.PrintIndented(file, ' ', dcl)
121 for entry in self._entries:
122 print >>file, ' ev_uint8_t %s_set;' % entry.Name()
126 """struct %(name)s *%(name)s_new(void);
127 struct %(name)s *%(name)s_new_with_arg(void *);
128 void %(name)s_free(struct %(name)s *);
129 void %(name)s_clear(struct %(name)s *);
130 void %(name)s_marshal(struct evbuffer *, const struct %(name)s *);
131 int %(name)s_unmarshal(struct %(name)s *, struct evbuffer *);
132 int %(name)s_complete(struct %(name)s *);
133 void evtag_marshal_%(name)s(struct evbuffer *, ev_uint32_t,
134 const struct %(name)s *);
135 int evtag_unmarshal_%(name)s(struct evbuffer *, ev_uint32_t,
136 struct %(name)s *);""" % { 'name' : self._name }
139 # Write a setting function of every variable
140 for entry in self._entries:
141 self.PrintIndented(file, '', entry.AssignDeclaration(
142 entry.AssignFuncName()))
143 self.PrintIndented(file, '', entry.GetDeclaration(
144 entry.GetFuncName()))
146 self.PrintIndented(file, '', entry.AddDeclaration(
147 entry.AddFuncName()))
149 print >>file, '/* --- %s done --- */\n' % self._name
151 def PrintCode(self, file):
152 print >>file, ('/*\n'
153 ' * Implementation of %s\n'
154 ' */\n') % self._name
157 'static struct %(name)s_access_ %(name)s_base__ = {' % \
158 { 'name' : self._name }
159 for entry in self._entries:
160 self.PrintIndented(file, ' ', entry.CodeBase())
165 'struct %(name)s *\n'
166 '%(name)s_new(void)\n'
168 ' return %(name)s_new_with_arg(NULL);\n'
171 'struct %(name)s *\n'
172 '%(name)s_new_with_arg(void *unused)\n'
174 ' struct %(name)s *tmp;\n'
175 ' if ((tmp = malloc(sizeof(struct %(name)s))) == NULL) {\n'
176 ' event_warn("%%s: malloc", __func__);\n'
179 ' tmp->base = &%(name)s_base__;\n') % { 'name' : self._name }
181 for entry in self._entries:
182 self.PrintIndented(file, ' ', entry.CodeInitialize('tmp'))
183 print >>file, ' tmp->%s_set = 0;\n' % entry.Name()
190 for entry in self._entries:
192 self.PrintIndented(file, '', entry.CodeAdd())
196 for entry in self._entries:
197 self.PrintIndented(file, '', entry.CodeAssign())
201 for entry in self._entries:
202 self.PrintIndented(file, '', entry.CodeGet())
206 print >>file, ( 'void\n'
207 '%(name)s_clear(struct %(name)s *tmp)\n'
209 ) % { 'name' : self._name }
210 for entry in self._entries:
211 self.PrintIndented(file, ' ', entry.CodeClear('tmp'))
216 print >>file, ( 'void\n'
217 '%(name)s_free(struct %(name)s *tmp)\n'
219 ) % { 'name' : self._name }
221 for entry in self._entries:
222 self.PrintIndented(file, ' ', entry.CodeFree('tmp'))
224 print >>file, (' free(tmp);\n'
228 print >>file, ('void\n'
229 '%(name)s_marshal(struct evbuffer *evbuf, '
230 'const struct %(name)s *tmp)'
231 '{') % { 'name' : self._name }
232 for entry in self._entries:
234 # Optional entries do not have to be set
237 print >>file, ' if (tmp->%s_set) {' % entry.Name()
240 entry.CodeMarshal('evbuf', self.EntryTagName(entry),
241 entry.GetVarName('tmp'),
242 entry.GetVarLen('tmp')))
249 print >>file, ('int\n'
250 '%(name)s_unmarshal(struct %(name)s *tmp, '
251 ' struct evbuffer *evbuf)\n'
253 ' ev_uint32_t tag;\n'
254 ' while (evbuffer_get_length(evbuf) > 0) {\n'
255 ' if (evtag_peek(evbuf, &tag) == -1)\n'
258 ) % { 'name' : self._name }
259 for entry in self._entries:
260 print >>file, ' case %s:\n' % self.EntryTagName(entry)
261 if not entry.Array():
263 ' if (tmp->%s_set)\n'
269 entry.CodeUnmarshal('evbuf',
270 self.EntryTagName(entry),
271 entry.GetVarName('tmp'),
272 entry.GetVarLen('tmp')))
274 print >>file, ( ' tmp->%s_set = 1;\n' % entry.Name() +
276 print >>file, ( ' default:\n'
280 # Check if it was decoded completely
281 print >>file, ( ' if (%(name)s_complete(tmp) == -1)\n'
283 ) % { 'name' : self._name }
285 # Successfully decoded
286 print >>file, ( ' return (0);\n'
289 # Checking if a structure has all the required data
292 '%(name)s_complete(struct %(name)s *msg)\n'
293 '{' ) % { 'name' : self._name }
294 for entry in self._entries:
295 if not entry.Optional():
297 'if (!msg->%(name)s_set)',
299 code = TranslateList(code, entry.GetTranslation())
305 entry.CodeComplete('msg', entry.GetVarName('msg')))
310 # Complete message unmarshaling
313 'evtag_unmarshal_%(name)s(struct evbuffer *evbuf, '
314 'ev_uint32_t need_tag, struct %(name)s *msg)\n'
316 ' ev_uint32_t tag;\n'
319 ' struct evbuffer *tmp = evbuffer_new();\n'
321 ' if (evtag_unmarshal(evbuf, &tag, tmp) == -1'
322 ' || tag != need_tag)\n'
325 ' if (%(name)s_unmarshal(msg, tmp) == -1)\n'
331 ' evbuffer_free(tmp);\n'
333 '}\n' ) % { 'name' : self._name }
335 # Complete message marshaling
338 'evtag_marshal_%(name)s(struct evbuffer *evbuf, ev_uint32_t tag, '
339 'const struct %(name)s *msg)\n'
341 ' struct evbuffer *buf_ = evbuffer_new();\n'
342 ' assert(buf_ != NULL);\n'
343 ' %(name)s_marshal(buf_, msg);\n'
344 ' evtag_marshal_buffer(evbuf, tag, buf_);\n '
345 ' evbuffer_free(buf_);\n'
346 '}\n' ) % { 'name' : self._name }
349 def __init__(self, type, name, tag):
355 self._can_be_array = 0
357 self._line_count = -1
361 self._optpointer = True
362 self._optaddarg = True
364 def GetInitializer(self):
365 assert 0, "Entry does not provide initializer"
367 def SetStruct(self, struct):
368 self._struct = struct
371 assert self._line_count != -1
372 return self._line_count
374 def SetLineCount(self, number):
375 self._line_count = number
381 return self._optional
392 def MakeArray(self, yes=1):
395 def MakeOptional(self):
399 if self.Array() and not self._can_be_array:
401 'Entry "%s" cannot be created as an array '
402 'around line %d' % (self._name, self.LineCount()))
405 'Entry "%s" does not know which struct it belongs to '
406 'around line %d' % (self._name, self.LineCount()))
407 if self._optional and self._array:
409 'Entry "%s" has illegal combination of optional and array '
410 'around line %d' % (self._name, self.LineCount()))
412 def GetTranslation(self, extradict = {}):
414 "parent_name" : self._struct.Name(),
416 "ctype" : self._ctype,
417 "refname" : self._refname,
418 "optpointer" : self._optpointer and "*" or "",
419 "optreference" : self._optpointer and "&" or "",
421 self._optaddarg and ", const %s value" % self._ctype or ""
423 for (k, v) in extradict.items():
428 def GetVarName(self, var):
429 return '%(var)s->%(name)s_data' % self.GetTranslation({ 'var' : var })
431 def GetVarLen(self, var):
432 return 'sizeof(%s)' % self._ctype
434 def GetFuncName(self):
435 return '%s_%s_get' % (self._struct.Name(), self._name)
437 def GetDeclaration(self, funcname):
438 code = [ 'int %s(struct %s *, %s *);' % (
439 funcname, self._struct.Name(), self._ctype ) ]
445 '%(parent_name)s_%(name)s_get(struct %(parent_name)s *msg, '
448 ' if (msg->%(name)s_set != 1)',
450 ' *value = msg->%(name)s_data;',
453 code = '\n'.join(code)
454 code = code % self.GetTranslation()
455 return code.split('\n')
457 def AssignFuncName(self):
458 return '%s_%s_assign' % (self._struct.Name(), self._name)
460 def AddFuncName(self):
461 return '%s_%s_add' % (self._struct.Name(), self._name)
463 def AssignDeclaration(self, funcname):
464 code = [ 'int %s(struct %s *, const %s);' % (
465 funcname, self._struct.Name(), self._ctype ) ]
468 def CodeAssign(self):
470 '%(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg,'
471 ' const %(ctype)s value)',
473 ' msg->%(name)s_set = 1;',
474 ' msg->%(name)s_data = value;',
477 code = '\n'.join(code)
478 code = code % self.GetTranslation()
479 return code.split('\n')
481 def CodeClear(self, structname):
482 code = [ '%s->%s_set = 0;' % (structname, self.Name()) ]
486 def CodeComplete(self, structname, var_name):
489 def CodeFree(self, name):
494 '%(parent_name)s_%(name)s_assign,',
495 '%(parent_name)s_%(name)s_get,'
498 code.append('%(parent_name)s_%(name)s_add,')
500 code = '\n'.join(code)
501 code = code % self.GetTranslation()
502 return code.split('\n')
504 class EntryBytes(Entry):
505 def __init__(self, type, name, tag, length):
507 Entry.__init__(self, type, name, tag)
509 self._length = length
510 self._ctype = 'ev_uint8_t'
512 def GetInitializer(self):
515 def GetVarLen(self, var):
516 return '(%s)' % self._length
518 def CodeArrayAdd(self, varname, value):
520 return [ '%(varname)s = NULL;' % { 'varname' : varname } ]
522 def GetDeclaration(self, funcname):
523 code = [ 'int %s(struct %s *, %s **);' % (
524 funcname, self._struct.Name(), self._ctype ) ]
527 def AssignDeclaration(self, funcname):
528 code = [ 'int %s(struct %s *, const %s *);' % (
529 funcname, self._struct.Name(), self._ctype ) ]
532 def Declaration(self):
533 dcl = ['ev_uint8_t %s_data[%s];' % (self._name, self._length)]
540 '%s_%s_get(struct %s *msg, %s **value)' % (
541 self._struct.Name(), name,
542 self._struct.Name(), self._ctype),
544 ' if (msg->%s_set != 1)' % name,
546 ' *value = msg->%s_data;' % name,
551 def CodeAssign(self):
554 '%s_%s_assign(struct %s *msg, const %s *value)' % (
555 self._struct.Name(), name,
556 self._struct.Name(), self._ctype),
558 ' msg->%s_set = 1;' % name,
559 ' memcpy(msg->%s_data, value, %s);' % (
565 def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
566 code = [ 'if (evtag_unmarshal_fixed(%(buf)s, %(tag)s, '
567 '%(var)s, %(varlen)s) == -1) {',
568 ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
572 return TranslateList(code,
573 self.GetTranslation({
579 def CodeMarshal(self, buf, tag_name, var_name, var_len):
580 code = ['evtag_marshal(%s, %s, %s, %s);' % (
581 buf, tag_name, var_name, var_len)]
584 def CodeClear(self, structname):
585 code = [ '%s->%s_set = 0;' % (structname, self.Name()),
586 'memset(%s->%s_data, 0, sizeof(%s->%s_data));' % (
587 structname, self._name, structname, self._name)]
591 def CodeInitialize(self, name):
592 code = ['memset(%s->%s_data, 0, sizeof(%s->%s_data));' % (
593 name, self._name, name, self._name)]
599 'Entry "%s" needs a length '
600 'around line %d' % (self._name, self.LineCount()))
604 class EntryInt(Entry):
605 def __init__(self, type, name, tag, bits=32):
607 Entry.__init__(self, type, name, tag)
609 self._can_be_array = 1
611 self._ctype = 'ev_uint32_t'
612 self._marshal_type = 'int'
614 self._ctype = 'ev_uint64_t'
615 self._marshal_type = 'int64'
617 def GetInitializer(self):
620 def CodeArrayFree(self, var):
623 def CodeArrayAssign(self, varname, srcvar):
624 return [ '%(varname)s = %(srcvar)s;' % { 'varname' : varname,
625 'srcvar' : srcvar } ]
627 def CodeArrayAdd(self, varname, value):
628 """Returns a new entry of this type."""
629 return [ '%(varname)s = %(value)s;' % { 'varname' : varname,
632 def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
634 'if (evtag_unmarshal_%(ma)s(%(buf)s, %(tag)s, &%(var)s) == -1) {',
635 ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
638 code = '\n'.join(code) % self.GetTranslation({
639 'ma' : self._marshal_type,
643 return code.split('\n')
645 def CodeMarshal(self, buf, tag_name, var_name, var_len):
647 'evtag_marshal_%s(%s, %s, %s);' % (
648 self._marshal_type, buf, tag_name, var_name)]
651 def Declaration(self):
652 dcl = ['%s %s_data;' % (self._ctype, self._name)]
656 def CodeInitialize(self, name):
657 code = ['%s->%s_data = 0;' % (name, self._name)]
660 class EntryString(Entry):
661 def __init__(self, type, name, tag):
663 Entry.__init__(self, type, name, tag)
665 self._can_be_array = 1
666 self._ctype = 'char *'
668 def GetInitializer(self):
671 def CodeArrayFree(self, varname):
673 'if (%(var)s != NULL) free(%(var)s);' ]
675 return TranslateList(code, { 'var' : varname })
677 def CodeArrayAssign(self, varname, srcvar):
679 'if (%(var)s != NULL)',
681 '%(var)s = strdup(%(srcvar)s);',
682 'if (%(var)s == NULL) {',
683 ' event_warnx("%%s: strdup", __func__);',
687 return TranslateList(code, { 'var' : varname,
690 def CodeArrayAdd(self, varname, value):
692 'if (%(value)s != NULL) {',
693 ' %(var)s = strdup(%(value)s);',
694 ' if (%(var)s == NULL) {',
701 return TranslateList(code, { 'var' : varname,
704 def GetVarLen(self, var):
705 return 'strlen(%s)' % self.GetVarName(var)
707 def CodeMakeInitalize(self, varname):
708 return '%(varname)s = NULL;' % { 'varname' : varname }
710 def CodeAssign(self):
713 %(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg,
714 const %(ctype)s value)
716 if (msg->%(name)s_data != NULL)
717 free(msg->%(name)s_data);
718 if ((msg->%(name)s_data = strdup(value)) == NULL)
720 msg->%(name)s_set = 1;
722 }""" % self.GetTranslation()
724 return code.split('\n')
726 def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
727 code = ['if (evtag_unmarshal_string(%(buf)s, %(tag)s, &%(var)s) == -1) {',
728 ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
732 code = '\n'.join(code) % self.GetTranslation({
736 return code.split('\n')
738 def CodeMarshal(self, buf, tag_name, var_name, var_len):
739 code = ['evtag_marshal_string(%s, %s, %s);' % (
740 buf, tag_name, var_name)]
743 def CodeClear(self, structname):
744 code = [ 'if (%s->%s_set == 1) {' % (structname, self.Name()),
745 ' free(%s->%s_data);' % (structname, self.Name()),
746 ' %s->%s_data = NULL;' % (structname, self.Name()),
747 ' %s->%s_set = 0;' % (structname, self.Name()),
753 def CodeInitialize(self, name):
754 code = ['%s->%s_data = NULL;' % (name, self._name)]
757 def CodeFree(self, name):
758 code = ['if (%s->%s_data != NULL)' % (name, self._name),
759 ' free (%s->%s_data);' % (name, self._name)]
763 def Declaration(self):
764 dcl = ['char *%s_data;' % self._name]
768 class EntryStruct(Entry):
769 def __init__(self, type, name, tag, refname):
771 Entry.__init__(self, type, name, tag)
773 self._optpointer = False
774 self._can_be_array = 1
775 self._refname = refname
776 self._ctype = 'struct %s*' % refname
777 self._optaddarg = False
779 def GetInitializer(self):
782 def GetVarLen(self, var):
785 def CodeArrayAdd(self, varname, value):
787 '%(varname)s = %(refname)s_new();',
788 'if (%(varname)s == NULL)',
791 return TranslateList(code, self.GetTranslation({ 'varname' : varname }))
793 def CodeArrayFree(self, var):
794 code = [ '%(refname)s_free(%(var)s);' % self.GetTranslation(
798 def CodeArrayAssign(self, var, srcvar):
800 'int had_error = 0;',
801 'struct evbuffer *tmp = NULL;',
802 '%(refname)s_clear(%(var)s);',
803 'if ((tmp = evbuffer_new()) == NULL) {',
804 ' event_warn("%%s: evbuffer_new()", __func__);',
808 '%(refname)s_marshal(tmp, %(srcvar)s);',
809 'if (%(refname)s_unmarshal(%(var)s, tmp) == -1) {',
810 ' event_warnx("%%s: %(refname)s_unmarshal", __func__);',
816 ' evbuffer_free(tmp);',
818 ' %(refname)s_clear(%(var)s);',
822 return TranslateList(code, self.GetTranslation({
829 '%s_%s_get(struct %s *msg, %s *value)' % (
830 self._struct.Name(), name,
831 self._struct.Name(), self._ctype),
833 ' if (msg->%s_set != 1) {' % name,
834 ' msg->%s_data = %s_new();' % (name, self._refname),
835 ' if (msg->%s_data == NULL)' % name,
837 ' msg->%s_set = 1;' % name,
839 ' *value = msg->%s_data;' % name,
844 def CodeAssign(self):
847 %(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg,
848 const %(ctype)s value)
850 struct evbuffer *tmp = NULL;
851 if (msg->%(name)s_set) {
852 %(refname)s_clear(msg->%(name)s_data);
853 msg->%(name)s_set = 0;
855 msg->%(name)s_data = %(refname)s_new();
856 if (msg->%(name)s_data == NULL) {
857 event_warn("%%s: %(refname)s_new()", __func__);
861 if ((tmp = evbuffer_new()) == NULL) {
862 event_warn("%%s: evbuffer_new()", __func__);
865 %(refname)s_marshal(tmp, value);
866 if (%(refname)s_unmarshal(msg->%(name)s_data, tmp) == -1) {
867 event_warnx("%%s: %(refname)s_unmarshal", __func__);
870 msg->%(name)s_set = 1;
876 if (msg->%(name)s_data != NULL) {
877 %(refname)s_free(msg->%(name)s_data);
878 msg->%(name)s_data = NULL;
881 }""" % self.GetTranslation()
882 return code.split('\n')
884 def CodeComplete(self, structname, var_name):
885 code = [ 'if (%(structname)s->%(name)s_set && '
886 '%(refname)s_complete(%(var)s) == -1)',
889 return TranslateList(code, self.GetTranslation({
890 'structname' : structname,
893 def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
894 code = ['%(var)s = %(refname)s_new();',
895 'if (%(var)s == NULL)',
897 'if (evtag_unmarshal_%(refname)s(%(buf)s, %(tag)s, '
899 ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
903 code = '\n'.join(code) % self.GetTranslation({
907 return code.split('\n')
909 def CodeMarshal(self, buf, tag_name, var_name, var_len):
910 code = ['evtag_marshal_%s(%s, %s, %s);' % (
911 self._refname, buf, tag_name, var_name)]
914 def CodeClear(self, structname):
915 code = [ 'if (%s->%s_set == 1) {' % (structname, self.Name()),
916 ' %s_free(%s->%s_data);' % (
917 self._refname, structname, self.Name()),
918 ' %s->%s_data = NULL;' % (structname, self.Name()),
919 ' %s->%s_set = 0;' % (structname, self.Name()),
925 def CodeInitialize(self, name):
926 code = ['%s->%s_data = NULL;' % (name, self._name)]
929 def CodeFree(self, name):
930 code = ['if (%s->%s_data != NULL)' % (name, self._name),
931 ' %s_free(%s->%s_data);' % (
932 self._refname, name, self._name)]
936 def Declaration(self):
937 dcl = ['%s %s_data;' % (self._ctype, self._name)]
941 class EntryVarBytes(Entry):
942 def __init__(self, type, name, tag):
944 Entry.__init__(self, type, name, tag)
946 self._ctype = 'ev_uint8_t *'
948 def GetInitializer(self):
951 def GetVarLen(self, var):
952 return '%(var)s->%(name)s_length' % self.GetTranslation({ 'var' : var })
954 def CodeArrayAdd(self, varname, value):
956 return [ '%(varname)s = NULL;' % { 'varname' : varname } ]
958 def GetDeclaration(self, funcname):
959 code = [ 'int %s(struct %s *, %s *, ev_uint32_t *);' % (
960 funcname, self._struct.Name(), self._ctype ) ]
963 def AssignDeclaration(self, funcname):
964 code = [ 'int %s(struct %s *, const %s, ev_uint32_t);' % (
965 funcname, self._struct.Name(), self._ctype ) ]
968 def CodeAssign(self):
971 '%s_%s_assign(struct %s *msg, '
972 'const %s value, ev_uint32_t len)' % (
973 self._struct.Name(), name,
974 self._struct.Name(), self._ctype),
976 ' if (msg->%s_data != NULL)' % name,
977 ' free (msg->%s_data);' % name,
978 ' msg->%s_data = malloc(len);' % name,
979 ' if (msg->%s_data == NULL)' % name,
981 ' msg->%s_set = 1;' % name,
982 ' msg->%s_length = len;' % name,
983 ' memcpy(msg->%s_data, value, len);' % name,
991 '%s_%s_get(struct %s *msg, %s *value, ev_uint32_t *plen)' % (
992 self._struct.Name(), name,
993 self._struct.Name(), self._ctype),
995 ' if (msg->%s_set != 1)' % name,
997 ' *value = msg->%s_data;' % name,
998 ' *plen = msg->%s_length;' % name,
1003 def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
1004 code = ['if (evtag_payload_length(%(buf)s, &%(varlen)s) == -1)',
1006 # We do not want DoS opportunities
1007 'if (%(varlen)s > evbuffer_get_length(%(buf)s))',
1009 'if ((%(var)s = malloc(%(varlen)s)) == NULL)',
1011 'if (evtag_unmarshal_fixed(%(buf)s, %(tag)s, %(var)s, '
1012 '%(varlen)s) == -1) {',
1013 ' event_warnx("%%s: failed to unmarshal %(name)s", __func__);',
1017 code = '\n'.join(code) % self.GetTranslation({
1021 'varlen' : var_len })
1022 return code.split('\n')
1024 def CodeMarshal(self, buf, tag_name, var_name, var_len):
1025 code = ['evtag_marshal(%s, %s, %s, %s);' % (
1026 buf, tag_name, var_name, var_len)]
1029 def CodeClear(self, structname):
1030 code = [ 'if (%s->%s_set == 1) {' % (structname, self.Name()),
1031 ' free (%s->%s_data);' % (structname, self.Name()),
1032 ' %s->%s_data = NULL;' % (structname, self.Name()),
1033 ' %s->%s_length = 0;' % (structname, self.Name()),
1034 ' %s->%s_set = 0;' % (structname, self.Name()),
1040 def CodeInitialize(self, name):
1041 code = ['%s->%s_data = NULL;' % (name, self._name),
1042 '%s->%s_length = 0;' % (name, self._name) ]
1045 def CodeFree(self, name):
1046 code = ['if (%s->%s_data != NULL)' % (name, self._name),
1047 ' free(%s->%s_data);' % (name, self._name)]
1051 def Declaration(self):
1052 dcl = ['ev_uint8_t *%s_data;' % self._name,
1053 'ev_uint32_t %s_length;' % self._name]
1057 class EntryArray(Entry):
1058 def __init__(self, entry):
1060 Entry.__init__(self, entry._type, entry._name, entry._tag)
1063 self._refname = entry._refname
1064 self._ctype = self._entry._ctype
1065 self._optional = True
1066 self._optpointer = self._entry._optpointer
1067 self._optaddarg = self._entry._optaddarg
1069 # provide a new function for accessing the variable name
1070 def GetVarName(var_name):
1071 return '%(var)s->%(name)s_data[%(index)s]' % \
1072 self._entry.GetTranslation({'var' : var_name,
1073 'index' : self._index})
1074 self._entry.GetVarName = GetVarName
1076 def GetInitializer(self):
1079 def GetVarName(self, var_name):
1082 def GetVarLen(self, var_name):
1085 def GetDeclaration(self, funcname):
1086 """Allows direct access to elements of the array."""
1088 'int %(funcname)s(struct %(parent_name)s *, int, %(ctype)s *);' %
1089 self.GetTranslation({ 'funcname' : funcname }) ]
1092 def AssignDeclaration(self, funcname):
1093 code = [ 'int %s(struct %s *, int, const %s);' % (
1094 funcname, self._struct.Name(), self._ctype ) ]
1097 def AddDeclaration(self, funcname):
1099 '%(ctype)s %(optpointer)s '
1100 '%(funcname)s(struct %(parent_name)s *msg%(optaddarg)s);' % \
1101 self.GetTranslation({ 'funcname' : funcname }) ]
1106 %(parent_name)s_%(name)s_get(struct %(parent_name)s *msg, int offset,
1109 if (!msg->%(name)s_set || offset < 0 || offset >= msg->%(name)s_length)
1111 *value = msg->%(name)s_data[offset];
1113 }""" % self.GetTranslation()
1115 return code.split('\n')
1117 def CodeAssign(self):
1120 '%(parent_name)s_%(name)s_assign(struct %(parent_name)s *msg, int off,',
1121 ' const %(ctype)s value)',
1123 ' if (!msg->%(name)s_set || off < 0 || off >= msg->%(name)s_length)',
1126 code = TranslateList(code, self.GetTranslation())
1128 codearrayassign = self._entry.CodeArrayAssign(
1129 'msg->%(name)s_data[off]' % self.GetTranslation(), 'value')
1130 code += map(lambda x: ' ' + x, codearrayassign)
1132 code += TranslateList([
1135 '}' ], self.GetTranslation())
1140 codearrayadd = self._entry.CodeArrayAdd(
1141 'msg->%(name)s_data[msg->%(name)s_length - 1]' % self.GetTranslation(),
1145 '%(parent_name)s_%(name)s_expand_to_hold_more('
1146 'struct %(parent_name)s *msg)',
1148 ' int tobe_allocated = msg->%(name)s_num_allocated;',
1149 ' %(ctype)s* new_data = NULL;',
1150 ' tobe_allocated = !tobe_allocated ? 1 : tobe_allocated << 1;',
1151 ' new_data = (%(ctype)s*) realloc(msg->%(name)s_data,',
1152 ' tobe_allocated * sizeof(%(ctype)s));',
1153 ' if (new_data == NULL)',
1155 ' msg->%(name)s_data = new_data;',
1156 ' msg->%(name)s_num_allocated = tobe_allocated;',
1160 '%(ctype)s %(optpointer)s',
1161 '%(parent_name)s_%(name)s_add('
1162 'struct %(parent_name)s *msg%(optaddarg)s)',
1164 ' if (++msg->%(name)s_length >= msg->%(name)s_num_allocated) {',
1165 ' if (%(parent_name)s_%(name)s_expand_to_hold_more(msg)<0)',
1169 code = TranslateList(code, self.GetTranslation())
1171 code += map(lambda x: ' ' + x, codearrayadd)
1173 code += TranslateList([
1174 ' msg->%(name)s_set = 1;',
1175 ' return %(optreference)s(msg->%(name)s_data['
1176 'msg->%(name)s_length - 1]);',
1178 ' --msg->%(name)s_length;',
1180 '}' ], self.GetTranslation())
1184 def CodeComplete(self, structname, var_name):
1186 tmp = self._entry.CodeComplete(structname, self._entry.GetVarName(var_name))
1187 # skip the whole loop if there is nothing to check
1191 translate = self.GetTranslation({ 'structname' : structname })
1195 ' for (i = 0; i < %(structname)s->%(name)s_length; ++i) {' ]
1197 code = TranslateList(code, translate)
1199 code += map(lambda x: ' ' + x, tmp)
1207 def CodeUnmarshal(self, buf, tag_name, var_name, var_len):
1208 translate = self.GetTranslation({ 'var' : var_name,
1211 'init' : self._entry.GetInitializer()})
1213 'if (%(var)s->%(name)s_length >= %(var)s->%(name)s_num_allocated &&',
1214 ' %(parent_name)s_%(name)s_expand_to_hold_more(%(var)s) < 0) {',
1215 ' puts("HEY NOW");',
1219 # the unmarshal code directly returns
1220 code = TranslateList(code, translate)
1222 self._index = '%(var)s->%(name)s_length' % translate
1223 code += self._entry.CodeUnmarshal(buf, tag_name,
1224 self._entry.GetVarName(var_name),
1225 self._entry.GetVarLen(var_name))
1227 code += [ '++%(var)s->%(name)s_length;' % translate ]
1231 def CodeMarshal(self, buf, tag_name, var_name, var_len):
1234 ' for (i = 0; i < %(var)s->%(name)s_length; ++i) {' ]
1237 code += self._entry.CodeMarshal(buf, tag_name,
1238 self._entry.GetVarName(var_name),
1239 self._entry.GetVarLen(var_name))
1244 code = "\n".join(code) % self.GetTranslation({ 'var' : var_name })
1246 return code.split('\n')
1248 def CodeClear(self, structname):
1249 translate = self.GetTranslation({ 'structname' : structname })
1250 codearrayfree = self._entry.CodeArrayFree(
1251 '%(structname)s->%(name)s_data[i]' % self.GetTranslation(
1252 { 'structname' : structname } ))
1254 code = [ 'if (%(structname)s->%(name)s_set == 1) {' ]
1259 ' for (i = 0; i < %(structname)s->%(name)s_length; ++i) {' ]
1261 code = TranslateList(code, translate)
1264 code += map(lambda x: ' ' + x, codearrayfree)
1268 code += TranslateList([
1269 ' free(%(structname)s->%(name)s_data);',
1270 ' %(structname)s->%(name)s_data = NULL;',
1271 ' %(structname)s->%(name)s_set = 0;',
1272 ' %(structname)s->%(name)s_length = 0;',
1273 ' %(structname)s->%(name)s_num_allocated = 0;',
1279 def CodeInitialize(self, name):
1280 code = ['%s->%s_data = NULL;' % (name, self._name),
1281 '%s->%s_length = 0;' % (name, self._name),
1282 '%s->%s_num_allocated = 0;' % (name, self._name)]
1285 def CodeFree(self, structname):
1286 code = self.CodeClear(structname);
1288 code += TranslateList([
1289 'free(%(structname)s->%(name)s_data);' ],
1290 self.GetTranslation({'structname' : structname }))
1294 def Declaration(self):
1295 dcl = ['%s *%s_data;' % (self._ctype, self._name),
1296 'int %s_length;' % self._name,
1297 'int %s_num_allocated;' % self._name ]
1301 def NormalizeLine(line):
1305 line = cppcomment.sub('', line)
1307 line = white.sub(' ', line)
1311 def ProcessOneEntry(factory, newstruct, entry):
1321 tokens = entry.split(' ')
1327 if not optional and token == 'optional':
1331 if not array and token == 'array':
1340 res = re.match(r'^([^\[\]]+)(\[.*\])?$', token)
1343 'Cannot parse name: \"%s\" '
1344 'around line %d' % (entry, line_count))
1346 fixed_length = res.group(2)
1348 fixed_length = fixed_length[1:-1]
1353 if separator != '=':
1354 raise RpcGenError('Expected "=" after name \"%s\" got %s'
1360 if not re.match(r'^(0x)?[0-9]+$', token):
1361 raise RpcGenError('Expected tag number: \"%s\"' % entry)
1365 raise RpcGenError('Cannot parse \"%s\"' % entry)
1368 raise RpcGenError('Need tag number: \"%s\"' % entry)
1370 # Create the right entry
1371 if entry_type == 'bytes':
1373 newentry = factory.EntryBytes(entry_type, name, tag, fixed_length)
1375 newentry = factory.EntryVarBytes(entry_type, name, tag)
1376 elif entry_type == 'int' and not fixed_length:
1377 newentry = factory.EntryInt(entry_type, name, tag)
1378 elif entry_type == 'int64' and not fixed_length:
1379 newentry = factory.EntryInt(entry_type, name, tag, bits=64)
1380 elif entry_type == 'string' and not fixed_length:
1381 newentry = factory.EntryString(entry_type, name, tag)
1383 res = structref.match(entry_type)
1385 # References another struct defined in our file
1386 newentry = factory.EntryStruct(entry_type, name, tag, res.group(1))
1388 raise RpcGenError('Bad type: "%s" in "%s"' % (entry_type, entry))
1393 newentry.MakeOptional()
1395 newentry.MakeArray()
1397 newentry.SetStruct(newstruct)
1398 newentry.SetLineCount(line_count)
1402 # We need to encapsulate this entry into a struct
1403 newname = newentry.Name()+ '_array'
1405 # Now borgify the new entry.
1406 newentry = factory.EntryArray(newentry)
1407 newentry.SetStruct(newstruct)
1408 newentry.SetLineCount(line_count)
1409 newentry.MakeArray()
1411 newstruct.AddEntry(newentry)
1415 def ProcessStruct(factory, data):
1416 tokens = data.split(' ')
1418 # First three tokens are: 'struct' 'name' '{'
1419 newstruct = factory.Struct(tokens[1])
1421 inside = ' '.join(tokens[3:-1])
1423 tokens = inside.split(';')
1427 for entry in tokens:
1428 entry = NormalizeLine(entry)
1432 # It's possible that new structs get defined in here
1433 structs.extend(ProcessOneEntry(factory, newstruct, entry))
1435 structs.append(newstruct)
1438 def GetNextStruct(file):
1444 processed_lines = []
1449 line = file.readline()
1456 if not have_c_comment and re.search(r'/\*', line):
1457 if re.search(r'/\*.*?\*/', line):
1458 line = re.sub(r'/\*.*?\*/', '', line)
1460 line = re.sub(r'/\*.*$', '', line)
1464 if not re.search(r'\*/', line):
1467 line = re.sub(r'^.*\*/', '', line)
1469 line = NormalizeLine(line)
1475 if re.match(r'#include ["<].*[>"]', line):
1476 cppdirect.append(line)
1479 if re.match(r'^#(if( |def)|endif)', line):
1480 cppdirect.append(line)
1483 if re.match(r'^#define', line):
1484 headerdirect.append(line)
1487 if not structdef.match(line):
1488 raise RpcGenError('Missing struct on line %d: %s'
1489 % (line_count, line))
1495 # We are inside the struct
1496 tokens = line.split('}')
1497 if len(tokens) == 1:
1502 raise RpcGenError('Trailing garbage after struct on line %d'
1505 # We found the end of the struct
1506 data += ' %s}' % tokens[0]
1509 # Remove any comments, that might be in there
1510 data = re.sub(r'/\*.*\*/', '', data)
1515 def Parse(factory, file):
1517 Parses the input file and returns C code and corresponding header file.
1523 # Just gets the whole struct nicely formatted
1524 data = GetNextStruct(file)
1529 entities.extend(ProcessStruct(factory, data))
1533 class CCodeGenerator:
1537 def GuardName(self, name):
1538 # Use the complete provided path to the input file, with all
1539 # non-identifier characters replaced with underscores, to
1540 # reduce the chance of a collision between guard macros.
1541 return 'EVENT_RPCOUT_' + nonident.sub('_', name).upper() + '_'
1543 def HeaderPreamble(self, name):
1544 guard = self.GuardName(name)
1547 ' * Automatically generated from %s\n'
1550 '#define %s\n\n' ) % (
1553 for statement in headerdirect:
1554 pre += '%s\n' % statement
1559 '#include <event2/util.h> /* for ev_uint*_t */\n'
1560 '#include <event2/rpc.h>\n'
1565 def HeaderPostamble(self, name):
1566 guard = self.GuardName(name)
1567 return '#endif /* %s */' % guard
1569 def BodyPreamble(self, name, header_file):
1573 slash = header_file.rfind('/')
1575 header_file = header_file[slash+1:]
1578 ' * Automatically generated from %s\n'
1579 ' * by %s/%s. DO NOT EDIT THIS FILE.\n'
1580 ' */\n\n' ) % (name, _NAME, _VERSION)
1581 pre += ( '#include <stdlib.h>\n'
1582 '#include <string.h>\n'
1583 '#include <assert.h>\n'
1584 '#include <event2/event-config.h>\n'
1585 '#include <event2/event.h>\n'
1586 '#include <event2/buffer.h>\n'
1587 '#include <event2/tag.h>\n\n'
1588 '#if defined(EVENT____func__) && !defined(__func__)\n'
1589 '#define __func__ EVENT____func__\n'
1593 for statement in cppdirect:
1594 pre += '%s\n' % statement
1596 pre += '\n#include "%s"\n\n' % header_file
1598 pre += 'void event_warn(const char *fmt, ...);\n'
1599 pre += 'void event_warnx(const char *fmt, ...);\n\n'
1603 def HeaderFilename(self, filename):
1604 return '.'.join(filename.split('.')[:-1]) + '.h'
1606 def CodeFilename(self, filename):
1607 return '.'.join(filename.split('.')[:-1]) + '.gen.c'
1609 def Struct(self, name):
1610 return StructCCode(name)
1612 def EntryBytes(self, entry_type, name, tag, fixed_length):
1613 return EntryBytes(entry_type, name, tag, fixed_length)
1615 def EntryVarBytes(self, entry_type, name, tag):
1616 return EntryVarBytes(entry_type, name, tag)
1618 def EntryInt(self, entry_type, name, tag, bits=32):
1619 return EntryInt(entry_type, name, tag, bits)
1621 def EntryString(self, entry_type, name, tag):
1622 return EntryString(entry_type, name, tag)
1624 def EntryStruct(self, entry_type, name, tag, struct_name):
1625 return EntryStruct(entry_type, name, tag, struct_name)
1627 def EntryArray(self, entry):
1628 return EntryArray(entry)
1630 class Usage(RpcGenError):
1631 def __init__(self, argv0):
1632 RpcGenError.__init__("usage: %s input.rpc [[output.h] output.c]"
1636 def __init__(self, argv):
1637 """Initialize a command-line to launch event_rpcgen, as if
1638 from a command-line with CommandLine(sys.argv). If you're
1639 calling this directly, remember to provide a dummy value
1642 self.filename = None
1643 self.header_file = None
1644 self.impl_file = None
1645 self.factory = CCodeGenerator()
1647 if len(argv) >= 2 and argv[1] == '--quiet':
1652 if len(argv) < 2 or len(argv) > 4:
1653 raise Usage(argv[0])
1655 self.filename = argv[1].replace('\\', '/')
1657 self.impl_file = argv[2].replace('\\', '/')
1659 self.header_file = argv[2].replace('\\', '/')
1660 self.impl_file = argv[3].replace('\\', '/')
1662 if not self.filename:
1663 raise Usage(argv[0])
1665 if not self.impl_file:
1666 self.impl_file = self.factory.CodeFilename(self.filename)
1668 if not self.header_file:
1669 self.header_file = self.factory.HeaderFilename(self.impl_file)
1671 if not self.impl_file.endswith('.c'):
1672 raise RpcGenError("can only generate C implementation files")
1673 if not self.header_file.endswith('.h'):
1674 raise RpcGenError("can only generate C header files")
1677 filename = self.filename
1678 header_file = self.header_file
1679 impl_file = self.impl_file
1680 factory = self.factory
1682 declare('Reading \"%s\"' % filename)
1684 fp = open(filename, 'r')
1685 entities = Parse(factory, fp)
1688 declare('... creating "%s"' % header_file)
1689 header_fp = open(header_file, 'w')
1690 print >>header_fp, factory.HeaderPreamble(filename)
1692 # Create forward declarations: allows other structs to reference
1694 for entry in entities:
1695 entry.PrintForwardDeclaration(header_fp)
1696 print >>header_fp, ''
1698 for entry in entities:
1699 entry.PrintTags(header_fp)
1700 entry.PrintDeclaration(header_fp)
1701 print >>header_fp, factory.HeaderPostamble(filename)
1704 declare('... creating "%s"' % impl_file)
1705 impl_fp = open(impl_file, 'w')
1706 print >>impl_fp, factory.BodyPreamble(filename, header_file)
1707 for entry in entities:
1708 entry.PrintCode(impl_fp)
1711 if __name__ == '__main__':
1713 CommandLine(sys.argv).run()
1716 except RpcGenError, e:
1717 print >>sys.stderr, e
1720 except EnvironmentError, e:
1721 if e.filename and e.strerror:
1722 print >>sys.stderr, "%s: %s" % (e.filename, e.strerror)
1725 print >> sys.stderr, e.strerror