2 * Copyright (c) 2008 The DragonFly Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
14 * 3. Neither the name of The DragonFly Project nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific, prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * Mach Operating System
34 * Copyright (c) 1991,1990 Carnegie Mellon University
35 * All Rights Reserved.
37 * Permission to use, copy, modify and distribute this software and its
38 * documentation is hereby granted, provided that both the copyright
39 * notice and this permission notice appear in all copies of the
40 * software, derivative works or modified versions, and any portions
41 * thereof, and that both notices appear in supporting documentation.
43 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
44 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
45 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
47 * Carnegie Mellon requests users of this software to return to
49 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
50 * School of Computer Science
51 * Carnegie Mellon University
52 * Pittsburgh PA 15213-3890
54 * any improvements or extensions that they make and grant Carnegie the
55 * rights to redistribute these changes.
57 * $FreeBSD: src/sys/i386/i386/db_trace.c,v 1.35.2.3 2002/02/21 22:31:25 silby Exp $
60 #include <sys/param.h>
61 #include <sys/systm.h>
62 #include <sys/linker_set.h>
67 #include <machine/cpu.h>
68 #include <machine/md_var.h>
71 #include <vm/vm_param.h>
73 #include <vm/vm_map.h>
75 #include <dlfcn.h> /* DLL */
79 #include <ddb/db_access.h>
80 #include <ddb/db_sym.h>
81 #include <ddb/db_variables.h>
93 * Machine register set.
95 struct db_variable db_regs[] = {
96 { "cs", &ddb_regs.tf_cs, NULL },
97 /* { "ds", &ddb_regs.tf_ds, NULL },
98 { "es", &ddb_regs.tf_es, NULL },
99 { "fs", &ddb_regs.tf_fs, NULL },
100 { "gs", &ddb_regs.tf_gs, NULL }, */
101 { "ss", &ddb_regs.tf_ss, NULL },
102 { "rax", &ddb_regs.tf_rax, NULL },
103 { "rcx", &ddb_regs.tf_rcx, NULL },
104 { "rdx", &ddb_regs.tf_rdx, NULL },
105 { "rbx", &ddb_regs.tf_rbx, NULL },
106 { "rsp", &ddb_regs.tf_rsp, NULL },
107 { "rbp", &ddb_regs.tf_rbp, NULL },
108 { "rsi", &ddb_regs.tf_rsi, NULL },
109 { "rdi", &ddb_regs.tf_rdi, NULL },
110 { "rip", &ddb_regs.tf_rip, NULL },
111 { "rfl", &ddb_regs.tf_rflags, NULL },
112 { "r8", &ddb_regs.tf_r8, NULL },
113 { "r9", &ddb_regs.tf_r9, NULL },
114 { "r10", &ddb_regs.tf_r10, NULL },
115 { "r11", &ddb_regs.tf_r11, NULL },
116 { "r12", &ddb_regs.tf_r12, NULL },
117 { "r13", &ddb_regs.tf_r13, NULL },
118 { "r14", &ddb_regs.tf_r14, NULL },
119 { "r15", &ddb_regs.tf_r15, NULL },
120 { "dr0", NULL, db_dr0 },
121 { "dr1", NULL, db_dr1 },
122 { "dr2", NULL, db_dr2 },
123 { "dr3", NULL, db_dr3 },
124 { "dr4", NULL, db_dr4 },
125 { "dr5", NULL, db_dr5 },
126 { "dr6", NULL, db_dr6 },
127 { "dr7", NULL, db_dr7 },
129 struct db_variable *db_eregs = db_regs + NELEM(db_regs);
134 #define INKERNEL(va) (((vm_offset_t)(va)) >= USRSTACK)
136 struct x86_64_frame {
137 struct x86_64_frame *f_frame;
147 static void db_nextframe(struct x86_64_frame **, db_addr_t *);
148 static int db_numargs(struct x86_64_frame *);
149 static void db_print_stack_entry(const char *, int, char **, long *, db_addr_t);
150 static void dl_symbol_values(long callpc, const char **name);
153 static char *watchtype_str(int type);
154 static int kx86_64_set_watch(int watchnum, unsigned int watchaddr,
155 int size, int access, struct dbreg * d);
156 static int kx86_64_clr_watch(int watchnum, struct dbreg * d);
157 int db_md_set_watchpoint(db_expr_t addr, db_expr_t size);
158 int db_md_clr_watchpoint(db_expr_t addr, db_expr_t size);
159 void db_md_list_watchpoints(void);
163 * Figure out how many arguments were passed into the frame at "fp".
166 db_numargs(struct x86_64_frame *fp)
169 return (0); /* regparm, needs dwarf2 info */
176 argp = (int *)db_get_value((int)&fp->f_retaddr, 4, FALSE);
178 * XXX etext is wrong for LKMs. We should attempt to interpret
179 * the instruction at the return address in all cases. This
180 * may require better fault handling.
182 if (argp < (int *)btext || argp >= (int *)etext) {
185 inst = db_get_value((int)argp, 4, FALSE);
186 if ((inst & 0xff) == 0x59) /* popl %ecx */
188 else if ((inst & 0xffff) == 0xc483) /* addl $Ibs, %esp */
189 args = ((inst >> 16) & 0xff) / 4;
200 db_print_stack_entry(const char *name, int narg, char **argnp, long *argp,
203 db_printf("%s(", name);
206 db_printf("%s=", *argnp++);
207 db_printf("%ld", (long)db_get_value((long)argp, 8, FALSE));
213 db_printsym(callpc, DB_STGY_PROC);
214 db_printf(" %p ", (void*) callpc);
219 * Figure out the next frame up in the call stack.
222 db_nextframe(struct x86_64_frame **fp, db_addr_t *ip)
224 struct trapframe *tf;
228 const char *sym, *name;
230 if ((unsigned long)*fp < PAGE_SIZE) {
234 rip = db_get_value((long) &(*fp)->f_retaddr, 8, FALSE);
235 rbp = db_get_value((long) &(*fp)->f_frame, 8, FALSE);
238 * Figure out frame type.
243 sym = db_search_symbol(rip, DB_STGY_ANY, &offset);
244 db_symbol_values(sym, &name, NULL);
245 dl_symbol_values(rip, &name);
247 if (!strcmp(name, "calltrap")) {
249 } else if (!strncmp(name, "Xresume", 7)) {
250 frame_type = INTERRUPT;
251 } else if (!strcmp(name, "_Xsyscall")) {
252 frame_type = SYSCALL;
257 * Normal frames need no special processing.
259 if (frame_type == NORMAL) {
260 *ip = (db_addr_t) rip;
261 *fp = (struct x86_64_frame *) rbp;
265 db_print_stack_entry(name, 0, 0, 0, rip);
268 * Point to base of trapframe which is just above the
271 tf = (struct trapframe *)((long)*fp + 16);
274 rsp = (ISPL(tf->tf_cs) == SEL_UPL) ? tf->tf_rsp : (long)&tf->tf_rsp;
276 rsp = (long)&tf->tf_rsp;
278 switch (frame_type) {
284 "--- trap %016lx, rip = %016lx, rsp = %016lx, rbp = %016lx ---\n",
285 tf->tf_trapno, rip, rsp, rbp);
293 "--- syscall %016lx, rip = %016lx, rsp = %016lx, rbp = %016lx ---\n",
294 tf->tf_rax, rip, rsp, rbp);
298 tf = (struct trapframe *)((long)*fp + 16);
303 "--- interrupt, rip = %016lx, rsp = %016lx, rbp = %016lx ---\n",
311 *ip = (db_addr_t) rip;
312 *fp = (struct x86_64_frame *) rbp;
316 db_stack_trace_cmd(db_expr_t addr, boolean_t have_addr, db_expr_t count,
319 struct x86_64_frame *frame;
329 frame = (struct x86_64_frame *)BP_REGS(&ddb_regs);
331 frame = (struct x86_64_frame *)(SP_REGS(&ddb_regs) - 8);
332 callpc = PC_REGS(&ddb_regs);
335 * Look for something that might be a frame pointer, just as
338 frame = (struct x86_64_frame *)addr;
339 for (i = 0; i < 4096; i += 8) {
340 struct x86_64_frame *check;
342 check = (struct x86_64_frame *)db_get_value((long)((char *)&frame->f_frame + i), 8, FALSE);
343 if ((char *)check - (char *)frame >= 0 &&
344 (char *)check - (char *)frame < 4096
348 db_printf("%p does not look like a stack frame, skipping\n", (char *)&frame->f_frame + i);
351 db_printf("Unable to find anything that looks like a stack frame\n");
354 frame = (void *)((char *)frame + i);
355 db_printf("Trace beginning at frame %p\n", frame);
356 callpc = (db_addr_t)db_get_value((long)&frame->f_retaddr, 8, FALSE);
361 struct x86_64_frame *actframe;
367 char *argnames[MAXNARG], **argnp = NULL;
369 sym = db_search_symbol(callpc, DB_STGY_ANY, &offset);
370 db_symbol_values(sym, &name, NULL);
371 dl_symbol_values(callpc, &name);
374 * Attempt to determine a (possibly fake) frame that gives
375 * the caller's pc. It may differ from `frame' if the
376 * current function never sets up a standard frame or hasn't
377 * set one up yet or has just discarded one. The last two
378 * cases can be guessed fairly reliably for code generated
379 * by gcc. The first case is too much trouble to handle in
380 * general because the amount of junk on the stack depends
381 * on the pc (the special handling of "calltrap", etc. in
382 * db_nextframe() works because the `next' pc is special).
389 instr = db_get_value(callpc, 4, FALSE);
390 if ((instr & 0xffffffff) == 0xe5894855) {
391 /* pushq %rbp; movq %rsp, %rbp */
392 actframe = (struct x86_64_frame *)
393 (SP_REGS(&ddb_regs) - 8);
394 } else if ((instr & 0xffffff) == 0xe58948) {
395 /* movq %rsp, %rbp */
396 actframe = (struct x86_64_frame *)
398 if (ddb_regs.tf_rbp == 0) {
399 /* Fake caller's frame better. */
402 } else if ((instr & 0xff) == 0xc3) {
404 actframe = (struct x86_64_frame *)
405 (SP_REGS(&ddb_regs) - 8);
406 } else if (offset == 0) {
407 /* Probably a symbol in assembler code. */
408 actframe = (struct x86_64_frame *)
409 (SP_REGS(&ddb_regs) - 8);
411 } else if (name != NULL &&
412 strcmp(name, "fork_trampoline") == 0) {
414 * Don't try to walk back on a stack for a
415 * process that hasn't actually been run yet.
417 db_print_stack_entry(name, 0, 0, 0, callpc);
423 argp = &actframe->f_arg0;
425 if (sym != NULL && db_sym_numargs(sym, &narg, argnames)) {
428 narg = db_numargs(frame);
431 db_print_stack_entry(name, narg, argnp, argp, callpc);
434 * Stop at the system call boundary (else we risk
435 * double-faulting on junk).
437 if (name && strcmp(name, "Xfast_syscall") == 0)
440 if (actframe != frame) {
441 /* `frame' belongs to caller. */
443 db_get_value((long)&actframe->f_retaddr, 8, FALSE);
447 db_nextframe(&frame, &callpc);
454 print_backtrace(int count)
458 __asm __volatile("movq %%rbp, %0" : "=r" (rbp));
459 db_stack_trace_cmd(rbp, 1, count, NULL);
462 #define DB_DRX_FUNC(reg) \
464 db_ ## reg (struct db_variable *vp, db_expr_t *valuep, int op) \
466 if (op == DB_VAR_GET) \
467 *valuep = r ## reg (); \
469 load_ ## reg (*valuep); \
484 kx86_64_set_watch(int watchnum, unsigned int watchaddr, int size, int access,
490 if (watchnum == -1) {
491 for (i = 0, mask = 0x3; i < 4; i++, mask <<= 2)
492 if ((d->dr[7] & mask) == 0)
502 size = 1; /* size must be 1 for an execution breakpoint */
504 case DBREG_DR7_WRONLY:
512 * we can watch a 1, 2, 4, or 8 byte sized location
533 /* clear the bits we are about to affect */
534 d->dr[7] &= ~((0x3 << (watchnum * 2)) | (0x0f << (watchnum * 4 + 16)));
536 /* set drN register to the address, N=watchnum */
537 DBREG_DRX(d, watchnum) = watchaddr;
539 /* enable the watchpoint */
540 d->dr[7] |= (0x2 << (watchnum * 2)) | (mask << (watchnum * 4 + 16));
547 kx86_64_clr_watch(int watchnum, struct dbreg *d)
549 if (watchnum < 0 || watchnum >= 4)
552 d->dr[7] &= ~((0x3 << (watchnum * 2)) | (0x0f << (watchnum * 4 + 16)));
553 DBREG_DRX(d, watchnum) = 0;
560 db_md_set_watchpoint(db_expr_t addr, db_expr_t size)
566 fill_dbregs(NULL, &d);
569 for (i = 0; i < 4; i++) {
570 if ((d.dr[7] & (3 << (i * 2))) == 0)
574 if (avail * 8 < size)
577 for (i=0; i < 4 && (size != 0); i++) {
578 if ((d.dr[7] & (3 << (i * 2))) == 0) {
579 if (size >= 8 || (avail == 1 && size > 4))
587 kx86_64_set_watch(i, addr, wsize, DBREG_DR7_WRONLY, &d);
593 set_dbregs(NULL, &d);
599 db_md_clr_watchpoint(db_expr_t addr, db_expr_t size)
604 fill_dbregs(NULL, &d);
606 for(i = 0; i < 4; i++) {
607 if (d.dr[7] & (3 << (i * 2))) {
608 if ((DBREG_DRX((&d), i) >= addr) &&
609 (DBREG_DRX((&d), i) < addr + size))
610 kx86_64_clr_watch(i, &d);
614 set_dbregs(NULL, &d);
620 watchtype_str(int type)
627 case DBREG_DR7_WRONLY:
635 db_md_list_watchpoints(void)
640 fill_dbregs(NULL, &d);
642 db_printf("\nhardware watchpoints:\n");
643 db_printf(" watch status type len address\n"
644 " ----- -------- ---------- --- ----------\n");
645 for (i = 0; i < 4; i++) {
646 if (d.dr[7] & (0x03 << (i * 2))) {
648 type = (d.dr[7] >> (16 + (i * 4))) & 3;
649 len = (d.dr[7] >> (16 + (i * 4) + 2)) & 3;
650 db_printf(" %-5d %-8s %10s %3d 0x%08lx\n",
651 i, "enabled", watchtype_str(type),
652 len + 1, DBREG_DRX((&d), i));
654 db_printf(" %-5d disabled\n", i);
658 db_printf("\ndebug register values:\n");
659 for (i = 0; i < 8; i++)
660 db_printf(" dr%d 0x%08lx\n", i, DBREG_DRX((&d),i));
665 * See if dladdr() can get the symbol name via the standard dynamic loader.
669 dl_symbol_values(long callpc, const char **name)
674 if (dladdr((const void *)callpc, &info) != 0) {
675 if (info.dli_saddr <= (const void *)callpc)
676 *name = info.dli_sname;