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.type.get_c_name() == 'vl_api_string_t':
18 return "u8 %s[%d];" % (self.name, self.len)
20 return "vl_api_string_t %s;" % (self.name)
22 if self.len is not None:
23 return "%s %s[%d];" % (self.type.get_c_name(), self.name, self.len)
25 return "%s %s;" % (self.type.get_c_name(), self.name)
27 def get_swap_to_be_code(self, struct, var):
28 if self.len is not None:
30 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
33 self.type.get_swap_to_be_code(struct, "%s[i]" % var))
35 if self.nelem_field.needs_byte_swap():
36 nelem_field = "%s(%s%s)" % (
37 self.nelem_field.type.get_swap_to_host_func_name(),
38 struct, self.nelem_field.name)
40 nelem_field = "%s%s" % (struct, self.nelem_field.name)
42 "do { unsigned i; for (i = 0; i < %s; ++i) { %s } }"
44 (nelem_field, self.type.get_swap_to_be_code(
45 struct, "%s[i]" % var)))
46 return self.type.get_swap_to_be_code(struct, "%s" % var)
48 def get_swap_to_host_code(self, struct, var):
49 if self.len is not None:
51 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
54 self.type.get_swap_to_host_code(struct, "%s[i]" % var))
56 # nelem_field already swapped to host here...
58 "do { unsigned i; for (i = 0; i < %s%s; ++i) { %s } }"
60 (struct, self.nelem_field.name,
61 self.type.get_swap_to_host_code(
62 struct, "%s[i]" % var)))
63 return self.type.get_swap_to_host_code(struct, "%s" % var)
65 def needs_byte_swap(self):
66 return self.type.needs_byte_swap()
68 def get_vla_field_length_name(self, path):
69 return "%s_%s_array_size" % ("_".join(path), self.name)
71 def get_alloc_vla_param_names(self, path):
73 result = [self.get_vla_field_length_name(path)]
76 if self.type.has_vla():
77 t = self.type.get_alloc_vla_param_names(path + [self.name])
81 def get_vla_calc_size_code(self, prefix, path):
83 result = ["sizeof(%s.%s[0]) * %s" % (
84 ".".join([prefix] + path),
86 self.get_vla_field_length_name(path))]
89 if self.type.has_vla():
90 t = self.type.get_vla_calc_size_code(prefix, path + [self.name])
94 def get_vla_assign_code(self, prefix, path):
97 result.append("%s.%s = %s" % (
98 ".".join([prefix] + path),
99 self.nelem_field.name,
100 self.get_vla_field_length_name(path)))
101 if self.type.has_vla():
102 t = self.type.get_vla_assign_code(prefix, path + [self.name])
107 class CAlias(CField):
108 def get_c_name(self):
109 return "vapi_type_%s" % self.name
112 if self.len is not None:
113 return "typedef %s vapi_type_%s[%d];" % (
114 self.type.get_c_name(), self.name, self.len)
116 return "typedef %s vapi_type_%s;" % (
117 self.type.get_c_name(), self.name)
120 class CStruct(Struct):
123 "typedef struct __attribute__((__packed__)) {\n%s" % (
124 "\n".join([" %s" % x.get_c_def()
125 for x in self.fields])),
126 "} %s;" % self.get_c_name()])
128 def get_vla_assign_code(self, prefix, path):
129 return [x for f in self.fields if f.has_vla()
130 for x in f.get_vla_assign_code(prefix, path)]
132 def get_alloc_vla_param_names(self, path):
133 return [x for f in self.fields
135 for x in f.get_alloc_vla_param_names(path)]
137 def get_vla_calc_size_code(self, prefix, path):
138 return [x for f in self.fields if f.has_vla()
139 for x in f.get_vla_calc_size_code(prefix, path)]
142 class CSimpleType (SimpleType):
145 'i16': 'htobe16', 'u16': 'htobe16',
146 'i32': 'htobe32', 'u32': 'htobe32',
147 'i64': 'htobe64', 'u64': 'htobe64',
150 swap_to_host_dict = {
151 'i16': 'be16toh', 'u16': 'be16toh',
152 'i32': 'be32toh', 'u32': 'be32toh',
153 'i64': 'be64toh', 'u64': 'be64toh',
156 def get_c_name(self):
159 def get_swap_to_be_func_name(self):
160 return self.swap_to_be_dict[self.name]
162 def get_swap_to_host_func_name(self):
163 return self.swap_to_host_dict[self.name]
165 def get_swap_to_be_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_be_func_name(), x)
171 def get_swap_to_host_code(self, struct, var, cast=None):
172 x = "%s%s" % (struct, var)
173 return "%s = %s%s(%s);" % (x,
174 "(%s)" % cast if cast else "",
175 self.get_swap_to_host_func_name(), x)
177 def needs_byte_swap(self):
179 self.get_swap_to_host_func_name()
187 def get_c_name(self):
188 return "vapi_enum_%s" % self.name
191 return "typedef enum {\n%s\n} %s;" % (
192 "\n".join([" %s = %s," % (i, j) for i, j in self.value_pairs]),
196 def needs_byte_swap(self):
197 return self.type.needs_byte_swap()
199 def get_swap_to_be_code(self, struct, var):
200 return self.type.get_swap_to_be_code(struct, var, self.get_c_name())
202 def get_swap_to_host_code(self, struct, var):
203 return self.type.get_swap_to_host_code(struct, var, self.get_c_name())
207 def get_c_name(self):
208 return "vapi_union_%s" % self.name
211 return "typedef union {\n%s\n} %s;" % (
212 "\n".join([" %s %s;" % (i.get_c_name(), j)
213 for i, j in self.type_pairs]),
217 def needs_byte_swap(self):
221 class CStructType (StructType, CStruct):
222 def get_c_name(self):
223 return "vapi_type_%s" % self.name
225 def get_swap_to_be_func_name(self):
226 return "%s_hton" % self.get_c_name()
228 def get_swap_to_host_func_name(self):
229 return "%s_ntoh" % self.get_c_name()
231 def get_swap_to_be_func_decl(self):
232 return "void %s(%s *msg)" % (
233 self.get_swap_to_be_func_name(), self.get_c_name())
235 def get_swap_to_be_func_def(self):
236 return "%s\n{\n%s\n}" % (
237 self.get_swap_to_be_func_decl(),
239 " %s" % p.get_swap_to_be_code("msg->", "%s" % p.name)
240 for p in self.fields if p.needs_byte_swap()]),
243 def get_swap_to_host_func_decl(self):
244 return "void %s(%s *msg)" % (
245 self.get_swap_to_host_func_name(), self.get_c_name())
247 def get_swap_to_host_func_def(self):
248 return "%s\n{\n%s\n}" % (
249 self.get_swap_to_host_func_decl(),
251 " %s" % p.get_swap_to_host_code("msg->", "%s" % p.name)
252 for p in self.fields if p.needs_byte_swap()]),
255 def get_swap_to_be_code(self, struct, var):
256 return "%s(&%s%s);" % (self.get_swap_to_be_func_name(), struct, var)
258 def get_swap_to_host_code(self, struct, var):
259 return "%s(&%s%s);" % (self.get_swap_to_host_func_name(), struct, var)
261 def needs_byte_swap(self):
262 for f in self.fields:
263 if f.needs_byte_swap():
268 class CMessage (Message):
269 def __init__(self, logger, definition, json_parser):
270 super(CMessage, self).__init__(logger, definition, json_parser)
271 self.payload_members = [
272 " %s" % p.get_c_def()
274 if p.type != self.header
277 def has_payload(self):
278 return len(self.payload_members) > 0
280 def get_msg_id_name(self):
281 return "vapi_msg_id_%s" % self.name
283 def get_c_name(self):
284 return "vapi_msg_%s" % self.name
286 def get_payload_struct_name(self):
287 return "vapi_payload_%s" % self.name
289 def get_alloc_func_name(self):
290 return "vapi_alloc_%s" % self.name
292 def get_alloc_vla_param_names(self):
293 return [x for f in self.fields
295 for x in f.get_alloc_vla_param_names([])]
297 def get_alloc_func_decl(self):
298 return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
300 self.get_alloc_func_name(),
301 "".join([", size_t %s" % n for n in
302 self.get_alloc_vla_param_names()]))
304 def get_alloc_func_def(self):
306 if self.header.has_field('client_index'):
308 " msg->header.client_index = vapi_get_client_index(ctx);")
309 if self.header.has_field('context'):
310 extra.append(" msg->header.context = 0;")
312 "%s" % self.get_alloc_func_decl(),
314 " %s *msg = NULL;" % self.get_c_name(),
315 " const size_t size = sizeof(%s)%s;" % (
317 "".join([" + %s" % x for f in self.fields if f.has_vla()
318 for x in f.get_vla_calc_size_code("msg->payload",
320 " /* cast here required to play nicely with C++ world ... */",
321 " msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
326 " msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
327 self.get_msg_id_name(),
328 "".join([" %s;\n" % line
329 for f in self.fields if f.has_vla()
330 for line in f.get_vla_assign_code("msg->payload", [])]),
334 def get_calc_msg_size_func_name(self):
335 return "vapi_calc_%s_msg_size" % self.name
337 def get_calc_msg_size_func_decl(self):
338 return "uword %s(%s *msg)" % (
339 self.get_calc_msg_size_func_name(),
342 def get_calc_msg_size_func_def(self):
344 "%s" % self.get_calc_msg_size_func_decl(),
346 " return sizeof(*msg)%s;" %
347 "".join(["+ msg->payload.%s * sizeof(msg->payload.%s[0])" % (
351 if f.nelem_field is not None
357 if self.has_payload():
359 "typedef struct __attribute__ ((__packed__)) {",
361 "\n".join(self.payload_members),
362 "} %s;" % self.get_payload_struct_name(),
364 "typedef struct __attribute__ ((__packed__)) {",
365 (" %s %s;" % (self.header.get_c_name(),
367 if self.header is not None else ""),
368 " %s payload;" % self.get_payload_struct_name(),
369 "} %s;" % self.get_c_name(), ])
372 "typedef struct __attribute__ ((__packed__)) {",
373 (" %s %s;" % (self.header.get_c_name(),
375 if self.header is not None else ""),
376 "} %s;" % self.get_c_name(), ])
378 def get_swap_payload_to_host_func_name(self):
379 return "%s_payload_ntoh" % self.get_c_name()
381 def get_swap_payload_to_be_func_name(self):
382 return "%s_payload_hton" % self.get_c_name()
384 def get_swap_payload_to_host_func_decl(self):
385 return "void %s(%s *payload)" % (
386 self.get_swap_payload_to_host_func_name(),
387 self.get_payload_struct_name())
389 def get_swap_payload_to_be_func_decl(self):
390 return "void %s(%s *payload)" % (
391 self.get_swap_payload_to_be_func_name(),
392 self.get_payload_struct_name())
394 def get_swap_payload_to_be_func_def(self):
395 return "%s\n{\n%s\n}" % (
396 self.get_swap_payload_to_be_func_decl(),
398 " %s" % p.get_swap_to_be_code("payload->", "%s" % p.name)
400 if p.needs_byte_swap() and p.type != self.header]),
403 def get_swap_payload_to_host_func_def(self):
404 return "%s\n{\n%s\n}" % (
405 self.get_swap_payload_to_host_func_decl(),
407 " %s" % p.get_swap_to_host_code("payload->", "%s" % p.name)
409 if p.needs_byte_swap() and p.type != self.header]),
412 def get_swap_to_host_func_name(self):
413 return "%s_ntoh" % self.get_c_name()
415 def get_swap_to_be_func_name(self):
416 return "%s_hton" % self.get_c_name()
418 def get_swap_to_host_func_decl(self):
419 return "void %s(%s *msg)" % (
420 self.get_swap_to_host_func_name(), self.get_c_name())
422 def get_swap_to_be_func_decl(self):
423 return "void %s(%s *msg)" % (
424 self.get_swap_to_be_func_name(), self.get_c_name())
426 def get_swap_to_be_func_def(self):
428 "%s" % self.get_swap_to_be_func_decl(),
430 (" VAPI_DBG(\"Swapping `%s'@%%p to big endian\", msg);" %
432 " %s(&msg->header);" % self.header.get_swap_to_be_func_name()
433 if self.header is not None else "",
434 " %s(&msg->payload);" % self.get_swap_payload_to_be_func_name()
435 if self.has_payload() else "",
439 def get_swap_to_host_func_def(self):
441 "%s" % self.get_swap_to_host_func_decl(),
443 (" VAPI_DBG(\"Swapping `%s'@%%p to host byte order\", msg);" %
445 " %s(&msg->header);" % self.header.get_swap_to_host_func_name()
446 if self.header is not None else "",
447 " %s(&msg->payload);" % self.get_swap_payload_to_host_func_name()
448 if self.has_payload() else "",
452 def get_op_func_name(self):
453 return "vapi_%s" % self.name
455 def get_op_func_decl(self):
456 if self.reply.has_payload():
457 return "vapi_error_e %s(%s)" % (
458 self.get_op_func_name(),
460 'struct vapi_ctx_s *ctx',
461 '%s *msg' % self.get_c_name(),
462 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
463 ' void *callback_ctx',
467 self.reply.get_payload_struct_name(),
468 'void *callback_ctx',
472 return "vapi_error_e %s(%s)" % (
473 self.get_op_func_name(),
475 'struct vapi_ctx_s *ctx',
476 '%s *msg' % self.get_c_name(),
477 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
478 ' void *callback_ctx',
481 'void *callback_ctx',
485 def get_op_func_def(self):
487 "%s" % self.get_op_func_decl(),
489 " if (!msg || !callback) {",
490 " return VAPI_EINVAL;",
492 " if (vapi_is_nonblocking(ctx) && vapi_requests_full(ctx)) {",
493 " return VAPI_EAGAIN;",
496 " if (VAPI_OK != (rv = vapi_producer_lock (ctx))) {",
499 " u32 req_context = vapi_gen_req_context(ctx);",
500 " msg->header.context = req_context;",
501 " %s(msg);" % self.get_swap_to_be_func_name(),
502 (" if (VAPI_OK == (rv = vapi_send_with_control_ping "
503 "(ctx, msg, req_context))) {"
504 if self.reply_is_stream else
505 " if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
507 (" vapi_store_request(ctx, req_context, %s, "
508 "(vapi_cb_t)callback, callback_ctx);" %
509 ("true" if self.reply_is_stream else "false")),
510 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
511 " abort (); /* this really shouldn't happen */",
513 " if (vapi_is_nonblocking(ctx)) {",
516 " rv = vapi_dispatch(ctx);",
519 " %s(msg);" % self.get_swap_to_host_func_name(),
520 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
521 " abort (); /* this really shouldn't happen */",
529 def get_event_cb_func_decl(self):
530 if not self.is_reply and not self.is_event:
532 "Cannot register event callback for non-reply message")
533 if self.has_payload():
535 "void vapi_set_%s_event_cb (" %
537 " struct vapi_ctx_s *ctx, ",
538 (" vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
539 "void *callback_ctx, %s *payload)," %
540 self.get_payload_struct_name()),
541 " void *callback_ctx)",
545 "void vapi_set_%s_event_cb (" %
547 " struct vapi_ctx_s *ctx, ",
548 " vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
549 "void *callback_ctx),",
550 " void *callback_ctx)",
553 def get_event_cb_func_def(self):
554 if not self.is_reply and not self.is_event:
556 "Cannot register event callback for non-reply function")
558 "%s" % self.get_event_cb_func_decl(),
560 (" vapi_set_event_cb(ctx, %s, (vapi_event_cb)callback, "
562 self.get_msg_id_name()),
565 def get_c_metadata_struct_name(self):
566 return "__vapi_metadata_%s" % self.name
568 def get_c_constructor(self):
570 if self.header is not None:
571 has_context = self.header.has_field('context')
573 'static void __attribute__((constructor)) __vapi_constructor_%s()'
576 ' static const char name[] = "%s";' % self.name,
577 ' static const char name_with_crc[] = "%s_%s";'
578 % (self.name, self.crc[2:]),
579 ' static vapi_message_desc_t %s = {' %
580 self.get_c_metadata_struct_name(),
582 ' sizeof(name) - 1,',
584 ' sizeof(name_with_crc) - 1,',
585 ' true,' if has_context else ' false,',
586 ' offsetof(%s, context),' % self.header.get_c_name()
587 if has_context else ' 0,',
588 (' offsetof(%s, payload),' % self.get_c_name())
589 if self.has_payload() else ' VAPI_INVALID_MSG_ID,',
590 ' sizeof(%s),' % self.get_c_name(),
591 ' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
592 ' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
593 ' VAPI_INVALID_MSG_ID,',
596 ' %s = vapi_register_msg(&%s);' %
597 (self.get_msg_id_name(), self.get_c_metadata_struct_name()),
598 ' VAPI_DBG("Assigned msg id %%d to %s", %s);' %
599 (self.name, self.get_msg_id_name()),
604 vapi_send_with_control_ping = """
605 static inline vapi_error_e
606 vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
608 vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
613 ping->header.context = context;
614 vapi_msg_control_ping_hton (ping);
615 return vapi_send2 (ctx, msg, ping);
620 def emit_definition(parser, json_file, emitted, o):
623 if o.name in ("msg_header1_t", "msg_header2_t"):
625 if hasattr(o, "depends"):
627 emit_definition(parser, json_file, emitted, x)
628 if hasattr(o, "reply"):
629 emit_definition(parser, json_file, emitted, o.reply)
630 if hasattr(o, "get_c_def"):
631 if (o not in parser.enums_by_json[json_file] and
632 o not in parser.types_by_json[json_file] and
633 o not in parser.unions_by_json[json_file] and
634 o.name not in parser.messages_by_json[json_file] and
635 o not in parser.aliases_by_json[json_file]):
637 guard = "defined_%s" % o.get_c_name()
638 print("#ifndef %s" % guard)
639 print("#define %s" % guard)
640 print("%s" % o.get_c_def())
642 function_attrs = "static inline "
643 if o.name in parser.messages_by_json[json_file]:
645 print("%s%s" % (function_attrs,
646 o.get_swap_payload_to_be_func_def()))
648 print("%s%s" % (function_attrs,
649 o.get_swap_payload_to_host_func_def()))
651 print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
653 print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
655 print("%s%s" % (function_attrs, o.get_calc_msg_size_func_def()))
656 if not o.is_reply and not o.is_event:
658 print("%s%s" % (function_attrs, o.get_alloc_func_def()))
660 print("%s%s" % (function_attrs, o.get_op_func_def()))
662 print("%s" % o.get_c_constructor())
663 if o.is_reply or o.is_event:
665 print("%s%s;" % (function_attrs, o.get_event_cb_func_def()))
666 elif hasattr(o, "get_swap_to_be_func_def"):
667 print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
669 print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
675 def gen_json_unified_header(parser, logger, j, io, name):
676 d, f = os.path.split(j)
677 logger.info("Generating header `%s'" % name)
678 orig_stdout = sys.stdout
680 include_guard = "__included_%s" % (
681 j.replace(".", "_").replace("/", "_").replace("-", "_"))
682 print("#ifndef %s" % include_guard)
683 print("#define %s" % include_guard)
685 print("#include <stdlib.h>")
686 print("#include <stddef.h>")
687 print("#include <arpa/inet.h>")
688 print("#include <vapi/vapi_internal.h>")
689 print("#include <vapi/vapi.h>")
690 print("#include <vapi/vapi_dbg.h>")
692 print("#ifdef __cplusplus")
693 print("extern \"C\" {")
695 if name == "vpe.api.vapi.h":
697 print("static inline vapi_error_e vapi_send_with_control_ping "
698 "(vapi_ctx_t ctx, void * msg, u32 context);")
700 print("#include <vapi/vpe.api.vapi.h>")
702 for m in parser.messages_by_json[j].values():
703 print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
705 print("#define DEFINE_VAPI_MSG_IDS_%s\\" %
706 f.replace(".", "_").replace("/", "_").replace("-", "_").upper())
708 " vapi_msg_id_t %s;" % m.get_msg_id_name()
709 for m in parser.messages_by_json[j].values()
714 for e in parser.enums_by_json[j]:
715 emit_definition(parser, j, emitted, e)
716 for u in parser.unions_by_json[j]:
717 emit_definition(parser, j, emitted, u)
718 for t in parser.types_by_json[j]:
719 emit_definition(parser, j, emitted, t)
720 for a in parser.aliases_by_json[j]:
721 emit_definition(parser, j, emitted, a)
722 for m in parser.messages_by_json[j].values():
723 emit_definition(parser, j, emitted, m)
727 if name == "vpe.api.vapi.h":
728 print("%s" % vapi_send_with_control_ping)
731 print("#ifdef __cplusplus")
736 sys.stdout = orig_stdout
739 def json_to_c_header_name(json_name):
740 if json_name.endswith(".json"):
741 return "%s.vapi.h" % os.path.splitext(json_name)[0]
742 raise Exception("Unexpected json name `%s'!" % json_name)
745 def gen_c_unified_headers(parser, logger, prefix, remove_path):
746 if prefix == "" or prefix is None:
749 prefix = "%s/" % prefix
750 for j in parser.json_files:
752 d, f = os.path.split(j)
755 with open('%s%s' % (prefix, json_to_c_header_name(f)), "w") as io:
756 gen_json_unified_header(
757 parser, logger, j, io, json_to_c_header_name(f))
760 if __name__ == '__main__':
762 verbose = int(os.getenv("V", 0))
773 logging.basicConfig(stream=sys.stdout, level=log_level)
774 logger = logging.getLogger("VAPI C GEN")
775 logger.setLevel(log_level)
777 argparser = argparse.ArgumentParser(description="VPP C API generator")
778 argparser.add_argument('files', metavar='api-file', action='append',
779 type=str, help='json api file'
780 '(may be specified multiple times)')
781 argparser.add_argument('--prefix', action='store', default=None,
783 argparser.add_argument('--remove-path', action='store_true',
784 help='remove path from filename')
785 args = argparser.parse_args()
787 jsonparser = JsonParser(logger, args.files,
788 simple_type_class=CSimpleType,
791 struct_type_class=CStructType,
793 message_class=CMessage,
796 # not using the model of having separate generated header and code files
797 # with generated symbols present in shared library (per discussion with
798 # Damjan), to avoid symbol version issues in .so
799 # gen_c_headers_and_code(jsonparser, logger, args.prefix)
801 gen_c_unified_headers(jsonparser, logger, args.prefix, args.remove_path)
803 for e in jsonparser.exceptions: