2 * the Win32 incarnation of OS-dependent routines. See also
3 * $(sbcl_arch)-win32-os.c
5 * This file (along with os.h) exports an OS-independent interface to
6 * the operating system VM facilities. Surprise surprise, this
7 * interface looks a lot like the Mach interface (but simpler in some
8 * places). For some operating systems, a subset of these functions
9 * will have to be emulated.
13 * This software is part of the SBCL system. See the README file for
16 * This software is derived from the CMU CL system, which was
17 * written at Carnegie Mellon University and released into the
18 * public domain. The software is in the public domain and is
19 * provided with absolutely no warranty. See the COPYING and CREDITS
20 * files for more information.
24 * This file was copied from the Linux version of the same, and
25 * likely still has some linuxisms in it have haven't been elimiated
30 #include <sys/param.h>
38 #include "interrupt.h"
43 #include "genesis/primitive-objects.h"
45 #include <sys/types.h>
55 size_t os_vm_page_size;
59 #include "gencgc-internal.h"
62 int linux_sparc_siginfo_bug = 0;
63 int linux_supports_futex=0;
66 /* The exception handling function looks like this: */
67 EXCEPTION_DISPOSITION handle_exception(EXCEPTION_RECORD *,
68 struct lisp_exception_frame *,
74 static void *get_seh_frame(void)
77 asm volatile ("movl %%fs:0,%0": "=r" (retval));
81 static void set_seh_frame(void *frame)
83 asm volatile ("movl %0,%%fs:0": : "r" (frame));
86 static struct lisp_exception_frame *find_our_seh_frame(void)
88 struct lisp_exception_frame *frame = get_seh_frame();
90 while (frame->handler != handle_exception)
91 frame = frame->next_frame;
97 inline static void *get_stack_frame(void)
100 asm volatile ("movl %%ebp,%0": "=r" (retval));
105 void os_init(char *argv[], char *envp[])
107 SYSTEM_INFO system_info;
109 GetSystemInfo(&system_info);
110 os_vm_page_size = system_info.dwPageSize;
112 base_seh_frame = get_seh_frame();
117 * So we have three fun scenarios here.
119 * First, we could be being called to reserve the memory areas
120 * during initialization (prior to loading the core file).
122 * Second, we could be being called by the GC to commit a page
123 * that has just been decommitted (for easy zero-fill).
125 * Third, we could be being called by create_thread_struct()
126 * in order to create the sundry and various stacks.
128 * The third case is easy to pick out because it passes an
131 * The second case is easy to pick out because it will be for
132 * a range of memory that is MEM_RESERVE rather than MEM_FREE.
134 * The second case is also an easy implement, because we leave
135 * the memory as reserved (since we do lazy commits).
139 os_validate(os_vm_address_t addr, os_vm_size_t len)
141 MEMORY_BASIC_INFORMATION mem_info;
144 /* the simple case first */
145 os_vm_address_t real_addr;
146 if (!(real_addr = VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE))) {
147 perror("VirtualAlloc");
154 if (!VirtualQuery(addr, &mem_info, sizeof mem_info)) {
155 perror("VirtualQuery");
159 if ((mem_info.State == MEM_RESERVE) && (mem_info.RegionSize >=len)) return addr;
161 if (mem_info.State == MEM_RESERVE) {
162 fprintf(stderr, "validation of reserved space too short.\n");
166 if (!VirtualAlloc(addr, len, (mem_info.State == MEM_RESERVE)? MEM_COMMIT: MEM_RESERVE, PAGE_EXECUTE_READWRITE)) {
167 perror("VirtualAlloc");
175 * For os_invalidate(), we merely decommit the memory rather than
176 * freeing the address space. This loses when freeing per-thread
177 * data and related memory since it leaks address space. It's not
178 * too lossy, however, since the two scenarios I'm aware of are
179 * fd-stream buffers, which are pooled rather than torched, and
180 * thread information, which I hope to pool (since windows creates
181 * threads at its own whim, and we probably want to be able to
182 * have them callback without funky magic on the part of the user,
183 * and full-on thread allocation is fairly heavyweight). Someone
184 * will probably shoot me down on this with some pithy comment on
185 * the use of (setf symbol-value) on a special variable. I'm happy
190 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
192 if (!VirtualFree(addr, len, MEM_DECOMMIT)) {
193 perror("VirtualFree");
198 * os_map() is called to map a chunk of the core file into memory.
200 * Unfortunately, Windows semantics completely screws this up, so
201 * we just add backing store from the swapfile to where the chunk
202 * goes and read it up like a normal file. We could consider using
203 * a lazy read (demand page) setup, but that would mean keeping an
204 * open file pointer for the core indefinately (and be one more
205 * thing to maintain).
209 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
213 fprintf(stderr, "os_map: %d, 0x%x, %p, 0x%x.\n", fd, offset, addr, len);
216 if (!VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
217 perror("VirtualAlloc");
218 lose("os_map: VirtualAlloc failure");
221 if (lseek(fd, offset, SEEK_SET) == -1) {
222 lose("os_map: Seek failure.");
225 count = read(fd, addr, len);
227 fprintf(stderr, "expected 0x%x, read 0x%x.\n", len, count);
228 lose("os_map: Failed to read enough bytes.");
234 static DWORD os_protect_modes[8] = {
241 PAGE_EXECUTE_READWRITE,
242 PAGE_EXECUTE_READWRITE,
246 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
250 if (!VirtualProtect(address, length, os_protect_modes[prot], &old_prot)) {
251 fprintf(stderr, "VirtualProtect failed, code 0x%lx.\n", GetLastError());
256 /* FIXME: Now that FOO_END, rather than FOO_SIZE, is the fundamental
257 * description of a space, we could probably punt this and just do
258 * (FOO_START <= x && x < FOO_END) everywhere it's called. */
260 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
262 char* beg = (char*)((long)sbeg);
263 char* end = (char*)((long)sbeg) + slen;
264 char* adr = (char*)a;
265 return (adr >= beg && adr < end);
269 is_valid_lisp_addr(os_vm_address_t addr)
272 if(in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
273 in_range_p(addr, STATIC_SPACE_START , STATIC_SPACE_SIZE) ||
274 in_range_p(addr, DYNAMIC_SPACE_START , DYNAMIC_SPACE_SIZE))
276 for_each_thread(th) {
277 if(((os_vm_address_t)th->control_stack_start <= addr) && (addr < (os_vm_address_t)th->control_stack_end))
279 if(in_range_p(addr, (unsigned long)th->binding_stack_start, BINDING_STACK_SIZE))
286 * any OS-dependent special low-level handling for signals
289 /* A tiny bit of interrupt.c state we want our paws on. */
290 extern boolean internal_errors_enabled;
293 * FIXME: There is a potential problem with foreign code here.
294 * If we are running foreign code instead of lisp code and an
295 * exception occurs we arrange a call into Lisp. If the
296 * foreign code has installed an exception handler, we run the
297 * very great risk of throwing through their exception handler
298 * without asking it to unwind. This is more a problem with
299 * non-sigtrap (EXCEPTION_BREAKPOINT) exceptions, as they could
300 * reasonably be expected to happen in foreign code. We need to
301 * figure out the exception handler unwind semantics and adhere
302 * to them (probably by abusing the Lisp unwind-protect system)
303 * if we are going to handle this scenario correctly.
305 * A good explanation of the exception handling semantics is
306 * http://win32assembly.online.fr/Exceptionhandling.html .
307 * We will also need to handle this ourselves when foreign
308 * code tries to unwind -us-.
310 * When unwinding through foreign code we should unwind the
311 * Lisp stack to the entry from foreign code, then unwind the
312 * foreign code stack to the entry from Lisp, then resume
316 EXCEPTION_DISPOSITION sigtrap_emulator(CONTEXT *context,
317 struct lisp_exception_frame *exception_frame)
319 if (*((char *)context->Eip + 1) == trap_ContextRestore) {
321 * This is the cleanup for what is immediately below, and
322 * for the generic exception handling further below. We
323 * have to memcpy() the original context (emulated sigtrap
324 * or normal exception) over our context and resume it.
326 memcpy(context, &exception_frame->context, sizeof(CONTEXT));
327 return ExceptionContinueExecution;
329 } else { /* Not a trap_ContextRestore, must be a sigtrap. */
330 /* sigtrap_trampoline is defined in x86-assem.S. */
331 extern void sigtrap_trampoline;
334 * Unlike some other operating systems, Win32 leaves EIP
335 * pointing to the breakpoint instruction.
340 * We're not on an alternate stack like we would be in some
341 * other operating systems, and we don't want to risk leaking
342 * any important resources if we throw out of the sigtrap
343 * handler, so we need to copy off our context to a "safe"
344 * place and then monkey with the return EIP to point to a
345 * trampoline which calls another function which copies the
346 * context out to a really-safe place and then calls the real
347 * sigtrap handler. When the real sigtrap handler returns, the
348 * trampoline then contains another breakpoint with a code of
349 * trap_ContextRestore (see above). Essentially the same
350 * mechanism is used by the generic exception path. There is
351 * a small window of opportunity between us copying the
352 * context to the "safe" place and the sigtrap wrapper copying
353 * it to the really-safe place (allocated in its stack frame)
354 * during which the context can be smashed. The only scenario
355 * I can come up with for this, however, involves a stack
356 * overflow occuring at just the wrong time (which makes one
357 * wonder how stack overflow exceptions even happen, given
358 * that we don't switch stacks for exception processing...)
360 memcpy(&exception_frame->context, context, sizeof(CONTEXT));
361 context->Eax = context->Eip;
362 context->Eip = (unsigned long)&sigtrap_trampoline;
365 return ExceptionContinueExecution;
369 void sigtrap_wrapper(void)
372 * This is the wrapper around the sigtrap handler called from
373 * the trampoline returned to from the function above.
375 * There actually is a point to some of the commented-out code
376 * in this function, although it really belongs to the callback
377 * wrappers. Once it is installed there, it can probably be
381 extern void sigtrap_handler(int signal, siginfo_t *info, void *context);
383 /* volatile struct { */
384 /* void *handler[2]; */
388 struct lisp_exception_frame *frame = find_our_seh_frame();
390 /* wos_install_interrupt_handlers(handler); */
391 /* handler.handler[0] = get_seh_frame(); */
392 /* handler.handler[1] = &handle_exception; */
393 /* set_seh_frame(&handler); */
395 memcpy(&context, &frame->context, sizeof(CONTEXT));
396 sigtrap_handler(0, NULL, &context);
397 memcpy(&frame->context, &context, sizeof(CONTEXT));
399 /* set_seh_frame(handler.handler[0]); */
402 EXCEPTION_DISPOSITION handle_exception(EXCEPTION_RECORD *exception_record,
403 struct lisp_exception_frame *exception_frame,
405 void *dc) /* FIXME: What's dc again? */
408 /* For EXCEPTION_ACCESS_VIOLATION only. */
409 void *fault_address = (void *)exception_record->ExceptionInformation[1];
411 if (exception_record->ExceptionCode == EXCEPTION_BREAKPOINT) {
412 /* Pick off sigtrap case first. */
413 return sigtrap_emulator(context, exception_frame);
415 } else if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION &&
416 is_valid_lisp_addr(fault_address)) {
417 /* Pick off GC-related memory fault next. */
418 MEMORY_BASIC_INFORMATION mem_info;
420 if (!VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
421 fprintf(stderr, "VirtualQuery: 0x%lx.\n", GetLastError());
422 lose("handle_exception: VirtualQuery failure");
425 if (mem_info.State == MEM_RESERVE) {
426 /* First use new page, lets get some memory for it. */
427 if (!VirtualAlloc(mem_info.BaseAddress, os_vm_page_size,
428 MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
429 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
430 lose("handle_exception: VirtualAlloc failure");
434 * Now, if the page is supposedly write-protected and this
435 * is a write, tell the gc that it's been hit.
437 * FIXME: Are we supposed to fall-through to the Lisp
438 * exception handler if the gc doesn't take the wp violation?
440 if (exception_record->ExceptionInformation[0]) {
441 int index = find_page_index(fault_address);
442 if ((index != -1) && (page_table[index].write_protected)) {
443 gencgc_handle_wp_violation(fault_address);
446 return ExceptionContinueExecution;
449 } else if (gencgc_handle_wp_violation(fault_address)) {
450 /* gc accepts the wp violation, so resume where we left off. */
451 return ExceptionContinueExecution;
454 /* All else failed, drop through to the lisp-side exception handler. */
458 * If we fall through to here then we need to either forward
459 * the exception to the lisp-side exception handler if it's
460 * set up, or drop to LDB.
463 if (internal_errors_enabled) {
464 /* exception_trampoline is defined in x86-assem.S. */
465 extern void exception_trampoline;
468 * We're making the somewhat arbitrary decision that
469 * having internal errors enabled means that lisp has
470 * sufficient marbles to be able to handle exceptions.
472 * Exceptions aren't supposed to happen during cold
473 * init or reinit anyway.
477 * We use the same mechanism as the sigtrap emulator above
478 * with just a couple changes. We obviously use a different
479 * trampoline and wrapper function, we kill out any live
480 * floating point exceptions, and we save off the exception
481 * record as well as the context.
484 /* Save off context and exception information */
485 memcpy(&exception_frame->context, context, sizeof(CONTEXT));
486 memcpy(&exception_frame->exception, exception_record, sizeof(EXCEPTION_RECORD));
488 /* Set up to activate trampoline when we return */
489 context->Eax = context->Eip;
490 context->Eip = (unsigned long)&exception_trampoline;
492 /* Make sure a floating-point trap doesn't kill us */
493 context->FloatSave.StatusWord &= ~0x3f;
496 return ExceptionContinueExecution;
499 fprintf(stderr, "Exception Code: 0x%lx.\n", exception_record->ExceptionCode);
500 fprintf(stderr, "Faulting IP: 0x%lx.\n", (DWORD)exception_record->ExceptionAddress);
501 if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
502 MEMORY_BASIC_INFORMATION mem_info;
504 if (VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
505 fprintf(stderr, "page status: 0x%lx.\n", mem_info.State);
508 fprintf(stderr, "Was writing: %ld, where: 0x%lx.\n",
509 exception_record->ExceptionInformation[0],
510 (DWORD)fault_address);
515 fake_foreign_function_call(context);
516 monitor_or_something();
518 return ExceptionContinueSearch;
521 void handle_win32_exception_wrapper(void)
523 struct lisp_exception_frame *frame = find_our_seh_frame();
525 EXCEPTION_RECORD exception_record;
527 lispobj exception_record_sap;
529 memcpy(&context, &frame->context, sizeof(CONTEXT));
530 memcpy(&exception_record, &frame->exception, sizeof(EXCEPTION_RECORD));
532 fake_foreign_function_call(&context);
534 /* Allocate the SAP objects while the "interrupts" are still
536 context_sap = alloc_sap(&context);
537 exception_record_sap = alloc_sap(&exception_record);
539 funcall2(SymbolFunction(HANDLE_WIN32_EXCEPTION), context_sap,
540 exception_record_sap);
542 undo_fake_foreign_function_call(&context);
544 memcpy(&frame->context, &context, sizeof(CONTEXT));
548 wos_install_interrupt_handlers(struct lisp_exception_frame *handler)
550 handler->next_frame = get_seh_frame();
551 handler->handler = &handle_exception;
552 set_seh_frame(handler);
555 void bcopy(const void *src, void *dest, size_t n)
557 MoveMemory(dest, src, n);
561 * The stubs below are replacements for the windows versions,
562 * which can -fail- when used in our memory spaces because they
563 * validate the memory spaces they are passed in a way that
564 * denies our exception handler a chance to run.
567 void *memmove(void *dest, const void *src, size_t n)
571 for (i = 0; i < n; i++) *(((char *)dest)+i) = *(((char *)src)+i);
573 while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
578 void *memcpy(void *dest, const void *src, size_t n)
580 while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
584 char *dirname(char *path)
586 static char buf[PATH_MAX + 1];
587 size_t pathlen = strlen(path);
590 if (pathlen >= sizeof(buf)) {
591 lose("Pathname too long in dirname.\n");
596 for (i = pathlen; i >= 0; --i) {
597 if (buf[i] == '/' || buf[i] == '\\') {
606 /* This is a manually-maintained version of ldso_stubs.S. */
622 GetProcAddress(0, 0);