1 /*******************************************************************************
2 * Copyright (c) 2011-2012 Ericsson, Ecole Polytechnique de Montreal and others
4 * All rights reserved. This program and the accompanying materials are made
5 * available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
9 * Contributors: Matthew Khouzam - Initial API and implementation
10 * Contributors: Simon Marchi - Initial API and implementation
11 *******************************************************************************/
12 package org
.eclipse
.linuxtools
.ctf
.core
.trace
;
14 import java
.io
.IOException
;
15 import java
.nio
.MappedByteBuffer
;
16 import java
.nio
.channels
.FileChannel
.MapMode
;
17 import java
.util
.Collection
;
18 import java
.util
.HashMap
;
20 import org
.eclipse
.linuxtools
.ctf
.core
.event
.EventDeclaration
;
21 import org
.eclipse
.linuxtools
.ctf
.core
.event
.EventDefinition
;
22 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.Definition
;
23 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.EnumDefinition
;
24 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.IDefinitionScope
;
25 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.IntegerDefinition
;
26 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.StructDeclaration
;
27 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.StructDefinition
;
28 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.VariantDefinition
;
29 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.io
.BitBuffer
;
30 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.trace
.Stream
;
31 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.trace
.StreamInputPacketIndexEntry
;
34 * <b><u>StreamInputPacketReader</u></b>
36 * Reads the events of a packet of a trace file.
38 class StreamInputPacketReader
implements IDefinitionScope
{
40 // ------------------------------------------------------------------------
42 // ------------------------------------------------------------------------
45 * Reference to the index entry of the current packet.
47 private StreamInputPacketIndexEntry currentPacket
= null;
50 * BitBuffer used to read the trace file.
52 private final BitBuffer bitBuffer
= new BitBuffer();
55 * StreamInputReader that uses this StreamInputPacketReader.
57 private final StreamInputReader streamInputReader
;
60 * Last timestamp recorded.
62 * Needed to calculate the complete timestamp values for the events with
65 private long lastTimestamp
= 0;
68 * Trace packet header.
70 private StructDefinition tracePacketHeaderDef
= null;
73 * Stream packet context definition.
75 private StructDefinition streamPacketContextDef
= null;
78 * Stream event header definition.
80 private StructDefinition streamEventHeaderDef
= null;
83 * Stream event context definition.
85 private StructDefinition streamEventContextDef
= null;
88 * Maps event ID to event definitions.
90 private final HashMap
<Long
, EventDefinition
> events
= new HashMap
<Long
, EventDefinition
>();
93 * CPU id of current packet.
95 private int currentCpu
= 0;
98 * number of lost events in this packet
100 private int lostEvents
;
102 private int lostSoFar
;
104 // ------------------------------------------------------------------------
106 // ------------------------------------------------------------------------
109 * Constructs a StreamInputPacketReader.
111 * @param streamInputReader
112 * The StreamInputReader to which this packet reader belongs to.
114 public StreamInputPacketReader(StreamInputReader streamInputReader
) {
115 this.streamInputReader
= streamInputReader
;
118 * Set the BitBuffer's byte order.
120 getBitBuffer().setByteOrder(streamInputReader
.getByteOrder());
123 * Create definitions needed to read the events.
131 // ------------------------------------------------------------------------
133 // ------------------------------------------------------------------------
135 // ------------------------------------------------------------------------
136 // Getters/Setters/Predicates
137 // ------------------------------------------------------------------------
139 /* Getters, setters and stuff. */
141 public StreamInputPacketIndexEntry
getCurrentPacket() {
142 return this.currentPacket
;
145 public StructDefinition
getStreamPacketContextDef() {
146 return this.streamPacketContextDef
;
149 public int getCPU() {
150 return this.currentCpu
;
154 public String
getPath() {
155 return ""; //$NON-NLS-1$
158 // ------------------------------------------------------------------------
160 // ------------------------------------------------------------------------
163 * Creates definitions needed to read events (stream-defined and
166 private void createDefinitions() {
168 * Create trace packet header definition.
170 final Stream currentStream
= getStreamInputReader().getStreamInput().getStream();
171 StructDeclaration tracePacketHeaderDecl
= currentStream
.getTrace().getPacketHeader();
172 if (tracePacketHeaderDecl
!= null) {
173 setTracePacketHeaderDef(tracePacketHeaderDecl
.createDefinition(this,
174 "trace.packet.header")); //$NON-NLS-1$
178 * Create stream packet context definition.
180 StructDeclaration streamPacketContextDecl
= currentStream
.getPacketContextDecl();
181 if (streamPacketContextDecl
!= null) {
182 setStreamPacketContextDef(streamPacketContextDecl
.createDefinition(
183 this, "stream.packet.context")); //$NON-NLS-1$
187 * Create stream event header definition.
189 StructDeclaration streamEventHeaderDecl
= currentStream
.getEventHeaderDecl();
190 if (streamEventHeaderDecl
!= null) {
191 setStreamEventHeaderDef(streamEventHeaderDecl
.createDefinition(this,
192 "stream.event.header")); //$NON-NLS-1$
196 * Create stream event context definition.
198 StructDeclaration streamEventContextDecl
= currentStream
.getEventContextDecl();
199 if (streamEventContextDecl
!= null) {
200 setStreamEventContextDef(streamEventContextDecl
.createDefinition(
201 this, "stream.event.context")); //$NON-NLS-1$
204 createEventDefinitions();
208 * Creates definitions needed to read the event. (event-defined).
210 private void createEventDefinitions() {
211 Collection
<EventDeclaration
> eventDecls
= getStreamInputReader().getStreamInput().getStream().getEvents().values();
214 * Create definitions for each event.
216 for (EventDeclaration event
: eventDecls
) {
217 EventDefinition eventDef
= event
.createDefinition(getStreamInputReader());
219 events
.put(event
.getId(), eventDef
);
224 * Changes the current packet to the given one.
226 * @param currentPacket
227 * The index entry of the packet to switch to.
229 public void setCurrentPacket(StreamInputPacketIndexEntry currentPacket
) {
230 this.currentPacket
= currentPacket
;
232 if (this.currentPacket
!= null) {
234 * Change the map of the BitBuffer.
236 MappedByteBuffer bb
= null;
238 bb
= getStreamInputReader().getStreamInput().getFileChannel().map(
239 MapMode
.READ_ONLY
, this.currentPacket
.getOffsetBytes(),
240 (this.currentPacket
.getPacketSizeBits() + 7) / 8);
241 } catch (IOException e
) {
243 * The streamInputReader object is already allocated, so this
244 * shouldn't fail bar some very bad kernel or RAM errors...
249 getBitBuffer().setByteBuffer(bb
);
252 * Read trace packet header.
254 if (getTracePacketHeaderDef() != null) {
255 getTracePacketHeaderDef().read(getBitBuffer());
259 * Read stream packet context.
261 if (getStreamPacketContextDef() != null) {
262 getStreamPacketContextDef().read(getBitBuffer());
267 Definition cpuiddef
= getStreamPacketContextDef().lookupDefinition("cpu_id"); //$NON-NLS-1$
268 if (cpuiddef
instanceof IntegerDefinition
) {
269 currentCpu
= (int) ((IntegerDefinition
) cpuiddef
).getValue();
272 * Read number of lost events
274 Definition lostEventsdef
= getStreamPacketContextDef().lookupDefinition("events_discarded"); //$NON-NLS-1$
275 if (cpuiddef
instanceof IntegerDefinition
) {
276 lostEvents
= (int) ((IntegerDefinition
) lostEventsdef
).getValue();
282 * Use the timestamp begin of the packet as the reference for the
283 * timestamp reconstitution.
285 lastTimestamp
= currentPacket
.getTimestampBegin();
287 getBitBuffer().setByteBuffer(null);
294 * Returns whether it is possible to read any more events from this packet.
296 * @return True if it is possible to read any more events from this packet.
298 public boolean hasMoreEvents() {
299 if (currentPacket
!= null) {
300 return getBitBuffer().position() < currentPacket
.getContentSizeBits();
306 * Reads the next event of the packet into the right event definition.
308 * @return The event definition containing the event data that was just
310 * @throws CTFReaderException
312 public EventDefinition
readNextEvent() throws CTFReaderException
{
313 /* WARNING: This is very LTTng-specific. */
318 if( lostEvents
> lostSoFar
)
320 EventDefinition eventDef
= EventDeclaration
.getLostEventDeclaration().createDefinition(streamInputReader
);
321 eventDef
.setTimestamp(this.lastTimestamp
);
325 StructDefinition sehd
= getStreamEventHeaderDef(); // acronym for a long variable name
326 BitBuffer currentBitBuffer
= getBitBuffer();
328 * Read the stream event header.
332 sehd
.read(currentBitBuffer
);
335 * Check for an event id.
337 EnumDefinition idEnumDef
= (EnumDefinition
) sehd
.lookupDefinition("id"); //$NON-NLS-1$
338 assert (idEnumDef
!= null);
340 eventID
= idEnumDef
.getIntegerValue();
343 * Check for the variant v.
345 VariantDefinition variantDef
= (VariantDefinition
) sehd
.lookupDefinition("v"); //$NON-NLS-1$
346 assert (variantDef
!= null);
349 * Get the variant current field
351 StructDefinition variantCurrentField
= (StructDefinition
) variantDef
.getCurrentField();
352 assert (variantCurrentField
!= null);
355 * Try to get the id field in the current field of the variant. If
356 * it is present, it overrides the previously read event id.
358 IntegerDefinition idIntegerDef
= (IntegerDefinition
) variantCurrentField
.lookupDefinition("id"); //$NON-NLS-1$
359 if (idIntegerDef
!= null) {
360 eventID
= idIntegerDef
.getValue();
366 IntegerDefinition timestampDef
= (IntegerDefinition
) variantCurrentField
.lookupDefinition("timestamp"); //$NON-NLS-1$
367 assert (timestampDef
!= null);
370 * Calculate the event timestamp.
372 timestamp
= calculateTimestamp(timestampDef
);
376 * Read the stream event context.
378 if (getStreamEventContextDef() != null) {
379 getStreamEventContextDef().read(currentBitBuffer
);
383 * Get the right event definition using the event id.
385 EventDefinition eventDef
= events
.get(eventID
);
386 if (eventDef
== null) {
387 throw new CTFReaderException("Incorrect event id : " + eventID
); //$NON-NLS-1$
391 * Read the event context.
393 if (eventDef
.getContext() != null) {
394 eventDef
.getContext().read(currentBitBuffer
);
398 * Read the event fields.
400 if (eventDef
.getFields() != null) {
401 eventDef
.getFields().read(currentBitBuffer
);
405 * Set the event timestamp using the timestamp calculated by
408 eventDef
.setTimestamp(timestamp
);
414 * Calculates the timestamp value of the event, possibly using the timestamp
415 * from the last event.
417 * @param timestampDef
418 * Integer definition of the timestamp.
419 * @return The calculated timestamp value.
421 private long calculateTimestamp(IntegerDefinition timestampDef
) {
424 int len
= timestampDef
.getDeclaration().getLength();
427 * If the timestamp length is 64 bits, it is a full timestamp.
429 if (timestampDef
.getDeclaration().getLength() == 64) {
430 lastTimestamp
= timestampDef
.getValue();
431 return lastTimestamp
;
435 * Bit mask to keep / remove all old / new bits.
437 majorasbitmask
= (1L << len
) - 1;
440 * If the new value is smaller than the corresponding bits of the last
441 * timestamp, we assume an overflow of the compact representation.
443 newval
= timestampDef
.getValue();
444 if (newval
< (lastTimestamp
& majorasbitmask
)) {
445 newval
= newval
+ (1L << len
);
448 /* Keep only the high bits of the old value */
449 lastTimestamp
= lastTimestamp
& ~majorasbitmask
;
451 /* Then add the low bits of the new value */
452 lastTimestamp
= lastTimestamp
+ newval
;
454 return lastTimestamp
;
458 public Definition
lookupDefinition(String lookupPath
) {
459 // TODO Auto-generated method stub
463 public StructDefinition
getStreamEventContextDef() {
464 return this.streamEventContextDef
;
467 public void setStreamEventContextDef(StructDefinition streamEventContextDef
) {
468 this.streamEventContextDef
= streamEventContextDef
;
471 public StructDefinition
getStreamEventHeaderDef() {
472 return this.streamEventHeaderDef
;
475 public void setStreamEventHeaderDef(StructDefinition streamEventHeaderDef
) {
476 this.streamEventHeaderDef
= streamEventHeaderDef
;
479 public void setStreamPacketContextDef(StructDefinition streamPacketContextDef
) {
480 this.streamPacketContextDef
= streamPacketContextDef
;
483 public StructDefinition
getTracePacketHeaderDef() {
484 return this.tracePacketHeaderDef
;
487 public void setTracePacketHeaderDef(StructDefinition tracePacketHeaderDef
) {
488 this.tracePacketHeaderDef
= tracePacketHeaderDef
;
491 public StreamInputReader
getStreamInputReader() {
492 return this.streamInputReader
;
495 public BitBuffer
getBitBuffer() {