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