aboutsummaryrefslogtreecommitdiff
path: root/bindings/java/src/java/com/galois/ppaml/tracer/Tracer.java
diff options
context:
space:
mode:
Diffstat (limited to 'bindings/java/src/java/com/galois/ppaml/tracer/Tracer.java')
-rw-r--r--bindings/java/src/java/com/galois/ppaml/tracer/Tracer.java134
1 files changed, 8 insertions, 126 deletions
diff --git a/bindings/java/src/java/com/galois/ppaml/tracer/Tracer.java b/bindings/java/src/java/com/galois/ppaml/tracer/Tracer.java
index fe0a180..24ca8e7 100644
--- a/bindings/java/src/java/com/galois/ppaml/tracer/Tracer.java
+++ b/bindings/java/src/java/com/galois/ppaml/tracer/Tracer.java
@@ -1,4 +1,4 @@
-/* Tracer -- wrapped ppaml_tracer_t
+/* Tracer -- Java analogue to ppaml_tracer_t
* Copyright (C) 2014 Galois, Inc.
*
* This library is free software: you can redistribute it and/or modify it
@@ -21,29 +21,13 @@
package com.galois.ppaml.tracer;
/**
- * State class for ppamltracer.
+ * State bundle for ppamltracer.
*
- * <p> ppamltracer is fundamentally a set of stateful operations; a
- * <code>Tracer</code> object holds the state ppamltracer needs to operate
+ * <p> ppamltracer is fundamentally a set of stateful operations; an object
+ * implementing <code>Tracer</code> holds the state ppamltracer needs to operate
* properly.
*/
-public final class Tracer extends CWrapper {
-
- /**
- * Base file path for trace report output.
- */
- private final String reportNameBase;
-
- /**
- * Creates and initializes a <code>Tracer</code>. The trace report will be
- * stored in Open Trace Format.
- *
- * @param reportNameBase all trace file paths will begin with this path.
- */
- public Tracer(final String reportNameBase) {
- this.reportNameBase = reportNameBase;
- super.open();
- }
+public interface Tracer {
/**
* Creates and initializes a {@link Phase} associated with this
@@ -51,113 +35,11 @@ public final class Tracer extends CWrapper {
*
* @param name the name of the phase.
*/
- public Phase createPhase(final String name) {
- return new Phase(this, name);
- }
-
-
- ////////////////////////// Low-level life cycle //////////////////////////
-
- ///// JNI shared library /////
-
- static {
- System.loadLibrary("ppamltracer_java");
- }
+ public Phase createPhase(final String name);
/**
- * Wraps <code>malloc</code> to allocate a <code>ppaml_tracer_t</code>.
- *
- * @return Same as <code>malloc</code>.
+ * Finalizes and frees the underlying structure.
*/
- private static native long mallocTracer();
-
- /**
- * Wraps <code>ppaml_tracer_init</code>.
- *
- * @return -1 if converting <code>reportNameBase</code> from a
- * <code>String</code> to a <code>char *</code> failed; all other return
- * codes are the same as <code>ppaml_tracer_init</code>.
- */
- private static native int ppaml_tracer_init(
- long tracer,
- final String reportNameBase);
-
- /**
- * Wraps <code>ppaml_tracer_done</code>.
- *
- * @return Same as <code>ppaml_tracer_done</code>.
- */
- private static native int ppaml_tracer_done(long tracer);
-
- /**
- * Wraps <code>free</code>.
- */
- private static native void freeTracer(long tracer);
-
-
- ///// JNI adapter code /////
-
- @Override
- protected void allocateCPointer() {
- this.cPointer = mallocTracer();
- }
-
- /**
- * Installs data into the structure to make it ready for use.
- *
- * <p> <b>Precondition:</b> Initialization succeeded.
- *
- * @throws OutOfMemoryError converting <code>reportNameBase</code> from a
- * <code>String</code> to a <code>char *</code> failed.
- *
- * @throws OTFManagerInitializationException the Open Trace Format file
- * manager could not be initialized.
- *
- * @throws OTFWriterInitializationException the Open Trace Format writer
- * could not be initialized.
- *
- * @throws OTFWriterResolutionException setting the trace resolution failed.
- *
- * @throws OTFWriterProcessDefinitionException defining the main OTF process
- * failed.
- */
- @Override
- protected void initializeCPointer() {
- assert this.cPointer != 0;
- assert reportNameBase != null;
- final int r = ppaml_tracer_init(this.cPointer, reportNameBase);
- switch (r) {
- case 0:
- break;
- case -1:
- throw new java.lang.OutOfMemoryError(
- "failed to convert Java string to C string");
- case 1:
- throw new OTFManagerInitializationException();
- case 2:
- throw new OTFWriterInitializationException();
- case 3:
- throw new OTFWriterResolutionException();
- case 4:
- throw new OTFWriterProcessDefinitionException("main");
- default:
- throw new UnexpectedReturnValueError(r);
- }
- }
-
- @Override
- protected void finalizeCPointer() {
- assert this.cPointer != 0;
- final int r = ppaml_tracer_done(this.cPointer);
- if (r != 0) {
- throw new UnexpectedReturnValueError(r);
- }
- }
-
- @Override
- protected void freeCPointer() {
- assert this.cPointer != 0;
- freeTracer(this.cPointer);
- }
+ public void close();
}