1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/* 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 <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;
/**
* State class for ppamltracer.
*
* <p> ppamltracer is fundamentally a set of stateful operations; a
* <code>Tracer</code> 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 <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();
}
/**
* Creates and initializes a {@link Phase} associated with this
* <code>Tracer</code>.
*
* @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 <code>malloc</code> to allocate a <code>ppaml_tracer_t</code>.
*
* @return Same as <code>malloc</code>.
*/
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);
}
}
|
