3 # Copyright (c) 2016 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.
18 from string import Template
20 def is_manually_generated(f_name):
21 return f_name in {'control_ping_reply'}
24 class_reference_template = Template("""jclass ${ref_name}Class;
27 find_class_invocation_template = Template("""
28 ${ref_name}Class = (jclass)(*env)->NewGlobalRef(env, (*env)->FindClass(env, "org/openvpp/jvpp/dto/${class_name}"));
29 if ((*env)->ExceptionCheck(env)) {
30 (*env)->ExceptionDescribe(env);
34 find_class_template = Template("""
35 ${ref_name}Class = (jclass)(*env)->NewGlobalRef(env, (*env)->FindClass(env, "${class_name}"));
36 if ((*env)->ExceptionCheck(env)) {
37 (*env)->ExceptionDescribe(env);
41 class_cache_template = Template("""
43 static int cache_class_references(JNIEnv* env) {
44 $find_class_invocations
48 def generate_class_cache(func_list):
50 find_class_invocations = []
53 class_name = util.underscore_to_camelcase_upper(c_name)
54 ref_name = util.underscore_to_camelcase(c_name)
56 if util.is_ignored(c_name):
59 if util.is_reply(class_name):
60 class_references.append(class_reference_template.substitute(
62 find_class_invocations.append(find_class_invocation_template.substitute(
64 class_name=class_name))
65 elif util.is_notification(c_name):
66 class_references.append(class_reference_template.substitute(
67 ref_name=util.add_notification_suffix(ref_name)))
68 find_class_invocations.append(find_class_invocation_template.substitute(
69 ref_name=util.add_notification_suffix(ref_name),
70 class_name=util.add_notification_suffix(class_name)))
72 # add exception class to class cache
73 ref_name = 'callbackException'
74 class_name = 'org/openvpp/jvpp/VppCallbackException'
75 class_references.append(class_reference_template.substitute(
77 find_class_invocations.append(find_class_template.substitute(
79 class_name=class_name))
80 return class_cache_template.substitute(
81 class_references="".join(class_references), find_class_invocations="".join(find_class_invocations))
84 # TODO: cache method and field identifiers to achieve better performance
85 # https://jira.fd.io/browse/HONEYCOMB-42
86 request_class_template = Template("""
87 jclass requestClass = (*env)->FindClass(env, "org/openvpp/jvpp/dto/${java_name_upper}");""")
89 request_field_identifier_template = Template("""
90 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, requestClass, "${java_name}", "${jni_signature}");
91 ${jni_type} ${java_name} = (*env)->Get${jni_getter}(env, request, ${java_name}FieldId);
94 u8_struct_setter_template = Template("""
95 mp->${c_name} = ${java_name};""")
97 u16_struct_setter_template = Template("""
98 mp->${c_name} = clib_host_to_net_u16(${java_name});""")
100 u32_struct_setter_template = Template("""
101 mp->${c_name} = clib_host_to_net_u32(${java_name});""")
103 i32_struct_setter_template = Template("""
104 mp->${c_name} = clib_host_to_net_i32(${java_name});!""")
106 u64_struct_setter_template = Template("""
107 mp->${c_name} = clib_host_to_net_u64(${java_name});""")
109 u8_array_struct_setter_template = Template("""
111 jsize cnt = (*env)->GetArrayLength (env, ${java_name});
112 size_t max_size = ${field_length};
113 if (max_size != 0 && cnt > max_size) cnt = max_size;
114 (*env)->GetByteArrayRegion(env, ${java_name}, 0, cnt, (jbyte *)mp->${c_name});
118 u32_array_struct_setter_template = Template("""
119 jint * ${java_name}ArrayElements = (*env)->GetIntArrayElements(env, ${java_name}, NULL);
122 jsize cnt = (*env)->GetArrayLength (env, ${java_name});
123 size_t max_size = ${field_length};
124 if (max_size != 0 && cnt > max_size) cnt = max_size;
125 for (_i = 0; _i < cnt; _i++) {
126 mp->${c_name}[_i] = clib_host_to_net_u32(${java_name}ArrayElements[_i]);
129 (*env)->ReleaseIntArrayElements (env, ${java_name}, ${java_name}ArrayElements, 0);
132 vl_api_ip4_fib_counter_t_array_struct_setter_template = Template("""
133 // vl_api_ip4_fib_counter_t_array_field_setter_template FIXME""")
135 vl_api_ip6_fib_counter_t_array_struct_setter_template = Template("""
136 // vl_api_ip6_fib_counter_t_array_field_setter_template FIXME""")
138 struct_setter_templates = {'u8': u8_struct_setter_template,
139 'u16': u16_struct_setter_template,
140 'u32': u32_struct_setter_template,
141 'i32': u32_struct_setter_template,
142 'u64': u64_struct_setter_template,
143 'u8[]': u8_array_struct_setter_template,
144 'u32[]': u32_array_struct_setter_template,
145 'vl_api_ip4_fib_counter_t[]': vl_api_ip4_fib_counter_t_array_struct_setter_template,
146 'vl_api_ip6_fib_counter_t[]': vl_api_ip6_fib_counter_t_array_struct_setter_template
149 jni_impl_template = Template("""
151 * JNI binding for sending ${c_name} vpe.api message.
152 * Generated based on $inputfile preparsed data:
155 JNIEXPORT jint JNICALL Java_org_openvpp_jvpp_JVppImpl_${java_name}0
156 (JNIEnv * env, jclass clazz$args) {
157 vppjni_main_t *jm = &vppjni_main;
158 vl_api_${c_name}_t * mp;
161 rv = vppjni_sanity_check (jm);
163 my_context_id = vppjni_get_context_id (jm);
166 M(${c_name_uppercase}, ${c_name});
167 mp->context = clib_host_to_net_u32 (my_context_id);
170 if ((*env)->ExceptionCheck(env)) {
173 return my_context_id;
176 def generate_jni_impl(func_list, inputfile):
180 camel_case_function_name = util.underscore_to_camelcase(f_name)
181 if is_manually_generated(f_name) or util.is_reply(camel_case_function_name) \
182 or util.is_ignored(f_name) or util.is_just_notification(f_name):
187 field_identifiers = ''
189 f_name_uppercase = f_name.upper()
192 arguments = ', jobject request'
193 camel_case_function_name_upper = util.underscore_to_camelcase_upper(f_name)
195 request_class = request_class_template.substitute(java_name_upper=camel_case_function_name_upper)
198 for t in zip(f['types'], f['args']):
200 java_field_name = util.underscore_to_camelcase(t[1])
201 jni_signature = util.jni_2_signature_mapping[jni_type]
202 jni_getter = util.jni_field_accessors[jni_type]
203 field_identifiers += request_field_identifier_template.substitute(
205 java_name=java_field_name,
206 jni_signature=jni_signature,
207 jni_getter=jni_getter)
210 for t in zip(f['c_types'], f['args'], f['lengths']):
213 field_length = t[2][0]
215 # check if we are processing variable length array:
217 field_length = util.underscore_to_camelcase(t[2][0])
219 java_field_name = util.underscore_to_camelcase(c_name)
221 struct_setter_template = struct_setter_templates[c_type]
223 struct_setters += struct_setter_template.substitute(
225 java_name=java_field_name,
226 field_length=field_length)
228 jni_impl.append(jni_impl_template.substitute(
230 api_data=util.api_message_to_javadoc(f),
231 java_name=camel_case_function_name,
232 c_name_uppercase=f_name_uppercase,
234 request_class=request_class,
235 field_identifiers=field_identifiers,
236 struct_setters=struct_setters,
239 return "\n".join(jni_impl)
242 dto_field_id_template = Template("""
243 jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");""")
245 default_dto_field_setter_template = Template("""
246 (*env)->Set${jni_setter}(env, dto, ${java_name}FieldId, mp->${c_name});
249 variable_length_array_value_template = Template("""mp->${length_var_name}""")
250 variable_length_array_template = Template("""clib_net_to_host_${length_field_type}(${value})""")
252 u16_dto_field_setter_template = Template("""
253 (*env)->Set${jni_setter}(env, dto, ${java_name}FieldId, clib_net_to_host_u16(mp->${c_name}));
256 u32_dto_field_setter_template = Template("""
257 (*env)->Set${jni_setter}(env, dto, ${java_name}FieldId, clib_net_to_host_u32(mp->${c_name}));
260 u64_dto_field_setter_template = Template("""
261 (*env)->Set${jni_setter}(env, dto, ${java_name}FieldId, clib_net_to_host_u64(mp->${c_name}));
264 u8_array_dto_field_setter_template = Template("""
265 jbyteArray ${java_name} = (*env)->NewByteArray(env, ${field_length});
266 (*env)->SetByteArrayRegion(env, ${java_name}, 0, ${field_length}, (const jbyte*)mp->${c_name});
267 (*env)->SetObjectField(env, dto, ${java_name}FieldId, ${java_name});
270 u32_array_dto_field_setter_template = Template("""
272 jintArray ${java_name} = (*env)->NewIntArray(env, ${field_length});
273 jint * ${java_name}ArrayElements = (*env)->GetIntArrayElements(env, ${java_name}, NULL);
275 for (_i = 0; _i < ${field_length}; _i++) {
276 ${java_name}ArrayElements[_i] = clib_net_to_host_u32(mp->${c_name}[_i]);
279 (*env)->ReleaseIntArrayElements(env, ${java_name}, ${java_name}ArrayElements, 0);
280 (*env)->SetObjectField(env, dto, ${java_name}FieldId, ${java_name});
284 # For each u64 array we get its elements. Then we convert values to host byte order.
285 # All changes to jlong* buffer are written to jlongArray (isCopy is set to NULL)
286 u64_array_dto_field_setter_template = Template("""
288 jlongArray ${java_name} = (*env)->NewLongArray(env, ${field_length});
289 jlong * ${java_name}ArrayElements = (*env)->GetLongArrayElements(env, ${java_name}, NULL);
291 for (_i = 0; _i < ${field_length}; _i++) {
292 ${java_name}ArrayElements[_i] = clib_net_to_host_u64(mp->${c_name}[_i]);
295 (*env)->ReleaseLongArrayElements(env, ${java_name}, ${java_name}ArrayElements, 0);
296 (*env)->SetObjectField(env, dto, ${java_name}FieldId, ${java_name});
300 dto_field_setter_templates = {'u8': default_dto_field_setter_template,
301 'u16': u16_dto_field_setter_template,
302 'u32': u32_dto_field_setter_template,
303 'i32': u32_dto_field_setter_template,
304 'u64': u64_dto_field_setter_template,
305 'f64': default_dto_field_setter_template, #fixme
306 'u8[]': u8_array_dto_field_setter_template,
307 'u32[]': u32_array_dto_field_setter_template,
308 'u64[]': u64_array_dto_field_setter_template
311 # code fragment for checking result of the operation before sending request reply
312 callback_err_handler_template = Template("""
313 // for negative result don't send callback message but send error callback
315 CallOnError("${handler_name}",mp->context,mp->retval);
318 if (mp->retval == VNET_API_ERROR_IN_PROGRESS) {
319 clib_warning("Result in progress");
324 msg_handler_template = Template("""
326 * Handler for ${handler_name} vpe.api message.
327 * Generated based on $inputfile preparsed data:
330 static void vl_api_${handler_name}_t_handler (vl_api_${handler_name}_t * mp)
332 vppjni_main_t * jm = &vppjni_main;
333 JNIEnv *env = jm->jenv;
336 jmethodID constructor = (*env)->GetMethodID(env, ${class_ref_name}Class, "<init>", "()V");
337 jmethodID callbackMethod = (*env)->GetMethodID(env, jm->callbackClass, "on${dto_name}", "(Lorg/openvpp/jvpp/dto/${dto_name};)V");
339 jobject dto = (*env)->NewObject(env, ${class_ref_name}Class, constructor);
341 (*env)->CallVoidMethod(env, jm->callback, callbackMethod, dto);
344 def generate_msg_handlers(func_list, inputfile):
347 handler_name = f['name']
348 dto_name = util.underscore_to_camelcase_upper(handler_name)
349 ref_name = util.underscore_to_camelcase(handler_name)
351 if is_manually_generated(handler_name) or util.is_ignored(handler_name):
354 if not util.is_reply(dto_name) and not util.is_notification(handler_name):
357 if util.is_notification(handler_name):
358 dto_name = util.add_notification_suffix(dto_name)
359 ref_name = util.add_notification_suffix(ref_name)
364 for t in zip(f['c_types'], f['types'], f['args'], f['lengths']):
368 field_length = t[3][0]
370 # check if we are processing variable length array
372 length_var_name = t[3][0]
373 length_field_type = f['c_types'][f['args'].index(length_var_name)]
374 field_length = variable_length_array_value_template.substitute(length_var_name=length_var_name)
375 if length_field_type != 'u8': # we need net to host conversion:
376 field_length = variable_length_array_template.substitute(
377 length_field_type=length_field_type, value=field_length)
379 # for retval don't generate setters and generate retval check
380 if util.is_retval_field(c_name):
381 err_handler = callback_err_handler_template.substitute(
382 handler_name=handler_name
386 java_field_name = util.underscore_to_camelcase(c_name)
387 jni_signature = util.jni_2_signature_mapping[jni_type]
388 jni_setter = util.jni_field_accessors[jni_type]
390 dto_setters += dto_field_id_template.substitute(
391 java_name=java_field_name,
392 class_ref_name=ref_name,
393 jni_signature=jni_signature)
395 dto_setter_template = dto_field_setter_templates[c_type]
397 dto_setters += dto_setter_template.substitute(
398 java_name=java_field_name,
399 jni_signature=jni_signature,
401 jni_setter=jni_setter,
402 field_length=field_length)
404 handlers.append(msg_handler_template.substitute(
406 api_data=util.api_message_to_javadoc(f),
407 handler_name=handler_name,
409 class_ref_name=ref_name,
410 dto_setters=dto_setters,
411 err_handler=err_handler))
413 return "\n".join(handlers)
416 handler_registration_template = Template("""_(${upercase_name}, ${name}) \\
420 def generate_handler_registration(func_list):
421 handler_registration = ["#define foreach_vpe_api_msg \\\n"]
424 camelcase_name = util.underscore_to_camelcase(f['name'])
426 if (not util.is_reply(camelcase_name) and not util.is_notification(name)) or util.is_ignored(name):
429 handler_registration.append(handler_registration_template.substitute(
431 upercase_name=name.upper()))
433 return "".join(handler_registration)
436 jvpp_c_template = Template("""/**
437 * This file contains JNI bindings for jvpp Java API.
438 * It was generated by jvpp_c_gen.py based on $inputfile
439 * (python representation of vpe.api generated by vppapigen).
442 void CallOnError(const char* call, int context, int retval);
444 // JAVA class reference cache
453 // Registration of message handlers in vlib
454 $handler_registration
457 def generate_jvpp(func_list, inputfile):
458 """ Generates jvpp C file """
459 print "Generating jvpp C"
461 class_cache = generate_class_cache(func_list)
462 jni_impl = generate_jni_impl(func_list, inputfile)
463 msg_handlers = generate_msg_handlers(func_list, inputfile)
464 handler_registration = generate_handler_registration(func_list)
466 jvpp_c_file = open("jvpp_gen.h", 'w')
467 jvpp_c_file.write(jvpp_c_template.substitute(
469 class_cache=class_cache,
470 jni_implementations=jni_impl,
471 msg_handlers=msg_handlers,
472 handler_registration=handler_registration))