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 jvpp_model import is_array, is_retval, Class, Enum, Union
21 def generate_j2c_identifiers(element, class_ref_name, object_ref_name):
23 for field in element.fields:
24 field_type = field.type
25 identifiers.append(_REQUEST_FIELD_IDENTIFIER_TEMPLATE.substitute(
26 java_name=field.java_name,
27 class_ref_name=class_ref_name,
28 jni_signature=field_type.jni_signature,
29 jni_type=field_type.jni_type,
30 jni_accessor=field_type.jni_accessor,
31 object_ref_name=object_ref_name
33 return "".join(identifiers)
35 _REQUEST_FIELD_IDENTIFIER_TEMPLATE = Template("""
36 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}, "${java_name}", "${jni_signature}");
37 ${jni_type} ${java_name} = (*env)->Get${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId);
41 # TODO(VPP-1187): do not inline JNI object creation inside message handlers to reduce number of special cases
42 def generate_j2c_swap(element, struct_ref_name, is_alias):
44 for field in element.fields:
45 initialization.append(generate_j2c_field_swap(field, struct_ref_name, is_alias))
46 return "\n".join(initialization)
49 def generate_j2c_field_swap(field, struct_ref_name, is_alias):
51 return _generate_j2c_array_swap(field, struct_ref_name, is_alias)
53 return _generate_j2c_scalar_swap(field, struct_ref_name, is_alias)
56 def _generate_j2c_array_swap(field, struct_ref_name, is_alias):
57 # TODO(VPP-1186): move the logic to JNI generators
58 base_type = field.type.base_type
59 if isinstance(base_type, (Class, Enum, Union)):
60 return _generate_j2c_object_array_swap(field, struct_ref_name)
61 elif base_type.is_swap_needed:
62 return _generate_j2c_primitive_type_array_swap(field, struct_ref_name)
64 return _generate_j2c_primitive_type_array_no_swap(field, struct_ref_name, is_alias)
67 def _generate_j2c_object_array_swap(field, struct_ref_name):
68 field_type = field.type
69 field_reference_name = field.java_name
71 host = "%sArrayElement" % field_reference_name
72 net = "%s->%s[_i]" % (struct_ref_name, c_name)
73 swap_elements = field_type.get_host_to_net_function(host, net)
74 return _J2C_OBJECT_ARRAY_SWAP_TEMPLATE.substitute(
75 field_reference_name=field_reference_name,
76 field_length_check=_generate_field_length_check(field),
77 swap_elements=swap_elements)
79 _J2C_OBJECT_ARRAY_SWAP_TEMPLATE = Template("""
81 if (${field_reference_name}) {
83 jsize cnt = (*env)->GetArrayLength (env, ${field_reference_name});
85 for (_i = 0; _i < cnt; _i++) {
86 jobject ${field_reference_name}ArrayElement = (*env)->GetObjectArrayElement(env, ${field_reference_name}, _i);
94 def _generate_j2c_primitive_type_array_swap(field, struct_ref_name):
95 field_reference_name = field.java_name
96 field_type = field.type
97 host = "%sArrayElements[_i]" % field_reference_name
98 net = "%s->%s[_i]" % (struct_ref_name, field.name)
99 swap_elements = field_type.get_host_to_net_function(host, net)
100 return _J2C_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE.substitute(
101 field_reference_name=field_reference_name,
102 field_length_check=_generate_field_length_check(field),
103 base_type=field_type.base_type.jni_accessor,
104 jni_base_type=field_type.base_type.jni_type,
105 swap_elements=swap_elements
108 _J2C_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE = Template("""
109 if (${field_reference_name}) {
110 ${jni_base_type} * ${field_reference_name}ArrayElements = (*env)->Get${base_type}ArrayElements(env, ${field_reference_name}, NULL);
112 jsize cnt = (*env)->GetArrayLength(env, ${field_reference_name});
113 ${field_length_check}
114 for (_i = 0; _i < cnt; _i++) {
117 (*env)->Release${base_type}ArrayElements (env, ${field_reference_name}, ${field_reference_name}ArrayElements, 0);
122 def _generate_j2c_primitive_type_array_no_swap(field, struct_ref_name, is_alias):
123 field_type = field.type
125 template = _J2C_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE
127 template = _J2C_ALIAS_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE
129 return template.substitute(
130 field_reference_name=field.java_name,
131 field_length_check=_generate_field_length_check(field),
132 base_type=field_type.base_type.jni_accessor,
133 jni_base_type=field_type.base_type.jni_type,
134 struct_reference_name=struct_ref_name,
138 _J2C_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE = Template("""
139 if (${field_reference_name}) {
140 jsize cnt = (*env)->GetArrayLength (env, ${field_reference_name});
141 ${field_length_check}
142 (*env)->Get${base_type}ArrayRegion(env, ${field_reference_name}, 0, cnt, (${jni_base_type} *)${struct_reference_name}->${c_name});
147 _J2C_ALIAS_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE = Template("""
148 if (${field_reference_name}) {
149 jsize cnt = (*env)->GetArrayLength (env, ${field_reference_name});
150 ${field_length_check}
151 (*env)->Get${base_type}ArrayRegion(env, ${field_reference_name}, 0, cnt, (${jni_base_type} *)${struct_reference_name});
156 def _generate_field_length_check(field):
157 # Enforce max length if array has fixed length or uses variable length syntax
158 field_length = str(field.array_len)
159 if field.array_len_field:
160 field_length = field.array_len_field.java_name
162 # TODO: remove when ZLAs without length field are disabled
163 if field_length != "0":
164 return _FIELD_LENGTH_CHECK.substitute(field_length=field_length)
168 # Make sure we do not write more elements that are expected
169 _FIELD_LENGTH_CHECK = Template("""
170 size_t max_size = ${field_length};
171 if (cnt > max_size) cnt = max_size;""")
174 def _generate_j2c_scalar_swap(field, struct_ref_name, is_alias):
175 field_type = field.type
176 if field_type.is_swap_needed:
177 host = field.java_name
179 net = "%s->%s" % (struct_ref_name, field.name)
180 return " %s;" % field_type.get_host_to_net_function(host, net)
182 net = "%s" % (struct_ref_name)
183 return " *%s;" % field_type.get_host_to_net_function(host, net)
185 return " %s->%s = %s;" % (struct_ref_name, field.name, field.java_name)
188 def generate_c2j_swap(element, object_ref_name, struct_ref_name, is_alias):
189 msg_java_name = element.java_name_lower
191 for field in element.fields:
193 # For retval don't generate setters and generate retval check
195 elif is_array(field):
196 initialization.append(_generate_c2j_array_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias))
198 initialization.append(_generate_c2j_scalar_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias))
199 return "".join(initialization)
202 def _generate_c2j_array_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias):
203 # TODO(VPP-1186): move the logic to JNI generators
204 base_type = field.type.base_type
205 if isinstance(base_type, (Class, Union)):
206 return _generate_c2j_object_array_swap(msg_java_name, field, object_ref_name, struct_ref_name)
207 elif isinstance(base_type, Enum):
208 return _generate_c2j_enum_array_swap(msg_java_name, field, object_ref_name, struct_ref_name)
209 elif base_type.is_swap_needed:
210 return _generate_c2j_primitive_type_array_swap(msg_java_name, field, object_ref_name, struct_ref_name)
212 return _generate_c2j_primitive_type_array_no_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias)
215 def _generate_c2j_object_array_swap(msg_java_name, field, object_ref_name, struct_ref_name):
216 field_type = field.type
217 return _C2J_OBJECT_ARRAY_SWAP_TEMPLATE.substitute(
218 field_reference_name=field.java_name,
219 class_ref_name=msg_java_name,
220 jni_signature=field_type.jni_signature,
221 jni_name=field_type.base_type.jni_name,
222 field_length=_generate_array_length(field, struct_ref_name),
223 net_to_host_function=field_type.net_to_host_function,
224 struct_ref_name=struct_ref_name,
225 object_ref_name=object_ref_name,
229 _C2J_OBJECT_ARRAY_SWAP_TEMPLATE = Template("""
230 jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
232 jclass ${field_reference_name}Class = (*env)->FindClass(env, "${jni_name}");
233 jobjectArray ${field_reference_name} = (*env)->NewObjectArray(env, ${field_length}, ${field_reference_name}Class, 0);
234 jmethodID ${field_reference_name}Constructor = (*env)->GetMethodID(env, ${field_reference_name}Class, "<init>", "()V");
236 for (_i = 0; _i < ${field_length}; _i++) {
237 jobject ${field_reference_name}ArrayElement = (*env)->NewObject(env, ${field_reference_name}Class, ${field_reference_name}Constructor);
238 ${net_to_host_function}(env, &(${struct_ref_name}->${c_name}[_i]), ${field_reference_name}ArrayElement);
239 (*env)->SetObjectArrayElement(env, ${field_reference_name}, _i, ${field_reference_name}ArrayElement);
240 (*env)->DeleteLocalRef(env, ${field_reference_name}ArrayElement);
242 (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
243 (*env)->DeleteLocalRef(env, ${field_reference_name});
248 def _generate_c2j_enum_array_swap(msg_java_name, field, object_ref_name, struct_ref_name):
249 field_type = field.type
250 base_type = field_type.base_type
251 return _C2J_ENUM_ARRAY_SWAP_TEMPLATE.substitute(
252 field_reference_name=field.java_name,
253 class_ref_name=msg_java_name,
254 jni_signature=field_type.jni_signature,
255 jni_name=base_type.jni_name,
256 field_length=_generate_array_length(field, struct_ref_name),
257 net_to_host_function=field_type.net_to_host_function,
258 jni_signature_enum_value=base_type.value.type.jni_signature,
259 struct_ref_name=struct_ref_name,
260 object_ref_name=object_ref_name,
264 _C2J_ENUM_ARRAY_SWAP_TEMPLATE = Template("""
265 jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
267 jclass ${field_reference_name}Class = (*env)->FindClass(env, "${jni_name}");
268 jobjectArray ${field_reference_name} = (*env)->NewObjectArray(env, ${field_length}, ${field_reference_name}Class, 0);
269 jmethodID ${field_reference_name}Constructor = (*env)->GetStaticMethodID(env, ${field_reference_name}Class, "forValue", "(${jni_signature_enum_value})${jni_signature}");
271 for (_i = 0; _i < ${field_length}; _i++) {
272 jobject ${field_reference_name}ArrayElement = (*env)->CallStaticObjectMethod(env, ${field_reference_name}Class, ${field_reference_name}Constructor, ${net_to_host_function}(${struct_ref_name}->${c_name}[_i]));
273 (*env)->SetObjectArrayElement(env, ${field_reference_name}, _i, ${field_reference_name}ArrayElement);
274 (*env)->DeleteLocalRef(env, ${field_reference_name}ArrayElement);
276 (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
277 (*env)->DeleteLocalRef(env, ${field_reference_name});
282 def _generate_c2j_primitive_type_array_swap(msg_java_name, field, object_ref_name, struct_ref_name):
283 field_type = field.type
284 return _C2J_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE.substitute(
285 field_reference_name=field.java_name,
286 class_ref_name=msg_java_name,
287 jni_signature=field_type.jni_signature,
288 jni_type=field_type.jni_type,
289 base_type=field_type.base_type.jni_accessor,
290 field_length=_generate_array_length(field, struct_ref_name),
291 jni_base_type=field_type.base_type.jni_type,
292 object_ref_name=object_ref_name,
293 struct_ref_name=struct_ref_name,
294 net_to_host_function=field_type.net_to_host_function,
298 _C2J_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE = Template("""
299 jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
301 ${jni_type} ${field_reference_name} = (*env)->New${base_type}Array(env, ${field_length});
302 ${jni_base_type} * ${field_reference_name}ArrayElements = (*env)->Get${base_type}ArrayElements(env, ${field_reference_name}, NULL);
304 for (_i = 0; _i < ${field_length}; _i++) {
305 ${field_reference_name}ArrayElements[_i] = ${net_to_host_function}(${struct_ref_name}->${c_name}[_i]);
308 (*env)->Release${base_type}ArrayElements(env, ${field_reference_name}, ${field_reference_name}ArrayElements, 0);
309 (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
310 (*env)->DeleteLocalRef(env, ${field_reference_name});
315 def _generate_c2j_primitive_type_array_no_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias):
316 field_type = field.type
318 template = _C2J_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE
320 template = _C2J_ALIAS_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE
321 return template.substitute(
322 field_reference_name=field.java_name,
323 class_ref_name=msg_java_name,
324 jni_signature=field_type.jni_signature,
325 jni_type=field_type.jni_type,
326 base_type=field_type.base_type.jni_accessor,
327 field_length=_generate_array_length(field, struct_ref_name),
328 jni_base_type=field_type.base_type.jni_type,
329 object_ref_name=object_ref_name,
330 struct_ref_name=struct_ref_name,
334 _C2J_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE = Template("""
335 jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
336 ${jni_type} ${field_reference_name} = (*env)->New${base_type}Array(env, ${field_length});
337 (*env)->Set${base_type}ArrayRegion(env, ${field_reference_name}, 0, ${field_length}, (const ${jni_base_type}*)${struct_ref_name}->${c_name});
338 (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
339 (*env)->DeleteLocalRef(env, ${field_reference_name});
343 _C2J_ALIAS_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE = Template("""
344 jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
345 ${jni_type} ${field_reference_name} = (*env)->New${base_type}Array(env, ${field_length});
346 (*env)->Set${base_type}ArrayRegion(env, ${field_reference_name}, 0, ${field_length}, (const ${jni_base_type}*)${struct_ref_name});
347 (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
348 (*env)->DeleteLocalRef(env, ${field_reference_name});
352 def _generate_array_length(field, struct_ref_name):
353 if field.array_len_field:
354 len_field = field.array_len_field
355 if len_field.type.is_swap_needed:
356 return "%s(%s->%s)" % (len_field.type.host_to_net_function, struct_ref_name, len_field.name)
358 return "%s->%s" % (struct_ref_name, len_field.name)
359 return field.array_len
362 def _generate_c2j_scalar_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias):
363 field_type = field.type
364 if field_type.is_swap_needed:
365 # TODO(VPP-1186): move the logic to JNI generators
366 if isinstance(field_type, (Class, Union)):
367 return _generate_c2j_object_swap(msg_java_name, field, object_ref_name, struct_ref_name)
368 elif isinstance(field_type, Enum):
369 return _generate_c2j_enum_swap(msg_java_name, field, object_ref_name, struct_ref_name)
371 return _generate_c2j_primitive_type_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias)
373 return _generate_c2j_primitive_type_no_swap(msg_java_name, field, object_ref_name, struct_ref_name)
376 def _generate_c2j_object_swap(msg_java_name, field, object_ref_name, struct_ref_name):
377 field_type = field.type
378 return _C2J_OBJECT_SWAP_TEMPLATE.substitute(
379 java_name=field.java_name,
380 class_ref_name=msg_java_name,
381 jni_signature=field_type.jni_signature,
382 jni_name=field_type.jni_name,
383 jni_accessor=field_type.jni_accessor,
384 object_ref_name=object_ref_name,
385 struct_ref_name=struct_ref_name,
386 net_to_host_function=field_type.net_to_host_function,
389 _C2J_OBJECT_SWAP_TEMPLATE = Template("""
390 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
391 jclass ${java_name}Class = (*env)->FindClass(env, "${jni_name}");
392 jmethodID ${java_name}Constructor = (*env)->GetMethodID(env, ${java_name}Class, "<init>", "()V");
393 jobject ${java_name} = (*env)->NewObject(env, ${java_name}Class, ${java_name}Constructor);
394 ${net_to_host_function}(env, &(${struct_ref_name}->${c_name}), ${java_name});
395 (*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${java_name});
396 (*env)->DeleteLocalRef(env, ${java_name});
400 def _generate_c2j_enum_swap(msg_java_name, field, object_ref_name, struct_ref_name):
401 field_type = field.type
402 return _C2J_ENUM_SWAP_TEMPLATE.substitute(
403 java_name=field.java_name,
404 class_ref_name=msg_java_name,
405 jni_signature=field_type.jni_signature,
406 jni_signature_enum_value=field_type.value.type.jni_signature,
407 jni_name=field_type.jni_name,
408 jni_accessor=field_type.jni_accessor,
409 object_ref_name=object_ref_name,
410 struct_ref_name=struct_ref_name,
411 net_to_host_function=field_type.net_to_host_function,
414 _C2J_ENUM_SWAP_TEMPLATE = Template("""
415 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
416 jclass ${java_name}Class = (*env)->FindClass(env, "${jni_name}");
417 jmethodID ${java_name}Constructor = (*env)->GetStaticMethodID(env, ${java_name}Class, "forValue", "(${jni_signature_enum_value})${jni_signature}");
418 jobject ${java_name} = (*env)->CallStaticObjectMethod(env, ${java_name}Class, ${java_name}Constructor, ${net_to_host_function}(${struct_ref_name}->${c_name}));
419 (*env)->SetObjectField(env, ${object_ref_name}, ${java_name}FieldId, ${java_name});
420 (*env)->DeleteLocalRef(env, ${java_name});
424 def _generate_c2j_primitive_type_swap(msg_java_name, field, object_ref_name, struct_ref_name, is_alias):
425 field_type = field.type
427 template = _C2J_PRIMITIVE_TYPE_SWAP_TEMPLATE
429 template = _C2J_ALIAS_PRIMITIVE_TYPE_SWAP_TEMPLATE
430 return template.substitute(
431 java_name=field.java_name,
432 class_ref_name=msg_java_name,
433 jni_signature=field_type.jni_signature,
434 jni_accessor=field_type.jni_accessor,
435 object_ref_name=object_ref_name,
436 net_to_host_function=field_type.net_to_host_function,
437 struct_ref_name=struct_ref_name,
441 _C2J_PRIMITIVE_TYPE_SWAP_TEMPLATE = Template("""
442 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
443 (*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${net_to_host_function}(${struct_ref_name}->${c_name}));
447 _C2J_ALIAS_PRIMITIVE_TYPE_SWAP_TEMPLATE = Template("""
448 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
449 (*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${net_to_host_function}(*${struct_ref_name}));
453 def _generate_c2j_primitive_type_no_swap(msg_java_name, field, object_ref_name, struct_ref_name):
454 field_type = field.type
455 return _C2J_PRIMITIVE_TYPE_NO_SWAP_TEMPLATE.substitute(
456 java_name=field.java_name,
457 class_ref_name=msg_java_name,
458 jni_signature=field_type.jni_signature,
459 jni_accessor=field_type.jni_accessor,
460 object_ref_name=object_ref_name,
461 struct_ref_name=struct_ref_name,
465 _C2J_PRIMITIVE_TYPE_NO_SWAP_TEMPLATE = Template("""
466 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
467 (*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${struct_ref_name}->${c_name});