src/vpp-api/java/jvpp/gen/jvppgen/jni_common_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 jvpp_model import is_array, is_retval, Class
  19
  20
  21 def generate_j2c_identifiers(element, class_ref_name, object_ref_name):
  22     identifiers = []
  23     for field in element.fields:
  24         field_type = field.type
  25         identifiers.append(_REQUEST_FIELD_IDENTIFIER_TEMPLATE.substitute(
  26             java_name=field.java_name,
  27             class_ref_name=class_ref_name,
  28             jni_signature=field_type.jni_signature,
  29             jni_type=field_type.jni_type,
  30             jni_accessor=field_type.jni_accessor,
  31             object_ref_name=object_ref_name
  32         ))
  33     return "".join(identifiers)
  34
  35 _REQUEST_FIELD_IDENTIFIER_TEMPLATE = Template("""
  36     jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}, "${java_name}", "${jni_signature}");
  37     ${jni_type} ${java_name} = (*env)->Get${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId);
  38 """)
  39
  40
  41 # TODO(VPP-1187): do not inline JNI object creation inside message handlers to reduce number of special cases
  42 def generate_j2c_swap(element, struct_ref_name):
  43     initialization = []
  44     for field in element.fields:
  45         if is_array(field):
  46             initialization.append(_generate_j2c_array_swap(field, struct_ref_name))
  47         else:
  48             initialization.append(_generate_j2c_scalar_swap(field, struct_ref_name))
  49
  50     return "\n".join(initialization)
  51
  52
  53 def _generate_j2c_array_swap(field, struct_ref_name):
  54     # TODO(VPP-1186): move the logic to JNI generators
  55     base_type = field.type.base_type
  56     if isinstance(base_type, Class):
  57         return _generate_j2c_object_array_swap(field, struct_ref_name)
  58     elif base_type.is_swap_needed:
  59         return _generate_j2c_primitive_type_array_swap(field, struct_ref_name)
  60     else:
  61         return _generate_j2c_primitive_type_array_no_swap(field, struct_ref_name)
  62
  63
  64 def _generate_j2c_object_array_swap(field, struct_ref_name):
  65     field_type = field.type
  66     field_reference_name = field.java_name
  67     c_name = field.name
  68     host = "%sArrayElement" % field_reference_name
  69     net = "%s->%s[_i]" % (struct_ref_name, c_name)
  70     swap_elements = field_type.get_host_to_net_function(host, net)
  71     return _J2C_OBJECT_ARRAY_SWAP_TEMPLATE.substitute(
  72         field_reference_name=field_reference_name,
  73         field_length_check=_generate_field_length_check(field),
  74         swap_elements=swap_elements)
  75
  76 _J2C_OBJECT_ARRAY_SWAP_TEMPLATE = Template("""
  77     {
  78         if (${field_reference_name}) {
  79             size_t _i;
  80             jsize cnt = (*env)->GetArrayLength (env, ${field_reference_name});
  81             ${field_length_check}
  82             for (_i = 0; _i < cnt; _i++) {
  83                 jobject ${field_reference_name}ArrayElement = (*env)->GetObjectArrayElement(env, ${field_reference_name}, _i);
  84                 ${swap_elements};
  85             }
  86         }
  87     }
  88 """)
  89
  90
  91 def _generate_j2c_primitive_type_array_swap(field, struct_ref_name):
  92     field_reference_name = field.java_name
  93     field_type = field.type
  94     host = "%sArrayElements[_i]" % field_reference_name
  95     net = "%s->%s[_i]" % (struct_ref_name,  field.name)
  96     swap_elements = field_type.get_host_to_net_function(host, net)
  97     return _J2C_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE.substitute(
  98         field_reference_name=field_reference_name,
  99         field_length_check=_generate_field_length_check(field),
 100         base_type=field_type.base_type.jni_accessor,
 101         jni_base_type=field_type.base_type.jni_type,
 102         swap_elements=swap_elements
 103     )
 104
 105 _J2C_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE = Template("""
 106     if (${field_reference_name}) {
 107         ${jni_base_type} * ${field_reference_name}ArrayElements = (*env)->Get${base_type}ArrayElements(env, ${field_reference_name}, NULL);
 108         size_t _i;
 109         jsize cnt = (*env)->GetArrayLength(env, ${field_reference_name});
 110         ${field_length_check}
 111         for (_i = 0; _i < cnt; _i++) {
 112             ${swap_elements};
 113         }
 114         (*env)->Release${base_type}ArrayElements (env, ${field_reference_name}, ${field_reference_name}ArrayElements, 0);
 115     }
 116     """)
 117
 118
 119 def _generate_j2c_primitive_type_array_no_swap(field, struct_ref_name):
 120     field_type = field.type
 121     return _J2C_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE.substitute(
 122         field_reference_name=field.java_name,
 123         field_length_check=_generate_field_length_check(field),
 124         base_type=field_type.base_type.jni_accessor,
 125         jni_base_type=field_type.base_type.jni_type,
 126         struct_reference_name=struct_ref_name,
 127         c_name=field.name
 128     )
 129
 130 _J2C_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE = Template("""
 131     if (${field_reference_name}) {
 132         jsize cnt = (*env)->GetArrayLength (env, ${field_reference_name});
 133         ${field_length_check}
 134         (*env)->Get${base_type}ArrayRegion(env, ${field_reference_name}, 0, cnt, (${jni_base_type} *)${struct_reference_name}->${c_name});
 135     }
 136 """)
 137
 138
 139 def _generate_field_length_check(field):
 140     # Enforce max length if array has fixed length or uses variable length syntax
 141     field_length = str(field.array_len)
 142     if field.array_len_field:
 143         field_length = field.array_len_field.java_name
 144
 145     # TODO: remove when ZLAs without length field are disabled
 146     if field_length != "0":
 147         return _FIELD_LENGTH_CHECK.substitute(field_length=field_length)
 148     else:
 149         return ""
 150
 151 # Make sure we do not write more elements that are expected
 152 _FIELD_LENGTH_CHECK = Template("""
 153         size_t max_size = ${field_length};
 154         if (cnt > max_size) cnt = max_size;""")
 155
 156
 157 def _generate_j2c_scalar_swap(field, struct_ref_name):
 158     field_type = field.type
 159     if field_type.is_swap_needed:
 160         host = field.java_name
 161         net = "%s->%s" % (struct_ref_name, field.name)
 162         return "    %s;" % field_type.get_host_to_net_function(host, net)
 163     else:
 164         return "    %s->%s = %s;" % (struct_ref_name, field.name, field.java_name)
 165
 166
 167 def generate_c2j_swap(element, object_ref_name, struct_ref_name):
 168     msg_java_name = element.java_name_lower
 169     initialization = []
 170     for field in element.fields:
 171         if is_retval(field):
 172             # For retval don't generate setters and generate retval check
 173             continue
 174         elif is_array(field):
 175             initialization.append(_generate_c2j_array_swap(msg_java_name, field, object_ref_name, struct_ref_name))
 176         else:
 177             initialization.append(_generate_c2j_scalar_swap(msg_java_name, field, object_ref_name, struct_ref_name))
 178     return "".join(initialization)
 179
 180
 181 def _generate_c2j_array_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 182     # TODO(VPP-1186): move the logic to JNI generators
 183     base_type = field.type.base_type
 184     if isinstance(base_type, Class):
 185         return _generate_c2j_class_array_swap(msg_java_name, field, object_ref_name, struct_ref_name)
 186     elif base_type.is_swap_needed:
 187         return _generate_c2j_primitive_type_array_swap(msg_java_name, field, object_ref_name, struct_ref_name)
 188     else:
 189         return _generate_c2j_primitive_type_array_no_swap(msg_java_name, field, object_ref_name, struct_ref_name)
 190
 191
 192 def _generate_c2j_class_array_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 193     field_type = field.type
 194     return _C2J_CLASS_ARRAY_SWAP_TEMPLATE.substitute(
 195         field_reference_name=field.java_name,
 196         class_ref_name=msg_java_name,
 197         jni_signature=field_type.jni_signature,
 198         jni_name=field_type.base_type.jni_name,
 199         field_length=_generate_array_length(field, struct_ref_name),
 200         net_to_host_function=field_type.net_to_host_function,
 201         struct_ref_name=struct_ref_name,
 202         object_ref_name=object_ref_name,
 203         c_name=field.name
 204     )
 205
 206 _C2J_CLASS_ARRAY_SWAP_TEMPLATE = Template("""
 207     jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
 208     {
 209         jclass ${field_reference_name}Class = (*env)->FindClass(env, "${jni_name}");
 210         jobjectArray ${field_reference_name} = (*env)->NewObjectArray(env, ${field_length}, ${field_reference_name}Class, 0);
 211         jmethodID ${field_reference_name}Constructor = (*env)->GetMethodID(env, ${field_reference_name}Class, "<init>", "()V");
 212         unsigned int _i;
 213         for (_i = 0; _i < ${field_length}; _i++) {
 214             jobject ${field_reference_name}ArrayElement = (*env)->NewObject(env, ${field_reference_name}Class,  ${field_reference_name}Constructor);
 215             ${net_to_host_function}(env, &(${struct_ref_name}->${c_name}[_i]), ${field_reference_name}ArrayElement);
 216             (*env)->SetObjectArrayElement(env, ${field_reference_name}, _i, ${field_reference_name}ArrayElement);
 217             (*env)->DeleteLocalRef(env, ${field_reference_name}ArrayElement);
 218         }
 219         (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
 220         (*env)->DeleteLocalRef(env, ${field_reference_name});
 221     }
 222 """)
 223
 224
 225 def _generate_c2j_primitive_type_array_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 226     field_type = field.type
 227     return _C2J_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE.substitute(
 228         field_reference_name=field.java_name,
 229         class_ref_name=msg_java_name,
 230         jni_signature=field_type.jni_signature,
 231         jni_type=field_type.jni_type,
 232         base_type=field_type.base_type.jni_accessor,
 233         field_length=_generate_array_length(field, struct_ref_name),
 234         jni_base_type=field_type.base_type.jni_type,
 235         object_ref_name=object_ref_name,
 236         struct_ref_name=struct_ref_name,
 237         net_to_host_function=field_type.net_to_host_function,
 238         c_name=field.name
 239     )
 240
 241 _C2J_PRIMITIVE_TYPE_ARRAY_SWAP_TEMPLATE = Template("""
 242     jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
 243     {
 244         ${jni_type} ${field_reference_name} = (*env)->New${base_type}Array(env, ${field_length});
 245         ${jni_base_type} * ${field_reference_name}ArrayElements = (*env)->Get${base_type}ArrayElements(env, ${field_reference_name}, NULL);
 246         unsigned int _i;
 247         for (_i = 0; _i < ${field_length}; _i++) {
 248             ${field_reference_name}ArrayElements[_i] = ${net_to_host_function}(${struct_ref_name}->${c_name}[_i]);
 249         }
 250
 251         (*env)->Release${base_type}ArrayElements(env,  ${field_reference_name}, ${field_reference_name}ArrayElements, 0);
 252         (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
 253         (*env)->DeleteLocalRef(env, ${field_reference_name});
 254     }
 255 """)
 256
 257
 258 def _generate_c2j_primitive_type_array_no_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 259     field_type = field.type
 260     return _C2J_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE.substitute(
 261         field_reference_name=field.java_name,
 262         class_ref_name=msg_java_name,
 263         jni_signature=field_type.jni_signature,
 264         jni_type=field_type.jni_type,
 265         base_type=field_type.base_type.jni_accessor,
 266         field_length=_generate_array_length(field, struct_ref_name),
 267         jni_base_type=field_type.base_type.jni_type,
 268         object_ref_name=object_ref_name,
 269         struct_ref_name=struct_ref_name,
 270         c_name=field.name
 271     )
 272
 273 _C2J_PRIMITIVE_TYPE_ARRAY_NO_SWAP_TEMPLATE = Template("""
 274     jfieldID ${field_reference_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${field_reference_name}", "${jni_signature}");
 275     ${jni_type} ${field_reference_name} = (*env)->New${base_type}Array(env, ${field_length});
 276     (*env)->Set${base_type}ArrayRegion(env, ${field_reference_name}, 0, ${field_length}, (const ${jni_base_type}*)${struct_ref_name}->${c_name});
 277     (*env)->SetObjectField(env, ${object_ref_name}, ${field_reference_name}FieldId, ${field_reference_name});
 278     (*env)->DeleteLocalRef(env, ${field_reference_name});
 279 """)
 280
 281
 282 def _generate_array_length(field, struct_ref_name):
 283     if field.array_len_field:
 284         len_field = field.array_len_field
 285         if len_field.type.is_swap_needed:
 286             return "%s(%s->%s)" % (len_field.type.host_to_net_function, struct_ref_name, len_field.name)
 287         else:
 288             return "%s->%s" % (struct_ref_name, len_field.name)
 289     return field.array_len
 290
 291
 292 def _generate_c2j_scalar_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 293     field_type = field.type
 294     if field_type.is_swap_needed:
 295         # TODO(VPP-1186): move the logic to JNI generators
 296         if isinstance(field_type, Class):
 297             return _generate_c2j_class_swap(msg_java_name, field, object_ref_name, struct_ref_name)
 298         else:
 299             return _generate_c2j_primitive_type_swap(msg_java_name, field, object_ref_name, struct_ref_name)
 300     else:
 301         return _generate_c2j_primitive_type_no_swap(msg_java_name, field, object_ref_name, struct_ref_name)
 302
 303
 304 def _generate_c2j_class_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 305     field_type = field.type
 306     return _C2J_CLASS_SWAP_TEMPLATE.substitute(
 307         java_name=field.java_name,
 308         class_ref_name=msg_java_name,
 309         jni_signature=field_type.jni_signature,
 310         jni_name=field_type.jni_name,
 311         jni_accessor=field_type.jni_accessor,
 312         object_ref_name=object_ref_name,
 313         struct_ref_name=struct_ref_name,
 314         net_to_host_function=field_type.net_to_host_function,
 315         c_name=field.name)
 316
 317 _C2J_CLASS_SWAP_TEMPLATE = Template("""
 318     jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
 319     jclass ${java_name}Class = (*env)->FindClass(env, "${jni_name}");
 320     jmethodID ${java_name}Constructor = (*env)->GetMethodID(env, ${java_name}Class, "<init>", "()V");
 321     jobject ${java_name} = (*env)->NewObject(env, ${java_name}Class,  ${java_name}Constructor);
 322     ${net_to_host_function}(env, &(${struct_ref_name}->${c_name}), ${java_name});
 323     (*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${java_name});
 324     (*env)->DeleteLocalRef(env, ${java_name});
 325 """)
 326
 327
 328 def _generate_c2j_primitive_type_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 329     field_type = field.type
 330     return _C2J_PRIMITIVE_TYPE_SWAP_TEMPLATE.substitute(
 331         java_name=field.java_name,
 332         class_ref_name=msg_java_name,
 333         jni_signature=field_type.jni_signature,
 334         jni_accessor=field_type.jni_accessor,
 335         object_ref_name=object_ref_name,
 336         net_to_host_function=field_type.net_to_host_function,
 337         struct_ref_name=struct_ref_name,
 338         c_name=field.name
 339     )
 340
 341 _C2J_PRIMITIVE_TYPE_SWAP_TEMPLATE = Template("""
 342     jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
 343     (*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${net_to_host_function}(${struct_ref_name}->${c_name}));
 344 """)
 345
 346
 347 def _generate_c2j_primitive_type_no_swap(msg_java_name, field, object_ref_name, struct_ref_name):
 348     field_type = field.type
 349     return _C2J_PRIMITIVE_TYPE_NO_SWAP_TEMPLATE.substitute(
 350         java_name=field.java_name,
 351         class_ref_name=msg_java_name,
 352         jni_signature=field_type.jni_signature,
 353         jni_accessor=field_type.jni_accessor,
 354         object_ref_name=object_ref_name,
 355         struct_ref_name=struct_ref_name,
 356         c_name=field.name
 357     )
 358
 359 _C2J_PRIMITIVE_TYPE_NO_SWAP_TEMPLATE = Template("""
 360     jfieldID ${java_name}FieldId = (*env)->GetFieldID(env, ${class_ref_name}Class, "${java_name}", "${jni_signature}");
 361     (*env)->Set${jni_accessor}Field(env, ${object_ref_name}, ${java_name}FieldId, ${struct_ref_name}->${c_name});
 362 """)