|
| 1 | +/********************************************************************** |
| 2 | + * Copyright (c) 2018, 2021 Ericsson |
| 3 | + * |
| 4 | + * All rights reserved. This program and the accompanying materials are |
| 5 | + * made available under the terms of the Eclipse Public License 2.0 which |
| 6 | + * accompanies this distribution, and is available at |
| 7 | + * https://www.eclipse.org/legal/epl-2.0/ |
| 8 | + * |
| 9 | + * SPDX-License-Identifier: EPL-2.0 |
| 10 | + **********************************************************************/ |
| 11 | + |
| 12 | +package org.eclipse.tracecompass.internal.provisional.tmf.core.model.events; |
| 13 | + |
| 14 | +import java.util.ArrayList; |
| 15 | +import java.util.LinkedHashMap; |
| 16 | +import java.util.List; |
| 17 | +import java.util.Map; |
| 18 | +import java.util.regex.Pattern; |
| 19 | + |
| 20 | +import org.eclipse.core.runtime.IProgressMonitor; |
| 21 | +import org.eclipse.jdt.annotation.Nullable; |
| 22 | +import org.eclipse.tracecompass.tmf.core.event.ITmfEvent; |
| 23 | +import org.eclipse.tracecompass.tmf.core.event.ITmfEventField; |
| 24 | +import org.eclipse.tracecompass.tmf.core.event.aspect.TmfBaseAspects; |
| 25 | +import org.eclipse.tracecompass.tmf.core.model.AbstractTmfTraceDataProvider; |
| 26 | +import org.eclipse.tracecompass.tmf.core.model.CommonStatusMessage; |
| 27 | +import org.eclipse.tracecompass.tmf.core.model.object.IObjectDataProvider; |
| 28 | +import org.eclipse.tracecompass.tmf.core.model.object.ObjectModel; |
| 29 | +import org.eclipse.tracecompass.tmf.core.response.ITmfResponse; |
| 30 | +import org.eclipse.tracecompass.tmf.core.response.TmfModelResponse; |
| 31 | +import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp; |
| 32 | +import org.eclipse.tracecompass.tmf.core.trace.ITmfContext; |
| 33 | +import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; |
| 34 | + |
| 35 | +import com.google.common.collect.ImmutableMap; |
| 36 | +import com.google.common.collect.ImmutableMap.Builder; |
| 37 | + |
| 38 | +/** |
| 39 | + * This data provider will return an object representing an array of raw event |
| 40 | + * data. |
| 41 | + * |
| 42 | + * @author Patrick Tasse |
| 43 | + */ |
| 44 | +public class TmfEventRawDataProvider extends AbstractTmfTraceDataProvider implements IObjectDataProvider { |
| 45 | + |
| 46 | + /** |
| 47 | + * Extension point ID. |
| 48 | + */ |
| 49 | + public static final String ID = "org.eclipse.tracecompass.tmf.core.model.events.data"; //$NON-NLS-1$ |
| 50 | + |
| 51 | + private static final int MAX_SIZE = 500; |
| 52 | + private static final String SELECTION_RANGE = "selection_range"; //$NON-NLS-1$ |
| 53 | + private static final String NEXT = "next"; //$NON-NLS-1$ |
| 54 | + private static final String PREVIOUS = "previous"; //$NON-NLS-1$ |
| 55 | + private static final String TYPE = "type"; //$NON-NLS-1$ |
| 56 | + private static final String FIELD = "field"; //$NON-NLS-1$ |
| 57 | + private static final String START = "start"; //$NON-NLS-1$ |
| 58 | + |
| 59 | + /** |
| 60 | + * Constructor |
| 61 | + * |
| 62 | + * @param trace |
| 63 | + * A trace on which we are interested to fetch a raw event model |
| 64 | + */ |
| 65 | + public TmfEventRawDataProvider(ITmfTrace trace) { |
| 66 | + super(trace); |
| 67 | + } |
| 68 | + |
| 69 | + @Override |
| 70 | + public String getId() { |
| 71 | + return ID; |
| 72 | + } |
| 73 | + |
| 74 | + @Override |
| 75 | + public TmfModelResponse<ObjectModel> fetchData(Map<String, Object> fetchParameters, @Nullable IProgressMonitor monitor) { |
| 76 | + ITmfTrace trace = getTrace(); |
| 77 | + long rank = 0L; |
| 78 | + Object selectionRangeObj = fetchParameters.get(SELECTION_RANGE); |
| 79 | + Object nextObj = fetchParameters.get(NEXT); |
| 80 | + Object previousObj = fetchParameters.get(PREVIOUS); |
| 81 | + Object typeObj = fetchParameters.get(TYPE); |
| 82 | + Object fieldObj = fetchParameters.get(FIELD); |
| 83 | + if (nextObj instanceof Number next) { |
| 84 | + rank = next.longValue(); |
| 85 | + } else if (previousObj instanceof Number previous) { |
| 86 | + rank = previous.longValue(); |
| 87 | + } else if (selectionRangeObj instanceof Map<?,?> selectionRange) { |
| 88 | + if (selectionRange.get(START) instanceof Number start) { |
| 89 | + rank = trace.seekEvent(TmfTimestamp.fromNanos(start.longValue())).getRank(); |
| 90 | + } |
| 91 | + } |
| 92 | + Pattern eventTypePattern = null; |
| 93 | + if (typeObj instanceof String type) { |
| 94 | + eventTypePattern = Pattern.compile(type); |
| 95 | + } |
| 96 | + Pattern fieldPattern = null; |
| 97 | + if (fieldObj instanceof String field) { |
| 98 | + fieldPattern = Pattern.compile(field); |
| 99 | + } |
| 100 | + ITmfContext context = trace.seekEvent(rank); |
| 101 | + List<Object> object = new ArrayList<>(); |
| 102 | + while (object.size() < MAX_SIZE) { |
| 103 | + long eventRank = context.getRank(); |
| 104 | + ITmfEvent event = trace.getNext(context); |
| 105 | + if (event == null) { |
| 106 | + break; |
| 107 | + } |
| 108 | + if (eventTypePattern == null || eventTypePattern.matcher(event.getName()).find()) { |
| 109 | + Object eventObj = convertEvent(event, eventRank, fieldPattern); |
| 110 | + if (eventObj != null) { |
| 111 | + object.add(eventObj); |
| 112 | + } |
| 113 | + } |
| 114 | + } |
| 115 | + ObjectModel model = new ObjectModel(object); |
| 116 | + long next = context.getRank(); |
| 117 | + if (trace.getNext(context) != null) { |
| 118 | + model.setNext(next); |
| 119 | + } |
| 120 | + if (rank > 0L) { |
| 121 | + model.setPrevious(Math.max(0L, rank - MAX_SIZE)); |
| 122 | + } |
| 123 | + return new TmfModelResponse<>(model, ITmfResponse.Status.COMPLETED, CommonStatusMessage.COMPLETED); |
| 124 | + } |
| 125 | + |
| 126 | + private static @Nullable Object convertEvent(ITmfEvent event, long rank, @Nullable Pattern fieldPattern) { |
| 127 | + Map<String, @Nullable Object> data = new LinkedHashMap<>(); |
| 128 | + |
| 129 | + // Add basic event information |
| 130 | + data.put("rank", rank); |
| 131 | + data.put(TmfBaseAspects.getTimestampAspect().getName(), event.getTimestamp().toNanos()); |
| 132 | + data.put(TmfBaseAspects.getEventTypeAspect().getName(), event.getType().getName()); |
| 133 | + Object contents = convertEventField(event.getContent(), fieldPattern); |
| 134 | + if (fieldPattern != null && contents instanceof Map map) { |
| 135 | + if (map.isEmpty()) { |
| 136 | + return null; |
| 137 | + } |
| 138 | + } |
| 139 | + data.put(TmfBaseAspects.getContentsAspect().getName(), contents); |
| 140 | + return data; |
| 141 | + } |
| 142 | + |
| 143 | + private static @Nullable Object convertEventField(@Nullable ITmfEventField field, @Nullable Pattern fieldPattern) { |
| 144 | + if (field == null) { |
| 145 | + return null; |
| 146 | + } |
| 147 | + Builder<String, @Nullable Object> builder = ImmutableMap.builder(); |
| 148 | + for (ITmfEventField subField : field.getFields()) { |
| 149 | + if (subField == null) { |
| 150 | + continue; |
| 151 | + } |
| 152 | + String name = subField.getName(); |
| 153 | + if (fieldPattern == null || fieldPattern.matcher(name).find()) { |
| 154 | + Object value = subField.getValue(); |
| 155 | + if (value instanceof ITmfEventField) { |
| 156 | + builder.put(name, convertEventField((ITmfEventField) value, null)); |
| 157 | + } else { |
| 158 | + builder.put(name, value); |
| 159 | + } |
| 160 | + } |
| 161 | + } |
| 162 | + Object value = field.getValue(); |
| 163 | + if (value instanceof ITmfEventField) { |
| 164 | + value = convertEventField((ITmfEventField) value, null); |
| 165 | + } |
| 166 | + ImmutableMap<String, @Nullable Object> fields = builder.build(); |
| 167 | + if (value == null) { |
| 168 | + return fields; |
| 169 | + } else if (fields.isEmpty()) { |
| 170 | + return value; |
| 171 | + } else { |
| 172 | + return Map.of("value", value, "fields", fields); //$NON-NLS-1$ //$NON-NLS-2$ |
| 173 | + } |
| 174 | + } |
| 175 | +} |
0 commit comments