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, Enum
  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         elif isinstance(t, Enum):
  34             _generate_enum(model, t, type_handlers)
  35         else:
  36             logger.debug("Skipping custom JNI type handler generation for %s", t)
  37
  38     return "\n".join(type_handlers)
  39
  40
  41 def _generate_class(model, t, type_handlers):
  42     ref_name = t.java_name_lower
  43     jni_identifiers = generate_j2c_identifiers(t, class_ref_name="%sClass" % ref_name, object_ref_name="_host")
  44     type_handlers.append(_TYPE_NET_TO_HOST_TEMPLATE.substitute(
  45         c_name=t.name,
  46         json_filename=model.json_api_files,
  47         json_definition=t.doc,
  48         type_reference_name=ref_name,
  49         class_FQN=t.jni_name,
  50         jni_identifiers=jni_identifiers,
  51         type_swap=generate_j2c_swap(t, struct_ref_name="_net")
  52     ))
  53
  54     type_handlers.append(_TYPE_HOST_TO_NET_TEMPLATE.substitute(
  55         c_name=t.name,
  56         json_filename=model.json_api_files,
  57         json_definition=t.doc,
  58         type_reference_name=ref_name,
  59         class_FQN=t.jni_name,
  60         jni_identifiers=jni_identifiers,
  61         type_swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net")
  62     ))
  63
  64 _TYPE_NET_TO_HOST_TEMPLATE = Template("""
  65 /**
  66  * Host to network byte order conversion for ${c_name} type.
  67  * Generated based on $json_filename:
  68 $json_definition
  69  */
  70 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
  71 {
  72     jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
  73 $jni_identifiers
  74 $type_swap
  75 }""")
  76
  77 _TYPE_HOST_TO_NET_TEMPLATE = Template("""
  78 /**
  79  * Network to host byte order conversion for ${c_name} type.
  80  * Generated based on $json_filename:
  81 $json_definition
  82  */
  83 static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
  84 {
  85     jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
  86 $type_swap
  87 }""")
  88
  89
  90 def _generate_enum(model, t, type_handlers):
  91     value_type = t.value.type
  92     type_handlers.append(_ENUM_NET_TO_HOST_TEMPLATE.substitute(
  93         c_name=t.name,
  94         json_filename=model.json_api_files,
  95         json_definition=t.doc,
  96         class_FQN=t.jni_name,
  97         jni_signature=value_type.jni_signature,
  98         jni_type=value_type.jni_type,
  99         jni_accessor=value_type.jni_accessor,
 100         swap=_generate_scalar_host_to_net_swap(t.value)
 101     ))
 102
 103     type_handlers.append(_ENUM_HOST_TO_NET_TEMPLATE.substitute(
 104         c_name=t.name,
 105         json_filename=model.json_api_files,
 106         json_definition=t.doc,
 107         class_FQN=t.jni_name,
 108         jni_type=value_type.jni_type,
 109         type_swap=_generate_scalar_net_to_host_swap(t.value)
 110     ))
 111
 112 _ENUM_NET_TO_HOST_TEMPLATE = Template("""
 113 /**
 114  * Host to network byte order conversion for ${c_name} enum.
 115  * Generated based on $json_filename:
 116 $json_definition
 117  */
 118 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
 119 {
 120     jclass enumClass = (*env)->FindClass(env, "${class_FQN}");
 121     jfieldID valueFieldId = (*env)->GetStaticFieldID(env, enumClass, "value", "${jni_signature}");
 122     ${jni_type} value = (*env)->GetStatic${jni_accessor}Field(env, enumClass, valueFieldId);
 123     ${swap};
 124 }""")
 125
 126 _ENUM_HOST_TO_NET_TEMPLATE = Template("""
 127 /**
 128  * Network to host byte order conversion for ${c_name} type.
 129  * Generated based on $json_filename:
 130 $json_definition
 131  */
 132 static inline ${jni_type} _net_to_host_${c_name}(vl_api_${c_name}_t _net)
 133 {
 134     return (${jni_type}) $type_swap
 135 }""")
 136
 137
 138 def _generate_scalar_host_to_net_swap(field):
 139     field_type = field.type
 140     if field_type.is_swap_needed:
 141         return field_type.get_host_to_net_function(field.java_name, "*_net")
 142     else:
 143         return "*_net = %s" % field.java_name
 144
 145
 146 def _generate_scalar_net_to_host_swap(field):
 147     field_type = field.type
 148     if field_type.is_swap_needed:
 149         return "%s((%s) _net);" % (field_type.net_to_host_function, field_type.name)
 150     else:
 151         return "_net"