1.0.45.22: non-racy RUN-PROGRAM :PTY on OpenBSD
[sbcl.git] / src / runtime / win32-os.c
1 /*
2  * the Win32 incarnation of OS-dependent routines.  See also
3  * $(sbcl_arch)-win32-os.c
4  *
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.
10  */
11
12 /*
13  * This software is part of the SBCL system. See the README file for
14  * more information.
15  *
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.
21  */
22
23 /*
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
26  * yet.
27  */
28
29 #include <malloc.h>
30 #include <stdio.h>
31 #include <sys/param.h>
32 #include <sys/file.h>
33 #include <io.h>
34 #include "sbcl.h"
35 #include "./signal.h"
36 #include "os.h"
37 #include "arch.h"
38 #include "globals.h"
39 #include "sbcl.h"
40 #include "interrupt.h"
41 #include "interr.h"
42 #include "lispregs.h"
43 #include "runtime.h"
44 #include "alloc.h"
45 #include "genesis/primitive-objects.h"
46 #include "dynbind.h"
47
48 #include <sys/types.h>
49 #include <signal.h>
50 #include <sys/time.h>
51 #include <sys/stat.h>
52 #include <unistd.h>
53
54 #include <math.h>
55 #include <float.h>
56
57 #include <excpt.h>
58
59 #include "validate.h"
60 #include "thread.h"
61 size_t os_vm_page_size;
62
63 #include "gc.h"
64 #include "gencgc-internal.h"
65
66 #if 0
67 int linux_sparc_siginfo_bug = 0;
68 int linux_supports_futex=0;
69 #endif
70
71 /* The exception handling function looks like this: */
72 EXCEPTION_DISPOSITION handle_exception(EXCEPTION_RECORD *,
73                                        struct lisp_exception_frame *,
74                                        CONTEXT *,
75                                        void *);
76
77 void *base_seh_frame;
78
79 static void *get_seh_frame(void)
80 {
81     void* retval;
82     asm volatile ("movl %%fs:0,%0": "=r" (retval));
83     return retval;
84 }
85
86 static void set_seh_frame(void *frame)
87 {
88     asm volatile ("movl %0,%%fs:0": : "r" (frame));
89 }
90
91 #if 0
92 static struct lisp_exception_frame *find_our_seh_frame(void)
93 {
94     struct lisp_exception_frame *frame = get_seh_frame();
95
96     while (frame->handler != handle_exception)
97         frame = frame->next_frame;
98
99     return frame;
100 }
101
102 inline static void *get_stack_frame(void)
103 {
104     void* retval;
105     asm volatile ("movl %%ebp,%0": "=r" (retval));
106     return retval;
107 }
108 #endif
109
110 void os_init(char *argv[], char *envp[])
111 {
112     SYSTEM_INFO system_info;
113
114     GetSystemInfo(&system_info);
115     os_vm_page_size = system_info.dwPageSize;
116
117     base_seh_frame = get_seh_frame();
118 }
119
120
121 /*
122  * So we have three fun scenarios here.
123  *
124  * First, we could be being called to reserve the memory areas
125  * during initialization (prior to loading the core file).
126  *
127  * Second, we could be being called by the GC to commit a page
128  * that has just been decommitted (for easy zero-fill).
129  *
130  * Third, we could be being called by create_thread_struct()
131  * in order to create the sundry and various stacks.
132  *
133  * The third case is easy to pick out because it passes an
134  * addr of 0.
135  *
136  * The second case is easy to pick out because it will be for
137  * a range of memory that is MEM_RESERVE rather than MEM_FREE.
138  *
139  * The second case is also an easy implement, because we leave
140  * the memory as reserved (since we do lazy commits).
141  */
142
143 os_vm_address_t
144 os_validate(os_vm_address_t addr, os_vm_size_t len)
145 {
146     MEMORY_BASIC_INFORMATION mem_info;
147
148     if (!addr) {
149         /* the simple case first */
150         os_vm_address_t real_addr;
151         if (!(real_addr = VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE))) {
152             fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
153             return 0;
154         }
155
156         return real_addr;
157     }
158
159     if (!VirtualQuery(addr, &mem_info, sizeof mem_info)) {
160         fprintf(stderr, "VirtualQuery: 0x%lx.\n", GetLastError());
161         return 0;
162     }
163
164     if ((mem_info.State == MEM_RESERVE) && (mem_info.RegionSize >=len)) return addr;
165
166     if (mem_info.State == MEM_RESERVE) {
167         fprintf(stderr, "validation of reserved space too short.\n");
168         fflush(stderr);
169     }
170
171     if (!VirtualAlloc(addr, len, (mem_info.State == MEM_RESERVE)? MEM_COMMIT: MEM_RESERVE, PAGE_EXECUTE_READWRITE)) {
172         fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
173         return 0;
174     }
175
176     return addr;
177 }
178
179 /*
180  * For os_invalidate(), we merely decommit the memory rather than
181  * freeing the address space. This loses when freeing per-thread
182  * data and related memory since it leaks address space. It's not
183  * too lossy, however, since the two scenarios I'm aware of are
184  * fd-stream buffers, which are pooled rather than torched, and
185  * thread information, which I hope to pool (since windows creates
186  * threads at its own whim, and we probably want to be able to
187  * have them callback without funky magic on the part of the user,
188  * and full-on thread allocation is fairly heavyweight). Someone
189  * will probably shoot me down on this with some pithy comment on
190  * the use of (setf symbol-value) on a special variable. I'm happy
191  * for them.
192  */
193
194 void
195 os_invalidate(os_vm_address_t addr, os_vm_size_t len)
196 {
197     if (!VirtualFree(addr, len, MEM_DECOMMIT)) {
198         fprintf(stderr, "VirtualFree: 0x%lx.\n", GetLastError());
199     }
200 }
201
202 /*
203  * os_map() is called to map a chunk of the core file into memory.
204  *
205  * Unfortunately, Windows semantics completely screws this up, so
206  * we just add backing store from the swapfile to where the chunk
207  * goes and read it up like a normal file. We could consider using
208  * a lazy read (demand page) setup, but that would mean keeping an
209  * open file pointer for the core indefinately (and be one more
210  * thing to maintain).
211  */
212
213 os_vm_address_t
214 os_map(int fd, int offset, os_vm_address_t addr, os_vm_size_t len)
215 {
216     os_vm_size_t count;
217
218 #if 0
219     fprintf(stderr, "os_map: %d, 0x%x, %p, 0x%x.\n", fd, offset, addr, len);
220     fflush(stderr);
221 #endif
222
223     if (!VirtualAlloc(addr, len, MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
224         fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
225         lose("os_map: VirtualAlloc failure");
226     }
227
228     if (lseek(fd, offset, SEEK_SET) == -1) {
229         lose("os_map: Seek failure.");
230     }
231
232     count = read(fd, addr, len);
233     if (count != len) {
234         fprintf(stderr, "expected 0x%x, read 0x%x.\n", len, count);
235         lose("os_map: Failed to read enough bytes.");
236     }
237
238     return addr;
239 }
240
241 static DWORD os_protect_modes[8] = {
242     PAGE_NOACCESS,
243     PAGE_READONLY,
244     PAGE_READWRITE,
245     PAGE_READWRITE,
246     PAGE_EXECUTE,
247     PAGE_EXECUTE_READ,
248     PAGE_EXECUTE_READWRITE,
249     PAGE_EXECUTE_READWRITE,
250 };
251
252 void
253 os_protect(os_vm_address_t address, os_vm_size_t length, os_vm_prot_t prot)
254 {
255     DWORD old_prot;
256
257     if (!VirtualProtect(address, length, os_protect_modes[prot], &old_prot)) {
258         fprintf(stderr, "VirtualProtect failed, code 0x%lx.\n", GetLastError());
259         fflush(stderr);
260     }
261 }
262
263 /* FIXME: Now that FOO_END, rather than FOO_SIZE, is the fundamental
264  * description of a space, we could probably punt this and just do
265  * (FOO_START <= x && x < FOO_END) everywhere it's called. */
266 static boolean
267 in_range_p(os_vm_address_t a, lispobj sbeg, size_t slen)
268 {
269     char* beg = (char*)((long)sbeg);
270     char* end = (char*)((long)sbeg) + slen;
271     char* adr = (char*)a;
272     return (adr >= beg && adr < end);
273 }
274
275 boolean
276 is_linkage_table_addr(os_vm_address_t addr)
277 {
278     return in_range_p(addr, LINKAGE_TABLE_SPACE_START, LINKAGE_TABLE_SPACE_END);
279 }
280
281 boolean
282 is_valid_lisp_addr(os_vm_address_t addr)
283 {
284     struct thread *th;
285     if(in_range_p(addr, READ_ONLY_SPACE_START, READ_ONLY_SPACE_SIZE) ||
286        in_range_p(addr, STATIC_SPACE_START   , STATIC_SPACE_SIZE) ||
287        in_range_p(addr, DYNAMIC_SPACE_START  , dynamic_space_size))
288         return 1;
289     for_each_thread(th) {
290         if(((os_vm_address_t)th->control_stack_start <= addr) && (addr < (os_vm_address_t)th->control_stack_end))
291             return 1;
292         if(in_range_p(addr, (unsigned long)th->binding_stack_start, BINDING_STACK_SIZE))
293             return 1;
294     }
295     return 0;
296 }
297
298 /* A tiny bit of interrupt.c state we want our paws on. */
299 extern boolean internal_errors_enabled;
300
301 #ifdef LISP_FEATURE_UD2_BREAKPOINTS
302 #define IS_TRAP_EXCEPTION(exception_record, context) \
303     (((exception_record)->ExceptionCode == EXCEPTION_ILLEGAL_INSTRUCTION) && \
304      (((unsigned short *)((context)->Eip))[0] == 0x0b0f))
305 #define TRAP_CODE_WIDTH 2
306 #else
307 #define IS_TRAP_EXCEPTION(exception_record, context) \
308     ((exception_record)->ExceptionCode == EXCEPTION_BREAKPOINT)
309 #define TRAP_CODE_WIDTH 1
310 #endif
311
312 /*
313  * A good explanation of the exception handling semantics is
314  * http://win32assembly.online.fr/Exceptionhandling.html .
315  */
316
317 EXCEPTION_DISPOSITION
318 handle_exception(EXCEPTION_RECORD *exception_record,
319                  struct lisp_exception_frame *exception_frame,
320                  CONTEXT *context,
321                  void *dispatcher_context)
322 {
323     if (exception_record->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND)) {
324         /* If we're being unwound, be graceful about it. */
325
326         /* Undo any dynamic bindings. */
327         unbind_to_here(exception_frame->bindstack_pointer,
328                        arch_os_get_current_thread());
329
330         return ExceptionContinueSearch;
331     }
332
333     /* For EXCEPTION_ACCESS_VIOLATION only. */
334     void *fault_address = (void *)exception_record->ExceptionInformation[1];
335
336     if (single_stepping &&
337         exception_record->ExceptionCode == EXCEPTION_SINGLE_STEP) {
338         /* We are doing a displaced instruction. At least function
339          * end breakpoints uses this. */
340         restore_breakpoint_from_single_step(context);
341         return ExceptionContinueExecution;
342     }
343
344     if (IS_TRAP_EXCEPTION(exception_record, context)) {
345         unsigned char trap;
346         /* This is just for info in case the monitor wants to print an
347          * approximation. */
348         current_control_stack_pointer =
349             (lispobj *)*os_context_sp_addr(context);
350         /* Unlike some other operating systems, Win32 leaves EIP
351          * pointing to the breakpoint instruction. */
352         context->Eip += TRAP_CODE_WIDTH;
353         /* Now EIP points just after the INT3 byte and aims at the
354          * 'kind' value (eg trap_Cerror). */
355         trap = *(unsigned char *)(*os_context_pc_addr(context));
356         handle_trap(context, trap);
357         /* Done, we're good to go! */
358         return ExceptionContinueExecution;
359     }
360     else if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION &&
361              (is_valid_lisp_addr(fault_address) ||
362               is_linkage_table_addr(fault_address))) {
363         /* Pick off GC-related memory fault next. */
364         MEMORY_BASIC_INFORMATION mem_info;
365
366         if (!VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
367             fprintf(stderr, "VirtualQuery: 0x%lx.\n", GetLastError());
368             lose("handle_exception: VirtualQuery failure");
369         }
370
371         if (mem_info.State == MEM_RESERVE) {
372             /* First use new page, lets get some memory for it. */
373             if (!VirtualAlloc(mem_info.BaseAddress, os_vm_page_size,
374                               MEM_COMMIT, PAGE_EXECUTE_READWRITE)) {
375                 fprintf(stderr, "VirtualAlloc: 0x%lx.\n", GetLastError());
376                 lose("handle_exception: VirtualAlloc failure");
377
378             } else {
379                 /*
380                  * Now, if the page is supposedly write-protected and this
381                  * is a write, tell the gc that it's been hit.
382                  *
383                  * FIXME: Are we supposed to fall-through to the Lisp
384                  * exception handler if the gc doesn't take the wp violation?
385                  */
386                 if (exception_record->ExceptionInformation[0]) {
387                     int index = find_page_index(fault_address);
388                     if ((index != -1) && (page_table[index].write_protected)) {
389                         gencgc_handle_wp_violation(fault_address);
390                     }
391                 }
392                 return ExceptionContinueExecution;
393             }
394
395         } else if (gencgc_handle_wp_violation(fault_address)) {
396             /* gc accepts the wp violation, so resume where we left off. */
397             return ExceptionContinueExecution;
398         }
399
400         /* All else failed, drop through to the lisp-side exception handler. */
401     }
402
403     /*
404      * If we fall through to here then we need to either forward
405      * the exception to the lisp-side exception handler if it's
406      * set up, or drop to LDB.
407      */
408
409     if (internal_errors_enabled) {
410         lispobj context_sap;
411         lispobj exception_record_sap;
412
413         /* We're making the somewhat arbitrary decision that having
414          * internal errors enabled means that lisp has sufficient
415          * marbles to be able to handle exceptions, but exceptions
416          * aren't supposed to happen during cold init or reinit
417          * anyway. */
418
419         fake_foreign_function_call(context);
420
421         /* Allocate the SAP objects while the "interrupts" are still
422          * disabled. */
423         context_sap = alloc_sap(context);
424         exception_record_sap = alloc_sap(exception_record);
425
426         /* The exception system doesn't automatically clear pending
427          * exceptions, so we lose as soon as we execute any FP
428          * instruction unless we do this first. */
429         _clearfp();
430
431         /* Call into lisp to handle things. */
432         funcall2(StaticSymbolFunction(HANDLE_WIN32_EXCEPTION), context_sap,
433                  exception_record_sap);
434
435         /* If Lisp doesn't nlx, we need to put things back. */
436         undo_fake_foreign_function_call(context);
437
438         /* FIXME: HANDLE-WIN32-EXCEPTION should be allowed to decline */
439         return ExceptionContinueExecution;
440     }
441
442     fprintf(stderr, "Exception Code: 0x%lx.\n", exception_record->ExceptionCode);
443     fprintf(stderr, "Faulting IP: 0x%lx.\n", (DWORD)exception_record->ExceptionAddress);
444     if (exception_record->ExceptionCode == EXCEPTION_ACCESS_VIOLATION) {
445         MEMORY_BASIC_INFORMATION mem_info;
446
447         if (VirtualQuery(fault_address, &mem_info, sizeof mem_info)) {
448             fprintf(stderr, "page status: 0x%lx.\n", mem_info.State);
449         }
450
451         fprintf(stderr, "Was writing: %ld, where: 0x%lx.\n",
452                 exception_record->ExceptionInformation[0],
453                 (DWORD)fault_address);
454     }
455
456     fflush(stderr);
457
458     fake_foreign_function_call(context);
459     lose("Exception too early in cold init, cannot continue.");
460
461     /* FIXME: WTF? How are we supposed to end up here? */
462     return ExceptionContinueSearch;
463 }
464
465 void
466 wos_install_interrupt_handlers(struct lisp_exception_frame *handler)
467 {
468     handler->next_frame = get_seh_frame();
469     handler->handler = &handle_exception;
470     set_seh_frame(handler);
471 }
472
473 void bcopy(const void *src, void *dest, size_t n)
474 {
475     MoveMemory(dest, src, n);
476 }
477
478 /*
479  * The stubs below are replacements for the windows versions,
480  * which can -fail- when used in our memory spaces because they
481  * validate the memory spaces they are passed in a way that
482  * denies our exception handler a chance to run.
483  */
484
485 void *memmove(void *dest, const void *src, size_t n)
486 {
487     if (dest < src) {
488         int i;
489         for (i = 0; i < n; i++) *(((char *)dest)+i) = *(((char *)src)+i);
490     } else {
491         while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
492     }
493     return dest;
494 }
495
496 void *memcpy(void *dest, const void *src, size_t n)
497 {
498     while (n--) *(((char *)dest)+n) = *(((char *)src)+n);
499     return dest;
500 }
501
502 char *dirname(char *path)
503 {
504     static char buf[PATH_MAX + 1];
505     size_t pathlen = strlen(path);
506     int i;
507
508     if (pathlen >= sizeof(buf)) {
509         lose("Pathname too long in dirname.\n");
510         return NULL;
511     }
512
513     strcpy(buf, path);
514     for (i = pathlen; i >= 0; --i) {
515         if (buf[i] == '/' || buf[i] == '\\') {
516             buf[i] = '\0';
517             break;
518         }
519     }
520
521     return buf;
522 }
523
524 /* This is a manually-maintained version of ldso_stubs.S. */
525
526 void __stdcall RtlUnwind(void *, void *, void *, void *); /* I don't have winternl.h */
527
528 void scratch(void)
529 {
530     CloseHandle(0);
531     FlushConsoleInputBuffer(0);
532     FormatMessageA(0, 0, 0, 0, 0, 0, 0);
533     FreeLibrary(0);
534     GetACP();
535     GetConsoleCP();
536     GetConsoleOutputCP();
537     GetCurrentProcess();
538     GetExitCodeProcess(0, 0);
539     GetLastError();
540     GetOEMCP();
541     GetProcAddress(0, 0);
542     GetProcessTimes(0, 0, 0, 0, 0);
543     GetSystemTimeAsFileTime(0);
544     LoadLibrary(0);
545     LocalFree(0);
546     PeekConsoleInput(0, 0, 0, 0);
547     PeekNamedPipe(0, 0, 0, 0, 0, 0);
548     ReadFile(0, 0, 0, 0, 0);
549     Sleep(0);
550     WriteFile(0, 0, 0, 0, 0);
551     _get_osfhandle(0);
552     _rmdir(0);
553     _pipe(0,0,0);
554     access(0,0);
555     close(0);
556     dup(0);
557     isatty(0);
558     strerror(42);
559     write(0, 0, 0);
560     RtlUnwind(0, 0, 0, 0);
561     #ifndef LISP_FEATURE_SB_UNICODE
562       CreateDirectoryA(0,0);
563       GetComputerNameA(0, 0);
564       GetCurrentDirectoryA(0,0);
565       GetEnvironmentVariableA(0, 0, 0);
566       GetVersionExA(0);
567       MoveFileA(0,0);
568       SHGetFolderPathA(0, 0, 0, 0, 0);
569       SetCurrentDirectoryA(0);
570       SetEnvironmentVariableA(0, 0);
571     #else
572       CreateDirectoryW(0,0);
573       FormatMessageW(0, 0, 0, 0, 0, 0, 0);
574       GetComputerNameW(0, 0);
575       GetCurrentDirectoryW(0,0);
576       GetEnvironmentVariableW(0, 0, 0);
577       GetVersionExW(0);
578       MoveFileW(0,0);
579       SHGetFolderPathW(0, 0, 0, 0, 0);
580       SetCurrentDirectoryW(0);
581       SetEnvironmentVariableW(0, 0);
582     #endif
583 }
584
585 char *
586 os_get_runtime_executable_path(int external)
587 {
588     char path[MAX_PATH + 1];
589     DWORD bufsize = sizeof(path);
590     DWORD size;
591
592     if ((size = GetModuleFileNameA(NULL, path, bufsize)) == 0)
593         return NULL;
594     else if (size == bufsize && GetLastError() == ERROR_INSUFFICIENT_BUFFER)
595         return NULL;
596
597     return copied_string(path);
598 }
599
600 /* EOF */