counter.core: Generalize the counterAnalysis to take ITmfCounterAspect

[Changed] Allowed ITmfCounterAspect populate counterAnalysis Signed-off-by: Reza Rouhghalandari <[email protected]>
eclipse-tracecompass · Aug 6, 2024 · 7a2e4f0 · 7a2e4f0
1 parent c8509f5
commit 7a2e4f0
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 20 deletions.
diff --git a/analysis/org.eclipse.tracecompass.analysis.counters.core/META-INF/MANIFEST.MF b/analysis/org.eclipse.tracecompass.analysis.counters.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: 2.2.1.qualifier
+Bundle-Version: 2.3.0.qualifier
 Bundle-Localization: plugin
 Bundle-SymbolicName: org.eclipse.tracecompass.analysis.counters.core;singleton:=true
 Bundle-Activator: org.eclipse.tracecompass.internal.analysis.counters.core.Activator

diff --git a/...unters.core/src/org/eclipse/tracecompass/analysis/counters/core/CounterStateProvider.java b/...unters.core/src/org/eclipse/tracecompass/analysis/counters/core/CounterStateProvider.java
@@ -76,8 +76,8 @@ public static CounterStateProvider create(ITmfTrace trace) {
         Iterable<ITmfEventAspect<?>> counterAspects = TmfTraceUtils.getEventAspects(trace, ITmfCounterAspect.class);
         for (ITmfEventAspect<?> counter : counterAspects) {
 
-            if (counter instanceof CounterAspect) {
-                CounterAspect counterAspect = (CounterAspect) counter;
+            if (counter instanceof ITmfCounterAspect) {
+                ITmfCounterAspect counterAspect = (ITmfCounterAspect) counter;
                 for (Class<? extends ITmfEventAspect<?>> parentAspectClass : counterAspect.getGroups()) {
 
                     // Avoid creating the same aggregated aspect multiple times
@@ -122,14 +122,14 @@ protected void eventHandle(@NonNull ITmfEvent event) {
         }
 
         for (ITmfEventAspect<?> aspect : fCounterAspects) {
-            if (aspect instanceof CounterAspect) {
-                CounterAspect counterAspect = (CounterAspect) aspect;
+            if (aspect instanceof ITmfCounterAspect) {
+                ITmfCounterAspect counterAspect = (ITmfCounterAspect) aspect;
                 if (counterAspect.getGroups().length > 0) {
                     int rootQuark = ss.getQuarkAbsoluteAndAdd(CounterAnalysis.GROUPED_COUNTER_ASPECTS_ATTRIB);
-                    handleGroupedCounterAspect(event, ss, counterAspect, rootQuark);
+                    handleGroupedCounterAspect(event, ss, rootQuark, counterAspect);
                 } else {
                     int rootQuark = ss.getQuarkAbsoluteAndAdd(CounterAnalysis.UNGROUPED_COUNTER_ASPECTS_ATTRIB);
-                    handleCounterAspect(event, ss, counterAspect, rootQuark);
+                    handleCounterAspect(event, ss, rootQuark, counterAspect);
                 }
             }
         }
@@ -147,8 +147,29 @@ protected void eventHandle(@NonNull ITmfEvent event) {
      *            Grouped counter aspect
      * @param rootQuark
      *            Key to a relative root of the state system
+     * @deprecated use
+     *             {@link #handleGroupedCounterAspect(ITmfEvent, ITmfStateSystemBuilder, int, ITfmCounterAspect)}
      */
+    @Deprecated
     protected void handleGroupedCounterAspect(ITmfEvent event, ITmfStateSystemBuilder ss, CounterAspect aspect, int rootQuark) {
+        handleGroupedCounterAspect(event, ss, rootQuark, aspect);
+    }
+
+    /**
+     * Add the field value of a grouped counter aspect to the state system
+     * (override in specific implementations)
+     *
+     * @param event
+     *            Event to process
+     * @param ss
+     *            State system object to fill
+     * @param rootQuark
+     *            Key to a relative root of the state system
+     * @param aspect
+     *            Grouped counter aspect
+     * @since 2.3
+     */
+    protected void handleGroupedCounterAspect(ITmfEvent event, ITmfStateSystemBuilder ss, int rootQuark, ITmfCounterAspect aspect) {
         /*
          * Retrieve the child quark of the counter aspect by going through its
          * attribute tree in the state system. The concatenation of the aspect's
@@ -170,10 +191,10 @@ protected void handleGroupedCounterAspect(ITmfEvent event, ITmfStateSystemBuilde
             }
         }
 
-        handleCounterAspect(event, ss, aspect, quark);
+        handleCounterAspect(event, ss, quark, aspect);
     }
 
-    private static void handleCounterAspect(ITmfEvent event, ITmfStateSystemBuilder ss, CounterAspect aspect, int rootQuark) {
+    private static void handleCounterAspect(ITmfEvent event, ITmfStateSystemBuilder ss, int rootQuark, ITmfCounterAspect aspect) {
         int quark = ss.getQuarkRelativeAndAdd(rootQuark, aspect.getName());
         Number eventContent = aspect.resolve(event);
         if (eventContent != null) {

diff --git a/...re/src/org/eclipse/tracecompass/analysis/counters/core/aspects/AbstractCounterAspect.java b/...re/src/org/eclipse/tracecompass/analysis/counters/core/aspects/AbstractCounterAspect.java
@@ -124,12 +124,7 @@ public boolean equals(@Nullable Object obj) {
         return Objects.equals(fFieldName, other.fFieldName) && Objects.equals(fLabel, other.fLabel);
     }
 
-    /**
-     * Gets the type of this counter
-     *
-     * @return the type of this counter
-     * @since 2.1
-     */
+    @Override
     public CounterType getType() {
         return fType;
     }

diff --git a/...nters.core/src/org/eclipse/tracecompass/analysis/counters/core/aspects/CounterAspect.java b/...nters.core/src/org/eclipse/tracecompass/analysis/counters/core/aspects/CounterAspect.java
@@ -76,11 +76,7 @@ public CounterAspect(String fieldName, String label, CounterType type, Class<? e
         fGroups = Arrays.copyOf(groups, groups.length);
     }
 
-    /**
-     * Get the groups
-     *
-     * @return the groups
-     */
+    @Override
     public Class<? extends ITmfEventAspect<?>>[] getGroups() {
         return fGroups;
     }

diff --git a/...s.core/src/org/eclipse/tracecompass/analysis/counters/core/aspects/ITmfCounterAspect.java b/...s.core/src/org/eclipse/tracecompass/analysis/counters/core/aspects/ITmfCounterAspect.java
@@ -11,6 +11,7 @@
 
 package org.eclipse.tracecompass.analysis.counters.core.aspects;
 
+import org.eclipse.tracecompass.analysis.counters.core.CounterType;
 import org.eclipse.tracecompass.tmf.core.event.aspect.ITmfEventAspect;
 
 /**
@@ -52,4 +53,24 @@ default boolean isHiddenByDefault() {
     default boolean isCumulative() {
         return true;
     }
+
+    /**
+     * Get the groups
+     *
+     * @return the groups
+     * @since 2.3
+     */
+    default Class<? extends ITmfEventAspect<?>>[] getGroups() {
+        return new Class[0];
+    }
+
+    /**
+     * Gets the type of this counter
+     *
+     * @return the groups
+     * @since 2.3
+     */
+    default CounterType getType() {
+        return CounterType.LONG;
+    }
 }