8932266f93d7317bc7e4ad1c9f863ce8e23cb5dd
[dragonfly.git] / gnu / usr.bin / gdb / kgdb / trgt_i386.c
1 /*
2  * Copyright (c) 2004 Marcel Moolenaar
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD: src/gnu/usr.bin/gdb/kgdb/trgt_i386.c,v 1.13 2008/09/27 15:58:37 kib Exp $
27  */
28
29 #include <sys/cdefs.h>
30
31 #include <sys/types.h>
32 #include <machine/thread.h>
33 #include <sys/thread.h>
34 #include <machine/globaldata.h>
35 #include <machine/pcb.h>
36 #include <machine/frame.h>
37 #include <machine/segments.h>
38 #include <machine/tss.h>
39 #include <err.h>
40 #include <kvm.h>
41 #include <string.h>
42
43 #include <defs.h>
44 #include <target.h>
45 #include <gdbthread.h>
46 #include <inferior.h>
47 #include <regcache.h>
48 #include <frame-unwind.h>
49 #include <i386-tdep.h>
50
51 #include "kgdb.h"
52
53 static int
54 kgdb_trgt_trapframe_sniffer(const struct frame_unwind *self,
55                             struct frame_info *next_frame,
56                             void **this_prologue_cache);
57
58 void
59 kgdb_trgt_fetch_registers(struct target_ops *target_ops, struct regcache *regcache, int regno)
60 {
61         struct kthr *kt;
62         struct pcb pcb;
63
64         kt = kgdb_thr_lookup_tid(ptid_get_tid(inferior_ptid));
65         if (kt == NULL) {
66                 regcache_raw_supply(regcache, regno, NULL);
67                 return;
68         }
69
70         /*
71          * kt->pcb == 0 is a marker for "non-dumping kernel thread".
72          */
73         if (kt->pcb == 0) {
74                 uintptr_t regs[5];
75                 uintptr_t addr;
76                 uintptr_t sp;
77
78                 addr = kt->kaddr + offsetof(struct thread, td_sp);
79                 kvm_read(kvm, addr, &sp, sizeof(sp));
80                 /*
81                  * Stack is:
82                  * -2 ret
83                  * -1 popfl
84                  * 0 popl %edi
85                  * 1 popl %esi
86                  * 2 popl %ebx
87                  * 3 popl %ebp
88                  * 4 ret
89                  */
90                 if (kvm_read(kvm, sp + 2 * sizeof(regs[0]), regs, sizeof(regs)) != sizeof(regs)) {
91                         warnx("kvm_read: %s", kvm_geterr(kvm));
92                         memset(regs, 0, sizeof(regs));
93                 }
94                 regcache_raw_supply(regcache, I386_EDI_REGNUM, &regs[0]);
95                 regcache_raw_supply(regcache, I386_ESI_REGNUM, &regs[1]);
96                 regcache_raw_supply(regcache, I386_EBX_REGNUM, &regs[2]);
97                 regcache_raw_supply(regcache, I386_EBP_REGNUM, &regs[3]);
98                 regcache_raw_supply(regcache, I386_EIP_REGNUM, &regs[4]);
99                 sp += 7 * sizeof(regs[0]);
100                 regcache_raw_supply(regcache, I386_ESP_REGNUM, &sp);
101                 return;
102         }
103
104         if (kvm_read(kvm, kt->pcb, &pcb, sizeof(pcb)) != sizeof(pcb)) {
105                 warnx("kvm_read: %s", kvm_geterr(kvm));
106                 memset(&pcb, 0, sizeof(pcb));
107         }
108         regcache_raw_supply(regcache, I386_EBX_REGNUM, (char *)&pcb.pcb_ebx);
109         regcache_raw_supply(regcache, I386_ESP_REGNUM, (char *)&pcb.pcb_esp);
110         regcache_raw_supply(regcache, I386_EBP_REGNUM, (char *)&pcb.pcb_ebp);
111         regcache_raw_supply(regcache, I386_ESI_REGNUM, (char *)&pcb.pcb_esi);
112         regcache_raw_supply(regcache, I386_EDI_REGNUM, (char *)&pcb.pcb_edi);
113         regcache_raw_supply(regcache, I386_EIP_REGNUM, (char *)&pcb.pcb_eip);
114 }
115
116 struct kgdb_tss_cache {
117         CORE_ADDR       pc;
118         CORE_ADDR       sp;
119         CORE_ADDR       tss;
120 };
121
122 static int kgdb_trgt_tss_offset[15] = {
123         offsetof(struct i386tss, tss_eax),
124         offsetof(struct i386tss, tss_ecx),
125         offsetof(struct i386tss, tss_edx),
126         offsetof(struct i386tss, tss_ebx),
127         offsetof(struct i386tss, tss_esp),
128         offsetof(struct i386tss, tss_ebp),
129         offsetof(struct i386tss, tss_esi),
130         offsetof(struct i386tss, tss_edi),
131         offsetof(struct i386tss, tss_eip),
132         offsetof(struct i386tss, tss_eflags),
133         offsetof(struct i386tss, tss_cs),
134         offsetof(struct i386tss, tss_ss),
135         offsetof(struct i386tss, tss_ds),
136         offsetof(struct i386tss, tss_es),
137         offsetof(struct i386tss, tss_fs)
138 };
139
140 /*
141  * If the current thread is executing on a CPU, fetch the common_tss
142  * for that CPU.
143  *
144  * This is painful because 'struct pcpu' is variant sized, so we can't
145  * use it.  Instead, we lookup the GDT selector for this CPU and
146  * extract the base of the TSS from there.
147  */
148 static CORE_ADDR
149 kgdb_trgt_fetch_tss(void)
150 {
151         struct kthr *kt;
152         struct segment_descriptor sd;
153         uintptr_t addr, tss;
154
155         kt = kgdb_thr_lookup_tid(ptid_get_tid(inferior_ptid));
156         if (kt == NULL || kt->gd == 0)
157                 return (0);
158
159         addr = kt->gd + offsetof(struct mdglobaldata, gd_common_tssd);
160         if (kvm_read(kvm, addr, &sd, sizeof(sd)) != sizeof(sd)) {
161                 warnx("kvm_read: %s", kvm_geterr(kvm));
162                 return (0);
163         }
164         if (sd.sd_type != SDT_SYS386BSY) {
165                 warnx("descriptor is not a busy TSS");
166                 return (0);
167         }
168         tss = kt->gd + offsetof(struct mdglobaldata, gd_common_tss);
169
170         return ((CORE_ADDR)tss);
171 }
172
173 static struct kgdb_tss_cache *
174 kgdb_trgt_tss_cache(struct frame_info *next_frame, void **this_cache)
175 {
176         struct gdbarch *gdbarch = get_frame_arch(next_frame);
177         enum bfd_endian byte_order = gdbarch_byte_order(gdbarch);
178         char buf[MAX_REGISTER_SIZE];
179         struct kgdb_tss_cache *cache;
180
181         cache = *this_cache;
182         if (cache == NULL) {
183                 cache = FRAME_OBSTACK_ZALLOC(struct kgdb_tss_cache);
184                 *this_cache = cache;
185                 cache->pc = get_frame_address_in_block(next_frame);
186                 frame_unwind_register(next_frame, I386_ESP_REGNUM, buf);
187                 cache->sp = extract_unsigned_integer(buf,
188                     register_size(gdbarch, I386_ESP_REGNUM),
189                     byte_order);
190                 cache->tss = kgdb_trgt_fetch_tss();
191         }
192         return (cache);
193 }
194
195 static void
196 kgdb_trgt_dblfault_this_id(struct frame_info *next_frame, void **this_cache,
197     struct frame_id *this_id)
198 {
199         struct kgdb_tss_cache *cache;
200
201         cache = kgdb_trgt_tss_cache(next_frame, this_cache);
202         *this_id = frame_id_build(cache->sp, cache->pc);
203 }
204
205 static struct value *
206 kgdb_trgt_dblfault_prev_register(struct frame_info *next_frame,
207     void **this_cache, int regnum)
208 {
209         CORE_ADDR addrp;
210         struct kgdb_tss_cache *cache;
211         int ofs;
212
213         if (regnum < I386_EAX_REGNUM || regnum > I386_FS_REGNUM)
214                 return frame_unwind_got_register(next_frame, regnum, regnum);
215
216         ofs = kgdb_trgt_tss_offset[regnum];
217
218         cache = kgdb_trgt_tss_cache(next_frame, this_cache);
219         if (cache->tss == 0)
220                 return frame_unwind_got_register(next_frame, regnum, regnum);
221
222         addrp = cache->tss + ofs;
223         return frame_unwind_got_memory(next_frame, regnum, addrp);
224 }
225
226 static const struct frame_unwind kgdb_trgt_dblfault_unwind = {
227         NORMAL_FRAME,
228         &kgdb_trgt_dblfault_this_id,
229         &kgdb_trgt_dblfault_prev_register,
230         .sniffer = kgdb_trgt_trapframe_sniffer
231 };
232
233 struct kgdb_frame_cache {
234         int             frame_type;
235         CORE_ADDR       pc;
236         CORE_ADDR       sp;
237 };
238 #define FT_NORMAL               1
239 #define FT_INTRFRAME            2
240 /*#define       FT_INTRTRAPFRAME        3*/
241 #define FT_TIMERFRAME           4
242 #define FT_CALLTRAP             5
243
244 static int kgdb_trgt_frame_offset[15] = {
245         offsetof(struct trapframe, tf_eax),
246         offsetof(struct trapframe, tf_ecx),
247         offsetof(struct trapframe, tf_edx),
248         offsetof(struct trapframe, tf_ebx),
249         offsetof(struct trapframe, tf_esp),
250         offsetof(struct trapframe, tf_ebp),
251         offsetof(struct trapframe, tf_esi),
252         offsetof(struct trapframe, tf_edi),
253         offsetof(struct trapframe, tf_eip),
254         offsetof(struct trapframe, tf_eflags),
255         offsetof(struct trapframe, tf_cs),
256         offsetof(struct trapframe, tf_ss),
257         offsetof(struct trapframe, tf_ds),
258         offsetof(struct trapframe, tf_es),
259         offsetof(struct trapframe, tf_fs)
260 };
261
262 static struct kgdb_frame_cache *
263 kgdb_trgt_frame_cache(struct frame_info *next_frame, void **this_cache)
264 {
265         struct kgdb_frame_cache *cache;
266         char *pname;
267
268         cache = *this_cache;
269         if (cache == NULL) {
270                 cache = FRAME_OBSTACK_ZALLOC(struct kgdb_frame_cache);
271                 *this_cache = cache;
272                 cache->pc = get_frame_address_in_block(next_frame);
273                 cache->sp = get_frame_sp(next_frame);
274                 find_pc_partial_function(cache->pc, &pname, NULL, NULL);
275
276                 if (strcmp(pname, "calltrap") == 0)
277                         cache->frame_type = FT_CALLTRAP;
278                 else if (pname[0] != 'X')
279                         cache->frame_type = FT_NORMAL;
280                 else if (strcmp(pname, "Xtimerint") == 0)
281                         cache->frame_type = FT_TIMERFRAME;
282                 /* else if (strcmp(pname, "Xcpustop") == 0 ||
283                     strcmp(pname, "Xrendezvous") == 0 ||
284                     strcmp(pname, "Xipi_intr_bitmap_handler") == 0 ||
285                     strcmp(pname, "Xlazypmap") == 0)
286                         cache->frame_type = FT_INTRTRAPFRAME;
287                         */
288                 else
289                         cache->frame_type = FT_INTRFRAME;
290         }
291         return (cache);
292 }
293
294 static void
295 kgdb_trgt_trapframe_this_id(struct frame_info *next_frame, void **this_cache,
296     struct frame_id *this_id)
297 {
298         struct kgdb_frame_cache *cache;
299
300         cache = kgdb_trgt_frame_cache(next_frame, this_cache);
301         *this_id = frame_id_build(cache->sp, cache->pc);
302 }
303
304 static struct value *
305 kgdb_trgt_trapframe_prev_register(struct frame_info *next_frame,
306     void **this_cache, int regnum)
307 {
308         CORE_ADDR addrp;
309         struct kgdb_frame_cache *cache;
310         int ofs;
311
312         if (regnum < I386_EAX_REGNUM || regnum > I386_FS_REGNUM)
313                 return frame_unwind_got_register(next_frame, regnum, regnum);
314
315         ofs = kgdb_trgt_frame_offset[regnum] + 4;
316
317         cache = kgdb_trgt_frame_cache(next_frame, this_cache);
318
319         switch (cache->frame_type) {
320         case FT_NORMAL:
321                 break;
322         case FT_INTRFRAME:
323                 ofs += 4;
324                 break;
325         case FT_TIMERFRAME:
326                 break;
327                 /*
328         case FT_INTRTRAPFRAME:
329                 ofs -= ofs_fix;
330                 break;
331                 */
332         case FT_CALLTRAP:
333                 ofs += 0;
334                 break;
335         default:
336                 fprintf_unfiltered(gdb_stderr, "Correct FT_XXX frame offsets "
337                    "for %d\n", cache->frame_type);
338                 break;
339         }
340
341         addrp = cache->sp + ofs;
342
343 #if 0
344         /*
345          * If we are in the kernel, we don't have esp stored in the
346          * trapframe, but we can calculate it simply by subtracting
347          * the size of the frame.
348          */
349         if (regnum == I386_ESP_REGNUM) {
350                 char buf[4];
351
352                 frame_unwind_register(next_frame, I386_CS_REGNUM, buf);
353                 if (extract_unsigned_integer(buf, 4, byte_order) != SEL_UPL)
354                         return frame_unwind_got_address(next_frame, regnum, addrp);
355                 /* else FALLTHROUGH */
356         }
357 #endif
358
359         return frame_unwind_got_memory(next_frame, regnum, addrp);
360 }
361
362 const struct frame_unwind kgdb_trgt_trapframe_unwind = {
363         NORMAL_FRAME,
364         &kgdb_trgt_trapframe_this_id,
365         &kgdb_trgt_trapframe_prev_register,
366         .sniffer = kgdb_trgt_trapframe_sniffer
367 };
368
369 static int
370 kgdb_trgt_trapframe_sniffer(const struct frame_unwind *self,
371                             struct frame_info *next_frame,
372                             void **this_prologue_cache)
373 {
374         char *pname;
375         CORE_ADDR pc;
376
377         pc = get_frame_address_in_block(next_frame);
378         pname = NULL;
379         find_pc_partial_function(pc, &pname, NULL, NULL);
380         if (pname == NULL)
381                 return (0);
382
383         /*
384          * This is a combined sniffer, since only the
385          * function names change.
386          */
387
388         /*
389          * If we're the sniffer for a trapframe, deal with
390          * all these function names.
391          */
392         if (self == &kgdb_trgt_trapframe_unwind &&
393             (strcmp(pname, "calltrap") == 0 ||
394              (pname[0] == 'X' && pname[1] != '_')))
395                 return (1);
396
397         /*
398          * If we're a double fault sniffer, only look for
399          * the double fault name.
400          */
401         if(self == &kgdb_trgt_dblfault_unwind &&
402            strcmp(pname, "dblfault_handler") == 0)
403                 return (1);
404
405         /* printf("%s: %llx =%s\n", __func__, pc, pname); */
406         return (0);
407 }