3 # Copyright (c) 2018 Cisco and/or its affiliates.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 from string import Template
18 from jni_common_gen import generate_j2c_swap, generate_j2c_field_swap, generate_j2c_identifiers, generate_c2j_swap
19 from jvpp_model import Class, Enum, Union
22 def generate_type_handlers(model, logger):
24 Generates host-to-net and net-to-host functions for all custom types defined in the VPP API
25 :param model: meta-model of VPP API used for jVPP generation.
26 :param logger: jVPP logger
30 #TODO(VPP-1186): move the logic to JNI generators
31 if isinstance(t, Class):
32 _generate_class(model, t, type_handlers)
33 elif isinstance(t, Enum):
34 _generate_enum(model, t, type_handlers)
35 elif isinstance(t, Union):
36 _generate_union(model, t, type_handlers)
38 logger.debug("Skipping custom JNI type handler generation for %s", t)
40 return "\n".join(type_handlers)
43 def _generate_class(model, t, type_handlers):
44 ref_name = t.java_name_lower
45 type_handlers.append(_TYPE_HOST_TO_NET_TEMPLATE.substitute(
47 json_filename=model.json_api_files,
48 json_definition=t.doc,
49 type_reference_name=ref_name,
51 jni_identifiers=generate_j2c_identifiers(t, class_ref_name="%sClass" % ref_name, object_ref_name="_host"),
52 type_swap=generate_j2c_swap(t, struct_ref_name="_net")
54 type_handlers.append(_TYPE_NET_TO_HOST_TEMPLATE.substitute(
56 json_filename=model.json_api_files,
57 json_definition=t.doc,
58 type_reference_name=ref_name,
60 type_swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net")
63 _TYPE_HOST_TO_NET_TEMPLATE = Template("""
65 * Host to network byte order conversion for ${c_name} type.
66 * Generated based on $json_filename:
69 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
71 jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
76 _TYPE_NET_TO_HOST_TEMPLATE = Template("""
78 * Network to host byte order conversion for ${c_name} type.
79 * Generated based on $json_filename:
82 static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
84 jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
89 def _generate_enum(model, t, type_handlers):
90 value_type = t.value.type
91 type_handlers.append(_ENUM_NET_TO_HOST_TEMPLATE.substitute(
93 json_filename=model.json_api_files,
94 json_definition=t.doc,
96 jni_signature=value_type.jni_signature,
97 jni_type=value_type.jni_type,
98 jni_accessor=value_type.jni_accessor,
99 swap=_generate_scalar_host_to_net_swap(t.value)
102 type_handlers.append(_ENUM_HOST_TO_NET_TEMPLATE.substitute(
104 json_filename=model.json_api_files,
105 json_definition=t.doc,
106 class_FQN=t.jni_name,
107 jni_type=value_type.jni_type,
108 type_swap=_generate_scalar_net_to_host_swap(t.value)
111 _ENUM_NET_TO_HOST_TEMPLATE = Template("""
113 * Host to network byte order conversion for ${c_name} enum.
114 * Generated based on $json_filename:
117 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
119 jclass enumClass = (*env)->FindClass(env, "${class_FQN}");
120 jmethodID getValueMethod = (*env)->GetMethodID(env, enumClass, "ordinal", "()I");
121 ${jni_type} value = (*env)->CallIntMethod(env, _host, getValueMethod);
125 _ENUM_HOST_TO_NET_TEMPLATE = Template("""
127 * Network to host byte order conversion for ${c_name} type.
128 * Generated based on $json_filename:
131 static inline ${jni_type} _net_to_host_${c_name}(vl_api_${c_name}_t _net)
133 return (${jni_type}) $type_swap
137 def _generate_scalar_host_to_net_swap(field):
138 field_type = field.type
139 if field_type.is_swap_needed:
140 return field_type.get_host_to_net_function(field.java_name, "*_net")
142 return "*_net = %s" % field.java_name
145 def _generate_scalar_net_to_host_swap(field):
146 field_type = field.type
147 if field_type.is_swap_needed:
148 return "%s((%s) _net);" % (field_type.net_to_host_function, field_type.name)
153 def _generate_union(model, t, type_handlers):
154 type_handlers.append(_generate_union_host_to_net(model, t))
155 type_handlers.append(_generate_union_net_to_host(model, t))
158 def _generate_union_host_to_net(model, t):
160 for i, field in enumerate(t.fields):
161 field_type = field.type
162 swap.append(_UNION_FIELD_HOST_TO_NET_TEMPLATE.substitute(
164 java_name=field.java_name,
165 jni_signature=field_type.jni_signature,
166 jni_type=field_type.jni_type,
167 jni_accessor=field_type.jni_accessor,
168 swap=generate_j2c_field_swap(field, struct_ref_name="_net")
171 return _UNION_HOST_TO_NET_TEMPLATE.substitute(
173 json_filename=model.json_api_files,
174 json_definition=t.doc,
175 class_FQN=t.jni_name,
179 _UNION_FIELD_HOST_TO_NET_TEMPLATE = Template("""
180 if (_activeMember == ${field_index}) {
181 jfieldID fieldId = (*env)->GetFieldID(env, _class, "${java_name}", "${jni_signature}");
182 ${jni_type} ${java_name} = (*env)->Get${jni_accessor}Field(env, _host, fieldId);
186 _UNION_HOST_TO_NET_TEMPLATE = Template("""
188 * Host to network byte order conversion for ${c_name} union.
189 * Generated based on $json_filename:
192 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
194 jclass _class = (*env)->FindClass(env, "${class_FQN}");
196 jfieldID _activeMemberFieldId = (*env)->GetFieldID(env, _class, "_activeMember", "I");
197 jint _activeMember = (*env)->GetIntField(env, _host, _activeMemberFieldId);
202 def _generate_union_net_to_host(model, t):
203 return _UNION_NET_TO_HOST_TEMPLATE.substitute(
205 json_filename=model.json_api_files,
206 json_definition=t.doc,
207 type_reference_name=t.java_name_lower,
208 class_FQN=t.jni_name,
209 swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net")
212 _UNION_NET_TO_HOST_TEMPLATE = Template("""
214 * Network to host byte order conversion for ${c_name} union.
215 * Generated based on $json_filename:
218 static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
220 jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");