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
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD$");
29
30#include <sys/param.h>
31#include <sys/proc.h>
32#include <machine/pcb.h>
33#include <machine/frame.h>
34#include <machine/segments.h>
35#include <machine/tss.h>
36#include <err.h>
37#include <kvm.h>
38#include <string.h>
39
40#include <defs.h>
41#include <target.h>
42#include <gdbthread.h>
43#include <inferior.h>
44#include <regcache.h>
45#include <frame-unwind.h>
46#include <i386-tdep.h>
47
48#include "kgdb.h"
49
50static int ofs_fix;
51
52void
53kgdb_trgt_fetch_registers(int regno __unused)
54{
55	struct kthr *kt;
56	struct pcb pcb;
57
58	kt = kgdb_thr_lookup_tid(ptid_get_pid(inferior_ptid));
59	if (kt == NULL)
60		return;
61	if (kvm_read(kvm, kt->pcb, &pcb, sizeof(pcb)) != sizeof(pcb)) {
62		warnx("kvm_read: %s", kvm_geterr(kvm));
63		memset(&pcb, 0, sizeof(pcb));
64	}
65	supply_register(I386_EBX_REGNUM, (char *)&pcb.pcb_ebx);
66	supply_register(I386_ESP_REGNUM, (char *)&pcb.pcb_esp);
67	supply_register(I386_EBP_REGNUM, (char *)&pcb.pcb_ebp);
68	supply_register(I386_ESI_REGNUM, (char *)&pcb.pcb_esi);
69	supply_register(I386_EDI_REGNUM, (char *)&pcb.pcb_edi);
70	supply_register(I386_EIP_REGNUM, (char *)&pcb.pcb_eip);
71}
72
73void
74kgdb_trgt_store_registers(int regno __unused)
75{
76	fprintf_unfiltered(gdb_stderr, "XXX: %s\n", __func__);
77}
78
79void
80kgdb_trgt_new_objfile(struct objfile *objfile)
81{
82
83	/*
84	 * In revision 1.117 of i386/i386/exception.S trap handlers
85	 * were changed to pass trapframes by reference rather than
86	 * by value.  Detect this by seeing if the first instruction
87	 * at the 'calltrap' label is a "push %esp" which has the
88	 * opcode 0x54.
89	 */
90	if (kgdb_parse("((char *)calltrap)[0]") == 0x54)
91		ofs_fix = 4;
92	else
93		ofs_fix = 0;
94}
95
96struct kgdb_tss_cache {
97	CORE_ADDR	pc;
98	CORE_ADDR	sp;
99	CORE_ADDR	tss;
100};
101
102static int kgdb_trgt_tss_offset[15] = {
103	offsetof(struct i386tss, tss_eax),
104	offsetof(struct i386tss, tss_ecx),
105	offsetof(struct i386tss, tss_edx),
106	offsetof(struct i386tss, tss_ebx),
107	offsetof(struct i386tss, tss_esp),
108	offsetof(struct i386tss, tss_ebp),
109	offsetof(struct i386tss, tss_esi),
110	offsetof(struct i386tss, tss_edi),
111	offsetof(struct i386tss, tss_eip),
112	offsetof(struct i386tss, tss_eflags),
113	offsetof(struct i386tss, tss_cs),
114	offsetof(struct i386tss, tss_ss),
115	offsetof(struct i386tss, tss_ds),
116	offsetof(struct i386tss, tss_es),
117	offsetof(struct i386tss, tss_fs)
118};
119
120/*
121 * If the current thread is executing on a CPU, fetch the common_tss
122 * for that CPU.
123 *
124 * This is painful because 'struct pcpu' is variant sized, so we can't
125 * use it.  Instead, we lookup the GDT selector for this CPU and
126 * extract the base of the TSS from there.
127 */
128static CORE_ADDR
129kgdb_trgt_fetch_tss(void)
130{
131	struct kthr *kt;
132	struct segment_descriptor sd;
133	uintptr_t addr, cpu0prvpage, tss;
134
135	kt = kgdb_thr_lookup_tid(ptid_get_pid(inferior_ptid));
136	if (kt == NULL || kt->cpu == NOCPU)
137		return (0);
138
139	addr = kgdb_lookup("gdt");
140	if (addr == 0)
141		return (0);
142	addr += (kt->cpu * NGDT + GPROC0_SEL) * sizeof(sd);
143	if (kvm_read(kvm, addr, &sd, sizeof(sd)) != sizeof(sd)) {
144		warnx("kvm_read: %s", kvm_geterr(kvm));
145		return (0);
146	}
147	if (sd.sd_type != SDT_SYS386BSY) {
148		warnx("descriptor is not a busy TSS");
149		return (0);
150	}
151	tss = sd.sd_hibase << 24 | sd.sd_lobase;
152
153	/*
154	 * In SMP kernels, the TSS is stored as part of the per-CPU
155	 * data.  On older kernels, the CPU0's private page
156	 * is stored at an address that isn't mapped in minidumps.
157	 * However, the data is mapped at the alternate cpu0prvpage
158	 * address.  Thus, if the TSS is at the invalid address,
159	 * change it to be relative to cpu0prvpage instead.
160	 */
161	if (trunc_page(tss) == 0xffc00000) {
162		addr = kgdb_lookup("cpu0prvpage");
163		if (addr == 0)
164			return (0);
165		if (kvm_read(kvm, addr, &cpu0prvpage, sizeof(cpu0prvpage)) !=
166		    sizeof(cpu0prvpage)) {
167			warnx("kvm_read: %s", kvm_geterr(kvm));
168			return (0);
169		}
170		tss = cpu0prvpage + (tss & PAGE_MASK);
171	}
172	return ((CORE_ADDR)tss);
173}
174
175static struct kgdb_tss_cache *
176kgdb_trgt_tss_cache(struct frame_info *next_frame, void **this_cache)
177{
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 = frame_func_unwind(next_frame);
186		frame_unwind_register(next_frame, SP_REGNUM, buf);
187		cache->sp = extract_unsigned_integer(buf,
188		    register_size(current_gdbarch, SP_REGNUM));
189		cache->tss = kgdb_trgt_fetch_tss();
190	}
191	return (cache);
192}
193
194static void
195kgdb_trgt_dblfault_this_id(struct frame_info *next_frame, void **this_cache,
196    struct frame_id *this_id)
197{
198	struct kgdb_tss_cache *cache;
199
200	cache = kgdb_trgt_tss_cache(next_frame, this_cache);
201	*this_id = frame_id_build(cache->sp, cache->pc);
202}
203
204static void
205kgdb_trgt_dblfault_prev_register(struct frame_info *next_frame,
206    void **this_cache, int regnum, int *optimizedp, enum lval_type *lvalp,
207    CORE_ADDR *addrp, int *realnump, void *valuep)
208{
209	char dummy_valuep[MAX_REGISTER_SIZE];
210	struct kgdb_tss_cache *cache;
211	int ofs, regsz;
212
213	regsz = register_size(current_gdbarch, regnum);
214
215	if (valuep == NULL)
216		valuep = dummy_valuep;
217	memset(valuep, 0, regsz);
218	*optimizedp = 0;
219	*addrp = 0;
220	*lvalp = not_lval;
221	*realnump = -1;
222
223	ofs = (regnum >= I386_EAX_REGNUM && regnum <= I386_FS_REGNUM)
224	    ? kgdb_trgt_tss_offset[regnum] : -1;
225	if (ofs == -1)
226		return;
227
228	cache = kgdb_trgt_tss_cache(next_frame, this_cache);
229	if (cache->tss == 0)
230		return;
231	*addrp = cache->tss + ofs;
232	*lvalp = lval_memory;
233	target_read_memory(*addrp, valuep, regsz);
234}
235
236static const struct frame_unwind kgdb_trgt_dblfault_unwind = {
237        UNKNOWN_FRAME,
238        &kgdb_trgt_dblfault_this_id,
239        &kgdb_trgt_dblfault_prev_register
240};
241
242struct kgdb_frame_cache {
243	int		frame_type;
244	CORE_ADDR	pc;
245	CORE_ADDR	sp;
246};
247#define	FT_NORMAL		1
248#define	FT_INTRFRAME		2
249#define	FT_INTRTRAPFRAME	3
250#define	FT_TIMERFRAME		4
251
252static int kgdb_trgt_frame_offset[15] = {
253	offsetof(struct trapframe, tf_eax),
254	offsetof(struct trapframe, tf_ecx),
255	offsetof(struct trapframe, tf_edx),
256	offsetof(struct trapframe, tf_ebx),
257	offsetof(struct trapframe, tf_esp),
258	offsetof(struct trapframe, tf_ebp),
259	offsetof(struct trapframe, tf_esi),
260	offsetof(struct trapframe, tf_edi),
261	offsetof(struct trapframe, tf_eip),
262	offsetof(struct trapframe, tf_eflags),
263	offsetof(struct trapframe, tf_cs),
264	offsetof(struct trapframe, tf_ss),
265	offsetof(struct trapframe, tf_ds),
266	offsetof(struct trapframe, tf_es),
267	offsetof(struct trapframe, tf_fs)
268};
269
270static struct kgdb_frame_cache *
271kgdb_trgt_frame_cache(struct frame_info *next_frame, void **this_cache)
272{
273	char buf[MAX_REGISTER_SIZE];
274	struct kgdb_frame_cache *cache;
275	char *pname;
276
277	cache = *this_cache;
278	if (cache == NULL) {
279		cache = FRAME_OBSTACK_ZALLOC(struct kgdb_frame_cache);
280		*this_cache = cache;
281		cache->pc = frame_func_unwind(next_frame);
282		find_pc_partial_function(cache->pc, &pname, NULL, NULL);
283		if (pname[0] != 'X')
284			cache->frame_type = FT_NORMAL;
285		else if (strcmp(pname, "Xtimerint") == 0)
286			cache->frame_type = FT_TIMERFRAME;
287		else if (strcmp(pname, "Xcpustop") == 0 ||
288		    strcmp(pname, "Xrendezvous") == 0 ||
289		    strcmp(pname, "Xipi_intr_bitmap_handler") == 0 ||
290		    strcmp(pname, "Xlazypmap") == 0)
291			cache->frame_type = FT_INTRTRAPFRAME;
292		else
293			cache->frame_type = FT_INTRFRAME;
294		frame_unwind_register(next_frame, SP_REGNUM, buf);
295		cache->sp = extract_unsigned_integer(buf,
296		    register_size(current_gdbarch, SP_REGNUM));
297	}
298	return (cache);
299}
300
301static void
302kgdb_trgt_trapframe_this_id(struct frame_info *next_frame, void **this_cache,
303    struct frame_id *this_id)
304{
305	struct kgdb_frame_cache *cache;
306
307	cache = kgdb_trgt_frame_cache(next_frame, this_cache);
308	*this_id = frame_id_build(cache->sp, cache->pc);
309}
310
311static void
312kgdb_trgt_trapframe_prev_register(struct frame_info *next_frame,
313    void **this_cache, int regnum, int *optimizedp, enum lval_type *lvalp,
314    CORE_ADDR *addrp, int *realnump, void *valuep)
315{
316	char dummy_valuep[MAX_REGISTER_SIZE];
317	struct kgdb_frame_cache *cache;
318	int ofs, regsz;
319
320	regsz = register_size(current_gdbarch, regnum);
321
322	if (valuep == NULL)
323		valuep = dummy_valuep;
324	memset(valuep, 0, regsz);
325	*optimizedp = 0;
326	*addrp = 0;
327	*lvalp = not_lval;
328	*realnump = -1;
329
330	ofs = (regnum >= I386_EAX_REGNUM && regnum <= I386_FS_REGNUM)
331	    ? kgdb_trgt_frame_offset[regnum] + ofs_fix : -1;
332	if (ofs == -1)
333		return;
334
335	cache = kgdb_trgt_frame_cache(next_frame, this_cache);
336	switch (cache->frame_type) {
337	case FT_NORMAL:
338		break;
339	case FT_INTRFRAME:
340		ofs += 4;
341		break;
342	case FT_TIMERFRAME:
343		break;
344	case FT_INTRTRAPFRAME:
345		ofs -= ofs_fix;
346		break;
347	default:
348		fprintf_unfiltered(gdb_stderr, "Correct FT_XXX frame offsets "
349		   "for %d\n", cache->frame_type);
350		break;
351	}
352	*addrp = cache->sp + ofs;
353	*lvalp = lval_memory;
354	target_read_memory(*addrp, valuep, regsz);
355}
356
357static const struct frame_unwind kgdb_trgt_trapframe_unwind = {
358        UNKNOWN_FRAME,
359        &kgdb_trgt_trapframe_this_id,
360        &kgdb_trgt_trapframe_prev_register
361};
362
363const struct frame_unwind *
364kgdb_trgt_trapframe_sniffer(struct frame_info *next_frame)
365{
366	char *pname;
367	CORE_ADDR pc;
368
369	pc = frame_pc_unwind(next_frame);
370	pname = NULL;
371	find_pc_partial_function(pc, &pname, NULL, NULL);
372	if (pname == NULL)
373		return (NULL);
374	if (strcmp(pname, "dblfault_handler") == 0)
375		return (&kgdb_trgt_dblfault_unwind);
376	if (strcmp(pname, "calltrap") == 0 ||
377	    (pname[0] == 'X' && pname[1] != '_'))
378		return (&kgdb_trgt_trapframe_unwind);
379	/* printf("%s: %llx =%s\n", __func__, pc, pname); */
380	return (NULL);
381}
382