-#!/usr/bin/env python2
+#!/usr/bin/env python3
import argparse
+import inspect
import os
import sys
import logging
-from vapi_json_parser import Field, Struct, Message, JsonParser,\
- SimpleType, StructType
+from vapi_json_parser import Field, Struct, Enum, Union, Message, JsonParser,\
+ SimpleType, StructType, Alias
class CField(Field):
+ def get_c_name(self):
+ return "vapi_type_%s" % self.name
+
def get_c_def(self):
- if self.len is not None:
- return "%s %s[%d]" % (self.type.get_c_name(), self.name, self.len)
+ if self.type.get_c_name() == 'vl_api_string_t':
+ if self.len:
+ return "u8 %s[%d];" % (self.name, self.len)
+ else:
+ return "vl_api_string_t %s;" % (self.name)
else:
- return "%s %s" % (self.type.get_c_name(), self.name)
+ if self.len is not None and type(self.len) != dict:
+ return "%s %s[%d];" % (self.type.get_c_name(), self.name,
+ self.len)
+ else:
+ return "%s %s;" % (self.type.get_c_name(), self.name)
def get_swap_to_be_code(self, struct, var):
- if self.len is not None:
+ if self.len is not None and type(self.len) != dict:
if self.len > 0:
return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
" while(0);" % (
return self.type.get_swap_to_be_code(struct, "%s" % var)
def get_swap_to_host_code(self, struct, var):
- if self.len is not None:
+ if self.len is not None and type(self.len) != dict:
if self.len > 0:
return "do { unsigned i; for (i = 0; i < %d; ++i) { %s } }"\
" while(0);" % (
def needs_byte_swap(self):
return self.type.needs_byte_swap()
+ def get_vla_field_length_name(self, path):
+ return "%s_%s_array_size" % ("_".join(path), self.name)
-class CStruct(Struct):
- def duplicate_barrier(func):
- def func_wrapper(self):
- name = self.get_c_name()
- return "#ifndef defined_{}\n#define defined_{}\n{}\n#endif".format(name, name, func(self))
- return func_wrapper
+ def get_alloc_vla_param_names(self, path):
+ if self.is_vla():
+ result = [self.get_vla_field_length_name(path)]
+ else:
+ result = []
+ if self.type.has_vla():
+ t = self.type.get_alloc_vla_param_names(path + [self.name])
+ result.extend(t)
+ return result
+
+ def get_vla_calc_size_code(self, prefix, path):
+ if self.is_vla():
+ result = ["sizeof(%s.%s[0]) * %s" % (
+ ".".join([prefix] + path),
+ self.name,
+ self.get_vla_field_length_name(path))]
+ else:
+ result = []
+ if self.type.has_vla():
+ t = self.type.get_vla_calc_size_code(prefix, path + [self.name])
+ result.extend(t)
+ return result
+
+ def get_vla_assign_code(self, prefix, path):
+ result = []
+ if self.is_vla():
+ result.append("%s.%s = %s" % (
+ ".".join([prefix] + path),
+ self.nelem_field.name,
+ self.get_vla_field_length_name(path)))
+ if self.type.has_vla():
+ t = self.type.get_vla_assign_code(prefix, path + [self.name])
+ result.extend(t)
+ return result
+
+
+class CAlias(CField):
+ def get_c_name(self):
+ return "vapi_type_%s" % self.name
- @duplicate_barrier
+ def get_c_def(self):
+ if self.len is not None:
+ return "typedef %s vapi_type_%s[%d];" % (
+ self.type.get_c_name(), self.name, self.len)
+ else:
+ return "typedef %s vapi_type_%s;" % (
+ self.type.get_c_name(), self.name)
+
+
+class CStruct(Struct):
def get_c_def(self):
return "\n".join([
- "typedef struct __attribute__((__packed__)) {",
- "%s;" % ";\n".join([" %s" % x.get_c_def()
- for x in self.fields]),
+ "typedef struct __attribute__((__packed__)) {\n%s" % (
+ "\n".join([" %s" % x.get_c_def()
+ for x in self.fields])),
"} %s;" % self.get_c_name()])
+ def get_vla_assign_code(self, prefix, path):
+ return [x for f in self.fields if f.has_vla()
+ for x in f.get_vla_assign_code(prefix, path)]
+
+ def get_alloc_vla_param_names(self, path):
+ return [x for f in self.fields
+ if f.has_vla()
+ for x in f.get_alloc_vla_param_names(path)]
+
+ def get_vla_calc_size_code(self, prefix, path):
+ return [x for f in self.fields if f.has_vla()
+ for x in f.get_vla_calc_size_code(prefix, path)]
+
class CSimpleType (SimpleType):
'i64': 'be64toh', 'u64': 'be64toh',
}
+ __packed = "__attribute__((packed))"
+ pack_dict = {
+ 'i8': __packed, 'u8': __packed,
+ 'i16': __packed, 'u16': __packed,
+ }
+
def get_c_name(self):
return self.name
def get_swap_to_host_func_name(self):
return self.swap_to_host_dict[self.name]
- def get_swap_to_be_code(self, struct, var):
+ def get_packed_string(self):
+ return self.pack_dict[self.name]
+
+ def get_swap_to_be_code(self, struct, var, cast=None):
x = "%s%s" % (struct, var)
- return "%s = %s(%s);" % (x, self.get_swap_to_be_func_name(), x)
+ return "%s = %s%s(%s);" % (x,
+ "(%s)" % cast if cast else "",
+ self.get_swap_to_be_func_name(), x)
- def get_swap_to_host_code(self, struct, var):
+ def get_swap_to_host_code(self, struct, var, cast=None):
x = "%s%s" % (struct, var)
- return "%s = %s(%s);" % (x, self.get_swap_to_host_func_name(), x)
+ return "%s = %s%s(%s);" % (x,
+ "(%s)" % cast if cast else "",
+ self.get_swap_to_host_func_name(), x)
def needs_byte_swap(self):
try:
self.get_swap_to_host_func_name()
return True
- except:
+ except KeyError:
pass
return False
+ def get_packed(self):
+ return self.pack_dict.get(self.name, "")
+
+
+class CEnum(Enum):
+ def get_c_name(self):
+ return "vapi_enum_%s" % self.name
+
+ def get_c_def(self):
+ return "typedef enum {\n%s\n} %s %s;" % (
+ "\n".join([" %s = %s," % (i, j) for i, j in self.value_pairs]),
+ self.type.get_packed(),
+ self.get_c_name()
+ )
+
+ def needs_byte_swap(self):
+ return self.type.needs_byte_swap()
+
+ def get_swap_to_be_code(self, struct, var):
+ return self.type.get_swap_to_be_code(struct, var, self.get_c_name())
+
+ def get_swap_to_host_code(self, struct, var):
+ return self.type.get_swap_to_host_code(struct, var, self.get_c_name())
+
+
+class CUnion(Union):
+ def get_c_name(self):
+ return "vapi_union_%s" % self.name
+
+ def get_c_def(self):
+ return "typedef union {\n%s\n} %s;" % (
+ "\n".join([" %s %s;" % (i.get_c_name(), j)
+ for i, j in self.type_pairs]),
+ self.get_c_name()
+ )
+
+ def needs_byte_swap(self):
+ return False
+
class CStructType (StructType, CStruct):
def get_c_name(self):
class CMessage (Message):
- def __init__(self, logger, definition, typedict,
- struct_type_class, simple_type_class, field_class):
- super(CMessage, self).__init__(logger, definition, typedict,
- struct_type_class, simple_type_class,
- field_class)
+ def __init__(self, logger, definition, json_parser):
+ super(CMessage, self).__init__(logger, definition, json_parser)
self.payload_members = [
" %s" % p.get_c_def()
for p in self.fields
def get_payload_struct_name(self):
return "vapi_payload_%s" % self.name
- def get_alloc_func_vla_field_length_name(self, field):
- return "%s_array_size" % field.name
-
def get_alloc_func_name(self):
return "vapi_alloc_%s" % self.name
def get_alloc_vla_param_names(self):
- return [self.get_alloc_func_vla_field_length_name(f)
- for f in self.fields
- if f.nelem_field is not None]
+ return [x for f in self.fields
+ if f.has_vla()
+ for x in f.get_alloc_vla_param_names([])]
def get_alloc_func_decl(self):
return "%s* %s(struct vapi_ctx_s *ctx%s)" % (
" %s *msg = NULL;" % self.get_c_name(),
" const size_t size = sizeof(%s)%s;" % (
self.get_c_name(),
- "".join([
- " + sizeof(msg->payload.%s[0]) * %s" % (
- f.name,
- self.get_alloc_func_vla_field_length_name(f))
- for f in self.fields
- if f.nelem_field is not None
- ])),
+ "".join([" + %s" % x for f in self.fields if f.has_vla()
+ for x in f.get_vla_calc_size_code("msg->payload",
+ [])])),
" /* cast here required to play nicely with C++ world ... */",
" msg = (%s*)vapi_msg_alloc(ctx, size);" % self.get_c_name(),
" if (!msg) {",
] + extra + [
" msg->header._vl_msg_id = vapi_lookup_vl_msg_id(ctx, %s);" %
self.get_msg_id_name(),
- "\n".join([" msg->payload.%s = %s;" % (
- f.nelem_field.name,
- self.get_alloc_func_vla_field_length_name(f))
- for f in self.fields
- if f.nelem_field is not None]),
+ "".join([" %s;\n" % line
+ for f in self.fields if f.has_vla()
+ for line in f.get_vla_assign_code("msg->payload", [])]),
" return msg;",
"}"])
"}",
])
- def duplicate_barrier(func):
- def func_wrapper(self):
- name = self.get_payload_struct_name()
- return "#ifndef defined_{}\n#define defined_{}\n{}\n#endif".format(name, name, func(self))
- return func_wrapper
+ def get_verify_msg_size_func_name(self):
+ return f"vapi_verify_{self.name}_msg_size"
+
+ def get_verify_msg_size_func_decl(self):
+ return "int %s(%s *msg, uword buf_size)" % (
+ self.get_verify_msg_size_func_name(),
+ self.get_c_name())
+
+ def get_verify_msg_size_func_def(self):
+ return inspect.cleandoc(
+ f"""
+ {self.get_verify_msg_size_func_decl()}
+ {{
+ if (sizeof({self.get_c_name()}) > buf_size)
+ {{
+ VAPI_ERR("Truncated '{self.name}' msg received, received %lu"
+ "bytes, expected %lu bytes.", buf_size,
+ sizeof({self.get_c_name()}));
+ return -1;
+ }}
+ if ({self.get_calc_msg_size_func_name()}(msg) > buf_size)
+ {{
+ VAPI_ERR("Truncated '{self.name}' msg received, received %lu"
+ "bytes, expected %lu bytes.", buf_size,
+ sizeof({self.get_calc_msg_size_func_name()}));
+ return -1;
+ }}
+ return 0;
+ }}
+ """)
- @duplicate_barrier
def get_c_def(self):
if self.has_payload():
return "\n".join([
"typedef struct __attribute__ ((__packed__)) {",
- "%s; " %
- ";\n".join(self.payload_members),
+ "%s " %
+ "\n".join(self.payload_members),
"} %s;" % self.get_payload_struct_name(),
"",
"typedef struct __attribute__ ((__packed__)) {",
" %s(msg);" % self.get_swap_to_be_func_name(),
(" if (VAPI_OK == (rv = vapi_send_with_control_ping "
"(ctx, msg, req_context))) {"
- if self.is_dump() else
+ if self.reply_is_stream else
" if (VAPI_OK == (rv = vapi_send (ctx, msg))) {"
),
(" vapi_store_request(ctx, req_context, %s, "
"(vapi_cb_t)callback, callback_ctx);" %
- ("true" if self.is_dump() else "false")),
+ ("true" if self.reply_is_stream else "false")),
" if (VAPI_OK != vapi_producer_unlock (ctx)) {",
" abort (); /* this really shouldn't happen */",
" }",
])
def get_event_cb_func_decl(self):
- if not self.is_reply():
+ if not self.is_reply and not self.is_event:
raise Exception(
"Cannot register event callback for non-reply message")
if self.has_payload():
])
def get_event_cb_func_def(self):
- if not self.is_reply():
+ if not self.is_reply and not self.is_event:
raise Exception(
"Cannot register event callback for non-reply function")
return "\n".join([
if has_context else ' 0,',
(' offsetof(%s, payload),' % self.get_c_name())
if self.has_payload() else ' VAPI_INVALID_MSG_ID,',
- ' sizeof(%s),' % self.get_c_name(),
+ ' (verify_msg_size_fn_t)%s,' %
+ self.get_verify_msg_size_func_name(),
' (generic_swap_fn_t)%s,' % self.get_swap_to_be_func_name(),
' (generic_swap_fn_t)%s,' % self.get_swap_to_host_func_name(),
' VAPI_INVALID_MSG_ID,',
])
-vapi_send_with_control_ping = """
-static inline vapi_error_e
-vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
-{
- vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
- if (!ping)
- {
- return VAPI_ENOMEM;
- }
- ping->header.context = context;
- vapi_msg_control_ping_hton (ping);
- return vapi_send2 (ctx, msg, ping);
-}
-"""
+def emit_definition(parser, json_file, emitted, o):
+ if o in emitted:
+ return
+ if o.name in ("msg_header1_t", "msg_header2_t"):
+ return
+ if hasattr(o, "depends"):
+ for x in o.depends:
+ emit_definition(parser, json_file, emitted, x)
+ if hasattr(o, "reply"):
+ emit_definition(parser, json_file, emitted, o.reply)
+ if hasattr(o, "get_c_def"):
+ if (o not in parser.enums_by_json[json_file] and
+ o not in parser.types_by_json[json_file] and
+ o not in parser.unions_by_json[json_file] and
+ o.name not in parser.messages_by_json[json_file] and
+ o not in parser.aliases_by_json[json_file]):
+ return
+ guard = "defined_%s" % o.get_c_name()
+ print("#ifndef %s" % guard)
+ print("#define %s" % guard)
+ print("%s" % o.get_c_def())
+ print("")
+ function_attrs = "static inline "
+ if o.name in parser.messages_by_json[json_file]:
+ if o.has_payload():
+ print("%s%s" % (function_attrs,
+ o.get_swap_payload_to_be_func_def()))
+ print("")
+ print("%s%s" % (function_attrs,
+ o.get_swap_payload_to_host_func_def()))
+ print("")
+ print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
+ print("")
+ print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
+ print("")
+ print("%s%s" % (function_attrs, o.get_calc_msg_size_func_def()))
+ print("")
+ print("%s%s" % (function_attrs, o.get_verify_msg_size_func_def()))
+ if not o.is_reply and not o.is_event:
+ print("")
+ print("%s%s" % (function_attrs, o.get_alloc_func_def()))
+ print("")
+ print("%s%s" % (function_attrs, o.get_op_func_def()))
+ print("")
+ print("%s" % o.get_c_constructor())
+ if o.is_reply or o.is_event:
+ print("")
+ print("%s%s;" % (function_attrs, o.get_event_cb_func_def()))
+ elif hasattr(o, "get_swap_to_be_func_def"):
+ print("%s%s" % (function_attrs, o.get_swap_to_be_func_def()))
+ print("")
+ print("%s%s" % (function_attrs, o.get_swap_to_host_func_def()))
+ print("#endif")
+ print("")
+ emitted.append(o)
def gen_json_unified_header(parser, logger, j, io, name):
orig_stdout = sys.stdout
sys.stdout = io
include_guard = "__included_%s" % (
- j.replace(".", "_").replace("/", "_").replace("-", "_"))
+ j.replace(".", "_").replace("/", "_").replace("-", "_").replace(
+ "+", "_").replace("@", "_"))
print("#ifndef %s" % include_guard)
print("#define %s" % include_guard)
print("")
print("#ifdef __cplusplus")
print("extern \"C\" {")
print("#endif")
- if name == "vpe.api.vapi.h":
+ if name == "memclnt.api.vapi.h":
print("")
print("static inline vapi_error_e vapi_send_with_control_ping "
"(vapi_ctx_t ctx, void * msg, u32 context);")
+ elif name == "vlib.api.vapi.h":
+ print("#include <vapi/memclnt.api.vapi.h>")
else:
- print("#include <vapi/vpe.api.vapi.h>")
+ print("#include <vapi/vlib.api.vapi.h>")
print("")
for m in parser.messages_by_json[j].values():
print("extern vapi_msg_id_t %s;" % m.get_msg_id_name())
]))
print("")
print("")
+ emitted = []
+ for e in parser.enums_by_json[j]:
+ emit_definition(parser, j, emitted, e)
+ for u in parser.unions_by_json[j]:
+ emit_definition(parser, j, emitted, u)
for t in parser.types_by_json[j]:
- try:
- print("%s" % t.get_c_def())
- print("")
- except:
- pass
+ emit_definition(parser, j, emitted, t)
+ for a in parser.aliases_by_json[j]:
+ emit_definition(parser, j, emitted, a)
for m in parser.messages_by_json[j].values():
- print("%s" % m.get_c_def())
- print("")
+ emit_definition(parser, j, emitted, m)
print("")
- function_attrs = "static inline "
- for t in parser.types_by_json[j]:
- print("#ifndef defined_inline_%s" % t.get_c_name())
- print("#define defined_inline_%s" % t.get_c_name())
- print("%s%s" % (function_attrs, t.get_swap_to_be_func_def()))
- print("")
- print("%s%s" % (function_attrs, t.get_swap_to_host_func_def()))
- print("#endif")
- print("")
- for m in parser.messages_by_json[j].values():
- if m.has_payload():
- print("%s%s" % (function_attrs,
- m.get_swap_payload_to_be_func_def()))
- print("")
- print("%s%s" % (function_attrs,
- m.get_swap_payload_to_host_func_def()))
- print("")
- print("%s%s" % (function_attrs, m.get_calc_msg_size_func_def()))
- print("")
- print("%s%s" % (function_attrs, m.get_swap_to_be_func_def()))
- print("")
- print("%s%s" % (function_attrs, m.get_swap_to_host_func_def()))
- print("")
- for m in parser.messages_by_json[j].values():
- if m.is_reply():
- continue
- print("%s%s" % (function_attrs, m.get_alloc_func_def()))
- print("")
- print("%s%s" % (function_attrs, m.get_op_func_def()))
- print("")
- print("")
- for m in parser.messages_by_json[j].values():
- print("%s" % m.get_c_constructor())
- print("")
- print("")
- for m in parser.messages_by_json[j].values():
- if not m.is_reply():
- continue
- print("%s%s;" % (function_attrs, m.get_event_cb_func_def()))
- print("")
- print("")
- if name == "vpe.api.vapi.h":
- print("%s" % vapi_send_with_control_ping)
+ if name == "vlib.api.vapi.h":
+ vapi_send_with_control_ping_function = """
+static inline vapi_error_e
+vapi_send_with_control_ping (vapi_ctx_t ctx, void *msg, u32 context)
+{
+ vapi_msg_control_ping *ping = vapi_alloc_control_ping (ctx);
+ if (!ping)
+ {
+ return VAPI_ENOMEM;
+ }
+ ping->header.context = context;
+ vapi_msg_control_ping_hton (ping);
+ return vapi_send2 (ctx, msg, ping);
+}
+"""
+ print("%s" % vapi_send_with_control_ping_function)
print("")
print("#ifdef __cplusplus")
jsonparser = JsonParser(logger, args.files,
simple_type_class=CSimpleType,
+ enum_class=CEnum,
+ union_class=CUnion,
struct_type_class=CStructType,
field_class=CField,
- message_class=CMessage)
+ message_class=CMessage,
+ alias_class=CAlias)
# not using the model of having separate generated header and code files
# with generated symbols present in shared library (per discussion with