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