callStack: add Annotations handlers for instant events

theibhir · theibhir · commit b1681736af2d · 2025-10-24T08:00:55.000-04:00
implement IOutputAnnotationProvider and override methods
add marker data to tooltips

Signed-off-by: Yassine Ibhir &lt;yassine.ibhir.ibhir@ericsson.com&gt;
diff --git a/analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/analysis/profiling/core/callstack/CallStackAnalysis.java b/analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/analysis/profiling/core/callstack/CallStackAnalysis.java
@@ -54,6 +54,13 @@ public abstract class CallStackAnalysis extends TmfStateSystemAnalysisModule imp
      */
     public static final String CALL_STACK = "CallStack"; //$NON-NLS-1$
 
+    /**
+     * Annotations string state attribute
+     *
+     * @since 2.6
+     */
+    public static final String ANNOTATIONS = "Markers"; //$NON-NLS-1$
+
     private static final String[] DEFAULT_PROCESSES_PATTERN = new String[] { CallStackStateProvider.PROCESSES, "*" }; //$NON-NLS-1$
 
     private static final String[] DEFAULT_THREADS_PATTERN = new String[] { "*" }; //$NON-NLS-1$
diff --git a/analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/analysis/profiling/core/callstack/CallStackStateProvider.java b/analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/analysis/profiling/core/callstack/CallStackStateProvider.java
@@ -277,4 +277,15 @@ public void done() {
         /* Override to provide a thread name */
         return null;
     }
+
+    /**
+     * Add an event as a marker to the Annotations attribute
+     *
+     * @param event
+     *            The event to add as a marker
+     * @since 2.6
+     */
+    protected void addMarker(ITmfEvent event) {
+        // Do nothing, this is a placeholder for overriding.
+    }
 }
diff --git a/analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/internal/analysis/profiling/core/instrumented/FlameChartDataProvider.java b/analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/internal/analysis/profiling/core/instrumented/FlameChartDataProvider.java
@@ -38,6 +38,7 @@
 import org.eclipse.tracecompass.analysis.profiling.core.base.FlameWithKernelPalette;
 import org.eclipse.tracecompass.analysis.profiling.core.base.ICallStackElement;
 import org.eclipse.tracecompass.analysis.profiling.core.callgraph.ICalledFunction;
+import org.eclipse.tracecompass.analysis.profiling.core.callstack.CallStackAnalysis;
 import org.eclipse.tracecompass.analysis.profiling.core.callstack2.CallStack;
 import org.eclipse.tracecompass.analysis.profiling.core.callstack2.CallStackDepth;
 import org.eclipse.tracecompass.analysis.profiling.core.callstack2.CallStackSeries;
@@ -48,7 +49,10 @@
 import org.eclipse.tracecompass.internal.analysis.profiling.core.instrumented.FlameChartEntryModel.EntryType;
 import org.eclipse.tracecompass.internal.analysis.profiling.core.model.ModelManager;
 import org.eclipse.tracecompass.internal.analysis.profiling.core.model.ProcessStatusInterval;
+import org.eclipse.tracecompass.internal.tmf.core.model.filters.FetchParametersUtils;
 import org.eclipse.tracecompass.segmentstore.core.ISegment;
+import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
+import org.eclipse.tracecompass.statesystem.core.exceptions.StateSystemDisposedException;
 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
 import org.eclipse.tracecompass.statesystem.core.interval.ITmfStateInterval;
 import org.eclipse.tracecompass.tmf.core.dataprovider.DataProviderParameterUtils;
@@ -57,6 +61,13 @@
 import org.eclipse.tracecompass.tmf.core.model.IOutputStyleProvider;
 import org.eclipse.tracecompass.tmf.core.model.OutputElementStyle;
 import org.eclipse.tracecompass.tmf.core.model.OutputStyleModel;
+import org.eclipse.tracecompass.tmf.core.model.StyleProperties;
+import org.eclipse.tracecompass.tmf.core.model.StyleProperties.SymbolType;
+import org.eclipse.tracecompass.tmf.core.model.annotations.Annotation;
+import org.eclipse.tracecompass.tmf.core.model.annotations.AnnotationCategoriesModel;
+import org.eclipse.tracecompass.tmf.core.model.annotations.AnnotationModel;
+import org.eclipse.tracecompass.tmf.core.model.annotations.IOutputAnnotationProvider;
+import org.eclipse.tracecompass.tmf.core.model.filters.SelectionTimeQueryFilter;
 import org.eclipse.tracecompass.tmf.core.model.timegraph.ITimeGraphArrow;
 import org.eclipse.tracecompass.tmf.core.model.timegraph.ITimeGraphDataProvider;
 import org.eclipse.tracecompass.tmf.core.model.timegraph.ITimeGraphRowModel;
@@ -70,6 +81,7 @@
 import org.eclipse.tracecompass.tmf.core.response.ITmfResponse;
 import org.eclipse.tracecompass.tmf.core.response.ITmfResponse.Status;
 import org.eclipse.tracecompass.tmf.core.response.TmfModelResponse;
+import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
 import org.eclipse.tracecompass.tmf.core.symbols.ISymbolProvider;
 import org.eclipse.tracecompass.tmf.core.symbols.SymbolProviderManager;
 import org.eclipse.tracecompass.tmf.core.symbols.SymbolProviderUtils;
@@ -84,6 +96,7 @@
 import com.google.common.collect.BiMap;
 import com.google.common.collect.HashBiMap;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableList.Builder;
 import com.google.common.collect.ImmutableMultimap;
 import com.google.common.collect.Multimap;
@@ -95,7 +108,7 @@
  *
  * @author Geneviève Bastien
  */
-public class FlameChartDataProvider extends AbstractTmfTraceDataProvider implements ITimeGraphDataProvider<FlameChartEntryModel>, IOutputStyleProvider {
+public class FlameChartDataProvider extends AbstractTmfTraceDataProvider implements ITimeGraphDataProvider<FlameChartEntryModel>, IOutputAnnotationProvider, IOutputStyleProvider {
 
     /**
      * Provider ID.
@@ -283,6 +296,34 @@ public TmfModelResponse<Map<String, String>> fetchTooltip(Map<String, Object> fe
             if (selectedDepth == null) {
                 return null;
             }
+            Map<String, String> tooltips = new HashMap<>();
+            if (fFcProvider instanceof TmfStateSystemAnalysisModule) {
+                ITmfStateSystem ss = ((TmfStateSystemAnalysisModule) fFcProvider).getStateSystem();
+                if (ss != null) {
+                    try {
+                        int parentQuark = ss.getParentAttributeQuark(ss.getParentAttributeQuark(selectedDepth.getQuark()));
+                        int annotQuark = ss.optQuarkRelative(parentQuark, CallStackAnalysis.ANNOTATIONS);
+                        if (annotQuark != ITmfStateSystem.INVALID_ATTRIBUTE) {
+                            ITmfStateInterval interval = ss.querySingleState(time, annotQuark);
+                            if (!interval.getStateValue().isNull()) {
+                                String annotValue = interval.getStateValue().unboxStr();
+                                String cleaned = annotValue.replace("{", "").replace("}", "");
+                                String[] pairs = cleaned.split(", ");
+                                for (String pair : pairs) {
+                                    String[] keyValue = pair.split("=", 2);
+                                    if (keyValue.length == 2) {
+                                        tooltips.put(keyValue[0].trim(), keyValue[1].trim());
+                                    }
+                                }
+                            }
+                        }
+                        return tooltips;
+
+                    } catch (StateSystemDisposedException e) {
+                        return null;
+                    }
+                }
+            }
             Multimap<CallStackDepth, ISegment> csFunctions = fFcProvider.queryCallStacks(Collections.singleton(selectedDepth), Collections.singleton(time));
             Collection<ISegment> functions = csFunctions.get(selectedDepth);
             if (functions.isEmpty()) {
@@ -293,7 +334,6 @@ public TmfModelResponse<Map<String, String>> fetchTooltip(Map<String, Object> fe
                 return null;
             }
             ICalledFunction currentFct = (ICalledFunction) next;
-            Map<String, String> tooltips = new HashMap<>();
             int threadId = currentFct.getThreadId();
             if (threadId > 0) {
                 tooltips.put(String.valueOf(Messages.FlameChartDataProvider_ThreadId), String.valueOf(threadId));
@@ -345,7 +385,8 @@ public TmfModelResponse<TmfTreeModel<FlameChartEntryModel>> fetchTree(Map<String
             boolean complete = fcProvider.isComplete();
             CallStackSeries callstack = fcProvider.getCallStackSeries();
             if (callstack == null) {
-                // Explicitly tell the client that the analysis is completed to prevent further polling
+                // Explicitly tell the client that the analysis is completed to
+                // prevent further polling
                 if (complete) {
                     return new TmfModelResponse<>(new TmfTreeModel<>(Collections.emptyList(), Collections.emptyList()), ITmfResponse.Status.COMPLETED, CommonStatusMessage.COMPLETED);
                 }
@@ -710,4 +751,77 @@ public TmfModelResponse<OutputStyleModel> fetchStyle(Map<String, Object> fetchPa
         Map<String, OutputElementStyle> styles = FlameWithKernelPalette.getInstance().getStyles();
         return new TmfModelResponse<>(new OutputStyleModel(styles), ITmfResponse.Status.COMPLETED, CommonStatusMessage.COMPLETED);
     }
+
+    @Override
+    public TmfModelResponse<AnnotationCategoriesModel> fetchAnnotationCategories(Map<String, Object> fetchParameters, @Nullable IProgressMonitor monitor) {
+        return new TmfModelResponse<>(new AnnotationCategoriesModel(Collections.singletonList(CallStackAnalysis.ANNOTATIONS)), ITmfResponse.Status.COMPLETED, CommonStatusMessage.COMPLETED);
+    }
+
+    @Override
+    public TmfModelResponse<AnnotationModel> fetchAnnotations(Map<String, Object> fetchParameters, @Nullable IProgressMonitor monitor) {
+
+        if (!(fFcProvider instanceof TmfStateSystemAnalysisModule)) {
+            return new TmfModelResponse<>(null, ITmfResponse.Status.FAILED, CommonStatusMessage.ANALYSIS_INITIALIZATION_FAILED);
+        }
+
+        TmfStateSystemAnalysisModule csa = (TmfStateSystemAnalysisModule) fFcProvider;
+        ITmfStateSystem ss = csa.getStateSystem();
+        if (ss == null) {
+            return new TmfModelResponse<>(null, ITmfResponse.Status.FAILED, CommonStatusMessage.STATE_SYSTEM_FAILED);
+        }
+
+        SelectionTimeQueryFilter filter = FetchParametersUtils.createSelectionTimeQuery(fetchParameters);
+        if (filter == null) {
+            return new TmfModelResponse<>(null, ITmfResponse.Status.COMPLETED, CommonStatusMessage.COMPLETED);
+        }
+
+        Map<Long, FlameChartEntryModel> selectedEntries = getSelectedEntries(fetchParameters);
+        List<Annotation> annotations = new ArrayList<>();
+        try {
+            for (Entry<@NonNull Long, @NonNull FlameChartEntryModel> entry : selectedEntries.entrySet()) {
+                long csId = entry.getValue().getId();
+                CallStackDepth cs = fIdToCallstack.get(csId);
+                if (cs == null) {
+                    continue;
+                }
+                int parentQuark = ss.getParentAttributeQuark(ss.getParentAttributeQuark(cs.getQuark()));
+                int markersQuark = ss.optQuarkRelative(parentQuark, CallStackAnalysis.ANNOTATIONS);
+                if (markersQuark != ITmfStateSystem.INVALID_ATTRIBUTE) {
+                    List<Long> times = DataProviderParameterUtils.extractTimeRequested(fetchParameters);
+                    for (ITmfStateInterval markerInterval : ss.query2D(Collections.singleton(markersQuark), times)) {
+                        if (!markerInterval.getStateValue().isNull()) {
+                            long startTime = markerInterval.getStartTime();
+                            // Find callstack depth at marker start time
+                            int depth = 0;
+                            for (int i = 1; i <= ss.getNbAttributes(); i++) {
+                                int depthQuark = ss.optQuarkRelative(cs.getQuark(), String.valueOf(i));
+                                if (depthQuark != ITmfStateSystem.INVALID_ATTRIBUTE) {
+                                    ITmfStateInterval depthInterval = ss.querySingleState(startTime, depthQuark);
+                                    if (!depthInterval.getStateValue().isNull()) {
+                                        depth = i;
+                                    }
+                                }
+                            }
+                            long entryId = entry.getKey();
+                            long rowId = (depth > 0) ? entryId + depth : entryId;
+                            String annotValue = markerInterval.getStateValue().unboxStr();
+                            String cleaned = annotValue.replace("{", "").replace("}", "");
+                            String[] pairs = cleaned.split(", ");
+                            if (pairs.length > 0) {
+                                OutputElementStyle style = new OutputElementStyle(null, ImmutableMap.of(
+                                        StyleProperties.COLOR, "#7D3D31", //$NON-NLS-1$
+                                        StyleProperties.HEIGHT, 0.33f,
+                                        StyleProperties.SYMBOL_TYPE, SymbolType.DIAMOND));
+                                annotations.add(new Annotation(startTime, 1, rowId, pairs[0], style));
+                            }
+                        }
+                    }
+                }
+            }
+        } catch (StateSystemDisposedException e) {
+            return new TmfModelResponse<>(null, ITmfResponse.Status.FAILED, e.getMessage());
+        }
+
+        return new TmfModelResponse<>(new AnnotationModel(Collections.singletonMap(CallStackAnalysis.ANNOTATIONS, annotations)), ITmfResponse.Status.COMPLETED, CommonStatusMessage.COMPLETED);
+    }
 }
diff --git a/tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/widgets/TimeGraphControl.java b/tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/widgets/timegraph/widgets/TimeGraphControl.java
@@ -2361,9 +2361,14 @@ private void oldDrawMarker(IMarkerEvent marker, GC gc, Rectangle rect, int color
         gc.setAlpha(OPAQUE);
         String label = marker.getLabel();
         if (fLabelsVisible && label != null && marker.getEntry() != null) {
-            label = label.substring(0, Math.min(label.indexOf('\n') != -1 ? label.indexOf('\n') : label.length(), MAX_LABEL_LENGTH));
-            gc.setForeground(color);
-            Utils.drawText(gc, label, rect.x - gc.textExtent(label).x, rect.y, true);
+            StyleManager styleManager = getStyleManager();
+            OutputElementStyle elementStyle = getElementStyle(marker);
+            Object symbolType = (elementStyle != null) ? styleManager.getStyle(elementStyle, StyleProperties.SYMBOL_TYPE) : null;
+            if (symbolType == null || symbolType == SymbolType.NONE) {
+                label = label.substring(0, Math.min(label.indexOf('\n') != -1 ? label.indexOf('\n') : label.length(), MAX_LABEL_LENGTH));
+                gc.setForeground(color);
+                Utils.drawText(gc, label, rect.x - gc.textExtent(label).x, rect.y, true);
+            }
         }
     }
 
