gem5ops: Implement Java JNI for gem5Ops

These ops allow gem5 ops to be called from within java programs like the following:
import jni.gem5Op;

public  class HelloWorld {

    public static void main(String[] args) {
        gem5Op gem5 = new gem5Op();
        System.out.println("Rpns0:" + gem5.rpns());
        System.out.println("Rpns1:" + gem5.rpns());
    }

    static {
        System.loadLibrary("gem5OpJni");
    }
}

When building you need to make sure classpath include gem5OpJni.jar:
javac -classpath $CLASSPATH:/path/to/gem5OpJni.jar HelloWorld.java

and when running you need to make sure both the java and library path are set:
java -classpath $CLASSPATH:/path/to/gem5OpJni.jar -Djava.library.path=/path/to/libgem5OpJni.so HelloWorld

3 files changed, 257 insertions, 2 deletions

diff --git a/util/m5/Makefile.arm b/util/m5/Makefile.arm
index 94c222644..80c562a06 100644
--- a/util/m5/Makefile.arm
+++ b/util/m5/Makefile.arm
@@ -47,8 +47,16 @@ CC=$(CROSS_COMPILE)gcc
 AS=$(CROSS_COMPILE)as
 LD=$(CROSS_COMPILE)ld
 
-CFLAGS=-O2 
+JC=javac
+JH=javah
+JR=jar
+### JDK_PATH must be set to build gem5OpJni
+#JDK_PATH=/path/to/jdk/version_number
+
+CFLAGS=-O2 -I $(JDK_PATH)/include/ -I $(JDK_PATH)/include/linux
+
 OBJS=m5.o m5op_arm.o
+JNI_OBJS=m5op_arm.o jni_gem5Op.o
 
 all: m5
 
@@ -61,5 +69,13 @@ all: m5
 m5: $(OBJS)
 	$(CC) -o $@ $(OBJS)
 
+gem5OpJni: gem5OpJni.jar $(JNI_OBJS)
+	$(CC) --shared -o lib$@.so $(JNI_OBJS)
+
+gem5OpJni.jar:
+	$(JC) jni/gem5Op.java; \
+	$(JH) jni.gem5Op; \
+	$(JR) cvf $@ jni/*.class
+
 clean:
-	rm -f *.o m5
+	rm -f *.o m5 libgemOpJni.so gem5OpJni.jar jni/*.class
diff --git a/util/m5/jni/gem5Op.java b/util/m5/jni/gem5Op.java
new file mode 100644
index 000000000..bb324b37c
--- /dev/null
+++ b/util/m5/jni/gem5Op.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2010 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Prakash Ramrakhyani
+ */
+
+package jni;
+
+/**
+ * Java class to implement JNI for m5Ops
+ */
+
+public class gem5Op {
+    public native void arm(long address);
+    public native void quiesce();
+    public native void quiesceNs(long ns);
+    public native void quiesceCycle(long cycles);
+    public native long quiesceTime();
+    public native long rpns();
+    public native void wakeCPU(long cpuid);
+
+    public native void exit(long ns_delay);
+    public native long initparam();
+    public native void checkpoint(long ns_delay, long ns_period);
+    public native void reset_stats(long ns_delay, long ns_period);
+    public native void dump_stats(long ns_delay, long ns_period);
+    public native void dumpreset_stats(long ns_delay, long ns_period);
+    public native void debugbreak();
+    public native void switchcpu();
+    public native void panic();
+    public native void work_begin(long workid, long threadid);
+    public native void work_end(long workid, long threadid);
+
+}
diff --git a/util/m5/jni_gem5Op.c b/util/m5/jni_gem5Op.c
new file mode 100644
index 000000000..501933e62
--- /dev/null
+++ b/util/m5/jni_gem5Op.c
@@ -0,0 +1,172 @@
+/*
+ * Copyright (c) 2010 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Prakash Ramrakhyani
+ */
+
+#include <stdint.h>
+
+#include "jni_gem5Op.h"
+#include "m5op.h"
+
+/**
+   C library interface for gem5Op JNI
+
+*/
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_arm(JNIEnv *env, jobject obj, jlong j_address)
+{
+    arm(j_address);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_quiesce(JNIEnv *env, jobject obj)
+{
+    quiesce();
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_quiesceNs(JNIEnv *env, jobject obj, jlong j_ns)
+{
+    quiesceNs(j_ns);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_quiesceCycle(JNIEnv *env, jobject obj, jlong j_cycles)
+{
+    quiesceCycle(j_cycles);
+}
+
+JNIEXPORT jlong JNICALL
+Java_jni_gem5Op_quiesceTime(JNIEnv *env, jobject obj)
+{
+    uint64_t time = quiesceTime();
+    if (time & 0x8000000000000000ULL)
+        printf("Truncated return value from quiesceTime() to 63 bits\n");
+    return (time & 0x7FFFFFFFFFFFFFFFULL);
+}
+
+JNIEXPORT jlong JNICALL
+Java_jni_gem5Op_rpns(JNIEnv *env, jobject obj)
+{
+    uint64_t time = rpns();
+    if (time & 0x8000000000000000ULL)
+        printf("Truncated return value from rpns() to 63 bits\n");
+    return (time & 0x7FFFFFFFFFFFFFFFULL);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_wakeCPU(JNIEnv *env, jobject obj, jlong j_cpuid)
+{
+    wakeCPU(j_cpuid);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_exit(JNIEnv *env, jobject obj, jlong j_ns_delay)
+{
+    m5_exit(j_ns_delay);
+}
+
+JNIEXPORT jlong JNICALL
+Java_jni_gem5Op_initparam(JNIEnv *env, jobject obj)
+{
+    uint64_t param = m5_initparam();
+    if (param & 0x8000000000000000ULL)
+        printf("Truncated return value from m_initparam() to 63 bits\n");
+    return (param & 0x7FFFFFFFFFFFFFFFULL);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_checkpoint(JNIEnv *env, jobject obj,
+                           jlong j_ns_delay, jlong j_ns_period)
+{
+    m5_checkpoint(j_ns_delay, j_ns_period);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_reset_1stats(JNIEnv *env, jobject obj,
+                             jlong j_ns_delay, jlong j_ns_period)
+{
+    m5_reset_stats(j_ns_delay, j_ns_period);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_dump_1stats(JNIEnv *env, jobject obj,
+                            jlong j_ns_delay, jlong j_ns_period)
+{
+    m5_dump_stats(j_ns_delay, j_ns_period);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_dumpreset_1stats(JNIEnv *env, jobject obj,
+                                 jlong j_ns_delay, jlong j_ns_period)
+{
+    m5_dumpreset_stats(j_ns_delay, j_ns_period);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_debugbreak(JNIEnv *env, jobject obj)
+{
+    m5_debugbreak();
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_switchcpu (JNIEnv *env, jobject obj)
+{
+    m5_switchcpu();
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_panic(JNIEnv *env, jobject obj)
+{
+    m5_panic();
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_work_1begin(JNIEnv *env, jobject obj,
+                            jlong j_workid, jlong j_threadid)
+{
+    m5_work_begin(j_workid, j_threadid);
+}
+
+JNIEXPORT void JNICALL
+Java_jni_gem5Op_work_1end(JNIEnv *env, jobject obj,
+                          jlong j_workid, jlong j_threadid)
+{
+    m5_work_end(j_workid, j_threadid);
+}
+