1 /*******************************************************************************
2 * Copyright (c) 2011, 2014 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 * Simon Delisle - Replace LinkedList by TreeSet in callsitesByName attribute
13 *******************************************************************************/
15 package org
.eclipse
.linuxtools
.ctf
.core
.trace
;
18 import java
.io
.FileFilter
;
19 import java
.io
.FileInputStream
;
20 import java
.io
.IOException
;
21 import java
.io
.Serializable
;
22 import java
.nio
.ByteOrder
;
23 import java
.nio
.MappedByteBuffer
;
24 import java
.nio
.channels
.FileChannel
;
25 import java
.nio
.channels
.FileChannel
.MapMode
;
26 import java
.util
.Arrays
;
27 import java
.util
.Collections
;
28 import java
.util
.Comparator
;
29 import java
.util
.HashMap
;
30 import java
.util
.Iterator
;
31 import java
.util
.LinkedList
;
32 import java
.util
.List
;
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
.CTFCallsiteComparator
;
51 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.metadata
.exceptions
.ParseException
;
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
, AutoCloseable
{
66 @SuppressWarnings("nls")
68 public String
toString() {
69 /* Only for debugging, shouldn't be externalized */
70 return "CTFTrace [path=" + fPath
+ ", major=" + fMajor
+ ", minor="
71 + fMinor
+ ", uuid=" + fUuid
+ "]";
75 * The trace directory on the filesystem.
77 private final File fPath
;
80 * Major CTF version number
85 * Minor CTF version number
97 private ByteOrder fByteOrder
;
100 * Packet header structure declaration
102 private StructDeclaration fPacketHeaderDecl
= null;
105 * The clock of the trace
107 private CTFClock fSingleClock
;
110 * Packet header structure definition
112 * This is only used when opening the trace files, to read the first packet
113 * header and see if they are valid trace files.
115 private StructDefinition fPacketHeaderDef
;
118 * Collection of streams contained in the trace.
120 private final Map
<Long
, Stream
> fStreams
= new HashMap
<>();
123 * Collection of environment variables set by the tracer
125 private final Map
<String
, String
> fEnvironment
= new HashMap
<>();
128 * Collection of all the clocks in a system.
130 private final Map
<String
, CTFClock
> fClocks
= new HashMap
<>();
132 /** FileInputStreams to the streams */
133 private final List
<FileInputStream
> fFileInputStreams
= new LinkedList
<>();
135 /** Handlers for the metadata files */
136 private static final FileFilter METADATA_FILE_FILTER
= new MetadataFileFilter();
137 private static final Comparator
<File
> METADATA_COMPARATOR
= new MetadataComparator();
139 /** Callsite helpers */
140 private CTFCallsiteComparator fCtfCallsiteComparator
= new CTFCallsiteComparator();
142 private Map
<String
, TreeSet
<CTFCallsite
>> fCallsitesByName
= new HashMap
<>();
144 /** Callsite helpers */
145 private TreeSet
<CTFCallsite
> fCallsitesByIP
= new TreeSet
<>();
147 // ------------------------------------------------------------------------
149 // ------------------------------------------------------------------------
155 * Filesystem path of the trace directory
156 * @throws CTFReaderException
157 * If no CTF trace was found at the path
159 public CTFTrace(String path
) throws CTFReaderException
{
160 this(new File(path
));
168 * Filesystem path of the trace directory.
169 * @throws CTFReaderException
170 * If no CTF trace was found at the path
172 public CTFTrace(File path
) throws CTFReaderException
{
174 final Metadata metadata
= new Metadata(this);
176 /* Set up the internal containers for this trace */
177 if (!fPath
.exists()) {
178 throw new CTFReaderException("Trace (" + path
.getPath() + ") doesn't exist. Deleted or moved?"); //$NON-NLS-1$ //$NON-NLS-2$
181 if (!fPath
.isDirectory()) {
182 throw new CTFReaderException("Path must be a valid directory"); //$NON-NLS-1$
185 /* Open and parse the metadata file */
186 metadata
.parseFile();
192 * Streamed constructor
201 private void init() {
202 /* Create the definitions needed to read things from the files */
203 if (fPacketHeaderDecl
!= null) {
204 fPacketHeaderDef
= fPacketHeaderDecl
.createDefinition(this, "packet.header"); //$NON-NLS-1$
208 private void init(File path
) throws CTFReaderException
{
212 /* Open all the trace files */
214 /* List files not called metadata and not hidden. */
215 File
[] files
= path
.listFiles(METADATA_FILE_FILTER
);
216 Arrays
.sort(files
, METADATA_COMPARATOR
);
218 /* Try to open each file */
219 for (File streamFile
: files
) {
220 openStreamInput(streamFile
);
223 /* Create their index */
224 for (Stream stream
: getStreams()) {
225 Set
<StreamInput
> inputs
= stream
.getStreamInputs();
226 for (StreamInput s
: inputs
) {
238 public void close() {
239 for (FileInputStream fis
: fFileInputStreams
) {
243 } catch (IOException e
) {
244 // do nothing it's ok, we tried to close it.
248 // Invoke GC to release MappedByteBuffer objects (Java bug JDK-4724038)
252 // ------------------------------------------------------------------------
253 // Getters/Setters/Predicates
254 // ------------------------------------------------------------------------
257 * Gets an event declaration hash map for a given streamID
260 * The ID of the stream from which to read
261 * @return The Hash map with the event declarations
264 public Map
<Long
, IEventDeclaration
> getEvents(Long streamId
) {
265 return fStreams
.get(streamId
).getEvents();
269 * Gets an event Declaration hashmap for a given StreamInput
273 * @return an empty hashmap, please see deprecated
275 * @deprecated You should be using
276 * {@link StreamInputReader#getEventDefinitions()} instead.
279 public Map
<Long
, EventDefinition
> getEventDefs(StreamInput id
) {
280 return new HashMap
<>();
284 * Get an event by it's ID
287 * The ID of the stream from which to read
289 * the ID of the event
290 * @return the event declaration
293 public IEventDeclaration
getEventType(long streamId
, long id
) {
294 return getEvents(streamId
).get(id
);
298 * Method getStream gets the stream for a given id
301 * Long the id of the stream
302 * @return Stream the stream that we need
305 public Stream
getStream(Long id
) {
306 return fStreams
.get(id
);
310 * Method nbStreams gets the number of available streams
312 * @return int the number of streams
314 public int nbStreams() {
315 return fStreams
.size();
319 * Method setMajor sets the major version of the trace (DO NOT USE)
322 * long the major version
324 public void setMajor(long major
) {
329 * Method setMinor sets the minor version of the trace (DO NOT USE)
332 * long the minor version
334 public void setMinor(long minor
) {
339 * Method setUUID sets the UUID of a trace
344 public void setUUID(UUID uuid
) {
349 * Method setByteOrder sets the byte order
352 * ByteOrder of the trace, can be little-endian or big-endian
354 public void setByteOrder(ByteOrder byteOrder
) {
355 fByteOrder
= byteOrder
;
359 * Method setPacketHeader sets the packet header of a trace (DO NOT USE)
361 * @param packetHeader
362 * StructDeclaration the header in structdeclaration form
364 public void setPacketHeader(StructDeclaration packetHeader
) {
365 fPacketHeaderDecl
= packetHeader
;
369 * Method majorIsSet is the major version number set?
371 * @return boolean is the major set?
374 public boolean majorIsSet() {
375 return fMajor
!= null;
379 * Method minorIsSet. is the minor version number set?
381 * @return boolean is the minor set?
383 public boolean minorIsSet() {
384 return fMinor
!= null;
388 * Method UUIDIsSet is the UUID set?
390 * @return boolean is the UUID set?
393 public boolean uuidIsSet() {
394 return fUuid
!= null;
398 * Method byteOrderIsSet is the byteorder set?
400 * @return boolean is the byteorder set?
402 public boolean byteOrderIsSet() {
403 return fByteOrder
!= null;
407 * Method packetHeaderIsSet is the packet header set?
409 * @return boolean is the packet header set?
411 public boolean packetHeaderIsSet() {
412 return fPacketHeaderDecl
!= null;
416 * Method getUUID gets the trace UUID
418 * @return UUID gets the trace UUID
420 public UUID
getUUID() {
425 * Method getMajor gets the trace major version
427 * @return long gets the trace major version
429 public long getMajor() {
434 * Method getMinor gets the trace minor version
436 * @return long gets the trace minor version
438 public long getMinor() {
443 * Method getByteOrder gets the trace byte order
445 * @return ByteOrder gets the trace byte order
447 public final ByteOrder
getByteOrder() {
452 * Method getPacketHeader gets the trace packet header
454 * @return StructDeclaration gets the trace packet header
456 public StructDeclaration
getPacketHeader() {
457 return fPacketHeaderDecl
;
461 * Method getTraceDirectory gets the trace directory
463 * @return File the path in "File" format.
465 public File
getTraceDirectory() {
470 * Get all the streams as an iterable.
472 * @return Iterable<Stream> an iterable over streams.
475 public Iterable
<Stream
> getStreams() {
476 return fStreams
.values();
480 * Method getPath gets the path of the trace directory
482 * @return String the path of the trace directory, in string format.
483 * @see java.io.File#getPath()
486 public String
getPath() {
487 return (fPath
!= null) ? fPath
.getPath() : ""; //$NON-NLS-1$
490 // ------------------------------------------------------------------------
492 // ------------------------------------------------------------------------
494 private void addStream(StreamInput s
) {
499 Iterator
<Entry
<Long
, IEventDeclaration
>> it
= s
.getStream()
500 .getEvents().entrySet().iterator();
501 while (it
.hasNext()) {
502 Entry
<Long
, IEventDeclaration
> pairs
= it
.next();
503 Long eventNum
= pairs
.getKey();
504 IEventDeclaration eventDec
= pairs
.getValue();
505 getEvents(s
.getStream().getId()).put(eventNum
, eventDec
);
515 * Tries to open the given file, reads the first packet header of the file
516 * and check its validity. This will add a file to a stream as a streaminput
519 * A trace file in the trace directory.
521 * Which index in the class' streamFileChannel array this file
523 * @throws CTFReaderException
524 * if there is a file error
526 private Stream
openStreamInput(File streamFile
) throws CTFReaderException
{
527 MappedByteBuffer byteBuffer
;
528 BitBuffer streamBitBuffer
;
532 if (!streamFile
.canRead()) {
533 throw new CTFReaderException("Unreadable file : " //$NON-NLS-1$
534 + streamFile
.getPath());
537 FileInputStream fis
= null;
539 /* Open the file and get the FileChannel */
540 fis
= new FileInputStream(streamFile
);
541 fFileInputStreams
.add(fis
);
542 fc
= fis
.getChannel();
544 /* Map one memory page of 4 kiB */
545 byteBuffer
= fc
.map(MapMode
.READ_ONLY
, 0, (int) Math
.min(fc
.size(), 4096L));
546 } catch (IOException e
) {
548 fFileInputStreams
.remove(fis
);
550 /* Shouldn't happen at this stage if every other check passed */
551 throw new CTFReaderException(e
);
554 /* Create a BitBuffer with this mapping and the trace byte order */
555 streamBitBuffer
= new BitBuffer(byteBuffer
, this.getByteOrder());
557 if (fPacketHeaderDef
!= null) {
558 /* Read the packet header */
559 fPacketHeaderDef
.read(streamBitBuffer
);
561 /* Check the magic number */
562 IntegerDefinition magicDef
= (IntegerDefinition
) fPacketHeaderDef
563 .lookupDefinition("magic"); //$NON-NLS-1$
564 int magic
= (int) magicDef
.getValue();
565 if (magic
!= Utils
.CTF_MAGIC
) {
566 throw new CTFReaderException("CTF magic mismatch"); //$NON-NLS-1$
570 ArrayDefinition uuidDef
= (ArrayDefinition
) fPacketHeaderDef
571 .lookupDefinition("uuid"); //$NON-NLS-1$
572 if (uuidDef
!= null) {
573 byte[] uuidArray
= new byte[Utils
.UUID_LEN
];
575 for (int i
= 0; i
< Utils
.UUID_LEN
; i
++) {
576 IntegerDefinition uuidByteDef
= (IntegerDefinition
) uuidDef
578 uuidArray
[i
] = (byte) uuidByteDef
.getValue();
581 UUID otheruuid
= Utils
.makeUUID(uuidArray
);
583 if (!fUuid
.equals(otheruuid
)) {
584 throw new CTFReaderException("UUID mismatch"); //$NON-NLS-1$
588 /* Read the stream ID */
589 Definition streamIDDef
= fPacketHeaderDef
.lookupDefinition("stream_id"); //$NON-NLS-1$
591 if (streamIDDef
instanceof IntegerDefinition
) { // this doubles as a
593 long streamID
= ((IntegerDefinition
) streamIDDef
).getValue();
594 stream
= fStreams
.get(streamID
);
596 /* No stream_id in the packet header */
597 stream
= fStreams
.get(null);
601 /* No packet header, we suppose there is only one stream */
602 stream
= fStreams
.get(null);
605 if (stream
== null) {
606 throw new CTFReaderException("Unexpected end of stream"); //$NON-NLS-1$
609 /* Create the stream input */
610 StreamInput streamInput
= new StreamInput(stream
, fc
, streamFile
);
612 /* Add a reference to the streamInput in the stream */
613 stream
.addInput(streamInput
);
619 * Looks up a definition from packet
624 * @see org.eclipse.linuxtools.ctf.core.event.types.IDefinitionScope#lookupDefinition(String)
627 public Definition
lookupDefinition(String lookupPath
) {
628 if (lookupPath
.equals("trace.packet.header")) { //$NON-NLS-1$
629 return fPacketHeaderDef
;
635 * Add a new stream file to support new streams while the trace is being
639 * the file of the stream
640 * @throws CTFReaderException
641 * A stream had an issue being read
644 public void addStreamFile(File streamFile
) throws CTFReaderException
{
645 openStreamInput(streamFile
);
649 * Registers a new stream to the trace.
653 * @throws ParseException
654 * If there was some problem reading the metadata
657 public void addStream(Stream stream
) throws ParseException
{
660 * Init if not done before
665 * If there is already a stream without id (the null key), it must be
668 if (fStreams
.get(null) != null) {
669 throw new ParseException("Stream without id with multiple streams"); //$NON-NLS-1$
673 * If the stream we try to add has the null key, it must be the only
674 * one. Thus, if the streams container is not empty, it is not valid.
676 if ((stream
.getId() == null) && (fStreams
.size() != 0)) {
677 throw new ParseException("Stream without id with multiple streams"); //$NON-NLS-1$
681 * If a stream with the same ID already exists, it is not valid.
683 Stream existingStream
= fStreams
.get(stream
.getId());
684 if (existingStream
!= null) {
685 throw new ParseException("Stream id already exists"); //$NON-NLS-1$
688 /* This stream is valid and has a unique id. */
689 fStreams
.put(stream
.getId(), stream
);
693 * Gets the Environment variables from the trace metadata (See CTF spec)
695 * @return The environment variables in the form of an unmodifiable map
699 public Map
<String
, String
> getEnvironment() {
700 return Collections
.unmodifiableMap(fEnvironment
);
704 * Add a variable to the environment variables
707 * the name of the variable
709 * the value of the variable
711 public void addEnvironmentVar(String varName
, String varValue
) {
712 fEnvironment
.put(varName
, varValue
);
716 * Add a clock to the clock list
719 * the name of the clock (full name with scope)
723 public void addClock(String nameValue
, CTFClock ctfClock
) {
724 fClocks
.put(nameValue
, ctfClock
);
728 * gets the clock with a specific name
731 * the name of the clock.
734 public CTFClock
getClock(String name
) {
735 return fClocks
.get(name
);
739 * gets the clock if there is only one. (this is 100% of the use cases as of
744 public final CTFClock
getClock() {
745 if (fClocks
.size() == 1) {
746 fSingleClock
= fClocks
.get(fClocks
.keySet().iterator().next());
753 * gets the time offset of a clock with respect to UTC in nanoseconds
755 * @return the time offset of a clock with respect to UTC in nanoseconds
757 public final long getOffset() {
758 if (getClock() == null) {
761 return fSingleClock
.getClockOffset();
765 * gets the time offset of a clock with respect to UTC in nanoseconds
767 * @return the time offset of a clock with respect to UTC in nanoseconds
769 private double getTimeScale() {
770 if (getClock() == null) {
773 return fSingleClock
.getClockScale();
777 * Does the trace need to time scale?
779 * @return if the trace is in ns or cycles.
781 private boolean clockNeedsScale() {
782 if (getClock() == null) {
785 return fSingleClock
.isClockScaled();
789 * the inverse clock for returning to a scale.
791 * @return 1.0 / scale
793 private double getInverseTimeScale() {
794 if (getClock() == null) {
797 return fSingleClock
.getClockAntiScale();
802 * clock cycles since boot
803 * @return time in nanoseconds UTC offset
806 public long timestampCyclesToNanos(long cycles
) {
807 long retVal
= cycles
+ getOffset();
809 * this fix is since quite often the offset will be > than 53 bits and
810 * therefore the conversion will be lossy
812 if (clockNeedsScale()) {
813 retVal
= (long) (retVal
* getTimeScale());
820 * time in nanoseconds UTC offset
821 * @return clock cycles since boot.
824 public long timestampNanoToCycles(long nanos
) {
827 * this fix is since quite often the offset will be > than 53 bits and
828 * therefore the conversion will be lossy
830 if (clockNeedsScale()) {
831 retVal
= (long) (nanos
* getInverseTimeScale());
835 return retVal
- getOffset();
842 * the event name of the callsite
844 * the name of the callsite function
846 * the ip of the callsite
848 * the filename of the callsite
850 * the line number of the callsite
852 public void addCallsite(String eventName
, String funcName
, long ip
,
853 String fileName
, long lineNumber
) {
854 final CTFCallsite cs
= new CTFCallsite(eventName
, funcName
, ip
,
855 fileName
, lineNumber
);
856 TreeSet
<CTFCallsite
> csl
= fCallsitesByName
.get(eventName
);
858 csl
= new TreeSet
<>(fCtfCallsiteComparator
);
859 fCallsitesByName
.put(eventName
, csl
);
864 fCallsitesByIP
.add(cs
);
868 * Gets the set of callsites associated to an event name. O(1)
872 * @return the callsite set can be empty
875 public TreeSet
<CTFCallsite
> getCallsiteCandidates(String eventName
) {
876 TreeSet
<CTFCallsite
> retVal
= fCallsitesByName
.get(eventName
);
877 if (retVal
== null) {
878 retVal
= new TreeSet
<>(fCtfCallsiteComparator
);
884 * The I'm feeling lucky of getCallsiteCandidates O(1)
888 * @return the first callsite that has that event name, can be null
891 public CTFCallsite
getCallsite(String eventName
) {
892 TreeSet
<CTFCallsite
> callsites
= fCallsitesByName
.get(eventName
);
893 if (callsites
!= null) {
894 return callsites
.first();
900 * Gets a callsite from the instruction pointer O(log(n))
903 * the instruction pointer to lookup
904 * @return the callsite just before that IP in the list remember the IP is
905 * backwards on X86, can be null if no callsite is before the IP.
908 public CTFCallsite
getCallsite(long ip
) {
909 CTFCallsite cs
= new CTFCallsite(null, null, ip
, null, 0L);
910 return fCallsitesByIP
.ceiling(cs
);
914 * Gets a callsite using the event name and instruction pointer O(log(n))
917 * the name of the event
919 * the instruction pointer
920 * @return the closest matching callsite, can be null
922 public CTFCallsite
getCallsite(String eventName
, long ip
) {
923 final TreeSet
<CTFCallsite
> candidates
= fCallsitesByName
.get(eventName
);
924 final CTFCallsite dummyCs
= new CTFCallsite(null, null, ip
, null, -1);
925 final CTFCallsite callsite
= candidates
.ceiling(dummyCs
);
926 if (callsite
== null) {
927 return candidates
.floor(dummyCs
);
933 class MetadataFileFilter
implements FileFilter
{
936 public boolean accept(File pathname
) {
937 if (pathname
.isDirectory()) {
940 if (pathname
.isHidden()) {
943 if (pathname
.getName().equals("metadata")) { //$NON-NLS-1$
951 class MetadataComparator
implements Comparator
<File
>, Serializable
{
953 private static final long serialVersionUID
= 1L;
956 public int compare(File o1
, File o2
) {
957 return o1
.getName().compareTo(o2
.getName());