vpp-api/java/jvpp/gen/jvpp_gen.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2016 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 # l
  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
  17 import argparse
  18 import importlib
  19 import sys
  20 import os
  21 import json
  22
  23 from jvppgen import types_gen
  24 from jvppgen import callback_gen
  25 from jvppgen import notification_gen
  26 from jvppgen import dto_gen
  27 from jvppgen import jvpp_callback_facade_gen
  28 from jvppgen import jvpp_future_facade_gen
  29 from jvppgen import jvpp_impl_gen
  30 from jvppgen import jvpp_c_gen
  31 from jvppgen import util
  32
  33 blacklist = [ "memclnt.api", "flowperpkt.api" ]
  34
  35 # Invocation:
  36 # ~/Projects/vpp/vpp-api/jvpp/gen$ mkdir -p java/io/fd/vpp/jvpp && cd java/io/fd/vpp/jvpp
  37 # ~/Projects/vpp/vpp-api/jvpp/gen/java/io/fd/vpp/jvpp$ ../../../../jvpp_gen.py -idefs_api_vpp_papi.py
  38 #
  39 # Compilation:
  40 # ~/Projects/vpp/vpp-api/jvpp/gen/java/io/fd/vpp/jvpp$ javac *.java dto/*.java callback/*.java
  41 #
  42 # where
  43 # defs_api_vpp_papi.py - vpe.api in python format (generated by vppapigen)
  44
  45 parser = argparse.ArgumentParser(description='VPP Java API generator')
  46 parser.add_argument('-i', action="store", dest="inputfiles", nargs='+')
  47 parser.add_argument('--plugin_name', action="store", dest="plugin_name")
  48 args = parser.parse_args()
  49
  50 sys.path.append(".")
  51
  52 print "Generating Java API for %s" % args.inputfiles
  53 print "inputfiles %s" % args.inputfiles
  54 plugin_name = args.plugin_name
  55 print "plugin_name %s" % plugin_name
  56
  57 cfg = {}
  58
  59 for inputfile in args.inputfiles:
  60     if any(substring in inputfile for substring in blacklist):
  61         print "WARNING: Imput file %s blacklisted" % inputfile
  62         continue
  63     _cfg = json.load(open(inputfile, 'r'))
  64     if 'types' in cfg:
  65         cfg['types'].extend(_cfg['types'])
  66     else:
  67         cfg['types'] = _cfg['types']
  68     if 'messages' in cfg:
  69         cfg['messages'].extend(_cfg['messages'])
  70     else:
  71         cfg['messages'] = _cfg['messages']
  72
  73
  74 def is_request_field(field_name):
  75     return field_name not in {'_vl_msg_id', 'client_index', 'context'}
  76
  77
  78 def is_response_field(field_name):
  79     return field_name not in {'_vl_msg_id'}
  80
  81
  82 def get_args(t, filter):
  83     arg_list = []
  84     for i in t:
  85         if is_crc(i):
  86             continue
  87         if not filter(i[1]):
  88             continue
  89         arg_list.append(i[1])
  90     return arg_list
  91
  92
  93 def get_types(t, filter):
  94     types_list = []
  95     lengths_list = []
  96     crc = None
  97     for i in t:
  98         if is_crc(i):
  99             crc = ('crc', i['crc'][2:])
 100             continue
 101         if not filter(i[1]):
 102             continue
 103         if len(i) is 3:  # array type
 104             types_list.append(i[0] + '[]')
 105             lengths_list.append((i[2], False))
 106         elif len(i) is 4:  # variable length array type
 107             types_list.append(i[0] + '[]')
 108             lengths_list.append((i[3], True))
 109         else:  # primitive type
 110             types_list.append(i[0])
 111             lengths_list.append((0, False))
 112     return types_list, lengths_list, crc
 113
 114
 115 def is_crc(arg):
 116     """ Check whether the argument inside message definition is just crc """
 117     return 'crc' in arg
 118
 119
 120 def get_definitions(defs):
 121     # Pass 1
 122     func_list = []
 123     func_name = {}
 124     for a in defs:
 125         java_name = util.underscore_to_camelcase(a[0])
 126
 127         # For replies include all the arguments except message_id
 128         if util.is_reply(java_name):
 129             types, lengths, crc = get_types(a[1:], is_response_field)
 130             func_name[a[0]] = dict(
 131                 [('name', a[0]), ('java_name', java_name),
 132                  ('args', get_args(a[1:], is_response_field)), ('full_args', get_args(a[1:], lambda x: True)),
 133                  ('types', types), ('lengths', lengths), crc])
 134         # For requests skip message_id, client_id and context
 135         else:
 136             types, lengths, crc = get_types(a[1:], is_request_field)
 137             func_name[a[0]] = dict(
 138                 [('name', a[0]), ('java_name', java_name),
 139                  ('args', get_args(a[1:], is_request_field)), ('full_args', get_args(a[1:], lambda x: True)),
 140                  ('types', types), ('lengths', lengths), crc])
 141
 142         # Indexed by name
 143         func_list.append(func_name[a[0]])
 144     return func_list, func_name
 145
 146
 147 base_package = 'io.fd.vpp.jvpp'
 148 plugin_package = base_package + '.' + plugin_name
 149 types_package = 'types'
 150 dto_package = 'dto'
 151 callback_package = 'callback'
 152 notification_package = 'notification'
 153 future_package = 'future'
 154 # TODO find better package name
 155 callback_facade_package = 'callfacade'
 156
 157 types_list, types_name = get_definitions(cfg['types'])
 158
 159 types_gen.generate_types(types_list, plugin_package, types_package, args.inputfiles)
 160
 161 func_list, func_name = get_definitions(cfg['messages'])
 162
 163 dto_gen.generate_dtos(func_list, base_package, plugin_package, plugin_name.title(), dto_package, args.inputfiles)
 164 jvpp_impl_gen.generate_jvpp(func_list, base_package, plugin_package, plugin_name, dto_package, args.inputfiles)
 165 callback_gen.generate_callbacks(func_list, base_package, plugin_package, plugin_name.title(), callback_package, dto_package, args.inputfiles)
 166 notification_gen.generate_notification_registry(func_list, base_package, plugin_package, plugin_name.title(), notification_package, callback_package, dto_package, args.inputfiles)
 167 jvpp_c_gen.generate_jvpp(func_list, plugin_name, args.inputfiles)
 168 jvpp_future_facade_gen.generate_jvpp(func_list, base_package, plugin_package, plugin_name.title(), dto_package, callback_package, notification_package, future_package, args.inputfiles)
 169 jvpp_callback_facade_gen.generate_jvpp(func_list, base_package, plugin_package, plugin_name.title(), dto_package, callback_package, notification_package, callback_facade_package, args.inputfiles)
 170
 171 print "Java API for %s generated successfully" % args.inputfiles