vpp-api/java/jvpp/gen/jvpp_future_facade_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 import os
  17 from string import Template
  18
  19 import dto_gen
  20 import util
  21
  22 jvpp_facade_callback_template = Template("""
  23 package $base_package.$future_package;
  24
  25 /**
  26  * <p>Async facade callback setting values to future objects
  27  * <br>It was generated by jvpp_future_facade_gen.py based on $inputfile
  28  * <br>(python representation of vpe.api generated by vppapigen).
  29  */
  30 public final class FutureJVppFacadeCallback implements $base_package.$callback_package.JVppGlobalCallback {
  31
  32     private final java.util.Map<java.lang.Integer, java.util.concurrent.CompletableFuture<? extends $base_package.$dto_package.JVppReply<?>>> requests;
  33
  34     public FutureJVppFacadeCallback(final java.util.Map<java.lang.Integer, java.util.concurrent.CompletableFuture<? extends $base_package.$dto_package.JVppReply<?>>> requestMap) {
  35         this.requests = requestMap;
  36     }
  37
  38 $methods
  39 }
  40 """)
  41
  42 jvpp_facade_callback_method_template = Template("""
  43     @Override
  44     @SuppressWarnings("unchecked")
  45     public void on$callback_dto($base_package.$dto_package.$callback_dto reply) {
  46         final java.util.concurrent.CompletableFuture<$base_package.$dto_package.JVppReply<?>> completableFuture;
  47
  48         synchronized(requests) {
  49             completableFuture = (java.util.concurrent.CompletableFuture<$base_package.$dto_package.JVppReply<?>>) requests.get(reply.context);
  50         }
  51
  52         if(completableFuture != null) {
  53             if(reply.retval < 0) {
  54                 completableFuture.completeExceptionally(new Exception("Invocation of " + $base_package.$dto_package.$callback_dto.class
  55                     + " failed with value " + reply.retval));
  56             } else {
  57                 completableFuture.complete(reply);
  58             }
  59
  60             synchronized(requests) {
  61                 requests.remove(reply.context);
  62             }
  63         }
  64     }
  65 """)
  66
  67 # TODO reuse common parts with generic method callback
  68 jvpp_facade_control_ping_method_template = Template("""
  69     @Override
  70     @SuppressWarnings("unchecked")
  71     public void on$callback_dto($base_package.$dto_package.$callback_dto reply) {
  72         final java.util.concurrent.CompletableFuture<$base_package.$dto_package.JVppReply<?>> completableFuture;
  73
  74         synchronized(requests) {
  75             completableFuture = (java.util.concurrent.CompletableFuture<$base_package.$dto_package.JVppReply<?>>) requests.get(reply.context);
  76         }
  77
  78         if(completableFuture != null) {
  79             // Finish dump call
  80             if (completableFuture instanceof $base_package.$future_package.FutureJVppFacade.CompletableDumpFuture) {
  81                 completableFuture.complete((($base_package.$future_package.FutureJVppFacade.CompletableDumpFuture) completableFuture).getReplyDump());
  82                 // Remove future mapped to dump call context id
  83                 synchronized(requests) {
  84                     requests.remove((($base_package.$future_package.FutureJVppFacade.CompletableDumpFuture) completableFuture).getContextId());
  85                 }
  86             } else {
  87                 if(reply.retval < 0) {
  88                     completableFuture.completeExceptionally(new Exception("Invocation of " + $base_package.$dto_package.$callback_dto.class
  89                         + " failed with value " + reply.retval));
  90                 } else {
  91                     completableFuture.complete(reply);
  92                 }
  93             }
  94
  95             synchronized(requests) {
  96                 requests.remove(reply.context);
  97             }
  98         }
  99     }
 100 """)
 101
 102 jvpp_facade_details_callback_method_template = Template("""
 103     @Override
 104     @SuppressWarnings("unchecked")
 105     public void on$callback_dto($base_package.$dto_package.$callback_dto reply) {
 106         final FutureJVppFacade.CompletableDumpFuture<$base_package.$dto_package.$callback_dto_reply_dump> completableFuture;
 107
 108         synchronized(requests) {
 109             completableFuture = ($base_package.$future_package.FutureJVppFacade.CompletableDumpFuture<$base_package.$dto_package.$callback_dto_reply_dump>) requests.get(reply.context);
 110         }
 111
 112         if(completableFuture != null) {
 113             $base_package.$dto_package.$callback_dto_reply_dump replyDump = completableFuture.getReplyDump();
 114             if(replyDump == null) {
 115                 replyDump = new $base_package.$dto_package.$callback_dto_reply_dump();
 116                 completableFuture.setReplyDump(replyDump);
 117             }
 118
 119             replyDump.$callback_dto_field.add(reply);
 120         }
 121     }
 122 """)
 123
 124
 125 def generate_jvpp(func_list, base_package, dto_package, callback_package, future_facade_package, inputfile):
 126     """ Generates JVpp interface and JNI implementation """
 127     print "Generating JVpp future facade"
 128
 129     if not os.path.exists(future_facade_package):
 130         raise Exception("%s folder is missing" % future_facade_package)
 131
 132     methods = []
 133     methods_impl = []
 134     callbacks = []
 135     for func in func_list:
 136
 137         if util.is_notification(func['name']) or util.is_ignored(func['name']):
 138             # TODO handle notifications
 139             continue
 140
 141         camel_case_name_with_suffix = util.underscore_to_camelcase_upper(func['name'])
 142         if not util.is_reply(camel_case_name_with_suffix):
 143             continue
 144
 145         camel_case_method_name = util.underscore_to_camelcase(func['name'])
 146         camel_case_request_method_name = util.remove_reply_suffix(util.underscore_to_camelcase(func['name']))
 147         if util.is_details(camel_case_name_with_suffix):
 148             camel_case_reply_name = get_standard_dump_reply_name(util.underscore_to_camelcase_upper(func['name']),
 149                                                                    func['name'])
 150             callbacks.append(jvpp_facade_details_callback_method_template.substitute(base_package=base_package,
 151                                                                                      dto_package=dto_package,
 152                                                                                      callback_dto=camel_case_name_with_suffix,
 153                                                                                      callback_dto_field=camel_case_method_name,
 154                                                                                      callback_dto_reply_dump=camel_case_reply_name + dto_gen.dump_dto_suffix,
 155                                                                                      future_package=future_facade_package))
 156
 157             methods.append(future_jvpp_method_template.substitute(base_package=base_package,
 158                                                                   dto_package=dto_package,
 159                                                                   method_name=camel_case_request_method_name +
 160                                                                               util.underscore_to_camelcase_upper(util.dump_suffix),
 161                                                                   reply_name=camel_case_reply_name + dto_gen.dump_dto_suffix,
 162                                                                   request_name=util.remove_reply_suffix(camel_case_reply_name) +
 163                                                                                util.underscore_to_camelcase_upper(util.dump_suffix)))
 164             methods_impl.append(future_jvpp_method_impl_template.substitute(base_package=base_package,
 165                                                                             dto_package=dto_package,
 166                                                                             method_name=camel_case_request_method_name +
 167                                                                                         util.underscore_to_camelcase_upper(util.dump_suffix),
 168                                                                             reply_name=camel_case_reply_name + dto_gen.dump_dto_suffix,
 169                                                                             request_name=util.remove_reply_suffix(camel_case_reply_name) +
 170                                                                                          util.underscore_to_camelcase_upper(util.dump_suffix)))
 171         else:
 172             request_name = util.underscore_to_camelcase_upper(util.unconventional_naming_rep_req[func['name']]) \
 173                 if func['name'] in util.unconventional_naming_rep_req else util.remove_reply_suffix(camel_case_name_with_suffix)
 174
 175             methods.append(future_jvpp_method_template.substitute(base_package=base_package,
 176                                                                   dto_package=dto_package,
 177                                                                   method_name=camel_case_request_method_name,
 178                                                                   reply_name=camel_case_name_with_suffix,
 179                                                                   request_name=request_name))
 180             methods_impl.append(future_jvpp_method_impl_template.substitute(base_package=base_package,
 181                                                                             dto_package=dto_package,
 182                                                                             method_name=camel_case_request_method_name,
 183                                                                             reply_name=camel_case_name_with_suffix,
 184                                                                             request_name=request_name))
 185
 186             # Callback handler is a bit special and a different template has to be used
 187             if util.is_control_ping(camel_case_name_with_suffix):
 188                 callbacks.append(jvpp_facade_control_ping_method_template.substitute(base_package=base_package,
 189                                                                                      dto_package=dto_package,
 190                                                                                      callback_dto=camel_case_name_with_suffix,
 191                                                                                      future_package=future_facade_package))
 192             else:
 193                 callbacks.append(jvpp_facade_callback_method_template.substitute(base_package=base_package,
 194                                                                                  dto_package=dto_package,
 195                                                                                  callback_dto=camel_case_name_with_suffix))
 196
 197     jvpp_file = open(os.path.join(future_facade_package, "FutureJVppFacadeCallback.java"), 'w')
 198     jvpp_file.write(jvpp_facade_callback_template.substitute(inputfile=inputfile,
 199                                                              base_package=base_package,
 200                                                              dto_package=dto_package,
 201                                                              callback_package=callback_package,
 202                                                              methods="".join(callbacks),
 203                                                              future_package=future_facade_package))
 204     jvpp_file.flush()
 205     jvpp_file.close()
 206
 207     jvpp_file = open(os.path.join(future_facade_package, "FutureJVpp.java"), 'w')
 208     jvpp_file.write(future_jvpp_template.substitute(inputfile=inputfile,
 209                                                     base_package=base_package,
 210                                                     methods="".join(methods),
 211                                                     future_package=future_facade_package))
 212     jvpp_file.flush()
 213     jvpp_file.close()
 214
 215     jvpp_file = open(os.path.join(future_facade_package, "FutureJVppFacade.java"), 'w')
 216     jvpp_file.write(future_jvpp_facade_template.substitute(inputfile=inputfile,
 217                                                            base_package=base_package,
 218                                                            dto_package=dto_package,
 219                                                            methods="".join(methods_impl),
 220                                                            future_package=future_facade_package))
 221     jvpp_file.flush()
 222     jvpp_file.close()
 223
 224
 225 future_jvpp_template = Template('''
 226 package $base_package.$future_package;
 227
 228 /**
 229  * <p>Async facade extension adding specific methods for each request invocation
 230  * <br>It was generated by jvpp_future_facade_gen.py based on $inputfile
 231  * <br>(python representation of vpe.api generated by vppapigen).
 232  */
 233 public interface FutureJVpp extends FutureJVppInvoker {
 234 $methods
 235 }
 236 ''')
 237
 238 future_jvpp_method_template = Template('''
 239     java.util.concurrent.CompletionStage<$base_package.$dto_package.$reply_name> $method_name($base_package.$dto_package.$request_name request);
 240 ''')
 241
 242
 243 future_jvpp_facade_template = Template('''
 244 package $base_package.$future_package;
 245
 246 /**
 247  * <p>Implementation of FutureJVpp based on FutureJVppInvokerFacade
 248  * <br>It was generated by jvpp_future_facade_gen.py based on $inputfile
 249  * <br>(python representation of vpe.api generated by vppapigen).
 250  */
 251 public class FutureJVppFacade extends FutureJVppInvokerFacade implements FutureJVpp {
 252
 253     /**
 254      * <p>Create FutureJVppFacade object for provided JVpp instance.
 255      * Constructor internally creates FutureJVppFacadeCallback class for processing callbacks
 256      * and then connects to provided JVpp instance
 257      *
 258      * @param jvpp provided $base_package.JVpp instance
 259      *
 260      * @throws java.io.IOException in case instance cannot connect to JVPP
 261      */
 262     public FutureJVppFacade(final $base_package.JVpp jvpp) throws java.io.IOException {
 263         super(jvpp, new java.util.HashMap<>());
 264         jvpp.connect(new FutureJVppFacadeCallback(getRequests()));
 265     }
 266 $methods
 267 }
 268 ''')
 269
 270 future_jvpp_method_impl_template = Template('''
 271     @Override
 272     public java.util.concurrent.CompletionStage<$base_package.$dto_package.$reply_name> $method_name($base_package.$dto_package.$request_name request) {
 273         return send(request);
 274     }
 275 ''')
 276
 277 # Returns request name or special one from unconventional_naming_rep_req map
 278 def get_standard_dump_reply_name(camel_case_dto_name, func_name):
 279     # FIXME this is a hotfix for sub-details callbacks
 280     # FIXME also for L2FibTableEntry
 281     # It's all because unclear mapping between
 282     #  request -> reply,
 283     #  dump -> reply, details,
 284     #  notification_start -> reply, notifications
 285
 286     # vpe.api needs to be "standardized" so we can parse the information and create maps before generating java code
 287     suffix = func_name.split("_")[-1]
 288     return util.underscore_to_camelcase_upper(
 289         util.unconventional_naming_rep_req[func_name]) + util.underscore_to_camelcase_upper(suffix) if func_name in util.unconventional_naming_rep_req \
 290         else camel_case_dto_name