7 from vapi_json_parser import Field, Struct, Message, JsonParser,\
18 super(CField, self).__init__(
19 field_name, field_type, array_len, nelem_field)
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()
69 class CStruct(Struct):
70 def __init__(self, name, fields):
71 super(CStruct, self).__init__(name, fields)
73 def duplicate_barrier(func):
74 def func_wrapper(self):
75 name = self.get_c_name()
76 return "#ifndef defined_{}\n#define defined_{}\n{}\n#endif".format(name, name, func(self))
82 "typedef struct __attribute__((__packed__)) {",
83 "%s;" % ";\n".join([" %s" % x.get_c_def()
84 for x in self.fields]),
85 "} %s;" % self.get_c_name()])
88 class CSimpleType (SimpleType):
91 'i16': 'htobe16', 'u16': 'htobe16',
92 'i32': 'htobe32', 'u32': 'htobe32',
93 'i64': 'htobe64', 'u64': 'htobe64',
97 'i16': 'be16toh', 'u16': 'be16toh',
98 'i32': 'be32toh', 'u32': 'be32toh',
99 'i64': 'be64toh', 'u64': 'be64toh',
102 def __init__(self, name):
103 super(CSimpleType, self).__init__(name)
105 def get_c_name(self):
108 def get_swap_to_be_func_name(self):
109 return self.swap_to_be_dict[self.name]
111 def get_swap_to_host_func_name(self):
112 return self.swap_to_host_dict[self.name]
114 def get_swap_to_be_code(self, struct, var):
115 x = "%s%s" % (struct, var)
116 return "%s = %s(%s);" % (x, self.get_swap_to_be_func_name(), x)
118 def get_swap_to_host_code(self, struct, var):
119 x = "%s%s" % (struct, var)
120 return "%s = %s(%s);" % (x, self.get_swap_to_host_func_name(), x)
122 def needs_byte_swap(self):
124 self.get_swap_to_host_func_name()
131 class CStructType (StructType, CStruct):
132 def __init__(self, definition, typedict, field_class):
133 super(CStructType, self).__init__(definition, typedict, field_class)
135 def get_c_name(self):
136 return "vapi_type_%s" % self.name
138 def get_swap_to_be_func_name(self):
139 return "%s_hton" % self.get_c_name()
141 def get_swap_to_host_func_name(self):
142 return "%s_ntoh" % self.get_c_name()
144 def get_swap_to_be_func_decl(self):
145 return "void %s(%s *msg)" % (
146 self.get_swap_to_be_func_name(), self.get_c_name())
148 def get_swap_to_be_func_def(self):
149 return "%s\n{\n%s\n}" % (
150 self.get_swap_to_be_func_decl(),
152 " %s" % p.get_swap_to_be_code("msg->", "%s" % p.name)
153 for p in self.fields if p.needs_byte_swap()]),
156 def get_swap_to_host_func_decl(self):
157 return "void %s(%s *msg)" % (
158 self.get_swap_to_host_func_name(), self.get_c_name())
160 def get_swap_to_host_func_def(self):
161 return "%s\n{\n%s\n}" % (
162 self.get_swap_to_host_func_decl(),
164 " %s" % p.get_swap_to_host_code("msg->", "%s" % p.name)
165 for p in self.fields if p.needs_byte_swap()]),
168 def get_swap_to_be_code(self, struct, var):
169 return "%s(&%s%s);" % (self.get_swap_to_be_func_name(), struct, var)
171 def get_swap_to_host_code(self, struct, var):
172 return "%s(&%s%s);" % (self.get_swap_to_host_func_name(), struct, var)
174 def needs_byte_swap(self):
175 for f in self.fields:
176 if f.needs_byte_swap():
181 class CMessage (Message):
182 def __init__(self, logger, definition, typedict,
183 struct_type_class, simple_type_class, field_class):
184 super(CMessage, self).__init__(logger, definition, typedict,
185 struct_type_class, simple_type_class,
187 self.payload_members = [
188 " %s" % p.get_c_def()
190 if p.type != self.header
193 def has_payload(self):
194 return len(self.payload_members) > 0
196 def get_msg_id_name(self):
197 return "vapi_msg_id_%s" % self.name
199 def get_c_name(self):
200 return "vapi_msg_%s" % self.name
202 def get_payload_struct_name(self):
203 return "vapi_payload_%s" % self.name
205 def get_alloc_func_vla_field_length_name(self, field):
206 return "%s_array_size" % field.name
208 def get_alloc_func_name(self):
209 return "vapi_alloc_%s" % self.name
211 def get_alloc_vla_param_names(self):
212 return [self.get_alloc_func_vla_field_length_name(f)
214 if f.nelem_field is not None]
216 def get_alloc_func_decl(self):
217 return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
219 self.get_alloc_func_name(),
220 "".join([", size_t %s" % n for n in
221 self.get_alloc_vla_param_names()]))
223 def get_alloc_func_def(self):
225 if self.header.has_field('client_index'):
227 " msg->header.client_index = vapi_get_client_index(ctx);")
228 if self.header.has_field('context'):
229 extra.append(" msg->header.context = 0;")
231 "%s" % self.get_alloc_func_decl(),
233 " %s *msg = NULL;" % self.get_c_name(),
234 " const size_t size = sizeof(%s)%s;" % (
237 " + sizeof(msg->payload.%s[0]) * %s" % (
239 self.get_alloc_func_vla_field_length_name(f))
241 if f.nelem_field is not None
243 " /* cast here required to play nicely with C++ world ... */",
244 " msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
249 " msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
250 self.get_msg_id_name(),
251 "\n".join([" msg->payload.%s = %s;" % (
253 self.get_alloc_func_vla_field_length_name(f))
255 if f.nelem_field is not None]),
259 def get_calc_msg_size_func_name(self):
260 return "vapi_calc_%s_msg_size" % self.name
262 def get_calc_msg_size_func_decl(self):
263 return "uword %s(%s *msg)" % (
264 self.get_calc_msg_size_func_name(),
267 def get_calc_msg_size_func_def(self):
269 "%s" % self.get_calc_msg_size_func_decl(),
271 " return sizeof(*msg)%s;" %
272 "".join(["+ msg->payload.%s * sizeof(msg->payload.%s[0])" % (
276 if f.nelem_field is not None
281 def duplicate_barrier(func):
282 def func_wrapper(self):
283 name = self.get_payload_struct_name()
284 return "#ifndef defined_{}\n#define defined_{}\n{}\n#endif".format(name, name, func(self))
289 if self.has_payload():
291 "typedef struct __attribute__ ((__packed__)) {",
293 ";\n".join(self.payload_members),
294 "} %s;" % self.get_payload_struct_name(),
296 "typedef struct __attribute__ ((__packed__)) {",
297 (" %s %s;" % (self.header.get_c_name(),
299 if self.header is not None else ""),
300 " %s payload;" % self.get_payload_struct_name(),
301 "} %s;" % self.get_c_name(), ])
304 "typedef struct __attribute__ ((__packed__)) {",
305 (" %s %s;" % (self.header.get_c_name(),
307 if self.header is not None else ""),
308 "} %s;" % self.get_c_name(), ])
310 def get_swap_payload_to_host_func_name(self):
311 return "%s_payload_ntoh" % self.get_c_name()
313 def get_swap_payload_to_be_func_name(self):
314 return "%s_payload_hton" % self.get_c_name()
316 def get_swap_payload_to_host_func_decl(self):
317 return "void %s(%s *payload)" % (
318 self.get_swap_payload_to_host_func_name(),
319 self.get_payload_struct_name())
321 def get_swap_payload_to_be_func_decl(self):
322 return "void %s(%s *payload)" % (
323 self.get_swap_payload_to_be_func_name(),
324 self.get_payload_struct_name())
326 def get_swap_payload_to_be_func_def(self):
327 return "%s\n{\n%s\n}" % (
328 self.get_swap_payload_to_be_func_decl(),
330 " %s" % p.get_swap_to_be_code("payload->", "%s" % p.name)
332 if p.needs_byte_swap() and p.type != self.header]),
335 def get_swap_payload_to_host_func_def(self):
336 return "%s\n{\n%s\n}" % (
337 self.get_swap_payload_to_host_func_decl(),
339 " %s" % p.get_swap_to_host_code("payload->", "%s" % p.name)
341 if p.needs_byte_swap() and p.type != self.header]),
344 def get_swap_to_host_func_name(self):
345 return "%s_ntoh" % self.get_c_name()
347 def get_swap_to_be_func_name(self):
348 return "%s_hton" % self.get_c_name()
350 def get_swap_to_host_func_decl(self):
351 return "void %s(%s *msg)" % (
352 self.get_swap_to_host_func_name(), self.get_c_name())
354 def get_swap_to_be_func_decl(self):
355 return "void %s(%s *msg)" % (
356 self.get_swap_to_be_func_name(), self.get_c_name())
358 def get_swap_to_be_func_def(self):
360 "%s" % self.get_swap_to_be_func_decl(),
362 (" VAPI_DBG(\"Swapping `%s'@%%p to big endian\", msg);" %
364 " %s(&msg->header);" % self.header.get_swap_to_be_func_name()
365 if self.header is not None else "",
366 " %s(&msg->payload);" % self.get_swap_payload_to_be_func_name()
367 if self.has_payload() else "",
371 def get_swap_to_host_func_def(self):
373 "%s" % self.get_swap_to_host_func_decl(),
375 (" VAPI_DBG(\"Swapping `%s'@%%p to host byte order\", msg);" %
377 " %s(&msg->header);" % self.header.get_swap_to_host_func_name()
378 if self.header is not None else "",
379 " %s(&msg->payload);" % self.get_swap_payload_to_host_func_name()
380 if self.has_payload() else "",
384 def get_op_func_name(self):
385 return "vapi_%s" % self.name
387 def get_op_func_decl(self):
388 if self.reply.has_payload():
389 return "vapi_error_e %s(%s)" % (
390 self.get_op_func_name(),
392 'struct vapi_ctx_s *ctx',
393 '%s *msg' % self.get_c_name(),
394 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
395 ' void *callback_ctx',
399 self.reply.get_payload_struct_name(),
400 'void *callback_ctx',
404 return "vapi_error_e %s(%s)" % (
405 self.get_op_func_name(),
407 'struct vapi_ctx_s *ctx',
408 '%s *msg' % self.get_c_name(),
409 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
410 ' void *callback_ctx',
413 'void *callback_ctx',
417 def get_op_func_def(self):
419 "%s" % self.get_op_func_decl(),
421 " if (!msg || !callback) {",
422 " return VAPI_EINVAL;",
424 " if (vapi_is_nonblocking(ctx) && vapi_requests_full(ctx)) {",
425 " return VAPI_EAGAIN;",
428 " if (VAPI_OK != (rv = vapi_producer_lock (ctx))) {",
431 " u32 req_context = vapi_gen_req_context(ctx);",
432 " msg->header.context = req_context;",
433 " %s(msg);" % self.get_swap_to_be_func_name(),
434 (" if (VAPI_OK == (rv = vapi_send_with_control_ping "
435 "(ctx, msg, req_context))) {"
436 if self.is_dump() else
437 " if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
439 (" vapi_store_request(ctx, req_context, %s, "
440 "(vapi_cb_t)callback, callback_ctx);" %
441 ("true" if self.is_dump() else "false")),
442 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
443 " abort (); /* this really shouldn't happen */",
445 " if (vapi_is_nonblocking(ctx)) {",
448 " rv = vapi_dispatch(ctx);",
451 " %s(msg);" % self.get_swap_to_host_func_name(),
452 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
453 " abort (); /* this really shouldn't happen */",
461 def get_event_cb_func_decl(self):
462 if not self.is_reply():
464 "Cannot register event callback for non-reply message")
465 if self.has_payload():
467 "void vapi_set_%s_event_cb (" %
469 " struct vapi_ctx_s *ctx, ",
470 (" vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
471 "void *callback_ctx, %s *payload)," %
472 self.get_payload_struct_name()),
473 " void *callback_ctx)",
477 "void vapi_set_%s_event_cb (" %
479 " struct vapi_ctx_s *ctx, ",
480 " vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
481 "void *callback_ctx),",
482 " void *callback_ctx)",
485 def get_event_cb_func_def(self):
486 if not self.is_reply():
488 "Cannot register event callback for non-reply function")
490 "%s" % self.get_event_cb_func_decl(),
492 (" vapi_set_event_cb(ctx, %s, (vapi_event_cb)callback, "
494 self.get_msg_id_name()),
497 def get_c_metadata_struct_name(self):
498 return "__vapi_metadata_%s" % self.name
500 def get_c_constructor(self):
502 if self.header is not None:
503 has_context = self.header.has_field('context')
505 'static void __attribute__((constructor)) __vapi_constructor_%s()'
508 ' static const char name[] = "%s";' % self.name,
509 ' static const char name_with_crc[] = "%s_%s";'
510 % (self.name, self.crc[2:]),
511 ' static vapi_message_desc_t %s = {' %
512 self.get_c_metadata_struct_name(),
514 ' sizeof(name) - 1,',
516 ' sizeof(name_with_crc) - 1,',
517 ' true,' if has_context else ' false,',
518 ' offsetof(%s, context),' % self.header.get_c_name()
519 if has_context else ' 0,',
520 (' offsetof(%s, payload),' % self.get_c_name())
521 if self.has_payload() else ' INVALID_MSG_ID,',
522 ' sizeof(%s),' % self.get_c_name(),
523 ' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
524 ' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
528 ' %s = vapi_register_msg(&%s);' %
529 (self.get_msg_id_name(), self.get_c_metadata_struct_name()),
530 ' VAPI_DBG("Assigned msg id %%d to %s", %s);' %
531 (self.name, self.get_msg_id_name()),
536 vapi_send_with_control_ping = """
537 static inline vapi_error_e
538 vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
540 vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
545 ping->header.context = context;
546 vapi_msg_control_ping_hton (ping);
547 return vapi_send2 (ctx, msg, ping);
552 def gen_json_unified_header(parser, logger, j, io, name):
553 logger.info("Generating header `%s'" % name)
554 orig_stdout = sys.stdout
556 include_guard = "__included_%s" % (
557 j.replace(".", "_").replace("/", "_").replace("-", "_"))
558 print("#ifndef %s" % include_guard)
559 print("#define %s" % include_guard)
561 print("#include <stdlib.h>")
562 print("#include <stddef.h>")
563 print("#include <arpa/inet.h>")
564 print("#include <vapi/vapi_internal.h>")
565 print("#include <vapi/vapi.h>")
566 print("#include <vapi/vapi_dbg.h>")
568 print("#ifdef __cplusplus")
569 print("extern \"C\" {")
571 if name == "vpe.api.vapi.h":
573 print("static inline vapi_error_e vapi_send_with_control_ping "
574 "(vapi_ctx_t ctx, void * msg, u32 context);")
576 print("#include <vapi/vpe.api.vapi.h>")
578 for m in parser.messages_by_json[j].values():
579 print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
581 print("#define DEFINE_VAPI_MSG_IDS_%s\\" %
582 j.replace(".", "_").replace("/", "_").replace("-", "_").upper())
584 " vapi_msg_id_t %s;" % m.get_msg_id_name()
585 for m in parser.messages_by_json[j].values()
589 for t in parser.types_by_json[j].values():
591 print("%s" % t.get_c_def())
595 for m in parser.messages_by_json[j].values():
596 print("%s" % m.get_c_def())
600 function_attrs = "static inline "
601 for t in parser.types_by_json[j].values():
602 print("#ifndef defined_inline_%s" % t.get_c_name())
603 print("#define defined_inline_%s" % t.get_c_name())
604 print("%s%s" % (function_attrs, t.get_swap_to_be_func_def()))
606 print("%s%s" % (function_attrs, t.get_swap_to_host_func_def()))
609 for m in parser.messages_by_json[j].values():
611 print("%s%s" % (function_attrs,
612 m.get_swap_payload_to_be_func_def()))
614 print("%s%s" % (function_attrs,
615 m.get_swap_payload_to_host_func_def()))
617 print("%s%s" % (function_attrs, m.get_calc_msg_size_func_def()))
619 print("%s%s" % (function_attrs, m.get_swap_to_be_func_def()))
621 print("%s%s" % (function_attrs, m.get_swap_to_host_func_def()))
623 for m in parser.messages_by_json[j].values():
626 print("%s%s" % (function_attrs, m.get_alloc_func_def()))
628 print("%s%s" % (function_attrs, m.get_op_func_def()))
631 for m in parser.messages_by_json[j].values():
632 print("%s" % m.get_c_constructor())
635 for m in parser.messages_by_json[j].values():
638 print("%s%s;" % (function_attrs, m.get_event_cb_func_def()))
642 if name == "vpe.api.vapi.h":
643 print("%s" % vapi_send_with_control_ping)
646 print("#ifdef __cplusplus")
651 sys.stdout = orig_stdout
654 def json_to_c_header_name(json_name):
655 if json_name.endswith(".json"):
656 return "%s.vapi.h" % os.path.splitext(json_name)[0]
657 raise Exception("Unexpected json name `%s'!" % json_name)
660 def gen_c_unified_headers(parser, logger, prefix):
661 if prefix == "" or prefix is None:
664 prefix = "%s/" % prefix
665 for j in parser.json_files:
666 with open('%s%s' % (prefix, json_to_c_header_name(j)), "w") as io:
667 gen_json_unified_header(
668 parser, logger, j, io, json_to_c_header_name(j))
671 if __name__ == '__main__':
673 verbose = int(os.getenv("V", 0))
684 logging.basicConfig(stream=sys.stdout, level=log_level)
685 logger = logging.getLogger("VAPI C GEN")
686 logger.setLevel(log_level)
688 argparser = argparse.ArgumentParser(description="VPP C API generator")
689 argparser.add_argument('files', metavar='api-file', action='append',
690 type=str, help='json api file'
691 '(may be specified multiple times)')
692 argparser.add_argument('--prefix', action='store', default=None,
694 args = argparser.parse_args()
696 jsonparser = JsonParser(logger, args.files,
697 simple_type_class=CSimpleType,
698 struct_type_class=CStructType,
700 message_class=CMessage)
702 # not using the model of having separate generated header and code files
703 # with generated symbols present in shared library (per discussion with
704 # Damjan), to avoid symbol version issues in .so
705 # gen_c_headers_and_code(jsonparser, logger, args.prefix)
707 gen_c_unified_headers(jsonparser, logger, args.prefix)
709 for e in jsonparser.exceptions: