tmf: Add bar chart data provider type with feature to fetch bars

This commit implements the feature to fetch bars in bar chart
data provider. All features for bar chart are implemented after
this commit.

CallStackAnalysis is used as the initial example input to
demonstrate this functionality through a function density view.

[Added] The feature to fetch bars in bar chart data provider

Signed-off-by: Siwei Zhang <siwei.zhang@ericsson.com>

Author: Siwei Zhang

analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/internal/analysis/profiling/core/callstack/provider/CallStackBarChartDataProvider.java

@@ -11,26 +11,35 @@
 package org.eclipse.tracecompass.internal.analysis.profiling.core.callstack.provider;
 
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Objects;
 
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.tracecompass.analysis.profiling.core.callstack.CallStackAnalysis;
 import org.eclipse.tracecompass.analysis.profiling.core.callstack.CallStackSeries;
 import org.eclipse.tracecompass.common.core.NonNullUtils;
+import org.eclipse.tracecompass.internal.analysis.profiling.core.callgraph.ICalledFunction;
+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.interval.ITmfStateInterval;
 import org.eclipse.tracecompass.tmf.core.dataprovider.DataType;
+import org.eclipse.tracecompass.tmf.core.model.YModel;
 import org.eclipse.tracecompass.tmf.core.model.barchart.AbstractTreeBarChartDataProvider;
 import org.eclipse.tracecompass.tmf.core.model.barchart.AxisDomain;
+import org.eclipse.tracecompass.tmf.core.model.barchart.Sampling;
+import org.eclipse.tracecompass.tmf.core.model.filters.SelectionSamplingQueryFilter;
 import org.eclipse.tracecompass.tmf.core.model.tree.ITmfTreeDataModel;
 import org.eclipse.tracecompass.tmf.core.model.tree.TmfTreeDataModel;
+import org.eclipse.tracecompass.tmf.core.model.xy.IYModel;
 import org.eclipse.tracecompass.tmf.core.model.xy.TmfXYAxisDescription;
 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
 
@@ -162,4 +171,77 @@ private static int getThreadProcessId(String name, @Nullable Object value) {
             return UNKNOWN_PID;
         }
     }
+
+    @Override
+    protected @Nullable Collection<@NonNull IYModel> getYSeriesModels(
+            @NonNull ITmfStateSystem ss,
+            @NonNull Map<@NonNull String, @NonNull Object> fetchParameters,
+            @Nullable IProgressMonitor monitor) throws StateSystemDisposedException {
+
+        SelectionSamplingQueryFilter filter = FetchParametersUtils.createSelectionSamplingQuery(fetchParameters);
+        if (filter == null) {
+            return null;
+        }
+
+        Sampling sampling = filter.getSampling();
+        if (!(sampling instanceof Sampling.Ranges)) {
+            return null;
+        }
+
+        Sampling.Ranges timeRanges = (Sampling.Ranges) sampling;
+        Map<@NonNull Long, @NonNull Integer> selectedEntries = getSelectedEntries(filter);
+
+        CallStackSeries series = fModule.getCallStackSeries();
+        if (series == null) {
+            return null;
+        }
+
+        List<Sampling.@NonNull Range<@NonNull Long>> ranges = timeRanges.ranges();
+        Map<Integer, double[]> pidsToBins = new HashMap<>();
+
+        // Initialize bins only for selected entries
+        for (Entry<Integer, Long> pidToEntryId : fPidsToEntryIds.entrySet()) {
+            int pid = pidToEntryId.getKey();
+            long entryId = pidToEntryId.getValue();
+            if (selectedEntries.containsKey(entryId)) {
+                pidsToBins.put(pid, new double[ranges.size()]);
+            }
+        }
+
+        // Count function durations falling in each bin, assume the ranges can
+        // overlap
+        for (ISegment segment : series.getIntersectingElements(ss.getStartTime(), ss.getCurrentEndTime())) {
+            if (segment instanceof ICalledFunction function) {
+                int pid = function.getProcessId();
+                double[] bins = pidsToBins.get(pid);
+                if (bins == null) {
+                    continue;
+                }
+                long duration = segment.getLength();
+                for (int i = 0; i < ranges.size(); i++) {
+                    Sampling.Range<@NonNull Long> range = ranges.get(i);
+                    if (duration >= range.start() && duration <= range.end()) {
+                        bins[i]++;
+                    }
+                }
+            }
+        }
+
+        // Build final Y models
+        List<@NonNull IYModel> yModels = new ArrayList<>();
+        for (Entry<Integer, double[]> entry : pidsToBins.entrySet()) {
+            int pid = entry.getKey();
+            double[] bins = entry.getValue();
+            long entryId = fPidsToEntryIds.getOrDefault(pid, -1L);
+            yModels.add(new YModel(entryId, getNameFromPID(pid), bins));
+        }
+
+        return yModels;
+    }
+
+    @Override
+    protected String getTitle() {
+        String title = Objects.requireNonNull(Messages.CallStackBarChartDataProviderFactory_title);
+        return title;
+    }
 }

analysis/org.eclipse.tracecompass.analysis.profiling.core/src/org/eclipse/tracecompass/internal/analysis/profiling/core/callstack/provider/CallStackBarChartDataProviderFactory.java

@@ -63,7 +63,8 @@ public class CallStackBarChartDataProviderFactory implements IDataProviderFactor
                 return providers.get(0);
             }
             if (!providers.isEmpty()) {
-                return new TmfTreeBarChartCompositeDataProvider<>(providers, CallStackBarChartDataProvider.ID);
+                String title = Objects.requireNonNull(Messages.CallStackBarChartDataProviderFactory_title);
+                return new TmfTreeBarChartCompositeDataProvider<>(providers, title, CallStackBarChartDataProvider.ID);
             }
             return null;
         }

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/internal/tmf/core/model/TmfXyResponseFactory.java

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2017 Ericsson
+ * Copyright (c) 2017, 2025 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -21,7 +21,9 @@
 import org.eclipse.tracecompass.tmf.core.model.CommonStatusMessage;
 import org.eclipse.tracecompass.tmf.core.model.SeriesModel.SeriesModelBuilder;
 import org.eclipse.tracecompass.tmf.core.model.TmfXyModel;
+import org.eclipse.tracecompass.tmf.core.model.barchart.Sampling;
 import org.eclipse.tracecompass.tmf.core.model.xy.ISeriesModel;
+import org.eclipse.tracecompass.tmf.core.model.xy.ISeriesModel.DisplayType;
 import org.eclipse.tracecompass.tmf.core.model.xy.ITmfXyModel;
 import org.eclipse.tracecompass.tmf.core.model.xy.IYModel;
 import org.eclipse.tracecompass.tmf.core.model.xy.TmfXYAxisDescription;
@@ -60,7 +62,9 @@ private TmfXyResponseFactory() {
      *            Tells whether the computed model is complete or partial
      * @return A {@link TmfModelResponse} with either a running status or a
      *         completed status
+     * @deprecated Use {@link Sampling} for xValues instead.
      */
+    @Deprecated(since = "10.2", forRemoval = true)
     public static TmfModelResponse<ITmfXyModel> create(String title, long[] xValues, Collection<IYModel> yModels, boolean isComplete) {
         List<ISeriesModel> series = Lists.transform(new ArrayList<>(yModels), model -> {
             SeriesModelBuilder builder = new SeriesModelBuilder(model.getId(), model.getName(), xValues, model.getData());
@@ -78,6 +82,75 @@ public static TmfModelResponse<ITmfXyModel> create(String title, long[] xValues,
         return new TmfModelResponse<>(model, ITmfResponse.Status.RUNNING, Objects.requireNonNull(CommonStatusMessage.RUNNING));
     }
 
+    /**
+     * Create a {@link TmfModelResponse} for values with common sampling values,
+     * with a either RUNNING or COMPLETED status. Model is not null, it's either
+     * partial or full.
+     *
+     * @param title
+     *            Chart title
+     * @param samples
+     *            The samples requested by the viewer
+     * @param yModels
+     *            Collection of IYModel
+     * @param isComplete
+     *            Tells whether the computed model is complete or partial
+     * @return A {@link TmfModelResponse} with either a running status or a
+     *         completed status
+     */
+    public static TmfModelResponse<ITmfXyModel> create(String title, Sampling samples, Collection<IYModel> yModels, boolean isComplete) {
+        List<ISeriesModel> series = Lists.transform(new ArrayList<>(yModels), model -> {
+            SeriesModelBuilder builder = new SeriesModelBuilder(model.getId(), model.getName(), samples, model.getData());
+            TmfXYAxisDescription yAxis = model.getYAxisDescription();
+            if (yAxis != null) {
+                builder.yAxisDescription(yAxis);
+            }
+            return builder.build();
+        });
+        ITmfXyModel model = new TmfXyModel(title, series);
+
+        if (isComplete) {
+            return new TmfModelResponse<>(model, ITmfResponse.Status.COMPLETED, Objects.requireNonNull(CommonStatusMessage.COMPLETED));
+        }
+        return new TmfModelResponse<>(model, ITmfResponse.Status.RUNNING, Objects.requireNonNull(CommonStatusMessage.RUNNING));
+    }
+
+    /**
+     * Create a {@link TmfModelResponse} for values with common sampling values,
+     * with a either RUNNING or COMPLETED status. Model is not null, it's either
+     * partial or full.
+     *
+     * @param title
+     *            Chart title
+     * @param samples
+     *            The samples requested by the viewer
+     * @param yModels
+     *            Collection of IYModel
+     * @param displayType
+     *            The type of display, see {@link DisplayType}
+     * @param isComplete
+     *            Tells whether the computed model is complete or partial
+     * @return A {@link TmfModelResponse} with either a running status or a
+     *         completed status
+     */
+    public static TmfModelResponse<ITmfXyModel> create(String title, Sampling samples, Collection<IYModel> yModels, DisplayType displayType, boolean isComplete) {
+        List<ISeriesModel> series = Lists.transform(new ArrayList<>(yModels), model -> {
+            SeriesModelBuilder builder = new SeriesModelBuilder(model.getId(), model.getName(), samples, model.getData());
+            TmfXYAxisDescription yAxis = model.getYAxisDescription();
+            if (yAxis != null) {
+                builder.yAxisDescription(yAxis);
+            }
+            builder.seriesDisplayType(displayType);
+            return builder.build();
+        });
+        ITmfXyModel model = new TmfXyModel(title, series);
+
+        if (isComplete) {
+            return new TmfModelResponse<>(model, ITmfResponse.Status.COMPLETED, Objects.requireNonNull(CommonStatusMessage.COMPLETED));
+        }
+        return new TmfModelResponse<>(model, ITmfResponse.Status.RUNNING, Objects.requireNonNull(CommonStatusMessage.RUNNING));
+    }
+
     /**
      * Create a {@link TmfModelResponse} with a either RUNNING or COMPLETED status.
      * Model is not null, it's either partial or full.

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/internal/tmf/core/model/filters/FetchParametersUtils.java

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2019 Ericsson
+ * Copyright (c) 2019, 2025 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -20,7 +20,9 @@
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.tracecompass.internal.provisional.tmf.core.model.filters.VirtualTableQueryFilter;
 import org.eclipse.tracecompass.tmf.core.dataprovider.DataProviderParameterUtils;
+import org.eclipse.tracecompass.tmf.core.model.barchart.Sampling;
 import org.eclipse.tracecompass.tmf.core.model.filters.FilterTimeQueryFilter;
+import org.eclipse.tracecompass.tmf.core.model.filters.SelectionSamplingQueryFilter;
 import org.eclipse.tracecompass.tmf.core.model.filters.SelectionTimeQueryFilter;
 import org.eclipse.tracecompass.tmf.core.model.filters.TimeQueryFilter;
 
@@ -61,6 +63,19 @@ private FetchParametersUtils() {
         return (timeRequested == null || selectedItems == null) ? null : new SelectionTimeQueryFilter(timeRequested, selectedItems);
     }
 
+    /**
+     * Create a {@link SelectionSamplingQueryFilter} with the given map of parameters
+     *
+     * @param parameters
+     *            Map of parameters
+     * @return A {@link SelectionSamplingQueryFilter} or null if the parameters are invalid
+     */
+    public static @Nullable SelectionSamplingQueryFilter createSelectionSamplingQuery(Map<String, Object> parameters) {
+        Sampling samplingRequested = DataProviderParameterUtils.extractSamplingRequested(parameters);
+        List<Long> selectedItems = DataProviderParameterUtils.extractSelectedItems(parameters);
+        return (samplingRequested == null || selectedItems == null) ? null : new SelectionSamplingQueryFilter(samplingRequested, selectedItems);
+    }
+
     /**
      * Create a {@link VirtualTableQueryFilter} with the given map of parameters
      *

tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/dataprovider/DataProviderParameterUtils.java

@@ -1,5 +1,5 @@
 /**********************************************************************
- * Copyright (c) 2019 Ericsson
+ * Copyright (c) 2019, 2025 Ericsson
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -22,6 +22,7 @@
 import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.tracecompass.internal.tmf.core.Activator;
+import org.eclipse.tracecompass.tmf.core.model.barchart.Sampling;
 
 import com.google.common.collect.HashMultimap;
 import com.google.common.collect.Multimap;
@@ -41,6 +42,12 @@ public class DataProviderParameterUtils {
      */
     public static final String REQUESTED_TIME_KEY = "requested_times"; //$NON-NLS-1$
 
+    /**
+     * Sampling requested key
+     * @since 10.2
+     */
+    public static final String REQUESTED_SAMPLING_KEY = "requested_sampling"; //$NON-NLS-1$
+
     /**
      * Selected items key
      */
@@ -178,6 +185,62 @@ private DataProviderParameterUtils() {
         return null;
     }
 
+    /**
+     * Extract a {@link Sampling} object from a map of parameters.
+     *
+     * Supports the following formats:
+     * <ul>
+     *   <li>{@code [1, 2, 3]} for {@link Sampling.Timestamps}</li>
+     *   <li>{@code ["Read", "Write", "Idle"]} for {@link Sampling.Categories}</li>
+     *   <li>{@code [[1, 2], [3, 4]]} for {@link Sampling.Ranges}</li>
+     * </ul>
+     *
+     * @param parameters
+     *            Map of parameters
+     * @param key
+     *            Parameter key for the value to extract
+     * @return a {@link Sampling} instance, or null if extraction fails
+     * @since 10.2
+     */
+    @SuppressWarnings("null")
+    public static @Nullable Sampling extractSampling(Map<String, Object> parameters, String key) {
+        Object value = parameters.get(key);
+        if (!(value instanceof Collection<?> collection)) {
+            return null;
+        }
+
+        // Check for [1, 2, 3] -> Timestamps
+        if (collection.stream().allMatch(o -> o instanceof Number)) {
+            long[] timestamps = collection.stream()
+                    .mapToLong(o -> ((Number) o).longValue())
+                    .toArray();
+            return new Sampling.Timestamps(timestamps);
+        }
+
+        // Check for ["a", "b", "c"] -> Categories
+        if (collection.stream().allMatch(o -> o instanceof String)) {
+            List<String> categories = (List<String>) collection.stream().map(Object::toString).toList();
+            return new Sampling.Categories(categories);
+        }
+
+        // Check for [[1,2],[3,4]] -> TimeRanges
+        List<Sampling.Range<Long>> ranges = new ArrayList<>();
+        for (Object item : collection) {
+            if (!(item instanceof List<?> pair) || pair.size() != 2) {
+                return null; // Invalid range entry
+            }
+            Object first = pair.get(0);
+            Object second = pair.get(1);
+            if (!(first instanceof Number) || !(second instanceof Number)) {
+                return null; // Invalid types in range
+            }
+            long start = ((Number) first).longValue();
+            long end = ((Number) second).longValue();
+            ranges.add(new Sampling.Range<>(start, end));
+        }
+        return ranges.isEmpty() ? null : new Sampling.Ranges(ranges);
+    }
+
     /**
      * Helper to extract time requested from a map of parameters
      *
@@ -189,6 +252,18 @@ private DataProviderParameterUtils() {
         return extractLongList(parameters, REQUESTED_TIME_KEY);
     }
 
+    /**
+     * Helper to extract time requested from a map of parameters
+     *
+     * @param parameters
+     *            Map of parameters
+     * @return List of times or null if no time requested in the map
+     * @since 10.2
+     */
+    public static @Nullable Sampling extractSamplingRequested(Map<String, Object> parameters) {
+        return extractSampling(parameters, REQUESTED_SAMPLING_KEY);
+    }
+
     /**
      * Helper to extract selected items from a map of parameters
      *