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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/* Phase -- wrapped ppaml_phase_t
* Copyright (C) 2014 Galois, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither Galois's name nor the names of other contributors may be used to
* endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY GALOIS AND OTHER 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 GALOIS OR OTHER 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. */
package com.galois.ppaml.tracer;
/**
* A phase of execution to trace. This class exports no public constructors;
* to instantiate it, use <code>Tracer.createPhase</code>.
*/
public final class Phase extends CWrapper {
/**
* The <code>TracerCWrapper</code> this phase is associated with.
*/
private final TracerCWrapper tracer;
/**
* The name of the phase.
*/
private final String name;
/**
* Creates and initializes a <code>Phase</code>. You should not call this;
* call <code>Tracer.createPhase</code> instead.
*
* @param tracer the {@link TracerCWrapper} to associate the
* <code>Phase</code> with.
*
* @param name the name of the phase.
*/
protected Phase(TracerCWrapper tracer, final String name) {
this.tracer = tracer;
this.name = name;
super.open();
}
////////////////////////// Low-level life cycle //////////////////////////
///// JNI shared library /////
static {
System.loadLibrary("ppamltracer_java");
}
/**
* Wraps <code>malloc</code> to allocate a <code>ppaml_phase_t</code>.
*
* @return Same as <code>malloc</code>.
*/
private static native long mallocPhase();
/**
* Wraps <code>ppaml_phase_init</code>.
*
* @return -1 if converting <code>name</code> from a <code>String</code> to
* a <code>char *</code> failed; all other return codes are the same as
* <code>ppaml_phase_init</code>.
*/
private static native int ppaml_phase_init(
long tracer,
long phase,
final String reportNameBase);
/**
* Wraps <code>ppaml_phase_done</code>.
*
* @return Same as <code>ppaml_phase_done</code>.
*/
private static native int ppaml_phase_done(long phase);
/**
* Wraps <code>free</code>.
*/
private static native void freePhase(long phase);
///// JNI adapter code /////
@Override
protected void allocateCPointer() {
this.cPointer = mallocPhase();
}
/**
* Installs data into the structure to make it ready for use.
*
* <p> <b>Precondition:</b> Initialization succeeded.
*
* @throws OutOfMemoryError converting <code>name</code> from a
* <code>String</code> to a <code>char *</code> failed.
*
* @throws OTFWriterPhaseDefinitionException defining the OTF phase failed.
*/
@Override
protected void initializeCPointer() {
assert this.cPointer != 0;
assert tracer != null;
assert name != null;
final int r = ppaml_phase_init(tracer.cPointer, this.cPointer, name);
switch (r) {
case 0:
break;
case -1:
throw new java.lang.OutOfMemoryError(
"failed to convert Java string to C string");
case 1:
throw new OTFWriterPhaseDefinitionException();
default:
throw new UnexpectedReturnValueError(r);
}
}
@Override
protected void finalizeCPointer() {
assert this.cPointer != 0;
final int r = ppaml_phase_done(this.cPointer);
if (r != 0) {
throw new UnexpectedReturnValueError(r);
}
}
@Override
protected void freeCPointer() {
assert this.cPointer != 0;
freePhase(this.cPointer);
}
////////////////////////// Starting and stopping //////////////////////////
///// JNI shared library /////
/**
* Wraps <code>ppaml_phase_start</code>.
*
* @return Same as <code>ppaml_phase_start</code>.
*/
private static native int ppaml_phase_start(long phase);
/**
* Wraps <code>ppaml_phase_stop</code>.
*
* @return Same as <code>ppaml_phase_stop</code>.
*/
private static native int ppaml_phase_stop(long phase);
///// JNI adapter code /////
/**
* Records the start of a <code>Phase</code>.
*
* @throws ClosedException the <code>Phase</code> has been closed.
*
* @throws ClockAcquisitionException getting the time failed.
*
* @throws OTFWriterEntryException recording the phase start failed.
*/
public void start() {
if (this.cPointer == 0) {
throw new ClosedException();
}
final int r = ppaml_phase_start(this.cPointer);
switch (r) {
case 0:
break;
case 1:
throw new ClockAcquisitionException();
case 2:
throw new OTFWriterEntryException();
default:
throw new UnexpectedReturnValueError(r);
}
}
/**
* Records the end of a <code>Phase</code>.
*
* @throws ClosedException the <code>Phase</code> has been closed.
*
* @throws ClockAcquisitionException getting the time failed.
*
* @throws OTFWriterExitException recording the phase stop failed.
*/
public void stop() {
if (this.cPointer == 0) {
throw new ClosedException();
}
final int r = ppaml_phase_stop(this.cPointer);
switch (r) {
case 0:
break;
case 1:
throw new ClockAcquisitionException();
case 2:
throw new OTFWriterExitException();
default:
throw new UnexpectedReturnValueError(r);
}
}
}
|
