Preliminary work towards threads on win32
[sbcl.git] / src / runtime / x86-arch.c
1 /*
2  * This software is part of the SBCL system. See the README file for
3  * more information.
4  *
5  * This software is derived from the CMU CL system, which was
6  * written at Carnegie Mellon University and released into the
7  * public domain. The software is in the public domain and is
8  * provided with absolutely no warranty. See the COPYING and CREDITS
9  * files for more information.
10  */
11
12 #include <stdio.h>
13
14 #include "sbcl.h"
15 #include "runtime.h"
16 #include "globals.h"
17 #include "validate.h"
18 #include "os.h"
19 #include "arch.h"
20 #include "lispregs.h"
21 #include "alloc.h"
22 #include "interrupt.h"
23 #include "interr.h"
24 #include "breakpoint.h"
25 #include "thread.h"
26 #include "pseudo-atomic.h"
27
28 #include "genesis/static-symbols.h"
29 #include "genesis/symbol.h"
30
31 #define BREAKPOINT_INST 0xcc    /* INT3 */
32 #define UD2_INST 0x0b0f         /* UD2 */
33
34 #ifndef LISP_FEATURE_UD2_BREAKPOINTS
35 #define BREAKPOINT_WIDTH 1
36 #else
37 #define BREAKPOINT_WIDTH 2
38 #endif
39
40 unsigned long fast_random_state = 1;
41
42 void arch_init(void)
43 {}
44
45 #ifndef LISP_FEATURE_WIN32
46 os_vm_address_t
47 arch_get_bad_addr(int sig, siginfo_t *code, os_context_t *context)
48 {
49     return (os_vm_address_t)code->si_addr;
50 }
51 #endif
52
53 \f
54 /*
55  * hacking signal contexts
56  *
57  * (This depends both on architecture, which determines what we might
58  * want to get to, and on OS, which determines how we get to it.)
59  */
60
61 int *
62 context_eflags_addr(os_context_t *context)
63 {
64 #if defined __linux__ || defined __sun
65     /* KLUDGE: As of kernel 2.2.14 on Red Hat 6.2, there's code in the
66      * <sys/ucontext.h> file to define symbolic names for offsets into
67      * gregs[], but it's conditional on __USE_GNU and not defined, so
68      * we need to do this nasty absolute index magic number thing
69      * instead. */
70     return &context->uc_mcontext.gregs[16];
71 #elif defined __FreeBSD__
72     return &context->uc_mcontext.mc_eflags;
73 #elif defined __OpenBSD__
74     return &context->sc_eflags;
75 #elif defined LISP_FEATURE_DARWIN
76     return (int *)(&context->uc_mcontext->SS.EFLAGS);
77 #elif defined __NetBSD__
78     return &(context->uc_mcontext.__gregs[_REG_EFL]);
79 #elif defined LISP_FEATURE_WIN32
80     return (int *)&context->win32_context->EFlags;
81 #else
82 #error unsupported OS
83 #endif
84 }
85 \f
86 void arch_skip_instruction(os_context_t *context)
87 {
88     /* Assuming we get here via an INT3 xxx instruction, the PC now
89      * points to the interrupt code (a Lisp value) so we just move
90      * past it. Skip the code; after that, if the code is an
91      * error-trap or cerror-trap then skip the data bytes that follow. */
92
93     int vlen;
94     int code;
95
96
97     /* Get and skip the Lisp interrupt code. */
98     code = *(char*)(*os_context_pc_addr(context))++;
99     switch (code)
100         {
101         case trap_Error:
102         case trap_Cerror:
103             /* Lisp error arg vector length */
104             vlen = *(char*)(*os_context_pc_addr(context))++;
105             /* Skip Lisp error arg data bytes. */
106             while (vlen-- > 0) {
107                 ++*os_context_pc_addr(context);
108             }
109             break;
110
111         case trap_Breakpoint:           /* not tested */
112         case trap_FunEndBreakpoint: /* not tested */
113             break;
114
115 #ifdef LISP_FEATURE_SB_SAFEPOINT
116         case trap_GlobalSafepoint:
117         case trap_CspSafepoint:
118 #endif
119         case trap_PendingInterrupt:
120         case trap_Halt:
121         case trap_SingleStepAround:
122         case trap_SingleStepBefore:
123             /* only needed to skip the Code */
124             break;
125
126         default:
127             fprintf(stderr,"[arch_skip_inst invalid code %d\n]\n",code);
128             break;
129         }
130
131     FSHOW((stderr,
132            "/[arch_skip_inst resuming at %x]\n",
133            *os_context_pc_addr(context)));
134 }
135
136 unsigned char *
137 arch_internal_error_arguments(os_context_t *context)
138 {
139     return 1 + (unsigned char *)(*os_context_pc_addr(context));
140 }
141
142 boolean
143 arch_pseudo_atomic_atomic(os_context_t *context)
144 {
145     return get_pseudo_atomic_atomic(arch_os_get_current_thread());
146 }
147
148 void
149 arch_set_pseudo_atomic_interrupted(os_context_t *context)
150 {
151     struct thread *thread = arch_os_get_current_thread();
152     set_pseudo_atomic_interrupted(thread);
153 }
154
155 void
156 arch_clear_pseudo_atomic_interrupted(os_context_t *context)
157 {
158     struct thread *thread = arch_os_get_current_thread();
159     clear_pseudo_atomic_interrupted(thread);
160 }
161 \f
162 /*
163  * This stuff seems to get called for TRACE and debug activity.
164  */
165
166 unsigned int
167 arch_install_breakpoint(void *pc)
168 {
169     unsigned int result = *(unsigned int*)pc;
170
171 #ifndef LISP_FEATURE_UD2_BREAKPOINTS
172     *(char*)pc = BREAKPOINT_INST;               /* x86 INT3       */
173     *((char*)pc+1) = trap_Breakpoint;           /* Lisp trap code */
174 #else
175     *(char*)pc = UD2_INST & 0xff;
176     *((char*)pc+1) = UD2_INST >> 8;
177     *((char*)pc+2) = trap_Breakpoint;
178 #endif
179
180     return result;
181 }
182
183 void
184 arch_remove_breakpoint(void *pc, unsigned int orig_inst)
185 {
186     *((char *)pc) = orig_inst & 0xff;
187     *((char *)pc + 1) = (orig_inst & 0xff00) >> 8;
188 #if BREAKPOINT_WIDTH > 1
189     *((char *)pc + 2) = (orig_inst & 0xff0000) >> 16;
190 #endif
191 }
192 \f
193 /* When single stepping, single_stepping holds the original instruction
194  * PC location. */
195 unsigned int *single_stepping = NULL;
196 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
197 unsigned int  single_step_save1;
198 unsigned int  single_step_save2;
199 unsigned int  single_step_save3;
200 #endif
201
202 void
203 arch_do_displaced_inst(os_context_t *context, unsigned int orig_inst)
204 {
205     unsigned int *pc = (unsigned int*)(*os_context_pc_addr(context));
206
207     /* Put the original instruction back. */
208     arch_remove_breakpoint(pc, orig_inst);
209
210 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
211     /* Install helper instructions for the single step:
212      * pushf; or [esp],0x100; popf. */
213     single_step_save1 = *(pc-3);
214     single_step_save2 = *(pc-2);
215     single_step_save3 = *(pc-1);
216     *(pc-3) = 0x9c909090;
217     *(pc-2) = 0x00240c81;
218     *(pc-1) = 0x9d000001;
219 #else
220     *context_eflags_addr(context) |= 0x100;
221 #endif
222
223     single_stepping = pc;
224
225 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
226     *os_context_pc_addr(context) = (os_context_register_t)((char *)pc - 9);
227 #endif
228 }
229 \f
230 void
231 restore_breakpoint_from_single_step(os_context_t * context)
232 {
233     /* fprintf(stderr,"* single step trap %x\n", single_stepping); */
234 #ifdef CANNOT_GET_TO_SINGLE_STEP_FLAG
235     /* Un-install single step helper instructions. */
236     *(single_stepping-3) = single_step_save1;
237     *(single_stepping-2) = single_step_save2;
238     *(single_stepping-1) = single_step_save3;
239 #else
240     *context_eflags_addr(context) &= ~0x100;
241 #endif
242     /* Re-install the breakpoint if possible. */
243     if (((char *)*os_context_pc_addr(context) >
244          (char *)single_stepping) &&
245         ((char *)*os_context_pc_addr(context) <=
246          (char *)single_stepping + BREAKPOINT_WIDTH)) {
247         fprintf(stderr, "warning: couldn't reinstall breakpoint\n");
248     } else {
249         arch_install_breakpoint(single_stepping);
250     }
251
252     single_stepping = NULL;
253     return;
254 }
255
256 void
257 arch_handle_breakpoint(os_context_t *context)
258 {
259     *os_context_pc_addr(context) -= BREAKPOINT_WIDTH;
260     handle_breakpoint(context);
261 }
262
263 void
264 arch_handle_fun_end_breakpoint(os_context_t *context)
265 {
266     *os_context_pc_addr(context) -= BREAKPOINT_WIDTH;
267     *os_context_pc_addr(context) =
268         (int)handle_fun_end_breakpoint(context);
269 }
270
271 void
272 arch_handle_single_step_trap(os_context_t *context, int trap)
273 {
274     arch_skip_instruction(context);
275     /* On x86 the fdefn / function is always in EAX, so we pass 0
276      * as the register_offset. */
277     handle_single_step_trap(context, trap, 0);
278 }
279
280 #ifndef LISP_FEATURE_WIN32
281 void
282 sigtrap_handler(int signal, siginfo_t *info, os_context_t *context)
283 {
284     unsigned int trap;
285
286     if (single_stepping) {
287         restore_breakpoint_from_single_step(context);
288         return;
289     }
290
291     /* This is just for info in case the monitor wants to print an
292      * approximation. */
293     access_control_stack_pointer(arch_os_get_current_thread()) =
294         (lispobj *)*os_context_sp_addr(context);
295
296 #ifdef LISP_FEATURE_SUNOS
297     /* For some reason the breakpoints that :ENCAPSULATE NIL tracing sets up
298      * cause a trace trap (i.e. processor single-stepping trap) on the following
299      * instruction on Solaris 10/x86. -- JES, 2006-04-07
300      */
301     if (info->si_code == TRAP_TRACE) {
302         lose("foo");
303         return;
304     }
305 #endif
306
307     /* On entry %eip points just after the INT3 byte and aims at the
308      * 'kind' value (eg trap_Cerror). For error-trap and Cerror-trap a
309      * number of bytes will follow, the first is the length of the byte
310      * arguments to follow. */
311     trap = *(unsigned char *)(*os_context_pc_addr(context));
312     handle_trap(context, trap);
313 }
314
315 void
316 sigill_handler(int signal, siginfo_t *siginfo, os_context_t *context) {
317     /* Triggering SIGTRAP using int3 is unreliable on OS X/x86, so
318      * we need to use illegal instructions for traps.
319      */
320 #if defined(LISP_FEATURE_UD2_BREAKPOINTS) && !defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
321     if (*((unsigned short *)*os_context_pc_addr(context)) == UD2_INST) {
322         *os_context_pc_addr(context) += 2;
323         return sigtrap_handler(signal, siginfo, context);
324     }
325 #endif
326     fake_foreign_function_call(context);
327     lose("Unhandled SIGILL");
328 }
329 #endif /* not LISP_FEATURE_WIN32 */
330
331 void
332 arch_install_interrupt_handlers()
333 {
334     SHOW("entering arch_install_interrupt_handlers()");
335
336     /* Note: The old CMU CL code here used sigtrap_handler() to handle
337      * SIGILL as well as SIGTRAP. I couldn't see any reason to do
338      * things that way. So, I changed to separate handlers when
339      * debugging a problem on OpenBSD, where SBCL wasn't catching
340      * SIGILL properly, but was instead letting the process be
341      * terminated with an "Illegal instruction" output. If this change
342      * turns out to break something (maybe breakpoint handling on some
343      * OS I haven't tested on?) and we have to go back to the old CMU
344      * CL way, I hope there will at least be a comment to explain
345      * why.. -- WHN 2001-06-07 */
346 #if !defined(LISP_FEATURE_WIN32) && !defined(LISP_FEATURE_MACH_EXCEPTION_HANDLER)
347     undoably_install_low_level_interrupt_handler(SIGILL , sigill_handler);
348     undoably_install_low_level_interrupt_handler(SIGTRAP, sigtrap_handler);
349 #endif
350     SHOW("returning from arch_install_interrupt_handlers()");
351 }
352 \f
353 #ifdef LISP_FEATURE_LINKAGE_TABLE
354 /* FIXME: It might be cleaner to generate these from the lisp side of
355  * things.
356  */
357
358 void
359 arch_write_linkage_table_jmp(char * reloc, void * fun)
360 {
361     /* Make JMP to function entry. JMP offset is calculated from next
362      * instruction.
363      */
364     long offset = (char *)fun - (reloc + 5);
365     int i;
366
367     *reloc++ = 0xe9;            /* opcode for JMP rel32 */
368     for (i = 0; i < 4; i++) {
369         *reloc++ = offset & 0xff;
370         offset >>= 8;
371     }
372
373     /* write a nop for good measure. */
374     *reloc = 0x90;
375 }
376
377 void
378 arch_write_linkage_table_ref(void * reloc, void * data)
379 {
380     *(unsigned long *)reloc = (unsigned long)data;
381 }
382
383 #endif