extras/japi/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_field_swap, generate_j2c_identifiers, generate_c2j_swap
  19 from jvpp_model import Class, Enum, Union
  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         elif isinstance(t, Union):
  36             _generate_union(model, t, type_handlers)
  37         else:
  38             logger.debug("Skipping custom JNI type handler generation for %s", t)
  39
  40     return "\n".join(type_handlers)
  41
  42
  43 def _generate_class(model, t, type_handlers):
  44     ref_name = t.java_name_lower
  45     if t.name in model._aliases:
  46         is_alias = True
  47     else:
  48         is_alias = False
  49
  50     type_handlers.append(_TYPE_HOST_TO_NET_TEMPLATE.substitute(
  51         c_name=t.name,
  52         json_filename=model.json_api_files,
  53         json_definition=t.doc,
  54         type_reference_name=ref_name,
  55         class_FQN=t.jni_name,
  56         jni_identifiers=generate_j2c_identifiers(t, class_ref_name="%sClass" % ref_name, object_ref_name="_host"),
  57         type_swap=generate_j2c_swap(t, struct_ref_name="_net", is_alias=is_alias)
  58     ))
  59     type_handlers.append(_TYPE_NET_TO_HOST_TEMPLATE.substitute(
  60         c_name=t.name,
  61         json_filename=model.json_api_files,
  62         json_definition=t.doc,
  63         type_reference_name=ref_name,
  64         class_FQN=t.jni_name,
  65         type_swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net", is_alias=is_alias)
  66     ))
  67
  68 _TYPE_HOST_TO_NET_TEMPLATE = Template("""
  69 /**
  70  * Host to network byte order conversion for ${c_name} type.
  71  * Generated based on $json_filename:
  72 $json_definition
  73  */
  74 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
  75 {
  76     jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
  77 $jni_identifiers
  78 $type_swap
  79 }""")
  80
  81 _TYPE_NET_TO_HOST_TEMPLATE = Template("""
  82 /**
  83  * Network to host byte order conversion for ${c_name} type.
  84  * Generated based on $json_filename:
  85 $json_definition
  86  */
  87 static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
  88 {
  89     jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
  90 $type_swap
  91 }""")
  92
  93
  94 def _generate_enum(model, t, type_handlers):
  95     value_type = t.value.type
  96     type_handlers.append(_ENUM_NET_TO_HOST_TEMPLATE.substitute(
  97         c_name=t.name,
  98         json_filename=model.json_api_files,
  99         json_definition=t.doc,
 100         class_FQN=t.jni_name,
 101         jni_signature=value_type.jni_signature,
 102         jni_type=value_type.jni_type,
 103         jni_accessor=value_type.jni_accessor,
 104         swap=_generate_scalar_host_to_net_swap(t.value)
 105     ))
 106
 107     type_handlers.append(_ENUM_HOST_TO_NET_TEMPLATE.substitute(
 108         c_name=t.name,
 109         json_filename=model.json_api_files,
 110         json_definition=t.doc,
 111         class_FQN=t.jni_name,
 112         jni_type=value_type.jni_type,
 113         type_swap=_generate_scalar_net_to_host_swap(t.value)
 114     ))
 115
 116 _ENUM_NET_TO_HOST_TEMPLATE = Template("""
 117 /**
 118  * Host to network byte order conversion for ${c_name} enum.
 119  * Generated based on $json_filename:
 120 $json_definition
 121  */
 122 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
 123 {
 124     jclass enumClass = (*env)->FindClass(env, "${class_FQN}");
 125     jmethodID getValueMethod = (*env)->GetMethodID(env, enumClass, "ordinal", "()I");
 126     ${jni_type} value = (*env)->CallIntMethod(env, _host, getValueMethod);
 127     ${swap};
 128 }""")
 129
 130 _ENUM_HOST_TO_NET_TEMPLATE = Template("""
 131 /**
 132  * Network to host byte order conversion for ${c_name} type.
 133  * Generated based on $json_filename:
 134 $json_definition
 135  */
 136 static inline ${jni_type} _net_to_host_${c_name}(vl_api_${c_name}_t _net)
 137 {
 138     return (${jni_type}) $type_swap
 139 }""")
 140
 141
 142 def _generate_scalar_host_to_net_swap(field):
 143     field_type = field.type
 144     if field_type.is_swap_needed:
 145         return field_type.get_host_to_net_function(field.java_name, "*_net")
 146     else:
 147         return "*_net = %s" % field.java_name
 148
 149
 150 def _generate_scalar_net_to_host_swap(field):
 151     field_type = field.type
 152     if field_type.is_swap_needed:
 153         return "%s((%s) _net);" % (field_type.net_to_host_function, field_type.name)
 154     else:
 155         return "_net"
 156
 157
 158 def _generate_union(model, t, type_handlers):
 159     type_handlers.append(_generate_union_host_to_net(model, t))
 160     type_handlers.append(_generate_union_net_to_host(model, t))
 161
 162
 163 def _generate_union_host_to_net(model, t):
 164     swap = []
 165     for i, field in enumerate(t.fields):
 166         field_type = field.type
 167         if t.name in model._aliases:
 168             is_alias = True
 169         else:
 170             is_alias = False
 171         swap.append(_UNION_FIELD_HOST_TO_NET_TEMPLATE.substitute(
 172             field_index=i,
 173             java_name=field.java_name,
 174             jni_signature=field_type.jni_signature,
 175             jni_type=field_type.jni_type,
 176             jni_accessor=field_type.jni_accessor,
 177             swap=generate_j2c_field_swap(field, struct_ref_name="_net", is_alias=is_alias)
 178         ))
 179
 180     return _UNION_HOST_TO_NET_TEMPLATE.substitute(
 181         c_name=t.name,
 182         json_filename=model.json_api_files,
 183         json_definition=t.doc,
 184         class_FQN=t.jni_name,
 185         swap="".join(swap)
 186     )
 187
 188 _UNION_FIELD_HOST_TO_NET_TEMPLATE = Template("""
 189     if (_activeMember == ${field_index}) {
 190         jfieldID fieldId = (*env)->GetFieldID(env, _class, "${java_name}", "${jni_signature}");
 191         ${jni_type} ${java_name} = (*env)->Get${jni_accessor}Field(env, _host, fieldId);
 192     ${swap}
 193     }""")
 194
 195 _UNION_HOST_TO_NET_TEMPLATE = Template("""
 196 /**
 197  * Host to network byte order conversion for ${c_name} union.
 198  * Generated based on $json_filename:
 199 $json_definition
 200  */
 201 static inline void _host_to_net_${c_name}(JNIEnv * env, jobject _host, vl_api_${c_name}_t * _net)
 202 {
 203     jclass _class = (*env)->FindClass(env, "${class_FQN}");
 204
 205     jfieldID _activeMemberFieldId = (*env)->GetFieldID(env, _class, "_activeMember", "I");
 206     jint _activeMember = (*env)->GetIntField(env, _host, _activeMemberFieldId);
 207 $swap
 208 }""")
 209
 210
 211 def _generate_union_net_to_host(model, t):
 212     if t.name in model._aliases:
 213         is_alias = True
 214     else:
 215         is_alias = False
 216     return _UNION_NET_TO_HOST_TEMPLATE.substitute(
 217         c_name=t.name,
 218         json_filename=model.json_api_files,
 219         json_definition=t.doc,
 220         type_reference_name=t.java_name_lower,
 221         class_FQN=t.jni_name,
 222         swap=generate_c2j_swap(t, object_ref_name="_host", struct_ref_name="_net", is_alias=is_alias)
 223     )
 224
 225 _UNION_NET_TO_HOST_TEMPLATE = Template("""
 226 /**
 227  * Network to host byte order conversion for ${c_name} union.
 228  * Generated based on $json_filename:
 229 $json_definition
 230  */
 231 static inline void _net_to_host_${c_name}(JNIEnv * env, vl_api_${c_name}_t * _net, jobject _host)
 232 {
 233     jclass ${type_reference_name}Class = (*env)->FindClass(env, "${class_FQN}");
 234 $swap
 235 }""")