lttng: Make text metadata detection more lenient

Text CTF metadata files are supposed to start with "/* CTF " followed by
the CTF version. https://diamon.org/ctf/v1.8.3/#spec7.1

However, to support opening traces that don't comply with the
specification check for some common metadata keywords at the
beginning of the metadata file when validating the trace. This will
allow to open such traces with Trace Compass.

fixes #298

Signed-off-by: Bernd Hufmann <[email protected]>

Author: bhufmann

ctf/org.eclipse.tracecompass.ctf.core.tests/src/org/eclipse/tracecompass/ctf/core/tests/trace/MetadataPrevalidationTest.java

@@ -180,21 +180,103 @@ public void testTraceDirectoryWithJsonMetadata() throws IOException, CTFExceptio
     }
 
     /**
-     * Test a valid trace with text invalid metadata should return false
+     * Test a valid trace with text metedata missing TSDL header, but with allowed "trace"
+     * strings should return true
      *
      * @throws IOException
      *             A file error occurs, shouldn't happen
      * @throws CTFException
      *             if an exception occurs, shouldn't happen
      */
     @Test
-    public void testTraceDirectoryWithInvalidMetadata() throws IOException, CTFException {
+    public void testTraceDirectoryWithAllowedStartStringMetadata1() throws IOException, CTFException {
         Path dir = Files.createTempDirectory("trace");
         Path f = Files.createFile(dir.resolve("metadata"));
         try (PrintWriter pw = new PrintWriter(f.toFile())) {
             // no header
             pw.println("trace { major =1 ; minor = 8 ; byte_order = le;};");
         }
+        assertTrue(Metadata.preValidate(dir.toAbsolutePath().toString()));
+    }
+
+    /**
+     * Test a valid trace with text metedata missing TSDL header, but with allowed "typealias"
+     * strings should return true
+     *
+     * @throws IOException
+     *             A file error occurs, shouldn't happen
+     * @throws CTFException
+     *             if an exception occurs, shouldn't happen
+     */
+    @Test
+    public void testTraceDirectoryWithAllowedStartStringMetadata2() throws IOException, CTFException {
+        Path dir = Files.createTempDirectory("trace");
+        Path f = Files.createFile(dir.resolve("metadata"));
+        try (PrintWriter pw = new PrintWriter(f.toFile())) {
+            // no header
+            pw.println("typealias integer { size = 8; align = 8; signed = false; } := uint8_t;");
+        }
+        assertTrue(Metadata.preValidate(dir.toAbsolutePath().toString()));
+    }
+
+    /**
+     * Test a valid trace with text metedata missing TSDL header, but with allowed "typealias"
+     * strings should return true
+     *
+     * @throws IOException
+     *             A file error occurs, shouldn't happen
+     * @throws CTFException
+     *             if an exception occurs, shouldn't happen
+     */
+    @Test
+    public void testTraceDirectoryWithAllowedStartStringMetadata3() throws IOException, CTFException {
+        Path dir = Files.createTempDirectory("trace");
+        Path f = Files.createFile(dir.resolve("metadata"));
+        try (PrintWriter pw = new PrintWriter(f.toFile())) {
+            // no header
+            pw.println("env {\n"
+                    + "    hostname = \"localhost.localdomain\";\n"
+                    + "    domain = \"kernel\";\n"
+                    + "    sysname = \"Linux\";\n"
+                    + "    kernel_release = \"4.18.16-rt9\";\n"
+                    + "    kernel_version = \"#1 SMP PREEMPT RT Thu Jun 23 10:43:50 EDT 2022\";\n"
+                    + "    tracer_name = \"lttng-modules\";\n"
+                    + "    tracer_major = 2;\n"
+                    + "    tracer_minor = 14;\n"
+                    + "    tracer_patchlevel = 0;\n"
+                    + "    trace_buffering_scheme = \"global\";\n"
+                    + "    trace_name = \"default-k-20250724-093844\";\n"
+                    + "    trace_creation_datetime = \"20250724T093844-0400\";\n"
+                    + "    product_uuid = \"03000200-0400-0500-0006-000700080009\";\n"
+                    + "};");
+        }
+        assertTrue(Metadata.preValidate(dir.toAbsolutePath().toString()));
+    }
+
+    /**
+     * Test a valid trace with text metedata missing TSDL header, but with allowed "typealias"
+     * strings should return true
+     *
+     * @throws IOException
+     *             A file error occurs, shouldn't happen
+     * @throws CTFException
+     *             if an exception occurs, shouldn't happen
+     */
+    @Test
+    public void testTraceDirectoryWithInvalidMetadata() throws IOException, CTFException {
+        Path dir = Files.createTempDirectory("trace");
+        Path f = Files.createFile(dir.resolve("metadata"));
+        try (PrintWriter pw = new PrintWriter(f.toFile())) {
+            // no header
+            pw.println("clock {\n"
+                    + "    name = \"monotonic\";\n"
+                    + "    uuid = \"e7602765-7075-4f0b-814a-87c901e6837f\";\n"
+                    + "    description = \"Monotonic Clock\";\n"
+                    + "    freq = 1000000000; /* Frequency, in Hz */\n"
+                    + "    /* clock value offset from Epoch is: offset * (1/freq) */\n"
+                    + "    offset = 1753351888197109407;\n"
+                    + "};");
+        }
         assertFalse(Metadata.preValidate(dir.toAbsolutePath().toString()));
     }
 

ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/trace/Metadata.java

@@ -63,6 +63,7 @@
 import org.eclipse.tracecompass.internal.ctf.core.event.metadata.JsonFieldClassAliasMetadataNode;
 import org.eclipse.tracecompass.internal.ctf.core.event.metadata.JsonPreambleMetadataNode;
 import org.eclipse.tracecompass.internal.ctf.core.event.metadata.JsonTraceMetadataNode;
+import org.eclipse.tracecompass.internal.ctf.core.event.metadata.MetadataStrings;
 import org.eclipse.tracecompass.internal.ctf.core.event.metadata.ParseException;
 import org.eclipse.tracecompass.internal.ctf.core.event.metadata.tsdl.trace.TraceDeclarationParser;
 import org.eclipse.tracecompass.internal.ctf.core.event.types.ICTFMetadataNode;
@@ -90,6 +91,9 @@ public class Metadata {
 
     private static final String TEXT_ONLY_METADATA_HEADER_PREFIX = "/* CTF"; //$NON-NLS-1$
 
+    private static final List<String> TEXT_ONLY_METADATA_HEADER_PREFIXES = List.of(TEXT_ONLY_METADATA_HEADER_PREFIX,
+            MetadataStrings.TYPE_ALIAS, MetadataStrings.TRACE, MetadataStrings.ENV);
+
     private static final int PREVALIDATION_SIZE = 8;
 
     private static final int BITS_PER_BYTE = Byte.SIZE;
@@ -349,7 +353,7 @@ public static boolean preValidate(String path) throws CTFException {
             }
             try (BufferedReader br = new BufferedReader(new FileReader(metadataFile))) {
                 String text = br.readLine();
-                return text.startsWith(TEXT_ONLY_METADATA_HEADER_PREFIX);
+                return TEXT_ONLY_METADATA_HEADER_PREFIXES.stream().anyMatch(text::startsWith);
             } catch (IOException e) {
                 throw new CTFException(e.getMessage(), e);
             }

ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/internal/ctf/core/event/metadata/MetadataStrings.java

@@ -128,5 +128,9 @@ public interface MetadataStrings {
     String VARIANT = "variant";
     /** enum */
     String ENUM = "enum";
+    /** typealias */
+    String TYPE_ALIAS = "typealias";
+    /** env */
+    String ENV = "env";
 
 }