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 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.ctf
.core
.trace
;
16 import java
.io
.FileInputStream
;
17 import java
.io
.FileNotFoundException
;
18 import java
.io
.FileReader
;
19 import java
.io
.IOException
;
20 import java
.io
.Reader
;
21 import java
.io
.StringReader
;
22 import java
.nio
.ByteBuffer
;
23 import java
.nio
.ByteOrder
;
24 import java
.nio
.channels
.FileChannel
;
25 import java
.util
.Arrays
;
26 import java
.util
.UUID
;
28 import org
.antlr
.runtime
.ANTLRReaderStream
;
29 import org
.antlr
.runtime
.CommonTokenStream
;
30 import org
.antlr
.runtime
.RecognitionException
;
31 import org
.antlr
.runtime
.tree
.CommonTree
;
32 import org
.eclipse
.linuxtools
.ctf
.parser
.CTFLexer
;
33 import org
.eclipse
.linuxtools
.ctf
.parser
.CTFParser
;
34 import org
.eclipse
.linuxtools
.ctf
.parser
.CTFParser
.parse_return
;
35 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.metadata
.IOStructGen
;
36 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.metadata
.exceptions
.ParseException
;
39 * The CTF trace metadata file
42 * @author Matthew Khouzam
43 * @author Simon Marchi
45 public class Metadata
{
47 // ------------------------------------------------------------------------
49 // ------------------------------------------------------------------------
52 * Name of the metadata file in the trace directory
54 final static String METADATA_FILENAME
= "metadata"; //$NON-NLS-1$
57 * Size of the metadata packet header, in bytes, computed by hand.
59 final static int METADATA_PACKET_HEADER_SIZE
= 37;
61 // ------------------------------------------------------------------------
63 // ------------------------------------------------------------------------
66 * Reference to the metadata file
68 private File metadataFile
= null;
71 * Byte order as detected when reading the TSDL magic number.
73 private ByteOrder detectedByteOrder
= null;
76 * The trace file to which belongs this metadata file.
78 private CTFTrace trace
= null;
80 // ------------------------------------------------------------------------
82 // ------------------------------------------------------------------------
85 * Constructs a Metadata object.
88 * The trace to which belongs this metadata file.
90 public Metadata(CTFTrace trace
) {
93 /* Path of metadata file = trace directory path + metadata filename */
94 String metadataPath
= trace
.getTraceDirectory().getPath()
95 + Utils
.SEPARATOR
+ METADATA_FILENAME
;
97 /* Create a file reference to the metadata file */
98 metadataFile
= new File(metadataPath
);
101 // ------------------------------------------------------------------------
102 // Getters/Setters/Predicates
103 // ------------------------------------------------------------------------
106 * Returns the ByteOrder that was detected while parsing the metadata.
108 * @return The byte order.
110 public ByteOrder
getDetectedByteOrder() {
111 return detectedByteOrder
;
114 // ------------------------------------------------------------------------
116 // ------------------------------------------------------------------------
119 * Parse the metadata file.
121 * @throws CTFReaderException
122 * If there was a problem parsing the metadata
124 public void parse() throws CTFReaderException
{
125 CTFReaderException tempException
= null;
127 FileInputStream fis
= null;
128 FileChannel metadataFileChannel
= null;
131 * Reader. It will contain a StringReader if we are using packet-based
132 * metadata and it will contain a FileReader if we have text-based
135 Reader metadataTextInput
= null;
138 fis
= new FileInputStream(metadataFile
);
139 metadataFileChannel
= fis
.getChannel();
141 /* Check if metadata is packet-based */
142 if (isPacketBased(metadataFileChannel
)) {
143 /* Create StringBuffer to receive metadata text */
144 StringBuffer metadataText
= new StringBuffer();
147 * Read metadata packet one by one, appending the text to the
150 MetadataPacketHeader packetHeader
= readMetadataPacket(
151 metadataFileChannel
, metadataText
);
152 while (packetHeader
!= null) {
153 packetHeader
= readMetadataPacket(metadataFileChannel
,
157 /* Wrap the metadata string with a StringReader */
158 metadataTextInput
= new StringReader(metadataText
.toString());
160 /* Wrap the metadata file with a FileReader */
161 metadataTextInput
= new FileReader(metadataFile
);
164 CommonTree tree
= createAST(metadataTextInput
);
166 /* Generate IO structures (declarations) */
167 IOStructGen gen
= new IOStructGen(tree
, trace
);
170 } catch (FileNotFoundException e
) {
171 tempException
= new CTFReaderException("Cannot find metadata file!"); //$NON-NLS-1$
172 } catch (IOException e
) {
173 /* This would indicate a problem with the ANTLR library... */
174 tempException
= new CTFReaderException(e
);
175 } catch (ParseException e
) {
176 tempException
= new CTFReaderException(e
);
177 } catch (RecognitionException e
) {
179 * We don't want to expose this ANTLR-specific exception type to the
182 tempException
= new CTFReaderException(e
);
185 /* Ghetto resource management. Java 7 will deliver us from this... */
186 if (metadataTextInput
!= null) {
188 metadataTextInput
.close();
189 } catch (IOException e
) {
193 if (metadataFileChannel
!= null) {
195 metadataFileChannel
.close();
196 } catch (IOException e
) {
203 } catch (IOException e
) {
208 if (tempException
!= null) {
213 private static CommonTree
createAST(Reader metadataTextInput
) throws IOException
,
214 RecognitionException
{
215 /* Create an ANTLR reader */
216 ANTLRReaderStream antlrStream
;
217 antlrStream
= new ANTLRReaderStream(metadataTextInput
);
219 /* Parse the metadata text and get the AST */
220 CTFLexer ctfLexer
= new CTFLexer(antlrStream
);
221 CommonTokenStream tokens
= new CommonTokenStream(ctfLexer
);
222 CTFParser ctfParser
= new CTFParser(tokens
, false);
225 ret
= ctfParser
.parse();
227 CommonTree tree
= (CommonTree
) ret
.getTree();
232 * Determines whether the metadata file is packet-based by looking at the
233 * TSDL magic number. If it is packet-based, it also gives information about
234 * the endianness of the trace using the detectedByteOrder attribute.
236 * @param metadataFileChannel
237 * FileChannel of the metadata file.
238 * @return True if the metadata is packet-based.
239 * @throws CTFReaderException
241 private boolean isPacketBased(FileChannel metadataFileChannel
)
242 throws CTFReaderException
{
244 * Create a ByteBuffer to read the TSDL magic number (default is big
247 ByteBuffer magicByteBuffer
= ByteBuffer
.allocate(Utils
.TSDL_MAGIC_LEN
);
249 /* Read without changing file position */
251 metadataFileChannel
.read(magicByteBuffer
, 0);
252 } catch (IOException e
) {
253 throw new CTFReaderException(
254 "Unable to read metadata file channel."); //$NON-NLS-1$
257 /* Get the first int from the file */
258 int magic
= magicByteBuffer
.getInt(0);
260 /* Check if it matches */
261 if (Utils
.TSDL_MAGIC
== magic
) {
262 detectedByteOrder
= ByteOrder
.BIG_ENDIAN
;
266 /* Try the same thing, but with little endian */
267 magicByteBuffer
.order(ByteOrder
.LITTLE_ENDIAN
);
268 magic
= magicByteBuffer
.getInt(0);
270 if (Utils
.TSDL_MAGIC
== magic
) {
271 detectedByteOrder
= ByteOrder
.LITTLE_ENDIAN
;
279 * Reads a metadata packet from the given metadata FileChannel, do some
280 * basic validation and append the text to the StringBuffer.
282 * @param metadataFileChannel
283 * Metadata FileChannel
284 * @param metadataText
285 * StringBuffer to which the metadata text will be appended.
286 * @return A structure describing the header of the metadata packet, or null
287 * if the end of the file is reached.
288 * @throws CTFReaderException
290 private MetadataPacketHeader
readMetadataPacket(
291 FileChannel metadataFileChannel
, StringBuffer metadataText
)
292 throws CTFReaderException
{
293 /* Allocate a ByteBuffer for the header */
294 ByteBuffer headerByteBuffer
= ByteBuffer
.allocate(METADATA_PACKET_HEADER_SIZE
);
296 /* Read the header */
299 nbBytesRead
= metadataFileChannel
.read(headerByteBuffer
);
300 } catch (IOException e
) {
301 throw new CTFReaderException("Error reading the metadata header."); //$NON-NLS-1$
304 /* Return null if EOF */
305 if (nbBytesRead
< 0) {
309 /* Set ByteBuffer's position to 0 */
310 headerByteBuffer
.position(0);
312 /* Use byte order that was detected with the magic number */
313 headerByteBuffer
.order(detectedByteOrder
);
315 assert (nbBytesRead
== METADATA_PACKET_HEADER_SIZE
);
317 MetadataPacketHeader header
= new MetadataPacketHeader();
319 /* Read from the ByteBuffer */
320 header
.magic
= headerByteBuffer
.getInt();
321 headerByteBuffer
.get(header
.uuid
);
322 header
.checksum
= headerByteBuffer
.getInt();
323 header
.contentSize
= headerByteBuffer
.getInt();
324 header
.packetSize
= headerByteBuffer
.getInt();
325 header
.compressionScheme
= headerByteBuffer
.get();
326 header
.encryptionScheme
= headerByteBuffer
.get();
327 header
.checksumScheme
= headerByteBuffer
.get();
328 header
.ctfMajorVersion
= headerByteBuffer
.get();
329 header
.ctfMinorVersion
= headerByteBuffer
.get();
331 /* Check TSDL magic number */
332 if (header
.magic
!= Utils
.TSDL_MAGIC
) {
333 throw new CTFReaderException("TSDL magic number does not match"); //$NON-NLS-1$
337 UUID uuid
= Utils
.makeUUID(header
.uuid
);
338 if (!trace
.UUIDIsSet()) {
341 if (!trace
.getUUID().equals(uuid
)) {
342 throw new CTFReaderException("UUID mismatch"); //$NON-NLS-1$
346 /* Extract the text from the packet */
347 int payloadSize
= ((header
.contentSize
/ 8) - METADATA_PACKET_HEADER_SIZE
);
348 int skipSize
= (header
.packetSize
- header
.contentSize
) / 8;
350 /* Read the payload + the padding in a ByteBuffer */
351 ByteBuffer payloadByteBuffer
= ByteBuffer
.allocateDirect(payloadSize
354 metadataFileChannel
.read(payloadByteBuffer
);
355 } catch (IOException e
) {
356 throw new CTFReaderException(
357 "Error reading metadata packet payload."); //$NON-NLS-1$
359 payloadByteBuffer
.rewind();
361 /* Read only the payload from the ByteBuffer into a byte array */
362 byte payloadByteArray
[] = new byte[payloadByteBuffer
.remaining()];
363 payloadByteBuffer
.get(payloadByteArray
, 0, payloadSize
);
365 /* Convert the byte array to a String */
366 String str
= new String(payloadByteArray
, 0, payloadSize
);
368 /* Append it to the existing metadata */
369 metadataText
.append(str
);
374 static class MetadataPacketHeader
{
377 public byte uuid
[] = new byte[16];
379 public int contentSize
;
380 public int packetSize
;
381 public byte compressionScheme
;
382 public byte encryptionScheme
;
383 public byte checksumScheme
;
384 public byte ctfMajorVersion
;
385 public byte ctfMinorVersion
;
388 public String
toString() {
389 /* Only for debugging, shouldn't be externalized */
390 /* Therefore it cannot be covered by test cases */
391 return "MetadataPacketHeader [magic=0x" //$NON-NLS-1$
392 + Integer
.toHexString(magic
) + ", uuid=" //$NON-NLS-1$
393 + Arrays
.toString(uuid
) + ", checksum=" + checksum
//$NON-NLS-1$
394 + ", contentSize=" + contentSize
+ ", packetSize=" //$NON-NLS-1$ //$NON-NLS-2$
395 + packetSize
+ ", compressionScheme=" + compressionScheme
//$NON-NLS-1$
396 + ", encryptionScheme=" + encryptionScheme
//$NON-NLS-1$
397 + ", checksumScheme=" + checksumScheme
//$NON-NLS-1$
398 + ", ctfMajorVersion=" + ctfMajorVersion
//$NON-NLS-1$
399 + ", ctfMinorVersion=" + ctfMinorVersion
+ ']'; //$NON-NLS-1$