7 from vapi_json_parser import Field, Struct, Message, JsonParser,\
18 super().__init__(field_name, field_type, array_len, nelem_field)
21 if self.len is not None:
22 return "%s %s[%d]" % (self.type.get_c_name(), self.name, self.len)
24 return "%s %s" % (self.type.get_c_name(), self.name)
26 def get_swap_to_be_code(self, struct, var):
27 if self.len is not None:
29 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
32 self.type.get_swap_to_be_code(struct, "%s[i]" % var))
34 if self.nelem_field.needs_byte_swap():
35 nelem_field = "%s(%s%s)" % (
36 self.nelem_field.type.get_swap_to_host_func_name(),
37 struct, self.nelem_field.name)
39 nelem_field = "%s%s" % (struct, self.nelem_field.name)
41 "do { unsigned i; for (i = 0; i < %s; ++i) { %s } }"
43 (nelem_field, self.type.get_swap_to_be_code(
44 struct, "%s[i]" % var)))
45 return self.type.get_swap_to_be_code(struct, "%s" % var)
47 def get_swap_to_host_code(self, struct, var):
48 if self.len is not None:
50 return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
53 self.type.get_swap_to_host_code(struct, "%s[i]" % var))
55 # nelem_field already swapped to host here...
57 "do { unsigned i; for (i = 0; i < %s%s; ++i) { %s } }"
59 (struct, self.nelem_field.name,
60 self.type.get_swap_to_host_code(
61 struct, "%s[i]" % var)))
62 return self.type.get_swap_to_host_code(struct, "%s" % var)
64 def needs_byte_swap(self):
65 return self.type.needs_byte_swap()
68 class CStruct(Struct):
69 def __init__(self, name, fields):
70 super().__init__(name, fields)
74 "typedef struct __attribute__((__packed__)) {",
75 "%s;" % ";\n".join([" %s" % x.get_c_def()
76 for x in self.fields]),
77 "} %s;" % self.get_c_name()])
80 class CSimpleType (SimpleType):
83 'i16': 'htobe16', 'u16': 'htobe16',
84 'i32': 'htobe32', 'u32': 'htobe32',
85 'i64': 'htobe64', 'u64': 'htobe64',
89 'i16': 'be16toh', 'u16': 'be16toh',
90 'i32': 'be32toh', 'u32': 'be32toh',
91 'i64': 'be64toh', 'u64': 'be64toh',
94 def __init__(self, name):
95 super().__init__(name)
100 def get_swap_to_be_func_name(self):
101 return self.swap_to_be_dict[self.name]
103 def get_swap_to_host_func_name(self):
104 return self.swap_to_host_dict[self.name]
106 def get_swap_to_be_code(self, struct, var):
107 x = "%s%s" % (struct, var)
108 return "%s = %s(%s);" % (x, self.get_swap_to_be_func_name(), x)
110 def get_swap_to_host_code(self, struct, var):
111 x = "%s%s" % (struct, var)
112 return "%s = %s(%s);" % (x, self.get_swap_to_host_func_name(), x)
114 def needs_byte_swap(self):
116 self.get_swap_to_host_func_name()
123 class CStructType (StructType, CStruct):
124 def __init__(self, definition, typedict, field_class):
125 super().__init__(definition, typedict, field_class)
127 def get_c_name(self):
128 return "vapi_type_%s" % self.name
130 def get_swap_to_be_func_name(self):
131 return "%s_hton" % self.get_c_name()
133 def get_swap_to_host_func_name(self):
134 return "%s_ntoh" % self.get_c_name()
136 def get_swap_to_be_func_decl(self):
137 return "void %s(%s *msg)" % (
138 self.get_swap_to_be_func_name(), self.get_c_name())
140 def get_swap_to_be_func_def(self):
141 return "%s\n{\n%s\n}" % (
142 self.get_swap_to_be_func_decl(),
144 " %s" % p.get_swap_to_be_code("msg->", "%s" % p.name)
145 for p in self.fields if p.needs_byte_swap()]),
148 def get_swap_to_host_func_decl(self):
149 return "void %s(%s *msg)" % (
150 self.get_swap_to_host_func_name(), self.get_c_name())
152 def get_swap_to_host_func_def(self):
153 return "%s\n{\n%s\n}" % (
154 self.get_swap_to_host_func_decl(),
156 " %s" % p.get_swap_to_host_code("msg->", "%s" % p.name)
157 for p in self.fields if p.needs_byte_swap()]),
160 def get_swap_to_be_code(self, struct, var):
161 return "%s(&%s%s);" % (self.get_swap_to_be_func_name(), struct, var)
163 def get_swap_to_host_code(self, struct, var):
164 return "%s(&%s%s);" % (self.get_swap_to_host_func_name(), struct, var)
166 def needs_byte_swap(self):
167 for f in self.fields:
168 if f.needs_byte_swap():
173 class CMessage (Message):
174 def __init__(self, logger, definition, typedict,
175 struct_type_class, simple_type_class, field_class):
176 super().__init__(logger, definition, typedict, struct_type_class,
177 simple_type_class, field_class)
178 self.payload_members = [
179 " %s" % p.get_c_def()
181 if p.type != self.header
184 def has_payload(self):
185 return len(self.payload_members) > 0
187 def get_msg_id_name(self):
188 return "vapi_msg_id_%s" % self.name
190 def get_c_name(self):
191 return "vapi_msg_%s" % self.name
193 def get_payload_struct_name(self):
194 return "vapi_payload_%s" % self.name
196 def get_alloc_func_vla_field_length_name(self, field):
197 return "%s_array_size" % field.name
199 def get_alloc_func_name(self):
200 return "vapi_alloc_%s" % self.name
202 def get_alloc_vla_param_names(self):
203 return [self.get_alloc_func_vla_field_length_name(f)
205 if f.nelem_field is not None]
207 def get_alloc_func_decl(self):
208 return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
210 self.get_alloc_func_name(),
211 "".join([", size_t %s" % n for n in
212 self.get_alloc_vla_param_names()]))
214 def get_alloc_func_def(self):
216 if self.header.has_field('client_index'):
218 " msg->header.client_index = vapi_get_client_index(ctx);")
219 if self.header.has_field('context'):
220 extra.append(" msg->header.context = 0;")
222 "%s" % self.get_alloc_func_decl(),
224 " %s *msg = NULL;" % self.get_c_name(),
225 " const size_t size = sizeof(%s)%s;" % (
228 " + sizeof(msg->payload.%s[0]) * %s" % (
230 self.get_alloc_func_vla_field_length_name(f))
232 if f.nelem_field is not None
234 " /* cast here required to play nicely with C++ world ... */",
235 " msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
240 " msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
241 self.get_msg_id_name(),
242 "\n".join([" msg->payload.%s = %s;" % (
244 self.get_alloc_func_vla_field_length_name(f))
246 if f.nelem_field is not None]),
250 def get_calc_msg_size_func_name(self):
251 return "vapi_calc_%s_msg_size" % self.name
253 def get_calc_msg_size_func_decl(self):
254 return "uword %s(%s *msg)" % (
255 self.get_calc_msg_size_func_name(),
258 def get_calc_msg_size_func_def(self):
260 "%s" % self.get_calc_msg_size_func_decl(),
262 " return sizeof(*msg)%s;" %
263 "".join(["+ msg->payload.%s * sizeof(msg->payload.%s[0])" % (
267 if f.nelem_field is not None
273 if self.has_payload():
275 "typedef struct __attribute__ ((__packed__)) {",
277 ";\n".join(self.payload_members),
278 "} %s;" % self.get_payload_struct_name(),
280 "typedef struct __attribute__ ((__packed__)) {",
281 (" %s %s;" % (self.header.get_c_name(),
283 if self.header is not None else ""),
284 " %s payload;" % self.get_payload_struct_name(),
285 "} %s;" % self.get_c_name(), ])
288 "typedef struct __attribute__ ((__packed__)) {",
289 (" %s %s;" % (self.header.get_c_name(),
291 if self.header is not None else ""),
292 "} %s;" % self.get_c_name(), ])
294 def get_swap_payload_to_host_func_name(self):
295 return "%s_payload_ntoh" % self.get_c_name()
297 def get_swap_payload_to_be_func_name(self):
298 return "%s_payload_hton" % self.get_c_name()
300 def get_swap_payload_to_host_func_decl(self):
301 return "void %s(%s *payload)" % (
302 self.get_swap_payload_to_host_func_name(),
303 self.get_payload_struct_name())
305 def get_swap_payload_to_be_func_decl(self):
306 return "void %s(%s *payload)" % (
307 self.get_swap_payload_to_be_func_name(),
308 self.get_payload_struct_name())
310 def get_swap_payload_to_be_func_def(self):
311 return "%s\n{\n%s\n}" % (
312 self.get_swap_payload_to_be_func_decl(),
314 " %s" % p.get_swap_to_be_code("payload->", "%s" % p.name)
316 if p.needs_byte_swap() and p.type != self.header]),
319 def get_swap_payload_to_host_func_def(self):
320 return "%s\n{\n%s\n}" % (
321 self.get_swap_payload_to_host_func_decl(),
323 " %s" % p.get_swap_to_host_code("payload->", "%s" % p.name)
325 if p.needs_byte_swap() and p.type != self.header]),
328 def get_swap_to_host_func_name(self):
329 return "%s_ntoh" % self.get_c_name()
331 def get_swap_to_be_func_name(self):
332 return "%s_hton" % self.get_c_name()
334 def get_swap_to_host_func_decl(self):
335 return "void %s(%s *msg)" % (
336 self.get_swap_to_host_func_name(), self.get_c_name())
338 def get_swap_to_be_func_decl(self):
339 return "void %s(%s *msg)" % (
340 self.get_swap_to_be_func_name(), self.get_c_name())
342 def get_swap_to_be_func_def(self):
344 "%s" % self.get_swap_to_be_func_decl(),
346 (" VAPI_DBG(\"Swapping `%s'@%%p to big endian\", msg);" %
348 " %s(&msg->header);" % self.header.get_swap_to_be_func_name()
349 if self.header is not None else "",
350 " %s(&msg->payload);" % self.get_swap_payload_to_be_func_name()
351 if self.has_payload() else "",
355 def get_swap_to_host_func_def(self):
357 "%s" % self.get_swap_to_host_func_decl(),
359 (" VAPI_DBG(\"Swapping `%s'@%%p to host byte order\", msg);" %
361 " %s(&msg->header);" % self.header.get_swap_to_host_func_name()
362 if self.header is not None else "",
363 " %s(&msg->payload);" % self.get_swap_payload_to_host_func_name()
364 if self.has_payload() else "",
368 def get_op_func_name(self):
369 return "vapi_%s" % self.name
371 def get_op_func_decl(self):
372 if self.reply.has_payload():
373 return "vapi_error_e %s(%s)" % (
374 self.get_op_func_name(),
376 'struct vapi_ctx_s *ctx',
377 '%s *msg' % self.get_c_name(),
378 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
379 ' void *callback_ctx',
383 self.reply.get_payload_struct_name(),
384 'void *callback_ctx',
388 return "vapi_error_e %s(%s)" % (
389 self.get_op_func_name(),
391 'struct vapi_ctx_s *ctx',
392 '%s *msg' % self.get_c_name(),
393 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
394 ' void *callback_ctx',
397 'void *callback_ctx',
401 def get_op_func_def(self):
403 "%s" % self.get_op_func_decl(),
405 " if (!msg || !callback) {",
406 " return VAPI_EINVAL;",
408 " if (vapi_is_nonblocking(ctx) && vapi_requests_full(ctx)) {",
409 " return VAPI_EAGAIN;",
412 " if (VAPI_OK != (rv = vapi_producer_lock (ctx))) {",
415 " u32 req_context = vapi_gen_req_context(ctx);",
416 " msg->header.context = req_context;",
417 " %s(msg);" % self.get_swap_to_be_func_name(),
418 (" if (VAPI_OK == (rv = vapi_send_with_control_ping "
419 "(ctx, msg, req_context))) {"
420 if self.is_dump() else
421 " if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
423 (" vapi_store_request(ctx, req_context, %s, "
424 "(vapi_cb_t)callback, callback_ctx);" %
425 ("true" if self.is_dump() else "false")),
426 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
427 " abort (); /* this really shouldn't happen */",
429 " if (vapi_is_nonblocking(ctx)) {",
432 " rv = vapi_dispatch(ctx);",
435 " %s(msg);" % self.get_swap_to_host_func_name(),
436 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
437 " abort (); /* this really shouldn't happen */",
445 def get_event_cb_func_decl(self):
446 if not self.is_reply():
448 "Cannot register event callback for non-reply message")
449 if self.has_payload():
451 "void vapi_set_%s_event_cb (" %
453 " struct vapi_ctx_s *ctx, ",
454 (" vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
455 "void *callback_ctx, %s *payload)," %
456 self.get_payload_struct_name()),
457 " void *callback_ctx)",
461 "void vapi_set_%s_event_cb (" %
463 " struct vapi_ctx_s *ctx, ",
464 " vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
465 "void *callback_ctx),",
466 " void *callback_ctx)",
469 def get_event_cb_func_def(self):
470 if not self.is_reply():
472 "Cannot register event callback for non-reply function")
474 "%s" % self.get_event_cb_func_decl(),
476 (" vapi_set_event_cb(ctx, %s, (vapi_event_cb)callback, "
478 self.get_msg_id_name()),
481 def get_c_metadata_struct_name(self):
482 return "__vapi_metadata_%s" % self.name
484 def get_c_constructor(self):
486 if self.header is not None:
487 has_context = self.header.has_field('context')
489 'static void __attribute__((constructor)) __vapi_constructor_%s()'
492 ' static const char name[] = "%s";' % self.name,
493 ' static const char name_with_crc[] = "%s_%s";'
494 % (self.name, self.crc[2:]),
495 ' static vapi_message_desc_t %s = {' %
496 self.get_c_metadata_struct_name(),
498 ' sizeof(name) - 1,',
500 ' sizeof(name_with_crc) - 1,',
501 ' true,' if has_context else ' false,',
502 ' offsetof(%s, context),' % self.header.get_c_name()
503 if has_context else ' 0,',
504 (' offsetof(%s, payload),' % self.get_c_name())
505 if self.has_payload() else ' ~0,',
506 ' sizeof(%s),' % self.get_c_name(),
507 ' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
508 ' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
512 ' %s = vapi_register_msg(&%s);' %
513 (self.get_msg_id_name(), self.get_c_metadata_struct_name()),
514 ' VAPI_DBG("Assigned msg id %%d to %s", %s);' %
515 (self.name, self.get_msg_id_name()),
520 vapi_send_with_control_ping = """
521 static inline vapi_error_e
522 vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
524 vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
529 ping->header.context = context;
530 vapi_msg_control_ping_hton (ping);
531 return vapi_send2 (ctx, msg, ping);
536 def gen_json_unified_header(parser, logger, j, io, name):
537 logger.info("Generating header `%s'" % name)
538 orig_stdout = sys.stdout
540 include_guard = "__included_%s" % (
541 j.replace(".", "_").replace("/", "_").replace("-", "_"))
542 print("#ifndef %s" % include_guard)
543 print("#define %s" % include_guard)
545 print("#include <stdlib.h>")
546 print("#include <stddef.h>")
547 print("#include <arpa/inet.h>")
548 print("#include <vapi/vapi_internal.h>")
549 print("#include <vapi/vapi.h>")
550 print("#include <vapi/vapi_dbg.h>")
552 print("#ifdef __cplusplus")
553 print("extern \"C\" {")
555 if name == "vpe.api.vapi.h":
557 print("static inline vapi_error_e vapi_send_with_control_ping "
558 "(vapi_ctx_t ctx, void * msg, u32 context);")
560 print("#include <vapi/vpe.api.vapi.h>")
562 for m in parser.messages_by_json[j].values():
563 print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
565 print("#define DEFINE_VAPI_MSG_IDS_%s\\" %
566 j.replace(".", "_").replace("/", "_").replace("-", "_").upper())
568 " vapi_msg_id_t %s;" % m.get_msg_id_name()
569 for m in parser.messages_by_json[j].values()
573 for t in parser.types_by_json[j].values():
575 print("%s" % t.get_c_def())
579 for m in parser.messages_by_json[j].values():
580 print("%s" % m.get_c_def())
584 function_attrs = "static inline "
585 for t in parser.types_by_json[j].values():
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()))
590 for m in parser.messages_by_json[j].values():
592 print("%s%s" % (function_attrs,
593 m.get_swap_payload_to_be_func_def()))
595 print("%s%s" % (function_attrs,
596 m.get_swap_payload_to_host_func_def()))
598 print("%s%s" % (function_attrs, m.get_calc_msg_size_func_def()))
600 print("%s%s" % (function_attrs, m.get_swap_to_be_func_def()))
602 print("%s%s" % (function_attrs, m.get_swap_to_host_func_def()))
604 for m in parser.messages_by_json[j].values():
607 print("%s%s" % (function_attrs, m.get_alloc_func_def()))
609 print("%s%s" % (function_attrs, m.get_op_func_def()))
612 for m in parser.messages_by_json[j].values():
613 print("%s" % m.get_c_constructor())
616 for m in parser.messages_by_json[j].values():
619 print("%s%s;" % (function_attrs, m.get_event_cb_func_def()))
623 if name == "vpe.api.vapi.h":
624 print("%s" % vapi_send_with_control_ping)
627 print("#ifdef __cplusplus")
632 sys.stdout = orig_stdout
635 def json_to_c_header_name(json_name):
636 if json_name.endswith(".json"):
637 return "%s.vapi.h" % os.path.splitext(json_name)[0]
638 raise Exception("Unexpected json name `%s'!" % json_name)
641 def gen_c_unified_headers(parser, logger, prefix):
642 if prefix == "" or prefix is None:
645 prefix = "%s/" % prefix
646 for j in parser.json_files:
647 with open('%s%s' % (prefix, json_to_c_header_name(j)), "w") as io:
648 gen_json_unified_header(
649 parser, logger, j, io, json_to_c_header_name(j))
652 if __name__ == '__main__':
654 verbose = int(os.getenv("V", 0))
665 logging.basicConfig(stream=sys.stdout, level=log_level)
666 logger = logging.getLogger("VAPI C GEN")
667 logger.setLevel(log_level)
669 argparser = argparse.ArgumentParser(description="VPP C API generator")
670 argparser.add_argument('files', metavar='api-file', action='append',
671 type=str, help='json api file'
672 '(may be specified multiple times)')
673 argparser.add_argument('--prefix', action='store', default=None,
675 args = argparser.parse_args()
677 jsonparser = JsonParser(logger, args.files,
678 simple_type_class=CSimpleType,
679 struct_type_class=CStructType,
681 message_class=CMessage)
683 # not using the model of having separate generated header and code files
684 # with generated symbols present in shared library (per discussion with
685 # Damjan), to avoid symbol version issues in .so
686 # gen_c_headers_and_code(jsonparser, logger, args.prefix)
688 gen_c_unified_headers(jsonparser, logger, args.prefix)
690 for e in jsonparser.exceptions: