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

   1 #!/usr/bin/env python2
   2 #
   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:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  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 from string import Template
  17
  18 from jni_common_gen import generate_j2c_swap, generate_j2c_identifiers, generate_c2j_swap
  19 from jvpp_model import Class
  20
  21
  22 def generate_type_handlers(model, logger):
  23     """
  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
  27     """
  28     type_handlers = []
  29     for t in model.types:
  30         #TODO(VPP-1186): move the logic to JNI generators
  31         if isinstance(t, Class):
  32             _generate_class(model, t, type_handlers)
  33         else:
  34             logger.debug("Skipping custom JNI type handler generation for %s", t)
  35
  36     return "\n".join(type_handlers)
  37
  38
  39 def _generate_class(model, t, type_handlers):
  40     ref_name = t.java_name_lower
  41     jni_identifiers = generate_j2c_identifiers(t, class_ref_name="%sClass" % ref_name, object_ref_name="_host")
  42     type_handlers.append(_TYPE_NET_TO_HOST_TEMPLATE.substitute(
  43         c_name=t.name,
  44         json_filename=model.json_api_files,
  45         json_definition=t.doc,
  46         type_reference_name=ref_name,
  47         class_FQN=t.jni_name,
  48         jni_identifiers=jni_identifiers,
  49         type_swap=generate_j2c_swap(t, struct_ref_name="_net")
  50     ))
  51
  52     type_handlers.append(_TYPE_HOST_TO_NET_TEMPLATE.substitute(
  53         c_name=t.name,
  54         json_filename=model.json_api_files,
  55         json_definition=t.doc,
  56         type_reference_name=ref_name,
  57         class_FQN=t.jni_name,
  58         jni_identifiers=jni_identifiers,
  59         type_swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net")
  60     ))
  61
  62 _TYPE_NET_TO_HOST_TEMPLATE = Template("""
  63 /**
  64  * Host to network byte order conversion for ${c_name} type.
  65  * Generated based on $json_filename:
  66 $json_definition
  67  */
  68 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
  69 {
  70     jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
  71 $jni_identifiers
  72 $type_swap
  73 }""")
  74
  75 _TYPE_HOST_TO_NET_TEMPLATE = Template("""
  76 /**
  77  * Network to host byte order conversion for ${c_name} type.
  78  * Generated based on $json_filename:
  79 $json_definition
  80  */
  81 static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
  82 {
  83     jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
  84 $type_swap
  85 }""")
  86
  87
  88 def _generate_scalar_host_to_net_swap(field):
  89     field_type = field.type
  90     if field_type.is_swap_needed:
  91         return field_type.get_host_to_net_function(field.java_name, "*_net")
  92     else:
  93         return "*_net = %s" % field.java_name
  94
  95
  96 def _generate_scalar_net_to_host_swap(field):
  97     field_type = field.type
  98     if field_type.is_swap_needed:
  99         return "%s((%s) _net);" % (field_type.net_to_host_function, field_type.name)
 100     else:
 101         return "_net"