1 /*******************************************************************************
2 * Copyright (c) 2011, 2013 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 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.ctf
.core
.trace
;
16 import java
.io
.IOException
;
17 import java
.nio
.MappedByteBuffer
;
18 import java
.nio
.channels
.FileChannel
;
19 import java
.nio
.channels
.FileChannel
.MapMode
;
20 import java
.util
.UUID
;
22 import org
.eclipse
.linuxtools
.ctf
.core
.event
.io
.BitBuffer
;
23 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.ArrayDefinition
;
24 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.Definition
;
25 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.EnumDefinition
;
26 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.FloatDefinition
;
27 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.IDefinitionScope
;
28 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.IntegerDefinition
;
29 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.StringDefinition
;
30 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.StructDefinition
;
31 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.trace
.StreamInputPacketIndex
;
32 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.trace
.StreamInputPacketIndexEntry
;
35 * <b><u>StreamInput</u></b>
37 * Represents a trace file that belongs to a certain stream.
40 public class StreamInput
implements IDefinitionScope
{
42 // ------------------------------------------------------------------------
44 // ------------------------------------------------------------------------
47 * The associated Stream
49 private final Stream stream
;
52 * FileChannel to the trace file
54 private final FileChannel fileChannel
;
57 * Information on the file (used for debugging)
59 private final File file
;
62 * The packet index of this input
64 private final StreamInputPacketIndex index
;
66 private long timestampEnd
;
69 * Definition of trace packet header
71 private StructDefinition tracePacketHeaderDef
= null;
74 * Definition of trace stream packet context
76 private StructDefinition streamPacketContextDef
= null;
79 * Total number of lost events in this stream
81 private long lostSoFar
= 0;
83 // ------------------------------------------------------------------------
85 // ------------------------------------------------------------------------
88 * Constructs a StreamInput.
91 * The stream to which this StreamInput belongs to.
93 * The FileChannel to the trace file.
95 * Information about the trace file (for debugging purposes).
97 public StreamInput(Stream stream
, FileChannel fileChannel
, File file
) {
99 this.fileChannel
= fileChannel
;
101 this.index
= stream
.getTrace().getIndex(this);
104 // ------------------------------------------------------------------------
105 // Getters/Setters/Predicates
106 // ------------------------------------------------------------------------
109 * Gets the stream the streamInput wrapper is wrapping
111 * @return the stream the streamInput wrapper is wrapping
113 public Stream
getStream() {
118 * The common streamInput Index
120 * @return the stream input Index
122 StreamInputPacketIndex
getIndex() {
127 * Gets the filechannel of the streamInput. This is a limited Java
130 * @return the filechannel
132 public FileChannel
getFileChannel() {
137 * Gets the filename of the streamInput file.
139 * @return the filename of the streaminput file.
141 public String
getFilename() {
142 return file
.getName();
146 * Gets the last read timestamp of a stream. (this is not necessarily the
147 * last time in the stream.)
149 * @return the last read timestamp
151 public long getTimestampEnd() {
156 * Sets the last read timestamp of a stream. (this is not necessarily the
157 * last time in the stream.)
159 * @param timestampEnd
160 * the last read timestamp
162 public void setTimestampEnd(long timestampEnd
) {
163 this.timestampEnd
= timestampEnd
;
167 * Useless for streaminputs
170 public String
getPath() {
171 return ""; //$NON-NLS-1$
174 // ------------------------------------------------------------------------
176 // ------------------------------------------------------------------------
179 public Definition
lookupDefinition(String lookupPath
) {
180 /* TODO: lookup in different dynamic scopes is not supported yet. */
185 * Create the index for this trace file.
187 public void setupIndex() {
190 * The BitBuffer to extract data from the StreamInput
192 BitBuffer bitBuffer
= new BitBuffer();
193 bitBuffer
.setByteOrder(this.getStream().getTrace().getByteOrder());
196 * Create the definitions we need to read the packet headers + contexts
198 if (getStream().getTrace().getPacketHeader() != null) {
199 tracePacketHeaderDef
= getStream().getTrace().getPacketHeader()
200 .createDefinition(this, "trace.packet.header"); //$NON-NLS-1$
203 if (getStream().getPacketContextDecl() != null) {
204 streamPacketContextDef
= getStream().getPacketContextDecl()
205 .createDefinition(this, "stream.packet.context"); //$NON-NLS-1$
211 * Adds the next packet header index entry to the index of a stream input.
213 * @warning slow, can corrupt data if not used properly
214 * @return true if there are more packets to add
215 * @throws CTFReaderException
216 * If there was a problem reading the packed header
218 public boolean addPacketHeaderIndex() throws CTFReaderException
{
219 long currentPos
= 0L;
220 if (!index
.getEntries().isEmpty()) {
221 StreamInputPacketIndexEntry pos
= index
.getEntries().lastElement();
222 currentPos
= computeNextOffset(pos
);
224 long fileSize
= getStreamSize();
225 if (currentPos
< fileSize
) {
226 BitBuffer bitBuffer
= new BitBuffer();
227 bitBuffer
.setByteOrder(this.getStream().getTrace().getByteOrder());
228 StreamInputPacketIndexEntry packetIndex
= new StreamInputPacketIndexEntry(
230 createPacketIndexEntry(fileSize
, currentPos
, packetIndex
,
231 tracePacketHeaderDef
, streamPacketContextDef
, bitBuffer
);
232 index
.addEntry(packetIndex
);
238 private long getStreamSize() {
239 return file
.length();
242 private long createPacketIndexEntry(long fileSizeBytes
,
243 long packetOffsetBytes
, StreamInputPacketIndexEntry packetIndex
,
244 StructDefinition tracePacketHeaderDef
,
245 StructDefinition streamPacketContextDef
, BitBuffer bitBuffer
)
246 throws CTFReaderException
{
248 /* Ignoring the return value, but this call is needed to initialize the input */
249 createPacketBitBuffer(fileSizeBytes
, packetOffsetBytes
, packetIndex
, bitBuffer
);
252 * Read the trace packet header if it exists.
254 if (tracePacketHeaderDef
!= null) {
255 parseTracePacketHeader(tracePacketHeaderDef
, bitBuffer
);
259 * Read the stream packet context if it exists.
261 if (streamPacketContextDef
!= null) {
262 parsePacketContext(fileSizeBytes
, streamPacketContextDef
,
263 bitBuffer
, packetIndex
);
265 setPacketContextNull(fileSizeBytes
, packetIndex
);
268 /* Basic validation */
269 if (packetIndex
.getContentSizeBits() > packetIndex
.getPacketSizeBits()) {
270 throw new CTFReaderException("Content size > packet size"); //$NON-NLS-1$
273 if (packetIndex
.getPacketSizeBits() > ((fileSizeBytes
- packetIndex
274 .getOffsetBytes()) * 8)) {
275 throw new CTFReaderException(
276 "Not enough data remaining in the file for the size of this packet"); //$NON-NLS-1$
280 * Offset in the file, in bits
282 packetIndex
.setDataOffsetBits(bitBuffer
.position());
285 * Update the counting packet offset
287 return computeNextOffset(packetIndex
);
294 private static long computeNextOffset(
295 StreamInputPacketIndexEntry packetIndex
) {
296 return packetIndex
.getOffsetBytes()
297 + ((packetIndex
.getPacketSizeBits() + 7) / 8);
301 * @param fileSizeBytes
302 * @param packetOffsetBytes
306 * @throws CTFReaderException
308 private MappedByteBuffer
createPacketBitBuffer(long fileSizeBytes
,
309 long packetOffsetBytes
, StreamInputPacketIndexEntry packetIndex
,
310 BitBuffer bitBuffer
) throws CTFReaderException
{
312 * Initial size, it should map at least the packet header + context
315 * TODO: use a less arbitrary size.
319 * If there is less data remaining than what we want to map, reduce the
322 if ((fileSizeBytes
- packetIndex
.getOffsetBytes()) < mapSize
) {
323 mapSize
= fileSizeBytes
- packetIndex
.getOffsetBytes();
332 bb
= fileChannel
.map(MapMode
.READ_ONLY
, packetOffsetBytes
, mapSize
);
333 } catch (IOException e
) {
334 throw new CTFReaderException(e
);
336 bitBuffer
.setByteBuffer(bb
);
340 private void parseTracePacketHeader(StructDefinition tracePacketHeaderDef
,
341 BitBuffer bitBuffer
) throws CTFReaderException
{
342 tracePacketHeaderDef
.read(bitBuffer
);
345 * Check the CTF magic number
347 IntegerDefinition magicDef
= (IntegerDefinition
) tracePacketHeaderDef
348 .lookupDefinition("magic"); //$NON-NLS-1$
349 if (magicDef
!= null) {
350 int magic
= (int) magicDef
.getValue();
351 if (magic
!= Utils
.CTF_MAGIC
) {
352 throw new CTFReaderException(
353 "CTF magic mismatch " + Integer
.toHexString(magic
) + " vs " + Integer
.toHexString(Utils
.CTF_MAGIC
)); //$NON-NLS-1$//$NON-NLS-2$
358 * Check the trace UUID
360 ArrayDefinition uuidDef
=
361 (ArrayDefinition
) tracePacketHeaderDef
.lookupDefinition("uuid"); //$NON-NLS-1$
362 if (uuidDef
!= null) {
363 byte[] uuidArray
= new byte[16];
365 for (int i
= 0; i
< uuidArray
.length
; i
++) {
366 IntegerDefinition uuidByteDef
= (IntegerDefinition
) uuidDef
.getElem(i
);
367 uuidArray
[i
] = (byte) uuidByteDef
.getValue();
370 UUID uuid
= Utils
.makeUUID(uuidArray
);
372 if (!getStream().getTrace().getUUID().equals(uuid
)) {
373 throw new CTFReaderException("UUID mismatch"); //$NON-NLS-1$
378 * Check that the stream id did not change
380 IntegerDefinition streamIDDef
= (IntegerDefinition
) tracePacketHeaderDef
381 .lookupDefinition("stream_id"); //$NON-NLS-1$
382 if (streamIDDef
!= null) {
383 long streamID
= streamIDDef
.getValue();
385 if (streamID
!= getStream().getId()) {
386 throw new CTFReaderException(
387 "Stream ID changing within a StreamInput"); //$NON-NLS-1$
392 private static void setPacketContextNull(long fileSizeBytes
,
393 StreamInputPacketIndexEntry packetIndex
) {
395 * If there is no packet context, infer the content and packet size from
396 * the file size (assume that there is only one packet and no padding)
398 packetIndex
.setContentSizeBits(fileSizeBytes
* 8);
399 packetIndex
.setPacketSizeBits(fileSizeBytes
* 8);
402 private void parsePacketContext(long fileSizeBytes
,
403 StructDefinition streamPacketContextDef
, BitBuffer bitBuffer
,
404 StreamInputPacketIndexEntry packetIndex
) {
405 streamPacketContextDef
.read(bitBuffer
);
407 for (String field
: streamPacketContextDef
.getDeclaration()
409 Definition id
= streamPacketContextDef
.lookupDefinition(field
);
410 if (id
instanceof IntegerDefinition
) {
411 packetIndex
.addAttribute(field
,
412 ((IntegerDefinition
) id
).getValue());
413 } else if (id
instanceof FloatDefinition
) {
414 packetIndex
.addAttribute(field
,
415 ((FloatDefinition
) id
).getValue());
416 } else if (id
instanceof EnumDefinition
) {
417 packetIndex
.addAttribute(field
,
418 ((EnumDefinition
) id
).getValue());
419 } else if (id
instanceof StringDefinition
) {
420 packetIndex
.addAttribute(field
,
421 ((StringDefinition
) id
).getValue());
425 Long contentSize
= (Long
) packetIndex
.lookupAttribute("content_size"); //$NON-NLS-1$
426 Long packetSize
= (Long
) packetIndex
.lookupAttribute("packet_size"); //$NON-NLS-1$
427 Long tsBegin
= (Long
) packetIndex
.lookupAttribute("timestamp_begin"); //$NON-NLS-1$
428 Long tsEnd
= (Long
) packetIndex
.lookupAttribute("timestamp_end"); //$NON-NLS-1$
429 String device
= (String
) packetIndex
.lookupAttribute("device"); //$NON-NLS-1$
431 Long cpuId
= (Long
) packetIndex
.lookupAttribute("cpu_id"); //$NON-NLS-1$
432 Long lostEvents
= (Long
) packetIndex
.lookupAttribute("events_discarded"); //$NON-NLS-1$
434 /* Read the content size in bits */
435 if (contentSize
!= null) {
436 packetIndex
.setContentSizeBits(contentSize
.intValue());
438 packetIndex
.setContentSizeBits((int) (fileSizeBytes
* 8));
441 /* Read the packet size in bits */
442 if (packetSize
!= null) {
443 packetIndex
.setPacketSizeBits(packetSize
.intValue());
445 if (packetIndex
.getContentSizeBits() != 0) {
446 packetIndex
.setPacketSizeBits(packetIndex
.getContentSizeBits());
448 packetIndex
.setPacketSizeBits((int) (fileSizeBytes
* 8));
452 /* Read the begin timestamp */
453 if (tsBegin
!= null) {
454 packetIndex
.setTimestampBegin(tsBegin
.longValue());
457 /* Read the end timestamp */
460 tsEnd
= Long
.MAX_VALUE
;
462 packetIndex
.setTimestampEnd(tsEnd
.longValue());
463 setTimestampEnd(packetIndex
.getTimestampEnd());
466 if (device
!= null) {
467 packetIndex
.setTarget(device
);
471 packetIndex
.setTarget("CPU" + cpuId
.toString()); //$NON-NLS-1$
474 if (lostEvents
!= null) {
475 packetIndex
.setLostEvents(lostEvents
- lostSoFar
);
476 this.lostSoFar
= lostEvents
;
481 public int hashCode() {
482 final int prime
= 31;
484 result
= (prime
* result
) + ((file
== null) ?
0 : file
.hashCode());
489 public boolean equals(Object obj
) {
496 if (!(obj
instanceof StreamInput
)) {
499 StreamInput other
= (StreamInput
) obj
;
501 if (other
.file
!= null) {
504 } else if (!file
.equals(other
.file
)) {