src/vpp-api/java/jvpp/gen/jvppgen/jvpp_c_gen.py

   1 #!/usr/bin/env python
   2 #
   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:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 # l
  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.
  15 #
  16
  17 import os, util
  18 from string import Template
  19
  20 import jni_gen
  21
  22
  23 def is_manually_generated(f_name, plugin_name):
  24     return f_name in {'control_ping_reply'}
  25
  26
  27 class_reference_template = Template("""jclass ${ref_name}Class;
  28 """)
  29
  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);
  34         return JNI_ERR;
  35     }""")
  36
  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);
  41         return JNI_ERR;
  42     }""")
  43
  44 delete_class_invocation_template = Template("""
  45     if (${ref_name}Class) {
  46         (*env)->DeleteGlobalRef(env, ${ref_name}Class);
  47     }""")
  48
  49 class_cache_template = Template("""
  50 $class_references
  51 static int cache_class_references(JNIEnv* env) {
  52     $find_class_invocations
  53     return 0;
  54 }
  55
  56 static void delete_class_references(JNIEnv* env) {
  57     $delete_class_invocations
  58 }""")
  59
  60
  61 def generate_class_cache(func_list, plugin_name):
  62     class_references = []
  63     find_class_invocations = []
  64     delete_class_invocations = []
  65     for f in func_list:
  66         c_name = f['name']
  67         class_name = util.underscore_to_camelcase_upper(c_name)
  68         ref_name = util.underscore_to_camelcase(c_name)
  69
  70         if util.is_ignored(c_name) or util.is_control_ping(class_name):
  71             continue
  72
  73         if util.is_reply(class_name):
  74             class_references.append(class_reference_template.substitute(
  75                 ref_name=ref_name))
  76             find_class_invocations.append(find_class_invocation_template.substitute(
  77                 plugin_name=plugin_name,
  78                 ref_name=ref_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)))
  90
  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(
  95             ref_name=ref_name))
  96     find_class_invocations.append(find_class_template.substitute(
  97             ref_name=ref_name,
  98             class_name=class_name))
  99     delete_class_invocations.append(delete_class_invocation_template.substitute(ref_name=ref_name))
 100
 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))
 104
 105
 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}");""")
 110
 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);
 114     """)
 115
 116
 117 jni_impl_template = Template("""
 118 /**
 119  * JNI binding for sending ${c_name} message.
 120  * Generated based on $inputfile preparsed data:
 121 $api_data
 122  */
 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);
 128     $request_class
 129
 130     // create message:
 131     mp = vl_msg_api_alloc(sizeof(*mp));
 132     memset (mp, 0, sizeof (*mp));
 133     mp->_vl_msg_id = ntohs (get_message_id(env, "${c_name}_${crc}"));
 134     mp->client_index = plugin_main->my_client_index;
 135     mp->context = clib_host_to_net_u32 (my_context_id);
 136
 137     $msg_initialization
 138
 139     // send message:
 140     vl_msg_api_send_shmem (plugin_main->vl_input_queue, (u8 *)&mp);
 141     if ((*env)->ExceptionCheck(env)) {
 142         return JNI_ERR;
 143     }
 144     return my_context_id;
 145 }""")
 146
 147 def generate_jni_impl(func_list, plugin_name, inputfile):
 148     jni_impl = []
 149     for f in func_list:
 150         f_name = f['name']
 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):
 154             continue
 155
 156         arguments = ''
 157         request_class = ''
 158         msg_initialization = ''
 159         f_name_uppercase = f_name.upper()
 160
 161         if f['args']:
 162             arguments = ', jobject request'
 163             camel_case_function_name_upper = util.underscore_to_camelcase_upper(f_name)
 164
 165             request_class = request_class_template.substitute(
 166                     java_name_upper=camel_case_function_name_upper,
 167                     plugin_name=plugin_name)
 168
 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])
 176
 177         jni_impl.append(jni_impl_template.substitute(
 178                 inputfile=inputfile,
 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,
 183                 c_name=f_name,
 184                 crc=f['crc'],
 185                 plugin_name=plugin_name,
 186                 java_plugin_name=plugin_name.title(),
 187                 request_class=request_class,
 188                 msg_initialization=msg_initialization,
 189                 args=arguments))
 190
 191     return "\n".join(jni_impl)
 192
 193 # code fragment for checking result of the operation before sending request reply
 194 callback_err_handler_template = Template("""
 195     // for negative result don't send callback message but send error callback
 196     if (mp->retval<0) {
 197         call_on_error("${handler_name}", mp->context, mp->retval, plugin_main->callbackClass, plugin_main->callbackObject, callbackExceptionClass);
 198         return;
 199     }
 200     if (mp->retval == VNET_API_ERROR_IN_PROGRESS) {
 201         clib_warning("Result in progress");
 202         return;
 203     }
 204 """)
 205
 206 msg_handler_template = Template("""
 207 /**
 208  * Handler for ${handler_name} message.
 209  * Generated based on $inputfile preparsed data:
 210 $api_data
 211  */
 212 static void vl_api_${handler_name}_t_handler (vl_api_${handler_name}_t * mp)
 213 {
 214     ${plugin_name}_main_t *plugin_main = &${plugin_name}_main;
 215     JNIEnv *env = jvpp_main.jenv;
 216
 217     $err_handler
 218
 219     jmethodID constructor = (*env)->GetMethodID(env, ${class_ref_name}Class, "<init>", "()V");
 220     jmethodID callbackMethod = (*env)->GetMethodID(env, plugin_main->callbackClass, "on${dto_name}", "(Lio/fd/vpp/jvpp/${plugin_name}/dto/${dto_name};)V");
 221
 222     jobject dto = (*env)->NewObject(env, ${class_ref_name}Class, constructor);
 223     $dto_setters
 224
 225     (*env)->CallVoidMethod(env, plugin_main->callbackObject, callbackMethod, dto);
 226     // free DTO as per http://stackoverflow.com/questions/1340938/memory-leak-when-calling-java-code-from-c-using-jni
 227     (*env)->DeleteLocalRef(env, dto);
 228 }""")
 229
 230
 231 def generate_msg_handlers(func_list, plugin_name, inputfile):
 232     handlers = []
 233     for f in func_list:
 234         handler_name = f['name']
 235         dto_name = util.underscore_to_camelcase_upper(handler_name)
 236         ref_name = util.underscore_to_camelcase(handler_name)
 237
 238         if is_manually_generated(handler_name, plugin_name) or util.is_ignored(handler_name):
 239             continue
 240
 241         if not util.is_reply(dto_name) and not util.is_notification(handler_name):
 242             continue
 243
 244         if util.is_notification(handler_name):
 245             dto_name = util.add_notification_suffix(dto_name)
 246             ref_name = util.add_notification_suffix(ref_name)
 247
 248         dto_setters = ''
 249         err_handler = ''
 250         # dto setters
 251         for t in zip(f['types'], f['args'], f['lengths']):
 252             c_name = t[1]
 253             java_name = util.underscore_to_camelcase(c_name)
 254             field_length = t[2][0]
 255             is_variable_len_array = t[2][1]
 256             length_field_type = None
 257             if is_variable_len_array:
 258                 length_field_type = f['types'][f['args'].index(field_length)]
 259             dto_setters += jni_gen.jni_reply_handler_for_type(handler_name=handler_name, ref_name=ref_name,
 260                                                               field_type=t[0], c_name=t[1],
 261                                                               field_reference_name=java_name,
 262                                                               field_name=java_name, field_length=field_length,
 263                                                               is_variable_len_array=is_variable_len_array,
 264                                                               length_field_type=length_field_type)
 265
 266             # for retval don't generate setters and generate retval check
 267             if util.is_retval_field(c_name):
 268                 err_handler = callback_err_handler_template.substitute(
 269                     handler_name=handler_name
 270                 )
 271                 continue
 272
 273         handlers.append(msg_handler_template.substitute(
 274             inputfile=inputfile,
 275             api_data=util.api_message_to_javadoc(f),
 276             handler_name=handler_name,
 277             plugin_name=plugin_name,
 278             dto_name=dto_name,
 279             class_ref_name=ref_name,
 280             dto_setters=dto_setters,
 281             err_handler=err_handler))
 282
 283     return "\n".join(handlers)
 284
 285
 286 handler_registration_template = Template("""_(${name}_${crc}, ${name}) \\
 287 """)
 288
 289
 290 def generate_handler_registration(func_list):
 291     handler_registration = ["#define foreach_api_reply_handler \\\n"]
 292     for f in func_list:
 293         name = f['name']
 294         camelcase_name = util.underscore_to_camelcase(f['name'])
 295
 296         if (not util.is_reply(camelcase_name) and not util.is_notification(name)) or util.is_ignored(name) \
 297                 or util.is_control_ping(camelcase_name):
 298             continue
 299
 300         handler_registration.append(handler_registration_template.substitute(
 301             name=name,
 302             crc=f['crc']))
 303
 304     return "".join(handler_registration)
 305
 306
 307 api_verification_template = Template("""_(${name}_${crc}) \\
 308 """)
 309
 310
 311 def generate_api_verification(func_list):
 312     api_verification = ["#define foreach_supported_api_message \\\n"]
 313     for f in func_list:
 314         name = f['name']
 315
 316         if util.is_ignored(name):
 317             continue
 318
 319         api_verification.append(api_verification_template.substitute(
 320             name=name,
 321             crc=f['crc']))
 322
 323     return "".join(api_verification)
 324
 325
 326 jvpp_c_template = Template("""/**
 327  * This file contains JNI bindings for jvpp Java API.
 328  * It was generated by jvpp_c_gen.py based on $inputfile
 329  * (python representation of api file generated by vppapigen).
 330  */
 331
 332 // JAVA class reference cache
 333 $class_cache
 334
 335 // List of supported API messages used for verification
 336 $api_verification
 337
 338 // JNI bindings
 339 $jni_implementations
 340
 341 // Message handlers
 342 $msg_handlers
 343
 344 // Registration of message handlers in vlib
 345 $handler_registration
 346 """)
 347
 348 def generate_jvpp(func_list, plugin_name, inputfile, path):
 349     """ Generates jvpp C file """
 350     print "Generating jvpp C"
 351
 352     class_cache = generate_class_cache(func_list, plugin_name)
 353     jni_impl = generate_jni_impl(func_list, plugin_name, inputfile)
 354     msg_handlers = generate_msg_handlers(func_list, plugin_name, inputfile)
 355     handler_registration = generate_handler_registration(func_list)
 356     api_verification = generate_api_verification(func_list)
 357
 358     jvpp_c_file = open("%s/jvpp_%s_gen.h" % (path, plugin_name), 'w')
 359     jvpp_c_file.write(jvpp_c_template.substitute(
 360             inputfile=inputfile,
 361             class_cache=class_cache,
 362             api_verification=api_verification,
 363             jni_implementations=jni_impl,
 364             msg_handlers=msg_handlers,
 365             handler_registration=handler_registration))
 366     jvpp_c_file.flush()
 367     jvpp_c_file.close()
 368