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