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>
39 #include "interrupt.h"
44 #include "genesis/primitive-objects.h"
46 #include <sys/types.h>
57 size_t os_vm_page_size;
61 #include "gencgc-internal.h"
64 int linux_sparc_siginfo_bug = 0;
65 int linux_supports_futex=0;
68 /* The exception handling function looks like this: */
69 EXCEPTION_DISPOSITION handle_exception(EXCEPTION_RECORD *,
70 struct lisp_exception_frame *,
76 static void *get_seh_frame(void)
79 asm volatile ("movl %%fs:0,%0": "=r" (retval));
83 static void set_seh_frame(void *frame)
85 asm volatile ("movl %0,%%fs:0": : "r" (frame));
88 static struct lisp_exception_frame *find_our_seh_frame(void)
90 struct lisp_exception_frame *frame = get_seh_frame();
92 while (frame->handler != handle_exception)
93 frame = frame->next_frame;
99 inline static void *get_stack_frame(void)
102 asm volatile ("movl %%ebp,%0": "=r" (retval));
107 void os_init(char *argv[], char *envp[])
109 SYSTEM_INFO system_info;
111 GetSystemInfo(&system_info);
112 os_vm_page_size = system_info.dwPageSize;
114 base_seh_frame = get_seh_frame();
119 * So we have three fun scenarios here.
121 * First, we could be being called to reserve the memory areas
122 * during initialization (prior to loading the core file).
124 * Second, we could be being called by the GC to commit a page
125 * that has just been decommitted (for easy zero-fill).
127 * Third, we could be being called by create_thread_struct()
128 * in order to create the sundry and various stacks.
130 * The third case is easy to pick out because it passes an
133 * The second case is easy to pick out because it will be for
134 * a range of memory that is MEM_RESERVE rather than MEM_FREE.
136 * The second case is also an easy implement, because we leave
137 * the memory as reserved (since we do lazy commits).
141 os_validate(os_vm_address_t addr, os_vm_size_t len)
143 MEMORY_BASIC_INFORMATION mem_info;
146 /* the simple case first */
147 os_vm_address_t real_addr;
148 if (!(real_addr = VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE))) {
149 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
156 if (!VirtualQuery(addr, &mem_info, sizeof mem_info)) {
157 fprintf(stderr, "VirtualQuery: 0x%lx.\n", GetLastError());
161 if ((mem_info.State == MEM_RESERVE) && (mem_info.RegionSize >=len)) return addr;
163 if (mem_info.State == MEM_RESERVE) {
164 fprintf(stderr, "validation of reserved space too short.\n");
168 if (!VirtualAlloc(addr, len, (mem_info.State == MEM_RESERVE)? MEM_COMMIT: MEM_RESERVE, PAGE_EXECUTE_READWRITE)) {
169 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
177 * For os_invalidate(), we merely decommit the memory rather than
178 * freeing the address space. This loses when freeing per-thread
179 * data and related memory since it leaks address space. It's not
180 * too lossy, however, since the two scenarios I'm aware of are
181 * fd-stream buffers, which are pooled rather than torched, and
182 * thread information, which I hope to pool (since windows creates
183 * threads at its own whim, and we probably want to be able to
184 * have them callback without funky magic on the part of the user,
185 * and full-on thread allocation is fairly heavyweight). Someone
186 * will probably shoot me down on this with some pithy comment on
187 * the use of (setf symbol-value) on a special variable. I'm happy
192 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
194 if (!VirtualFree(addr, len, MEM_DECOMMIT)) {
195 fprintf(stderr, "VirtualFree: 0x%lx.\n", GetLastError());
200 * os_map() is called to map a chunk of the core file into memory.
202 * Unfortunately, Windows semantics completely screws this up, so
203 * we just add backing store from the swapfile to where the chunk
204 * goes and read it up like a normal file. We could consider using
205 * a lazy read (demand page) setup, but that would mean keeping an
206 * open file pointer for the core indefinately (and be one more
207 * thing to maintain).
211 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
216 fprintf(stderr, "os_map: %d, 0x%x, %p, 0x%x.\n", fd, offset, addr, len);
220 if (!VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
221 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
222 lose("os_map: VirtualAlloc failure");
225 if (lseek(fd, offset, SEEK_SET) == -1) {
226 lose("os_map: Seek failure.");
229 count = read(fd, addr, len);
231 fprintf(stderr, "expected 0x%x, read 0x%x.\n", len, count);
232 lose("os_map: Failed to read enough bytes.");
238 static DWORD os_protect_modes[8] = {
245 PAGE_EXECUTE_READWRITE,
246 PAGE_EXECUTE_READWRITE,
250 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
254 if (!VirtualProtect(address, length, os_protect_modes[prot], &old_prot)) {
255 fprintf(stderr, "VirtualProtect failed, code 0x%lx.\n", GetLastError());
260 /* FIXME: Now that FOO_END, rather than FOO_SIZE, is the fundamental
261 * description of a space, we could probably punt this and just do
262 * (FOO_START <= x && x < FOO_END) everywhere it's called. */
264 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
266 char* beg = (char*)((long)sbeg);
267 char* end = (char*)((long)sbeg) + slen;
268 char* adr = (char*)a;
269 return (adr >= beg && adr < end);
273 is_linkage_table_addr(os_vm_address_t addr)
275 return in_range_p(addr, LINKAGE_TABLE_SPACE_START, LINKAGE_TABLE_SPACE_END);
279 is_valid_lisp_addr(os_vm_address_t addr)
282 if(in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
283 in_range_p(addr, STATIC_SPACE_START , STATIC_SPACE_SIZE) ||
284 in_range_p(addr, DYNAMIC_SPACE_START , DYNAMIC_SPACE_SIZE))
286 for_each_thread(th) {
287 if(((os_vm_address_t)th->control_stack_start <= addr) && (addr < (os_vm_address_t)th->control_stack_end))
289 if(in_range_p(addr, (unsigned long)th->binding_stack_start, BINDING_STACK_SIZE))
296 * any OS-dependent special low-level handling for signals
299 /* A tiny bit of interrupt.c state we want our paws on. */
300 extern boolean internal_errors_enabled;
303 * FIXME: There is a potential problem with foreign code here.
304 * If we are running foreign code instead of lisp code and an
305 * exception occurs we arrange a call into Lisp. If the
306 * foreign code has installed an exception handler, we run the
307 * very great risk of throwing through their exception handler
308 * without asking it to unwind. This is more a problem with
309 * non-sigtrap (EXCEPTION_BREAKPOINT) exceptions, as they could
310 * reasonably be expected to happen in foreign code. We need to
311 * figure out the exception handler unwind semantics and adhere
312 * to them (probably by abusing the Lisp unwind-protect system)
313 * if we are going to handle this scenario correctly.
315 * A good explanation of the exception handling semantics is
316 * http://win32assembly.online.fr/Exceptionhandling.html .
317 * We will also need to handle this ourselves when foreign
318 * code tries to unwind -us-.
320 * When unwinding through foreign code we should unwind the
321 * Lisp stack to the entry from foreign code, then unwind the
322 * foreign code stack to the entry from Lisp, then resume
326 EXCEPTION_DISPOSITION sigtrap_emulator(CONTEXT *context,
327 struct lisp_exception_frame *exception_frame)
329 if (*((char *)context->Eip + 1) == trap_ContextRestore) {
330 /* This is the cleanup for what is immediately below, and
331 * for the generic exception handling further below. We
332 * have to memcpy() the original context (emulated sigtrap
333 * or normal exception) over our context and resume it. */
334 memcpy(context, &exception_frame->context, sizeof(CONTEXT));
335 return ExceptionContinueExecution;
338 /* Not a trap_ContextRestore, must be a sigtrap.
339 * sigtrap_trampoline is defined in x86-assem.S. */
340 extern void sigtrap_trampoline;
343 * Unlike some other operating systems, Win32 leaves EIP
344 * pointing to the breakpoint instruction.
348 /* We're not on an alternate stack like we would be in some
349 * other operating systems, and we don't want to risk leaking
350 * any important resources if we throw out of the sigtrap
351 * handler, so we need to copy off our context to a "safe"
352 * place and then monkey with the return EIP to point to a
353 * trampoline which calls another function which copies the
354 * context out to a really-safe place and then calls the real
355 * sigtrap handler. When the real sigtrap handler returns, the
356 * trampoline then contains another breakpoint with a code of
357 * trap_ContextRestore (see above). Essentially the same
358 * mechanism is used by the generic exception path. There is
359 * a small window of opportunity between us copying the
360 * context to the "safe" place and the sigtrap wrapper copying
361 * it to the really-safe place (allocated in its stack frame)
362 * during which the context can be smashed. The only scenario
363 * I can come up with for this, however, involves a stack
364 * overflow occuring at just the wrong time (which makes one
365 * wonder how stack overflow exceptions even happen, given
366 * that we don't switch stacks for exception processing...) */
367 memcpy(&exception_frame->context, context, sizeof(CONTEXT));
369 /* FIXME: Why do we save the old EIP in EAX? The sigtrap_trampoline
370 * pushes it into stack, but the sigtrap_wrapper where the trampoline
371 * goes ignores it, and after the wrapper we hit the trap_ContextRestore,
372 * which nukes the whole context with the original one?
374 * Am I misreading this, or is the EAX here and in the
375 * trampoline superfluous? --NS 20061024 */
376 context->Eax = context->Eip;
377 context->Eip = (unsigned long)&sigtrap_trampoline;
380 return ExceptionContinueExecution;
384 void sigtrap_wrapper(void)
387 * This is the wrapper around the sigtrap handler called from
388 * the trampoline returned to from the function above.
390 * There actually is a point to some of the commented-out code
391 * in this function, although it really belongs to the callback
392 * wrappers. Once it is installed there, it can probably be
395 extern void sigtrap_handler(int signal, siginfo_t *info, void *context);
397 /* volatile struct { */
398 /* void *handler[2]; */
402 struct lisp_exception_frame *frame = find_our_seh_frame();
404 /* wos_install_interrupt_handlers(handler); */
405 /* handler.handler[0] = get_seh_frame(); */
406 /* handler.handler[1] = &handle_exception; */
407 /* set_seh_frame(&handler); */
409 memcpy(&context, &frame->context, sizeof(CONTEXT));
410 sigtrap_handler(0, NULL, &context);
411 memcpy(&frame->context, &context, sizeof(CONTEXT));
413 /* set_seh_frame(handler.handler[0]); */
416 EXCEPTION_DISPOSITION handle_exception(EXCEPTION_RECORD *exception_record,
417 struct lisp_exception_frame *exception_frame,
419 void *dc) /* FIXME: What's dc again? */
422 /* For EXCEPTION_ACCESS_VIOLATION only. */
423 void *fault_address = (void *)exception_record->ExceptionInformation[1];
425 if (exception_record->ExceptionCode == EXCEPTION_BREAKPOINT) {
426 /* Pick off sigtrap case first. */
427 return sigtrap_emulator(context, exception_frame);
430 else if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION &&
431 (is_valid_lisp_addr(fault_address) ||
432 is_linkage_table_addr(fault_address))) {
433 /* Pick off GC-related memory fault next. */
434 MEMORY_BASIC_INFORMATION mem_info;
436 if (!VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
437 fprintf(stderr, "VirtualQuery: 0x%lx.\n", GetLastError());
438 lose("handle_exception: VirtualQuery failure");
441 if (mem_info.State == MEM_RESERVE) {
442 /* First use new page, lets get some memory for it. */
443 if (!VirtualAlloc(mem_info.BaseAddress, os_vm_page_size,
444 MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
445 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
446 lose("handle_exception: VirtualAlloc failure");
450 * Now, if the page is supposedly write-protected and this
451 * is a write, tell the gc that it's been hit.
453 * FIXME: Are we supposed to fall-through to the Lisp
454 * exception handler if the gc doesn't take the wp violation?
456 if (exception_record->ExceptionInformation[0]) {
457 int index = find_page_index(fault_address);
458 if ((index != -1) && (page_table[index].write_protected)) {
459 gencgc_handle_wp_violation(fault_address);
462 return ExceptionContinueExecution;
465 } else if (gencgc_handle_wp_violation(fault_address)) {
466 /* gc accepts the wp violation, so resume where we left off. */
467 return ExceptionContinueExecution;
470 /* All else failed, drop through to the lisp-side exception handler. */
474 * If we fall through to here then we need to either forward
475 * the exception to the lisp-side exception handler if it's
476 * set up, or drop to LDB.
479 if (internal_errors_enabled) {
480 /* exception_trampoline is defined in x86-assem.S. */
481 extern void exception_trampoline;
483 /* We're making the somewhat arbitrary decision that having
484 * internal errors enabled means that lisp has sufficient
485 * marbles to be able to handle exceptions, but xceptions
486 * aren't supposed to happen during cold init or reinit
489 * We use the same mechanism as the sigtrap emulator above
490 * with just a couple changes. We obviously use a different
491 * trampoline and wrapper function, we kill out any live
492 * floating point exceptions, and we save off the exception
493 * record as well as the context. */
495 /* Save off context and exception information */
496 memcpy(&exception_frame->context, context, sizeof(CONTEXT));
497 memcpy(&exception_frame->exception, exception_record, sizeof(EXCEPTION_RECORD));
499 /* Set up to activate trampoline when we return
501 * FIXME: Why do we save the old EIP in EAX? The
502 * exception_trampoline pushes it into stack, but the wrapper
503 * where the trampoline goes ignores it, and then the wrapper
504 * unwinds from Lisp... WTF?
506 * Am I misreading this, or is the EAX here and in the
507 * trampoline superfluous? --NS 20061024 */
508 context->Eax = context->Eip;
509 context->Eip = (unsigned long)&exception_trampoline;
511 /* Make sure a floating-point trap doesn't kill us */
512 context->FloatSave.StatusWord &= ~0x3f;
515 return ExceptionContinueExecution;
518 fprintf(stderr, "Exception Code: 0x%lx.\n", exception_record->ExceptionCode);
519 fprintf(stderr, "Faulting IP: 0x%lx.\n", (DWORD)exception_record->ExceptionAddress);
520 if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
521 MEMORY_BASIC_INFORMATION mem_info;
523 if (VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
524 fprintf(stderr, "page status: 0x%lx.\n", mem_info.State);
527 fprintf(stderr, "Was writing: %ld, where: 0x%lx.\n",
528 exception_record->ExceptionInformation[0],
529 (DWORD)fault_address);
534 fake_foreign_function_call(context);
535 lose("fake_foreign_function_call fell through");
537 /* FIXME: WTF? How are we supposed to end up here? */
538 return ExceptionContinueSearch;
541 void handle_win32_exception_wrapper(void)
543 struct lisp_exception_frame *frame = find_our_seh_frame();
545 EXCEPTION_RECORD exception_record;
547 lispobj exception_record_sap;
549 memcpy(&context, &frame->context, sizeof(CONTEXT));
550 memcpy(&exception_record, &frame->exception, sizeof(EXCEPTION_RECORD));
552 fake_foreign_function_call(&context);
554 /* Allocate the SAP objects while the "interrupts" are still
556 context_sap = alloc_sap(&context);
557 exception_record_sap = alloc_sap(&exception_record);
559 funcall2(SymbolFunction(HANDLE_WIN32_EXCEPTION), context_sap,
560 exception_record_sap);
562 /* FIXME: These never happen, as the Lisp-side call is
563 * to an ERROR, which means we must do a non-local exit
565 undo_fake_foreign_function_call(&context);
566 memcpy(&frame->context, &context, sizeof(CONTEXT));
570 wos_install_interrupt_handlers(struct lisp_exception_frame *handler)
572 handler->next_frame = get_seh_frame();
573 handler->handler = &handle_exception;
574 set_seh_frame(handler);
577 void bcopy(const void *src, void *dest, size_t n)
579 MoveMemory(dest, src, n);
583 * The stubs below are replacements for the windows versions,
584 * which can -fail- when used in our memory spaces because they
585 * validate the memory spaces they are passed in a way that
586 * denies our exception handler a chance to run.
589 void *memmove(void *dest, const void *src, size_t n)
593 for (i = 0; i < n; i++) *(((char *)dest)+i) = *(((char *)src)+i);
595 while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
600 void *memcpy(void *dest, const void *src, size_t n)
602 while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
606 char *dirname(char *path)
608 static char buf[PATH_MAX + 1];
609 size_t pathlen = strlen(path);
612 if (pathlen >= sizeof(buf)) {
613 lose("Pathname too long in dirname.\n");
618 for (i = pathlen; i >= 0; --i) {
619 if (buf[i] == '/' || buf[i] == '\\') {
628 /* This is a manually-maintained version of ldso_stubs.S. */
640 #ifndef LISP_FEATURE_SB_UNICODE
645 #ifndef LISP_FEATURE_SB_UNICODE
646 GetCurrentDirectoryA(0,0);
648 GetCurrentDirectoryW(0,0);
652 GetProcAddress(0, 0);
654 #ifndef LISP_FEATURE_SB_UNICODE
655 CreateDirectoryA(0,0);
657 CreateDirectoryW(0,0);
663 FormatMessageA(0, 0, 0, 0, 0, 0, 0);
664 #ifdef LISP_FEATURE_SB_UNICODE
665 FormatMessageW(0, 0, 0, 0, 0, 0, 0);
668 ReadFile(0, 0, 0, 0, 0);
669 WriteFile(0, 0, 0, 0, 0);
670 PeekNamedPipe(0, 0, 0, 0, 0, 0);
671 FlushConsoleInputBuffer(0);
672 PeekConsoleInput(0, 0, 0, 0);
674 #ifndef LISP_FEATURE_SB_UNICODE
675 SHGetFolderPathA(0, 0, 0, 0, 0);
677 SHGetFolderPathW(0, 0, 0, 0, 0);
682 #ifndef LISP_FEATURE_SB_UNICODE
683 GetEnvironmentVariableA(0, 0, 0);
685 GetEnvironmentVariableW(0, 0, 0);
688 GetConsoleOutputCP();
689 GetExitCodeProcess(0, 0);
691 GetProcessTimes(0, 0, 0, 0, 0);
692 #ifndef LISP_FEATURE_SB_UNICODE
693 SetEnvironmentVariableA(0, 0);
695 SetEnvironmentVariableW(0, 0);
697 #ifndef LISP_FEATURE_SB_UNICODE
702 #ifndef LISP_FEATURE_SB_UNICODE
703 GetComputerNameA(0, 0);
705 GetComputerNameW(0, 0);
707 #ifndef LISP_FEATURE_SB_UNICODE
708 SetCurrentDirectoryA(0);
710 SetCurrentDirectoryW(0);
716 os_get_runtime_executable_path()
718 char path[MAX_PATH + 1];
719 DWORD bufsize = sizeof(path);
722 if ((size = GetModuleFileNameA(NULL, path, bufsize)) == 0)
724 else if (size == bufsize && GetLastError() == ERROR_INSUFFICIENT_BUFFER)
727 return copied_string(path);