VPP-205: jvpp plugin support.
Splits jvpp into two jars jvpp-registry.jar - base jvpp functionality jvpp-core.jar - Java wrapper for vpe.api Plugins can be generated the same way jvpp-core.jar is. Example (nsh): https://gerrit.fd.io/r/#/c/2118/ Change-Id: I2254f90b2c3e423563bb91bf70877979f1e90a7d Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
This commit is contained in:
Marek Gradzki
committed by
Dave Wallace
Dave Wallace
parent
f4691cd7be
commit
66ea26b1bc
@ -17,25 +17,14 @@ import os, util
|
||||
from string import Template
|
||||
|
||||
jvpp_ifc_template = Template("""
|
||||
package $base_package;
|
||||
|
||||
package $plugin_package;
|
||||
|
||||
/**
|
||||
* <p>Java representation of vpe.api.
|
||||
* <p>Java representation of plugin's api file.
|
||||
* <br>It was generated by jvpp_impl_gen.py based on $inputfile
|
||||
* <br>(python representation of vpe.api generated by vppapigen).
|
||||
* <br>(python representation of api file generated by vppapigen).
|
||||
*/
|
||||
public interface JVpp extends java.lang.AutoCloseable {
|
||||
|
||||
/**
|
||||
* Generic connect with $base_package.callback.JVppCallback callback handler
|
||||
* providing connecting to VPP
|
||||
*
|
||||
* @param callback JVppCallback instance providing callback handling
|
||||
*
|
||||
* @throws java.io.IOException if connection cannot be initiated
|
||||
*/
|
||||
void connect($base_package.callback.JVppCallback callback) throws java.io.IOException;
|
||||
public interface JVpp${plugin_name} extends $base_package.JVpp {
|
||||
|
||||
/**
|
||||
* Generic dispatch method for sending requests to VPP
|
||||
@ -44,52 +33,110 @@ public interface JVpp extends java.lang.AutoCloseable {
|
||||
*/
|
||||
int send($base_package.$dto_package.JVppRequest request) throws org.openvpp.jvpp.VppInvocationException;
|
||||
|
||||
@Override
|
||||
void close();
|
||||
|
||||
$methods
|
||||
}
|
||||
""")
|
||||
|
||||
jvpp_impl_template = Template("""
|
||||
package $base_package;
|
||||
package $plugin_package;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.nio.file.StandardCopyOption;
|
||||
import java.nio.file.attribute.PosixFilePermission;
|
||||
import java.nio.file.attribute.PosixFilePermissions;
|
||||
import java.util.Set;
|
||||
import java.util.logging.Logger;
|
||||
import $base_package.callback.JVppCallback;
|
||||
import $base_package.VppConnection;
|
||||
import $base_package.JVppRegistry;
|
||||
|
||||
/**
|
||||
* <p>Default implementation of JVpp interface.
|
||||
* <br>It was generated by jvpp_impl_gen.py based on $inputfile
|
||||
* <br>(python representation of vpe.api generated by vppapigen).
|
||||
* <br>(python representation of api file generated by vppapigen).
|
||||
*/
|
||||
public final class JVppImpl implements $base_package.JVpp {
|
||||
public final class JVpp${plugin_name}Impl implements $plugin_package.JVpp${plugin_name} {
|
||||
|
||||
private final $base_package.VppConnection connection;
|
||||
private final static Logger LOG = Logger.getLogger(JVpp${plugin_name}Impl.class.getName());
|
||||
private static final String LIBNAME = "libjvpp_${plugin_name_underscore}.so.0.0.0";
|
||||
|
||||
public JVppImpl(final $base_package.VppConnection connection) {
|
||||
this.connection = java.util.Objects.requireNonNull(connection,"Connection is null");
|
||||
// FIXME using NativeLibraryLoader makes load fail could not find (WantInterfaceEventsReply).
|
||||
static {
|
||||
try {
|
||||
loadLibrary();
|
||||
} catch (Exception e) {
|
||||
LOG.severe("Can't find jvpp jni library: " + LIBNAME);
|
||||
throw new ExceptionInInitializerError(e);
|
||||
}
|
||||
}
|
||||
|
||||
private static void loadStream(final InputStream is) throws IOException {
|
||||
final Set<PosixFilePermission> perms = PosixFilePermissions.fromString("rwxr-x---");
|
||||
final Path p = Files.createTempFile(LIBNAME, null, PosixFilePermissions.asFileAttribute(perms));
|
||||
try {
|
||||
Files.copy(is, p, StandardCopyOption.REPLACE_EXISTING);
|
||||
|
||||
try {
|
||||
Runtime.getRuntime().load(p.toString());
|
||||
} catch (UnsatisfiedLinkError e) {
|
||||
throw new IOException("Failed to load library " + p, e);
|
||||
}
|
||||
} finally {
|
||||
try {
|
||||
Files.deleteIfExists(p);
|
||||
} catch (IOException e) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static void loadLibrary() throws IOException {
|
||||
try (final InputStream is = JVpp${plugin_name}Impl.class.getResourceAsStream('/' + LIBNAME)) {
|
||||
if (is == null) {
|
||||
throw new IOException("Failed to open library resource " + LIBNAME);
|
||||
}
|
||||
loadStream(is);
|
||||
}
|
||||
}
|
||||
|
||||
private VppConnection connection;
|
||||
private JVppRegistry registry;
|
||||
|
||||
private static native void init0(final JVppCallback callback, final long queueAddress, final int clientIndex);
|
||||
@Override
|
||||
public void connect($base_package.callback.JVppCallback callback) throws java.io.IOException {
|
||||
connection.connect(callback);
|
||||
public void init(final JVppRegistry registry, final JVppCallback callback, final long queueAddress, final int clientIndex) {
|
||||
this.registry = java.util.Objects.requireNonNull(registry, "registry should not be null");
|
||||
this.connection = java.util.Objects.requireNonNull(registry.getConnection(), "connection should not be null");
|
||||
connection.checkActive();
|
||||
init0(callback, queueAddress, clientIndex);
|
||||
}
|
||||
|
||||
private static native void close0();
|
||||
@Override
|
||||
public void close() {
|
||||
connection.close();
|
||||
close0();
|
||||
}
|
||||
|
||||
@Override
|
||||
public int send($base_package.$dto_package.JVppRequest request) throws org.openvpp.jvpp.VppInvocationException {
|
||||
public int send($base_package.$dto_package.JVppRequest request) throws org.openvpp.jvpp.VppInvocationException {
|
||||
return request.send(this);
|
||||
}
|
||||
|
||||
@Override
|
||||
public final int controlPing(final org.openvpp.jvpp.dto.ControlPing controlPing) throws org.openvpp.jvpp.VppInvocationException {
|
||||
return registry.controlPing(JVpp${plugin_name}Impl.class);
|
||||
}
|
||||
|
||||
$methods
|
||||
}
|
||||
""")
|
||||
|
||||
method_template = Template(""" int $name($base_package.$dto_package.$request request) throws org.openvpp.jvpp.VppInvocationException;""")
|
||||
method_template = Template(""" int $name($plugin_package.$dto_package.$request request) throws org.openvpp.jvpp.VppInvocationException;""")
|
||||
method_native_template = Template(
|
||||
""" private static native int ${name}0($base_package.$dto_package.$request request);""")
|
||||
method_impl_template = Template(""" public final int $name($base_package.$dto_package.$request request) throws org.openvpp.jvpp.VppInvocationException {
|
||||
""" private static native int ${name}0($plugin_package.$dto_package.$request request);""")
|
||||
method_impl_template = Template(""" public final int $name($plugin_package.$dto_package.$request request) throws org.openvpp.jvpp.VppInvocationException {
|
||||
java.util.Objects.requireNonNull(request,"Null request object");
|
||||
connection.checkActive();
|
||||
int result=${name}0(request);
|
||||
@ -113,9 +160,10 @@ no_arg_method_impl_template = Template(""" public final int $name() throws or
|
||||
""")
|
||||
|
||||
|
||||
def generate_jvpp(func_list, base_package, dto_package, inputfile):
|
||||
def generate_jvpp(func_list, base_package, plugin_package, plugin_name_underscore, control_ping_class, dto_package, inputfile):
|
||||
""" Generates JVpp interface and JNI implementation """
|
||||
print "Generating JVpp"
|
||||
plugin_name = util.underscore_to_camelcase_upper(plugin_name_underscore)
|
||||
|
||||
methods = []
|
||||
methods_impl = []
|
||||
@ -131,43 +179,42 @@ def generate_jvpp(func_list, base_package, dto_package, inputfile):
|
||||
continue
|
||||
|
||||
if len(func['args']) == 0:
|
||||
methods.append(no_arg_method_template.substitute(name=camel_case_name,
|
||||
base_package=base_package,
|
||||
dto_package=dto_package))
|
||||
methods_impl.append(
|
||||
no_arg_method_native_template.substitute(name=camel_case_name,
|
||||
base_package=base_package,
|
||||
dto_package=dto_package))
|
||||
methods_impl.append(no_arg_method_impl_template.substitute(name=camel_case_name,
|
||||
base_package=base_package,
|
||||
dto_package=dto_package))
|
||||
methods.append(no_arg_method_template.substitute(name=camel_case_name))
|
||||
methods_impl.append(no_arg_method_native_template.substitute(name=camel_case_name))
|
||||
methods_impl.append(no_arg_method_impl_template.substitute(name=camel_case_name))
|
||||
else:
|
||||
methods.append(method_template.substitute(name=camel_case_name,
|
||||
request=camel_case_name_upper,
|
||||
base_package=base_package,
|
||||
plugin_package=plugin_package,
|
||||
dto_package=dto_package))
|
||||
methods_impl.append(method_native_template.substitute(name=camel_case_name,
|
||||
request=camel_case_name_upper,
|
||||
base_package=base_package,
|
||||
plugin_package=plugin_package,
|
||||
dto_package=dto_package))
|
||||
methods_impl.append(method_impl_template.substitute(name=camel_case_name,
|
||||
request=camel_case_name_upper,
|
||||
base_package=base_package,
|
||||
plugin_package=plugin_package,
|
||||
dto_package=dto_package))
|
||||
|
||||
jvpp_file = open("JVpp.java", 'w')
|
||||
jvpp_file = open("JVpp%s.java" % plugin_name, 'w')
|
||||
jvpp_file.write(
|
||||
jvpp_ifc_template.substitute(inputfile=inputfile,
|
||||
methods="\n".join(methods),
|
||||
base_package=base_package,
|
||||
plugin_package=plugin_package,
|
||||
plugin_name=plugin_name,
|
||||
dto_package=dto_package))
|
||||
jvpp_file.flush()
|
||||
jvpp_file.close()
|
||||
|
||||
jvpp_file = open("JVppImpl.java", 'w')
|
||||
jvpp_file = open("JVpp%sImpl.java" % plugin_name, 'w')
|
||||
jvpp_file.write(jvpp_impl_template.substitute(inputfile=inputfile,
|
||||
methods="\n".join(methods_impl),
|
||||
base_package=base_package,
|
||||
dto_package=dto_package))
|
||||
plugin_package=plugin_package,
|
||||
plugin_name=plugin_name,
|
||||
plugin_name_underscore=plugin_name_underscore,
|
||||
dto_package=dto_package,
|
||||
control_ping_class=control_ping_class))
|
||||
jvpp_file.flush()
|
||||
jvpp_file.close()
|
||||
|
||||
Reference in New Issue
Block a user