source: mainline/kernel/arch/mips32/src/debugger.c@ 76fca31

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 76fca31 was 76fca31, checked in by Martin Decky <martin@…>, 17 years ago

kconsole is optional
kernel & uspace framebuffer rewrite with speedups (some things are slightly broken yet)
  • Property mode set to 100644
File size: 11.1 KB
Line 
1/*
2 * Copyright (c) 2005 Ondrej Palkovsky
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup mips32debug
30 * @{
31 */
32/** @file
33 */
34
35#include <arch/debugger.h>
36#include <arch/barrier.h>
37#include <memstr.h>
38#include <console/kconsole.h>
39#include <console/cmd.h>
40#include <symtab.h>
41#include <print.h>
42#include <panic.h>
43#include <arch.h>
44#include <arch/cp0.h>
45#include <func.h>
46
47bpinfo_t breakpoints[BKPOINTS_MAX];
48SPINLOCK_INITIALIZE(bkpoint_lock);
49
50#ifdef CONFIG_KCONSOLE
51
52static int cmd_print_breakpoints(cmd_arg_t *argv);
53static cmd_info_t bkpts_info = {
54 .name = "bkpts",
55 .description = "Print breakpoint table.",
56 .func = cmd_print_breakpoints,
57 .argc = 0,
58};
59
60static int cmd_del_breakpoint(cmd_arg_t *argv);
61static cmd_arg_t del_argv = {
62 .type = ARG_TYPE_INT
63};
64static cmd_info_t delbkpt_info = {
65 .name = "delbkpt",
66 .description = "delbkpt <number> - Delete breakpoint.",
67 .func = cmd_del_breakpoint,
68 .argc = 1,
69 .argv = &del_argv
70};
71
72static int cmd_add_breakpoint(cmd_arg_t *argv);
73static cmd_arg_t add_argv = {
74 .type = ARG_TYPE_INT
75};
76static cmd_info_t addbkpt_info = {
77 .name = "addbkpt",
78 .description = "addbkpt <&symbol> - new bkpoint. Break on J/Branch "
79 "insts unsupported.",
80 .func = cmd_add_breakpoint,
81 .argc = 1,
82 .argv = &add_argv
83};
84
85static cmd_arg_t adde_argv[] = {
86 { .type = ARG_TYPE_INT },
87 { .type = ARG_TYPE_INT }
88};
89static cmd_info_t addbkpte_info = {
90 .name = "addbkpte",
91 .description = "addebkpte <&symbol> <&func> - new bkpoint. Call "
92 "func(or Nothing if 0).",
93 .func = cmd_add_breakpoint,
94 .argc = 2,
95 .argv = adde_argv
96};
97
98static struct {
99 uint32_t andmask;
100 uint32_t value;
101} jmpinstr[] = {
102 {0xf3ff0000, 0x41000000}, /* BCzF */
103 {0xf3ff0000, 0x41020000}, /* BCzFL */
104 {0xf3ff0000, 0x41010000}, /* BCzT */
105 {0xf3ff0000, 0x41030000}, /* BCzTL */
106 {0xfc000000, 0x10000000}, /* BEQ */
107 {0xfc000000, 0x50000000}, /* BEQL */
108 {0xfc1f0000, 0x04010000}, /* BEQL */
109 {0xfc1f0000, 0x04110000}, /* BGEZAL */
110 {0xfc1f0000, 0x04130000}, /* BGEZALL */
111 {0xfc1f0000, 0x04030000}, /* BGEZL */
112 {0xfc1f0000, 0x1c000000}, /* BGTZ */
113 {0xfc1f0000, 0x5c000000}, /* BGTZL */
114 {0xfc1f0000, 0x18000000}, /* BLEZ */
115 {0xfc1f0000, 0x58000000}, /* BLEZL */
116 {0xfc1f0000, 0x04000000}, /* BLTZ */
117 {0xfc1f0000, 0x04100000}, /* BLTZAL */
118 {0xfc1f0000, 0x04120000}, /* BLTZALL */
119 {0xfc1f0000, 0x04020000}, /* BLTZL */
120 {0xfc000000, 0x14000000}, /* BNE */
121 {0xfc000000, 0x54000000}, /* BNEL */
122 {0xfc000000, 0x08000000}, /* J */
123 {0xfc000000, 0x0c000000}, /* JAL */
124 {0xfc1f07ff, 0x00000009}, /* JALR */
125 {0, 0} /* EndOfTable */
126};
127
128
129/** Test, if the given instruction is a jump or branch instruction
130 *
131 * @param instr Instruction code
132 * @return true - it is jump instruction, false otherwise
133 *
134 */
135static bool is_jump(unative_t instr)
136{
137 int i;
138
139 for (i = 0; jmpinstr[i].andmask; i++) {
140 if ((instr & jmpinstr[i].andmask) == jmpinstr[i].value)
141 return true;
142 }
143
144 return false;
145}
146
147/** Add new breakpoint to table */
148int cmd_add_breakpoint(cmd_arg_t *argv)
149{
150 bpinfo_t *cur = NULL;
151 ipl_t ipl;
152 int i;
153
154 if (argv->intval & 0x3) {
155 printf("Not aligned instruction, forgot to use &symbol?\n");
156 return 1;
157 }
158 ipl = interrupts_disable();
159 spinlock_lock(&bkpoint_lock);
160
161 /* Check, that the breakpoints do not conflict */
162 for (i = 0; i < BKPOINTS_MAX; i++) {
163 if (breakpoints[i].address == (uintptr_t)argv->intval) {
164 printf("Duplicate breakpoint %d.\n", i);
165 spinlock_unlock(&bkpoints_lock);
166 return 0;
167 } else if (breakpoints[i].address == (uintptr_t)argv->intval +
168 sizeof(unative_t) || breakpoints[i].address ==
169 (uintptr_t)argv->intval - sizeof(unative_t)) {
170 printf("Adjacent breakpoints not supported, conflict "
171 "with %d.\n", i);
172 spinlock_unlock(&bkpoints_lock);
173 return 0;
174 }
175
176 }
177
178 for (i = 0; i < BKPOINTS_MAX; i++)
179 if (!breakpoints[i].address) {
180 cur = &breakpoints[i];
181 break;
182 }
183 if (!cur) {
184 printf("Too many breakpoints.\n");
185 spinlock_unlock(&bkpoint_lock);
186 interrupts_restore(ipl);
187 return 0;
188 }
189 cur->address = (uintptr_t) argv->intval;
190 printf("Adding breakpoint on address: %p\n", argv->intval);
191 cur->instruction = ((unative_t *)cur->address)[0];
192 cur->nextinstruction = ((unative_t *)cur->address)[1];
193 if (argv == &add_argv) {
194 cur->flags = 0;
195 } else { /* We are add extended */
196 cur->flags = BKPOINT_FUNCCALL;
197 cur->bkfunc = (void (*)(void *, istate_t *)) argv[1].intval;
198 }
199 if (is_jump(cur->instruction))
200 cur->flags |= BKPOINT_ONESHOT;
201 cur->counter = 0;
202
203 /* Set breakpoint */
204 *((unative_t *)cur->address) = 0x0d;
205 smc_coherence(cur->address);
206
207 spinlock_unlock(&bkpoint_lock);
208 interrupts_restore(ipl);
209
210 return 1;
211}
212
213/** Remove breakpoint from table */
214int cmd_del_breakpoint(cmd_arg_t *argv)
215{
216 bpinfo_t *cur;
217 ipl_t ipl;
218
219 if (argv->intval > BKPOINTS_MAX) {
220 printf("Invalid breakpoint number.\n");
221 return 0;
222 }
223 ipl = interrupts_disable();
224 spinlock_lock(&bkpoint_lock);
225
226 cur = &breakpoints[argv->intval];
227 if (!cur->address) {
228 printf("Breakpoint does not exist.\n");
229 spinlock_unlock(&bkpoint_lock);
230 interrupts_restore(ipl);
231 return 0;
232 }
233 if ((cur->flags & BKPOINT_INPROG) && (cur->flags & BKPOINT_ONESHOT)) {
234 printf("Cannot remove one-shot breakpoint in-progress\n");
235 spinlock_unlock(&bkpoint_lock);
236 interrupts_restore(ipl);
237 return 0;
238 }
239 ((uint32_t *)cur->address)[0] = cur->instruction;
240 smc_coherence(((uint32_t *)cur->address)[0]);
241 ((uint32_t *)cur->address)[1] = cur->nextinstruction;
242 smc_coherence(((uint32_t *)cur->address)[1]);
243
244 cur->address = NULL;
245
246 spinlock_unlock(&bkpoint_lock);
247 interrupts_restore(ipl);
248 return 1;
249}
250
251/** Print table of active breakpoints */
252int cmd_print_breakpoints(cmd_arg_t *argv)
253{
254 unsigned int i;
255 char *symbol;
256
257 printf("# Count Address INPROG ONESHOT FUNCCALL In symbol\n");
258 printf("-- ----- ---------- ------ ------- -------- ---------\n");
259
260 for (i = 0; i < BKPOINTS_MAX; i++)
261 if (breakpoints[i].address) {
262 symbol = get_symtab_entry(breakpoints[i].address);
263
264 printf("%-2u %-5d %#10zx %-6s %-7s %-8s %s\n", i,
265 breakpoints[i].counter, breakpoints[i].address,
266 ((breakpoints[i].flags & BKPOINT_INPROG) ? "true" :
267 "false"), ((breakpoints[i].flags & BKPOINT_ONESHOT)
268 ? "true" : "false"), ((breakpoints[i].flags &
269 BKPOINT_FUNCCALL) ? "true" : "false"), symbol);
270 }
271 return 1;
272}
273
274#endif
275
276/** Initialize debugger */
277void debugger_init()
278{
279 int i;
280
281 for (i = 0; i < BKPOINTS_MAX; i++)
282 breakpoints[i].address = NULL;
283
284#ifdef CONFIG_KCONSOLE
285 cmd_initialize(&bkpts_info);
286 if (!cmd_register(&bkpts_info))
287 printf("Cannot register command %s\n", bkpts_info.name);
288
289 cmd_initialize(&delbkpt_info);
290 if (!cmd_register(&delbkpt_info))
291 printf("Cannot register command %s\n", delbkpt_info.name);
292
293 cmd_initialize(&addbkpt_info);
294 if (!cmd_register(&addbkpt_info))
295 printf("Cannot register command %s\n", addbkpt_info.name);
296
297 cmd_initialize(&addbkpte_info);
298 if (!cmd_register(&addbkpte_info))
299 printf("Cannot register command %s\n", addbkpte_info.name);
300#endif
301}
302
303/** Handle breakpoint
304 *
305 * Find breakpoint in breakpoint table.
306 * If found, call kconsole, set break on next instruction and reexecute.
307 * If we are on "next instruction", set it back on the first and reexecute.
308 * If breakpoint not found in breakpoint table, call kconsole and start
309 * next instruction.
310 */
311void debugger_bpoint(istate_t *istate)
312{
313 bpinfo_t *cur = NULL;
314 uintptr_t fireaddr = istate->epc;
315 int i;
316
317 /* test branch delay slot */
318 if (cp0_cause_read() & 0x80000000)
319 panic("Breakpoint in branch delay slot not supported.\n");
320
321 spinlock_lock(&bkpoint_lock);
322 for (i = 0; i < BKPOINTS_MAX; i++) {
323 /* Normal breakpoint */
324 if (fireaddr == breakpoints[i].address &&
325 !(breakpoints[i].flags & BKPOINT_REINST)) {
326 cur = &breakpoints[i];
327 break;
328 }
329 /* Reinst only breakpoint */
330 if ((breakpoints[i].flags & BKPOINT_REINST) &&
331 (fireaddr == breakpoints[i].address + sizeof(unative_t))) {
332 cur = &breakpoints[i];
333 break;
334 }
335 }
336 if (cur) {
337 if (cur->flags & BKPOINT_REINST) {
338 /* Set breakpoint on first instruction */
339 ((uint32_t *)cur->address)[0] = 0x0d;
340 smc_coherence(((uint32_t *)cur->address)[0]);
341 /* Return back the second */
342 ((uint32_t *)cur->address)[1] = cur->nextinstruction;
343 smc_coherence(((uint32_t *)cur->address)[1]);
344 cur->flags &= ~BKPOINT_REINST;
345 spinlock_unlock(&bkpoint_lock);
346 return;
347 }
348 if (cur->flags & BKPOINT_INPROG)
349 printf("Warning: breakpoint recursion\n");
350
351 if (!(cur->flags & BKPOINT_FUNCCALL))
352 printf("***Breakpoint %d: %p in %s.\n", i, fireaddr,
353 get_symtab_entry(istate->epc));
354
355 /* Return first instruction back */
356 ((uint32_t *)cur->address)[0] = cur->instruction;
357 smc_coherence(cur->address);
358
359 if (! (cur->flags & BKPOINT_ONESHOT)) {
360 /* Set Breakpoint on next instruction */
361 ((uint32_t *)cur->address)[1] = 0x0d;
362 cur->flags |= BKPOINT_REINST;
363 }
364 cur->flags |= BKPOINT_INPROG;
365 } else {
366 printf("***Breakpoint %p in %s.\n", fireaddr,
367 get_symtab_entry(fireaddr));
368 /* Move on to next instruction */
369 istate->epc += 4;
370 }
371 if (cur)
372 cur->counter++;
373 if (cur && (cur->flags & BKPOINT_FUNCCALL)) {
374 /* Allow zero bkfunc, just for counting */
375 if (cur->bkfunc)
376 cur->bkfunc(cur, istate);
377 } else {
378#ifdef CONFIG_KCONSOLE
379 /* This disables all other processors - we are not SMP,
380 * actually this gets us to cpu_halt, if scheduler() is run
381 * - we generally do not want scheduler to be run from debug,
382 * so this is a good idea
383 */
384 atomic_set(&haltstate, 1);
385 spinlock_unlock(&bkpoint_lock);
386
387 kconsole("debug", "Debug console ready (type 'exit' to continue)\n", false);
388
389 spinlock_lock(&bkpoint_lock);
390 atomic_set(&haltstate, 0);
391#endif
392 }
393 if (cur && cur->address == fireaddr && (cur->flags & BKPOINT_INPROG)) {
394 /* Remove one-shot breakpoint */
395 if ((cur->flags & BKPOINT_ONESHOT))
396 cur->address = NULL;
397 /* Remove in-progress flag */
398 cur->flags &= ~BKPOINT_INPROG;
399 }
400 spinlock_unlock(&bkpoint_lock);
401}
402
403/** @}
404 */
Note: See TracBrowser for help on using the repository browser.