/* Tracer -- wrapped ppaml_tracer_t
* Copyright (C) 2014 Galois, Inc.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this library. If not, see
ppamltracer is fundamentally a set of stateful operations; a
* Tracer
object 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 Tracer
. 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();
}
/**
* Creates and initializes a {@link Phase} associated with this
* Tracer
.
*
* @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");
}
/**
* Wraps malloc
to allocate a ppaml_tracer_t
.
*
* @return Same as malloc
.
*/
private static native long mallocTracer();
/**
* Wraps ppaml_tracer_init
.
*
* @return -1 if converting reportNameBase
from a
* String
to a char *
failed; all other return
* codes are the same as ppaml_tracer_init
.
*/
private static native int ppaml_tracer_init(
long tracer,
final String reportNameBase);
/**
* Wraps ppaml_tracer_done
.
*
* @return Same as ppaml_tracer_done
.
*/
private static native int ppaml_tracer_done(long tracer);
/**
* Wraps free
.
*/
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.
*
*
Precondition: Initialization succeeded.
*
* @throws OutOfMemoryError converting reportNameBase
from a
* String
to a char *
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);
}
}