|
70
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
2 |
<html>
|
|
|
3 |
<head>
|
|
|
4 |
<title>Target Communication Framework Services - Run Control</title>
|
|
|
5 |
</head>
|
|
|
6 |
|
|
|
7 |
<body lang='EN-US'>
|
|
|
8 |
|
|
|
9 |
<h1>Target Communication Framework Services - Run Control</h1>
|
|
|
10 |
|
|
|
11 |
<ul>
|
|
|
12 |
<li><a href='#VersionHistory'>Version History</a>
|
|
|
13 |
<li><a href='#Overview'>Overview</a>
|
|
|
14 |
<li><a href='#Cmds'>Commands</a>
|
|
|
15 |
<ul>
|
|
|
16 |
<li><a href='#CmdGetContext'>Get Context</a>
|
|
|
17 |
<li><a href='#CmdGetChildren'>Get Children</a>
|
|
|
18 |
<li><a href='#CmdSuspend'>Suspend</a>
|
|
|
19 |
<li><a href='#CmdResume'>Resume</a>
|
|
|
20 |
<li><a href='#CmdGetState'>Get State</a>
|
|
|
21 |
<li><a href='#CmdTerminate'>Terminate</a>
|
|
|
22 |
</ul>
|
|
|
23 |
<li><a href='#Events'>Events</a>
|
|
|
24 |
<li><a href='#API'>API</a>
|
|
|
25 |
</ul>
|
|
|
26 |
|
|
|
27 |
<h1>Run Control Service</h1>
|
|
|
28 |
|
|
|
29 |
<h2><a name='VersionHistory'>Version History</a></h2>
|
|
|
30 |
|
|
|
31 |
<table border=1 cellpadding=8>
|
|
|
32 |
<tr>
|
|
|
33 |
<th>Version
|
|
|
34 |
<th>Date
|
|
|
35 |
<th>Change
|
|
|
36 |
<tr>
|
|
|
37 |
<td>0.1
|
|
|
38 |
<td>2008-01-10
|
|
|
39 |
<td>Initial contribution
|
|
|
40 |
<tr>
|
|
|
41 |
<td>1.0
|
|
|
42 |
<td>2008-05-06
|
|
|
43 |
<td>Approved
|
|
|
44 |
</table>
|
|
|
45 |
|
|
|
46 |
<h2><a name='Overview'>Overview</a></h2>
|
|
|
47 |
|
|
|
48 |
<p>The service provides basic run control operations for execution contexts on a target.
|
|
|
49 |
Command and event parameters are encoded as zero terminated <a href='TCF Specification.html#JSON'>JSON</a> strings.</p>
|
|
|
50 |
|
|
|
51 |
<p>The service uses standard format for error reports,
|
|
|
52 |
see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
|
|
|
53 |
|
|
|
54 |
<h2><a name='Cmds'>Commands</a></h2>
|
|
|
55 |
|
|
|
56 |
<p>All run control commands are fully asynchronous, which means they never wait until
|
|
|
57 |
context is in a particular state. For example, if single step command arrives when
|
|
|
58 |
context is running, it does not wait until it stops, but returns an error. If a command
|
|
|
59 |
successfully resumed a context, it does not wait until instruction pointer reaches
|
|
|
60 |
desired destination – from client point of view the command execution ends right after
|
|
|
61 |
context was resumed. Various stepping commands can leave a context running in a special
|
|
|
62 |
mode, which is different from normal execution, for example, it can leave temporary
|
|
|
63 |
breakpoints to suspend the context when control reaches a particular place. Such execution
|
|
|
64 |
mode ends when the context is suspended, even if it was suspended for reasons unrelated
|
|
|
65 |
to the command and intended destination was not reached. Client can know when and
|
|
|
66 |
why a context is suspended by listening to events.</p>
|
|
|
67 |
|
|
|
68 |
<h3><a name='CmdGetContext'>Get Context</a></h3>
|
|
|
69 |
|
|
|
70 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
71 |
C • <i><token></i> • RunControl • getContext • <i><string: context ID></i> •
|
|
|
72 |
</font></b></pre>
|
|
|
73 |
|
|
|
74 |
<p>The command retrieves context properties for given context ID.
|
|
|
75 |
Exact meaning of context depends on the target.
|
|
|
76 |
A context can represent an execution thread, a process, an address space, etc.
|
|
|
77 |
A context can belong to a parent context. Contexts hierarchy can be simple
|
|
|
78 |
plain list or it can form a tree. It is up to target agent developers to choose
|
|
|
79 |
layout that is most descriptive for a given target. Context IDs are valid across
|
|
|
80 |
all services. In other words, all services access same hierarchy of contexts,
|
|
|
81 |
with same IDs, however, each service accesses its own subset of context's
|
|
|
82 |
attributes and functionality, which is relevant to that service.</p>
|
|
|
83 |
|
|
|
84 |
<p>Reply:</p>
|
|
|
85 |
|
|
|
86 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
87 |
R • <i><token></i> • <i><error report></i> • <i><context data></i> •
|
|
|
88 |
|
|
|
89 |
<i><context data></i>
|
|
|
90 |
⇒ null
|
|
|
91 |
⇒ <i><object: context properties></i>
|
|
|
92 |
</font></b></pre>
|
|
|
93 |
|
|
|
94 |
<p>Context data object is collection of context properties. It should, at least, contain member
|
|
|
95 |
<b><font face="Courier New" size=2 color=#333399>"ID" : <i><string></i></font></b>.
|
|
|
96 |
It can also contain arbitrary number of components
|
|
|
97 |
describing context properties and capabilities. Context data is supposed to be cached
|
|
|
98 |
by clients and it is not expected to change frequently. It can include, for example,
|
|
|
99 |
context name or ability to perform single step command on the context. But, it should
|
|
|
100 |
not include volatile data like current PC or running/suspended state. Service sends
|
|
|
101 |
contextChanged event to notify changes in context data.</p>
|
|
|
102 |
|
|
|
103 |
<p>Predefined run control context properties are:</p>
|
|
|
104 |
<ul>
|
|
|
105 |
<li><code><b><font face="Courier New" size=2 color=#333399>"ID" : <i><string></i></font></b></code>
|
|
|
106 |
- ID of the context, same as getContext command argument.
|
|
|
107 |
|
|
|
108 |
<li><code><b><font face="Courier New" size=2 color=#333399>"ParentID" : <i><string></i></font></b></code>
|
|
|
109 |
- ID of a parent context.
|
|
|
110 |
|
|
|
111 |
<li><code><b><font face="Courier New" size=2 color=#333399>"IsContainer" : <i><boolean></i></font></b></code>
|
|
|
112 |
- true if the context is a container.
|
|
|
113 |
Executing resume or suspend command on a container causes all its children to resume or suspend.
|
|
|
114 |
|
|
|
115 |
<li><code><b><font face="Courier New" size=2 color=#333399>"HasState" : <i><boolean></i></font></b></code>
|
|
|
116 |
- true if the context is an execution context, therefore
|
|
|
117 |
has an execution state, like state of a program counter (PC).
|
|
|
118 |
Only context that has a state can be resumed or suspended.
|
|
|
119 |
|
|
|
120 |
<li><code><b><font face="Courier New" size=2 color=#333399>"CanSuspend" : <i><boolean></i></font></b></code>
|
|
|
121 |
- true if Suspend command is supported for this context. It does not mean that the command can be executed successfully in
|
|
|
122 |
the current state of the context. For example, the command still can fail if context is already suspended.
|
|
|
123 |
|
|
|
124 |
<li><code><b><font face="Courier New" size=2 color=#333399>"CanResume" : <i><int: bitset of resume modes></i></font></b></code>
|
|
|
125 |
- for each resume mode, corresponding bit is '1' if Resume command mode is supported for this context, and '0' otherwise.
|
|
|
126 |
It does not mean that the command can be executed successfully in
|
|
|
127 |
the current state of the context. For example, the command still can fail if context is already resumed.
|
|
|
128 |
|
|
|
129 |
<li><code><b><font face="Courier New" size=2 color=#333399>"CanCount" : <i><int: bitset of resume modes></i></font></b></code>
|
|
|
130 |
- for each resume mode, corresponding bit is '1' if Resume command mode with count other then 1 is supported by the context.
|
|
|
131 |
|
|
|
132 |
<li><code><b><font face="Courier New" size=2 color=#333399>"CanTerminate" : <i><boolean></i></font></b></code>
|
|
|
133 |
- true if Terminate command is supported by the context,
|
|
|
134 |
</ul>
|
|
|
135 |
|
|
|
136 |
<h3><a name='CmdGetChildren'>Get Children</a></h3>
|
|
|
137 |
|
|
|
138 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
139 |
C • <i><token></i> • RunControl • getChildren • <i><string: parent context ID></i> •
|
|
|
140 |
</font></b></pre>
|
|
|
141 |
|
|
|
142 |
<p>The command requests list of execution contexts available for run control commands.</p>
|
|
|
143 |
|
|
|
144 |
<p>Parent context ID can be null – to retrieve top level of the hierarchy, can be one
|
|
|
145 |
of context IDs retrieved by previous getChildren commands, or it can be obtained from another service.
|
|
|
146 |
Contexts hierarchy can be simple plain list or it can form a tree. It is up to target agent developers to
|
|
|
147 |
choose layout that is most descriptive for a given target.</p>
|
|
|
148 |
|
|
|
149 |
<p>Reply:</p>
|
|
|
150 |
|
|
|
151 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
152 |
R • <i><token></i> • <i><error report></i> • <i><array of context IDs></i> •
|
|
|
153 |
|
|
|
154 |
<i><array of context IDs></i>
|
|
|
155 |
⇒ null
|
|
|
156 |
⇒ [ <i><context ID list></i> ]
|
|
|
157 |
|
|
|
158 |
<i><context ID list></i>
|
|
|
159 |
⇒ <i><string: context ID></i>
|
|
|
160 |
⇒ <i><context ID list></i> , <i><string: context ID></i>
|
|
|
161 |
</font></b></pre>
|
|
|
162 |
|
|
|
163 |
<h3><a name='CmdSuspend'>Suspend</a></h3>
|
|
|
164 |
|
|
|
165 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
166 |
C • <i><token></i> • RunControl • suspend • <i><string: context ID></i> •
|
|
|
167 |
</font></b></pre>
|
|
|
168 |
|
|
|
169 |
<p>The command suspends execution of given context. The command should fail if CanSuspend property of the context is false.
|
|
|
170 |
If context's IsContainer = true, the command is propagated to context's children. Only contexts with HasState = true
|
|
|
171 |
can be suspended.</p>
|
|
|
172 |
|
|
|
173 |
<p>Result message:</p>
|
|
|
174 |
|
|
|
175 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
176 |
R • <i><token></i> • <i><error report></i> •
|
|
|
177 |
</font></b></pre>
|
|
|
178 |
|
|
|
179 |
<h3><a name='CmdResume'>Resume</a></h3>
|
|
|
180 |
|
|
|
181 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
182 |
C • <i><token></i> • RunControl • resume • <i><string: context ID></i> • <i><int: mode></i> • <i><int: count></i> •
|
|
|
183 |
C • <i><token></i> • RunControl • resume • <i><string: context ID></i> • <i><int: mode></i> • <i><int: count></i> • <i><object: parameters></i> •
|
|
|
184 |
</font></b></pre>
|
|
|
185 |
|
|
|
186 |
<p>The command resumes execution of given context. The command should fail if CanResume
|
|
|
187 |
property of the context is '0' for given mode. If context's IsContainer = true, the command is propagated
|
|
|
188 |
to context's children. Only contexts with HasState = true can be resumed.</p>
|
|
|
189 |
<p>The command can have optional argument that contains set of resume parameters, for example stepping range definition.</p>
|
|
|
190 |
|
|
|
191 |
<p>Resume modes:</p>
|
|
|
192 |
<ul>
|
|
|
193 |
<li>
|
|
|
194 |
<code>RM_RESUME = 0</code> - resume normal execution. Execution will
|
|
|
195 |
continue until suspended by command or breakpoint.
|
|
|
196 |
</li>
|
|
|
197 |
|
|
|
198 |
<li>
|
|
|
199 |
<code>RM_STEP_OVER = 1</code> - step over a single instruction. If instruction
|
|
|
200 |
is function call, execution continues until control returns from the function.
|
|
|
201 |
</li>
|
|
|
202 |
|
|
|
203 |
<li>
|
|
|
204 |
<code>RM_STEP_INTO = 2</code> - single instruction in given context.
|
|
|
205 |
</li>
|
|
|
206 |
|
|
|
207 |
<li>
|
|
|
208 |
<code>RM_STEP_OVER_LINE = 3</code> - resume execution of given context until control reaches instruction
|
|
|
209 |
that belongs to a different line of source code, but runs any functions called at
|
|
|
210 |
full speed. Error is returned if line number information not available.
|
|
|
211 |
</li>
|
|
|
212 |
|
|
|
213 |
<li>
|
|
|
214 |
<code>RM_STEP_INTO_LINE = 4</code> - resumes execution of given context until control reaches instruction
|
|
|
215 |
that belongs to a different line of source code. If a function is called,
|
|
|
216 |
stop at first line of the function code. Error is returned if line number
|
|
|
217 |
information not available.
|
|
|
218 |
</li>
|
|
|
219 |
|
|
|
220 |
<li>
|
|
|
221 |
<code>RM_STEP_OUT = 5</code> - resume execution of given context until control returns from current
|
|
|
222 |
function.
|
|
|
223 |
</li>
|
|
|
224 |
|
|
|
225 |
<li>
|
|
|
226 |
<code>RM_REVERSE_RESUME = 6</code> - reverse of <code>RM_RESUME</code>; resume backward execution. Execution will
|
|
|
227 |
continue until suspended by command or breakpoint.
|
|
|
228 |
</li>
|
|
|
229 |
|
|
|
230 |
<li>
|
|
|
231 |
<code>RM_REVERSE_STEP_OVER = 7</code> - reverse of <code>RM_STEP_OVER</code>; reverse step over a single instruction.
|
|
|
232 |
</li>
|
|
|
233 |
|
|
|
234 |
<li>
|
|
|
235 |
<code>RM_REVERSE_STEP_INTO = 8</code> - reverse of <code>RM_STEP_INTO</code>; reverse step into a single instruction in the given context.
|
|
|
236 |
This effectively "un-executes" the previous instruction.
|
|
|
237 |
</li>
|
|
|
238 |
|
|
|
239 |
<li>
|
|
|
240 |
<code>RM_REVERSE_STEP_OVER_LINE = 9</code> - reverse of <code>RM_STEP_OVER_LINE</code>; resume backward execution
|
|
|
241 |
of given context until control reaches an instruction that belongs to a different source line.
|
|
|
242 |
If the line contains a function call then don't stop until get out of the function.
|
|
|
243 |
Error is returned if line number information not available.
|
|
|
244 |
</li>
|
|
|
245 |
|
|
|
246 |
<li>
|
|
|
247 |
<code>RM_REVERSE_STEP_INTO_LINE = 10</code> - reverse of <code>RM_STEP_INTO_LINE</code>; resume backward execution of given context
|
|
|
248 |
until control reaches an instruction that belongs to a different line of source code.
|
|
|
249 |
If a function is called, stop at the beginning of the last line of the function code.
|
|
|
250 |
Error is returned if line number information not available.
|
|
|
251 |
</li>
|
|
|
252 |
|
|
|
253 |
<li>
|
|
|
254 |
<code>RM_REVERSE_STEP_OUT = 11</code> - reverse of <code>RM_STEP_OUT</code>; resume backward execution of
|
|
|
255 |
the given context until control reaches the point where the current function was called.
|
|
|
256 |
</li>
|
|
|
257 |
|
|
|
258 |
<li>
|
|
|
259 |
<code>RM_STEP_OVER_RANGE = 12</code> - step over instructions until PC is outside the specified range.
|
|
|
260 |
If any function call within the range is considered to be in range.
|
|
|
261 |
</li>
|
|
|
262 |
|
|
|
263 |
<li>
|
|
|
264 |
<code>RM_STEP_INTO_RANGE = 13</code> - step instruction until PC is outside the specified range for any reason.
|
|
|
265 |
</li>
|
|
|
266 |
|
|
|
267 |
<li>
|
|
|
268 |
<code>RM_REVERSE_STEP_OVER_RANGE = 14</code> - reverse of <code>RM_STEP_OVER_RANGE</code>.
|
|
|
269 |
</li>
|
|
|
270 |
|
|
|
271 |
<li>
|
|
|
272 |
<code>RM_REVERSE_STEP_INTO_RANGE = 15</code> - reverse of <code>RM_STEP_INTO_RANGE</code>.
|
|
|
273 |
</li>
|
|
|
274 |
</ul>
|
|
|
275 |
|
|
|
276 |
<p>Result message:</p>
|
|
|
277 |
|
|
|
278 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
279 |
R • <i><token></i> • <i><error report></i> •
|
|
|
280 |
</font></b></pre>
|
|
|
281 |
|
|
|
282 |
<h3><a name='CmdGetState'>Get State</a></h3>
|
|
|
283 |
|
|
|
284 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
285 |
C • <i><token></i> • RunControl • getState • <i><string: context ID></i> •
|
|
|
286 |
</font></b></pre>
|
|
|
287 |
|
|
|
288 |
<p>The command retrieves current state of the context. The command should fail if HasState property of
|
|
|
289 |
the context is false.</p>
|
|
|
290 |
|
|
|
291 |
<p>Result message:</p>
|
|
|
292 |
|
|
|
293 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
294 |
R • <i><token></i> • <i><error report></i> • <i><boolean: suspended></i> •
|
|
|
295 |
<i><int: PC></i> • <i><string: last state change reason></i> • <i><state data></i> •
|
|
|
296 |
|
|
|
297 |
<i><state data></i>
|
|
|
298 |
⇒ null
|
|
|
299 |
⇒ <i><object: context state properties></i>
|
|
|
300 |
</font></b></pre>
|
|
|
301 |
|
|
|
302 |
<p>State change reason can be any text, but if it is one of predefined strings,
|
|
|
303 |
a generic client might be able to handle it better. Predefined reasons are:</p>
|
|
|
304 |
<ul>
|
|
|
305 |
<li><code>REASON_USER_REQUEST = "Suspended"</code> - context suspended by command.
|
|
|
306 |
<li><code>REASON_STEP = "Step"</code> - context resumed or suspended by step command.
|
|
|
307 |
<li><code>REASON_BREAKPOINT = "Breakpoint"</code> - context suspended by breakpoint.
|
|
|
308 |
<li><code>REASON_EXCEPTION = "Exception"</code> - context suspended by exception.
|
|
|
309 |
<li><code>REASON_CONTAINER = "Container"</code> - context suspended or resumed as part of container.
|
|
|
310 |
<li><code>REASON_WATCHPOINT = "Watchpoint"</code> - context suspended by watchpoint (data breakpoint).
|
|
|
311 |
<li><code>REASON_SIGNAL = "Signal"</code> - context suspended because it received a signal.
|
|
|
312 |
<li><code>REASON_SHAREDLIB = "Shared Library"</code> - context suspended because a shared library is loaded or unloaded.
|
|
|
313 |
<li><code>REASON_ERROR = "Error"</code> - context suspended because of an error in execution environment.
|
|
|
314 |
</ul>
|
|
|
315 |
|
|
|
316 |
<p>Context state properties can contain any data relevant to context state.
|
|
|
317 |
Definition of state properties depends on a target.</p>
|
|
|
318 |
|
|
|
319 |
<h3><a name='CmdTerminate'>Terminate</a></h3>
|
|
|
320 |
|
|
|
321 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
322 |
C • <i><token></i> • RunControl • terminate • <i><string: context ID></i> •
|
|
|
323 |
</font></b></pre>
|
|
|
324 |
|
|
|
325 |
<p>The command terminates execution of given context. The command should fail if CanTerminate
|
|
|
326 |
property of the context is false.</p>
|
|
|
327 |
|
|
|
328 |
<p>Result message:</p>
|
|
|
329 |
|
|
|
330 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
331 |
R • <i><token></i> • <i><error report></i> •
|
|
|
332 |
</font></b></pre>
|
|
|
333 |
|
|
|
334 |
<h2><a name='Events'>Events</a></h2>
|
|
|
335 |
|
|
|
336 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
337 |
E • RunControl • contextAdded • <i><array of context data></i> •
|
|
|
338 |
|
|
|
339 |
E • RunControl • contextChanged • <i><array of context data></i> •
|
|
|
340 |
|
|
|
341 |
E • RunControl • contextRemoved • <i><array of context IDs></i> •
|
|
|
342 |
|
|
|
343 |
E • RunControl • contextSuspended • <i><string: context ID></i> • <i><int: PC></i> •
|
|
|
344 |
<i><string: reason></i> • <i><state data></i> •
|
|
|
345 |
|
|
|
346 |
E • RunControl • contextResumed • <i><string: context ID></i> •
|
|
|
347 |
|
|
|
348 |
E • RunControl • contextException • <i><string: context ID></i> • <i><string: description></i> •
|
|
|
349 |
|
|
|
350 |
E • RunControl • containerSuspended • <i><string: context ID></i> • <i><int: PC></i> •
|
|
|
351 |
<i><string: reason></i> • <i><state data></i> • <i><array of context IDs></i> •
|
|
|
352 |
|
|
|
353 |
E • RunControl • containerResumed • <i><array of context IDs></i> •
|
|
|
354 |
|
|
|
355 |
<i><array of context data></i>
|
|
|
356 |
⇒ null
|
|
|
357 |
⇒ [ <i><context data list></i> ]
|
|
|
358 |
|
|
|
359 |
<i><context data list></i>
|
|
|
360 |
⇒ <i><object: context data></i>
|
|
|
361 |
⇒ <i><context data list></i> , <i><object: context data></i>
|
|
|
362 |
</font></b></pre>
|
|
|
363 |
|
|
|
364 |
<dl>
|
|
|
365 |
<dt><b>contextAdded</b>
|
|
|
366 |
<dd>is sent when new contexts are created or attached for debugging. The message contains
|
|
|
367 |
array of context data. Context data is same as returned by Get Context command.
|
|
|
368 |
<dt><b>contextChanged</b>
|
|
|
369 |
<dd>is sent when context properties change. The message contains
|
|
|
370 |
array of changed (new) context data. Context data is same as returned by Get Context command.
|
|
|
371 |
<dt><b>contextRemoved</b>
|
|
|
372 |
<dd>is sent when context is removed - terminated or detached. The message contains
|
|
|
373 |
array of context IDs.
|
|
|
374 |
<dt><b>contextSuspended</b>
|
|
|
375 |
<dd>is sent when context is suspended. The message context ID contains context state data,
|
|
|
376 |
same state data as returned by Get State command.
|
|
|
377 |
<dt><b>contextResumed</b>
|
|
|
378 |
<dd>is sent when context is resumed. The message contains resumed context ID.
|
|
|
379 |
<dt><b>contextException</b>
|
|
|
380 |
<dd>is sent when execution exception occurs in a context. The message contains context ID and
|
|
|
381 |
a string that describes nature of the exception.
|
|
|
382 |
<dt><b>containerSuspended</b>
|
|
|
383 |
<dd>is sent when target simultaneously suspends multiple threads in a container (process, core, etc.).
|
|
|
384 |
The message contains context ID and context state data of a context responsible for the event.
|
|
|
385 |
It can be container ID or any one of container children, for example, it can be thread
|
|
|
386 |
that hit "suspend all" breakpoint. Message also contains full list of all contexts that were suspended
|
|
|
387 |
simultaneously. No separate contextSuspened events are sent for contexts in the list. If client needs
|
|
|
388 |
state data for those contexts, it should use Get State command.
|
|
|
389 |
<dt><b>containerResumed</b>
|
|
|
390 |
<dd>is sent when target simultaneously resumes multiple threads in a container (process,
|
|
|
391 |
core, etc.). Message contains full list of all contexts that were resumed
|
|
|
392 |
simultaneously. No separate contextResumed events are sent for contexts in the list.
|
|
|
393 |
</dl>
|
|
|
394 |
|
|
|
395 |
<h2><a name='API'>API</a></h2>
|
|
|
396 |
|
|
|
397 |
<pre>
|
|
|
398 |
<font color=#7F0055>public interface</font> IRunControl <font color=#7F0055>extends</font> IService {
|
|
|
399 |
|
|
|
400 |
<font color=#3F5FBF>/**
|
|
|
401 |
* Context property names.
|
|
|
402 |
*/</font>
|
|
|
403 |
<font color=#7F0055>static final</font> String
|
|
|
404 |
PROP_ID = "ID",
|
|
|
405 |
PROP_PARENT_ID = "ParentID",
|
|
|
406 |
PROP_IS_CONTAINER = "IsContainer",
|
|
|
407 |
PROP_HAS_STATE = "HasState",
|
|
|
408 |
PROP_CAN_RESUME = "CanResume",
|
|
|
409 |
PROP_CAN_COUNT = "CanCount",
|
|
|
410 |
PROP_CAN_SUSPEND = "CanSuspend",
|
|
|
411 |
PROP_CAN_TERMINATE = "CanTerminate";
|
|
|
412 |
|
|
|
413 |
<font color=#3F5FBF>/**
|
|
|
414 |
* Context resume modes.
|
|
|
415 |
*/</font>
|
|
|
416 |
<font color=#7F0055>static final int</font>
|
|
|
417 |
RM_RESUME = 0,
|
|
|
418 |
RM_STEP_OVER = 1,
|
|
|
419 |
RM_STEP_INTO = 2,
|
|
|
420 |
RM_STEP_OVER_LINE = 3,
|
|
|
421 |
RM_STEP_INTO_LINE = 4,
|
|
|
422 |
RM_STEP_OUT = 5,
|
|
|
423 |
RM_REVERSE_RESUME = 6,
|
|
|
424 |
RM_REVERSE_STEP_OVER = 7,
|
|
|
425 |
RM_REVERSE_STEP_INTO = 8,
|
|
|
426 |
RM_REVERSE_STEP_OVER_LINE = 9,
|
|
|
427 |
RM_REVERSE_STEP_INTO_LINE = 10,
|
|
|
428 |
RM_REVERSE_STEP_OUT = 11;
|
|
|
429 |
|
|
|
430 |
<font color=#3F5FBF>/**
|
|
|
431 |
* State change reason of a context.
|
|
|
432 |
* Reason can be any text, but if it is one of predefined strings,
|
|
|
433 |
* a generic client might be able to handle it better.
|
|
|
434 |
*/</font>
|
|
|
435 |
<font color=#7F0055>static final</font> String
|
|
|
436 |
REASON_USER_REQUEST = "Suspended",
|
|
|
437 |
REASON_STEP = "Step",
|
|
|
438 |
REASON_BREAKPOINT = "Breakpoint",
|
|
|
439 |
REASON_EXCEPTION = "Exception",
|
|
|
440 |
REASON_CONTAINER = "Container",
|
|
|
441 |
REASON_WATCHPOINT = "Watchpoint",
|
|
|
442 |
REASON_SIGNAL = "Signal",
|
|
|
443 |
REASON_SHAREDLIB = "Shared Library",
|
|
|
444 |
REASON_ERROR = "Error";
|
|
|
445 |
|
|
|
446 |
<font color=#3F5FBF>/**
|
|
|
447 |
* Retrieve context info for given context ID.
|
|
|
448 |
*
|
|
|
449 |
* <font color=#7F9FBF>@param</font> id – context ID.
|
|
|
450 |
* <font color=#7F9FBF>@param</font> done - callback interface called when operation is completed.
|
|
|
451 |
*/</font>
|
|
|
452 |
IToken getContext(String id, DoneGetContext done);
|
|
|
453 |
|
|
|
454 |
<font color=#3F5FBF>/**
|
|
|
455 |
* Client callback interface for getContext().
|
|
|
456 |
*/</font>
|
|
|
457 |
<font color=#7F0055>interface</font> DoneGetContext {
|
|
|
458 |
<font color=#3F5FBF>/**
|
|
|
459 |
* Called when contexts data retrieval is done.
|
|
|
460 |
* <font color=#7F9FBF>@param</font> error – error description if operation failed, null if succeeded.
|
|
|
461 |
* <font color=#7F9FBF>@param</font> context – context data.
|
|
|
462 |
*/</font>
|
|
|
463 |
<font color=#7F0055>void</font> doneGetContext(IToken token, Exception error, RunControlContext context);
|
|
|
464 |
}
|
|
|
465 |
|
|
|
466 |
<font color=#3F5FBF>/**
|
|
|
467 |
* Retrieve children of given context.
|
|
|
468 |
*
|
|
|
469 |
* <font color=#7F9FBF>@param</font> parent_context_id – parent context ID. Can be null –
|
|
|
470 |
* to retrieve top level of the hierarchy, or one of context IDs retrieved
|
|
|
471 |
* by previous getContext or getChildren commands.
|
|
|
472 |
* <font color=#7F9FBF>@param</font> done - callback interface called when operation is completed.
|
|
|
473 |
*/</font>
|
|
|
474 |
IToken getChildren(String parent_context_id, DoneGetChildren done);
|
|
|
475 |
|
|
|
476 |
<font color=#3F5FBF>/**
|
|
|
477 |
* Client callback interface for getContexts().
|
|
|
478 |
*/</font>
|
|
|
479 |
<font color=#7F0055>interface</font> DoneGetChildren {
|
|
|
480 |
<font color=#3F5FBF>/**
|
|
|
481 |
* Called when contexts data retrieval is done.
|
|
|
482 |
* <font color=#7F9FBF>@param</font> error – error description if operation failed, null if succeeded.
|
|
|
483 |
* <font color=#7F9FBF>@param</font> contexts – array of available context IDs.
|
|
|
484 |
*/</font>
|
|
|
485 |
<font color=#7F0055>void</font> doneGetChildren(IToken token, RunControlError error, Context[] contexts);
|
|
|
486 |
}
|
|
|
487 |
|
|
|
488 |
<font color=#3F5FBF>/**
|
|
|
489 |
* A context corresponds to an execution thread, process, address space, etc.
|
|
|
490 |
* A context can belong to a parent context. Contexts hierarchy can be simple
|
|
|
491 |
* plain list or it can form a tree. It is up to target agent developers to choose
|
|
|
492 |
* layout that is most descriptive for a given target. Context IDs are valid across
|
|
|
493 |
* all services. In other words, all services access same hierarchy of contexts,
|
|
|
494 |
* with same IDs, however, each service accesses its own subset of context's
|
|
|
495 |
* attributes and functionality, which is relevant to that service.
|
|
|
496 |
*/</font>
|
|
|
497 |
<font color=#7F0055>interface</font> RunControlContext {
|
|
|
498 |
|
|
|
499 |
<font color=#3F5FBF>/**
|
|
|
500 |
* Retrieve context ID.
|
|
|
501 |
* Same as getProperties().get("ID")
|
|
|
502 |
*/</font>
|
|
|
503 |
String getID();
|
|
|
504 |
|
|
|
505 |
<font color=#3F5FBF>/**
|
|
|
506 |
* Retrieve parent context ID.
|
|
|
507 |
* Same as getProperties().get("ParentID")
|
|
|
508 |
*/</font>
|
|
|
509 |
String getParentID();
|
|
|
510 |
|
|
|
511 |
<font color=#3F5FBF>/**
|
|
|
512 |
* Get context properties. See PROP_* definitions for property names.
|
|
|
513 |
* Context properties are read only, clients should not try to modify them.
|
|
|
514 |
* <font color=#7F9FBF>@return</font> Map of context properties.
|
|
|
515 |
*/</font>
|
|
|
516 |
Map<String,Object> getProperties();
|
|
|
517 |
|
|
|
518 |
<font color=#3F5FBF>/**
|
|
|
519 |
* Utility method to read context property PROP_IS_CONTAINER.
|
|
|
520 |
* Executing resume or suspend command on a container causes all its children to resume or suspend.
|
|
|
521 |
* <font color=#7F9FBF>@return</font> value of PROP_IS_CONTAINER.
|
|
|
522 |
*/</font>
|
|
|
523 |
<font color=#7F0055>boolean</font> isContainer();
|
|
|
524 |
|
|
|
525 |
<font color=#3F5FBF>/**
|
|
|
526 |
* Utility method to read context property PROP_HAS_STATE.
|
|
|
527 |
* Only context that has a state can be resumed or suspended.
|
|
|
528 |
* <font color=#7F9FBF>@return</font> value of PROP_HAS_STATE.
|
|
|
529 |
*/</font>
|
|
|
530 |
<font color=#7F0055>boolean</font> hasState();
|
|
|
531 |
|
|
|
532 |
<font color=#3F5FBF>/**
|
|
|
533 |
* Utility method to read context property PROP_CAN_SUSPEND.
|
|
|
534 |
* Value 'true' means suspend command is supported by the context,
|
|
|
535 |
* however the method does not check that the command can be executed successfully in
|
|
|
536 |
* the current state of the context. For example, the command still can fail if context is
|
|
|
537 |
* already suspended.
|
|
|
538 |
* <font color=#7F9FBF>@return</font> value of PROP_CAN_SUSPEND.
|
|
|
539 |
*/</font>
|
|
|
540 |
<font color=#7F0055>boolean</font> canSuspend();
|
|
|
541 |
|
|
|
542 |
<font color=#3F5FBF>/**
|
|
|
543 |
* Utility method to read a 'mode' bit in context property PROP_CAN_RESUME.
|
|
|
544 |
* Value 'true' means resume command is supported by the context,
|
|
|
545 |
* however the method does not check that the command can be executed successfully in
|
|
|
546 |
* the current state of the context. For example, the command still can fail if context is
|
|
|
547 |
* already resumed.
|
|
|
548 |
* <font color=#7F9FBF>@param</font> mode - resume mode, see RM_*.
|
|
|
549 |
* <font color=#7F9FBF>@return</font> value of requested bit of PROP_CAN_RESUME.
|
|
|
550 |
*/</font>
|
|
|
551 |
<font color=#7F0055>boolean</font> canResume(<font color=#7F0055>int</font> mode);
|
|
|
552 |
|
|
|
553 |
<font color=#3F5FBF>/**
|
|
|
554 |
* Utility method to read a 'mode' bit in context property PROP_CAN_COUNT.
|
|
|
555 |
* Value 'true' means resume command with count other then 1 is supported by the context,
|
|
|
556 |
* however the method does not check that the command can be executed successfully in
|
|
|
557 |
* the current state of the context. For example, the command still can fail if context is
|
|
|
558 |
* already resumed.
|
|
|
559 |
* <font color=#7F9FBF>@param</font> mode - resume mode, see RM_*.
|
|
|
560 |
* <font color=#7F9FBF>@return</font> value of requested bit of PROP_CAN_COUNT.
|
|
|
561 |
*/</font>
|
|
|
562 |
<font color=#7F0055>boolean</font> canCount(<font color=#7F0055>int</font> mode);
|
|
|
563 |
|
|
|
564 |
<font color=#3F5FBF>/**
|
|
|
565 |
* Utility method to read context property PROP_CAN_TERMINATE.
|
|
|
566 |
* Value 'true' means terminate command is supported by the context,
|
|
|
567 |
* however the method does not check that the command can be executed successfully in
|
|
|
568 |
* the current state of the context. For example, the command still can fail if context is
|
|
|
569 |
* already exited.
|
|
|
570 |
* <font color=#7F9FBF>@return</font> value of PROP_CAN_SUSPEND.
|
|
|
571 |
*/</font>
|
|
|
572 |
<font color=#7F0055>boolean</font> canTerminate();
|
|
|
573 |
|
|
|
574 |
<font color=#3F5FBF>/**
|
|
|
575 |
* Send a command to retrieve current state of a context.
|
|
|
576 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
577 |
* <font color=#7F9FBF>@return</font> pending command handle, can be used to cancel the command.
|
|
|
578 |
*/</font>
|
|
|
579 |
IToken getState(DoneGetState done);
|
|
|
580 |
|
|
|
581 |
<font color=#3F5FBF>/**
|
|
|
582 |
* Send a command to suspend a context.
|
|
|
583 |
* Also suspends children if context is a container.
|
|
|
584 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
585 |
* <font color=#7F9FBF>@return</font> pending command handle, can be used to cancel the command.
|
|
|
586 |
*/</font>
|
|
|
587 |
IToken suspend(DoneCommand done);
|
|
|
588 |
|
|
|
589 |
<font color=#3F5FBF>/**
|
|
|
590 |
* Send a command to resume a context.
|
|
|
591 |
* Also resumes children if context is a container.
|
|
|
592 |
* <font color=#7F9FBF>@param</font> mode - defines how to resume the context, see RM_*.
|
|
|
593 |
* <font color=#7F9FBF>@param</font> count - if mode implies stepping, defines how many steps to perform.
|
|
|
594 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
595 |
* <font color=#7F9FBF>@return</font> pending command handle, can be used to cancel the command.
|
|
|
596 |
*/</font>
|
|
|
597 |
IToken resume(<font color=#7F0055>int</font> mode, <font color=#7F0055>int</font> count, DoneCommand done);
|
|
|
598 |
|
|
|
599 |
<font color=#3F5FBF>/**
|
|
|
600 |
* Send a command to terminate a context.
|
|
|
601 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
602 |
* <font color=#7F9FBF>@return</font> pending command handle, can be used to cancel the command.
|
|
|
603 |
*/</font>
|
|
|
604 |
IToken terminate(DoneCommand done);
|
|
|
605 |
}
|
|
|
606 |
|
|
|
607 |
<font color=#7F0055>class</font> RunControlError <font color=#7F0055>extends</font> Exception {
|
|
|
608 |
}
|
|
|
609 |
|
|
|
610 |
<font color=#7F0055>interface</font> DoneGetState {
|
|
|
611 |
<font color=#7F0055>void</font> doneGetState(IToken token, Exception error, <font color=#7F0055>boolean</font> suspended, String pc,
|
|
|
612 |
String reason, Map<String,Object> params);
|
|
|
613 |
}
|
|
|
614 |
|
|
|
615 |
<font color=#7F0055>interface</font> DoneCommand {
|
|
|
616 |
<font color=#3F5FBF>/**
|
|
|
617 |
* Called when run control command execution is complete.
|
|
|
618 |
* <font color=#7F9FBF>@param</font> token - pending command handle.
|
|
|
619 |
* <font color=#7F9FBF>@param</font> error - command execution error or null.
|
|
|
620 |
*/</font>
|
|
|
621 |
<font color=#7F0055>void</font> doneCommand(IToken token, Exception error);
|
|
|
622 |
}
|
|
|
623 |
|
|
|
624 |
<font color=#3F5FBF>/**
|
|
|
625 |
* Add run control event listener.
|
|
|
626 |
* <font color=#7F9FBF>@param</font> listener - run control event listener to add.
|
|
|
627 |
*/</font>
|
|
|
628 |
<font color=#7F0055>void</font> addListener(RunControlListener listener);
|
|
|
629 |
|
|
|
630 |
<font color=#3F5FBF>/**
|
|
|
631 |
* Remove run control event listener.
|
|
|
632 |
* <font color=#7F9FBF>@param</font> listener - run control event listener to remove.
|
|
|
633 |
*/</font>
|
|
|
634 |
<font color=#7F0055>void</font> removeListener(RunControlListener listener);
|
|
|
635 |
|
|
|
636 |
<font color=#3F5FBF>/**
|
|
|
637 |
* Service events listener interface.
|
|
|
638 |
*/</font>
|
|
|
639 |
<font color=#7F0055>interface</font> RunControlListener {
|
|
|
640 |
|
|
|
641 |
<font color=#3F5FBF>/**
|
|
|
642 |
* Called when a new contexts are created.
|
|
|
643 |
* <font color=#7F9FBF>@param</font> contexts - array of new context properties.
|
|
|
644 |
*/</font>
|
|
|
645 |
<font color=#7F0055>void</font> contextAdded(RunControlContext contexts[]);
|
|
|
646 |
|
|
|
647 |
<font color=#3F5FBF>/**
|
|
|
648 |
* Called when a context properties changed.
|
|
|
649 |
* <font color=#7F9FBF>@param</font> contexts - array of new context properties.
|
|
|
650 |
*/</font>
|
|
|
651 |
<font color=#7F0055>void</font> contextChanged(RunControlContext contexts[]);
|
|
|
652 |
|
|
|
653 |
<font color=#3F5FBF>/**
|
|
|
654 |
* Called when contexts are removed.
|
|
|
655 |
* <font color=#7F9FBF>@param</font> context_ids - array of removed context IDs.
|
|
|
656 |
*/</font>
|
|
|
657 |
<font color=#7F0055>void</font> contextRemoved(String context_ids[]);
|
|
|
658 |
|
|
|
659 |
<font color=#3F5FBF>/**
|
|
|
660 |
* Called when a thread is suspended.
|
|
|
661 |
* <font color=#7F9FBF>@param</font> context - ID of a context that was suspended.
|
|
|
662 |
* <font color=#7F9FBF>@param</font> pc - program counter of the context, can be null.
|
|
|
663 |
* <font color=#7F9FBF>@param</font> reason - human readable description of suspend reason.
|
|
|
664 |
* <font color=#7F9FBF>@param</font> params - additional, target specific data about suspended context.
|
|
|
665 |
*/</font>
|
|
|
666 |
<font color=#7F0055>void</font> contextSuspended(String context, String pc,
|
|
|
667 |
String reason, Map<String,Object> params);
|
|
|
668 |
|
|
|
669 |
<font color=#3F5FBF>/**
|
|
|
670 |
* Called when a thread is resumed.
|
|
|
671 |
* <font color=#7F9FBF>@param</font> context - ID of a context that was resumed.
|
|
|
672 |
*/</font>
|
|
|
673 |
<font color=#7F0055>void</font> contextResumed(String context);
|
|
|
674 |
|
|
|
675 |
<font color=#3F5FBF>/**
|
|
|
676 |
* Called when target simultaneously suspends multiple threads in a container
|
|
|
677 |
* (process, core, etc.).
|
|
|
678 |
*
|
|
|
679 |
* <font color=#7F9FBF>@param</font> context - ID of a context responsible for the event. It can be container ID or
|
|
|
680 |
* any one of container children, for example, it can be thread that hit "suspend all" breakpoint.
|
|
|
681 |
* Client expected to move focus (selection) to this context.
|
|
|
682 |
* <font color=#7F9FBF>@param</font> pc - program counter of the context.
|
|
|
683 |
* <font color=#7F9FBF>@param</font> reason - human readable description of suspend reason.
|
|
|
684 |
* <font color=#7F9FBF>@param</font> params - additional target specific data about suspended context.
|
|
|
685 |
* <font color=#7F9FBF>@param</font> suspended_ids - full list of all contexts that were suspended.
|
|
|
686 |
*/</font>
|
|
|
687 |
<font color=#7F0055>void</font> containerSuspended(String context, String pc,
|
|
|
688 |
String reason, Map<String,Object> params, String[] suspended_ids);
|
|
|
689 |
|
|
|
690 |
<font color=#3F5FBF>/**
|
|
|
691 |
* Called when target simultaneously resumes multiple threads in a container (process,
|
|
|
692 |
* core, etc.).
|
|
|
693 |
*
|
|
|
694 |
* <font color=#7F9FBF>@param</font> context_ids - full list of all contexts that were resumed.
|
|
|
695 |
*/</font>
|
|
|
696 |
<font color=#7F0055>void</font> containerResumed(String[] context_ids);
|
|
|
697 |
|
|
|
698 |
<font color=#3F5FBF>/**
|
|
|
699 |
* Called when an exception is detected in a target thread.
|
|
|
700 |
* <font color=#7F9FBF>@param</font> context - ID of a context that caused an exception.
|
|
|
701 |
* <font color=#7F9FBF>@param</font> msg - human readable description of the exception.
|
|
|
702 |
*/</font>
|
|
|
703 |
<font color=#7F0055>void</font> contextException(String context, String msg);
|
|
|
704 |
}
|
|
|
705 |
}
|
|
|
706 |
</pre>
|
|
|
707 |
|
|
|
708 |
</body>
|
|
|
709 |
</html>
|