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