sys/platform/pc32/i386/db_trace.c

   1 /*
   2  * Mach Operating System
   3  * Copyright (c) 1991,1990 Carnegie Mellon University
   4  * All Rights Reserved.
   5  *
   6  * Permission to use, copy, modify and distribute this software and its
   7  * documentation is hereby granted, provided that both the copyright
   8  * notice and this permission notice appear in all copies of the
   9  * software, derivative works or modified versions, and any portions
  10  * thereof, and that both notices appear in supporting documentation.
  11  *
  12  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
  13  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  14  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  15  *
  16  * Carnegie Mellon requests users of this software to return to
  17  *
  18  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  19  *  School of Computer Science
  20  *  Carnegie Mellon University
  21  *  Pittsburgh PA 15213-3890
  22  *
  23  * any improvements or extensions that they make and grant Carnegie the
  24  * rights to redistribute these changes.
  25  *
  26  * $FreeBSD: src/sys/i386/i386/db_trace.c,v 1.35.2.3 2002/02/21 22:31:25 silby Exp $
  27  */
  28
  29 #include <sys/param.h>
  30 #include <sys/systm.h>
  31 #include <sys/linker_set.h>
  32 #include <sys/lock.h>
  33 #include <sys/proc.h>
  34 #include <sys/reg.h>
  35
  36 #include <machine/cpu.h>
  37 #include <machine/md_var.h>
  38
  39 #include <vm/vm.h>
  40 #include <vm/vm_param.h>
  41 #include <vm/pmap.h>
  42 #include <vm/vm_map.h>
  43 #include <ddb/ddb.h>
  44
  45 #include <sys/user.h>
  46
  47 #include <ddb/db_access.h>
  48 #include <ddb/db_sym.h>
  49 #include <ddb/db_variables.h>
  50
  51 db_varfcn_t db_dr0;
  52 db_varfcn_t db_dr1;
  53 db_varfcn_t db_dr2;
  54 db_varfcn_t db_dr3;
  55 db_varfcn_t db_dr4;
  56 db_varfcn_t db_dr5;
  57 db_varfcn_t db_dr6;
  58 db_varfcn_t db_dr7;
  59
  60 /*
  61  * Machine register set.
  62  */
  63 struct db_variable db_regs[] = {
  64         { "cs",         &ddb_regs.tf_cs,     NULL },
  65         { "ds",         &ddb_regs.tf_ds,     NULL },
  66         { "es",         &ddb_regs.tf_es,     NULL },
  67         { "fs",         &ddb_regs.tf_fs,     NULL },
  68         { "gs",         &ddb_regs.tf_gs,     NULL },
  69         { "ss",         &ddb_regs.tf_ss,     NULL },
  70         { "eax",        &ddb_regs.tf_eax,    NULL },
  71         { "ecx",        &ddb_regs.tf_ecx,    NULL },
  72         { "edx",        &ddb_regs.tf_edx,    NULL },
  73         { "ebx",        &ddb_regs.tf_ebx,    NULL },
  74         { "esp",        &ddb_regs.tf_esp,    NULL },
  75         { "ebp",        &ddb_regs.tf_ebp,    NULL },
  76         { "esi",        &ddb_regs.tf_esi,    NULL },
  77         { "edi",        &ddb_regs.tf_edi,    NULL },
  78         { "eip",        &ddb_regs.tf_eip,    NULL },
  79         { "efl",        &ddb_regs.tf_eflags, NULL },
  80         { "dr0",        NULL,                db_dr0 },
  81         { "dr1",        NULL,                db_dr1 },
  82         { "dr2",        NULL,                db_dr2 },
  83         { "dr3",        NULL,                db_dr3 },
  84         { "dr4",        NULL,                db_dr4 },
  85         { "dr5",        NULL,                db_dr5 },
  86         { "dr6",        NULL,                db_dr6 },
  87         { "dr7",        NULL,                db_dr7 },
  88 };
  89 struct db_variable *db_eregs = db_regs + NELEM(db_regs);
  90
  91 /*
  92  * Stack trace.
  93  */
  94 #define INKERNEL(va)    (((vm_offset_t)(va)) >= USRSTACK)
  95
  96 struct i386_frame {
  97         struct i386_frame       *f_frame;
  98         int                     f_retaddr;
  99         int                     f_arg0;
 100 };
 101
 102 #define NORMAL          0
 103 #define TRAP            1
 104 #define INTERRUPT       2
 105 #define SYSCALL         3
 106
 107 static void     db_nextframe(struct i386_frame **, db_addr_t *);
 108 static int      db_numargs(struct i386_frame *);
 109 static void     db_print_stack_entry(const char *, int, char **, int *, db_addr_t);
 110
 111
 112 static char     *watchtype_str(int type);
 113 static int      ki386_set_watch(int watchnum, unsigned int watchaddr,
 114                                int size, int access, struct dbreg * d);
 115 static int      ki386_clr_watch(int watchnum, struct dbreg * d);
 116 int             db_md_set_watchpoint(db_expr_t addr, db_expr_t size);
 117 int             db_md_clr_watchpoint(db_expr_t addr, db_expr_t size);
 118 void            db_md_list_watchpoints(void);
 119
 120
 121 /*
 122  * Figure out how many arguments were passed into the frame at "fp".
 123  */
 124 static int
 125 db_numargs(struct i386_frame *fp)
 126 {
 127         int     *argp;
 128         int     inst;
 129         int     args;
 130
 131         argp = (int *)db_get_value((int)&fp->f_retaddr, 4, FALSE);
 132         /*
 133          * XXX etext is wrong for LKMs.  We should attempt to interpret
 134          * the instruction at the return address in all cases.  This
 135          * may require better fault handling.
 136          */
 137         if (argp < (int *)btext || argp >= (int *)etext) {
 138                 args = 5;
 139         } else {
 140                 inst = db_get_value((int)argp, 4, FALSE);
 141                 if ((inst & 0xff) == 0x59)      /* popl %ecx */
 142                         args = 1;
 143                 else if ((inst & 0xffff) == 0xc483)     /* addl $Ibs, %esp */
 144                         args = ((inst >> 16) & 0xff) / 4;
 145                 else
 146                         args = 5;
 147         }
 148         return(args);
 149 }
 150
 151 static void
 152 db_print_stack_entry(const char *name, int narg, char **argnp, int *argp,
 153                      db_addr_t callpc)
 154 {
 155         db_printf("%s(", name);
 156         while (narg) {
 157                 if (argnp)
 158                         db_printf("%s=", *argnp++);
 159                 db_printf("%r", db_get_value((int)argp, 4, FALSE));
 160                 argp++;
 161                 if (--narg != 0)
 162                         db_printf(",");
 163         }
 164         db_printf(") at ");
 165         db_printsym(callpc, DB_STGY_PROC);
 166         db_printf("\n");
 167 }
 168
 169 /*
 170  * Figure out the next frame up in the call stack.
 171  */
 172 static void
 173 db_nextframe(struct i386_frame **fp, db_addr_t *ip)
 174 {
 175         struct trapframe *tf;
 176         int frame_type;
 177         int eip, esp, ebp;
 178         db_expr_t offset;
 179         const char *sym, *name;
 180
 181         eip = db_get_value((int) &(*fp)->f_retaddr, 4, FALSE);
 182         ebp = db_get_value((int) &(*fp)->f_frame, 4, FALSE);
 183
 184         /*
 185          * Figure out frame type.
 186          */
 187
 188         frame_type = NORMAL;
 189
 190         sym = db_search_symbol(eip, DB_STGY_ANY, &offset);
 191         db_symbol_values(sym, &name, NULL);
 192         if (name != NULL) {
 193                 if (!strcmp(name, "calltrap")) {
 194                         frame_type = TRAP;
 195                 } else if (!strncmp(name, "Xresume", 7)) {
 196                         frame_type = INTERRUPT;
 197                 } else if (!strcmp(name, "_Xsyscall")) {
 198                         frame_type = SYSCALL;
 199                 }
 200         }
 201
 202         /*
 203          * Normal frames need no special processing.
 204          */
 205         if (frame_type == NORMAL) {
 206                 *ip = (db_addr_t) eip;
 207                 *fp = (struct i386_frame *) ebp;
 208                 return;
 209         }
 210
 211         db_print_stack_entry(name, 0, 0, 0, eip);
 212
 213         /*
 214          * Point to base of trapframe which is just above the
 215          * current frame.
 216          */
 217         tf = (struct trapframe *) ((int)*fp + 8);
 218
 219         esp = (ISPL(tf->tf_cs) == SEL_UPL) ?  tf->tf_esp : (int)&tf->tf_esp;
 220         switch (frame_type) {
 221         case TRAP:
 222                 if (INKERNEL((int) tf)) {
 223                         eip = tf->tf_eip;
 224                         ebp = tf->tf_ebp;
 225                         db_printf(
 226                     "--- trap %#r, eip = %#r, esp = %#r, ebp = %#r ---\n",
 227                             tf->tf_trapno, eip, esp, ebp);
 228                 }
 229                 break;
 230         case SYSCALL:
 231                 if (INKERNEL((int) tf)) {
 232                         eip = tf->tf_eip;
 233                         ebp = tf->tf_ebp;
 234                         db_printf(
 235                     "--- syscall %#r, eip = %#r, esp = %#r, ebp = %#r ---\n",
 236                             tf->tf_eax, eip, esp, ebp);
 237                 }
 238                 break;
 239         case INTERRUPT:
 240                 tf = (struct trapframe *)((int)*fp + 16);
 241                 if (INKERNEL((int) tf)) {
 242                         eip = tf->tf_eip;
 243                         ebp = tf->tf_ebp;
 244                         db_printf(
 245                     "--- interrupt, eip = %#r, esp = %#r, ebp = %#r ---\n",
 246                             eip, esp, ebp);
 247                 }
 248                 break;
 249         default:
 250                 break;
 251         }
 252
 253         *ip = (db_addr_t) eip;
 254         *fp = (struct i386_frame *) ebp;
 255 }
 256
 257 void
 258 db_stack_trace_cmd(db_expr_t addr, boolean_t have_addr, db_expr_t count,
 259                    char *modif)
 260 {
 261         struct i386_frame *frame;
 262         int *argp;
 263         db_addr_t callpc;
 264         boolean_t first;
 265         int i;
 266
 267         if (count == -1)
 268                 count = 1024;
 269
 270         if (!have_addr) {
 271                 frame = (struct i386_frame *)BP_REGS(&ddb_regs);
 272                 if (frame == NULL)
 273                         frame = (struct i386_frame *)(SP_REGS(&ddb_regs) - 4);
 274                 callpc = PC_REGS(&ddb_regs);
 275         } else if (!INKERNEL(addr)) {
 276 #if 0 /* needswork */
 277                 pid = (addr % 16) + ((addr >> 4) % 16) * 10 +
 278                     ((addr >> 8) % 16) * 100 + ((addr >> 12) % 16) * 1000 +
 279                     ((addr >> 16) % 16) * 10000;
 280                 /*
 281                  * The pcb for curproc is not valid at this point,
 282                  * so fall back to the default case.
 283                  */
 284                 if ((curproc != NULL) && (pid == curproc->p_pid)) {
 285                         frame = (struct i386_frame *)BP_REGS(&ddb_regs);
 286                         if (frame == NULL)
 287                                 frame = (struct i386_frame *)
 288                                     (SP_REGS(&ddb_regs) - 4);
 289                         callpc = PC_REGS(&ddb_regs);
 290                 } else {
 291                         pid_t pid;
 292                         struct proc *p;
 293                         struct pcb *pcb;
 294
 295                         p = pfindn(pid);
 296                         if (p == NULL) {
 297                                 db_printf("pid %d not found\n", pid);
 298                                 return;
 299                         }
 300                         if ((p->p_flag & P_SWAPPEDOUT)) {
 301                                 db_printf("pid %d swapped out\n", pid);
 302                                 return;
 303                         }
 304                         pcb = p->p_thread->td_pcb;
 305                         frame = (struct i386_frame *)pcb->pcb_ebp;
 306                         if (frame == NULL)
 307                                 frame = (struct i386_frame *)
 308                                     (pcb->pcb_esp - 4);
 309                         callpc = (db_addr_t)pcb->pcb_eip;
 310                 }
 311 #else
 312                 /* XXX */
 313                 db_printf("no kernel stack address\n");
 314                 return;
 315 #endif
 316         } else {
 317                 /*
 318                  * Look for something that might be a frame pointer, just as
 319                  * a convenience.
 320                  */
 321                 frame = (struct i386_frame *)addr;
 322                 for (i = 0; i < 4096; i += 4) {
 323                         struct i386_frame *check;
 324
 325                         check = (struct i386_frame *)db_get_value((int)((char *)&frame->f_frame + i), 4, FALSE);
 326                         if ((char *)check - (char *)frame >= 0 &&
 327                             (char *)check - (char *)frame < 4096
 328                         ) {
 329                                 break;
 330                         }
 331                         db_printf("%p does not look like a stack frame, skipping\n", (char *)&frame->f_frame + i);
 332                 }
 333                 if (i == 4096) {
 334                         db_printf("Unable to find anything that looks like a stack frame\n");
 335                         return;
 336                 }
 337                 frame = (void *)((char *)frame + i);
 338                 db_printf("Trace beginning at frame %p\n", frame);
 339                 callpc = (db_addr_t)db_get_value((int)&frame->f_retaddr, 4, FALSE);
 340         }
 341
 342         first = TRUE;
 343         while (count--) {
 344                 struct i386_frame *actframe;
 345                 int             narg;
 346                 const char *    name;
 347                 db_expr_t       offset;
 348                 c_db_sym_t      sym;
 349 #define MAXNARG 16
 350                 char    *argnames[MAXNARG], **argnp = NULL;
 351
 352                 sym = db_search_symbol(callpc, DB_STGY_ANY, &offset);
 353                 db_symbol_values(sym, &name, NULL);
 354
 355                 /*
 356                  * Attempt to determine a (possibly fake) frame that gives
 357                  * the caller's pc.  It may differ from `frame' if the
 358                  * current function never sets up a standard frame or hasn't
 359                  * set one up yet or has just discarded one.  The last two
 360                  * cases can be guessed fairly reliably for code generated
 361                  * by gcc.  The first case is too much trouble to handle in
 362                  * general because the amount of junk on the stack depends
 363                  * on the pc (the special handling of "calltrap", etc. in
 364                  * db_nextframe() works because the `next' pc is special).
 365                  */
 366                 actframe = frame;
 367                 if (first) {
 368                         if (!have_addr) {
 369                                 int instr;
 370
 371                                 instr = db_get_value(callpc, 4, FALSE);
 372                                 if ((instr & 0x00ffffff) == 0x00e58955) {
 373                                         /* pushl %ebp; movl %esp, %ebp */
 374                                         actframe = (struct i386_frame *)
 375                                             (SP_REGS(&ddb_regs) - 4);
 376                                 } else if ((instr & 0x0000ffff) == 0x0000e589) {
 377                                         /* movl %esp, %ebp */
 378                                         actframe = (struct i386_frame *)
 379                                             SP_REGS(&ddb_regs);
 380                                         if (ddb_regs.tf_ebp == 0) {
 381                                                 /* Fake caller's frame better. */
 382                                                 frame = actframe;
 383                                         }
 384                                 } else if ((instr & 0x000000ff) == 0x000000c3) {
 385                                         /* ret */
 386                                         actframe = (struct i386_frame *)
 387                                             (SP_REGS(&ddb_regs) - 4);
 388                                 } else if (offset == 0) {
 389                                         /* Probably a symbol in assembler code. */
 390                                         actframe = (struct i386_frame *)
 391                                             (SP_REGS(&ddb_regs) - 4);
 392                                 }
 393                         } else if (name != NULL &&
 394                                    strcmp(name, "fork_trampoline") == 0) {
 395                                 /*
 396                                  * Don't try to walk back on a stack for a
 397                                  * process that hasn't actually been run yet.
 398                                  */
 399                                 db_print_stack_entry(name, 0, 0, 0, callpc);
 400                                 break;
 401                         }
 402                         first = FALSE;
 403                 }
 404
 405                 argp = &actframe->f_arg0;
 406                 narg = MAXNARG;
 407                 if (sym != NULL && db_sym_numargs(sym, &narg, argnames)) {
 408                         argnp = argnames;
 409                 } else {
 410                         narg = db_numargs(frame);
 411                 }
 412
 413                 db_print_stack_entry(name, narg, argnp, argp, callpc);
 414
 415                 if (actframe != frame) {
 416                         /* `frame' belongs to caller. */
 417                         callpc = (db_addr_t)
 418                             db_get_value((int)&actframe->f_retaddr, 4, FALSE);
 419                         continue;
 420                 }
 421
 422                 db_nextframe(&frame, &callpc);
 423
 424                 if (INKERNEL((int) callpc) && !INKERNEL((int) frame)) {
 425                         sym = db_search_symbol(callpc, DB_STGY_ANY, &offset);
 426                         db_symbol_values(sym, &name, NULL);
 427                         db_print_stack_entry(name, 0, 0, 0, callpc);
 428                         break;
 429                 }
 430                 if (!INKERNEL((int) frame)) {
 431                         break;
 432                 }
 433         }
 434 }
 435
 436 void
 437 print_backtrace(int count)
 438 {
 439         register_t  ebp;
 440
 441         __asm __volatile("movl %%ebp, %0" : "=r" (ebp));
 442         db_stack_trace_cmd(ebp, 1, count, NULL);
 443 }
 444
 445 #define DB_DRX_FUNC(reg)                                                \
 446 int                                                                     \
 447 db_ ## reg (struct db_variable *vp, db_expr_t *valuep, int op)          \
 448 {                                                                       \
 449         if (op == DB_VAR_GET)                                           \
 450                 *valuep = r ## reg ();                                  \
 451         else                                                            \
 452                 load_ ## reg (*valuep);                                 \
 453                                                                         \
 454         return(0);                                                      \
 455 }
 456
 457 DB_DRX_FUNC(dr0)
 458 DB_DRX_FUNC(dr1)
 459 DB_DRX_FUNC(dr2)
 460 DB_DRX_FUNC(dr3)
 461 DB_DRX_FUNC(dr4)
 462 DB_DRX_FUNC(dr5)
 463 DB_DRX_FUNC(dr6)
 464 DB_DRX_FUNC(dr7)
 465
 466 static int
 467 ki386_set_watch(int watchnum, unsigned int watchaddr, int size, int access,
 468                struct dbreg *d)
 469 {
 470         int i;
 471         unsigned int mask;
 472
 473         if (watchnum == -1) {
 474                 for (i = 0, mask = 0x3; i < 4; i++, mask <<= 2)
 475                         if ((d->dr7 & mask) == 0)
 476                                 break;
 477                 if (i < 4)
 478                         watchnum = i;
 479                 else
 480                         return(-1);
 481         }
 482
 483         switch (access) {
 484         case DBREG_DR7_EXEC:
 485                 size = 1; /* size must be 1 for an execution breakpoint */
 486                 /* fall through */
 487         case DBREG_DR7_WRONLY:
 488         case DBREG_DR7_RDWR:
 489                 break;
 490         default:
 491                 return(-1);
 492         }
 493
 494         /*
 495          * we can watch a 1, 2, or 4 byte sized location
 496          */
 497         switch (size) {
 498         case 1:
 499                 mask = 0x00;
 500                 break;
 501         case 2:
 502                 mask = 0x01 << 2;
 503                 break;
 504         case 4:
 505                 mask = 0x03 << 2;
 506                 break;
 507         default:
 508                 return(-1);
 509         }
 510
 511         mask |= access;
 512
 513         /* clear the bits we are about to affect */
 514         d->dr7 &= ~((0x3 << (watchnum * 2)) | (0x0f << (watchnum * 4 + 16)));
 515
 516         /* set drN register to the address, N=watchnum */
 517         DBREG_DRX(d, watchnum) = watchaddr;
 518
 519         /* enable the watchpoint */
 520         d->dr7 |= (0x2 << (watchnum * 2)) | (mask << (watchnum * 4 + 16));
 521
 522         return(watchnum);
 523 }
 524
 525
 526 int
 527 ki386_clr_watch(int watchnum, struct dbreg *d)
 528 {
 529         if (watchnum < 0 || watchnum >= 4)
 530                 return(-1);
 531
 532         d->dr7 &= ~((0x3 << (watchnum * 2)) | (0x0f << (watchnum * 4 + 16)));
 533         DBREG_DRX(d, watchnum) = 0;
 534
 535         return(0);
 536 }
 537
 538
 539 int
 540 db_md_set_watchpoint(db_expr_t addr, db_expr_t size)
 541 {
 542         int avail, wsize;
 543         int i;
 544         struct dbreg d;
 545
 546         fill_dbregs(NULL, &d);
 547
 548         avail = 0;
 549         for(i=0; i < 4; i++) {
 550                 if ((d.dr7 & (3 << (i * 2))) == 0)
 551                         avail++;
 552         }
 553
 554         if (avail * 4 < size)
 555                 return(-1);
 556
 557         for (i=0; i < 4 && (size != 0); i++) {
 558                 if ((d.dr7 & (3 << (i * 2))) == 0) {
 559                         if (size > 4)
 560                                 wsize = 4;
 561                         else
 562                                 wsize = size;
 563                         if (wsize == 3)
 564                                 wsize++;
 565                         ki386_set_watch(i, addr, wsize, DBREG_DR7_WRONLY, &d);
 566                         addr += wsize;
 567                         size -= wsize;
 568                 }
 569         }
 570
 571         set_dbregs(NULL, &d);
 572
 573         return(0);
 574 }
 575
 576 int
 577 db_md_clr_watchpoint(db_expr_t addr, db_expr_t size)
 578 {
 579         int i;
 580         struct dbreg d;
 581
 582         fill_dbregs(NULL, &d);
 583
 584         for(i=0; i<4; i++) {
 585                 if (d.dr7 & (3 << (i * 2))) {
 586                         if ((DBREG_DRX((&d), i) >= addr) &&
 587                             (DBREG_DRX((&d), i) < addr + size))
 588                                 ki386_clr_watch(i, &d);
 589                 }
 590         }
 591
 592         set_dbregs(NULL, &d);
 593
 594         return(0);
 595 }
 596
 597 static char *
 598 watchtype_str(int type)
 599 {
 600         switch (type) {
 601         case DBREG_DR7_EXEC:
 602                 return "execute";
 603         case DBREG_DR7_RDWR:
 604                 return "read/write";
 605         case DBREG_DR7_WRONLY:
 606                 return "write";
 607         default:
 608                 return "invalid";
 609         }
 610 }
 611
 612 void
 613 db_md_list_watchpoints(void)
 614 {
 615         int i;
 616         struct dbreg d;
 617
 618         fill_dbregs(NULL, &d);
 619
 620         db_printf("\nhardware watchpoints:\n");
 621         db_printf("  watch    status        type  len     address\n"
 622                   "  -----  --------  ----------  ---  ----------\n");
 623         for (i=0; i < 4; i++) {
 624                 if (d.dr7 & (0x03 << (i * 2))) {
 625                         unsigned type, len;
 626                         type = (d.dr7 >> (16 + (i * 4))) & 3;
 627                         len =  (d.dr7 >> (16 + (i * 4) + 2)) & 3;
 628                         db_printf("  %-5d  %-8s  %10s  %3d  0x%08x\n",
 629                                   i, "enabled", watchtype_str(type),
 630                                   len + 1, DBREG_DRX((&d), i));
 631                 } else {
 632                         db_printf("  %-5d  disabled\n", i);
 633                 }
 634         }
 635
 636         db_printf("\ndebug register values:\n");
 637         for (i=0; i < 8; i++)
 638                 db_printf("  dr%d 0x%08x\n", i, DBREG_DRX((&d),i));
 639         db_printf("\n");
 640 }