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
10 * Matthew Khouzam - Initial API and implementation
11 * Alexandre Montplaisir - Initial API and implementation
12 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.ctf
.core
.trace
;
17 import java
.io
.FileFilter
;
18 import java
.io
.FileInputStream
;
19 import java
.io
.IOException
;
20 import java
.io
.Serializable
;
21 import java
.nio
.ByteOrder
;
22 import java
.nio
.MappedByteBuffer
;
23 import java
.nio
.channels
.FileChannel
;
24 import java
.nio
.channels
.FileChannel
.MapMode
;
25 import java
.util
.Arrays
;
26 import java
.util
.Collections
;
27 import java
.util
.Comparator
;
28 import java
.util
.HashMap
;
29 import java
.util
.Iterator
;
30 import java
.util
.LinkedList
;
31 import java
.util
.List
;
32 import java
.util
.ListIterator
;
34 import java
.util
.Map
.Entry
;
36 import java
.util
.TreeSet
;
37 import java
.util
.UUID
;
39 import org
.eclipse
.linuxtools
.ctf
.core
.event
.CTFCallsite
;
40 import org
.eclipse
.linuxtools
.ctf
.core
.event
.CTFClock
;
41 import org
.eclipse
.linuxtools
.ctf
.core
.event
.EventDefinition
;
42 import org
.eclipse
.linuxtools
.ctf
.core
.event
.IEventDeclaration
;
43 import org
.eclipse
.linuxtools
.ctf
.core
.event
.io
.BitBuffer
;
44 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.ArrayDefinition
;
45 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.Definition
;
46 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.IDefinitionScope
;
47 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.IntegerDefinition
;
48 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.StructDeclaration
;
49 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.StructDefinition
;
50 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.metadata
.exceptions
.ParseException
;
51 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.trace
.StreamInputPacketIndex
;
54 * A CTF trace on the file system.
56 * Represents a trace on the filesystem. It is responsible of parsing the
57 * metadata, creating declarations data structures, indexing the event packets
58 * (in other words, all the work that can be shared between readers), but the
59 * actual reading of events is left to TraceReader.
61 * @author Matthew Khouzam
62 * @version $Revision: 1.0 $
64 public class CTFTrace
implements IDefinitionScope
{
66 @SuppressWarnings("nls")
68 public String
toString() {
69 /* Only for debugging, shouldn't be externalized */
70 return "CTFTrace [path=" + path
+ ", major=" + major
+ ", minor="
71 + minor
+ ", uuid=" + uuid
+ "]";
75 * The trace directory on the filesystem.
77 private final File path
;
80 * The metadata parsing object.
82 private final Metadata metadata
;
85 * Major CTF version number
90 * Minor CTF version number
102 private ByteOrder byteOrder
;
105 * Packet header structure declaration
107 private StructDeclaration packetHeaderDecl
= null;
110 * The clock of the trace
112 private CTFClock singleClock
;
115 * Packet header structure definition
117 * This is only used when opening the trace files, to read the first packet
118 * header and see if they are valid trace files.
120 private StructDefinition packetHeaderDef
;
123 * Collection of streams contained in the trace.
125 private final Map
<Long
, Stream
> streams
= new HashMap
<Long
, Stream
>();
128 * Collection of environment variables set by the tracer
130 private final Map
<String
, String
> environment
= new HashMap
<String
, String
>();
133 * Collection of all the clocks in a system.
135 private final Map
<String
, CTFClock
> clocks
= new HashMap
<String
, CTFClock
>();
137 /** FileInputStreams to the streams */
138 private final List
<FileInputStream
> fileInputStreams
= new LinkedList
<FileInputStream
>();
140 /** Handlers for the metadata files */
141 private final static FileFilter metadataFileFilter
= new MetadataFileFilter();
142 private final static Comparator
<File
> metadataComparator
= new MetadataComparator(); // $codepro.audit.disable
145 /** map of all the event types */
146 private final Map
<Long
,HashMap
<Long
, IEventDeclaration
>> eventDecs
= new HashMap
<Long
, HashMap
<Long
,IEventDeclaration
>>();
147 /** map of all the event types */
148 private final Map
<StreamInput
,HashMap
<Long
, EventDefinition
>> eventDefs
= new HashMap
<StreamInput
, HashMap
<Long
,EventDefinition
>>();
149 /** map of all the indexes */
150 private final Map
<StreamInput
, StreamInputPacketIndex
> indexes
= new HashMap
<StreamInput
, StreamInputPacketIndex
>();
152 /** Callsite helpers */
153 private Map
<String
, LinkedList
<CTFCallsite
>> callsitesByName
= new HashMap
<String
, LinkedList
<CTFCallsite
>>();
154 /** Callsite helpers */
155 private TreeSet
<CTFCallsite
> callsitesByIP
= new TreeSet
<CTFCallsite
>();
159 // ------------------------------------------------------------------------
161 // ------------------------------------------------------------------------
167 * Filesystem path of the trace directory
168 * @throws CTFReaderException
169 * If no CTF trace was found at the path
171 public CTFTrace(String path
) throws CTFReaderException
{
172 this(new File(path
));
180 * Filesystem path of the trace directory.
181 * @throws CTFReaderException
182 * If no CTF trace was found at the path
184 public CTFTrace(File path
) throws CTFReaderException
{
186 this.metadata
= new Metadata(this);
188 /* Set up the internal containers for this trace */
189 if (!this.path
.exists()) {
190 throw new CTFReaderException("Trace (" + path
.getPath() + ") doesn't exist. Deleted or moved?"); //$NON-NLS-1$ //$NON-NLS-2$
193 if (!this.path
.isDirectory()) {
194 throw new CTFReaderException("Path must be a valid directory"); //$NON-NLS-1$
197 /* Open and parse the metadata file */
200 /* Open all the trace files */
201 /* Create the definitions needed to read things from the files */
202 if (packetHeaderDecl
!= null) {
203 packetHeaderDef
= packetHeaderDecl
.createDefinition(this,
204 "packet.header"); //$NON-NLS-1$
207 /* List files not called metadata and not hidden. */
208 File
[] files
= path
.listFiles(metadataFileFilter
);
209 Arrays
.sort(files
, metadataComparator
);
210 /* Try to open each file */
211 for (File streamFile
: files
) {
212 openStreamInput(streamFile
);
215 /* Create their index */
216 for (Map
.Entry
<Long
, Stream
> stream
: streams
.entrySet()) {
217 Set
<StreamInput
> inputs
= stream
.getValue().getStreamInputs();
218 for (StreamInput s
: inputs
) {
222 Iterator
<Entry
<Long
, IEventDeclaration
>> it
= s
.getStream()
223 .getEvents().entrySet().iterator();
224 while (it
.hasNext()) {
225 Entry
<Long
, IEventDeclaration
> pairs
= it
.next();
226 Long eventNum
= pairs
.getKey();
227 IEventDeclaration eventDec
= pairs
.getValue();
228 getEvents(s
.getStream().getId()).put(eventNum
, eventDec
);
243 public void dispose() {
244 for (FileInputStream fis
: fileInputStreams
) {
248 } catch (IOException e
) {
249 // do nothing it's ok, we tried to close it.
253 System
.gc(); // Invoke GC to release MappedByteBuffer objects (Java bug JDK-4724038)
256 // ------------------------------------------------------------------------
257 // Getters/Setters/Predicates
258 // ------------------------------------------------------------------------
261 * Gets an event declaration hash map for a given streamID
264 * The ID of the stream from which to read
265 * @return The Hash map with the event declarations
267 public HashMap
<Long
, IEventDeclaration
> getEvents(Long streamId
) {
268 return eventDecs
.get(streamId
);
272 * Gets an index for a given StreamInput
273 * @param id the StreamInput
276 StreamInputPacketIndex
getIndex(StreamInput id
){
277 if(! indexes
.containsKey(id
)){
278 indexes
.put(id
, new StreamInputPacketIndex());
280 return indexes
.get(id
);
284 * Gets an event Declaration hashmap for a given StreamInput
285 * @param id the StreamInput
286 * @return the hashmap with the event definitions
289 public HashMap
<Long
, EventDefinition
> getEventDefs(StreamInput id
) {
290 if(! eventDefs
.containsKey(id
)){
291 eventDefs
.put(id
, new HashMap
<Long
, EventDefinition
>());
293 return eventDefs
.get(id
);
297 * Get an event by it's ID
300 * The ID of the stream from which to read
302 * the ID of the event
303 * @return the event declaration
306 public IEventDeclaration
getEventType(long streamId
, long id
) {
307 return getEvents(streamId
).get(id
);
311 * Method getStream gets the stream for a given id
314 * Long the id of the stream
315 * @return Stream the stream that we need
318 public Stream
getStream(Long id
) {
319 return streams
.get(id
);
323 * Method nbStreams gets the number of available streams
325 * @return int the number of streams
327 public int nbStreams() {
328 return streams
.size();
332 * Method setMajor sets the major version of the trace (DO NOT USE)
335 * long the major version
337 public void setMajor(long major
) {
342 * Method setMinor sets the minor version of the trace (DO NOT USE)
345 * long the minor version
347 public void setMinor(long minor
) {
352 * Method setUUID sets the UUID of a trace
357 public void setUUID(UUID uuid
) {
362 * Method setByteOrder sets the byte order
365 * ByteOrder of the trace, can be little-endian or big-endian
367 public void setByteOrder(ByteOrder byteOrder
) {
368 this.byteOrder
= byteOrder
;
372 * Method setPacketHeader sets the packet header of a trace (DO NOT USE)
374 * @param packetHeader
375 * StructDeclaration the header in structdeclaration form
377 public void setPacketHeader(StructDeclaration packetHeader
) {
378 this.packetHeaderDecl
= packetHeader
;
382 * Method majortIsSet is the major version number set?
384 * @return boolean is the major set?
386 public boolean majortIsSet() {
387 return major
!= null;
391 * Method minorIsSet. is the minor version number set?
393 * @return boolean is the minor set?
395 public boolean minorIsSet() {
396 return minor
!= null;
400 * Method UUIDIsSet is the UUID set?
402 * @return boolean is the UUID set?
404 public boolean UUIDIsSet() {
409 * Method byteOrderIsSet is the byteorder set?
411 * @return boolean is the byteorder set?
413 public boolean byteOrderIsSet() {
414 return byteOrder
!= null;
418 * Method packetHeaderIsSet is the packet header set?
420 * @return boolean is the packet header set?
422 public boolean packetHeaderIsSet() {
423 return packetHeaderDecl
!= null;
427 * Method getUUID gets the trace UUID
429 * @return UUID gets the trace UUID
431 public UUID
getUUID() {
436 * Method getMajor gets the trace major version
438 * @return long gets the trace major version
440 public long getMajor() {
445 * Method getMinor gets the trace minor version
447 * @return long gets the trace minor version
449 public long getMinor() {
454 * Method getByteOrder gets the trace byte order
456 * @return ByteOrder gets the trace byte order
458 public ByteOrder
getByteOrder() {
463 * Method getPacketHeader gets the trace packet header
465 * @return StructDeclaration gets the trace packet header
467 public StructDeclaration
getPacketHeader() {
468 return packetHeaderDecl
;
472 * Method getTraceDirectory gets the trace directory
474 * @return File the path in "File" format.
476 public File
getTraceDirectory() {
481 * Method getStreams get all the streams in a map format.
483 * @return Map<Long,Stream> a map of all the streams.
485 public Map
<Long
, Stream
> getStreams() {
490 * Method getPath gets the path of the trace directory
492 * @return String the path of the trace directory, in string format.
493 * @see java.io.File#getPath()
496 public String
getPath() {
497 return path
.getPath();
500 // ------------------------------------------------------------------------
502 // ------------------------------------------------------------------------
505 * Tries to open the given file, reads the first packet header of the file
506 * and check its validity.
509 * A trace file in the trace directory.
511 * Which index in the class' streamFileChannel array this file
513 * @throws CTFReaderException
515 private void openStreamInput(File streamFile
) throws CTFReaderException
{
516 MappedByteBuffer byteBuffer
;
517 BitBuffer streamBitBuffer
;
521 if (!streamFile
.canRead()) {
522 throw new CTFReaderException("Unreadable file : " //$NON-NLS-1$
523 + streamFile
.getPath());
527 /* Open the file and get the FileChannel */
528 FileInputStream fis
= new FileInputStream(streamFile
);
529 fileInputStreams
.add(fis
);
530 fc
= fis
.getChannel();
532 /* Map one memory page of 4 kiB */
533 byteBuffer
= fc
.map(MapMode
.READ_ONLY
, 0, Math
.min((int)fc
.size(), 4096));
534 } catch (IOException e
) {
535 /* Shouldn't happen at this stage if every other check passed */
536 throw new CTFReaderException();
539 /* Create a BitBuffer with this mapping and the trace byte order */
540 streamBitBuffer
= new BitBuffer(byteBuffer
, this.getByteOrder());
542 if (packetHeaderDef
!= null) {
543 /* Read the packet header */
544 packetHeaderDef
.read(streamBitBuffer
);
546 /* Check the magic number */
547 IntegerDefinition magicDef
= (IntegerDefinition
) packetHeaderDef
548 .lookupDefinition("magic"); //$NON-NLS-1$
549 int magic
= (int) magicDef
.getValue();
550 if (magic
!= Utils
.CTF_MAGIC
) {
551 throw new CTFReaderException("CTF magic mismatch"); //$NON-NLS-1$
555 ArrayDefinition uuidDef
= (ArrayDefinition
) packetHeaderDef
556 .lookupDefinition("uuid"); //$NON-NLS-1$
557 if (uuidDef
!= null) {
558 byte[] uuidArray
= new byte[Utils
.UUID_LEN
];
560 for (int i
= 0; i
< Utils
.UUID_LEN
; i
++) {
561 IntegerDefinition uuidByteDef
= (IntegerDefinition
) uuidDef
563 uuidArray
[i
] = (byte) uuidByteDef
.getValue();
566 UUID otheruuid
= Utils
.makeUUID(uuidArray
);
568 if (!this.uuid
.equals(otheruuid
)) {
569 throw new CTFReaderException("UUID mismatch"); //$NON-NLS-1$
573 /* Read the stream ID */
574 Definition streamIDDef
= packetHeaderDef
.lookupDefinition("stream_id"); //$NON-NLS-1$
576 if (streamIDDef
instanceof IntegerDefinition
) { //this doubles as a null check
577 long streamID
= ((IntegerDefinition
) streamIDDef
).getValue();
578 stream
= streams
.get(streamID
);
580 /* No stream_id in the packet header */
581 stream
= streams
.get(null);
585 /* No packet header, we suppose there is only one stream */
586 stream
= streams
.get(null);
589 if (stream
== null) {
590 throw new CTFReaderException("Unexpected end of stream"); //$NON-NLS-1$
593 /* Create the stream input */
594 StreamInput streamInput
= new StreamInput(stream
, fc
, streamFile
);
596 /* Add a reference to the streamInput in the stream */
597 stream
.addInput(streamInput
);
601 * Looks up a definition from packet
606 * @see org.eclipse.linuxtools.ctf.core.event.types.IDefinitionScope#lookupDefinition(String)
609 public Definition
lookupDefinition(String lookupPath
) {
610 if (lookupPath
.equals("trace.packet.header")) { //$NON-NLS-1$
611 return packetHeaderDef
;
617 * Adds a new stream to the trace.
621 * @throws ParseException
622 * If there was some problem reading the metadata
625 public void addStream(Stream stream
) throws ParseException
{
628 * If there is already a stream without id (the null key), it must be
631 if (streams
.get(null) != null) {
632 throw new ParseException("Stream without id with multiple streams"); //$NON-NLS-1$
636 * If the stream we try to add has the null key, it must be the only
637 * one. Thus, if the streams container is not empty, it is not valid.
639 if ((stream
.getId() == null) && (streams
.size() != 0)) {
640 throw new ParseException("Stream without id with multiple streams"); //$NON-NLS-1$
643 /* If a stream with the same ID already exists, it is not valid. */
644 if (streams
.get(stream
.getId()) != null) {
645 throw new ParseException("Stream id already exists"); //$NON-NLS-1$
648 /* It should be ok now. */
649 streams
.put(stream
.getId(), stream
);
650 eventDecs
.put(stream
.getId(), new HashMap
<Long
,IEventDeclaration
>());
654 * gets the Environment variables from the trace metadata (See CTF spec)
655 * @return the environment variables in a map form (key value)
658 public Map
<String
, String
> getEnvironment() {
663 * Look up a specific environment variable
664 * @param key the key to look for
665 * @return the value of the variable, can be null.
667 public String
lookupEnvironment(String key
) {
668 return environment
.get(key
);
672 * Add a variable to the environment variables
673 * @param varName the name of the variable
674 * @param varValue the value of the variable
676 public void addEnvironmentVar(String varName
, String varValue
) {
677 environment
.put(varName
, varValue
);
681 * Add a clock to the clock list
682 * @param nameValue the name of the clock (full name with scope)
683 * @param ctfClock the clock
685 public void addClock(String nameValue
, CTFClock ctfClock
) {
686 clocks
.put(nameValue
, ctfClock
);
690 * gets the clock with a specific name
691 * @param name the name of the clock.
694 public CTFClock
getClock(String name
) {
695 return clocks
.get(name
);
702 * gets the clock if there is only one. (this is 100% of the use cases as of
707 public final CTFClock
getClock() {
708 if (clocks
.size() == 1) {
709 singleClock
= clocks
.get(clocks
.keySet().iterator().next());
716 * gets the time offset of a clock with respect to UTC in nanoseconds
718 * @return the time offset of a clock with respect to UTC in nanoseconds
720 public final long getOffset() {
721 if (getClock() == null) {
724 return singleClock
.getClockOffset();
728 * gets the time offset of a clock with respect to UTC in nanoseconds
730 * @return the time offset of a clock with respect to UTC in nanoseconds
732 private final double getTimeScale() {
733 if (getClock() == null) {
736 return singleClock
.getClockScale();
740 * Does the trace need to time scale?
742 * @return if the trace is in ns or cycles.
744 private final boolean clockNeedsScale() {
745 if (getClock() == null) {
748 return singleClock
.isClockScaled();
752 * the inverse clock for returning to a scale.
754 * @return 1.0 / scale
756 private final double getInverseTimeScale() {
757 if (getClock() == null) {
760 return singleClock
.getClockAntiScale();
765 * clock cycles since boot
766 * @return time in nanoseconds UTC offset
769 public long timestampCyclesToNanos(long cycles
) {
770 long retVal
= cycles
+ getOffset();
772 * this fix is since quite often the offset will be > than 53 bits and
773 * therefore the conversion will be lossy
775 if (clockNeedsScale()) {
776 retVal
= (long) (retVal
* getTimeScale());
783 * time in nanoseconds UTC offset
784 * @return clock cycles since boot.
787 public long timestampNanoToCycles(long nanos
) {
790 * this fix is since quite often the offset will be > than 53 bits and
791 * therefore the conversion will be lossy
793 if (clockNeedsScale()) {
794 retVal
= (long) (nanos
* getInverseTimeScale());
798 return retVal
- getOffset();
802 * Does a given stream contain any events?
803 * @param id the stream ID
804 * @return true if the stream has events.
806 public boolean hasEvents(Long id
){
807 return eventDecs
.containsKey(id
);
811 * Add an event declaration map to the events map.
812 * @param id the id of a stream
813 * @return the hashmap containing events.
815 public HashMap
<Long
, IEventDeclaration
> createEvents(Long id
){
816 HashMap
<Long
, IEventDeclaration
> value
= eventDecs
.get(id
);
817 if( value
== null ) {
818 value
= new HashMap
<Long
, IEventDeclaration
>();
819 eventDecs
.put(id
, value
);
828 * the event name of the callsite
830 * the name of the callsite function
832 * the ip of the callsite
834 * the filename of the callsite
836 * the line number of the callsite
838 public void addCallsite(String eventName
, String funcName
, long ip
,
839 String fileName
, long lineNumber
) {
840 final CTFCallsite cs
= new CTFCallsite(eventName
, funcName
, ip
,
841 fileName
, lineNumber
);
842 LinkedList
<CTFCallsite
> csl
= callsitesByName
.get(eventName
);
844 csl
= new LinkedList
<CTFCallsite
>();
845 callsitesByName
.put(eventName
, csl
);
848 ListIterator
<CTFCallsite
> iter
= csl
.listIterator();
850 for (; index
< csl
.size(); index
++) {
851 if (iter
.next().compareTo(cs
) < 0) {
858 callsitesByIP
.add(cs
);
862 * Gets the list of callsites associated to an event name. O(1)
866 * @return the callsite list can be empty
869 public List
<CTFCallsite
> getCallsiteCandidates(String eventName
) {
870 LinkedList
<CTFCallsite
> retVal
= callsitesByName
.get(eventName
);
871 if( retVal
== null ) {
872 retVal
= new LinkedList
<CTFCallsite
>();
878 * The I'm feeling lucky of getCallsiteCandidates O(1)
882 * @return the first callsite that has that event name, can be null
885 public CTFCallsite
getCallsite(String eventName
) {
886 LinkedList
<CTFCallsite
> callsites
= callsitesByName
.get(eventName
);
887 if (callsites
!= null) {
888 return callsites
.getFirst();
894 * Gets a callsite from the instruction pointer O(log(n))
897 * the instruction pointer to lookup
898 * @return the callsite just before that IP in the list remember the IP is
899 * backwards on X86, can be null if no callsite is before the IP.
902 public CTFCallsite
getCallsite(long ip
) {
903 CTFCallsite cs
= new CTFCallsite(null, null, ip
, null, 0L);
904 return callsitesByIP
.ceiling(cs
);
908 * Gets a callsite using the event name and instruction pointer O(log(n))
911 * the name of the event
913 * the instruction pointer
914 * @return the closest matching callsite, can be null
916 public CTFCallsite
getCallsite(String eventName
, long ip
) {
917 final LinkedList
<CTFCallsite
> candidates
= callsitesByName
.get(eventName
);
918 final CTFCallsite dummyCs
= new CTFCallsite(null, null, ip
, null, -1);
919 final int pos
= Collections
.binarySearch(candidates
, dummyCs
)+1;
920 if( pos
>= candidates
.size()) {
923 return candidates
.get(pos
);
928 class MetadataFileFilter
implements FileFilter
{
931 public boolean accept(File pathname
) {
932 if (pathname
.isDirectory()) {
935 if (pathname
.isHidden()) {
938 if (pathname
.getName().equals("metadata")) { //$NON-NLS-1$
946 class MetadataComparator
implements Comparator
<File
>, Serializable
{
948 private static final long serialVersionUID
= 1L;
951 public int compare(File o1
, File o2
) {
952 return o1
.getName().compareTo(o2
.getName());