]> gitweb.factorcode.org Git - factor.git/blob - vm/os-windows.cpp
145344d767f860bb6126c865ce46c7f25d8ebef0
[factor.git] / vm / os-windows.cpp
1 #include "master.hpp"
2
3 namespace factor {
4
5 HMODULE hFactorDll;
6
7 bool set_memory_locked(cell base, cell size, bool locked) {
8   int prot = locked ? PAGE_NOACCESS : PAGE_READWRITE;
9   DWORD ignore;
10   int status = VirtualProtect((char*)base, size, prot, &ignore);
11   return status != 0;
12 }
13
14 void factor_vm::init_ffi() {
15   hFactorDll = GetModuleHandle(NULL);
16   if (!hFactorDll)
17     fatal_error("GetModuleHandle() failed", 0);
18 }
19
20 void factor_vm::ffi_dlopen(dll* dll) {
21   dll->handle = LoadLibraryEx((WCHAR*)alien_offset(dll->path), NULL, 0);
22 }
23
24 cell factor_vm::ffi_dlsym(dll* dll, symbol_char* symbol) {
25   return (cell)GetProcAddress(dll ? (HMODULE) dll->handle : hFactorDll,
26                               symbol);
27 }
28
29 cell factor_vm::ffi_dlsym_raw(dll* dll, symbol_char* symbol) {
30   return ffi_dlsym(dll, symbol);
31 }
32
33 void factor_vm::ffi_dlclose(dll* dll) {
34   FreeLibrary((HMODULE) dll->handle);
35   dll->handle = NULL;
36 }
37
38 BOOL factor_vm::windows_stat(vm_char* path) {
39   BY_HANDLE_FILE_INFORMATION bhfi;
40   HANDLE h = CreateFileW(path, GENERIC_READ, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE, NULL,
41                          OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
42
43   if (h == INVALID_HANDLE_VALUE) {
44     // FindFirstFile is the only call that can stat c:\pagefile.sys
45     WIN32_FIND_DATA st;
46     HANDLE h;
47
48     if (INVALID_HANDLE_VALUE == (h = FindFirstFile(path, &st)))
49       return false;
50     FindClose(h);
51     return true;
52   }
53   BOOL ret = GetFileInformationByHandle(h, &bhfi);
54   CloseHandle(h);
55   return ret;
56 }
57
58 // You must free() this yourself.
59 const vm_char* factor_vm::default_image_path() {
60   vm_char full_path[MAX_UNICODE_PATH];
61   vm_char* ptr;
62   vm_char temp_path[MAX_UNICODE_PATH];
63
64   if (!GetModuleFileName(NULL, full_path, MAX_UNICODE_PATH))
65     fatal_error("GetModuleFileName() failed", 0);
66
67   if ((ptr = wcsrchr(full_path, '.')))
68     *ptr = 0;
69
70   wcsncpy(temp_path, full_path, MAX_UNICODE_PATH - 1);
71   size_t full_path_len = wcslen(full_path);
72   if (full_path_len < MAX_UNICODE_PATH - 1)
73     wcsncat(temp_path, L".image", MAX_UNICODE_PATH - full_path_len - 1);
74   temp_path[MAX_UNICODE_PATH - 1] = 0;
75
76   return safe_strdup(temp_path);
77 }
78
79 // You must free() this yourself.
80 const vm_char* factor_vm::vm_executable_path() {
81   vm_char full_path[MAX_UNICODE_PATH];
82   if (!GetModuleFileName(NULL, full_path, MAX_UNICODE_PATH))
83     fatal_error("GetModuleFileName() failed", 0);
84   return safe_strdup(full_path);
85 }
86
87 void factor_vm::primitive_existsp() {
88   vm_char* path = untag_check<byte_array>(ctx->pop())->data<vm_char>();
89   ctx->push(tag_boolean(windows_stat(path)));
90 }
91
92 segment::segment(cell size_, bool executable_p) {
93   size = size_;
94
95   char* mem;
96   cell alloc_size = getpagesize() * 2 + size;
97   if ((mem = (char*)VirtualAlloc(
98            NULL, alloc_size, MEM_COMMIT,
99            executable_p ? PAGE_EXECUTE_READWRITE : PAGE_READWRITE)) ==
100       0) {
101     fatal_error("Out of memory in VirtualAlloc", alloc_size);
102   }
103
104   start = (cell)mem + getpagesize();
105   end = start + size;
106
107   set_border_locked(true);
108 }
109
110 segment::~segment() {
111   SYSTEM_INFO si;
112   GetSystemInfo(&si);
113   if (!VirtualFree((void*)(start - si.dwPageSize), 0, MEM_RELEASE))
114     fatal_error("Segment deallocation failed", 0);
115 }
116
117 long getpagesize() {
118   static long g_pagesize = 0;
119   if (!g_pagesize) {
120     SYSTEM_INFO system_info;
121     GetSystemInfo(&system_info);
122     g_pagesize = system_info.dwPageSize;
123   }
124   return g_pagesize;
125 }
126
127
128 bool move_file(const vm_char* path1, const vm_char* path2) {
129   // MoveFileEx returns FALSE on fail.
130   BOOL val = MoveFileEx((path1), (path2), MOVEFILE_REPLACE_EXISTING);
131   if (val == FALSE) {
132     // MoveFileEx doesn't set errno, which primitive_save_image()
133     // reads the error code from. Instead of converting from
134     // GetLastError() to errno values, we ust set it to the generic
135     // EIO value.
136     errno = EIO;
137   }
138   return val == TRUE;
139 }
140
141 void factor_vm::init_signals() {}
142
143 THREADHANDLE start_thread(void* (*start_routine)(void*), void* args) {
144   return (void*)CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE) start_routine,
145                              args, 0, 0);
146 }
147
148 uint64_t nano_count() {
149   static double scale_factor;
150
151   static uint32_t hi = 0;
152   static uint32_t lo = 0;
153
154   // Note: on older systems QueryPerformanceCounter may be unreliable
155   // until you add /usepmtimer to Boot.ini. I had an issue where two
156   // nano_count calls would show a difference of about 1 second,
157   // while actually about 80 seconds have passed. The /usepmtimer
158   // switch cured the issue on that PC (WinXP Pro SP3 32-bit).
159   // See also http://www.virtualdub.org/blog/pivot/entry.php?id=106
160   LARGE_INTEGER count;
161   BOOL ret = QueryPerformanceCounter(&count);
162   if (ret == 0)
163     fatal_error("QueryPerformanceCounter", 0);
164
165   if (scale_factor == 0.0) {
166     LARGE_INTEGER frequency;
167     BOOL ret = QueryPerformanceFrequency(&frequency);
168     if (ret == 0)
169       fatal_error("QueryPerformanceFrequency", 0);
170     scale_factor = (1000000000.0 / frequency.QuadPart);
171   }
172
173 #ifdef FACTOR_64
174   hi = count.HighPart;
175 #else
176   // On VirtualBox, QueryPerformanceCounter does not increment
177   // the high part every time the low part overflows.  Workaround.
178   if (lo > count.LowPart)
179     hi++;
180 #endif
181   lo = count.LowPart;
182
183   return (uint64_t)((((uint64_t)hi << 32) | (uint64_t)lo) * scale_factor);
184 }
185
186 void sleep_nanos(uint64_t nsec) { Sleep((DWORD)(nsec / 1000000)); }
187
188 typedef enum _EXCEPTION_DISPOSITION {
189   ExceptionContinueExecution = 0,
190   ExceptionContinueSearch = 1,
191   ExceptionNestedException = 2,
192   ExceptionCollidedUnwind = 3
193 } EXCEPTION_DISPOSITION;
194
195 LONG factor_vm::exception_handler(PEXCEPTION_RECORD e, void* frame, PCONTEXT c,
196                                   void* dispatch) {
197   switch (e->ExceptionCode) {
198     case EXCEPTION_ACCESS_VIOLATION:
199       set_memory_protection_error(e->ExceptionInformation[1], c->EIP);
200       dispatch_signal_handler((cell*)&c->ESP, (cell*)&c->EIP,
201                               (cell)factor::memory_signal_handler_impl);
202       break;
203
204     case STATUS_FLOAT_DENORMAL_OPERAND:
205     case STATUS_FLOAT_DIVIDE_BY_ZERO:
206     case STATUS_FLOAT_INEXACT_RESULT:
207     case STATUS_FLOAT_INVALID_OPERATION:
208     case STATUS_FLOAT_OVERFLOW:
209     case STATUS_FLOAT_STACK_CHECK:
210     case STATUS_FLOAT_UNDERFLOW:
211     case STATUS_FLOAT_MULTIPLE_FAULTS:
212     case STATUS_FLOAT_MULTIPLE_TRAPS:
213 #ifdef FACTOR_64
214       signal_fpu_status = fpu_status(MXCSR(c));
215 #else
216       signal_fpu_status = fpu_status(X87SW(c) | MXCSR(c));
217
218       // This seems to have no effect
219       X87SW(c) = 0;
220 #endif
221       MXCSR(c) &= 0xffffffc0;
222       dispatch_signal_handler((cell*)&c->ESP, (cell*)&c->EIP,
223                               (cell)factor::fp_signal_handler_impl);
224       break;
225     default:
226       signal_number = e->ExceptionCode;
227       dispatch_signal_handler((cell*)&c->ESP, (cell*)&c->EIP,
228                               (cell)factor::synchronous_signal_handler_impl);
229       break;
230   }
231   return ExceptionContinueExecution;
232 }
233
234 VM_C_API LONG exception_handler(PEXCEPTION_RECORD e, void* frame, PCONTEXT c,
235                                 void* dispatch) {
236   factor_vm* vm = current_vm_p();
237   if (factor_vm::fatal_erroring_p || !vm)
238     return ExceptionContinueSearch;
239   return vm->exception_handler(e, frame, c, dispatch);
240 }
241
242 // On Unix SIGINT (ctrl-c) automatically interrupts blocking io system
243 // calls. It doesn't on Windows, so we need to manually send some
244 // cancellation requests to unblock the thread.
245 VOID CALLBACK dummy_cb (ULONG_PTR dwParam) { }
246
247 // CancelSynchronousIo is not in Windows XP
248 #if _WIN32_WINNT >= 0x0600
249 static void wake_up_thread(HANDLE thread) {
250   if (!CancelSynchronousIo(thread)) {
251     DWORD err = GetLastError();
252     // CancelSynchronousIo() didn't find anything to cancel, let's try
253     // with QueueUserAPC() instead.
254     if (err == ERROR_NOT_FOUND) {
255       if (!QueueUserAPC(&dummy_cb, thread, NULL)) {
256         fatal_error("QueueUserAPC() failed", GetLastError());
257       }
258     } else {
259       fatal_error("CancelSynchronousIo() failed", err);
260     }
261   }
262 }
263 #else
264 static void wake_up_thread(HANDLE thread) {}
265 #endif
266
267 static BOOL WINAPI ctrl_handler(DWORD dwCtrlType) {
268   switch (dwCtrlType) {
269     case CTRL_C_EVENT: {
270       // The CtrlHandler runs in its own thread without stopping the main
271       // thread. Since in practice nobody uses the multi-VM stuff yet, we just
272       // grab the first VM we can get. This will not be a good idea when we
273       // actually support native threads.
274       FACTOR_ASSERT(thread_vms.size() == 1);
275       factor_vm* vm = thread_vms.begin()->second;
276       vm->enqueue_fep();
277
278       // Before leaving the ctrl_handler, try and wake up the main thread.
279       wake_up_thread(factor::boot_thread);
280       return TRUE;
281     }
282     default:
283       return FALSE;
284   }
285 }
286
287 void open_console() { handle_ctrl_c(); }
288
289 void ignore_ctrl_c() {
290   SetConsoleCtrlHandler(factor::ctrl_handler, FALSE);
291 }
292
293 void handle_ctrl_c() {
294   SetConsoleCtrlHandler(factor::ctrl_handler, TRUE);
295 }
296
297 void lock_console() {}
298
299 void unlock_console() {}
300
301 void close_console() {}
302
303 cell get_thread_pc(THREADHANDLE th) {
304   DWORD suscount = SuspendThread(th);
305   FACTOR_ASSERT(suscount == 0);
306
307   CONTEXT context;
308   memset((void*)&context, 0, sizeof(CONTEXT));
309   context.ContextFlags = CONTEXT_CONTROL;
310   BOOL context_ok = GetThreadContext(th, &context);
311   FACTOR_ASSERT(context_ok);
312
313   suscount = ResumeThread(th);
314   FACTOR_ASSERT(suscount == 1);
315   return context.EIP;
316 }
317
318 void factor_vm::sampler_thread_loop() {
319   LARGE_INTEGER counter, new_counter, units_per_second;
320   DWORD ok;
321
322   ok = QueryPerformanceFrequency(&units_per_second);
323   FACTOR_ASSERT(ok);
324
325   ok = QueryPerformanceCounter(&counter);
326   FACTOR_ASSERT(ok);
327
328   counter.QuadPart *= samples_per_second;
329   while (atomic::load(&sampling_profiler_p)) {
330     SwitchToThread();
331     ok = QueryPerformanceCounter(&new_counter);
332     FACTOR_ASSERT(ok);
333     new_counter.QuadPart *= samples_per_second;
334     cell samples = 0;
335     while (new_counter.QuadPart - counter.QuadPart >
336            units_per_second.QuadPart) {
337       ++samples;
338       counter.QuadPart += units_per_second.QuadPart;
339     }
340     if (samples == 0)
341       continue;
342
343     cell pc = get_thread_pc(thread);
344     enqueue_samples(samples, pc, false);
345   }
346 }
347
348 static DWORD WINAPI sampler_thread_entry(LPVOID parent_vm) {
349   static_cast<factor_vm*>(parent_vm)->sampler_thread_loop();
350   return 0;
351 }
352
353 void factor_vm::start_sampling_profiler_timer() {
354   sampler_thread = CreateThread(NULL, 0, &sampler_thread_entry,
355                                 static_cast<LPVOID>(this), 0, NULL);
356 }
357
358 void factor_vm::end_sampling_profiler_timer() {
359   atomic::store(&sampling_profiler_p, false);
360   DWORD wait_result =
361       WaitForSingleObject(sampler_thread, 3000 * (DWORD) samples_per_second);
362   if (wait_result != WAIT_OBJECT_0)
363     TerminateThread(sampler_thread, 0);
364   CloseHandle(sampler_thread);
365   sampler_thread = NULL;
366 }
367
368 void abort() { ::abort(); }
369
370 }