ctf: Add new field classes to complete ctf2 parsing

ctf/org.eclipse.tracecompass.ctf.core/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-Vendor: %Bundle-Vendor
-Bundle-Version: 5.1.0.qualifier
+Bundle-Version: 5.2.0.qualifier
 Bundle-Localization: plugin
 Bundle-SymbolicName: org.eclipse.tracecompass.ctf.core;singleton:=true
 Bundle-ActivationPolicy: lazy

ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/types/BlobDeclaration.java

@@ -19,9 +19,9 @@
 import org.eclipse.tracecompass.ctf.core.event.scope.IDefinitionScope;
 
 /**
- * A CTF blob class definition.
+ * A CTF blob class declaration.
  *
- * The definition of a blob data type that can be used to define sequence of
+ * The declaration of a blob data type that can be used to define sequence of
  * zero or more contiguous bytes with an associated IANA media type
  *
  * @author Sehr Moosabhoy
@@ -85,7 +85,8 @@ public long getAlignment() {
 
     @Override
     public int getMaximumSize() {
-        return fLength * 8; // This will allow the blob to be read properly and not break alignment in ctf.
+        return fLength * 8; // This will allow the blob to be read properly and
+                            // not break alignment in ctf.
     }
 
     @Override

ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/types/BlobDefinition.java

@@ -62,6 +62,14 @@ public byte[] getBytes() {
         return fArray;
     }
 
+    /**
+     * @return
+     * @since 5.2
+     */
+    public String getType() {
+        return fType;
+    }
+
     @Override
     public @NonNull BlobDeclaration getDeclaration() {
         return (BlobDeclaration) super.getDeclaration();

ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/types/BooleanDeclaration.java

@@ -0,0 +1,90 @@
+/**********************************************************************
+ * Copyright (c) 2026 École Polytechnique de Montréal
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License 2.0 which
+ * accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+package org.eclipse.tracecompass.ctf.core.event.types;
+
+import java.nio.ByteOrder;
+
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.tracecompass.ctf.core.CTFException;
+import org.eclipse.tracecompass.ctf.core.event.io.BitBuffer;
+import org.eclipse.tracecompass.ctf.core.event.scope.IDefinitionScope;
+
+/**
+ * A CTF declaration of a boolean field
+ *
+ * It declares a certain amount of bits as a boolean value.
+ *
+ * @since 5.2
+ * @author Arnaud Fiorini
+ */
+public class BooleanDeclaration extends Declaration {
+
+    private int fLength;
+    private long fAlignment;
+    private ByteOrder fByteOrder;
+
+    /**
+     * @param length
+     *            the size of the boolean field
+     * @param byteOrder
+     *            the order in which the bytes should be read
+     * @param alignment
+     *            alignment of the first bit of field relative to the beginning
+     *            of the packet
+     */
+    public BooleanDeclaration(int length, ByteOrder byteOrder, long alignment) {
+        fLength = length;
+        fByteOrder = byteOrder;
+        fAlignment = alignment;
+    }
+
+    @Override
+    public @NonNull Definition createDefinition(IDefinitionScope definitionScope, @NonNull String fieldName, @NonNull BitBuffer input) throws CTFException {
+        ByteOrder byteOrder = input.getByteOrder();
+        input.setByteOrder(fByteOrder);
+        boolean value = read(input);
+        input.setByteOrder(byteOrder);
+        return new BooleanDefinition(this, definitionScope, fieldName, value);
+    }
+
+    private boolean read(BitBuffer input) throws CTFException {
+        for (int i = 0; i < fLength; i++) {
+            if (input.get(Math.min(64, fLength - i * 64), false) != 0) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    @Override
+    public long getAlignment() {
+        return fAlignment;
+    }
+
+    @Override
+    public int getMaximumSize() {
+        return fLength;
+    }
+
+    @Override
+    public boolean isBinaryEquivalent(IDeclaration other) {
+        if (this == other) {
+            return true;
+        }
+        if (other == null) {
+            return false;
+        }
+        if (getClass() != other.getClass()) {
+            return false;
+        }
+        return fLength == other.getMaximumSize();
+    }
+}

ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/types/BooleanDefinition.java

@@ -0,0 +1,61 @@
+/**********************************************************************
+ * Copyright (c) 2026 École Polytechnique de Montréal
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License 2.0 which
+ * accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+package org.eclipse.tracecompass.ctf.core.event.types;
+
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.tracecompass.ctf.core.event.scope.IDefinitionScope;
+
+/**
+ * A CTF2 boolean definition.
+ *
+ * The definition of a boolean field class in ctf2
+ *
+ * @author Arnaud Fiorini
+ * @since 5.2
+ */
+public class BooleanDefinition extends SimpleDatatypeDefinition {
+
+    private final boolean fValue;
+
+    /**
+     * Constructor
+     *
+     * @param declaration
+     *            the parent declaration
+     * @param definitionScope
+     *            the parent scope
+     * @param fieldName
+     *            the field name
+     * @param value
+     *            the field value
+     */
+    public BooleanDefinition(@NonNull IDeclaration declaration, IDefinitionScope definitionScope, @NonNull String fieldName, boolean value) {
+        super(declaration, definitionScope, fieldName);
+        fValue = value;
+    }
+
+    /**
+     * @return boolean value of the field
+     */
+    public boolean getValue() {
+        return fValue;
+    }
+
+    @Override
+    public BooleanDeclaration getDeclaration() {
+        return (BooleanDeclaration) super.getDeclaration();
+    }
+
+    @Override
+    public String toString() {
+        return String.valueOf(fValue);
+    }
+}

ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/types/DynamicBlobDeclaration.java

@@ -0,0 +1,124 @@
+/**********************************************************************
+ * Copyright (c) 2026 École Polytechnique de Montréal
+ *
+ * All rights reserved. This program and the accompanying materials are
+ * made available under the terms of the Eclipse Public License 2.0 which
+ * accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ **********************************************************************/
+package org.eclipse.tracecompass.ctf.core.event.types;
+
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.eclipse.tracecompass.ctf.core.CTFException;
+import org.eclipse.tracecompass.ctf.core.event.io.BitBuffer;
+import org.eclipse.tracecompass.ctf.core.event.scope.IDefinitionScope;
+
+/**
+ * A CTF blob class declaration.
+ *
+ * The declaration of a blob data type that can be used to define sequence of
+ * zero or more contiguous bytes with an associated IANA media type
+ *
+ * @since 5.2
+ * @author Arnaud Fiorini
+ */
+public class DynamicBlobDeclaration extends Declaration {
+
+    private String fLengthName;
+    private String fMediaType;
+
+    /**
+     * Constructor
+     *
+     * @param lengthName
+     *            the length field location
+     * @param mediaType
+     *            the IANA media type
+     */
+    public DynamicBlobDeclaration(@Nullable String lengthName, String mediaType) {
+        fLengthName = lengthName;
+        fMediaType = mediaType;
+    }
+
+    @Override
+    public @NonNull Definition createDefinition(IDefinitionScope definitionScope, @NonNull String fieldName, @NonNull BitBuffer input) throws CTFException {
+        IDefinition lenDef = null;
+
+        if (definitionScope != null) {
+            lenDef = definitionScope.lookupDefinition(fLengthName);
+        }
+
+        if (lenDef == null) {
+            throw new CTFException("Dynamic blob length field not found"); //$NON-NLS-1$
+        }
+
+        if (!(lenDef instanceof IntegerDefinition)) {
+            throw new CTFException("Dynamic blob length field not integer"); //$NON-NLS-1$
+        }
+
+        IntegerDefinition lengthDefinition = (IntegerDefinition) lenDef;
+
+        if (lengthDefinition.getDeclaration().isSigned()) {
+            throw new CTFException("Dynamic blob length must not be signed"); //$NON-NLS-1$
+        }
+
+        long length = lengthDefinition.getValue();
+        if ((length > Integer.MAX_VALUE) || (!input.canRead((int) length))) {
+            throw new CTFException("Blob is too large " + length); //$NON-NLS-1$
+        }
+
+        byte[] array = new byte[(int) length];
+        if (input.getByteBuffer().remaining() < length) {
+            throw new CTFException("There is not enough data provided. Length asked: " + length + " Remaining buffer size: " + input.getByteBuffer().remaining()); //$NON-NLS-1$ //$NON-NLS-2$
+        }
+
+        /* Offset the buffer position wrt the current alignment */
+        alignRead(input);
+        input.get(array);
+
+        return new DynamicBlobDefinition(this, definitionScope, fieldName, array, fMediaType);
+    }
+
+    @Override
+    public int getMaximumSize() {
+        return Integer.MAX_VALUE;
+    }
+
+    /**
+     * From the documentation:
+     * https://diamon.org/ctf/files/CTF2-SPECRC-7.0rA.html#align-dec
+     *
+     * Alignment of a blob will always be 8 bits
+     */
+    @Override
+    public long getAlignment() {
+        return 8;
+    }
+
+    @Override
+    public String toString() {
+        /* Only used for debugging */
+        return "[declaration] dynamicblob[length-field-location=" + fLengthName + ", media-type=" + fMediaType + ']'; //$NON-NLS-1$ //$NON-NLS-2$
+    }
+
+    @Override
+    public boolean isBinaryEquivalent(IDeclaration other) {
+        if (this == other) {
+            return true;
+        }
+        if (other == null) {
+            return false;
+        }
+        if (getClass() != other.getClass()) {
+            return false;
+        }
+        DynamicBlobDeclaration otherBlob = (DynamicBlobDeclaration) other;
+        if (!fMediaType.equals(otherBlob.fMediaType)) {
+            return false;
+        }
+        return (fLengthName.equals(otherBlob.fLengthName));
+    }
+}