src/vpp-api/java/jvpp/gen/jvppgen/jvpp_model.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 import json
  17 import pprint
  18 from collections import OrderedDict
  19
  20 BASE_PACKAGE = "io.fd.vpp.jvpp"
  21
  22
  23 class ParseException(Exception):
  24     pass
  25
  26
  27 class Type(object):
  28     def __init__(self, name, java_name, java_name_fqn, jni_signature, jni_type, jni_accessor,
  29                  host_to_net_function, net_to_host_function):
  30         """
  31         Initializes Type class.
  32
  33         :param name: name of type as defined in .api file, e.g. u8, u32[] or mac_entry
  34         :param java_name: corresponding java name, e.g. byte, int[] or MacEntry
  35         :param java_name_fqn: fully qualified java name, e.g. io.fd.vpp.jvpp.core.types.MacEntry
  36         :param jni_signature: JNI Type signature, e.g. B, [I or Lio.fd.vpp.jvpp.core.types.MacEntry;
  37                               See https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/types.html#type_signatures
  38         :param jni_type: JNI reference type, e.g. jbyte jintArray, jobject
  39                          See https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/types.html#reference_types
  40         :param jni_accessor: Java type do by used in Get<type>Field, Set<type>Field and other functions.
  41                              See https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/functions.html#accessing_fields_of_objects
  42         :param host_to_net_function: name of function host to net byte order swap function
  43         :param net_to_host_function: name of function net to host byte order swap function
  44         """
  45         self.name = name
  46         self.java_name = java_name
  47
  48         # Java generation specific properties, TODO(VPP-1186): move to Java specific subclass
  49         self.java_name_fqn = java_name_fqn
  50
  51         # JNI generation specific properties, TODO(VPP-1186): move to JNI specific subclass
  52         self.jni_signature = jni_signature
  53
  54         # Native type, see:
  55         # https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/types.html#primitive_types
  56         # and
  57         # https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/types.html#reference_types
  58         self.jni_type = jni_type
  59
  60         # Java type do by used in Get<type>Field, Set<type>Field and other functions, see:
  61         # https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/functions.html#accessing_fields_of_objects
  62         self.jni_accessor = jni_accessor
  63
  64         self.host_to_net_function = host_to_net_function
  65         self.net_to_host_function = net_to_host_function
  66         self.is_swap_needed = host_to_net_function and net_to_host_function
  67
  68
  69 class SimpleType(Type):
  70     def __init__(self, name, java_name, jni_signature, jni_type, jni_accessor,
  71                  host_to_net_function=None, net_to_host_function=None):
  72         super(SimpleType, self).__init__(
  73             name=name,
  74             java_name=java_name,
  75             java_name_fqn=java_name,
  76             jni_signature=jni_signature,
  77             jni_type=jni_type,
  78             jni_accessor=jni_accessor,
  79             host_to_net_function=host_to_net_function,
  80             net_to_host_function=net_to_host_function
  81         )
  82         self.vpp_name = name
  83
  84     def get_host_to_net_function(self, host_ref_name, net_ref_name):
  85         return "%s = %s(%s)" % (net_ref_name, self.host_to_net_function, host_ref_name)
  86
  87     def __str__(self):
  88         return "SimpleType{name:%s, java_name:%s}" % (self.name, self.java_name)
  89
  90
  91 # TODO(VPP-1187): add array host to net functions to reduce number of members and simplify JNI generation
  92 class Array(Type):
  93     def __init__(self, base_type):
  94         super(Array, self).__init__(
  95             name=base_type.name + _ARRAY_SUFFIX,
  96             java_name=base_type.java_name + _ARRAY_SUFFIX,
  97             java_name_fqn=base_type.java_name_fqn + _ARRAY_SUFFIX,
  98             jni_signature="[%s" % base_type.jni_signature,
  99             jni_type="%sArray" % base_type.jni_type,
 100             jni_accessor="Object",
 101             host_to_net_function=base_type.host_to_net_function,
 102             net_to_host_function=base_type.net_to_host_function
 103         )
 104         self.base_type = base_type
 105
 106     def get_host_to_net_function(self, host_ref_name, net_ref_name):
 107         return self.base_type.get_host_to_net_function(host_ref_name, net_ref_name)
 108
 109     def __str__(self):
 110         return "Array{name:%s, java_name:%s}" % (self.name, self.java_name)
 111
 112
 113 class Class(Type):
 114     def __init__(self, name, crc, fields, definition, plugin_name):
 115         _java_name = _underscore_to_camelcase_upper(name)
 116
 117         super(Class, self).__init__(
 118             name=name,
 119             java_name=_java_name,
 120             java_name_fqn="io.fd.vpp.jvpp.%s.types.%s" % (plugin_name, _java_name),
 121             jni_signature="Lio/fd/vpp/jvpp/%s/types/%s;" % (plugin_name, _java_name),
 122             jni_type="jobject",
 123             jni_accessor="Object",
 124             host_to_net_function="_host_to_net_%s" % name,
 125             net_to_host_function="_net_to_host_%s" % name
 126         )
 127
 128         self.crc = crc
 129         self.fields = fields
 130         self.doc = _message_to_javadoc(definition)
 131         self.java_name_lower = _underscore_to_camelcase_lower(name)
 132         self.vpp_name = "%s%s%s" % (_VPP_TYPE_PREFIX, name, _VPP_TYPE_SUFFIX)
 133         # Fully qualified class name used by FindClass function, see:
 134         # https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/functions.html#FindClass
 135         self.jni_name = "io/fd/vpp/jvpp/%s/types/%s" % (plugin_name, _java_name)
 136
 137     def get_host_to_net_function(self, host_ref_name, net_ref_name):
 138         return "_host_to_net_%s(env, %s, &(%s))" % (self.name, host_ref_name, net_ref_name)
 139
 140
 141 class Field(object):
 142     def __init__(self, name, field_type, array_len=None, array_len_field=None):
 143         self.name = name
 144         self.java_name = _underscore_to_camelcase_lower(name)
 145         self.type = field_type
 146         self.array_len = array_len
 147         self.array_len_field = array_len_field
 148
 149     def __str__(self):
 150         return "Field{name:%s, java_name:%s, type:%s}" % (self.name, self.java_name, self.type)
 151
 152
 153 class Message(object):
 154     def __init__(self, name, crc, fields, definition):
 155         self.name = name
 156         self.java_name_upper = _underscore_to_camelcase_upper(name)
 157         self.java_name_lower = _underscore_to_camelcase_lower(name)
 158         self.crc = crc[2:]
 159         self.fields = fields
 160         self.has_fields = fields != []
 161         self.doc = _message_to_javadoc(definition)
 162
 163     def __str__(self):
 164         return "Message{name:%s, java_name:%s, crc:%s, fields:%s}" % (
 165             self.name, self.java_name_upper, self.crc, self.fields)
 166
 167
 168 class Event(Message):
 169     def __init__(self, name, crc, fields, definition):
 170         super(Event, self).__init__(name, crc, fields, definition)
 171
 172
 173 class Request(Message):
 174     def __init__(self, name, reply, crc, fields, definition):
 175         super(Request, self).__init__(name, crc, fields, definition)
 176         self.reply = reply
 177         self.reply_java = _underscore_to_camelcase_upper(reply)
 178
 179     def __str__(self):
 180         return "Request{name:%s, reply:%s, crc:%s, fields:%s}" % (self.name, self.reply, self.crc, self.fields)
 181
 182
 183 class Reply(Message):
 184     def __init__(self, name, request, crc, fields, definition):
 185         super(Reply, self).__init__(name, crc, fields, definition)
 186         self.request = request
 187         self.request_java = _underscore_to_camelcase_upper(request)
 188
 189     def __str__(self):
 190         return "Reply{name:%s, request:%s, crc:%s, fields:%s}" % (self.name, self.request, self.crc, self.fields)
 191
 192
 193 class Dump(Message):
 194     def __init__(self, name, details, crc, fields, definition):
 195         super(Dump, self).__init__(name, crc, fields, definition)
 196         self.details = details
 197         self.reply_java = _underscore_to_camelcase_upper(details)
 198
 199     def __str__(self):
 200         return "Dump{name:%s, details:%s, crc:%s, fields:%s}" % (self.name, self.details, self.crc, self.fields)
 201
 202
 203 class Details(Message):
 204     def __init__(self, name, dump, crc, fields, definition):
 205         super(Details, self).__init__(name, crc, fields, definition)
 206         self.dump = dump
 207         self.request_java = _underscore_to_camelcase_upper(dump)
 208
 209     def __str__(self):
 210         return "Details{name:%s, dump:%s, crc:%s, fields:%s}" % (self.name, self.dump, self.crc, self.fields)
 211
 212
 213 def is_retval(field):
 214     return field.name == u'retval'
 215
 216
 217 def is_array(field):
 218     return field.array_len is not None
 219
 220
 221 def is_request(msg):
 222     return hasattr(msg, 'reply')
 223
 224
 225 def is_reply(msg):
 226     return hasattr(msg, 'request')
 227
 228
 229 def is_dump(msg):
 230     return hasattr(msg, 'details')
 231
 232
 233 def is_details(msg):
 234     return hasattr(msg, 'dump')
 235
 236
 237 def is_event(msg):
 238     return isinstance(msg, Event)
 239
 240
 241 def is_control_ping(msg):
 242     return msg.name == u'control_ping'
 243
 244
 245 def is_control_ping_reply(msg):
 246     return msg.name == u'control_ping_reply'
 247
 248
 249 class JVppModel(object):
 250     def __init__(self, logger, json_api_files, plugin_name):
 251         self.logger = logger
 252         # TODO(VPP-1188): provide json_file_by_definition map to improve javadoc
 253         self.json_api_files = json_api_files
 254         self.plugin_package = BASE_PACKAGE + "." + plugin_name
 255         self.plugin_name = plugin_name
 256         self.plugin_java_name = _underscore_to_camelcase_upper(plugin_name)
 257         self._load_json_files(json_api_files)
 258         self._parse_types()
 259         self._parse_services()
 260         self._parse_messages()
 261         self._validate_messages()
 262
 263     def _load_json_files(self, json_api_files):
 264         self._enums = []
 265         self._types = []
 266         self._messages = []
 267         self._services = {}
 268         for file_name in json_api_files:
 269             with open(file_name) as f:
 270                 j = json.load(f)
 271                 self._enums.extend(j['enums'])
 272                 self._types.extend(j['types'])
 273                 self._messages.extend(j['messages'])
 274                 self._services.update(j['services'])
 275
 276     def _parse_types(self):
 277         # Mapping according to:
 278         # http://docs.oracle.com/javase/7/do+'[]'cs/technotes/guides/jni/spec/types.html
 279         # and
 280         # https://docs.oracle.com/javase/8/docs/technotes/guides/jni/spec/functions.html#Get_type_Field_routines
 281         #
 282         # Unsigned types are converted to signed java types that have the same size.
 283         # It is the API user responsibility to interpret them correctly.
 284
 285         self._types_by_name = OrderedDict({
 286             'u8': SimpleType('u8', 'byte', 'B', 'jbyte', 'Byte'),
 287             'i8': SimpleType('i8', 'byte', 'B', 'jbyte', 'Byte'),
 288             'u16': SimpleType('u16', 'short', 'S', 'jshort', 'Short',
 289                               host_to_net_function='clib_host_to_net_u16',
 290                               net_to_host_function='clib_net_to_host_u16'),
 291             'i16': SimpleType('i16', 'short', 'S', 'jshort', 'Short',
 292                               host_to_net_function='clib_host_to_net_i16',
 293                               net_to_host_function='clib_net_to_host_i16'),
 294             'u32': SimpleType('u32', 'int', 'I', 'jint', 'Int',
 295                               host_to_net_function='clib_host_to_net_u32',
 296                               net_to_host_function='clib_net_to_host_u32'),
 297             'i32': SimpleType('i32', 'int', 'I', 'jint', 'Int',
 298                               host_to_net_function='clib_host_to_net_i32',
 299                               net_to_host_function='clib_net_to_host_i32'),
 300             'u64': SimpleType('u64', 'long', 'J', 'jlong', 'Long',
 301                               host_to_net_function='clib_host_to_net_u64',
 302                               net_to_host_function='clib_net_to_host_u64'),
 303             'i64': SimpleType('i64', 'long', 'J', 'jlong', 'Long',
 304                               host_to_net_function='clib_host_to_net_i64',
 305                               net_to_host_function='clib_net_to_host_i64'),
 306             'f64': SimpleType('f64', 'double', 'D', 'jdouble', 'Double')
 307         })
 308
 309         for n, t in self._types_by_name.items():
 310             self._types_by_name[n + _ARRAY_SUFFIX] = Array(t)
 311
 312         for json_type in self._types:
 313             try:
 314                 name = json_type[0]
 315                 definition = json_type[1:]
 316                 _type = self._parse_type(name, definition)
 317                 self._types_by_name[name] = _type
 318                 self._types_by_name[name + _ARRAY_SUFFIX] = Array(_type)
 319             except ParseException as e:
 320                 self.logger.warning("Failed to parse %s type: %s. Skipping type definition.", name, e)
 321
 322         self.types = self._types_by_name.values()
 323
 324     def _parse_type(self, name, definition):
 325         self.logger.debug("Parsing type %s: %s", name, definition)
 326         crc, fields = self._parse_fields(definition)
 327         return Class(name, crc, fields, definition, self.plugin_name)
 328
 329     def _parse_services(self):
 330         self._dumps_by_details = {}
 331         self._requests_by_reply = {}
 332         for name, service in self._services.iteritems():
 333             if _is_stream(service):
 334                 self._dumps_by_details[service['reply']] = name
 335             else:
 336                 self._requests_by_reply[service['reply']] = name
 337
 338     def _parse_messages(self):
 339         # Preserve ordering from JSON file to make debugging easier.
 340         self._messages_by_name = OrderedDict()
 341         for msg in self._messages:
 342             try:
 343                 name = msg[0]
 344                 definition = msg[1:]
 345                 self._messages_by_name[name] = self._parse_message(name, definition)
 346             except ParseException as e:
 347                 self.logger.warning("Failed to parse message %s: %s. Skipping message.", name, e)
 348
 349     def _parse_message(self, name, definition):
 350         self.logger.debug("Parsing message %s: %s", name, definition)
 351         crc, fields = self._parse_fields(definition)
 352         if name in self._services:
 353             service = self._services[name]
 354             reply = service['reply']
 355             if _is_stream(service):
 356                 return Dump(name, reply, crc, filter(_is_request_field, fields), definition)
 357             if reply:
 358                 return Request(name, reply, crc, filter(_is_request_field, fields), definition)
 359             else:
 360                 return Event(name, crc, filter(_is_request_field, fields), definition)
 361         elif name in self._requests_by_reply:
 362             return Reply(name, self._requests_by_reply[name], crc, filter(_is_reply_field, fields), definition)
 363         elif name in self._dumps_by_details:
 364             return Details(name, self._dumps_by_details[name], crc, filter(_is_reply_field, fields), definition)
 365         else:
 366             # TODO: some messages like combined_counters are not visible in the services.
 367             # Throw exception instead (requires fixing vppagigen).
 368             return Event(name, crc, filter(_is_request_field, fields), definition)
 369
 370     def _parse_fields(self, definition):
 371         crc = None
 372         fields = []
 373         for item in definition:
 374             if type(item) == dict and 'crc' in item:
 375                 crc = item['crc']
 376             else:
 377                 fields.append(self._parse_field(item, fields))
 378         if not crc:
 379             raise ParseException("CRC was not defined for %s" % definition)
 380         return crc, fields
 381
 382     def _parse_field(self, field, fields):
 383         type_name = _extract_type_name(field[0])
 384         if type_name in self._types_by_name:
 385             if len(field) > 2:
 386                 # Array field
 387                 array_len_field = None
 388                 if len(field) == 4:
 389                     for f in fields:
 390                         if f.name == field[3]:
 391                             array_len_field = f
 392                     if not array_len_field:
 393                         raise ParseException("Could not find field %s declared as length of array %s",
 394                                              field[3], field[1])
 395                 return Field(field[1], self._types_by_name[type_name + _ARRAY_SUFFIX], field[2], array_len_field)
 396             else:
 397                 return Field(field[1], self._types_by_name[type_name])
 398         else:
 399             raise ParseException("Unknown field type %s" % field)
 400
 401     def _validate_messages(self):
 402         """
 403         In case if message A is known to be reply for message B, and message B was not correctly parsed,
 404         remove message A from the set of all messages.
 405         """
 406         to_be_removed = []
 407         messages = self._messages_by_name
 408         for name, msg in messages.iteritems():
 409             if (is_request(msg) and msg.reply not in messages) \
 410                     or (is_reply(msg) and msg.request not in messages) \
 411                     or (is_dump(msg) and msg.details not in messages) \
 412                     or (is_details(msg) and msg.dump not in messages):
 413                 to_be_removed.append(name)
 414
 415         for name in to_be_removed:
 416             del messages[name]
 417
 418         self.messages = self._messages_by_name.values()
 419
 420 _ARRAY_SUFFIX = '[]'
 421
 422
 423 def _underscore_to_camelcase_upper(name):
 424     return name.title().replace("_", "")
 425
 426
 427 def _underscore_to_camelcase_lower(name):
 428     name = name.title().replace("_", "")
 429     return name[0].lower() + name[1:]
 430
 431
 432 def _message_to_javadoc(message_definition):
 433     """ Converts JSON message definition to javadoc """
 434     formatted_message = pprint.pformat(message_definition, indent=4, width=120, depth=None)
 435     return " * " + formatted_message.replace("\n", "\n * ")
 436
 437
 438 def _is_stream(service):
 439     """
 440     Checks if service represents stream, e.g.:
 441     "ip_address_dump": {
 442         "reply": "ip_address_details",
 443         "stream": true
 444     }
 445     :param service: JSON definition of service
 446     :return: value assigned to "stream" or None
 447     """
 448     return "stream" in service
 449
 450
 451 def _extract_type_name(name):
 452     if name.startswith(_VPP_TYPE_PREFIX) and name.endswith(_VPP_TYPE_SUFFIX):
 453         return name[len(_VPP_TYPE_PREFIX): - len(_VPP_TYPE_SUFFIX)]
 454     return name
 455
 456 _VPP_TYPE_PREFIX = "vl_api_"
 457
 458 _VPP_TYPE_SUFFIX = "_t"
 459
 460
 461 def _is_request_field(field):
 462     # Skip fields that are hidden to the jvpp user (handled by JNI layer)
 463     return field.name not in {'_vl_msg_id', 'client_index', 'context'}
 464
 465
 466 def _is_reply_field(field):
 467     # Skip fields that are hidden to the jvpp user:
 468     # _vl_msg_id is handled at JNI layer,
 469     # Unlike in the request case, context is visible to allow matching replies with requests at Java layer.
 470     return field.name not in {'_vl_msg_id'}