7 from vapi_json_parser import Field, Struct, 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()
60 class CStruct(Struct):
61 def duplicate_barrier(func):
62 def func_wrapper(self):
63 name = self.get_c_name()
64 return "#ifndef defined_{}\n#define defined_{}\n{}\n#endif".format(name, name, func(self))
70 "typedef struct __attribute__((__packed__)) {",
71 "%s;" % ";\n".join([" %s" % x.get_c_def()
72 for x in self.fields]),
73 "} %s;" % self.get_c_name()])
76 class CSimpleType (SimpleType):
79 'i16': 'htobe16', 'u16': 'htobe16',
80 'i32': 'htobe32', 'u32': 'htobe32',
81 'i64': 'htobe64', 'u64': 'htobe64',
85 'i16': 'be16toh', 'u16': 'be16toh',
86 'i32': 'be32toh', 'u32': 'be32toh',
87 'i64': 'be64toh', 'u64': 'be64toh',
93 def get_swap_to_be_func_name(self):
94 return self.swap_to_be_dict[self.name]
96 def get_swap_to_host_func_name(self):
97 return self.swap_to_host_dict[self.name]
99 def get_swap_to_be_code(self, struct, var):
100 x = "%s%s" % (struct, var)
101 return "%s = %s(%s);" % (x, self.get_swap_to_be_func_name(), x)
103 def get_swap_to_host_code(self, struct, var):
104 x = "%s%s" % (struct, var)
105 return "%s = %s(%s);" % (x, self.get_swap_to_host_func_name(), x)
107 def needs_byte_swap(self):
109 self.get_swap_to_host_func_name()
116 class CStructType (StructType, CStruct):
117 def get_c_name(self):
118 return "vapi_type_%s" % self.name
120 def get_swap_to_be_func_name(self):
121 return "%s_hton" % self.get_c_name()
123 def get_swap_to_host_func_name(self):
124 return "%s_ntoh" % self.get_c_name()
126 def get_swap_to_be_func_decl(self):
127 return "void %s(%s *msg)" % (
128 self.get_swap_to_be_func_name(), self.get_c_name())
130 def get_swap_to_be_func_def(self):
131 return "%s\n{\n%s\n}" % (
132 self.get_swap_to_be_func_decl(),
134 " %s" % p.get_swap_to_be_code("msg->", "%s" % p.name)
135 for p in self.fields if p.needs_byte_swap()]),
138 def get_swap_to_host_func_decl(self):
139 return "void %s(%s *msg)" % (
140 self.get_swap_to_host_func_name(), self.get_c_name())
142 def get_swap_to_host_func_def(self):
143 return "%s\n{\n%s\n}" % (
144 self.get_swap_to_host_func_decl(),
146 " %s" % p.get_swap_to_host_code("msg->", "%s" % p.name)
147 for p in self.fields if p.needs_byte_swap()]),
150 def get_swap_to_be_code(self, struct, var):
151 return "%s(&%s%s);" % (self.get_swap_to_be_func_name(), struct, var)
153 def get_swap_to_host_code(self, struct, var):
154 return "%s(&%s%s);" % (self.get_swap_to_host_func_name(), struct, var)
156 def needs_byte_swap(self):
157 for f in self.fields:
158 if f.needs_byte_swap():
163 class CMessage (Message):
164 def __init__(self, logger, definition, typedict,
165 struct_type_class, simple_type_class, field_class):
166 super(CMessage, self).__init__(logger, definition, typedict,
167 struct_type_class, simple_type_class,
169 self.payload_members = [
170 " %s" % p.get_c_def()
172 if p.type != self.header
175 def has_payload(self):
176 return len(self.payload_members) > 0
178 def get_msg_id_name(self):
179 return "vapi_msg_id_%s" % self.name
181 def get_c_name(self):
182 return "vapi_msg_%s" % self.name
184 def get_payload_struct_name(self):
185 return "vapi_payload_%s" % self.name
187 def get_alloc_func_vla_field_length_name(self, field):
188 return "%s_array_size" % field.name
190 def get_alloc_func_name(self):
191 return "vapi_alloc_%s" % self.name
193 def get_alloc_vla_param_names(self):
194 return [self.get_alloc_func_vla_field_length_name(f)
196 if f.nelem_field is not None]
198 def get_alloc_func_decl(self):
199 return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
201 self.get_alloc_func_name(),
202 "".join([", size_t %s" % n for n in
203 self.get_alloc_vla_param_names()]))
205 def get_alloc_func_def(self):
207 if self.header.has_field('client_index'):
209 " msg->header.client_index = vapi_get_client_index(ctx);")
210 if self.header.has_field('context'):
211 extra.append(" msg->header.context = 0;")
213 "%s" % self.get_alloc_func_decl(),
215 " %s *msg = NULL;" % self.get_c_name(),
216 " const size_t size = sizeof(%s)%s;" % (
219 " + sizeof(msg->payload.%s[0]) * %s" % (
221 self.get_alloc_func_vla_field_length_name(f))
223 if f.nelem_field is not None
225 " /* cast here required to play nicely with C++ world ... */",
226 " msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
231 " msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
232 self.get_msg_id_name(),
233 "\n".join([" msg->payload.%s = %s;" % (
235 self.get_alloc_func_vla_field_length_name(f))
237 if f.nelem_field is not None]),
241 def get_calc_msg_size_func_name(self):
242 return "vapi_calc_%s_msg_size" % self.name
244 def get_calc_msg_size_func_decl(self):
245 return "uword %s(%s *msg)" % (
246 self.get_calc_msg_size_func_name(),
249 def get_calc_msg_size_func_def(self):
251 "%s" % self.get_calc_msg_size_func_decl(),
253 " return sizeof(*msg)%s;" %
254 "".join(["+ msg->payload.%s * sizeof(msg->payload.%s[0])" % (
258 if f.nelem_field is not None
263 def duplicate_barrier(func):
264 def func_wrapper(self):
265 name = self.get_payload_struct_name()
266 return "#ifndef defined_{}\n#define defined_{}\n{}\n#endif".format(name, name, func(self))
271 if self.has_payload():
273 "typedef struct __attribute__ ((__packed__)) {",
275 ";\n".join(self.payload_members),
276 "} %s;" % self.get_payload_struct_name(),
278 "typedef struct __attribute__ ((__packed__)) {",
279 (" %s %s;" % (self.header.get_c_name(),
281 if self.header is not None else ""),
282 " %s payload;" % self.get_payload_struct_name(),
283 "} %s;" % self.get_c_name(), ])
286 "typedef struct __attribute__ ((__packed__)) {",
287 (" %s %s;" % (self.header.get_c_name(),
289 if self.header is not None else ""),
290 "} %s;" % self.get_c_name(), ])
292 def get_swap_payload_to_host_func_name(self):
293 return "%s_payload_ntoh" % self.get_c_name()
295 def get_swap_payload_to_be_func_name(self):
296 return "%s_payload_hton" % self.get_c_name()
298 def get_swap_payload_to_host_func_decl(self):
299 return "void %s(%s *payload)" % (
300 self.get_swap_payload_to_host_func_name(),
301 self.get_payload_struct_name())
303 def get_swap_payload_to_be_func_decl(self):
304 return "void %s(%s *payload)" % (
305 self.get_swap_payload_to_be_func_name(),
306 self.get_payload_struct_name())
308 def get_swap_payload_to_be_func_def(self):
309 return "%s\n{\n%s\n}" % (
310 self.get_swap_payload_to_be_func_decl(),
312 " %s" % p.get_swap_to_be_code("payload->", "%s" % p.name)
314 if p.needs_byte_swap() and p.type != self.header]),
317 def get_swap_payload_to_host_func_def(self):
318 return "%s\n{\n%s\n}" % (
319 self.get_swap_payload_to_host_func_decl(),
321 " %s" % p.get_swap_to_host_code("payload->", "%s" % p.name)
323 if p.needs_byte_swap() and p.type != self.header]),
326 def get_swap_to_host_func_name(self):
327 return "%s_ntoh" % self.get_c_name()
329 def get_swap_to_be_func_name(self):
330 return "%s_hton" % self.get_c_name()
332 def get_swap_to_host_func_decl(self):
333 return "void %s(%s *msg)" % (
334 self.get_swap_to_host_func_name(), self.get_c_name())
336 def get_swap_to_be_func_decl(self):
337 return "void %s(%s *msg)" % (
338 self.get_swap_to_be_func_name(), self.get_c_name())
340 def get_swap_to_be_func_def(self):
342 "%s" % self.get_swap_to_be_func_decl(),
344 (" VAPI_DBG(\"Swapping `%s'@%%p to big endian\", msg);" %
346 " %s(&msg->header);" % self.header.get_swap_to_be_func_name()
347 if self.header is not None else "",
348 " %s(&msg->payload);" % self.get_swap_payload_to_be_func_name()
349 if self.has_payload() else "",
353 def get_swap_to_host_func_def(self):
355 "%s" % self.get_swap_to_host_func_decl(),
357 (" VAPI_DBG(\"Swapping `%s'@%%p to host byte order\", msg);" %
359 " %s(&msg->header);" % self.header.get_swap_to_host_func_name()
360 if self.header is not None else "",
361 " %s(&msg->payload);" % self.get_swap_payload_to_host_func_name()
362 if self.has_payload() else "",
366 def get_op_func_name(self):
367 return "vapi_%s" % self.name
369 def get_op_func_decl(self):
370 if self.reply.has_payload():
371 return "vapi_error_e %s(%s)" % (
372 self.get_op_func_name(),
374 'struct vapi_ctx_s *ctx',
375 '%s *msg' % self.get_c_name(),
376 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
377 ' void *callback_ctx',
381 self.reply.get_payload_struct_name(),
382 'void *callback_ctx',
386 return "vapi_error_e %s(%s)" % (
387 self.get_op_func_name(),
389 'struct vapi_ctx_s *ctx',
390 '%s *msg' % self.get_c_name(),
391 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
392 ' void *callback_ctx',
395 'void *callback_ctx',
399 def get_op_func_def(self):
401 "%s" % self.get_op_func_decl(),
403 " if (!msg || !callback) {",
404 " return VAPI_EINVAL;",
406 " if (vapi_is_nonblocking(ctx) && vapi_requests_full(ctx)) {",
407 " return VAPI_EAGAIN;",
410 " if (VAPI_OK != (rv = vapi_producer_lock (ctx))) {",
413 " u32 req_context = vapi_gen_req_context(ctx);",
414 " msg->header.context = req_context;",
415 " %s(msg);" % self.get_swap_to_be_func_name(),
416 (" if (VAPI_OK == (rv = vapi_send_with_control_ping "
417 "(ctx, msg, req_context))) {"
418 if self.is_dump() else
419 " if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
421 (" vapi_store_request(ctx, req_context, %s, "
422 "(vapi_cb_t)callback, callback_ctx);" %
423 ("true" if self.is_dump() else "false")),
424 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
425 " abort (); /* this really shouldn't happen */",
427 " if (vapi_is_nonblocking(ctx)) {",
430 " rv = vapi_dispatch(ctx);",
433 " %s(msg);" % self.get_swap_to_host_func_name(),
434 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
435 " abort (); /* this really shouldn't happen */",
443 def get_event_cb_func_decl(self):
444 if not self.is_reply():
446 "Cannot register event callback for non-reply message")
447 if self.has_payload():
449 "void vapi_set_%s_event_cb (" %
451 " struct vapi_ctx_s *ctx, ",
452 (" vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
453 "void *callback_ctx, %s *payload)," %
454 self.get_payload_struct_name()),
455 " void *callback_ctx)",
459 "void vapi_set_%s_event_cb (" %
461 " struct vapi_ctx_s *ctx, ",
462 " vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
463 "void *callback_ctx),",
464 " void *callback_ctx)",
467 def get_event_cb_func_def(self):
468 if not self.is_reply():
470 "Cannot register event callback for non-reply function")
472 "%s" % self.get_event_cb_func_decl(),
474 (" vapi_set_event_cb(ctx, %s, (vapi_event_cb)callback, "
476 self.get_msg_id_name()),
479 def get_c_metadata_struct_name(self):
480 return "__vapi_metadata_%s" % self.name
482 def get_c_constructor(self):
484 if self.header is not None:
485 has_context = self.header.has_field('context')
487 'static void __attribute__((constructor)) __vapi_constructor_%s()'
490 ' static const char name[] = "%s";' % self.name,
491 ' static const char name_with_crc[] = "%s_%s";'
492 % (self.name, self.crc[2:]),
493 ' static vapi_message_desc_t %s = {' %
494 self.get_c_metadata_struct_name(),
496 ' sizeof(name) - 1,',
498 ' sizeof(name_with_crc) - 1,',
499 ' true,' if has_context else ' false,',
500 ' offsetof(%s, context),' % self.header.get_c_name()
501 if has_context else ' 0,',
502 (' offsetof(%s, payload),' % self.get_c_name())
503 if self.has_payload() else ' VAPI_INVALID_MSG_ID,',
504 ' sizeof(%s),' % self.get_c_name(),
505 ' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
506 ' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
507 ' VAPI_INVALID_MSG_ID,',
510 ' %s = vapi_register_msg(&%s);' %
511 (self.get_msg_id_name(), self.get_c_metadata_struct_name()),
512 ' VAPI_DBG("Assigned msg id %%d to %s", %s);' %
513 (self.name, self.get_msg_id_name()),
518 vapi_send_with_control_ping = """
519 static inline vapi_error_e
520 vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
522 vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
527 ping->header.context = context;
528 vapi_msg_control_ping_hton (ping);
529 return vapi_send2 (ctx, msg, ping);
534 def gen_json_unified_header(parser, logger, j, io, name):
535 logger.info("Generating header `%s'" % name)
536 orig_stdout = sys.stdout
538 include_guard = "__included_%s" % (
539 j.replace(".", "_").replace("/", "_").replace("-", "_"))
540 print("#ifndef %s" % include_guard)
541 print("#define %s" % include_guard)
543 print("#include <stdlib.h>")
544 print("#include <stddef.h>")
545 print("#include <arpa/inet.h>")
546 print("#include <vapi/vapi_internal.h>")
547 print("#include <vapi/vapi.h>")
548 print("#include <vapi/vapi_dbg.h>")
550 print("#ifdef __cplusplus")
551 print("extern \"C\" {")
553 if name == "vpe.api.vapi.h":
555 print("static inline vapi_error_e vapi_send_with_control_ping "
556 "(vapi_ctx_t ctx, void * msg, u32 context);")
558 print("#include <vapi/vpe.api.vapi.h>")
560 for m in parser.messages_by_json[j].values():
561 print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
563 print("#define DEFINE_VAPI_MSG_IDS_%s\\" %
564 j.replace(".", "_").replace("/", "_").replace("-", "_").upper())
566 " vapi_msg_id_t %s;" % m.get_msg_id_name()
567 for m in parser.messages_by_json[j].values()
571 for t in parser.types_by_json[j]:
573 print("%s" % t.get_c_def())
577 for m in parser.messages_by_json[j].values():
578 print("%s" % m.get_c_def())
582 function_attrs = "static inline "
583 for t in parser.types_by_json[j]:
584 print("#ifndef defined_inline_%s" % t.get_c_name())
585 print("#define defined_inline_%s" % t.get_c_name())
586 print("%s%s" % (function_attrs, t.get_swap_to_be_func_def()))
588 print("%s%s" % (function_attrs, t.get_swap_to_host_func_def()))
591 for m in parser.messages_by_json[j].values():
593 print("%s%s" % (function_attrs,
594 m.get_swap_payload_to_be_func_def()))
596 print("%s%s" % (function_attrs,
597 m.get_swap_payload_to_host_func_def()))
599 print("%s%s" % (function_attrs, m.get_calc_msg_size_func_def()))
601 print("%s%s" % (function_attrs, m.get_swap_to_be_func_def()))
603 print("%s%s" % (function_attrs, m.get_swap_to_host_func_def()))
605 for m in parser.messages_by_json[j].values():
608 print("%s%s" % (function_attrs, m.get_alloc_func_def()))
610 print("%s%s" % (function_attrs, m.get_op_func_def()))
613 for m in parser.messages_by_json[j].values():
614 print("%s" % m.get_c_constructor())
617 for m in parser.messages_by_json[j].values():
620 print("%s%s;" % (function_attrs, m.get_event_cb_func_def()))
624 if name == "vpe.api.vapi.h":
625 print("%s" % vapi_send_with_control_ping)
628 print("#ifdef __cplusplus")
633 sys.stdout = orig_stdout
636 def json_to_c_header_name(json_name):
637 if json_name.endswith(".json"):
638 return "%s.vapi.h" % os.path.splitext(json_name)[0]
639 raise Exception("Unexpected json name `%s'!" % json_name)
642 def gen_c_unified_headers(parser, logger, prefix):
643 if prefix == "" or prefix is None:
646 prefix = "%s/" % prefix
647 for j in parser.json_files:
648 with open('%s%s' % (prefix, json_to_c_header_name(j)), "w") as io:
649 gen_json_unified_header(
650 parser, logger, j, io, json_to_c_header_name(j))
653 if __name__ == '__main__':
655 verbose = int(os.getenv("V", 0))
666 logging.basicConfig(stream=sys.stdout, level=log_level)
667 logger = logging.getLogger("VAPI C GEN")
668 logger.setLevel(log_level)
670 argparser = argparse.ArgumentParser(description="VPP C API generator")
671 argparser.add_argument('files', metavar='api-file', action='append',
672 type=str, help='json api file'
673 '(may be specified multiple times)')
674 argparser.add_argument('--prefix', action='store', default=None,
676 args = argparser.parse_args()
678 jsonparser = JsonParser(logger, args.files,
679 simple_type_class=CSimpleType,
680 struct_type_class=CStructType,
682 message_class=CMessage)
684 # not using the model of having separate generated header and code files
685 # with generated symbols present in shared library (per discussion with
686 # Damjan), to avoid symbol version issues in .so
687 # gen_c_headers_and_code(jsonparser, logger, args.prefix)
689 gen_c_unified_headers(jsonparser, logger, args.prefix)
691 for e in jsonparser.exceptions: