| /******************************************************************************* |
| * Copyright (c) 2017 Ericsson |
| * |
| * All rights reserved. This program and the accompanying materials are made |
| * available under the terms of the Eclipse Public License v1.0 which |
| * accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| *******************************************************************************/ |
| |
| package org.eclipse.tracecompass.incubator.internal.traceevent.core.trace; |
| |
| import java.io.File; |
| import java.io.IOException; |
| import java.io.RandomAccessFile; |
| import java.util.HashMap; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.NavigableMap; |
| import java.util.Set; |
| import java.util.TreeMap; |
| |
| import org.eclipse.core.resources.IProject; |
| import org.eclipse.core.resources.IResource; |
| import org.eclipse.core.runtime.IStatus; |
| import org.eclipse.core.runtime.Status; |
| import org.eclipse.core.runtime.jobs.Job; |
| import org.eclipse.jdt.annotation.NonNull; |
| import org.eclipse.jdt.annotation.Nullable; |
| import org.eclipse.tracecompass.incubator.internal.traceevent.core.Activator; |
| import org.eclipse.tracecompass.incubator.internal.traceevent.core.event.TraceEventAspects; |
| import org.eclipse.tracecompass.incubator.internal.traceevent.core.event.TraceEventEvent; |
| import org.eclipse.tracecompass.incubator.internal.traceevent.core.event.TraceEventField; |
| import org.eclipse.tracecompass.internal.provisional.jsontrace.core.trace.JsonTrace; |
| import org.eclipse.tracecompass.tmf.core.event.ITmfEvent; |
| import org.eclipse.tracecompass.tmf.core.event.aspect.ITmfEventAspect; |
| import org.eclipse.tracecompass.tmf.core.exceptions.TmfTraceException; |
| import org.eclipse.tracecompass.tmf.core.io.BufferedRandomAccessFile; |
| import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp; |
| import org.eclipse.tracecompass.tmf.core.trace.ITmfContext; |
| import org.eclipse.tracecompass.tmf.core.trace.TmfTraceManager; |
| import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils; |
| import org.eclipse.tracecompass.tmf.core.trace.TraceValidationStatus; |
| import org.eclipse.tracecompass.tmf.core.trace.location.ITmfLocation; |
| import org.eclipse.tracecompass.tmf.core.trace.location.TmfLongLocation; |
| |
| import com.google.common.collect.Lists; |
| |
| /** |
| * Trace event trace. Can read trace event unsorted or sorted JSON traces. |
| * |
| * @author Matthew Khouzam |
| * |
| */ |
| public class TraceEventTrace extends JsonTrace { |
| |
| /** |
| * Tid prefix to add to thread name |
| */ |
| private static final String TID_PREFIX = "tid-"; //$NON-NLS-1$ |
| /** |
| * Pid Labels prefix |
| */ |
| private static final String PID_LABEL_PREFIX = "pidLabel-"; //$NON-NLS-1$ |
| /** |
| * Pid name prefix |
| */ |
| private static final String PID_PREFIX = "pid-"; //$NON-NLS-1$ |
| /** |
| * Metadata Field String Name |
| */ |
| private static final String NAME_ARG = "name"; //$NON-NLS-1$ |
| /** |
| * Metadata Field String labels |
| */ |
| private static final String LABELS = "labels"; //$NON-NLS-1$ |
| /** |
| * Metadata Field String sort index |
| */ |
| private static final String SORT_INDEX = "sort_index"; //$NON-NLS-1$ |
| /** |
| * Metadata String Process Name |
| */ |
| private static final String PROCESS_NAME = "process_name"; //$NON-NLS-1$ |
| /** |
| * Metadata String Process Labels |
| */ |
| private static final String PROCESS_LABELS = "process_labels"; //$NON-NLS-1$ |
| /** |
| * Metadata String Process Sort Index |
| */ |
| private static final String PROCESS_SORT_INDEX = "process_sort_index"; //$NON-NLS-1$ |
| /** |
| * Metadata String Thread Name |
| */ |
| private static final String THREAD_NAME = "thread_name"; //$NON-NLS-1$ |
| /** |
| * Metadata String Thread Sort Index |
| */ |
| private static final String THREAD_SORT_INDEX = "thread_sort_index"; //$NON-NLS-1$ |
| |
| private final @NonNull Map<Object, String> fPidNames = new HashMap<>(); |
| private final @NonNull NavigableMap<Integer, String> fTidNames = new TreeMap<>(); |
| private final @NonNull Iterable<@NonNull ITmfEventAspect<?>> fEventAspects; |
| |
| /** |
| * Constructor |
| */ |
| public TraceEventTrace() { |
| List<@NonNull ITmfEventAspect<?>> aspects = Lists.newArrayList(TraceEventAspects.getAspects()); |
| aspects.add(new ProcessNameAspect()); |
| aspects.add(new ThreadNameAspect()); |
| fEventAspects = aspects; |
| } |
| |
| @Override |
| public IStatus validate(IProject project, String path) { |
| File file = new File(path); |
| if (!file.exists()) { |
| return new Status(IStatus.ERROR, Activator.PLUGIN_ID, "File not found: " + path); //$NON-NLS-1$ |
| } |
| if (!file.isFile()) { |
| return new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Not a file. It's a directory: " + path); //$NON-NLS-1$ |
| } |
| int confidence = 0; |
| |
| try { |
| if (!TmfTraceUtils.isText(file)) { |
| return new TraceValidationStatus(confidence, Activator.PLUGIN_ID); |
| } |
| } catch (IOException e) { |
| Activator.getInstance().logError("Error validating file: " + path, e); //$NON-NLS-1$ |
| return new Status(IStatus.ERROR, Activator.PLUGIN_ID, "IOException validating file: " + path, e); //$NON-NLS-1$ |
| } |
| try (BufferedRandomAccessFile rafile = new BufferedRandomAccessFile(path, "r")) { //$NON-NLS-1$ |
| goToCorrectStart(rafile); |
| int lineCount = 0; |
| int matches = 0; |
| String line = readNextEventString(() -> rafile.read()); |
| while ((line != null) && (lineCount++ < MAX_LINES)) { |
| try { |
| TraceEventField field = TraceEventField.parseJson(line); |
| if (field != null) { |
| matches++; |
| } |
| } catch (RuntimeException e) { |
| confidence = Integer.MIN_VALUE; |
| } |
| |
| confidence = MAX_CONFIDENCE * matches / lineCount; |
| line = readNextEventString(() -> rafile.read()); |
| } |
| if (matches == 0) { |
| return new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Most assuredly NOT a Trace-Event trace"); //$NON-NLS-1$ |
| } |
| } catch (IOException e) { |
| Activator.getInstance().logError("Error validating file: " + path, e); //$NON-NLS-1$ |
| return new Status(IStatus.ERROR, Activator.PLUGIN_ID, "IOException validating file: " + path, e); //$NON-NLS-1$ |
| } |
| return new TraceValidationStatus(confidence, Activator.PLUGIN_ID); |
| } |
| |
| @Override |
| public void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException { |
| super.initTrace(resource, path, type); |
| fProperties.put("Type", "Trace-Event"); //$NON-NLS-1$ //$NON-NLS-2$ |
| String dir = TmfTraceManager.getSupplementaryFileDir(this); |
| fFile = new File(dir + new File(path).getName()); |
| if (!fFile.exists()) { |
| Job sortJob = new TraceEventSortingJob(this, path); |
| sortJob.schedule(); |
| while (sortJob.getResult() == null) { |
| try { |
| sortJob.join(); |
| } catch (InterruptedException e) { |
| throw new TmfTraceException(e.getMessage(), e); |
| } |
| } |
| IStatus result = sortJob.getResult(); |
| if (!result.isOK()) { |
| throw new TmfTraceException("Job failed " + result.getMessage()); //$NON-NLS-1$ |
| } |
| } |
| try { |
| fFileInput = new BufferedRandomAccessFile(fFile, "r"); //$NON-NLS-1$ |
| goToCorrectStart(fFileInput); |
| /* Set the start and (current) end times for this trace */ |
| ITmfContext ctx = seekEvent(0L); |
| if (ctx == null) { |
| return; |
| } |
| ITmfEvent event = getNext(ctx); |
| if (event != null) { |
| final ITmfTimestamp curTime = event.getTimestamp(); |
| setStartTime(curTime); |
| setEndTime(curTime); |
| } |
| ctx.dispose(); |
| } catch (IOException e) { |
| throw new TmfTraceException(e.getMessage(), e); |
| } |
| } |
| |
| /** |
| * Update the file position to be at the actual start of events, after the |
| * trace event header |
| * |
| * @param rafile |
| * The random access file |
| * @throws IOException |
| * Exceptions reading the file |
| */ |
| protected static void goToCorrectStart(RandomAccessFile rafile) throws IOException { |
| // skip start if it's {"traceEvents": |
| String traceEventsKey = "\"traceEvents\""; //$NON-NLS-1$ |
| StringBuilder sb = new StringBuilder(); |
| int val = rafile.read(); |
| /* |
| * Skip list contains all the odd control characters |
| */ |
| Set<Integer> skipList = new HashSet<>(); |
| skipList.add((int) ':'); |
| skipList.add((int) '\t'); |
| skipList.add((int) '\n'); |
| skipList.add((int) '\r'); |
| skipList.add((int) ' '); |
| skipList.add((int) '\b'); |
| skipList.add((int) '\f'); |
| while (val != -1 && val != ':' && sb.length() < 14) { |
| if (!skipList.contains(val)) { |
| sb.append((char) val); |
| } |
| val = rafile.read(); |
| } |
| if (!(sb.toString().startsWith('{' + traceEventsKey) && rafile.length() > 14)) { |
| // Trace does not start with {"TraceEvents", maybe it's the events |
| // directly, go back to start of trace |
| rafile.seek(0); |
| } |
| } |
| |
| @Override |
| public Iterable<@NonNull ITmfEventAspect<?>> getEventAspects() { |
| return fEventAspects; |
| } |
| |
| @Override |
| public ITmfEvent parseEvent(ITmfContext context) { |
| @Nullable |
| ITmfLocation location = context.getLocation(); |
| if (location instanceof TmfLongLocation) { |
| TmfLongLocation tmfLongLocation = (TmfLongLocation) location; |
| Long locationInfo = tmfLongLocation.getLocationInfo(); |
| if (location.equals(NULL_LOCATION)) { |
| locationInfo = 0L; |
| } |
| if (locationInfo != null) { |
| try { |
| if (!locationInfo.equals(fFileInput.getFilePointer())) { |
| fFileInput.seek(locationInfo); |
| } |
| String nextJson = readNextEventString(() -> fFileInput.read()); |
| while (nextJson != null) { |
| TraceEventField field = TraceEventField.parseJson(nextJson); |
| if (field == null) { |
| nextJson = readNextEventString(() -> fFileInput.read()); |
| continue; |
| } |
| if (field.getPhase() != 'M') { |
| return new TraceEventEvent(this, context.getRank(), field); |
| } |
| parseMetadata(field); |
| nextJson = readNextEventString(() -> fFileInput.read()); |
| } |
| } catch (IOException e) { |
| Activator.getInstance().logError("Error parsing event", e); //$NON-NLS-1$ |
| } |
| } |
| } |
| return null; |
| } |
| |
| private void parseMetadata(TraceEventField field) { |
| Map<@NonNull String, @NonNull Object> args = field.getArgs(); |
| String name = field.getName(); |
| if (args == null) { |
| return; |
| } |
| switch (name) { |
| case PROCESS_NAME: |
| String procName = (String) args.get(NAME_ARG); |
| fPidNames.put(field.getPid(), procName); |
| if (procName != null) { |
| fProperties.put(PID_PREFIX + field.getPid(), procName); |
| } |
| break; |
| case PROCESS_LABELS: |
| String procLabels = (String) args.get(LABELS); |
| if (procLabels != null) { |
| fProperties.put(PID_LABEL_PREFIX + field.getPid(), procLabels); |
| } |
| break; |
| case PROCESS_SORT_INDEX: |
| String sortIndex = (String) args.get(SORT_INDEX); |
| if (sortIndex != null) { |
| fProperties.put(name + '-' + field.getPid(), sortIndex); |
| } |
| break; |
| case THREAD_NAME: |
| String threadName = (String) args.get(NAME_ARG); |
| fTidNames.put(field.getTid(), threadName); |
| if (threadName != null) { |
| fProperties.put(TID_PREFIX + field.getTid(), threadName); |
| } |
| break; |
| case THREAD_SORT_INDEX: |
| sortIndex = (String) args.get(SORT_INDEX); |
| if (sortIndex != null) { |
| fProperties.put(name + '-' + field.getTid(), sortIndex); |
| } |
| break; |
| default: |
| fProperties.put(name, String.valueOf(args)); |
| break; |
| } |
| |
| } |
| |
| /** |
| * Get the Process name |
| */ |
| public class ProcessNameAspect extends org.eclipse.tracecompass.incubator.analysis.core.aspects.ProcessNameAspect { |
| |
| @Override |
| public @Nullable String resolve(@NonNull ITmfEvent event) { |
| if (event instanceof TraceEventEvent) { |
| TraceEventField field = ((TraceEventEvent) event).getField(); |
| if (field.getPid() != null) { |
| return fPidNames.get(field.getPid()); |
| } |
| } |
| return null; |
| } |
| } |
| |
| /** |
| * Get the Thread name |
| */ |
| public class ThreadNameAspect extends org.eclipse.tracecompass.incubator.analysis.core.aspects.ThreadNameAspect { |
| |
| @Override |
| public @Nullable String resolve(@NonNull ITmfEvent event) { |
| if (event instanceof TraceEventEvent) { |
| TraceEventField field = ((TraceEventEvent) event).getField(); |
| if (field.getTid() != null) { |
| return fTidNames.get(field.getTid()); |
| } |
| } |
| return null; |
| } |
| } |
| } |
