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
23 def is_manually_generated(f_name, plugin_name):
24 return f_name in {'control_ping_reply'}
27 class_reference_template = Template("""jclass ${ref_name}Class;
30 find_class_invocation_template = Template("""
31 ${ref_name}Class = (jclass)(*env)->NewGlobalRef(env, (*env)->FindClass(env, "io/fd/vpp/jvpp/${plugin_name}/dto/${class_name}"));
32 if ((*env)->ExceptionCheck(env)) {
33 (*env)->ExceptionDescribe(env);
37 find_class_template = Template("""
38 ${ref_name}Class = (jclass)(*env)->NewGlobalRef(env, (*env)->FindClass(env, "${class_name}"));
39 if ((*env)->ExceptionCheck(env)) {
40 (*env)->ExceptionDescribe(env);
44 delete_class_invocation_template = Template("""
45 if (${ref_name}Class) {
46 (*env)->DeleteGlobalRef(env, ${ref_name}Class);
49 class_cache_template = Template("""
51 static int cache_class_references(JNIEnv* env) {
52 $find_class_invocations
56 static void delete_class_references(JNIEnv* env) {
57 $delete_class_invocations
61 def generate_class_cache(func_list, plugin_name):
63 find_class_invocations = []
64 delete_class_invocations = []
67 class_name = util.underscore_to_camelcase_upper(c_name)
68 ref_name = util.underscore_to_camelcase(c_name)
70 if util.is_ignored(c_name) or util.is_control_ping(class_name):
73 if util.is_reply(class_name):
74 class_references.append(class_reference_template.substitute(
76 find_class_invocations.append(find_class_invocation_template.substitute(
77 plugin_name=plugin_name,
79 class_name=class_name))
80 delete_class_invocations.append(delete_class_invocation_template.substitute(ref_name=ref_name))
81 elif util.is_notification(c_name):
82 class_references.append(class_reference_template.substitute(
83 ref_name=util.add_notification_suffix(ref_name)))
84 find_class_invocations.append(find_class_invocation_template.substitute(
85 plugin_name=plugin_name,
86 ref_name=util.add_notification_suffix(ref_name),
87 class_name=util.add_notification_suffix(class_name)))
88 delete_class_invocations.append(delete_class_invocation_template.substitute(
89 ref_name=util.add_notification_suffix(ref_name)))
91 # add exception class to class cache
92 ref_name = 'callbackException'
93 class_name = 'io/fd/vpp/jvpp/VppCallbackException'
94 class_references.append(class_reference_template.substitute(
96 find_class_invocations.append(find_class_template.substitute(
98 class_name=class_name))
99 delete_class_invocations.append(delete_class_invocation_template.substitute(ref_name=ref_name))
101 return class_cache_template.substitute(
102 class_references="".join(class_references), find_class_invocations="".join(find_class_invocations),
103 delete_class_invocations="".join(delete_class_invocations))
106 # TODO: cache method and field identifiers to achieve better performance
107 # https://jira.fd.io/browse/HONEYCOMB-42
108 request_class_template = Template("""
109 jclass requestClass = (*env)->FindClass(env, "io/fd/vpp/jvpp/${plugin_name}/dto/${java_name_upper}");""")
111 request_field_identifier_template = Template("""
112 jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${object_name}Class, "${field_name}", "${jni_signature}");
113 ${jni_type} ${field_reference_name} = (*env)->Get${jni_getter}(env, ${object_name}, ${field_reference_name}FieldId);
117 jni_impl_template = Template("""
119 * JNI binding for sending ${c_name} message.
120 * Generated based on $inputfile preparsed data:
123 JNIEXPORT jint JNICALL Java_io_fd_vpp_jvpp_${plugin_name}_JVpp${java_plugin_name}Impl_${field_name}0
124 (JNIEnv * env, jclass clazz$args) {
125 ${plugin_name}_main_t *plugin_main = &${plugin_name}_main;
126 vl_api_${c_name}_t * mp;
127 u32 my_context_id = vppjni_get_context_id (&jvpp_main);
131 mp = vl_msg_api_alloc(sizeof(*mp));
132 memset (mp, 0, sizeof (*mp));
133 mp->_vl_msg_id = ntohs (VL_API_${c_name_uppercase} + plugin_main->msg_id_base);
134 mp->client_index = plugin_main->my_client_index;
135 mp->context = clib_host_to_net_u32 (my_context_id);
140 vl_msg_api_send_shmem (plugin_main->vl_input_queue, (u8 *)&mp);
141 if ((*env)->ExceptionCheck(env)) {
144 return my_context_id;
147 def generate_jni_impl(func_list, plugin_name, inputfile):
151 camel_case_function_name = util.underscore_to_camelcase(f_name)
152 if is_manually_generated(f_name, plugin_name) or util.is_reply(camel_case_function_name) \
153 or util.is_ignored(f_name) or util.is_just_notification(f_name):
158 msg_initialization = ''
159 f_name_uppercase = f_name.upper()
162 arguments = ', jobject request'
163 camel_case_function_name_upper = util.underscore_to_camelcase_upper(f_name)
165 request_class = request_class_template.substitute(
166 java_name_upper=camel_case_function_name_upper,
167 plugin_name=plugin_name)
169 for t in zip(f['types'], f['args'], f['lengths']):
170 field_name = util.underscore_to_camelcase(t[1])
171 msg_initialization += jni_gen.jni_request_binding_for_type(field_type=t[0], c_name=t[1],
172 field_reference_name=field_name,
173 field_name=field_name,
174 field_length=t[2][0],
175 is_variable_len_array=t[2][1])
177 jni_impl.append(jni_impl_template.substitute(
179 api_data=util.api_message_to_javadoc(f),
180 field_reference_name=camel_case_function_name,
181 field_name=camel_case_function_name,
182 c_name_uppercase=f_name_uppercase,
184 plugin_name=plugin_name,
185 java_plugin_name=plugin_name.title(),
186 request_class=request_class,
187 msg_initialization=msg_initialization,
190 return "\n".join(jni_impl)
192 # code fragment for checking result of the operation before sending request reply
193 callback_err_handler_template = Template("""
194 // for negative result don't send callback message but send error callback
196 call_on_error("${handler_name}", mp->context, mp->retval, plugin_main->callbackClass, plugin_main->callbackObject, callbackExceptionClass);
199 if (mp->retval == VNET_API_ERROR_IN_PROGRESS) {
200 clib_warning("Result in progress");
205 msg_handler_template = Template("""
207 * Handler for ${handler_name} message.
208 * Generated based on $inputfile preparsed data:
211 static void vl_api_${handler_name}_t_handler (vl_api_${handler_name}_t * mp)
213 ${plugin_name}_main_t *plugin_main = &${plugin_name}_main;
214 JNIEnv *env = jvpp_main.jenv;
218 jmethodID constructor = (*env)->GetMethodID(env, ${class_ref_name}Class, "<init>", "()V");
219 jmethodID callbackMethod = (*env)->GetMethodID(env, plugin_main->callbackClass, "on${dto_name}", "(Lio/fd/vpp/jvpp/${plugin_name}/dto/${dto_name};)V");
221 jobject dto = (*env)->NewObject(env, ${class_ref_name}Class, constructor);
224 (*env)->CallVoidMethod(env, plugin_main->callbackObject, callbackMethod, dto);
225 // free DTO as per http://stackoverflow.com/questions/1340938/memory-leak-when-calling-java-code-from-c-using-jni
226 (*env)->DeleteLocalRef(env, dto);
230 def generate_msg_handlers(func_list, plugin_name, inputfile):
233 handler_name = f['name']
234 dto_name = util.underscore_to_camelcase_upper(handler_name)
235 ref_name = util.underscore_to_camelcase(handler_name)
237 if is_manually_generated(handler_name, plugin_name) or util.is_ignored(handler_name):
240 if not util.is_reply(dto_name) and not util.is_notification(handler_name):
243 if util.is_notification(handler_name):
244 dto_name = util.add_notification_suffix(dto_name)
245 ref_name = util.add_notification_suffix(ref_name)
250 for t in zip(f['types'], f['args'], f['lengths']):
252 java_name = util.underscore_to_camelcase(c_name)
253 field_length = t[2][0]
254 is_variable_len_array = t[2][1]
255 length_field_type = None
256 if is_variable_len_array:
257 length_field_type = f['types'][f['args'].index(field_length)]
258 dto_setters += jni_gen.jni_reply_handler_for_type(handler_name=handler_name, ref_name=ref_name,
259 field_type=t[0], c_name=t[1],
260 field_reference_name=java_name,
261 field_name=java_name, field_length=field_length,
262 is_variable_len_array=is_variable_len_array,
263 length_field_type=length_field_type)
265 # for retval don't generate setters and generate retval check
266 if util.is_retval_field(c_name):
267 err_handler = callback_err_handler_template.substitute(
268 handler_name=handler_name
272 handlers.append(msg_handler_template.substitute(
274 api_data=util.api_message_to_javadoc(f),
275 handler_name=handler_name,
276 plugin_name=plugin_name,
278 class_ref_name=ref_name,
279 dto_setters=dto_setters,
280 err_handler=err_handler))
282 return "\n".join(handlers)
285 handler_registration_template = Template("""_(${upercase_name}, ${name}) \\
289 def generate_handler_registration(func_list):
290 handler_registration = ["#define foreach_api_reply_handler \\\n"]
293 camelcase_name = util.underscore_to_camelcase(f['name'])
295 if (not util.is_reply(camelcase_name) and not util.is_notification(name)) or util.is_ignored(name) \
296 or util.is_control_ping(camelcase_name):
299 handler_registration.append(handler_registration_template.substitute(
301 upercase_name=name.upper()))
303 return "".join(handler_registration)
306 jvpp_c_template = Template("""/**
307 * This file contains JNI bindings for jvpp Java API.
308 * It was generated by jvpp_c_gen.py based on $inputfile
309 * (python representation of api file generated by vppapigen).
312 // JAVA class reference cache
321 // Registration of message handlers in vlib
322 $handler_registration
325 def generate_jvpp(func_list, plugin_name, inputfile, path):
326 """ Generates jvpp C file """
327 print "Generating jvpp C"
329 class_cache = generate_class_cache(func_list, plugin_name)
330 jni_impl = generate_jni_impl(func_list, plugin_name, inputfile)
331 msg_handlers = generate_msg_handlers(func_list, plugin_name, inputfile)
332 handler_registration = generate_handler_registration(func_list)
334 jvpp_c_file = open("%s/jvpp_%s_gen.h" % (path, plugin_name), 'w')
335 jvpp_c_file.write(jvpp_c_template.substitute(
337 class_cache=class_cache,
338 jni_implementations=jni_impl,
339 msg_handlers=msg_handlers,
340 handler_registration=handler_registration))