7 from vapi_json_parser import Field, Struct, Enum, Union, Message, JsonParser,\
13 if self.len is not None:
14 return "%s %s[%d]" % (self.type.get_c_name(), self.name, self.len)
16 return "%s %s" % (self.type.get_c_name(), self.name)
18 def get_swap_to_be_code(self, struct, var):
19 if self.len is not None:
21 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
24 self.type.get_swap_to_be_code(struct, "%s[i]" % var))
26 if self.nelem_field.needs_byte_swap():
27 nelem_field = "%s(%s%s)" % (
28 self.nelem_field.type.get_swap_to_host_func_name(),
29 struct, self.nelem_field.name)
31 nelem_field = "%s%s" % (struct, self.nelem_field.name)
33 "do { unsigned i; for (i = 0; i < %s; ++i) { %s } }"
35 (nelem_field, self.type.get_swap_to_be_code(
36 struct, "%s[i]" % var)))
37 return self.type.get_swap_to_be_code(struct, "%s" % var)
39 def get_swap_to_host_code(self, struct, var):
40 if self.len is not None:
42 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
45 self.type.get_swap_to_host_code(struct, "%s[i]" % var))
47 # nelem_field already swapped to host here...
49 "do { unsigned i; for (i = 0; i < %s%s; ++i) { %s } }"
51 (struct, self.nelem_field.name,
52 self.type.get_swap_to_host_code(
53 struct, "%s[i]" % var)))
54 return self.type.get_swap_to_host_code(struct, "%s" % var)
56 def needs_byte_swap(self):
57 return self.type.needs_byte_swap()
59 def get_vla_field_length_name(self, path):
60 return "%s_%s_array_size" % ("_".join(path), self.name)
62 def get_alloc_vla_param_names(self, path):
64 result = [self.get_vla_field_length_name(path)]
67 if self.type.has_vla():
68 t = self.type.get_alloc_vla_param_names(path + [self.name])
72 def get_vla_calc_size_code(self, prefix, path):
74 result = ["sizeof(%s.%s[0]) * %s" % (
75 ".".join([prefix] + path),
77 self.get_vla_field_length_name(path))]
80 if self.type.has_vla():
81 t = self.type.get_vla_calc_size_code(prefix, path + [self.name])
85 def get_vla_assign_code(self, prefix, path):
88 result.append("%s.%s = %s" % (
89 ".".join([prefix] + path),
90 self.nelem_field.name,
91 self.get_vla_field_length_name(path)))
92 if self.type.has_vla():
93 t = self.type.get_vla_assign_code(prefix, path + [self.name])
98 class CStruct(Struct):
101 "typedef struct __attribute__((__packed__)) {\n%s;" % (
102 ";\n".join([" %s" % x.get_c_def()
103 for x in self.fields])),
104 "} %s;" % self.get_c_name()])
106 def get_vla_assign_code(self, prefix, path):
107 return [x for f in self.fields if f.has_vla()
108 for x in f.get_vla_assign_code(prefix, path)]
110 def get_alloc_vla_param_names(self, path):
111 return [x for f in self.fields
113 for x in f.get_alloc_vla_param_names(path)]
115 def get_vla_calc_size_code(self, prefix, path):
116 return [x for f in self.fields if f.has_vla()
117 for x in f.get_vla_calc_size_code(prefix, path)]
120 class CSimpleType (SimpleType):
123 'i16': 'htobe16', 'u16': 'htobe16',
124 'i32': 'htobe32', 'u32': 'htobe32',
125 'i64': 'htobe64', 'u64': 'htobe64',
128 swap_to_host_dict = {
129 'i16': 'be16toh', 'u16': 'be16toh',
130 'i32': 'be32toh', 'u32': 'be32toh',
131 'i64': 'be64toh', 'u64': 'be64toh',
134 def get_c_name(self):
137 def get_swap_to_be_func_name(self):
138 return self.swap_to_be_dict[self.name]
140 def get_swap_to_host_func_name(self):
141 return self.swap_to_host_dict[self.name]
143 def get_swap_to_be_code(self, struct, var, cast=None):
144 x = "%s%s" % (struct, var)
145 return "%s = %s%s(%s);" % (x,
146 "(%s)" % cast if cast else "",
147 self.get_swap_to_be_func_name(), x)
149 def get_swap_to_host_code(self, struct, var, cast=None):
150 x = "%s%s" % (struct, var)
151 return "%s = %s%s(%s);" % (x,
152 "(%s)" % cast if cast else "",
153 self.get_swap_to_host_func_name(), x)
155 def needs_byte_swap(self):
157 self.get_swap_to_host_func_name()
165 def get_c_name(self):
166 return "vapi_enum_%s" % self.name
169 return "typedef enum {\n%s\n} %s;" % (
170 "\n".join([" %s = %s," % (i, j) for i, j in self.value_pairs]),
174 def needs_byte_swap(self):
175 return self.type.needs_byte_swap()
177 def get_swap_to_be_code(self, struct, var):
178 return self.type.get_swap_to_be_code(struct, var, self.get_c_name())
180 def get_swap_to_host_code(self, struct, var):
181 return self.type.get_swap_to_host_code(struct, var, self.get_c_name())
185 def get_c_name(self):
186 return "vapi_union_%s" % self.name
189 return "typedef union {\n%s\n} %s;" % (
190 "\n".join([" %s %s;" % (i.get_c_name(), j)
191 for i, j in self.type_pairs]),
195 def needs_byte_swap(self):
199 class CStructType (StructType, CStruct):
200 def get_c_name(self):
201 return "vapi_type_%s" % self.name
203 def get_swap_to_be_func_name(self):
204 return "%s_hton" % self.get_c_name()
206 def get_swap_to_host_func_name(self):
207 return "%s_ntoh" % self.get_c_name()
209 def get_swap_to_be_func_decl(self):
210 return "void %s(%s *msg)" % (
211 self.get_swap_to_be_func_name(), self.get_c_name())
213 def get_swap_to_be_func_def(self):
214 return "%s\n{\n%s\n}" % (
215 self.get_swap_to_be_func_decl(),
217 " %s" % p.get_swap_to_be_code("msg->", "%s" % p.name)
218 for p in self.fields if p.needs_byte_swap()]),
221 def get_swap_to_host_func_decl(self):
222 return "void %s(%s *msg)" % (
223 self.get_swap_to_host_func_name(), self.get_c_name())
225 def get_swap_to_host_func_def(self):
226 return "%s\n{\n%s\n}" % (
227 self.get_swap_to_host_func_decl(),
229 " %s" % p.get_swap_to_host_code("msg->", "%s" % p.name)
230 for p in self.fields if p.needs_byte_swap()]),
233 def get_swap_to_be_code(self, struct, var):
234 return "%s(&%s%s);" % (self.get_swap_to_be_func_name(), struct, var)
236 def get_swap_to_host_code(self, struct, var):
237 return "%s(&%s%s);" % (self.get_swap_to_host_func_name(), struct, var)
239 def needs_byte_swap(self):
240 for f in self.fields:
241 if f.needs_byte_swap():
246 class CMessage (Message):
247 def __init__(self, logger, definition, json_parser):
248 super(CMessage, self).__init__(logger, definition, json_parser)
249 self.payload_members = [
250 " %s" % p.get_c_def()
252 if p.type != self.header
255 def has_payload(self):
256 return len(self.payload_members) > 0
258 def get_msg_id_name(self):
259 return "vapi_msg_id_%s" % self.name
261 def get_c_name(self):
262 return "vapi_msg_%s" % self.name
264 def get_payload_struct_name(self):
265 return "vapi_payload_%s" % self.name
267 def get_alloc_func_name(self):
268 return "vapi_alloc_%s" % self.name
270 def get_alloc_vla_param_names(self):
271 return [x for f in self.fields
273 for x in f.get_alloc_vla_param_names([])]
275 def get_alloc_func_decl(self):
276 return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
278 self.get_alloc_func_name(),
279 "".join([", size_t %s" % n for n in
280 self.get_alloc_vla_param_names()]))
282 def get_alloc_func_def(self):
284 if self.header.has_field('client_index'):
286 " msg->header.client_index = vapi_get_client_index(ctx);")
287 if self.header.has_field('context'):
288 extra.append(" msg->header.context = 0;")
290 "%s" % self.get_alloc_func_decl(),
292 " %s *msg = NULL;" % self.get_c_name(),
293 " const size_t size = sizeof(%s)%s;" % (
295 "".join([" + %s" % x for f in self.fields if f.has_vla()
296 for x in f.get_vla_calc_size_code("msg->payload",
298 " /* cast here required to play nicely with C++ world ... */",
299 " msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
304 " msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
305 self.get_msg_id_name(),
306 "".join([" %s;\n" % line
307 for f in self.fields if f.has_vla()
308 for line in f.get_vla_assign_code("msg->payload", [])]),
312 def get_calc_msg_size_func_name(self):
313 return "vapi_calc_%s_msg_size" % self.name
315 def get_calc_msg_size_func_decl(self):
316 return "uword %s(%s *msg)" % (
317 self.get_calc_msg_size_func_name(),
320 def get_calc_msg_size_func_def(self):
322 "%s" % self.get_calc_msg_size_func_decl(),
324 " return sizeof(*msg)%s;" %
325 "".join(["+ msg->payload.%s * sizeof(msg->payload.%s[0])" % (
329 if f.nelem_field is not None
335 if self.has_payload():
337 "typedef struct __attribute__ ((__packed__)) {",
339 ";\n".join(self.payload_members),
340 "} %s;" % self.get_payload_struct_name(),
342 "typedef struct __attribute__ ((__packed__)) {",
343 (" %s %s;" % (self.header.get_c_name(),
345 if self.header is not None else ""),
346 " %s payload;" % self.get_payload_struct_name(),
347 "} %s;" % self.get_c_name(), ])
350 "typedef struct __attribute__ ((__packed__)) {",
351 (" %s %s;" % (self.header.get_c_name(),
353 if self.header is not None else ""),
354 "} %s;" % self.get_c_name(), ])
356 def get_swap_payload_to_host_func_name(self):
357 return "%s_payload_ntoh" % self.get_c_name()
359 def get_swap_payload_to_be_func_name(self):
360 return "%s_payload_hton" % self.get_c_name()
362 def get_swap_payload_to_host_func_decl(self):
363 return "void %s(%s *payload)" % (
364 self.get_swap_payload_to_host_func_name(),
365 self.get_payload_struct_name())
367 def get_swap_payload_to_be_func_decl(self):
368 return "void %s(%s *payload)" % (
369 self.get_swap_payload_to_be_func_name(),
370 self.get_payload_struct_name())
372 def get_swap_payload_to_be_func_def(self):
373 return "%s\n{\n%s\n}" % (
374 self.get_swap_payload_to_be_func_decl(),
376 " %s" % p.get_swap_to_be_code("payload->", "%s" % p.name)
378 if p.needs_byte_swap() and p.type != self.header]),
381 def get_swap_payload_to_host_func_def(self):
382 return "%s\n{\n%s\n}" % (
383 self.get_swap_payload_to_host_func_decl(),
385 " %s" % p.get_swap_to_host_code("payload->", "%s" % p.name)
387 if p.needs_byte_swap() and p.type != self.header]),
390 def get_swap_to_host_func_name(self):
391 return "%s_ntoh" % self.get_c_name()
393 def get_swap_to_be_func_name(self):
394 return "%s_hton" % self.get_c_name()
396 def get_swap_to_host_func_decl(self):
397 return "void %s(%s *msg)" % (
398 self.get_swap_to_host_func_name(), self.get_c_name())
400 def get_swap_to_be_func_decl(self):
401 return "void %s(%s *msg)" % (
402 self.get_swap_to_be_func_name(), self.get_c_name())
404 def get_swap_to_be_func_def(self):
406 "%s" % self.get_swap_to_be_func_decl(),
408 (" VAPI_DBG(\"Swapping `%s'@%%p to big endian\", msg);" %
410 " %s(&msg->header);" % self.header.get_swap_to_be_func_name()
411 if self.header is not None else "",
412 " %s(&msg->payload);" % self.get_swap_payload_to_be_func_name()
413 if self.has_payload() else "",
417 def get_swap_to_host_func_def(self):
419 "%s" % self.get_swap_to_host_func_decl(),
421 (" VAPI_DBG(\"Swapping `%s'@%%p to host byte order\", msg);" %
423 " %s(&msg->header);" % self.header.get_swap_to_host_func_name()
424 if self.header is not None else "",
425 " %s(&msg->payload);" % self.get_swap_payload_to_host_func_name()
426 if self.has_payload() else "",
430 def get_op_func_name(self):
431 return "vapi_%s" % self.name
433 def get_op_func_decl(self):
434 if self.reply.has_payload():
435 return "vapi_error_e %s(%s)" % (
436 self.get_op_func_name(),
438 'struct vapi_ctx_s *ctx',
439 '%s *msg' % self.get_c_name(),
440 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
441 ' void *callback_ctx',
445 self.reply.get_payload_struct_name(),
446 'void *callback_ctx',
450 return "vapi_error_e %s(%s)" % (
451 self.get_op_func_name(),
453 'struct vapi_ctx_s *ctx',
454 '%s *msg' % self.get_c_name(),
455 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
456 ' void *callback_ctx',
459 'void *callback_ctx',
463 def get_op_func_def(self):
465 "%s" % self.get_op_func_decl(),
467 " if (!msg || !callback) {",
468 " return VAPI_EINVAL;",
470 " if (vapi_is_nonblocking(ctx) && vapi_requests_full(ctx)) {",
471 " return VAPI_EAGAIN;",
474 " if (VAPI_OK != (rv = vapi_producer_lock (ctx))) {",
477 " u32 req_context = vapi_gen_req_context(ctx);",
478 " msg->header.context = req_context;",
479 " %s(msg);" % self.get_swap_to_be_func_name(),
480 (" if (VAPI_OK == (rv = vapi_send_with_control_ping "
481 "(ctx, msg, req_context))) {"
482 if self.reply_is_stream else
483 " if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
485 (" vapi_store_request(ctx, req_context, %s, "
486 "(vapi_cb_t)callback, callback_ctx);" %
487 ("true" if self.reply_is_stream else "false")),
488 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
489 " abort (); /* this really shouldn't happen */",
491 " if (vapi_is_nonblocking(ctx)) {",
494 " rv = vapi_dispatch(ctx);",
497 " %s(msg);" % self.get_swap_to_host_func_name(),
498 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
499 " abort (); /* this really shouldn't happen */",
507 def get_event_cb_func_decl(self):
508 if not self.is_reply and not self.is_event:
510 "Cannot register event callback for non-reply message")
511 if self.has_payload():
513 "void vapi_set_%s_event_cb (" %
515 " struct vapi_ctx_s *ctx, ",
516 (" vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
517 "void *callback_ctx, %s *payload)," %
518 self.get_payload_struct_name()),
519 " void *callback_ctx)",
523 "void vapi_set_%s_event_cb (" %
525 " struct vapi_ctx_s *ctx, ",
526 " vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
527 "void *callback_ctx),",
528 " void *callback_ctx)",
531 def get_event_cb_func_def(self):
532 if not self.is_reply and not self.is_event:
534 "Cannot register event callback for non-reply function")
536 "%s" % self.get_event_cb_func_decl(),
538 (" vapi_set_event_cb(ctx, %s, (vapi_event_cb)callback, "
540 self.get_msg_id_name()),
543 def get_c_metadata_struct_name(self):
544 return "__vapi_metadata_%s" % self.name
546 def get_c_constructor(self):
548 if self.header is not None:
549 has_context = self.header.has_field('context')
551 'static void __attribute__((constructor)) __vapi_constructor_%s()'
554 ' static const char name[] = "%s";' % self.name,
555 ' static const char name_with_crc[] = "%s_%s";'
556 % (self.name, self.crc[2:]),
557 ' static vapi_message_desc_t %s = {' %
558 self.get_c_metadata_struct_name(),
560 ' sizeof(name) - 1,',
562 ' sizeof(name_with_crc) - 1,',
563 ' true,' if has_context else ' false,',
564 ' offsetof(%s, context),' % self.header.get_c_name()
565 if has_context else ' 0,',
566 (' offsetof(%s, payload),' % self.get_c_name())
567 if self.has_payload() else ' VAPI_INVALID_MSG_ID,',
568 ' sizeof(%s),' % self.get_c_name(),
569 ' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
570 ' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
571 ' VAPI_INVALID_MSG_ID,',
574 ' %s = vapi_register_msg(&%s);' %
575 (self.get_msg_id_name(), self.get_c_metadata_struct_name()),
576 ' VAPI_DBG("Assigned msg id %%d to %s", %s);' %
577 (self.name, self.get_msg_id_name()),
582 vapi_send_with_control_ping = """
583 static inline vapi_error_e
584 vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
586 vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
591 ping->header.context = context;
592 vapi_msg_control_ping_hton (ping);
593 return vapi_send2 (ctx, msg, ping);
598 def emit_definition(parser, json_file, emitted, o):
601 if o.name in ("msg_header1_t", "msg_header2_t"):
603 if hasattr(o, "depends"):
605 emit_definition(parser, json_file, emitted, x)
606 if hasattr(o, "reply"):
607 emit_definition(parser, json_file, emitted, o.reply)
608 if hasattr(o, "get_c_def"):
609 if (o not in parser.enums_by_json[json_file] and
610 o not in parser.types_by_json[json_file] and
611 o not in parser.unions_by_json[json_file] and
612 o.name not in parser.messages_by_json[json_file]):
614 guard = "defined_%s" % o.get_c_name()
615 print("#ifndef %s" % guard)
616 print("#define %s" % guard)
617 print("%s" % o.get_c_def())
619 function_attrs = "static inline "
620 if o.name in parser.messages_by_json[json_file]:
622 print("%s%s" % (function_attrs,
623 o.get_swap_payload_to_be_func_def()))
625 print("%s%s" % (function_attrs,
626 o.get_swap_payload_to_host_func_def()))
628 print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
630 print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
632 print("%s%s" % (function_attrs, o.get_calc_msg_size_func_def()))
633 if not o.is_reply and not o.is_event:
635 print("%s%s" % (function_attrs, o.get_alloc_func_def()))
637 print("%s%s" % (function_attrs, o.get_op_func_def()))
639 print("%s" % o.get_c_constructor())
640 if o.is_reply or o.is_event:
642 print("%s%s;" % (function_attrs, o.get_event_cb_func_def()))
643 elif hasattr(o, "get_swap_to_be_func_def"):
644 print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
646 print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
652 def gen_json_unified_header(parser, logger, j, io, name):
653 d, f = os.path.split(j)
654 logger.info("Generating header `%s'" % name)
655 orig_stdout = sys.stdout
657 include_guard = "__included_%s" % (
658 j.replace(".", "_").replace("/", "_").replace("-", "_"))
659 print("#ifndef %s" % include_guard)
660 print("#define %s" % include_guard)
662 print("#include <stdlib.h>")
663 print("#include <stddef.h>")
664 print("#include <arpa/inet.h>")
665 print("#include <vapi/vapi_internal.h>")
666 print("#include <vapi/vapi.h>")
667 print("#include <vapi/vapi_dbg.h>")
669 print("#ifdef __cplusplus")
670 print("extern \"C\" {")
672 if name == "vpe.api.vapi.h":
674 print("static inline vapi_error_e vapi_send_with_control_ping "
675 "(vapi_ctx_t ctx, void * msg, u32 context);")
677 print("#include <vapi/vpe.api.vapi.h>")
679 for m in parser.messages_by_json[j].values():
680 print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
682 print("#define DEFINE_VAPI_MSG_IDS_%s\\" %
683 f.replace(".", "_").replace("/", "_").replace("-", "_").upper())
685 " vapi_msg_id_t %s;" % m.get_msg_id_name()
686 for m in parser.messages_by_json[j].values()
691 for e in parser.enums_by_json[j]:
692 emit_definition(parser, j, emitted, e)
693 for u in parser.unions_by_json[j]:
694 emit_definition(parser, j, emitted, u)
695 for t in parser.types_by_json[j]:
696 emit_definition(parser, j, emitted, t)
697 for m in parser.messages_by_json[j].values():
698 emit_definition(parser, j, emitted, m)
702 if name == "vpe.api.vapi.h":
703 print("%s" % vapi_send_with_control_ping)
706 print("#ifdef __cplusplus")
711 sys.stdout = orig_stdout
714 def json_to_c_header_name(json_name):
715 if json_name.endswith(".json"):
716 return "%s.vapi.h" % os.path.splitext(json_name)[0]
717 raise Exception("Unexpected json name `%s'!" % json_name)
720 def gen_c_unified_headers(parser, logger, prefix, remove_path):
721 if prefix == "" or prefix is None:
724 prefix = "%s/" % prefix
725 for j in parser.json_files:
727 d, f = os.path.split(j)
730 with open('%s%s' % (prefix, json_to_c_header_name(f)), "w") as io:
731 gen_json_unified_header(
732 parser, logger, j, io, json_to_c_header_name(f))
735 if __name__ == '__main__':
737 verbose = int(os.getenv("V", 0))
748 logging.basicConfig(stream=sys.stdout, level=log_level)
749 logger = logging.getLogger("VAPI C GEN")
750 logger.setLevel(log_level)
752 argparser = argparse.ArgumentParser(description="VPP C API generator")
753 argparser.add_argument('files', metavar='api-file', action='append',
754 type=str, help='json api file'
755 '(may be specified multiple times)')
756 argparser.add_argument('--prefix', action='store', default=None,
758 argparser.add_argument('--remove-path', action='store_true',
759 help='remove path from filename')
760 args = argparser.parse_args()
762 jsonparser = JsonParser(logger, args.files,
763 simple_type_class=CSimpleType,
766 struct_type_class=CStructType,
768 message_class=CMessage)
770 # not using the model of having separate generated header and code files
771 # with generated symbols present in shared library (per discussion with
772 # Damjan), to avoid symbol version issues in .so
773 # gen_c_headers_and_code(jsonparser, logger, args.prefix)
775 gen_c_unified_headers(jsonparser, logger, args.prefix, args.remove_path)
777 for e in jsonparser.exceptions: