diff options
author | Benjamin Barenblat <bbarenblat@galois.com> | 2014-02-03 17:19:53 -0800 |
---|---|---|
committer | Benjamin Barenblat <bbarenblat@galois.com> | 2014-02-06 09:50:09 -0800 |
commit | cc9249c85c50116813665d5753d81c3d5f11c9e7 (patch) | |
tree | ed31dd5412e7e04f4bd726c00c62ce519051676d /bindings/java/src/java/com/galois/ppaml/tracer/EnvironmentConfiguredTracer.java | |
parent | 0b617259a3c1c1f7e2c097e0f56d8ae3c5cc96f7 (diff) |
Java: Add 'EnvironmentConfiguredTracer'
Adding 'ppaml_tracer_init_from_env' (commit b9dfb8d0) makes the Java
code substantially more complicated, as it introduces a second mechanism
to construct 'Tracer's. While I could simply provide two constructors
in the 'Tracer' class, this would make for an ugly and dangerous
implementation; after all, the life cycle of a tracer configured
explicitly is noticeably different from the life cycle of a tracer
configured by sourcing environment variables. Instead, I’ve changed
'Tracer' to be an interface implemented by 'ExplicitlyConfiguredTracer'
and 'EnvironmentConfiguredTracer'.
This is an API-breaking change.
Diffstat (limited to 'bindings/java/src/java/com/galois/ppaml/tracer/EnvironmentConfiguredTracer.java')
-rw-r--r-- | bindings/java/src/java/com/galois/ppaml/tracer/EnvironmentConfiguredTracer.java | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/bindings/java/src/java/com/galois/ppaml/tracer/EnvironmentConfiguredTracer.java b/bindings/java/src/java/com/galois/ppaml/tracer/EnvironmentConfiguredTracer.java new file mode 100644 index 0000000..925e3e2 --- /dev/null +++ b/bindings/java/src/java/com/galois/ppaml/tracer/EnvironmentConfiguredTracer.java @@ -0,0 +1,84 @@ +/* EnvironmentConfiguredTracer -- tracer initialized with ppaml_tracer_init_from_env + * 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 <http://www.gnu.org/licenses/>. + * + * To contact Galois, complete the Web form at + * <http://corp.galois.com/contact/> or write to Galois, Inc., 421 Southwest + * 6th Avenue, Suite 300, Portland, Oregon, 97204-1622. */ + +package com.galois.ppaml.tracer; + +/** + * A tracer initialized automatically from environment variables. + * + * <p>The currently-supported environment variables are: + * + * <dl> + * <dt><code>PPAMLTRACER_TRACE_BASE</code></dt><dd>All trace file paths will + * begin with this path.</dd> + */ +public final class EnvironmentConfiguredTracer extends TracerCWrapper { + + /** + * Creates and initializes an <code>EnvironmentConfiguredTracer</code>. The + * trace report will be stored in Open Trace Format. + */ + public EnvironmentConfiguredTracer() { + super.open(); + } + + ////////////////////////// Low-level life cycle ////////////////////////// + + ///// JNI adapter code ///// + + /** + * Installs data into the structure to make it ready for use. + * + * <p> <b>Precondition:</b> Initialization succeeded. + * + * @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; + final int r = ppaml_tracer_init_from_env(this.cPointer); + switch (r) { + case 0: + break; + case 1: + throw new OTFManagerInitializationException(); + case 2: + throw new OTFWriterInitializationException(); + case 3: + throw new OTFWriterResolutionException(); + case 4: + throw new OTFWriterProcessDefinitionException("main"); + case 5: + throw new UndefinedTracerBasePathException(); + default: + throw new UnexpectedReturnValueError(r); + } + } + +} |