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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
|
/** @file
Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "Edb.h"
/**
Check whether current IP is EBC BREAK3 instruction.
@param Address EBC IP address.
@retval TRUE Current IP is EBC BREAK3 instruction
@retval FALSE Current IP is not EBC BREAK3 instruction
**/
BOOLEAN
IsEBCBREAK3 (
IN UINTN Address
)
{
if (GET_OPCODE (Address) != OPCODE_BREAK) {
return FALSE;
}
if (GET_OPERANDS (Address) != 3) {
return FALSE;
} else {
return TRUE;
}
}
/**
Check whether the Address is already set in breakpoint.
@param DebuggerPrivate EBC Debugger private data structure
@param Address Breakpoint Address
@retval TRUE breakpoint is found
@retval FALSE breakpoint is not found
**/
BOOLEAN
DebuggerBreakpointIsDuplicated (
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN UINTN Address
)
{
UINTN Index;
//
// Go through each breakpoint context
//
for (Index = 0; Index < DebuggerPrivate->DebuggerBreakpointCount; Index++) {
if (DebuggerPrivate->DebuggerBreakpointContext[Index].BreakpointAddress == Address) {
//
// Found it
//
return TRUE;
}
}
//
// Not found
//
return FALSE;
}
/**
Add this breakpoint.
@param DebuggerPrivate EBC Debugger private data structure
@param Address Breakpoint Address
@retval EFI_SUCCESS breakpoint added successfully
@retval EFI_ALREADY_STARTED breakpoint is already added
@retval EFI_OUT_OF_RESOURCES all the breakpoint entries are used
**/
EFI_STATUS
DebuggerBreakpointAdd (
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN UINTN Address
)
{
//
// Check duplicated breakpoint
//
if (DebuggerBreakpointIsDuplicated (DebuggerPrivate, Address)) {
EDBPrint (L"Breakpoint duplicated!\n");
return EFI_ALREADY_STARTED;
}
//
// Check whether the address is a breakpoint 3 instruction
//
if (IsEBCBREAK3 (Address)) {
EDBPrint (L"Breakpoint can not be set on BREAK 3 instruction!\n");
return EFI_ALREADY_STARTED;
}
if (DebuggerPrivate->DebuggerBreakpointCount >= EFI_DEBUGGER_BREAKPOINT_MAX) {
EDBPrint (L"Breakpoint out of resource!\n");
return EFI_OUT_OF_RESOURCES;
}
//
// Set the breakpoint
//
DebuggerPrivate->DebuggerBreakpointContext[DebuggerPrivate->DebuggerBreakpointCount].BreakpointAddress = Address;
DebuggerPrivate->DebuggerBreakpointContext[DebuggerPrivate->DebuggerBreakpointCount].State = TRUE;
DebuggerPrivate->DebuggerBreakpointContext[DebuggerPrivate->DebuggerBreakpointCount].OldInstruction = 0;
CopyMem (
&DebuggerPrivate->DebuggerBreakpointContext[DebuggerPrivate->DebuggerBreakpointCount].OldInstruction,
(VOID *)Address,
sizeof (UINT16)
);
DebuggerPrivate->DebuggerBreakpointCount++;
//
// Done
//
return EFI_SUCCESS;
}
/**
Delete this breakpoint.
@param DebuggerPrivate EBC Debugger private data structure
@param Index Breakpoint Index
@retval EFI_SUCCESS breakpoint deleted successfully
@retval EFI_NOT_FOUND breakpoint not found
**/
EFI_STATUS
DebuggerBreakpointDel (
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN UINTN Index
)
{
UINTN BpIndex;
if ((Index >= EFI_DEBUGGER_BREAKPOINT_MAX) ||
(Index >= DebuggerPrivate->DebuggerBreakpointCount))
{
return EFI_NOT_FOUND;
}
//
// Delete this breakpoint
//
for (BpIndex = Index; BpIndex < DebuggerPrivate->DebuggerBreakpointCount - 1; BpIndex++) {
CopyMem (
&DebuggerPrivate->DebuggerBreakpointContext[BpIndex],
&DebuggerPrivate->DebuggerBreakpointContext[BpIndex + 1],
sizeof (DebuggerPrivate->DebuggerBreakpointContext[BpIndex])
);
}
ZeroMem (
&DebuggerPrivate->DebuggerBreakpointContext[BpIndex],
sizeof (DebuggerPrivate->DebuggerBreakpointContext[BpIndex])
);
DebuggerPrivate->DebuggerBreakpointCount--;
//
// Done
//
return EFI_SUCCESS;
}
/**
Disable this breakpoint.
@param DebuggerPrivate EBC Debugger private data structure
@param Index Breakpoint Index
@retval EFI_SUCCESS breakpoint disabled successfully
@retval EFI_NOT_FOUND breakpoint not found
**/
EFI_STATUS
DebuggerBreakpointDis (
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN UINTN Index
)
{
if ((Index >= EFI_DEBUGGER_BREAKPOINT_MAX) ||
(Index >= DebuggerPrivate->DebuggerBreakpointCount))
{
return EFI_NOT_FOUND;
}
//
// Disable this breakpoint
//
DebuggerPrivate->DebuggerBreakpointContext[Index].State = FALSE;
return EFI_SUCCESS;
}
/**
Enable this breakpoint.
@param DebuggerPrivate - EBC Debugger private data structure
@param Index - Breakpoint Index
@retval EFI_SUCCESS - breakpoint enabled successfully
@retval EFI_NOT_FOUND - breakpoint not found
**/
EFI_STATUS
DebuggerBreakpointEn (
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN UINTN Index
)
{
if ((Index >= EFI_DEBUGGER_BREAKPOINT_MAX) ||
(Index >= DebuggerPrivate->DebuggerBreakpointCount))
{
return EFI_NOT_FOUND;
}
//
// Enable this breakpoint
//
DebuggerPrivate->DebuggerBreakpointContext[Index].State = TRUE;
return EFI_SUCCESS;
}
/**
DebuggerCommand - BreakpointList.
@param CommandArg - The argument for this command
@param DebuggerPrivate - EBC Debugger private data structure
@param ExceptionType - Exception type.
@param SystemContext - EBC system context.
@retval EFI_DEBUG_CONTINUE - formal return value
**/
EFI_DEBUG_STATUS
DebuggerBreakpointList (
IN CHAR16 *CommandArg,
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN EFI_EXCEPTION_TYPE ExceptionType,
IN OUT EFI_SYSTEM_CONTEXT SystemContext
)
{
UINTN Index;
//
// Check breakpoint cound
//
if (DebuggerPrivate->DebuggerBreakpointCount == 0) {
EDBPrint (L"No Breakpoint\n");
return EFI_DEBUG_CONTINUE;
} else if (DebuggerPrivate->DebuggerBreakpointCount > EFI_DEBUGGER_BREAKPOINT_MAX) {
EDBPrint (L"Breakpoint too many!\n");
DebuggerPrivate->DebuggerBreakpointCount = 0;
return EFI_DEBUG_CONTINUE;
}
//
// Go through each breakpoint
//
EDBPrint (L"Breakpoint :\n");
EDBPrint (L" Index Address Status\n");
EDBPrint (L"======= ================== ========\n");
// EDBPrint (L" 1 0xFFFFFFFF00000000 *\n");
// EDBPrint (L" 12 0x00000000FFFFFFFF\n");
for (Index = 0; Index < DebuggerPrivate->DebuggerBreakpointCount; Index++) {
//
// Print the breakpoint
//
EDBPrint (L" %2d 0x%016lx", Index, DebuggerPrivate->DebuggerBreakpointContext[Index].BreakpointAddress);
if (DebuggerPrivate->DebuggerBreakpointContext[Index].State) {
EDBPrint (L" *\n");
} else {
EDBPrint (L"\n");
}
}
//
// Done
//
return EFI_DEBUG_CONTINUE;
}
/**
DebuggerCommand - BreakpointSet.
@param CommandArg The argument for this command
@param DebuggerPrivate EBC Debugger private data structure
@param ExceptionType Exception type.
@param SystemContext EBC system context.
@retval EFI_DEBUG_CONTINUE - formal return value
**/
EFI_DEBUG_STATUS
DebuggerBreakpointSet (
IN CHAR16 *CommandArg,
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN EFI_EXCEPTION_TYPE ExceptionType,
IN OUT EFI_SYSTEM_CONTEXT SystemContext
)
{
UINTN Address;
EFI_STATUS Status;
if (CommandArg == NULL) {
EDBPrint (L"BreakpointSet Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
//
// Get breakpoint address
//
Status = Symboltoi (CommandArg, &Address);
if (EFI_ERROR (Status)) {
if (Status == EFI_NOT_FOUND) {
Address = Xtoi (CommandArg);
} else {
//
// Something wrong, let Symboltoi print error info.
//
EDBPrint (L"Command Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
}
//
// Add breakpoint
//
Status = DebuggerBreakpointAdd (DebuggerPrivate, Address);
if (EFI_ERROR (Status)) {
EDBPrint (L"BreakpointSet error!\n");
}
//
// Done
//
return EFI_DEBUG_CONTINUE;
}
/**
DebuggerCommand - BreakpointClear
@param CommandArg The argument for this command
@param DebuggerPrivate EBC Debugger private data structure
@param ExceptionType Exception type.
@param SystemContext EBC system context.
@retval EFI_DEBUG_CONTINUE formal return value
**/
EFI_DEBUG_STATUS
DebuggerBreakpointClear (
IN CHAR16 *CommandArg,
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN EFI_EXCEPTION_TYPE ExceptionType,
IN OUT EFI_SYSTEM_CONTEXT SystemContext
)
{
UINTN Index;
EFI_STATUS Status;
if (CommandArg == NULL) {
EDBPrint (L"BreakpointClear Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
if (StriCmp (CommandArg, L"*") == 0) {
//
// delete all breakpoint
//
DebuggerPrivate->DebuggerBreakpointCount = 0;
ZeroMem (DebuggerPrivate->DebuggerBreakpointContext, sizeof (DebuggerPrivate->DebuggerBreakpointContext));
EDBPrint (L"All the Breakpoint is cleared\n");
return EFI_DEBUG_CONTINUE;
}
//
// Get breakpoint index
//
Index = Atoi (CommandArg);
if (Index == (UINTN)-1) {
EDBPrint (L"BreakpointClear Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
if ((Index >= EFI_DEBUGGER_BREAKPOINT_MAX) ||
(Index >= DebuggerPrivate->DebuggerBreakpointCount))
{
EDBPrint (L"BreakpointClear error!\n");
return EFI_DEBUG_CONTINUE;
}
//
// Delete breakpoint
//
Status = DebuggerBreakpointDel (DebuggerPrivate, Index);
if (EFI_ERROR (Status)) {
EDBPrint (L"BreakpointClear error!\n");
}
//
// Done
//
return EFI_DEBUG_CONTINUE;
}
/**
DebuggerCommand - BreakpointDisable
@param CommandArg The argument for this command
@param DebuggerPrivate EBC Debugger private data structure
@param ExceptionType Exception type.
@param SystemContext EBC system context.
@retval EFI_DEBUG_CONTINUE formal return value
**/
EFI_DEBUG_STATUS
DebuggerBreakpointDisable (
IN CHAR16 *CommandArg,
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN EFI_EXCEPTION_TYPE ExceptionType,
IN OUT EFI_SYSTEM_CONTEXT SystemContext
)
{
UINTN Index;
EFI_STATUS Status;
if (CommandArg == NULL) {
EDBPrint (L"BreakpointDisable Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
if (StriCmp (CommandArg, L"*") == 0) {
//
// disable all breakpoint
//
for (Index = 0; Index < DebuggerPrivate->DebuggerBreakpointCount; Index++) {
Status = DebuggerBreakpointDis (DebuggerPrivate, Index);
}
EDBPrint (L"All the Breakpoint is disabled\n");
return EFI_DEBUG_CONTINUE;
}
//
// Get breakpoint index
//
Index = Atoi (CommandArg);
if (Index == (UINTN)-1) {
EDBPrint (L"BreakpointDisable Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
//
// Disable breakpoint
//
Status = DebuggerBreakpointDis (DebuggerPrivate, Index);
if (EFI_ERROR (Status)) {
EDBPrint (L"BreakpointDisable error!\n");
}
//
// Done
//
return EFI_DEBUG_CONTINUE;
}
/**
DebuggerCommand - BreakpointEnable.
@param CommandArg The argument for this command
@param DebuggerPrivate EBC Debugger private data structure
@param ExceptionType Exception type.
@param SystemContext EBC system context.
@retval EFI_DEBUG_CONTINUE formal return value
**/
EFI_DEBUG_STATUS
DebuggerBreakpointEnable (
IN CHAR16 *CommandArg,
IN EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,
IN EFI_EXCEPTION_TYPE ExceptionType,
IN OUT EFI_SYSTEM_CONTEXT SystemContext
)
{
UINTN Index;
EFI_STATUS Status;
if (CommandArg == NULL) {
EDBPrint (L"BreakpointEnable Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
if (StriCmp (CommandArg, L"*") == 0) {
//
// enable all breakpoint
//
for (Index = 0; Index < DebuggerPrivate->DebuggerBreakpointCount; Index++) {
Status = DebuggerBreakpointEn (DebuggerPrivate, Index);
}
EDBPrint (L"All the Breakpoint is enabled\n");
return EFI_DEBUG_CONTINUE;
}
//
// Get breakpoint index
//
Index = Atoi (CommandArg);
if (Index == (UINTN)-1) {
EDBPrint (L"BreakpointEnable Argument error!\n");
return EFI_DEBUG_CONTINUE;
}
//
// Enable breakpoint
//
Status = DebuggerBreakpointEn (DebuggerPrivate, Index);
if (EFI_ERROR (Status)) {
EDBPrint (L"BreakpointEnable error!\n");
}
//
// Done
//
return EFI_DEBUG_CONTINUE;
}
|
