1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*******************************************************************************
* Copyright (c) 2007, 2008 Wind River Systems, Inc. and others.
* 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:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tm.tcf.services;
import java.util.Map;
import org.eclipse.tm.tcf.protocol.IService;
import org.eclipse.tm.tcf.protocol.IToken;
public interface IStackTrace extends IService {
static final String NAME = "StackTrace";
/**
* Stack frame context property names.
*/
static final String
PROP_ID = "ID", /** String, stack frame ID */
PROP_PARENT_ID = "ParentID", /** String, stack frame parent ID */
PROP_PROCESS_ID = "ProcessID", /** String, stack frame process ID */
PROP_NAME = "Name", /** String, human readable name */
PROP_TOP_FRAME = "TopFrame", /** Boolean, true if the frame is top frame on a stack */
PROP_LEVEL = "Level", /** Integer, stack frame level, starting from stack bottom */
PROP_FRAME_ADDRESS = "FP", /** Number, stack frame memory address */
PROP_RETURN_ADDRESS = "RP", /** Number, return address */
PROP_INSTRUCTION_ADDRESS = "IP", /** Number, instruction pointer */
PROP_ARGUMENTS_COUNT = "ArgsCnt", /** Integer, number of function arguments */
PROP_ARGUMENTS_ADDRESS = "ArgsAddr"; /** Number, memory address of function arguments */
/**
* Retrieve context info for given context IDs.
*
* The command will fail if parent thread is not suspended.
* Client can use Run Control service to suspend a thread.
*
* @param id – array of context IDs.
* @param done - call back interface called when operation is completed.
*/
IToken getContext(String[] id, DoneGetContext done);
/**
* Client call back interface for getContext().
*/
interface DoneGetContext {
/**
* Called when context data retrieval is done.
* @param error – error description if operation failed, null if succeeded.
* @param context – array of context data or null if error.
*/
void doneGetContext(IToken token, Exception error, StackTraceContext[] context);
}
/**
* Retrieve stack trace context list.
* Parent context usually corresponds to an execution thread.
* Some targets have more then one stack. In such case children of a thread
* are stacks, and stack frames are deeper in the hierarchy - they can be
* retrieved with additional getChildren commands.
*
* The command will fail if parent thread is not suspended.
* Client can use Run Control service to suspend a thread.
*
* @param parent_context_id – parent context ID.
* @param done - call back interface called when operation is completed.
*/
IToken getChildren(String parent_context_id, DoneGetChildren done);
/**
* Client call back interface for getChildren().
*/
interface DoneGetChildren {
/**
* Called when context list retrieval is done.
* @param error – error description if operation failed, null if succeeded.
* @param context_ids – array of available context IDs.
* Stack frames are ordered from stack bottom to top.
*/
void doneGetChildren(IToken token, Exception error, String[] context_ids);
}
/**
* StackTraceContext represents stack trace objects - stacks and stack frames.
*/
interface StackTraceContext {
/**
* Get Context ID.
* @return context ID.
*/
String getID();
/**
* Get parent context ID.
* @return parent context ID.
*/
String getParentID();
/**
* Get context name - if context represents a stack.
* @return context name or null.
*/
String getName();
/**
* Get memory address of this frame.
* @return address or null if not a stack frame.
*/
Number getFrameAddress();
/**
* Get program counter saved in this stack frame -
* it is address of instruction to be executed when the function returns.
* @return return address or null if not a stack frame.
*/
Number getReturnAddress();
/**
* Get address of the next instruction to be executed in this stack frame.
* For top frame it is same as PC register value.
* For other frames it is same as return address of the next frame.
* @return instruction address or null if not a stack frame.
*/
Number getInstructionAddress();
/**
* Get number of function arguments for this frame.
* @return function arguments count.
*/
int getArgumentsCount();
/**
* Get address of function arguments area in memory.
* @return function arguments address or null if not available.
*/
Number getArgumentsAddress();
/**
* Get complete map of context properties.
* @return map of context properties.
*/
Map<String,Object> getProperties();
}
}
|
