1 //===-- sanitizer_win.cc --------------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file is shared between AddressSanitizer and ThreadSanitizer
11 // run-time libraries and implements windows-specific functions from
13 //===----------------------------------------------------------------------===//
15 #include "sanitizer_platform.h"
18 #define WIN32_LEAN_AND_MEAN
26 #include "sanitizer_common.h"
27 #include "sanitizer_libc.h"
28 #include "sanitizer_mutex.h"
29 #include "sanitizer_placement_new.h"
30 #include "sanitizer_stacktrace.h"
32 namespace __sanitizer {
34 #include "sanitizer_syscall_generic.inc"
36 // --------------------- sanitizer_common.h
38 // FIXME: there is an API for getting the system page size (GetSystemInfo or
39 // GetNativeSystemInfo), but if we use it here we get test failures elsewhere.
43 uptr GetMmapGranularity() {
44 return 1U << 16; // FIXME: is this configurable?
47 uptr GetMaxVirtualAddress() {
50 return (uptr)si.lpMaximumApplicationAddress;
53 bool FileExists(const char *filename) {
54 return ::GetFileAttributesA(filename) != INVALID_FILE_ATTRIBUTES;
57 uptr internal_getpid() {
58 return GetProcessId(GetCurrentProcess());
61 // In contrast to POSIX, on Windows GetCurrentThreadId()
62 // returns a system-unique identifier.
64 return GetCurrentThreadId();
67 uptr GetThreadSelf() {
72 void GetThreadStackTopAndBottom(bool at_initialization, uptr *stack_top,
76 MEMORY_BASIC_INFORMATION mbi;
77 CHECK_NE(VirtualQuery(&mbi /* on stack */, &mbi, sizeof(mbi)), 0);
78 // FIXME: is it possible for the stack to not be a single allocation?
79 // Are these values what ASan expects to get (reserved, not committed;
80 // including stack guard page) ?
81 *stack_top = (uptr)mbi.BaseAddress + mbi.RegionSize;
82 *stack_bottom = (uptr)mbi.AllocationBase;
84 #endif // #if !SANITIZER_GO
86 void *MmapOrDie(uptr size, const char *mem_type, bool raw_report) {
87 void *rv = VirtualAlloc(0, size, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
89 ReportMmapFailureAndDie(size, mem_type, "allocate",
90 GetLastError(), raw_report);
94 void UnmapOrDie(void *addr, uptr size) {
98 if (VirtualFree(addr, size, MEM_DECOMMIT) == 0) {
99 Report("ERROR: %s failed to "
100 "deallocate 0x%zx (%zd) bytes at address %p (error code: %d)\n",
101 SanitizerToolName, size, size, addr, GetLastError());
102 CHECK("unable to unmap" && 0);
106 void *MmapFixedNoReserve(uptr fixed_addr, uptr size, const char *name) {
107 // FIXME: is this really "NoReserve"? On Win32 this does not matter much,
108 // but on Win64 it does.
109 (void)name; // unsupported
110 void *p = VirtualAlloc((LPVOID)fixed_addr, size,
111 MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
113 Report("ERROR: %s failed to "
114 "allocate %p (%zd) bytes at %p (error code: %d)\n",
115 SanitizerToolName, size, size, fixed_addr, GetLastError());
119 void *MmapFixedOrDie(uptr fixed_addr, uptr size) {
120 return MmapFixedNoReserve(fixed_addr, size);
123 void *MmapNoReserveOrDie(uptr size, const char *mem_type) {
124 // FIXME: make this really NoReserve?
125 return MmapOrDie(size, mem_type);
128 void *MmapNoAccess(uptr fixed_addr, uptr size, const char *name) {
129 (void)name; // unsupported
130 void *res = VirtualAlloc((LPVOID)fixed_addr, size,
131 MEM_RESERVE | MEM_COMMIT, PAGE_NOACCESS);
133 Report("WARNING: %s failed to "
134 "mprotect %p (%zd) bytes at %p (error code: %d)\n",
135 SanitizerToolName, size, size, fixed_addr, GetLastError());
139 bool MprotectNoAccess(uptr addr, uptr size) {
140 DWORD old_protection;
141 return VirtualProtect((LPVOID)addr, size, PAGE_NOACCESS, &old_protection);
145 void FlushUnneededShadowMemory(uptr addr, uptr size) {
146 // This is almost useless on 32-bits.
147 // FIXME: add madvise-analog when we move to 64-bits.
150 void NoHugePagesInRegion(uptr addr, uptr size) {
151 // FIXME: probably similar to FlushUnneededShadowMemory.
154 void DontDumpShadowMemory(uptr addr, uptr length) {
155 // This is almost useless on 32-bits.
156 // FIXME: add madvise-analog when we move to 64-bits.
159 bool MemoryRangeIsAvailable(uptr range_start, uptr range_end) {
160 MEMORY_BASIC_INFORMATION mbi;
161 CHECK(VirtualQuery((void *)range_start, &mbi, sizeof(mbi)));
162 return mbi.Protect == PAGE_NOACCESS &&
163 (uptr)mbi.BaseAddress + mbi.RegionSize >= range_end;
166 void *MapFileToMemory(const char *file_name, uptr *buff_size) {
170 void *MapWritableFileToMemory(void *addr, uptr size, fd_t fd, OFF_T offset) {
174 static const int kMaxEnvNameLength = 128;
175 static const DWORD kMaxEnvValueLength = 32767;
180 char name[kMaxEnvNameLength];
181 char value[kMaxEnvValueLength];
186 static const int kEnvVariables = 5;
187 static EnvVariable env_vars[kEnvVariables];
188 static int num_env_vars;
190 const char *GetEnv(const char *name) {
191 // Note: this implementation caches the values of the environment variables
192 // and limits their quantity.
193 for (int i = 0; i < num_env_vars; i++) {
194 if (0 == internal_strcmp(name, env_vars[i].name))
195 return env_vars[i].value;
197 CHECK_LT(num_env_vars, kEnvVariables);
198 DWORD rv = GetEnvironmentVariableA(name, env_vars[num_env_vars].value,
200 if (rv > 0 && rv < kMaxEnvValueLength) {
201 CHECK_LT(internal_strlen(name), kMaxEnvNameLength);
202 internal_strncpy(env_vars[num_env_vars].name, name, kMaxEnvNameLength);
204 return env_vars[num_env_vars - 1].value;
209 const char *GetPwd() {
219 const char *filepath;
225 int CompareModulesBase(const void *pl, const void *pr) {
226 const ModuleInfo *l = (ModuleInfo *)pl, *r = (ModuleInfo *)pr;
227 if (l->base_address < r->base_address)
229 return l->base_address > r->base_address;
235 void DumpProcessMap() {
236 Report("Dumping process modules:\n");
237 InternalScopedBuffer<LoadedModule> modules(kMaxNumberOfModules);
239 GetListOfModules(modules.data(), kMaxNumberOfModules, nullptr);
241 InternalScopedBuffer<ModuleInfo> module_infos(num_modules);
242 for (size_t i = 0; i < num_modules; ++i) {
243 module_infos[i].filepath = modules[i].full_name();
244 module_infos[i].base_address = modules[i].base_address();
245 module_infos[i].end_address = modules[i].ranges().next()->end;
247 qsort(module_infos.data(), num_modules, sizeof(ModuleInfo),
250 for (size_t i = 0; i < num_modules; ++i) {
251 const ModuleInfo &mi = module_infos[i];
252 if (mi.end_address != 0) {
253 Printf("\t%p-%p %s\n", mi.base_address, mi.end_address,
254 mi.filepath[0] ? mi.filepath : "[no name]");
255 } else if (mi.filepath[0]) {
256 Printf("\t??\?-??? %s\n", mi.filepath);
264 void DisableCoreDumperIfNecessary() {
272 void PrepareForSandboxing(__sanitizer_sandbox_arguments *args) {
274 CovPrepareForSandboxing(args);
278 bool StackSizeIsUnlimited() {
282 void SetStackSizeLimitInBytes(uptr limit) {
286 bool AddressSpaceIsUnlimited() {
290 void SetAddressSpaceUnlimited() {
294 bool IsPathSeparator(const char c) {
295 return c == '\\' || c == '/';
298 bool IsAbsolutePath(const char *path) {
302 void SleepForSeconds(int seconds) {
303 Sleep(seconds * 1000);
306 void SleepForMillis(int millis) {
315 if (::IsDebuggerPresent())
320 // Read the file to extract the ImageBase field from the PE header. If ASLR is
321 // disabled and this virtual address is available, the loader will typically
322 // load the image at this address. Therefore, we call it the preferred base. Any
323 // addresses in the DWARF typically assume that the object has been loaded at
325 static uptr GetPreferredBase(const char *modname) {
326 fd_t fd = OpenFile(modname, RdOnly, nullptr);
327 if (fd == kInvalidFd)
329 FileCloser closer(fd);
331 // Read just the DOS header.
332 IMAGE_DOS_HEADER dos_header;
334 if (!ReadFromFile(fd, &dos_header, sizeof(dos_header), &bytes_read) ||
335 bytes_read != sizeof(dos_header))
338 // The file should start with the right signature.
339 if (dos_header.e_magic != IMAGE_DOS_SIGNATURE)
342 // The layout at e_lfanew is:
345 // IMAGE_OPTIONAL_HEADER
346 // Seek to e_lfanew and read all that data.
347 char buf[4 + sizeof(IMAGE_FILE_HEADER) + sizeof(IMAGE_OPTIONAL_HEADER)];
348 if (::SetFilePointer(fd, dos_header.e_lfanew, nullptr, FILE_BEGIN) ==
349 INVALID_SET_FILE_POINTER)
351 if (!ReadFromFile(fd, &buf[0], sizeof(buf), &bytes_read) ||
352 bytes_read != sizeof(buf))
355 // Check for "PE\0\0" before the PE header.
356 char *pe_sig = &buf[0];
357 if (internal_memcmp(pe_sig, "PE\0\0", 4) != 0)
360 // Skip over IMAGE_FILE_HEADER. We could do more validation here if we wanted.
361 IMAGE_OPTIONAL_HEADER *pe_header =
362 (IMAGE_OPTIONAL_HEADER *)(pe_sig + 4 + sizeof(IMAGE_FILE_HEADER));
364 // Check for more magic in the PE header.
365 if (pe_header->Magic != IMAGE_NT_OPTIONAL_HDR_MAGIC)
368 // Finally, return the ImageBase.
369 return (uptr)pe_header->ImageBase;
373 uptr GetListOfModules(LoadedModule *modules, uptr max_modules,
374 string_predicate_t filter) {
375 HANDLE cur_process = GetCurrentProcess();
377 // Query the list of modules. Start by assuming there are no more than 256
378 // modules and retry if that's not sufficient.
379 HMODULE *hmodules = 0;
380 uptr modules_buffer_size = sizeof(HMODULE) * 256;
381 DWORD bytes_required;
383 hmodules = (HMODULE *)MmapOrDie(modules_buffer_size, __FUNCTION__);
384 CHECK(EnumProcessModules(cur_process, hmodules, modules_buffer_size,
386 if (bytes_required > modules_buffer_size) {
387 // Either there turned out to be more than 256 hmodules, or new hmodules
388 // could have loaded since the last try. Retry.
389 UnmapOrDie(hmodules, modules_buffer_size);
391 modules_buffer_size = bytes_required;
395 // |num_modules| is the number of modules actually present,
396 // |count| is the number of modules we return.
397 size_t nun_modules = bytes_required / sizeof(HMODULE),
399 for (size_t i = 0; i < nun_modules && count < max_modules; ++i) {
400 HMODULE handle = hmodules[i];
402 if (!GetModuleInformation(cur_process, handle, &mi, sizeof(mi)))
405 // Get the UTF-16 path and convert to UTF-8.
406 wchar_t modname_utf16[kMaxPathLength];
407 int modname_utf16_len =
408 GetModuleFileNameW(handle, modname_utf16, kMaxPathLength);
409 if (modname_utf16_len == 0)
410 modname_utf16[0] = '\0';
411 char module_name[kMaxPathLength];
412 int module_name_len =
413 ::WideCharToMultiByte(CP_UTF8, 0, modname_utf16, modname_utf16_len + 1,
414 &module_name[0], kMaxPathLength, NULL, NULL);
415 module_name[module_name_len] = '\0';
417 if (filter && !filter(module_name))
420 uptr base_address = (uptr)mi.lpBaseOfDll;
421 uptr end_address = (uptr)mi.lpBaseOfDll + mi.SizeOfImage;
423 // Adjust the base address of the module so that we get a VA instead of an
424 // RVA when computing the module offset. This helps llvm-symbolizer find the
425 // right DWARF CU. In the common case that the image is loaded at it's
426 // preferred address, we will now print normal virtual addresses.
427 uptr preferred_base = GetPreferredBase(&module_name[0]);
428 uptr adjusted_base = base_address - preferred_base;
430 LoadedModule *cur_module = &modules[count];
431 cur_module->set(module_name, adjusted_base);
432 // We add the whole module as one single address range.
433 cur_module->addAddressRange(base_address, end_address, /*executable*/ true);
436 UnmapOrDie(hmodules, modules_buffer_size);
441 // We can't use atexit() directly at __asan_init time as the CRT is not fully
442 // initialized at this point. Place the functions into a vector and use
443 // atexit() as soon as it is ready for use (i.e. after .CRT$XIC initializers).
444 InternalMmapVectorNoCtor<void (*)(void)> atexit_functions;
446 int Atexit(void (*function)(void)) {
447 atexit_functions.push_back(function);
451 static int RunAtexit() {
453 for (uptr i = 0; i < atexit_functions.size(); ++i) {
454 ret |= atexit(atexit_functions[i]);
459 #pragma section(".CRT$XID", long, read) // NOLINT
460 __declspec(allocate(".CRT$XID")) int (*__run_atexit)() = RunAtexit;
463 // ------------------ sanitizer_libc.h
464 fd_t OpenFile(const char *filename, FileAccessMode mode, error_t *last_error) {
466 if (mode == RdOnly) {
467 res = CreateFile(filename, GENERIC_READ,
468 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
469 nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr);
470 } else if (mode == WrOnly) {
471 res = CreateFile(filename, GENERIC_WRITE, 0, nullptr, CREATE_ALWAYS,
472 FILE_ATTRIBUTE_NORMAL, nullptr);
476 CHECK(res != kStdoutFd || kStdoutFd == kInvalidFd);
477 CHECK(res != kStderrFd || kStderrFd == kInvalidFd);
478 if (res == kInvalidFd && last_error)
479 *last_error = GetLastError();
483 void CloseFile(fd_t fd) {
487 bool ReadFromFile(fd_t fd, void *buff, uptr buff_size, uptr *bytes_read,
489 CHECK(fd != kInvalidFd);
491 // bytes_read can't be passed directly to ReadFile:
492 // uptr is unsigned long long on 64-bit Windows.
493 unsigned long num_read_long;
495 bool success = ::ReadFile(fd, buff, buff_size, &num_read_long, nullptr);
496 if (!success && error_p)
497 *error_p = GetLastError();
499 *bytes_read = num_read_long;
503 bool SupportsColoredOutput(fd_t fd) {
504 // FIXME: support colored output.
508 bool WriteToFile(fd_t fd, const void *buff, uptr buff_size, uptr *bytes_written,
510 CHECK(fd != kInvalidFd);
512 // Handle null optional parameters.
514 error_p = error_p ? error_p : &dummy_error;
515 uptr dummy_bytes_written;
516 bytes_written = bytes_written ? bytes_written : &dummy_bytes_written;
518 // Initialize output parameters in case we fail.
522 // Map the conventional Unix fds 1 and 2 to Windows handles. They might be
523 // closed, in which case this will fail.
524 if (fd == kStdoutFd || fd == kStderrFd) {
525 fd = GetStdHandle(fd == kStdoutFd ? STD_OUTPUT_HANDLE : STD_ERROR_HANDLE);
527 *error_p = ERROR_INVALID_HANDLE;
532 DWORD bytes_written_32;
533 if (!WriteFile(fd, buff, buff_size, &bytes_written_32, 0)) {
534 *error_p = GetLastError();
537 *bytes_written = bytes_written_32;
542 bool RenameFile(const char *oldpath, const char *newpath, error_t *error_p) {
546 uptr internal_sched_yield() {
551 void internal__exit(int exitcode) {
552 ExitProcess(exitcode);
555 uptr internal_ftruncate(fd_t fd, uptr size) {
563 void *internal_start_thread(void (*func)(void *arg), void *arg) { return 0; }
564 void internal_join_thread(void *th) { }
566 // ---------------------- BlockingMutex ---------------- {{{1
567 const uptr LOCK_UNINITIALIZED = 0;
568 const uptr LOCK_READY = (uptr)-1;
570 BlockingMutex::BlockingMutex(LinkerInitialized li) {
571 // FIXME: see comments in BlockingMutex::Lock() for the details.
572 CHECK(li == LINKER_INITIALIZED || owner_ == LOCK_UNINITIALIZED);
574 CHECK(sizeof(CRITICAL_SECTION) <= sizeof(opaque_storage_));
575 InitializeCriticalSection((LPCRITICAL_SECTION)opaque_storage_);
579 BlockingMutex::BlockingMutex() {
580 CHECK(sizeof(CRITICAL_SECTION) <= sizeof(opaque_storage_));
581 InitializeCriticalSection((LPCRITICAL_SECTION)opaque_storage_);
585 void BlockingMutex::Lock() {
586 if (owner_ == LOCK_UNINITIALIZED) {
587 // FIXME: hm, global BlockingMutex objects are not initialized?!?
588 // This might be a side effect of the clang+cl+link Frankenbuild...
589 new(this) BlockingMutex((LinkerInitialized)(LINKER_INITIALIZED + 1));
591 // FIXME: If it turns out the linker doesn't invoke our
592 // constructors, we should probably manually Lock/Unlock all the global
593 // locks while we're starting in one thread to avoid double-init races.
595 EnterCriticalSection((LPCRITICAL_SECTION)opaque_storage_);
596 CHECK_EQ(owner_, LOCK_READY);
597 owner_ = GetThreadSelf();
600 void BlockingMutex::Unlock() {
601 CHECK_EQ(owner_, GetThreadSelf());
603 LeaveCriticalSection((LPCRITICAL_SECTION)opaque_storage_);
606 void BlockingMutex::CheckLocked() {
607 CHECK_EQ(owner_, GetThreadSelf());
617 void GetThreadStackAndTls(bool main, uptr *stk_addr, uptr *stk_size,
618 uptr *tls_addr, uptr *tls_size) {
625 uptr stack_top, stack_bottom;
626 GetThreadStackTopAndBottom(main, &stack_top, &stack_bottom);
627 *stk_addr = stack_bottom;
628 *stk_size = stack_top - stack_bottom;
635 void BufferedStackTrace::SlowUnwindStack(uptr pc, u32 max_depth) {
636 CHECK_GE(max_depth, 2);
637 // FIXME: CaptureStackBackTrace might be too slow for us.
638 // FIXME: Compare with StackWalk64.
639 // FIXME: Look at LLVMUnhandledExceptionFilter in Signals.inc
640 size = CaptureStackBackTrace(2, Min(max_depth, kStackTraceMax),
645 // Skip the RTL frames by searching for the PC in the stacktrace.
646 uptr pc_location = LocatePcInTrace(pc);
647 PopStackFrames(pc_location);
650 void BufferedStackTrace::SlowUnwindStackWithContext(uptr pc, void *context,
652 CONTEXT ctx = *(CONTEXT *)context;
653 STACKFRAME64 stack_frame;
654 memset(&stack_frame, 0, sizeof(stack_frame));
657 int machine_type = IMAGE_FILE_MACHINE_AMD64;
658 stack_frame.AddrPC.Offset = ctx.Rip;
659 stack_frame.AddrFrame.Offset = ctx.Rbp;
660 stack_frame.AddrStack.Offset = ctx.Rsp;
662 int machine_type = IMAGE_FILE_MACHINE_I386;
663 stack_frame.AddrPC.Offset = ctx.Eip;
664 stack_frame.AddrFrame.Offset = ctx.Ebp;
665 stack_frame.AddrStack.Offset = ctx.Esp;
667 stack_frame.AddrPC.Mode = AddrModeFlat;
668 stack_frame.AddrFrame.Mode = AddrModeFlat;
669 stack_frame.AddrStack.Mode = AddrModeFlat;
670 while (StackWalk64(machine_type, GetCurrentProcess(), GetCurrentThread(),
671 &stack_frame, &ctx, NULL, &SymFunctionTableAccess64,
672 &SymGetModuleBase64, NULL) &&
673 size < Min(max_depth, kStackTraceMax)) {
674 trace_buffer[size++] = (uptr)stack_frame.AddrPC.Offset;
677 #endif // #if !SANITIZER_GO
679 void ReportFile::Write(const char *buffer, uptr length) {
682 if (!WriteToFile(fd, buffer, length)) {
683 // stderr may be closed, but we may be able to print to the debugger
684 // instead. This is the case when launching a program from Visual Studio,
685 // and the following routine should write to its console.
686 OutputDebugStringA(buffer);
690 void SetAlternateSignalStack() {
691 // FIXME: Decide what to do on Windows.
694 void UnsetAlternateSignalStack() {
695 // FIXME: Decide what to do on Windows.
698 void InstallDeadlySignalHandlers(SignalHandlerType handler) {
700 // FIXME: Decide what to do on Windows.
703 bool IsDeadlySignal(int signum) {
704 // FIXME: Decide what to do on Windows.
708 bool IsAccessibleMemoryRange(uptr beg, uptr size) {
710 GetNativeSystemInfo(&si);
711 uptr page_size = si.dwPageSize;
712 uptr page_mask = ~(page_size - 1);
714 for (uptr page = beg & page_mask, end = (beg + size - 1) & page_mask;
716 MEMORY_BASIC_INFORMATION info;
717 if (VirtualQuery((LPCVOID)page, &info, sizeof(info)) != sizeof(info))
720 if (info.Protect == 0 || info.Protect == PAGE_NOACCESS ||
721 info.Protect == PAGE_EXECUTE)
724 if (info.RegionSize == 0)
727 page += info.RegionSize;
733 SignalContext SignalContext::Create(void *siginfo, void *context) {
734 EXCEPTION_RECORD *exception_record = (EXCEPTION_RECORD*)siginfo;
735 CONTEXT *context_record = (CONTEXT*)context;
737 uptr pc = (uptr)exception_record->ExceptionAddress;
739 uptr bp = (uptr)context_record->Rbp;
740 uptr sp = (uptr)context_record->Rsp;
742 uptr bp = (uptr)context_record->Ebp;
743 uptr sp = (uptr)context_record->Esp;
745 uptr access_addr = exception_record->ExceptionInformation[1];
747 return SignalContext(context, access_addr, pc, sp, bp);
750 uptr ReadBinaryName(/*out*/char *buf, uptr buf_len) {
751 // FIXME: Actually implement this function.
752 CHECK_GT(buf_len, 0);
757 uptr ReadLongProcessName(/*out*/char *buf, uptr buf_len) {
758 return ReadBinaryName(buf, buf_len);
761 void CheckVMASize() {
765 void DisableReexec() {
766 // No need to re-exec on Windows.
770 // No need to re-exec on Windows.
773 } // namespace __sanitizer