Mention ~/.gdbinit
[ikiwiki.git] / docs / howtos / HowToDebugVKernels / index.mdwn
1 # Introduction
2 The purpose of this document is to introduce the reader with vkernel debugging.
3 The vkernel architecture allows us to run DragonFly kernels in userland. These virtual
4 kernels can be paniced or otherwise abused, without affecting the host operating system.
5
6 To make things a bit more interesting, we will use a real life example.
7
8 # Once upon a time
9 ... I wrote a simple program that used the AIO interface. As it turned out we don't support
10 this feature, but at that point I didn't know.
11
12     [beket@sadness ~]$ gcc t_aio.c -o t_aio -Wall -ansi -pedantic
13     [beket@sadness ~]$ ./t_aio 
14     aio_read: Function not implemented
15     [beket@sadness ~]$ 
16
17 Ktrace'ing the process and seeing with my own eyes what was going on, seemed like a good idea.
18 Here comes the fun. I misread the ktrace(1) man page and typed:
19
20     [beket@sadness ~]$ ktrace -c ./t_aio
21
22 And the system hang.
23 (My intention was to track the system calls of t_aio.)
24
25 # Setup a vkernel
26 To setup a vkernel, please consult this [man page](http://leaf.dragonflybsd.org/cgi/web-man?command=vkernel&section=ANY).
27 It's very straightforward.
28
29 # Reproduce the problem
30 We boot into our vkernel:
31
32     # cd /var/kernel
33     # ./boot/kernel -m 64m -r rootimg.01 -I auto:bridge0
34     [...]
35     login: root
36     #
37 And then try to reproduce the system freeze:
38
39     # ktrace -c ./t_aio
40
41     Fatal trap 12: page fault while in kernel mode
42     mp_lock = 00000001; cpuid = 1
43     fault virtual address   = 0x0
44     fault code              = supervisor read, page not present
45     instruction pointer     = 0x1f:0x80aca52
46     stack pointer           = 0x10:0x5709d914
47     frame pointer           = 0x10:0x5709dbe0
48     processor eflags        = interrupt enabled, resume, IOPL = 0
49     current process         = 692 (ktrace)
50     current thread          = pri 6 
51      <- SMP: XXX
52     kernel: type 12 trap, code=4
53     
54     CPU1 stopping CPUs: 0x00000001
55      stopped
56     Stopped at      0x80aca52:      movl    0(%eax),%eax
57     db> 
58
59 This db> prompt is from ddb(4), the interactive kernel debugger.
60 The
61
62     fault virtual address   = 0x0
63
64 field is indicative of a NULL pointer dereference inside the kernel.
65
66 Let's get a trace of what went wrong:
67
68     db> trace
69     ktrdestroy(57082700,5709dc5c,0,57082700,5709dca0) at 0x80aca52
70     allproc_scan(80aca14,5709dc5c,be,2,0) at 0x80b2e91
71     sys_ktrace(5709dca0,6,0,0,57082700) at 0x80acffe
72     syscall2(5709dd40,6,57082700,0,0) at 0x8214b6d
73     user_trap(5709dd40,570940e8,8214185,0,8215462) at 0x8214d9c
74     go_user(5709dd38,0,0,7b,0) at 0x82151ac
75     db> 
76
77 # Gdb
78 Quoting from vkernel(7):
79
80 It is possible to directly gdb the virtual kernel's process.  It is recommended that you do a `handle SIGSEGV noprint' to ignore page faults processed by the virtual kernel itself and `handle SIGUSR1 noprint' to ignore signals used for simulating inter-processor interrupts (SMP build only).
81
82 You can add these two commands in my ~/.gdbinit to save yourself from typing them again and again.
83     [beket@sadness ~]$ cat ~/.gdbinit
84     handle SIGSEGV noprint
85     handle SIGUSR1 noprint
86
87 So we are going to attach to the vkernel process:
88
89     # ps aux | grep kernel
90     root  25408  0.0  2.3 1053376 17772  p0  IL+   8:32PM   0:06.51 ./boot/kernel -m 64m -r rootimg.01 -I auto:bridge0
91     # gdb kernel 25408
92     GNU gdb 6.7.1
93     [...]
94
95 Let's get a trace from inside gdb:
96
97     (gdb) bt
98     #0  0x282d4c10 in sigsuspend () from /usr/lib/libc.so.6
99     #1  0x28287eb2 in sigsuspend () from /usr/lib/libthread_xu.so.2
100     #2  0x0821530a in stopsig (nada=24, info=0x40407d2c, ctxp=0x40407a4c) at /usr/src/sys/platform/vkernel/i386/exception.c:112
101     #3  <signal handler called>
102     #4  0x282d4690 in umtx_sleep () from /usr/lib/libc.so.6
103     #5  0x08213bde in cpu_idle () at /usr/src/sys/platform/vkernel/i386/cpu_regs.c:722
104     #6  0x00000000 in ?? ()
105    (gdb) 
106
107 Why does it differ from the ddb's trace ?
108 Well, when the vkernel is sitting at a db> prompt all vkernel threads representing virtual cpu's except the one handling the db> prompt itself will be suspended in stopsig(). The backtrace only sees one of the N threads.
109
110 We need to do better this time. Let's break into the kernel _before_ it crashes. sys_ktrace() seems like a good candidate.
111
112     # gdb kernel 25532
113     GNU gdb 6.7.1
114     [...]
115     (gdb) break sys_ktrace
116     Breakpoint 1 at 0x80acf43: file ./machine/thread.h, line 83.
117     (gdb) 
118
119 Next we type 'c' in the gdb prompt to resume vkernel execution:
120
121     (gdb) c
122     Continuing.
123
124 Now we go to our vkernel and type the offending command:
125
126     # ktrace -c 
127
128 Gdb stops the execution of vkernel and a message pops up in gdb buffer:
129
130     Breakpoint 1, sys_ktrace (uap=0x573e2ca0) at ./machine/thread.h:83
131     83          __asm ("movl %%fs:globaldata,%0" : "=r" (gd) : "m"(__mycpu__dummy));
132     (gdb) 
133
134 We navigate through source code with the 'step' and 'next' gdb commands. They are identical, except that 'step' follows function calls. When we meet this call:
135
136     276                     allproc_scan(ktrace_clear_callback, &info);
137
138 we 'step' inside it. alloproc_scan() iterates through the process list and applies the ktrace_clear_callback() to each one of them.
139 Later we see this:
140
141     347                     if (p->p_tracenode->kn_vp == info->tracenode->kn_vp) {
142
143 Here p is a pointer to the current process:
144
145     (gdb) print p
146     $1 = (struct proc *) 0x57098c00
147
148 Let's see if this process is traced:
149
150     (gdb) print p->p_tracenode
151     $2 = (struct ktrace_node *) 0x0
152     (gdb) 
153
154 Oops. There is no trace to a vnode for this process. The code will try to access p->p_tracenode and crash. This is the zero virtual address we saw before.