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
31 #include <sys/param.h>
40 #include "interrupt.h"
45 #include "genesis/primitive-objects.h"
48 #include <sys/types.h>
54 /* KLUDGE: Avoid double definition of boolean by rpcndr.h included via
57 * FIXME: We should probably arrange to use the rpcndr.h boolean on Windows,
58 * or get rid of our own boolean type.
60 #define boolean rpcndr_boolean
71 size_t os_vm_page_size;
74 #include "gencgc-internal.h"
77 int linux_sparc_siginfo_bug = 0;
78 int linux_supports_futex=0;
81 /* The exception handling function looks like this: */
82 EXCEPTION_DISPOSITION handle_exception(EXCEPTION_RECORD *,
83 struct lisp_exception_frame *,
89 static void *get_seh_frame(void)
92 asm volatile ("movl %%fs:0,%0": "=r" (retval));
96 static void set_seh_frame(void *frame)
98 asm volatile ("movl %0,%%fs:0": : "r" (frame));
102 static struct lisp_exception_frame *find_our_seh_frame(void)
104 struct lisp_exception_frame *frame = get_seh_frame();
106 while (frame->handler != handle_exception)
107 frame = frame->next_frame;
112 inline static void *get_stack_frame(void)
115 asm volatile ("movl %%ebp,%0": "=r" (retval));
120 void os_init(char *argv[], char *envp[])
122 SYSTEM_INFO system_info;
124 GetSystemInfo(&system_info);
125 os_vm_page_size = system_info.dwPageSize;
127 base_seh_frame = get_seh_frame();
132 * So we have three fun scenarios here.
134 * First, we could be being called to reserve the memory areas
135 * during initialization (prior to loading the core file).
137 * Second, we could be being called by the GC to commit a page
138 * that has just been decommitted (for easy zero-fill).
140 * Third, we could be being called by create_thread_struct()
141 * in order to create the sundry and various stacks.
143 * The third case is easy to pick out because it passes an
146 * The second case is easy to pick out because it will be for
147 * a range of memory that is MEM_RESERVE rather than MEM_FREE.
149 * The second case is also an easy implement, because we leave
150 * the memory as reserved (since we do lazy commits).
154 os_validate(os_vm_address_t addr, os_vm_size_t len)
156 MEMORY_BASIC_INFORMATION mem_info;
159 /* the simple case first */
160 os_vm_address_t real_addr;
161 if (!(real_addr = VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE))) {
162 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
169 if (!VirtualQuery(addr, &mem_info, sizeof mem_info)) {
170 fprintf(stderr, "VirtualQuery: 0x%lx.\n", GetLastError());
174 if ((mem_info.State == MEM_RESERVE) && (mem_info.RegionSize >=len)) return addr;
176 if (mem_info.State == MEM_RESERVE) {
177 fprintf(stderr, "validation of reserved space too short.\n");
181 if (!VirtualAlloc(addr, len, (mem_info.State == MEM_RESERVE)? MEM_COMMIT: MEM_RESERVE, PAGE_EXECUTE_READWRITE)) {
182 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
190 * For os_invalidate(), we merely decommit the memory rather than
191 * freeing the address space. This loses when freeing per-thread
192 * data and related memory since it leaks address space. It's not
193 * too lossy, however, since the two scenarios I'm aware of are
194 * fd-stream buffers, which are pooled rather than torched, and
195 * thread information, which I hope to pool (since windows creates
196 * threads at its own whim, and we probably want to be able to
197 * have them callback without funky magic on the part of the user,
198 * and full-on thread allocation is fairly heavyweight). Someone
199 * will probably shoot me down on this with some pithy comment on
200 * the use of (setf symbol-value) on a special variable. I'm happy
205 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
207 if (!VirtualFree(addr, len, MEM_DECOMMIT)) {
208 fprintf(stderr, "VirtualFree: 0x%lx.\n", GetLastError());
213 * os_map() is called to map a chunk of the core file into memory.
215 * Unfortunately, Windows semantics completely screws this up, so
216 * we just add backing store from the swapfile to where the chunk
217 * goes and read it up like a normal file. We could consider using
218 * a lazy read (demand page) setup, but that would mean keeping an
219 * open file pointer for the core indefinately (and be one more
220 * thing to maintain).
224 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
229 fprintf(stderr, "os_map: %d, 0x%x, %p, 0x%x.\n", fd, offset, addr, len);
233 if (!VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
234 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
235 lose("os_map: VirtualAlloc failure");
238 if (lseek(fd, offset, SEEK_SET) == -1) {
239 lose("os_map: Seek failure.");
242 count = read(fd, addr, len);
244 fprintf(stderr, "expected 0x%x, read 0x%x.\n", len, count);
245 lose("os_map: Failed to read enough bytes.");
251 static DWORD os_protect_modes[8] = {
258 PAGE_EXECUTE_READWRITE,
259 PAGE_EXECUTE_READWRITE,
263 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
267 if (!VirtualProtect(address, length, os_protect_modes[prot], &old_prot)) {
268 fprintf(stderr, "VirtualProtect failed, code 0x%lx.\n", GetLastError());
273 /* FIXME: Now that FOO_END, rather than FOO_SIZE, is the fundamental
274 * description of a space, we could probably punt this and just do
275 * (FOO_START <= x && x < FOO_END) everywhere it's called. */
277 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
279 char* beg = (char*)((long)sbeg);
280 char* end = (char*)((long)sbeg) + slen;
281 char* adr = (char*)a;
282 return (adr >= beg && adr < end);
286 is_linkage_table_addr(os_vm_address_t addr)
288 return in_range_p(addr, LINKAGE_TABLE_SPACE_START, LINKAGE_TABLE_SPACE_END);
292 is_valid_lisp_addr(os_vm_address_t addr)
295 if(in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
296 in_range_p(addr, STATIC_SPACE_START , STATIC_SPACE_SIZE) ||
297 in_range_p(addr, DYNAMIC_SPACE_START , dynamic_space_size))
299 for_each_thread(th) {
300 if(((os_vm_address_t)th->control_stack_start <= addr) && (addr < (os_vm_address_t)th->control_stack_end))
302 if(in_range_p(addr, (unsigned long)th->binding_stack_start, BINDING_STACK_SIZE))
309 * any OS-dependent special low-level handling for signals
312 /* A tiny bit of interrupt.c state we want our paws on. */
313 extern boolean internal_errors_enabled;
316 * A good explanation of the exception handling semantics is
317 * http://win32assembly.online.fr/Exceptionhandling.html .
320 EXCEPTION_DISPOSITION
321 handle_exception(EXCEPTION_RECORD *exception_record,
322 struct lisp_exception_frame *exception_frame,
324 void *dispatcher_context)
326 if (exception_record->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND)) {
327 /* If we're being unwound, be graceful about it. */
329 /* Undo any dynamic bindings. */
330 unbind_to_here(exception_frame->bindstack_pointer,
331 arch_os_get_current_thread());
333 return ExceptionContinueSearch;
336 /* For EXCEPTION_ACCESS_VIOLATION only. */
337 void *fault_address = (void *)exception_record->ExceptionInformation[1];
339 if (single_stepping &&
340 exception_record->ExceptionCode == EXCEPTION_SINGLE_STEP) {
341 /* We are doing a displaced instruction. At least function
342 * end breakpoints uses this. */
343 restore_breakpoint_from_single_step(context);
344 return ExceptionContinueExecution;
347 if (exception_record->ExceptionCode == EXCEPTION_BREAKPOINT) {
348 /* Pick off sigtrap case first. */
350 extern void sigtrap_handler(int signal, siginfo_t *info, void *context);
352 * Unlike some other operating systems, Win32 leaves EIP
353 * pointing to the breakpoint instruction.
357 sigtrap_handler(0, NULL, context);
359 return ExceptionContinueExecution;
361 else if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION &&
362 (is_valid_lisp_addr(fault_address) ||
363 is_linkage_table_addr(fault_address))) {
364 /* Pick off GC-related memory fault next. */
365 MEMORY_BASIC_INFORMATION mem_info;
367 if (!VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
368 fprintf(stderr, "VirtualQuery: 0x%lx.\n", GetLastError());
369 lose("handle_exception: VirtualQuery failure");
372 if (mem_info.State == MEM_RESERVE) {
373 /* First use new page, lets get some memory for it. */
374 if (!VirtualAlloc(mem_info.BaseAddress, os_vm_page_size,
375 MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
376 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
377 lose("handle_exception: VirtualAlloc failure");
381 * Now, if the page is supposedly write-protected and this
382 * is a write, tell the gc that it's been hit.
384 * FIXME: Are we supposed to fall-through to the Lisp
385 * exception handler if the gc doesn't take the wp violation?
387 if (exception_record->ExceptionInformation[0]) {
388 int index = find_page_index(fault_address);
389 if ((index != -1) && (page_table[index].write_protected)) {
390 gencgc_handle_wp_violation(fault_address);
393 return ExceptionContinueExecution;
396 } else if (gencgc_handle_wp_violation(fault_address)) {
397 /* gc accepts the wp violation, so resume where we left off. */
398 return ExceptionContinueExecution;
401 /* All else failed, drop through to the lisp-side exception handler. */
405 * If we fall through to here then we need to either forward
406 * the exception to the lisp-side exception handler if it's
407 * set up, or drop to LDB.
410 if (internal_errors_enabled) {
412 lispobj exception_record_sap;
414 /* We're making the somewhat arbitrary decision that having
415 * internal errors enabled means that lisp has sufficient
416 * marbles to be able to handle exceptions, but exceptions
417 * aren't supposed to happen during cold init or reinit
420 fake_foreign_function_call(context);
422 /* Allocate the SAP objects while the "interrupts" are still
424 context_sap = alloc_sap(context);
425 exception_record_sap = alloc_sap(exception_record);
427 /* The exception system doesn't automatically clear pending
428 * exceptions, so we lose as soon as we execute any FP
429 * instruction unless we do this first. */
432 /* Call into lisp to handle things. */
433 funcall2(SymbolFunction(HANDLE_WIN32_EXCEPTION), context_sap,
434 exception_record_sap);
436 /* If Lisp doesn't nlx, we need to put things back. */
437 undo_fake_foreign_function_call(context);
439 /* FIXME: HANDLE-WIN32-EXCEPTION should be allowed to decline */
440 return ExceptionContinueExecution;
443 fprintf(stderr, "Exception Code: 0x%lx.\n", exception_record->ExceptionCode);
444 fprintf(stderr, "Faulting IP: 0x%lx.\n", (DWORD)exception_record->ExceptionAddress);
445 if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
446 MEMORY_BASIC_INFORMATION mem_info;
448 if (VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
449 fprintf(stderr, "page status: 0x%lx.\n", mem_info.State);
452 fprintf(stderr, "Was writing: %ld, where: 0x%lx.\n",
453 exception_record->ExceptionInformation[0],
454 (DWORD)fault_address);
459 fake_foreign_function_call(context);
460 lose("fake_foreign_function_call fell through");
462 /* FIXME: WTF? How are we supposed to end up here? */
463 return ExceptionContinueSearch;
467 wos_install_interrupt_handlers(struct lisp_exception_frame *handler)
469 handler->next_frame = get_seh_frame();
470 handler->handler = &handle_exception;
471 set_seh_frame(handler);
474 void bcopy(const void *src, void *dest, size_t n)
476 MoveMemory(dest, src, n);
480 * The stubs below are replacements for the windows versions,
481 * which can -fail- when used in our memory spaces because they
482 * validate the memory spaces they are passed in a way that
483 * denies our exception handler a chance to run.
486 void *memmove(void *dest, const void *src, size_t n)
490 for (i = 0; i < n; i++) *(((char *)dest)+i) = *(((char *)src)+i);
492 while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
497 void *memcpy(void *dest, const void *src, size_t n)
499 while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
503 char *dirname(char *path)
505 static char buf[PATH_MAX + 1];
506 size_t pathlen = strlen(path);
509 if (pathlen >= sizeof(buf)) {
510 lose("Pathname too long in dirname.\n");
515 for (i = pathlen; i >= 0; --i) {
516 if (buf[i] == '/' || buf[i] == '\\') {
525 /* This is a manually-maintained version of ldso_stubs.S. */
527 void __stdcall RtlUnwind(void *, void *, void *, void *); /* I don't have winternl.h */
532 FlushConsoleInputBuffer(0);
533 FormatMessageA(0, 0, 0, 0, 0, 0, 0);
537 GetConsoleOutputCP();
539 GetExitCodeProcess(0, 0);
542 GetProcAddress(0, 0);
543 GetProcessTimes(0, 0, 0, 0, 0);
544 GetSystemTimeAsFileTime(0);
547 PeekConsoleInput(0, 0, 0, 0);
548 PeekNamedPipe(0, 0, 0, 0, 0, 0);
549 ReadFile(0, 0, 0, 0, 0);
551 WriteFile(0, 0, 0, 0, 0);
565 RtlUnwind(0, 0, 0, 0);
566 #ifndef LISP_FEATURE_SB_UNICODE
567 CreateDirectoryA(0,0);
568 GetComputerNameA(0, 0);
569 GetCurrentDirectoryA(0,0);
570 GetEnvironmentVariableA(0, 0, 0);
573 SHGetFolderPathA(0, 0, 0, 0, 0);
574 SetCurrentDirectoryA(0);
575 SetEnvironmentVariableA(0, 0);
577 CreateDirectoryW(0,0);
578 FormatMessageW(0, 0, 0, 0, 0, 0, 0);
579 GetComputerNameW(0, 0);
580 GetCurrentDirectoryW(0,0);
581 GetEnvironmentVariableW(0, 0, 0);
584 SHGetFolderPathW(0, 0, 0, 0, 0);
585 SetCurrentDirectoryW(0);
586 SetEnvironmentVariableW(0, 0);
591 os_get_runtime_executable_path()
593 char path[MAX_PATH + 1];
594 DWORD bufsize = sizeof(path);
597 if ((size = GetModuleFileNameA(NULL, path, bufsize)) == 0)
599 else if (size == bufsize && GetLastError() == ERROR_INSUFFICIENT_BUFFER)
602 return copied_string(path);