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
.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
.MismatchedTokenException
;
31 import org
.antlr
.runtime
.RecognitionException
;
32 import org
.antlr
.runtime
.tree
.CommonTree
;
33 import org
.eclipse
.linuxtools
.ctf
.parser
.CTFLexer
;
34 import org
.eclipse
.linuxtools
.ctf
.parser
.CTFParser
;
35 import org
.eclipse
.linuxtools
.ctf
.parser
.CTFParser
.parse_return
;
36 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.metadata
.IOStructGen
;
37 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.metadata
.exceptions
.ParseException
;
40 * The CTF trace metadata file
43 * @author Matthew Khouzam
44 * @author Simon Marchi
46 public class Metadata
{
48 // ------------------------------------------------------------------------
50 // ------------------------------------------------------------------------
53 * Name of the metadata file in the trace directory
55 final static String METADATA_FILENAME
= "metadata"; //$NON-NLS-1$
58 * Size of the metadata packet header, in bytes, computed by hand.
60 final static int METADATA_PACKET_HEADER_SIZE
= 37;
62 // ------------------------------------------------------------------------
64 // ------------------------------------------------------------------------
67 * Reference to the metadata file
69 private File metadataFile
= null;
72 * Byte order as detected when reading the TSDL magic number.
74 private ByteOrder detectedByteOrder
= null;
77 * The trace file to which belongs this metadata file.
79 private CTFTrace trace
= null;
81 // ------------------------------------------------------------------------
83 // ------------------------------------------------------------------------
86 * Constructs a Metadata object.
89 * The trace to which belongs this metadata file.
91 public Metadata(CTFTrace trace
) {
94 /* Path of metadata file = trace directory path + metadata filename */
95 String metadataPath
= trace
.getTraceDirectory().getPath()
96 + Utils
.SEPARATOR
+ METADATA_FILENAME
;
98 /* Create a file reference to the metadata file */
99 metadataFile
= new File(metadataPath
);
102 // ------------------------------------------------------------------------
103 // Getters/Setters/Predicates
104 // ------------------------------------------------------------------------
107 * Returns the ByteOrder that was detected while parsing the metadata.
109 * @return The byte order.
111 public ByteOrder
getDetectedByteOrder() {
112 return detectedByteOrder
;
115 // ------------------------------------------------------------------------
117 // ------------------------------------------------------------------------
120 * Parse the metadata file.
122 * @throws CTFReaderException
123 * If there was a problem parsing the metadata
125 public void parse() throws CTFReaderException
{
126 CTFReaderException tempException
= null;
128 FileInputStream fis
= null;
129 FileChannel metadataFileChannel
= null;
132 * Reader. It will contain a StringReader if we are using packet-based
133 * metadata and it will contain a FileReader if we have text-based
136 Reader metadataTextInput
= null;
139 fis
= new FileInputStream(metadataFile
);
140 metadataFileChannel
= fis
.getChannel();
142 /* Check if metadata is packet-based */
143 if (isPacketBased(metadataFileChannel
)) {
144 /* Create StringBuffer to receive metadata text */
145 StringBuffer metadataText
= new StringBuffer();
148 * Read metadata packet one by one, appending the text to the
151 MetadataPacketHeader packetHeader
= readMetadataPacket(
152 metadataFileChannel
, metadataText
);
153 while (packetHeader
!= null) {
154 packetHeader
= readMetadataPacket(metadataFileChannel
,
158 /* Wrap the metadata string with a StringReader */
159 metadataTextInput
= new StringReader(metadataText
.toString());
161 /* Wrap the metadata file with a FileReader */
162 metadataTextInput
= new FileReader(metadataFile
);
165 CommonTree tree
= createAST(metadataTextInput
);
167 /* Generate IO structures (declarations) */
168 IOStructGen gen
= new IOStructGen(tree
, trace
);
171 } catch (FileNotFoundException e
) {
172 tempException
= new CTFReaderException("Cannot find metadata file!"); //$NON-NLS-1$
173 } catch (IOException e
) {
174 /* This would indicate a problem with the ANTLR library... */
175 tempException
= new CTFReaderException(e
);
176 } catch (ParseException e
) {
177 tempException
= new CTFReaderException(e
);
178 } catch (MismatchedTokenException e
) {
179 tempException
= new CTFReaderException(e
);
180 } catch (RecognitionException e
) {
181 tempException
= new CTFReaderException(e
);
184 /* Ghetto resource management. Java 7 will deliver us from this... */
185 if (metadataTextInput
!= null) {
187 metadataTextInput
.close();
188 } catch (IOException e
) {
192 if (metadataFileChannel
!= null) {
194 metadataFileChannel
.close();
195 } catch (IOException e
) {
202 } catch (IOException e
) {
207 if (tempException
!= null) {
212 private static CommonTree
createAST(Reader metadataTextInput
) throws IOException
,
213 RecognitionException
{
214 /* Create an ANTLR reader */
215 ANTLRReaderStream antlrStream
;
216 antlrStream
= new ANTLRReaderStream(metadataTextInput
);
218 /* Parse the metadata text and get the AST */
219 CTFLexer ctfLexer
= new CTFLexer(antlrStream
);
220 CommonTokenStream tokens
= new CommonTokenStream(ctfLexer
);
221 CTFParser ctfParser
= new CTFParser(tokens
, false);
224 ret
= ctfParser
.parse();
226 CommonTree tree
= (CommonTree
) ret
.getTree();
231 * Determines whether the metadata file is packet-based by looking at the
232 * TSDL magic number. If it is packet-based, it also gives information about
233 * the endianness of the trace using the detectedByteOrder attribute.
235 * @param metadataFileChannel
236 * FileChannel of the metadata file.
237 * @return True if the metadata is packet-based.
238 * @throws CTFReaderException
240 private boolean isPacketBased(FileChannel metadataFileChannel
)
241 throws CTFReaderException
{
243 * Create a ByteBuffer to read the TSDL magic number (default is big
246 ByteBuffer magicByteBuffer
= ByteBuffer
.allocate(Utils
.TSDL_MAGIC_LEN
);
248 /* Read without changing file position */
250 metadataFileChannel
.read(magicByteBuffer
, 0);
251 } catch (IOException e
) {
252 throw new CTFReaderException("Unable to read metadata file channel."); //$NON-NLS-1$
255 /* Get the first int from the file */
256 int magic
= magicByteBuffer
.getInt(0);
258 /* Check if it matches */
259 if (Utils
.TSDL_MAGIC
== magic
) {
260 detectedByteOrder
= ByteOrder
.BIG_ENDIAN
;
264 /* Try the same thing, but with little endian */
265 magicByteBuffer
.order(ByteOrder
.LITTLE_ENDIAN
);
266 magic
= magicByteBuffer
.getInt(0);
268 if (Utils
.TSDL_MAGIC
== magic
) {
269 detectedByteOrder
= ByteOrder
.LITTLE_ENDIAN
;
277 * Reads a metadata packet from the given metadata FileChannel, do some
278 * basic validation and append the text to the StringBuffer.
280 * @param metadataFileChannel
281 * Metadata FileChannel
282 * @param metadataText
283 * StringBuffer to which the metadata text will be appended.
284 * @return A structure describing the header of the metadata packet, or null
285 * if the end of the file is reached.
286 * @throws CTFReaderException
288 private MetadataPacketHeader
readMetadataPacket(
289 FileChannel metadataFileChannel
, StringBuffer metadataText
)
290 throws CTFReaderException
{
291 /* Allocate a ByteBuffer for the header */
292 ByteBuffer headerByteBuffer
= ByteBuffer
.allocate(METADATA_PACKET_HEADER_SIZE
);
294 /* Read the header */
297 nbBytesRead
= metadataFileChannel
.read(headerByteBuffer
);
298 } catch (IOException e
) {
299 throw new CTFReaderException("Error reading the metadata header."); //$NON-NLS-1$
302 /* Return null if EOF */
303 if (nbBytesRead
< 0) {
307 /* Set ByteBuffer's position to 0 */
308 headerByteBuffer
.position(0);
310 /* Use byte order that was detected with the magic number */
311 headerByteBuffer
.order(detectedByteOrder
);
313 assert (nbBytesRead
== METADATA_PACKET_HEADER_SIZE
);
315 MetadataPacketHeader header
= new MetadataPacketHeader();
317 /* Read from the ByteBuffer */
318 header
.magic
= headerByteBuffer
.getInt();
319 headerByteBuffer
.get(header
.uuid
);
320 header
.checksum
= headerByteBuffer
.getInt();
321 header
.contentSize
= headerByteBuffer
.getInt();
322 header
.packetSize
= headerByteBuffer
.getInt();
323 header
.compressionScheme
= headerByteBuffer
.get();
324 header
.encryptionScheme
= headerByteBuffer
.get();
325 header
.checksumScheme
= headerByteBuffer
.get();
326 header
.ctfMajorVersion
= headerByteBuffer
.get();
327 header
.ctfMinorVersion
= headerByteBuffer
.get();
329 /* Check TSDL magic number */
330 if (header
.magic
!= Utils
.TSDL_MAGIC
) {
331 throw new CTFReaderException("TSDL magic number does not match"); //$NON-NLS-1$
335 UUID uuid
= Utils
.makeUUID(header
.uuid
);
336 if (!trace
.UUIDIsSet()) {
339 if (!trace
.getUUID().equals(uuid
)) {
340 throw new CTFReaderException("UUID mismatch"); //$NON-NLS-1$
344 /* Extract the text from the packet */
345 int payloadSize
= ((header
.contentSize
/ 8) - METADATA_PACKET_HEADER_SIZE
);
346 int skipSize
= (header
.packetSize
- header
.contentSize
) / 8;
348 /* Read the payload + the padding in a ByteBuffer */
349 ByteBuffer payloadByteBuffer
= ByteBuffer
.allocateDirect(payloadSize
352 metadataFileChannel
.read(payloadByteBuffer
);
353 } catch (IOException e
) {
354 throw new CTFReaderException("Error reading metadata packet payload."); //$NON-NLS-1$
356 payloadByteBuffer
.rewind();
358 /* Read only the payload from the ByteBuffer into a byte array */
359 byte payloadByteArray
[] = new byte[payloadByteBuffer
.remaining()];
360 payloadByteBuffer
.get(payloadByteArray
, 0, payloadSize
);
362 /* Convert the byte array to a String */
363 String str
= new String(payloadByteArray
, 0, payloadSize
);
365 /* Append it to the existing metadata */
366 metadataText
.append(str
);
371 static class MetadataPacketHeader
{
374 public byte uuid
[] = new byte[16];
376 public int contentSize
;
377 public int packetSize
;
378 public byte compressionScheme
;
379 public byte encryptionScheme
;
380 public byte checksumScheme
;
381 public byte ctfMajorVersion
;
382 public byte ctfMinorVersion
;
385 public String
toString() {
386 /* Only for debugging, shouldn't be externalized */
387 /* Therefore it cannot be covered by test cases */
388 return "MetadataPacketHeader [magic=0x" //$NON-NLS-1$
389 + Integer
.toHexString(magic
) + ", uuid=" //$NON-NLS-1$
390 + Arrays
.toString(uuid
) + ", checksum=" + checksum
//$NON-NLS-1$
391 + ", contentSize=" + contentSize
+ ", packetSize=" //$NON-NLS-1$ //$NON-NLS-2$
392 + packetSize
+ ", compressionScheme=" + compressionScheme
//$NON-NLS-1$
393 + ", encryptionScheme=" + encryptionScheme
//$NON-NLS-1$
394 + ", checksumScheme=" + checksumScheme
//$NON-NLS-1$
395 + ", ctfMajorVersion=" + ctfMajorVersion
//$NON-NLS-1$
396 + ", ctfMinorVersion=" + ctfMinorVersion
+ ']'; //$NON-NLS-1$