1 /*******************************************************************************
2 * Copyright (c) 2013 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Patrick Tasse - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.core
.callstack
;
15 import org
.eclipse
.linuxtools
.internal
.tmf
.core
.Activator
;
16 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
17 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.AttributeNotFoundException
;
18 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.StateValueTypeException
;
19 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TimeRangeException
;
20 import org
.eclipse
.linuxtools
.tmf
.core
.statesystem
.AbstractTmfStateProvider
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.statevalue
.ITmfStateValue
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.statevalue
.TmfStateValue
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.ITmfTimestamp
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
25 import org
.eclipse
.osgi
.util
.NLS
;
28 * The state provider for traces that support the Call Stack view.
30 * The attribute tree should have the following structure:
35 * | \-- CallStack (stack-attribute)
41 * | \-- CallStack (stack-attribute)
48 * \-- CallStack (stack-attribute)
56 * (Thread n) is an attribute whose name is the name of the thread
58 * CallStack is a stack-attribute whose pushed values are either a string,
59 * int or long representing the function name or address in the call stack.
60 * The type of value used must be constant for a particular CallStack.
62 * @author Patrick Tasse
65 public abstract class CallStackStateProvider
extends AbstractTmfStateProvider
{
67 /** CallStack state system ID */
68 public static final String ID
= "org.eclipse.linuxtools.tmf.callstack"; //$NON-NLS-1$
69 /** Thread attribute */
70 public static final String THREADS
= "Threads"; //$NON-NLS-1$
71 /** CallStack stack-attribute */
72 public static final String CALL_STACK
= "CallStack"; //$NON-NLS-1$
73 /** Undefined function exit name */
74 public static final String UNDEFINED
= "UNDEFINED"; //$NON-NLS-1$
76 /** Dummy function name for when no function is expected */
77 private static final String NO_FUNCTION
= "no function"; //$NON-NLS-1$
83 * The trace for which we build this state system
85 public CallStackStateProvider(ITmfTrace trace
) {
86 super(trace
, ITmfEvent
.class, ID
);
90 protected void eventHandle(ITmfEvent event
) {
91 if (!considerEvent(event
)) {
95 /* Check if the event is a function entry */
96 String functionEntryName
= functionEntry(event
);
97 if (functionEntryName
!= null) {
98 long timestamp
= event
.getTimestamp().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
99 String thread
= getThreadName(event
);
100 int quark
= ss
.getQuarkAbsoluteAndAdd(THREADS
, thread
, CALL_STACK
);
101 ITmfStateValue value
= TmfStateValue
.newValueString(functionEntryName
);
102 ss
.pushAttribute(timestamp
, value
, quark
);
106 /* Check if the event is a function exit */
107 String functionExitName
= functionExit(event
);
108 if (functionExitName
!= null) {
109 long timestamp
= event
.getTimestamp().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
110 String thread
= getThreadName(event
);
111 int quark
= ss
.getQuarkAbsoluteAndAdd(THREADS
, thread
, CALL_STACK
);
112 ITmfStateValue poppedValue
= ss
.popAttribute(timestamp
, quark
);
113 String poppedName
= (poppedValue
== null ? NO_FUNCTION
: poppedValue
.unboxStr());
116 * Verify that the value we are popping matches the one in the
117 * event field, unless the latter is undefined.
119 if (!functionExitName
.equals(UNDEFINED
) &&
120 !functionExitName
.equals(poppedName
)) {
121 Activator
.logWarning(NLS
.bind(
122 Messages
.CallStackStateProvider_UnmatchedPoppedValue
,
128 } catch (TimeRangeException e
) {
130 } catch (AttributeNotFoundException e
) {
132 } catch (StateValueTypeException e
) {
138 * Check if this event should be considered at all for function entry/exit
139 * analysis. This check is only run once per event, before
140 * {@link #functionEntry} and {@link #functionExit} (to avoid repeating
141 * checks in those methods).
145 * @return If false, the event will be ignored by the state provider. If
146 * true processing will continue.
148 protected abstract boolean considerEvent(ITmfEvent event
);
151 * Check an event if it indicates a function entry.
154 * An event to check for function entry
155 * @return The function name of the function entry, or null if not a
158 protected abstract String
functionEntry(ITmfEvent event
);
161 * Check an event if it indicates a function exit.
164 * An event to check for function exit
165 * @return The function name, or UNDEFINED, for a function exit, or null if
166 * not a function exit.
168 protected abstract String
functionExit(ITmfEvent event
);
171 * Return the thread name of a function entry or exit event.
175 * @return The thread name (as will be shown in the view)
177 protected abstract String
getThreadName(ITmfEvent event
);