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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Target Communication Framework Services - Breakpoints</title>
</head>
<body lang='EN-US'>
<h1>Target Communication Framework Services - Breakpoints</h1>
<ul>
<li><a href='#Cmds'>Commands</a>
<ul>
<li><a href='#CmdSet'>Set</a>
<li><a href='#CmdAdd'>Add</a>
<li><a href='#CmdChange'>Change</a>
<li><a href='#CmdEnable'>Enable</a>
<li><a href='#CmdDisable'>Disable</a>
<li><a href='#CmdRemove'>Remove</a>
<li><a href='#CmdGetIDs'>Get IDs</a>
<li><a href='#CmdGetProperties'>Get Properties</a>
<li><a href='#CmdGetStatus'>Get Status</a>
<li><a href='#CmdGetCapabilities'>Get Capabilities</a>
</ul>
<li><a href='#Events'>Events</a>
<li><a href='#API'>API</a>
</ul>
<h1>Breakpoints Service</h1>
<p>Breakpoint is represented by unique identifier and set of properties.
Breakpoint identifier (String id) needs to be unique across all hosts and targets</p>
<p>Breakpoint properties is extendable collection of named attributes,
which define breakpoint location and behavior. The service defines some common
attribute names, host tools and target agents may support additional attributes.</p>
<p>For each breakpoint a target agent maintains another extendable collection of named attributes:
breakpoint status. While breakpoint properties are persistent and represent user input,
breakpoint status reflects dynamic target agent reports about breakpoint current state,
like actual addresses where breakpoint is planted or planting errors.</p>
<p>Breakpoints are associated with communication channel and traget agent must remove them
when the channel is closed. Target agent should maintain separate breakpoint table
for each communication channel. It is allowed to set same breakpoint (same ID) through multiple
channels, target agent should treat it as single breakpoint with maltiple references. Such breakpoint
is removed when all refering channels are closed.</p>
<p>The service uses standard format for error reports,
see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
<h2><a name='Cmds'>Commands</a></h2>
<h3><a name='CmdSet'>Set</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • set • <i><array of breakpoints></i> •
<i><array of breakpoints></i>
<font face=Wingdings>Ø</font> null
<font face=Wingdings>Ø</font> [ ]
<font face=Wingdings>Ø</font> [ <i><breakpoints list></i> ]
<i><breakpoints list></i>
<font face=Wingdings>Ø</font> <i><breakpoint data></i>
<font face=Wingdings>Ø</font> <i><breakpoint data></i> , <i><breakpoint data></i>
<i><breakpoint data></i>
<font face=Wingdings>Ø</font> <i><object></i>
</font></b></pre>
<p> The command downloads breakpoints data to a target agent.
The command is intended to be used only to initialize target breakpoints table
when communication channel is open. After that, host should
notify target about (incremental) changes in breakpoint data by sending
Add, Change and Remove commands.<p>
<p>Breakpoint data consists of a list of breakpoint properties. All properties are optional, except ID.
Tools and targets can define additional properties. Predefined properties are:</p>
<ul>
<li><code><b><font face="Courier New" size=2 color=#333399>"ID" : <i><string></i></font></b></code>
- breakpoint ID
<li><code><b><font face="Courier New" size=2 color=#333399>"Enabled" : <i><boolean></i></font></b></code>
- if true breakpoint is enabled
<li><code><b><font face="Courier New" size=2 color=#333399>"Address" : <i><string></i></font></b></code>
- if preset, defines address of the breakpoint. Address is an expression that evaluates to breakpoint memory address.
Alternatively, breakpoint location can be given as File/Line/Column.
<li><code><b><font face="Courier New" size=2 color=#333399>"Condition" : <i><string></i></font></b></code>
- a conditional expression that is evaluted every time execution hits the breakpoint. If condition is evaluated to false,
the breakpoint is skipped and execution is resumed without sending notifications to a host.
<li><code><b><font face="Courier New" size=2 color=#333399>"File" : <i><string></i></font></b></code>
- source code file name of breakpoint location.
<li><code><b><font face="Courier New" size=2 color=#333399>"Line" : <i><int></i></font></b></code>
- source code line number of breakpoint location.
<li><code><b><font face="Courier New" size=2 color=#333399>"Column" : <i><int></i></font></b></code>
- source code column number of breakpoint location.
</ul>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<h3><a name='CmdAdd'>Add</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • add • <i><breakpoint data></i> •
</font></b></pre>
<p>The command adds breakpoint to target agent breakpoint table. Host should send this command when user creates new breakpoint</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<h3><a name='CmdChange'>Change</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • change • <i><breakpoint data></i> •
</font></b></pre>
<p>The command updates breakpoint data in target agent breakpoint table. Host should send this command when user modifies a breakpoint</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<h3><a name='CmdEnable'>Enable</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • enable • <i><array of breakpoint IDs></i> •
<i><array of breakpoint IDs></i>
<font face=Wingdings>Ø</font> null
<font face=Wingdings>Ø</font> [ ]
<font face=Wingdings>Ø</font> [ <i><breakpoint IDs list></i> ]
<i><breakpoint IDs list></i>
<font face=Wingdings>Ø</font> <i><breakpoint ID></i>
<font face=Wingdings>Ø</font> <i><breakpoint ID></i> , <i><breakpoint ID></i>
<i><breakpoint ID></i>
<font face=Wingdings>Ø</font> <i><string></i>
</font></b></pre>
<p>The command enables a list of breakpoints - sets brekpoint property "Enabled" to true.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<h3><a name='CmdDisable'>Disable</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • disable • <i><array of breakpoint IDs></i> •
</font></b></pre>
<p>The command disables a list of breakpoints - sets brekpoint property "Enabled" to false.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<h3><a name='CmdRemove'>Remove</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • remove • <i><array of breakpoint IDs></i> •
</font></b></pre>
<p>The command removes a list of breakpoints. Host should send this command when user deletes breakpoints.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> •
</font></b></pre>
<h3><a name='CmdGetIDs'>Get IDs</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • getIDs •
</font></b></pre>
<p>The command uploads IDs of breakpoints known to target agent. Only breakpoints what are set through
this communication channel are reported. Target agent should maintain separate breakpoint table
for each communication channel.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><array of breakpoint IDs></i> •
</font></b></pre>
<h3><a name='CmdGetProperties'>Get Properties</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • getProperties • <i><string: breakpoint ID></i> •
</font></b></pre>
<p>The command uploads properties of given breakpoint from target agent breakpoint table.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><;breakpoint data></i> •
</font></b></pre>
<h3><a name='CmdGetStatus'>Get Status</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • getStatus • <i><string: breakpoint ID></i> •
</font></b></pre>
<p>The command uploads status of given breakpoint from target agent.</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><;breakpoint status></i> •
<i><breakpoint status></i>
<font face=Wingdings>Ø</font> <i><object></i>
</font></b></pre>
<p>Breakpoint status consists of a list of status properties. All properties are optional.
Tools and targets can define additional properties. Predefined properties are:</p>
<ul>
<li><code><b><font face="Courier New" size=2 color=#333399>"Planted" : <i><array of addresses></i></font></b></code>
<li><code><b><font face="Courier New" size=2 color=#333399>"Error" : <i><string></i></font></b></code>
<li><code><b><font face="Courier New" size=2 color=#333399>"File" : <i><string></i></font></b></code>
<li><code><b><font face="Courier New" size=2 color=#333399>"Line" : <i><int></i></font></b></code>
<li><code><b><font face="Courier New" size=2 color=#333399>"Column" : <i><int></i></font></b></code>
</ul>
<h3><a name='CmdGetCapabilities'>Get Capabilities</a></h3>
<pre><b><font face="Courier New" size=2 color=#333399>
C • <i><token></i> • Breakpoints • getCapabilities • <i><string: context ID></i> •
</font></b></pre>
<p>The command reports breakpoint service capabilities to clients so they
can adjust to different implementations of the service.
When called with a null ("") context ID the global capabilities are returned,
otherwise context specific capabilities are returned. A special capability
property is used to indicate that all child contexts have the same
capabilities..</p>
<p>Reply:</p>
<pre><b><font face="Courier New" size=2 color=#333399>
R • <i><token></i> • <i><error report></i> • <i><;service capabilities></i> •
<i><service capabilities></i>
<font face=Wingdings>Ø</font> <i><object></i>
</font></b></pre>
<p>Service capabilities consist of a list of properties. All properties are optional.
Tools and targets can define additional properties. Predefined properties are:</p>
<ul>
<li><code><b><font face="Courier New" size=2 color=#333399>"ID" : <i><string: context ID></i></font></b></code>
- ID of a context that was used to query capabilities
<li><code><b><font face="Courier New" size=2 color=#333399>"HasChildren" : <i><boolean></i></font></b></code>
- if true, children of the context can have different capabilities
<li><code><b><font face="Courier New" size=2 color=#333399>"Address" : <i><boolean></i></font></b></code>
- if true, "Address" breakpoint property is supported
<li><code><b><font face="Courier New" size=2 color=#333399>"Condition" : <i><boolean></i></font></b></code>
- if true, "Condition" breakpoint property is supported
<li><code><b><font face="Courier New" size=2 color=#333399>"FileLine" : <i><boolean></i></font></b></code>
- if true, "File", "Line" and "Column" breakpoint properties are supported
</ul>
<h2><a name='Events'>Events</a></h2>
<p>Breakpoints service events are user to notify clients about breakpoint properties and status changes.
Note that contextAdded, contextChanged and contextRemoved events carry exactly same set
of breakpoint properties that was sent by a client to a target. The purpose of these events is to
let all clients know about breakpoints that were created by other clients.</p>
<pre><b><font face="Courier New" size=2 color=#333399>
E • Breakpoints • status • <i><string: breakpoint ID></i> • <i><breakpoint status></i> •
E • Breakpoints • contextAdded • <i><array of breakpoints></i> •
E • Breakpoints • contextChanged • <i><array of breakpoints></i> •
E • Breakpoints • contextRemoved • <i><array of breakpoint IDs></i> •
</font></b></pre>
<dl>
<dt><b>status</b>
<dd>is sent when breakpoint status changes.
<dt><b>contextAdded</b>
<dd>is sent when a new breakpoints are added.
<dt><b>contextChanged</b>
<dd>is sent when breakpoint properties change.
<dt><b>contextRemoved</b>
<dd>is sent when breakpoints are removed.
</dl>
<h2><a name='API'>API</a></h2>
<pre>
<font color=#3F5FBF>/**
* Breakpoint is represented by unique identifier and set of properties.
* Breakpoint identifier (String id) needs to be unique across all hosts and targets.
*
* Breakpoint properties (Map<String,Object>) is extendible collection of named attributes,
* which define breakpoint location and behavior. This module defines some common
* attribute names (see PROP_*), host tools and target agents may support additional attributes.
*
* For each breakpoint a target agent maintains another extendible collection of named attributes:
* breakpoint status (Map<String,Object>, see STATUS_*). While breakpoint properties are
* persistent and represent user input, breakpoint status reflects dynamic target agent reports
* about breakpoint current state, like actual addresses where breakpoint is planted or planting errors.
*/</font>
<font color=#7F0055>public interface</font> IBreakpoints <font color=#7F0055>extends</font> IService {
<font color=#3F5FBF>/**
* Service name.
*/</font>
<font color=#7F0055>static final</font> String NAME = "Breakpoints";
<font color=#3F5FBF>/**
* Breakpoint property names.
*/</font>
<font color=#7F0055>static final</font> String
PROP_ID = "ID", // String
PROP_ENABLED = "Enabled", // Boolean
PROP_ADDRESS = "Address", // String
PROP_CONDITION = "Condition", // String
PROP_FILE = "File", // String
PROP_LINE = "Line", // Number
PROP_COLUMN = "Column"; // Number
<font color=#3F5FBF>/**
* Breakpoint status field names.
*/</font>
<font color=#7F0055>static final</font> String
STATUS_PLANTED = "Planted", // Array of addresses
STATUS_ERROR = "Error", // String
STATUS_FILE = "File", // String
STATUS_LINE = "Line", // Number
STATUS_COLUMN = "Column"; // Number
<font color=#3F5FBF>/**
* Breakpoint service capabilities.
*/</font>
<font color=#7F0055>static final</font> String
CAPABILITY_CONTEXT_ID = "ID", // String
CAPABILITY_HAS_CHILDREN = "HasChildren", // Boolean
CAPABILITY_ADDRESS = "Address", // Boolean
CAPABILITY_CONDITION = "Condition", // Boolean
CAPABILITY_FILE_LINE = "FileLine"; // Boolean
<font color=#3F5FBF>/**
* Call back interface for breakpoint service commands.
*/</font>
<font color=#7F0055>interface</font> DoneCommand {
<font color=#7F0055>void</font> doneCommand(IToken token, Exception error);
}
<font color=#3F5FBF>/**
* Download breakpoints data to target agent.
* The command is intended to be used only to initialize target breakpoints table
* when communication channel is open. After that, host should
* notify target about (incremental) changes in breakpoint data by sending
* add, change and remove commands.
*
* @param properties - array of breakpoints.
* @param done - command result call back object.
*/</font>
IToken set(Map<String,Object>[] properties, DoneCommand done);
<font color=#3F5FBF>/**
* Called when breakpoint is added into breakpoints table.
* @param properties - breakpoint properties.
* @param done - command result call back object.
*/</font>
IToken add(Map<String,Object> properties, DoneCommand done);
<font color=#3F5FBF>/**
* Called when breakpoint properties are changed.
* @param properties - breakpoint properties.
* @param done - command result call back object.
*/</font>
IToken change(Map<String,Object> properties, DoneCommand done);
<font color=#3F5FBF>/**
* Tell target to change (only) PROP_ENABLED breakpoint property to 'true'.
* @param ids - array of enabled breakpoint identifiers.
* @param done - command result call back object.
*/</font>
IToken enable(String[] ids, DoneCommand done);
<font color=#3F5FBF>/**
* Tell target to change (only) PROP_ENABLED breakpoint property to 'false'.
* @param ids - array of disabled breakpoint identifiers.
* @param done - command result call back object.
*/</font>
IToken disable(String[] ids, DoneCommand done);
<font color=#3F5FBF>/**
* Tell target to remove breakpoints.
* @param id - unique breakpoint identifier.
* @param done - command result call back object.
*/</font>
IToken remove(String[] ids, DoneCommand done);
<font color=#3F5FBF>/**
* Upload IDs of breakpoints known to target agent.
* @param done - command result call back object.
*/</font>
IToken getIDs(DoneGetIDs done);
<font color=#7F0055>interface</font> DoneGetIDs {
<font color=#7F0055>void</font> doneGetIDs(IToken token, Exception error, String[] ids);
}
<font color=#3F5FBF>/**
* Upload properties of given breakpoint from target agent breakpoint table.
* @param id - unique breakpoint identifier.
* @param done - command result call back object.
*/</font>
IToken getProperties(String id, DoneGetProperties done);
<font color=#7F0055>interface</font> DoneGetProperties {
<font color=#7F0055>void</font> doneGetProperties(IToken token, Exception error, Map<String,Object> properties);
}
<font color=#3F5FBF>/**
* Upload status of given breakpoint from target agent.
* @param id - unique breakpoint identifier.
* @param done - command result call back object.
*/</font>
IToken getStatus(String id, DoneGetStatus done);
<font color=#7F0055>interface</font> DoneGetStatus {
<font color=#7F0055>void</font> doneGetStatus(IToken token, Exception error, Map<String,Object> status);
}
<font color=#3F5FBF>/**
* Report breakpoint service capabilities to clients so they
* can adjust to different implementations of the service.
* When called with a null ("") context ID the global capabilities are returned,
* otherwise context specific capabilities are returned. A special capability
* property is used to indicate that all child contexts have the same
* capabilities.
* @param id - a context ID or null.
* @param done - command result call back object.
*/</font>
IToken getCapabilities(String id, DoneGetCapabilities done);
<font color=#7F0055>interface</font> DoneGetCapabilities {
void</font> doneGetCapabilities(IToken token, Exception error, Map<String,Object> capabilities);
}
<font color=#3F5FBF>/**
* Breakpoints service events listener.
* Note that contextAdded, contextChanged and contextRemoved events carry exactly same set
* of breakpoint properties that was sent by a client to a target. The purpose of these events is to
* let all clients know about breakpoints that were created by other clients.
*/</font>
<font color=#7F0055>interface</font> BreakpointsListener {
<font color=#3F5FBF>/**
* Called when breakpoint status changes.
* @param id - unique breakpoint identifier.
* @param status - breakpoint status.
*/</font>
<font color=#7F0055>void</font> breakpointStatusChanged(String id, Map<String,Object> status);
<font color=#3F5FBF>/**
* Called when a new breakpoints are added.
* @param bps - array of breakpoints.
*/</font>
<font color=#7F0055>void</font> contextAdded(Map<String,Object>[] bps);
<font color=#3F5FBF>/**
* Called when breakpoint properties change.
* @param bps - array of breakpoints.
*/</font>
<font color=#7F0055>void</font> contextChanged(Map<String,Object>[] bps);
<font color=#3F5FBF>/**
* Called when breakpoints are removed.
* @param ids - array of breakpoint IDs.
*/</font>
<font color=#7F0055>void</font> contextRemoved(String[] ids);
}
<font color=#3F5FBF>/**
* Add breakpoints service event listener.
* @param listener - object that implements BreakpointsListener interface.
*/</font>
<font color=#7F0055>void</font> addListener(BreakpointsListener listener);
<font color=#3F5FBF>/**
* Remove breakpoints service event listener.
* @param listener - object that implements BreakpointsListener interface.
*/</font>
<font color=#7F0055>void</font> removeListener(BreakpointsListener listener);
}
</pre>
</body>
</html>
|
