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)
75 "typedef struct __attribute__((__packed__)) {",
76 "%s;" % ";\n".join([" %s" % x.get_c_def()
77 for x in self.fields]),
78 "} %s;" % self.get_c_name()])
81 class CSimpleType (SimpleType):
84 'i16': 'htobe16', 'u16': 'htobe16',
85 'i32': 'htobe32', 'u32': 'htobe32',
86 'i64': 'htobe64', 'u64': 'htobe64',
90 'i16': 'be16toh', 'u16': 'be16toh',
91 'i32': 'be32toh', 'u32': 'be32toh',
92 'i64': 'be64toh', 'u64': 'be64toh',
95 def __init__(self, name):
96 super(CSimpleType, self).__init__(name)
101 def get_swap_to_be_func_name(self):
102 return self.swap_to_be_dict[self.name]
104 def get_swap_to_host_func_name(self):
105 return self.swap_to_host_dict[self.name]
107 def get_swap_to_be_code(self, struct, var):
108 x = "%s%s" % (struct, var)
109 return "%s = %s(%s);" % (x, self.get_swap_to_be_func_name(), x)
111 def get_swap_to_host_code(self, struct, var):
112 x = "%s%s" % (struct, var)
113 return "%s = %s(%s);" % (x, self.get_swap_to_host_func_name(), x)
115 def needs_byte_swap(self):
117 self.get_swap_to_host_func_name()
124 class CStructType (StructType, CStruct):
125 def __init__(self, definition, typedict, field_class):
126 super(CStructType, self).__init__(definition, typedict, field_class)
128 def get_c_name(self):
129 return "vapi_type_%s" % self.name
131 def get_swap_to_be_func_name(self):
132 return "%s_hton" % self.get_c_name()
134 def get_swap_to_host_func_name(self):
135 return "%s_ntoh" % self.get_c_name()
137 def get_swap_to_be_func_decl(self):
138 return "void %s(%s *msg)" % (
139 self.get_swap_to_be_func_name(), self.get_c_name())
141 def get_swap_to_be_func_def(self):
142 return "%s\n{\n%s\n}" % (
143 self.get_swap_to_be_func_decl(),
145 " %s" % p.get_swap_to_be_code("msg->", "%s" % p.name)
146 for p in self.fields if p.needs_byte_swap()]),
149 def get_swap_to_host_func_decl(self):
150 return "void %s(%s *msg)" % (
151 self.get_swap_to_host_func_name(), self.get_c_name())
153 def get_swap_to_host_func_def(self):
154 return "%s\n{\n%s\n}" % (
155 self.get_swap_to_host_func_decl(),
157 " %s" % p.get_swap_to_host_code("msg->", "%s" % p.name)
158 for p in self.fields if p.needs_byte_swap()]),
161 def get_swap_to_be_code(self, struct, var):
162 return "%s(&%s%s);" % (self.get_swap_to_be_func_name(), struct, var)
164 def get_swap_to_host_code(self, struct, var):
165 return "%s(&%s%s);" % (self.get_swap_to_host_func_name(), struct, var)
167 def needs_byte_swap(self):
168 for f in self.fields:
169 if f.needs_byte_swap():
174 class CMessage (Message):
175 def __init__(self, logger, definition, typedict,
176 struct_type_class, simple_type_class, field_class):
177 super(CMessage, self).__init__(logger, definition, typedict,
178 struct_type_class, simple_type_class,
180 self.payload_members = [
181 " %s" % p.get_c_def()
183 if p.type != self.header
186 def has_payload(self):
187 return len(self.payload_members) > 0
189 def get_msg_id_name(self):
190 return "vapi_msg_id_%s" % self.name
192 def get_c_name(self):
193 return "vapi_msg_%s" % self.name
195 def get_payload_struct_name(self):
196 return "vapi_payload_%s" % self.name
198 def get_alloc_func_vla_field_length_name(self, field):
199 return "%s_array_size" % field.name
201 def get_alloc_func_name(self):
202 return "vapi_alloc_%s" % self.name
204 def get_alloc_vla_param_names(self):
205 return [self.get_alloc_func_vla_field_length_name(f)
207 if f.nelem_field is not None]
209 def get_alloc_func_decl(self):
210 return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
212 self.get_alloc_func_name(),
213 "".join([", size_t %s" % n for n in
214 self.get_alloc_vla_param_names()]))
216 def get_alloc_func_def(self):
218 if self.header.has_field('client_index'):
220 " msg->header.client_index = vapi_get_client_index(ctx);")
221 if self.header.has_field('context'):
222 extra.append(" msg->header.context = 0;")
224 "%s" % self.get_alloc_func_decl(),
226 " %s *msg = NULL;" % self.get_c_name(),
227 " const size_t size = sizeof(%s)%s;" % (
230 " + sizeof(msg->payload.%s[0]) * %s" % (
232 self.get_alloc_func_vla_field_length_name(f))
234 if f.nelem_field is not None
236 " /* cast here required to play nicely with C++ world ... */",
237 " msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
242 " msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
243 self.get_msg_id_name(),
244 "\n".join([" msg->payload.%s = %s;" % (
246 self.get_alloc_func_vla_field_length_name(f))
248 if f.nelem_field is not None]),
252 def get_calc_msg_size_func_name(self):
253 return "vapi_calc_%s_msg_size" % self.name
255 def get_calc_msg_size_func_decl(self):
256 return "uword %s(%s *msg)" % (
257 self.get_calc_msg_size_func_name(),
260 def get_calc_msg_size_func_def(self):
262 "%s" % self.get_calc_msg_size_func_decl(),
264 " return sizeof(*msg)%s;" %
265 "".join(["+ msg->payload.%s * sizeof(msg->payload.%s[0])" % (
269 if f.nelem_field is not None
275 if self.has_payload():
277 "typedef struct __attribute__ ((__packed__)) {",
279 ";\n".join(self.payload_members),
280 "} %s;" % self.get_payload_struct_name(),
282 "typedef struct __attribute__ ((__packed__)) {",
283 (" %s %s;" % (self.header.get_c_name(),
285 if self.header is not None else ""),
286 " %s payload;" % self.get_payload_struct_name(),
287 "} %s;" % self.get_c_name(), ])
290 "typedef struct __attribute__ ((__packed__)) {",
291 (" %s %s;" % (self.header.get_c_name(),
293 if self.header is not None else ""),
294 "} %s;" % self.get_c_name(), ])
296 def get_swap_payload_to_host_func_name(self):
297 return "%s_payload_ntoh" % self.get_c_name()
299 def get_swap_payload_to_be_func_name(self):
300 return "%s_payload_hton" % self.get_c_name()
302 def get_swap_payload_to_host_func_decl(self):
303 return "void %s(%s *payload)" % (
304 self.get_swap_payload_to_host_func_name(),
305 self.get_payload_struct_name())
307 def get_swap_payload_to_be_func_decl(self):
308 return "void %s(%s *payload)" % (
309 self.get_swap_payload_to_be_func_name(),
310 self.get_payload_struct_name())
312 def get_swap_payload_to_be_func_def(self):
313 return "%s\n{\n%s\n}" % (
314 self.get_swap_payload_to_be_func_decl(),
316 " %s" % p.get_swap_to_be_code("payload->", "%s" % p.name)
318 if p.needs_byte_swap() and p.type != self.header]),
321 def get_swap_payload_to_host_func_def(self):
322 return "%s\n{\n%s\n}" % (
323 self.get_swap_payload_to_host_func_decl(),
325 " %s" % p.get_swap_to_host_code("payload->", "%s" % p.name)
327 if p.needs_byte_swap() and p.type != self.header]),
330 def get_swap_to_host_func_name(self):
331 return "%s_ntoh" % self.get_c_name()
333 def get_swap_to_be_func_name(self):
334 return "%s_hton" % self.get_c_name()
336 def get_swap_to_host_func_decl(self):
337 return "void %s(%s *msg)" % (
338 self.get_swap_to_host_func_name(), self.get_c_name())
340 def get_swap_to_be_func_decl(self):
341 return "void %s(%s *msg)" % (
342 self.get_swap_to_be_func_name(), self.get_c_name())
344 def get_swap_to_be_func_def(self):
346 "%s" % self.get_swap_to_be_func_decl(),
348 (" VAPI_DBG(\"Swapping `%s'@%%p to big endian\", msg);" %
350 " %s(&msg->header);" % self.header.get_swap_to_be_func_name()
351 if self.header is not None else "",
352 " %s(&msg->payload);" % self.get_swap_payload_to_be_func_name()
353 if self.has_payload() else "",
357 def get_swap_to_host_func_def(self):
359 "%s" % self.get_swap_to_host_func_decl(),
361 (" VAPI_DBG(\"Swapping `%s'@%%p to host byte order\", msg);" %
363 " %s(&msg->header);" % self.header.get_swap_to_host_func_name()
364 if self.header is not None else "",
365 " %s(&msg->payload);" % self.get_swap_payload_to_host_func_name()
366 if self.has_payload() else "",
370 def get_op_func_name(self):
371 return "vapi_%s" % self.name
373 def get_op_func_decl(self):
374 if self.reply.has_payload():
375 return "vapi_error_e %s(%s)" % (
376 self.get_op_func_name(),
378 'struct vapi_ctx_s *ctx',
379 '%s *msg' % self.get_c_name(),
380 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
381 ' void *callback_ctx',
385 self.reply.get_payload_struct_name(),
386 'void *callback_ctx',
390 return "vapi_error_e %s(%s)" % (
391 self.get_op_func_name(),
393 'struct vapi_ctx_s *ctx',
394 '%s *msg' % self.get_c_name(),
395 'vapi_error_e (*callback)(struct vapi_ctx_s *ctx',
396 ' void *callback_ctx',
399 'void *callback_ctx',
403 def get_op_func_def(self):
405 "%s" % self.get_op_func_decl(),
407 " if (!msg || !callback) {",
408 " return VAPI_EINVAL;",
410 " if (vapi_is_nonblocking(ctx) && vapi_requests_full(ctx)) {",
411 " return VAPI_EAGAIN;",
414 " if (VAPI_OK != (rv = vapi_producer_lock (ctx))) {",
417 " u32 req_context = vapi_gen_req_context(ctx);",
418 " msg->header.context = req_context;",
419 " %s(msg);" % self.get_swap_to_be_func_name(),
420 (" if (VAPI_OK == (rv = vapi_send_with_control_ping "
421 "(ctx, msg, req_context))) {"
422 if self.is_dump() else
423 " if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
425 (" vapi_store_request(ctx, req_context, %s, "
426 "(vapi_cb_t)callback, callback_ctx);" %
427 ("true" if self.is_dump() else "false")),
428 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
429 " abort (); /* this really shouldn't happen */",
431 " if (vapi_is_nonblocking(ctx)) {",
434 " rv = vapi_dispatch(ctx);",
437 " %s(msg);" % self.get_swap_to_host_func_name(),
438 " if (VAPI_OK != vapi_producer_unlock (ctx)) {",
439 " abort (); /* this really shouldn't happen */",
447 def get_event_cb_func_decl(self):
448 if not self.is_reply():
450 "Cannot register event callback for non-reply message")
451 if self.has_payload():
453 "void vapi_set_%s_event_cb (" %
455 " struct vapi_ctx_s *ctx, ",
456 (" vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
457 "void *callback_ctx, %s *payload)," %
458 self.get_payload_struct_name()),
459 " void *callback_ctx)",
463 "void vapi_set_%s_event_cb (" %
465 " struct vapi_ctx_s *ctx, ",
466 " vapi_error_e (*callback)(struct vapi_ctx_s *ctx, "
467 "void *callback_ctx),",
468 " void *callback_ctx)",
471 def get_event_cb_func_def(self):
472 if not self.is_reply():
474 "Cannot register event callback for non-reply function")
476 "%s" % self.get_event_cb_func_decl(),
478 (" vapi_set_event_cb(ctx, %s, (vapi_event_cb)callback, "
480 self.get_msg_id_name()),
483 def get_c_metadata_struct_name(self):
484 return "__vapi_metadata_%s" % self.name
486 def get_c_constructor(self):
488 if self.header is not None:
489 has_context = self.header.has_field('context')
491 'static void __attribute__((constructor)) __vapi_constructor_%s()'
494 ' static const char name[] = "%s";' % self.name,
495 ' static const char name_with_crc[] = "%s_%s";'
496 % (self.name, self.crc[2:]),
497 ' static vapi_message_desc_t %s = {' %
498 self.get_c_metadata_struct_name(),
500 ' sizeof(name) - 1,',
502 ' sizeof(name_with_crc) - 1,',
503 ' true,' if has_context else ' false,',
504 ' offsetof(%s, context),' % self.header.get_c_name()
505 if has_context else ' 0,',
506 (' offsetof(%s, payload),' % self.get_c_name())
507 if self.has_payload() else ' INVALID_MSG_ID,',
508 ' sizeof(%s),' % self.get_c_name(),
509 ' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
510 ' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
514 ' %s = vapi_register_msg(&%s);' %
515 (self.get_msg_id_name(), self.get_c_metadata_struct_name()),
516 ' VAPI_DBG("Assigned msg id %%d to %s", %s);' %
517 (self.name, self.get_msg_id_name()),
522 vapi_send_with_control_ping = """
523 static inline vapi_error_e
524 vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
526 vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
531 ping->header.context = context;
532 vapi_msg_control_ping_hton (ping);
533 return vapi_send2 (ctx, msg, ping);
538 def gen_json_unified_header(parser, logger, j, io, name):
539 logger.info("Generating header `%s'" % name)
540 orig_stdout = sys.stdout
542 include_guard = "__included_%s" % (
543 j.replace(".", "_").replace("/", "_").replace("-", "_"))
544 print("#ifndef %s" % include_guard)
545 print("#define %s" % include_guard)
547 print("#include <stdlib.h>")
548 print("#include <stddef.h>")
549 print("#include <arpa/inet.h>")
550 print("#include <vapi/vapi_internal.h>")
551 print("#include <vapi/vapi.h>")
552 print("#include <vapi/vapi_dbg.h>")
554 print("#ifdef __cplusplus")
555 print("extern \"C\" {")
557 if name == "vpe.api.vapi.h":
559 print("static inline vapi_error_e vapi_send_with_control_ping "
560 "(vapi_ctx_t ctx, void * msg, u32 context);")
562 print("#include <vapi/vpe.api.vapi.h>")
564 for m in parser.messages_by_json[j].values():
565 print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
567 print("#define DEFINE_VAPI_MSG_IDS_%s\\" %
568 j.replace(".", "_").replace("/", "_").replace("-", "_").upper())
570 " vapi_msg_id_t %s;" % m.get_msg_id_name()
571 for m in parser.messages_by_json[j].values()
575 for t in parser.types_by_json[j].values():
577 print("%s" % t.get_c_def())
581 for m in parser.messages_by_json[j].values():
582 print("%s" % m.get_c_def())
586 function_attrs = "static inline "
587 for t in parser.types_by_json[j].values():
588 print("%s%s" % (function_attrs, t.get_swap_to_be_func_def()))
590 print("%s%s" % (function_attrs, t.get_swap_to_host_func_def()))
592 for m in parser.messages_by_json[j].values():
594 print("%s%s" % (function_attrs,
595 m.get_swap_payload_to_be_func_def()))
597 print("%s%s" % (function_attrs,
598 m.get_swap_payload_to_host_func_def()))
600 print("%s%s" % (function_attrs, m.get_calc_msg_size_func_def()))
602 print("%s%s" % (function_attrs, m.get_swap_to_be_func_def()))
604 print("%s%s" % (function_attrs, m.get_swap_to_host_func_def()))
606 for m in parser.messages_by_json[j].values():
609 print("%s%s" % (function_attrs, m.get_alloc_func_def()))
611 print("%s%s" % (function_attrs, m.get_op_func_def()))
614 for m in parser.messages_by_json[j].values():
615 print("%s" % m.get_c_constructor())
618 for m in parser.messages_by_json[j].values():
621 print("%s%s;" % (function_attrs, m.get_event_cb_func_def()))
625 if name == "vpe.api.vapi.h":
626 print("%s" % vapi_send_with_control_ping)
629 print("#ifdef __cplusplus")
634 sys.stdout = orig_stdout
637 def json_to_c_header_name(json_name):
638 if json_name.endswith(".json"):
639 return "%s.vapi.h" % os.path.splitext(json_name)[0]
640 raise Exception("Unexpected json name `%s'!" % json_name)
643 def gen_c_unified_headers(parser, logger, prefix):
644 if prefix == "" or prefix is None:
647 prefix = "%s/" % prefix
648 for j in parser.json_files:
649 with open('%s%s' % (prefix, json_to_c_header_name(j)), "w") as io:
650 gen_json_unified_header(
651 parser, logger, j, io, json_to_c_header_name(j))
654 if __name__ == '__main__':
656 verbose = int(os.getenv("V", 0))
667 logging.basicConfig(stream=sys.stdout, level=log_level)
668 logger = logging.getLogger("VAPI C GEN")
669 logger.setLevel(log_level)
671 argparser = argparse.ArgumentParser(description="VPP C API generator")
672 argparser.add_argument('files', metavar='api-file', action='append',
673 type=str, help='json api file'
674 '(may be specified multiple times)')
675 argparser.add_argument('--prefix', action='store', default=None,
677 args = argparser.parse_args()
679 jsonparser = JsonParser(logger, args.files,
680 simple_type_class=CSimpleType,
681 struct_type_class=CStructType,
683 message_class=CMessage)
685 # not using the model of having separate generated header and code files
686 # with generated symbols present in shared library (per discussion with
687 # Damjan), to avoid symbol version issues in .so
688 # gen_c_headers_and_code(jsonparser, logger, args.prefix)
690 gen_c_unified_headers(jsonparser, logger, args.prefix)
692 for e in jsonparser.exceptions: