7 from vapi_json_parser import Field, Struct, Enum, Union, Message, JsonParser,\
8 SimpleType, StructType, Alias
13 return "vapi_type_%s" % self.name
16 if self.len is not None:
17 return "%s %s[%d];" % (self.type.get_c_name(), self.name, self.len)
19 return "%s %s;" % (self.type.get_c_name(), self.name)
21 def get_swap_to_be_code(self, struct, var):
22 if self.len is not None:
24 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
27 self.type.get_swap_to_be_code(struct, "%s[i]" % var))
29 if self.nelem_field.needs_byte_swap():
30 nelem_field = "%s(%s%s)" % (
31 self.nelem_field.type.get_swap_to_host_func_name(),
32 struct, self.nelem_field.name)
34 nelem_field = "%s%s" % (struct, self.nelem_field.name)
36 "do { unsigned i; for (i = 0; i < %s; ++i) { %s } }"
38 (nelem_field, self.type.get_swap_to_be_code(
39 struct, "%s[i]" % var)))
40 return self.type.get_swap_to_be_code(struct, "%s" % var)
42 def get_swap_to_host_code(self, struct, var):
43 if self.len is not None:
45 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
48 self.type.get_swap_to_host_code(struct, "%s[i]" % var))
50 # nelem_field already swapped to host here...
52 "do { unsigned i; for (i = 0; i < %s%s; ++i) { %s } }"
54 (struct, self.nelem_field.name,
55 self.type.get_swap_to_host_code(
56 struct, "%s[i]" % var)))
57 return self.type.get_swap_to_host_code(struct, "%s" % var)
59 def needs_byte_swap(self):
60 return self.type.needs_byte_swap()
62 def get_vla_field_length_name(self, path):
63 return "%s_%s_array_size" % ("_".join(path), self.name)
65 def get_alloc_vla_param_names(self, path):
67 result = [self.get_vla_field_length_name(path)]
70 if self.type.has_vla():
71 t = self.type.get_alloc_vla_param_names(path + [self.name])
75 def get_vla_calc_size_code(self, prefix, path):
77 result = ["sizeof(%s.%s[0]) * %s" % (
78 ".".join([prefix] + path),
80 self.get_vla_field_length_name(path))]
83 if self.type.has_vla():
84 t = self.type.get_vla_calc_size_code(prefix, path + [self.name])
88 def get_vla_assign_code(self, prefix, path):
91 result.append("%s.%s = %s" % (
92 ".".join([prefix] + path),
93 self.nelem_field.name,
94 self.get_vla_field_length_name(path)))
95 if self.type.has_vla():
96 t = self.type.get_vla_assign_code(prefix, path + [self.name])
101 class CAlias(CField):
102 def get_c_name(self):
103 return "vapi_type_%s" % self.name
106 if self.len is not None:
107 return "typedef %s vapi_type_%s[%d];" % (
108 self.type.get_c_name(), self.name, self.len)
110 return "typedef %s vapi_type_%s;" % (
111 self.type.get_c_name(), self.name)
114 class CStruct(Struct):
117 "typedef struct __attribute__((__packed__)) {\n%s" % (
118 "\n".join([" %s" % x.get_c_def()
119 for x in self.fields])),
120 "} %s;" % self.get_c_name()])
122 def get_vla_assign_code(self, prefix, path):
123 return [x for f in self.fields if f.has_vla()
124 for x in f.get_vla_assign_code(prefix, path)]
126 def get_alloc_vla_param_names(self, path):
127 return [x for f in self.fields
129 for x in f.get_alloc_vla_param_names(path)]
131 def get_vla_calc_size_code(self, prefix, path):
132 return [x for f in self.fields if f.has_vla()
133 for x in f.get_vla_calc_size_code(prefix, path)]
136 class CSimpleType (SimpleType):
139 'i16': 'htobe16', 'u16': 'htobe16',
140 'i32': 'htobe32', 'u32': 'htobe32',
141 'i64': 'htobe64', 'u64': 'htobe64',
144 swap_to_host_dict = {
145 'i16': 'be16toh', 'u16': 'be16toh',
146 'i32': 'be32toh', 'u32': 'be32toh',
147 'i64': 'be64toh', 'u64': 'be64toh',
150 def get_c_name(self):
153 def get_swap_to_be_func_name(self):
154 return self.swap_to_be_dict[self.name]
156 def get_swap_to_host_func_name(self):
157 return self.swap_to_host_dict[self.name]
159 def get_swap_to_be_code(self, struct, var, cast=None):
160 x = "%s%s" % (struct, var)
161 return "%s = %s%s(%s);" % (x,
162 "(%s)" % cast if cast else "",
163 self.get_swap_to_be_func_name(), x)
165 def get_swap_to_host_code(self, struct, var, cast=None):
166 x = "%s%s" % (struct, var)
167 return "%s = %s%s(%s);" % (x,
168 "(%s)" % cast if cast else "",
169 self.get_swap_to_host_func_name(), x)
171 def needs_byte_swap(self):
173 self.get_swap_to_host_func_name()
181 def get_c_name(self):
182 return "vapi_enum_%s" % self.name
185 return "typedef enum {\n%s\n} %s;" % (
186 "\n".join([" %s = %s," % (i, j) for i, j in self.value_pairs]),
190 def needs_byte_swap(self):
191 return self.type.needs_byte_swap()
193 def get_swap_to_be_code(self, struct, var):
194 return self.type.get_swap_to_be_code(struct, var, self.get_c_name())
196 def get_swap_to_host_code(self, struct, var):
197 return self.type.get_swap_to_host_code(struct, var, self.get_c_name())
201 def get_c_name(self):
202 return "vapi_union_%s" % self.name
205 return "typedef union {\n%s\n} %s;" % (
206 "\n".join([" %s %s;" % (i.get_c_name(), j)
207 for i, j in self.type_pairs]),
211 def needs_byte_swap(self):
215 class CStructType (StructType, CStruct):
216 def get_c_name(self):
217 return "vapi_type_%s" % self.name
219 def get_swap_to_be_func_name(self):
220 return "%s_hton" % self.get_c_name()
222 def get_swap_to_host_func_name(self):
223 return "%s_ntoh" % self.get_c_name()
225 def get_swap_to_be_func_decl(self):
226 return "void %s(%s *msg)" % (
227 self.get_swap_to_be_func_name(), self.get_c_name())
229 def get_swap_to_be_func_def(self):
230 return "%s\n{\n%s\n}" % (
231 self.get_swap_to_be_func_decl(),
233 " %s" % p.get_swap_to_be_code("msg->", "%s" % p.name)
234 for p in self.fields if p.needs_byte_swap()]),
237 def get_swap_to_host_func_decl(self):
238 return "void %s(%s *msg)" % (
239 self.get_swap_to_host_func_name(), self.get_c_name())
241 def get_swap_to_host_func_def(self):
242 return "%s\n{\n%s\n}" % (
243 self.get_swap_to_host_func_decl(),
245 " %s" % p.get_swap_to_host_code("msg->", "%s" % p.name)
246 for p in self.fields if p.needs_byte_swap()]),
249 def get_swap_to_be_code(self, struct, var):
250 return "%s(&%s%s);" % (self.get_swap_to_be_func_name(), struct, var)
252 def get_swap_to_host_code(self, struct, var):
253 return "%s(&%s%s);" % (self.get_swap_to_host_func_name(), struct, var)
255 def needs_byte_swap(self):
256 for f in self.fields:
257 if f.needs_byte_swap():
262 class CMessage (Message):
263 def __init__(self, logger, definition, json_parser):
264 super(CMessage, self).__init__(logger, definition, json_parser)
265 self.payload_members = [
266 " %s" % p.get_c_def()
268 if p.type != self.header
271 def has_payload(self):
272 return len(self.payload_members) > 0
274 def get_msg_id_name(self):
275 return "vapi_msg_id_%s" % self.name
277 def get_c_name(self):
278 return "vapi_msg_%s" % self.name
280 def get_payload_struct_name(self):
281 return "vapi_payload_%s" % self.name
283 def get_alloc_func_name(self):
284 return "vapi_alloc_%s" % self.name
286 def get_alloc_vla_param_names(self):
287 return [x for f in self.fields
289 for x in f.get_alloc_vla_param_names([])]
291 def get_alloc_func_decl(self):
292 return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
294 self.get_alloc_func_name(),
295 "".join([", size_t %s" % n for n in
296 self.get_alloc_vla_param_names()]))
298 def get_alloc_func_def(self):
300 if self.header.has_field('client_index'):
302 " msg->header.client_index = vapi_get_client_index(ctx);")
303 if self.header.has_field('context'):
304 extra.append(" msg->header.context = 0;")
306 "%s" % self.get_alloc_func_decl(),
308 " %s *msg = NULL;" % self.get_c_name(),
309 " const size_t size = sizeof(%s)%s;" % (
311 "".join([" + %s" % x for f in self.fields if f.has_vla()
312 for x in f.get_vla_calc_size_code("msg->payload",
314 " /* cast here required to play nicely with C++ world ... */",
315 " msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
320 " msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
321 self.get_msg_id_name(),
322 "".join([" %s;\n" % line
323 for f in self.fields if f.has_vla()
324 for line in f.get_vla_assign_code("msg->payload", [])]),
328 def get_calc_msg_size_func_name(self):
329 return "vapi_calc_%s_msg_size" % self.name
331 def get_calc_msg_size_func_decl(self):
332 return "uword %s(%s *msg)" % (
333 self.get_calc_msg_size_func_name(),
336 def get_calc_msg_size_func_def(self):
338 "%s" % self.get_calc_msg_size_func_decl(),
340 " return sizeof(*msg)%s;" %
341 "".join(["+ msg->payload.%s * sizeof(msg->payload.%s[0])" % (
345 if f.nelem_field is not None
351 if self.has_payload():
353 "typedef struct __attribute__ ((__packed__)) {",
355 "\n".join(self.payload_members),
356 "} %s;" % self.get_payload_struct_name(),
358 "typedef struct __attribute__ ((__packed__)) {",
359 (" %s %s;" % (self.header.get_c_name(),
361 if self.header is not None else ""),
362 " %s payload;" % self.get_payload_struct_name(),
363 "} %s;" % self.get_c_name(), ])
366 "typedef struct __attribute__ ((__packed__)) {",
367 (" %s %s;" % (self.header.get_c_name(),
369 if self.header is not None else ""),
370 "} %s;" % self.get_c_name(), ])
372 def get_swap_payload_to_host_func_name(self):
373 return "%s_payload_ntoh" % self.get_c_name()
375 def get_swap_payload_to_be_func_name(self):
376 return "%s_payload_hton" % self.get_c_name()
378 def get_swap_payload_to_host_func_decl(self):
379 return "void %s(%s *payload)" % (
380 self.get_swap_payload_to_host_func_name(),
381 self.get_payload_struct_name())
383 def get_swap_payload_to_be_func_decl(self):
384 return "void %s(%s *payload)" % (
385 self.get_swap_payload_to_be_func_name(),
386 self.get_payload_struct_name())
388 def get_swap_payload_to_be_func_def(self):
389 return "%s\n{\n%s\n}" % (
390 self.get_swap_payload_to_be_func_decl(),
392 " %s" % p.get_swap_to_be_code("payload->", "%s" % p.name)
394 if p.needs_byte_swap() and p.type != self.header]),
397 def get_swap_payload_to_host_func_def(self):
398 return "%s\n{\n%s\n}" % (
399 self.get_swap_payload_to_host_func_decl(),
401 " %s" % p.get_swap_to_host_code("payload->", "%s" % p.name)
403 if p.needs_byte_swap() and p.type != self.header]),
406 def get_swap_to_host_func_name(self):
407 return "%s_ntoh" % self.get_c_name()
409 def get_swap_to_be_func_name(self):
410 return "%s_hton" % self.get_c_name()
412 def get_swap_to_host_func_decl(self):
413 return "void %s(%s *msg)" % (
414 self.get_swap_to_host_func_name(), self.get_c_name())
416 def get_swap_to_be_func_decl(self):
417 return "void %s(%s *msg)" % (
418 self.get_swap_to_be_func_name(), self.get_c_name())
420 def get_swap_to_be_func_def(self):
422 "%s" % self.get_swap_to_be_func_decl(),
424 (" VAPI_DBG(\"Swapping `%s'@%%p to big endian\", msg);" %
426 " %s(&msg->header);" % self.header.get_swap_to_be_func_name()
427 if self.header is not None else "",
428 " %s(&msg->payload);" % self.get_swap_payload_to_be_func_name()
429 if self.has_payload() else "",
433 def get_swap_to_host_func_def(self):
435 "%s" % self.get_swap_to_host_func_decl(),
437 (" VAPI_DBG(\"Swapping `%s'@%%p to host byte order\", msg);" %
439 " %s(&msg->header);" % self.header.get_swap_to_host_func_name()
440 if self.header is not None else "",
441 " %s(&msg->payload);" % self.get_swap_payload_to_host_func_name()
442 if self.has_payload() else "",
446 def get_op_func_name(self):
447 return "vapi_%s" % self.name
449 def get_op_func_decl(self):
450 if self.reply.has_payload():
451 return "vapi_error_e %s(%s)" % (
452 self.get_op_func_name(),
454 'struct vapi_ctx_s *ctx',
455 '%s *msg' % self.get_c_name(),
456 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
457 ' void *callback_ctx',
461 self.reply.get_payload_struct_name(),
462 'void *callback_ctx',
466 return "vapi_error_e %s(%s)" % (
467 self.get_op_func_name(),
469 'struct vapi_ctx_s *ctx',
470 '%s *msg' % self.get_c_name(),
471 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
472 ' void *callback_ctx',
475 'void *callback_ctx',
479 def get_op_func_def(self):
481 "%s" % self.get_op_func_decl(),
483 " if (!msg || !callback) {",
484 " return VAPI_EINVAL;",
486 " if (vapi_is_nonblocking(ctx) && vapi_requests_full(ctx)) {",
487 " return VAPI_EAGAIN;",
490 " if (VAPI_OK != (rv = vapi_producer_lock (ctx))) {",
493 " u32 req_context = vapi_gen_req_context(ctx);",
494 " msg->header.context = req_context;",
495 " %s(msg);" % self.get_swap_to_be_func_name(),
496 (" if (VAPI_OK == (rv = vapi_send_with_control_ping "
497 "(ctx, msg, req_context))) {"
498 if self.reply_is_stream else
499 " if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
501 (" vapi_store_request(ctx, req_context, %s, "
502 "(vapi_cb_t)callback, callback_ctx);" %
503 ("true" if self.reply_is_stream else "false")),
504 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
505 " abort (); /* this really shouldn't happen */",
507 " if (vapi_is_nonblocking(ctx)) {",
510 " rv = vapi_dispatch(ctx);",
513 " %s(msg);" % self.get_swap_to_host_func_name(),
514 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
515 " abort (); /* this really shouldn't happen */",
523 def get_event_cb_func_decl(self):
524 if not self.is_reply and not self.is_event:
526 "Cannot register event callback for non-reply message")
527 if self.has_payload():
529 "void vapi_set_%s_event_cb (" %
531 " struct vapi_ctx_s *ctx, ",
532 (" vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
533 "void *callback_ctx, %s *payload)," %
534 self.get_payload_struct_name()),
535 " void *callback_ctx)",
539 "void vapi_set_%s_event_cb (" %
541 " struct vapi_ctx_s *ctx, ",
542 " vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
543 "void *callback_ctx),",
544 " void *callback_ctx)",
547 def get_event_cb_func_def(self):
548 if not self.is_reply and not self.is_event:
550 "Cannot register event callback for non-reply function")
552 "%s" % self.get_event_cb_func_decl(),
554 (" vapi_set_event_cb(ctx, %s, (vapi_event_cb)callback, "
556 self.get_msg_id_name()),
559 def get_c_metadata_struct_name(self):
560 return "__vapi_metadata_%s" % self.name
562 def get_c_constructor(self):
564 if self.header is not None:
565 has_context = self.header.has_field('context')
567 'static void __attribute__((constructor)) __vapi_constructor_%s()'
570 ' static const char name[] = "%s";' % self.name,
571 ' static const char name_with_crc[] = "%s_%s";'
572 % (self.name, self.crc[2:]),
573 ' static vapi_message_desc_t %s = {' %
574 self.get_c_metadata_struct_name(),
576 ' sizeof(name) - 1,',
578 ' sizeof(name_with_crc) - 1,',
579 ' true,' if has_context else ' false,',
580 ' offsetof(%s, context),' % self.header.get_c_name()
581 if has_context else ' 0,',
582 (' offsetof(%s, payload),' % self.get_c_name())
583 if self.has_payload() else ' VAPI_INVALID_MSG_ID,',
584 ' sizeof(%s),' % self.get_c_name(),
585 ' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
586 ' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
587 ' VAPI_INVALID_MSG_ID,',
590 ' %s = vapi_register_msg(&%s);' %
591 (self.get_msg_id_name(), self.get_c_metadata_struct_name()),
592 ' VAPI_DBG("Assigned msg id %%d to %s", %s);' %
593 (self.name, self.get_msg_id_name()),
598 vapi_send_with_control_ping = """
599 static inline vapi_error_e
600 vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
602 vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
607 ping->header.context = context;
608 vapi_msg_control_ping_hton (ping);
609 return vapi_send2 (ctx, msg, ping);
614 def emit_definition(parser, json_file, emitted, o):
617 if o.name in ("msg_header1_t", "msg_header2_t"):
619 if hasattr(o, "depends"):
621 emit_definition(parser, json_file, emitted, x)
622 if hasattr(o, "reply"):
623 emit_definition(parser, json_file, emitted, o.reply)
624 if hasattr(o, "get_c_def"):
625 if (o not in parser.enums_by_json[json_file] and
626 o not in parser.types_by_json[json_file] and
627 o not in parser.unions_by_json[json_file] and
628 o.name not in parser.messages_by_json[json_file] and
629 o not in parser.aliases_by_json[json_file]):
631 guard = "defined_%s" % o.get_c_name()
632 print("#ifndef %s" % guard)
633 print("#define %s" % guard)
634 print("%s" % o.get_c_def())
636 function_attrs = "static inline "
637 if o.name in parser.messages_by_json[json_file]:
639 print("%s%s" % (function_attrs,
640 o.get_swap_payload_to_be_func_def()))
642 print("%s%s" % (function_attrs,
643 o.get_swap_payload_to_host_func_def()))
645 print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
647 print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
649 print("%s%s" % (function_attrs, o.get_calc_msg_size_func_def()))
650 if not o.is_reply and not o.is_event:
652 print("%s%s" % (function_attrs, o.get_alloc_func_def()))
654 print("%s%s" % (function_attrs, o.get_op_func_def()))
656 print("%s" % o.get_c_constructor())
657 if o.is_reply or o.is_event:
659 print("%s%s;" % (function_attrs, o.get_event_cb_func_def()))
660 elif hasattr(o, "get_swap_to_be_func_def"):
661 print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
663 print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
669 def gen_json_unified_header(parser, logger, j, io, name):
670 d, f = os.path.split(j)
671 logger.info("Generating header `%s'" % name)
672 orig_stdout = sys.stdout
674 include_guard = "__included_%s" % (
675 j.replace(".", "_").replace("/", "_").replace("-", "_"))
676 print("#ifndef %s" % include_guard)
677 print("#define %s" % include_guard)
679 print("#include <stdlib.h>")
680 print("#include <stddef.h>")
681 print("#include <arpa/inet.h>")
682 print("#include <vapi/vapi_internal.h>")
683 print("#include <vapi/vapi.h>")
684 print("#include <vapi/vapi_dbg.h>")
686 print("#ifdef __cplusplus")
687 print("extern \"C\" {")
689 if name == "vpe.api.vapi.h":
691 print("static inline vapi_error_e vapi_send_with_control_ping "
692 "(vapi_ctx_t ctx, void * msg, u32 context);")
694 print("#include <vapi/vpe.api.vapi.h>")
696 for m in parser.messages_by_json[j].values():
697 print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
699 print("#define DEFINE_VAPI_MSG_IDS_%s\\" %
700 f.replace(".", "_").replace("/", "_").replace("-", "_").upper())
702 " vapi_msg_id_t %s;" % m.get_msg_id_name()
703 for m in parser.messages_by_json[j].values()
708 for e in parser.enums_by_json[j]:
709 emit_definition(parser, j, emitted, e)
710 for a in parser.aliases_by_json[j]:
711 emit_definition(parser, j, emitted, a)
712 for u in parser.unions_by_json[j]:
713 emit_definition(parser, j, emitted, u)
714 for t in parser.types_by_json[j]:
715 emit_definition(parser, j, emitted, t)
716 for m in parser.messages_by_json[j].values():
717 emit_definition(parser, j, emitted, m)
721 if name == "vpe.api.vapi.h":
722 print("%s" % vapi_send_with_control_ping)
725 print("#ifdef __cplusplus")
730 sys.stdout = orig_stdout
733 def json_to_c_header_name(json_name):
734 if json_name.endswith(".json"):
735 return "%s.vapi.h" % os.path.splitext(json_name)[0]
736 raise Exception("Unexpected json name `%s'!" % json_name)
739 def gen_c_unified_headers(parser, logger, prefix, remove_path):
740 if prefix == "" or prefix is None:
743 prefix = "%s/" % prefix
744 for j in parser.json_files:
746 d, f = os.path.split(j)
749 with open('%s%s' % (prefix, json_to_c_header_name(f)), "w") as io:
750 gen_json_unified_header(
751 parser, logger, j, io, json_to_c_header_name(f))
754 if __name__ == '__main__':
756 verbose = int(os.getenv("V", 0))
767 logging.basicConfig(stream=sys.stdout, level=log_level)
768 logger = logging.getLogger("VAPI C GEN")
769 logger.setLevel(log_level)
771 argparser = argparse.ArgumentParser(description="VPP C API generator")
772 argparser.add_argument('files', metavar='api-file', action='append',
773 type=str, help='json api file'
774 '(may be specified multiple times)')
775 argparser.add_argument('--prefix', action='store', default=None,
777 argparser.add_argument('--remove-path', action='store_true',
778 help='remove path from filename')
779 args = argparser.parse_args()
781 jsonparser = JsonParser(logger, args.files,
782 simple_type_class=CSimpleType,
785 struct_type_class=CStructType,
787 message_class=CMessage,
790 # not using the model of having separate generated header and code files
791 # with generated symbols present in shared library (per discussion with
792 # Damjan), to avoid symbol version issues in .so
793 # gen_c_headers_and_code(jsonparser, logger, args.prefix)
795 gen_c_unified_headers(jsonparser, logger, args.prefix, args.remove_path)
797 for e in jsonparser.exceptions: