JVpp JMH benchmark

Creates ACL of size aclSize using acl_add_replace,
then assigns it to local0 using acl_interface_set_acl_list.

Then ACL is updated synchronously using acl_add_replace.
By default 20x2s warmup and 100x2s measurment iterations
are performed.

VPP is restarted after each iteration.

Each invocation of acl_add_replace uses ACL from precomputed
set of ACLs of size aclSetSize.
ACLs from the set are used in round-robin fashion.

Compile:

cd $HC2VPP_ROOT/it/jvpp-benchmark
mvn clean install

Run with:

sudo java -jar ./target/jvpp-benchmark-exec.jar

To specify aclSize (default=100), use:

sudo java -jar ./target/jvpp-benchmark-exec.jar -p aclSize=1000

To specify aclSetSize (default=100), use:

sudo java -jar ./target/jvpp-benchmark-exec.jar -p aclSetSize=1000

To see more options, use

java -jar ./target/jvpp-benchmark-exec.jar -h

Change-Id: I43691ba891940a1c341f8e9893c8598c811bc077
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>

6 files changed, 432 insertions, 0 deletions

diff --git a/it/jvpp-benchmark/asciidoc/Readme.adoc b/it/jvpp-benchmark/asciidoc/Readme.adoc
new file mode 100644
index 000000000..604abf9b3
--- /dev/null
+++ b/it/jvpp-benchmark/asciidoc/Readme.adoc
@@ -0,0 +1,49 @@
+= jvpp-benchmark
+
+Provides JMH based benchmarks JVpp (Java API for VPP).
+
+== AclUpdateBenchmark
+
+Creates ACL of size aclSize using acl_add_replace,
+then assigns it to local0 using acl_interface_set_acl_list.
+
+Then ACL is updated synchronously using acl_add_replace.
+By default 20x2s warmup and 100x2s measurment iterations
+are performed.
+
+VPP is restarted after each iteration.
+
+Each invocation of acl_add_replace uses ACL from precomputed
+set of ACLs of size aclSetSize.
+ACLs from the set are used in round-robin fashion.
+
+Compile:
+[source,shell]
+---
+cd $HC2VPP_ROOT/it/jvpp-benchmark
+mvn clean install
+---
+
+Run with:
+[source,shell]
+---
+sudo java -jar ./target/jvpp-benchmark-exec.jar
+---
+
+To specify aclSize (default=100), use:
+[source,shell]
+---
+sudo java -jar ./target/jvpp-benchmark-exec.jar -p aclSize=1000
+---
+
+To specify aclSetSize (default=100), use:
+[source,shell]
+---
+sudo java -jar ./target/jvpp-benchmark-exec.jar -p aclSetSize=1000
+---
+
+To see more options, use
+[source,shell]
+---
+java -jar ./target/jvpp-benchmark-exec.jar -h
+---
diff --git a/it/jvpp-benchmark/pom.xml b/it/jvpp-benchmark/pom.xml
new file mode 100644
index 000000000..f0e801e93
--- /dev/null
+++ b/it/jvpp-benchmark/pom.xml
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2017 Cisco and/or its affiliates.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at:
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>io.fd.hc2vpp.common</groupId>
+        <artifactId>hc2vpp-parent</artifactId>
+        <version>1.18.07-SNAPSHOT</version>
+        <relativePath>../../common/hc2vpp-parent</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>io.fd.hc2vpp.it</groupId>
+    <artifactId>jvpp-benchmark</artifactId>
+    <version>1.18.07-SNAPSHOT</version>
+    <name>${project.artifactId}</name>
+
+    <properties>
+        <jmh.version>1.21</jmh.version>
+        <shaded.name>jvpp-benchmark-exec</shaded.name>
+        <jvpp.version>18.07-SNAPSHOT</jvpp.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.openjdk.jmh</groupId>
+            <artifactId>jmh-core</artifactId>
+            <version>${jmh.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.openjdk.jmh</groupId>
+            <artifactId>jmh-generator-annprocess</artifactId>
+            <version>${jmh.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>io.fd.vpp</groupId>
+            <artifactId>jvpp-registry</artifactId>
+            <version>${jvpp.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.fd.vpp</groupId>
+            <artifactId>jvpp-acl</artifactId>
+            <version>${jvpp.version}</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>
+                <version>3.1.1</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>shade</goal>
+                        </goals>
+                        <configuration>
+                            <!-- fixme: includevesion in artifact name, deploy to nexus -->
+                            <finalName>${shaded.name}</finalName>
+                            <transformers>
+                                <transformer
+                                        implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                                    <mainClass>org.openjdk.jmh.Main</mainClass>
+                                </transformer>
+                            </transformers>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
diff --git a/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclProvider.java b/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclProvider.java
new file mode 100644
index 000000000..b00f5b90a
--- /dev/null
+++ b/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclProvider.java
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.hc2vpp.it.jvpp.benchmark;
+
+import io.fd.vpp.jvpp.acl.dto.AclAddReplace;
+
+/**
+ * Provides ACLs for JVpp Benchmark.
+ */
+interface AclProvider {
+    AclAddReplace next();
+    void setAclIndex(final int index);
+}
diff --git a/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclProviderImpl.java b/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclProviderImpl.java
new file mode 100644
index 000000000..4a39becad
--- /dev/null
+++ b/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclProviderImpl.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.hc2vpp.it.jvpp.benchmark;
+
+import io.fd.vpp.jvpp.acl.dto.AclAddReplace;
+import io.fd.vpp.jvpp.acl.types.AclRule;
+import javax.annotation.concurrent.NotThreadSafe;
+
+@NotThreadSafe
+class AclProviderImpl implements AclProvider {
+    private static final int CREATE_NEW_ACL = -1;
+    private static final short MAX_PORT_NUMBER = (short) 65535;
+
+    private final int aclSetSize;
+    private final AclAddReplace[] acls;
+
+    /**
+     * Pointer to ACL to be returned by invocation of {@link #next()} method.
+     */
+    private int currentAcl = 0;
+
+    AclProviderImpl(final int aclSetSize, final int aclSize) {
+        this.aclSetSize = aclSetSize;
+        acls = new AclAddReplace[aclSetSize];
+        initAcls(aclSetSize, aclSize);
+    }
+
+    @Override
+    public AclAddReplace next() {
+        final AclAddReplace result = acls[currentAcl];
+        currentAcl = (currentAcl + 1) % aclSetSize;
+        return result;
+    }
+
+    @Override
+    public void setAclIndex(final int index) {
+        for (int i = 0; i < aclSetSize; ++i) {
+            acls[i].aclIndex = index;
+        }
+    }
+
+    private void initAcls(final int aclSetSize, final int aclSize) {
+        long ip = 0x01000000; // 1.0.0.0
+        for (int i = 0; i < aclSetSize; ++i) {
+            acls[i] = createAddReplaceRequest(aclSize, CREATE_NEW_ACL, (int) (ip++));
+        }
+    }
+
+    private static AclAddReplace createAddReplaceRequest(final int size, final int index, final int ip) {
+        AclAddReplace request = new AclAddReplace();
+        request.aclIndex = index;
+        request.count = size;
+        request.r = createRules(size, ip);
+        return request;
+    }
+
+    private static AclRule[] createRules(final int size, final int ip) {
+        final AclRule[] rules = new AclRule[size];
+        for (int i = 0; i < size; ++i) {
+            rules[i] = new AclRule();
+            rules[i].isIpv6 = 0;
+            rules[i].isPermit = 1;
+            rules[i].srcIpAddr = getIp(ip);
+            rules[i].srcIpPrefixLen = 32;
+            rules[i].dstIpAddr = getIp(ip);
+            rules[i].dstIpPrefixLen = 32;
+            rules[i].dstportOrIcmpcodeFirst = 0;
+            rules[i].dstportOrIcmpcodeLast = MAX_PORT_NUMBER;
+            rules[i].srcportOrIcmptypeFirst = 0;
+            rules[i].srcportOrIcmptypeLast = MAX_PORT_NUMBER;
+            rules[i].proto = 17; // UDP
+        }
+        return rules;
+    }
+
+    private static byte[] getIp(final int i) {
+        int b1 = (i >> 24) & 0xff;
+        int b2 = (i >> 16) & 0xff;
+        int b3 = (i >> 8) & 0xff;
+        int b4 = i & 0xff;
+        return new byte[] {(byte) b1, (byte) b2, (byte) b3, (byte) b4};
+    }
+}
\ No newline at end of file
diff --git a/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclUpdateBenchmark.java b/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclUpdateBenchmark.java
new file mode 100644
index 000000000..8a26e2d21
--- /dev/null
+++ b/it/jvpp-benchmark/src/main/java/io/fd/hc2vpp/it/jvpp/benchmark/AclUpdateBenchmark.java
@@ -0,0 +1,157 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.hc2vpp.it.jvpp.benchmark;
+
+import static org.openjdk.jmh.annotations.Mode.Throughput;
+
+import com.google.common.io.CharStreams;
+import io.fd.vpp.jvpp.JVppRegistryImpl;
+import io.fd.vpp.jvpp.acl.JVppAclImpl;
+import io.fd.vpp.jvpp.acl.dto.AclInterfaceSetAclList;
+import io.fd.vpp.jvpp.acl.future.FutureJVppAclFacade;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import org.openjdk.jmh.annotations.Benchmark;
+import org.openjdk.jmh.annotations.BenchmarkMode;
+import org.openjdk.jmh.annotations.Fork;
+import org.openjdk.jmh.annotations.Level;
+import org.openjdk.jmh.annotations.Measurement;
+import org.openjdk.jmh.annotations.Mode;
+import org.openjdk.jmh.annotations.OutputTimeUnit;
+import org.openjdk.jmh.annotations.Param;
+import org.openjdk.jmh.annotations.Scope;
+import org.openjdk.jmh.annotations.Setup;
+import org.openjdk.jmh.annotations.State;
+import org.openjdk.jmh.annotations.TearDown;
+import org.openjdk.jmh.annotations.Threads;
+import org.openjdk.jmh.annotations.Timeout;
+import org.openjdk.jmh.annotations.Warmup;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+@BenchmarkMode(Mode.AverageTime)
+@State(Scope.Thread)
+@Fork(1)
+@Threads(1)
+@Timeout(time = 5)
+@Warmup(iterations = 20, time = 2)
+@Measurement(iterations = 100, time = 2)
+@OutputTimeUnit(TimeUnit.MILLISECONDS)
+public class AclUpdateBenchmark {
+    private static final Logger LOG = LoggerFactory.getLogger(AclUpdateBenchmark.class);
+
+    @Param( {"100"})
+    private int aclSize;
+
+    @Param( {"100"})
+    private int aclSetSize;
+
+    private AclProvider aclProvider;
+    private JVppRegistryImpl registry;
+    private FutureJVppAclFacade jvpp;
+
+    @Benchmark
+    public void testMethod() throws Exception {
+        jvpp.aclAddReplace(aclProvider.next()).toCompletableFuture().get();
+    }
+
+    @Setup(Level.Iteration)
+    public void setup() throws Exception {
+        initAclProvider();
+        startVpp();
+        connect();
+        initAcl();
+    }
+
+    @TearDown(Level.Iteration)
+    public void tearDown() throws Exception {
+        disconnect();
+        stopVpp();
+    }
+
+    private void initAclProvider() {
+        aclProvider = new AclProviderImpl(aclSetSize, aclSize);
+    }
+
+    private void startVpp() throws Exception {
+        LOG.info("Starting VPP ...");
+        final String[] cmd = {"/bin/sh", "-c", "sudo service vpp start"};
+        exec(cmd);
+        LOG.info("VPP started successfully");
+    }
+
+    private void stopVpp() throws Exception {
+        LOG.info("Stopping VPP ...");
+        final String[] cmd = {"/bin/sh", "-c", "sudo service vpp stop"};
+        exec(cmd);
+
+        // Wait to be sure VPP was stopped.
+        // Prevents VPP start failure: "vpp.service: Start request repeated too quickly".
+        Thread.sleep(1500);
+        LOG.info("VPP stopped successfully");
+
+    }
+
+    private static void exec(String[] command) throws IOException, InterruptedException {
+        Process process = Runtime.getRuntime().exec(command);
+        process.waitFor();
+        if (process.exitValue() != 0) {
+            String error_msg = "Failed to execute " + Arrays.toString(command) + ": " +
+                CharStreams.toString(new InputStreamReader(process.getErrorStream(), StandardCharsets.UTF_8));
+            throw new IllegalStateException(error_msg);
+        }
+    }
+
+    private void connect() throws IOException {
+        LOG.info("Connecting to JVPP ...");
+        registry = new JVppRegistryImpl("ACLUpdateBenchmark");
+        jvpp = new FutureJVppAclFacade(registry, new JVppAclImpl());
+        LOG.info("Successfully connected to JVPP");
+    }
+
+    private void disconnect() throws Exception {
+        LOG.info("Disconnecting ...");
+        jvpp.close();
+        registry.close();
+        LOG.info("Successfully disconnected ...");
+    }
+
+    /**
+     * Creates ACL and assigns it to local0 interface.
+     */
+    private void initAcl()
+        throws ExecutionException, InterruptedException {
+        // Create ACL
+        final int aclId = jvpp.aclAddReplace(aclProvider.next()).toCompletableFuture().get().aclIndex;
+
+        // Assign the ACL to local0 interface
+        final AclInterfaceSetAclList aclList = new AclInterfaceSetAclList();
+        aclList.swIfIndex = 0;
+        aclList.count = 1;
+        aclList.nInput = 1;
+        aclList.acls = new int[] {aclId};
+        jvpp.aclInterfaceSetAclList(aclList).toCompletableFuture().get();
+
+        // Use ACL index in subsequent executions of aclProvider.next() method
+        aclProvider.setAclIndex(aclId);
+    }
+}
diff --git a/it/pom.xml b/it/pom.xml
index e05a68ebb..ee5ebdedb 100644
--- a/it/pom.xml
+++ b/it/pom.xml
@@ -33,6 +33,7 @@
 
     <modules>
         <module>api-test</module>
+        <module>jvpp-benchmark</module>
     </modules>
 
     <profiles>