--- /dev/null
+/*******************************************************************************
+ * Copyright (c) 2013 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
+ *
+ * Contributors:
+ * Alexandre Montplaisir - Initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.linuxtools.internal.lttng2.ust.core.trace.callstack;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import org.eclipse.linuxtools.lttng2.ust.core.trace.LttngUstTrace;
+import org.eclipse.linuxtools.tmf.core.callstack.CallStackStateProvider;
+import org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfEvent;
+import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
+import org.eclipse.linuxtools.tmf.core.event.ITmfEventField;
+
+/**
+ * Callstack provider for LTTng-UST traces.
+ *
+ * If the traces contains 'func_entry' and 'func_exit' event (see the
+ * lttng-ust-cyg-profile manpage), AND contains vtid and procname contexts, we
+ * can use this information to populate the TMF Callstack View.
+ *
+ * Granted, most UST traces will not contain this information. In this case,
+ * this will simply build an empty state system, and the view will remain
+ * unavailable.
+ *
+ * @author Alexandre Montplaisir
+ */
+public class LttngUstCallStackProvider extends CallStackStateProvider {
+
+ // ------------------------------------------------------------------------
+ // Event strings
+ // ------------------------------------------------------------------------
+
+ /** Name of the fake field for the vtid contexts */
+ private static final String CONTEXT_VTID = "context._vtid"; //$NON-NLS-1$
+
+ /** Name of the fake field for the procname context */
+ private static final String CONTEXT_PROCNAME = "context._procname"; //$NON-NLS-1$
+
+ /** Field name for the target function address */
+ private static final String FIELD_ADDR = "addr"; //$NON-NLS-1$
+
+ /** Event names indicating function entry */
+ private static final Set<String> FUNC_ENTRY_EVENTS = new HashSet<String>();
+
+ /** Event names indicating function exit */
+ private static final Set<String> FUNC_EXIT_EVENTS = new HashSet<String>();
+
+ static {
+ /* This seems overkill, but it will be checked every event. Gotta go FAST! */
+ FUNC_ENTRY_EVENTS.add("lttng_ust_cyg_profile:func_entry"); //$NON-NLS-1$
+ FUNC_ENTRY_EVENTS.add("lttng_ust_cyg_profile_fast:func_entry"); //$NON-NLS-1$
+
+ FUNC_EXIT_EVENTS.add("lttng_ust_cyg_profile:func_exit"); //$NON-NLS-1$
+ FUNC_EXIT_EVENTS.add("lttng_ust_cyg_profile_fast:func_exit"); //$NON-NLS-1$
+ }
+
+ // ------------------------------------------------------------------------
+ // Constructor
+ // ------------------------------------------------------------------------
+
+ /**
+ * Constructor
+ *
+ * @param trace
+ * The UST trace
+ */
+ public LttngUstCallStackProvider(LttngUstTrace trace) {
+ super(trace);
+ }
+
+ // ------------------------------------------------------------------------
+ // Methods from AbstractTmfStateProvider
+ // ------------------------------------------------------------------------
+
+ @Override
+ public LttngUstTrace getTrace() {
+ /* Type is enforced by the constructor */
+ return (LttngUstTrace) super.getTrace();
+ }
+
+ @Override
+ public LttngUstCallStackProvider getNewInstance() {
+ return new LttngUstCallStackProvider(getTrace());
+ }
+
+ // ------------------------------------------------------------------------
+ // Methods from CallStackStateProvider
+ // ------------------------------------------------------------------------
+
+ /**
+ * Check that this event contains the required information we need to be
+ * used in the call stack view. We need at least the "procname" and "vtid"
+ * contexts.
+ */
+ @Override
+ protected boolean considerEvent(ITmfEvent event) {
+ if (!(event instanceof CtfTmfEvent)) {
+ return false;
+ }
+ ITmfEventField content = ((CtfTmfEvent) event).getContent();
+ if (content.getField(CONTEXT_VTID) == null ||
+ content.getField(CONTEXT_PROCNAME) == null) {
+ return false;
+ }
+ return true;
+ }
+
+ @Override
+ public String functionEntry(ITmfEvent event) {
+ String eventName = ((CtfTmfEvent) event).getEventName();
+ if (!FUNC_ENTRY_EVENTS.contains(eventName)) {
+ return null;
+ }
+ Long address = (Long) event.getContent().getField(FIELD_ADDR).getValue();
+ return getFunctionNameFromAddress(address.longValue());
+ }
+
+ @Override
+ public String functionExit(ITmfEvent event) {
+ String eventName = ((CtfTmfEvent) event).getEventName();
+ if (!FUNC_EXIT_EVENTS.contains(eventName)) {
+ return null;
+ }
+ /*
+ * The 'addr' field may or may not be present in func_exit events,
+ * depending on if cyg-profile.so or cyg-profile-fast.so was used.
+ */
+ ITmfEventField field = event.getContent().getField(FIELD_ADDR);
+ if (field == null) {
+ return CallStackStateProvider.UNDEFINED;
+ }
+ Long address = (Long) field.getValue();
+ return getFunctionNameFromAddress(address.longValue());
+ }
+
+ @Override
+ public String getThreadName(ITmfEvent event) {
+ /* Class type and content was already checked if we get called here */
+ ITmfEventField content = ((CtfTmfEvent) event).getContent();
+ String procName = (String) content.getField(CONTEXT_PROCNAME).getValue();
+ Long vtid = (Long) content.getField(CONTEXT_VTID).getValue();
+
+ if (procName == null || vtid == null) {
+ throw new IllegalStateException();
+ }
+
+ return new String(procName + '-' + vtid.toString());
+ }
+
+ // ------------------------------------------------------------------------
+ // Internal helper methods
+ // ------------------------------------------------------------------------
+
+ private static String getFunctionNameFromAddress(long address) {
+ /*
+ * We do not support getting the real function name yet, just print the
+ * hex string.
+ */
+ return new String("0x" + Long.toHexString(address)); //$NON-NLS-1$
+ }
+}
*
* Contributors:
* Matthew Khouzam - Initial API and implementation
+ * Alexandre Montplaisir - Add UST callstack state system
**********************************************************************/
package org.eclipse.linuxtools.lttng2.ust.core.trace;
+import java.io.File;
+
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException;
import org.eclipse.linuxtools.ctf.core.trace.CTFTrace;
import org.eclipse.linuxtools.internal.lttng2.ust.core.Activator;
+import org.eclipse.linuxtools.internal.lttng2.ust.core.trace.callstack.LttngUstCallStackProvider;
+import org.eclipse.linuxtools.tmf.core.callstack.CallStackStateProvider;
import org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfTrace;
+import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
+import org.eclipse.linuxtools.tmf.core.statesystem.ITmfStateProvider;
+import org.eclipse.linuxtools.tmf.core.statesystem.ITmfStateSystem;
+import org.eclipse.linuxtools.tmf.core.statesystem.TmfStateSystemFactory;
+import org.eclipse.linuxtools.tmf.core.trace.TmfTraceManager;
/**
* Class to contain LTTng-UST traces
*/
public class LttngUstTrace extends CtfTmfTrace {
+ /** Name of the history file for the callstack state system */
+ private static final String CALLSTACK_FILENAME = "ust-callstack.ht"; //$NON-NLS-1$
+
/**
* Default constructor
*/
status = new Status(IStatus.ERROR, Activator.PLUGIN_ID, Messages.LttngUstTrace_DomainError);
return status;
}
+
+ @Override
+ public IStatus buildStateSystem() {
+ super.buildStateSystem();
+
+ /*
+ * Build the state system for the UST Callstack (will be empty if the
+ * required events are not present).
+ */
+ String directory = TmfTraceManager.getSupplementaryFileDir(this);
+ final File htFile = new File(directory + CALLSTACK_FILENAME);
+ ITmfStateProvider csInput = new LttngUstCallStackProvider(this);
+
+ try {
+ ITmfStateSystem ss = TmfStateSystemFactory.newFullHistory(htFile, csInput, false);
+ registerStateSystem(CallStackStateProvider.ID, ss);
+ } catch (TmfTraceException e) {
+ return new Status(IStatus.ERROR, Activator.PLUGIN_ID, e.getMessage(), e);
+ }
+
+ return Status.OK_STATUS;
+ }
}
projects / deliverable / tracecompass.git / commitdiff
