1 //===- lib/Support/ErrorHandling.cpp - Callbacks for errors ---------------===//
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 defines an API used to indicate fatal error conditions. Non-fatal
11 // errors (most of them) should be handled through LLVMContext.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Support/ErrorHandling.h"
16 #include "llvm-c/ErrorHandling.h"
17 #include "llvm/ADT/SmallVector.h"
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/Config/config.h"
20 #include "llvm/Support/Debug.h"
21 #include "llvm/Support/Errc.h"
22 #include "llvm/Support/Error.h"
23 #include "llvm/Support/Signals.h"
24 #include "llvm/Support/Threading.h"
25 #include "llvm/Support/WindowsError.h"
26 #include "llvm/Support/raw_ostream.h"
32 #if defined(HAVE_UNISTD_H)
42 static fatal_error_handler_t ErrorHandler = nullptr;
43 static void *ErrorHandlerUserData = nullptr;
45 static fatal_error_handler_t BadAllocErrorHandler = nullptr;
46 static void *BadAllocErrorHandlerUserData = nullptr;
48 #if LLVM_ENABLE_THREADS == 1
49 // Mutexes to synchronize installing error handlers and calling error handlers.
50 // Do not use ManagedStatic, or that may allocate memory while attempting to
53 // This usage of std::mutex has to be conditionalized behind ifdefs because
55 // compiler-rt/lib/sanitizer_common/symbolizer/scripts/build_symbolizer.sh
56 // That script attempts to statically link the LLVM symbolizer library with the
57 // STL and hide all of its symbols with 'opt -internalize'. To reduce size, it
58 // cuts out the threading portions of the hermetic copy of libc++ that it
59 // builds. We can remove these ifdefs if that script goes away.
60 static std::mutex ErrorHandlerMutex;
61 static std::mutex BadAllocErrorHandlerMutex;
64 void llvm::install_fatal_error_handler(fatal_error_handler_t handler,
66 #if LLVM_ENABLE_THREADS == 1
67 std::lock_guard<std::mutex> Lock(ErrorHandlerMutex);
69 assert(!ErrorHandler && "Error handler already registered!\n");
70 ErrorHandler = handler;
71 ErrorHandlerUserData = user_data;
74 void llvm::remove_fatal_error_handler() {
75 #if LLVM_ENABLE_THREADS == 1
76 std::lock_guard<std::mutex> Lock(ErrorHandlerMutex);
78 ErrorHandler = nullptr;
79 ErrorHandlerUserData = nullptr;
82 void llvm::report_fatal_error(const char *Reason, bool GenCrashDiag) {
83 report_fatal_error(Twine(Reason), GenCrashDiag);
86 void llvm::report_fatal_error(const std::string &Reason, bool GenCrashDiag) {
87 report_fatal_error(Twine(Reason), GenCrashDiag);
90 void llvm::report_fatal_error(StringRef Reason, bool GenCrashDiag) {
91 report_fatal_error(Twine(Reason), GenCrashDiag);
94 void llvm::report_fatal_error(const Twine &Reason, bool GenCrashDiag) {
95 llvm::fatal_error_handler_t handler = nullptr;
96 void* handlerData = nullptr;
98 // Only acquire the mutex while reading the handler, so as not to invoke a
99 // user-supplied callback under a lock.
100 #if LLVM_ENABLE_THREADS == 1
101 std::lock_guard<std::mutex> Lock(ErrorHandlerMutex);
103 handler = ErrorHandler;
104 handlerData = ErrorHandlerUserData;
108 handler(handlerData, Reason.str(), GenCrashDiag);
110 // Blast the result out to stderr. We don't try hard to make sure this
111 // succeeds (e.g. handling EINTR) and we can't use errs() here because
112 // raw ostreams can call report_fatal_error.
113 SmallVector<char, 64> Buffer;
114 raw_svector_ostream OS(Buffer);
115 OS << "LLVM ERROR: " << Reason << "\n";
116 StringRef MessageStr = OS.str();
117 ssize_t written = ::write(2, MessageStr.data(), MessageStr.size());
118 (void)written; // If something went wrong, we deliberately just give up.
121 // If we reached here, we are failing ungracefully. Run the interrupt handlers
122 // to make sure any special cleanups get done, in particular that we remove
123 // files registered with RemoveFileOnSignal.
124 sys::RunInterruptHandlers();
129 void llvm::install_bad_alloc_error_handler(fatal_error_handler_t handler,
131 #if LLVM_ENABLE_THREADS == 1
132 std::lock_guard<std::mutex> Lock(BadAllocErrorHandlerMutex);
134 assert(!ErrorHandler && "Bad alloc error handler already registered!\n");
135 BadAllocErrorHandler = handler;
136 BadAllocErrorHandlerUserData = user_data;
139 void llvm::remove_bad_alloc_error_handler() {
140 #if LLVM_ENABLE_THREADS == 1
141 std::lock_guard<std::mutex> Lock(BadAllocErrorHandlerMutex);
143 BadAllocErrorHandler = nullptr;
144 BadAllocErrorHandlerUserData = nullptr;
147 void llvm::report_bad_alloc_error(const char *Reason, bool GenCrashDiag) {
148 fatal_error_handler_t Handler = nullptr;
149 void *HandlerData = nullptr;
151 // Only acquire the mutex while reading the handler, so as not to invoke a
152 // user-supplied callback under a lock.
153 #if LLVM_ENABLE_THREADS == 1
154 std::lock_guard<std::mutex> Lock(BadAllocErrorHandlerMutex);
156 Handler = BadAllocErrorHandler;
157 HandlerData = BadAllocErrorHandlerUserData;
161 Handler(HandlerData, Reason, GenCrashDiag);
162 llvm_unreachable("bad alloc handler should not return");
165 #ifdef LLVM_ENABLE_EXCEPTIONS
166 // If exceptions are enabled, make OOM in malloc look like OOM in new.
167 throw std::bad_alloc();
169 // Don't call the normal error handler. It may allocate memory. Directly write
170 // an OOM to stderr and abort.
171 char OOMMessage[] = "LLVM ERROR: out of memory\n";
172 ssize_t written = ::write(2, OOMMessage, strlen(OOMMessage));
178 void llvm::llvm_unreachable_internal(const char *msg, const char *file,
180 // This code intentionally doesn't call the ErrorHandler callback, because
181 // llvm_unreachable is intended to be used to indicate "impossible"
182 // situations, and not legitimate runtime errors.
184 dbgs() << msg << "\n";
185 dbgs() << "UNREACHABLE executed";
187 dbgs() << " at " << file << ":" << line;
190 #ifdef LLVM_BUILTIN_UNREACHABLE
191 // Windows systems and possibly others don't declare abort() to be noreturn,
192 // so use the unreachable builtin to avoid a Clang self-host warning.
193 LLVM_BUILTIN_UNREACHABLE;
197 static void bindingsErrorHandler(void *user_data, const std::string& reason,
198 bool gen_crash_diag) {
199 LLVMFatalErrorHandler handler =
200 LLVM_EXTENSION reinterpret_cast<LLVMFatalErrorHandler>(user_data);
201 handler(reason.c_str());
204 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler) {
205 install_fatal_error_handler(bindingsErrorHandler,
206 LLVM_EXTENSION reinterpret_cast<void *>(Handler));
209 void LLVMResetFatalErrorHandler() {
210 remove_fatal_error_handler();
215 #include <winerror.h>
217 // I'd rather not double the line count of the following.
218 #define MAP_ERR_TO_COND(x, y) \
220 return make_error_code(errc::y)
222 std::error_code llvm::mapWindowsError(unsigned EV) {
224 MAP_ERR_TO_COND(ERROR_ACCESS_DENIED, permission_denied);
225 MAP_ERR_TO_COND(ERROR_ALREADY_EXISTS, file_exists);
226 MAP_ERR_TO_COND(ERROR_BAD_UNIT, no_such_device);
227 MAP_ERR_TO_COND(ERROR_BUFFER_OVERFLOW, filename_too_long);
228 MAP_ERR_TO_COND(ERROR_BUSY, device_or_resource_busy);
229 MAP_ERR_TO_COND(ERROR_BUSY_DRIVE, device_or_resource_busy);
230 MAP_ERR_TO_COND(ERROR_CANNOT_MAKE, permission_denied);
231 MAP_ERR_TO_COND(ERROR_CANTOPEN, io_error);
232 MAP_ERR_TO_COND(ERROR_CANTREAD, io_error);
233 MAP_ERR_TO_COND(ERROR_CANTWRITE, io_error);
234 MAP_ERR_TO_COND(ERROR_CURRENT_DIRECTORY, permission_denied);
235 MAP_ERR_TO_COND(ERROR_DEV_NOT_EXIST, no_such_device);
236 MAP_ERR_TO_COND(ERROR_DEVICE_IN_USE, device_or_resource_busy);
237 MAP_ERR_TO_COND(ERROR_DIR_NOT_EMPTY, directory_not_empty);
238 MAP_ERR_TO_COND(ERROR_DIRECTORY, invalid_argument);
239 MAP_ERR_TO_COND(ERROR_DISK_FULL, no_space_on_device);
240 MAP_ERR_TO_COND(ERROR_FILE_EXISTS, file_exists);
241 MAP_ERR_TO_COND(ERROR_FILE_NOT_FOUND, no_such_file_or_directory);
242 MAP_ERR_TO_COND(ERROR_HANDLE_DISK_FULL, no_space_on_device);
243 MAP_ERR_TO_COND(ERROR_INVALID_ACCESS, permission_denied);
244 MAP_ERR_TO_COND(ERROR_INVALID_DRIVE, no_such_device);
245 MAP_ERR_TO_COND(ERROR_INVALID_FUNCTION, function_not_supported);
246 MAP_ERR_TO_COND(ERROR_INVALID_HANDLE, invalid_argument);
247 MAP_ERR_TO_COND(ERROR_INVALID_NAME, invalid_argument);
248 MAP_ERR_TO_COND(ERROR_LOCK_VIOLATION, no_lock_available);
249 MAP_ERR_TO_COND(ERROR_LOCKED, no_lock_available);
250 MAP_ERR_TO_COND(ERROR_NEGATIVE_SEEK, invalid_argument);
251 MAP_ERR_TO_COND(ERROR_NOACCESS, permission_denied);
252 MAP_ERR_TO_COND(ERROR_NOT_ENOUGH_MEMORY, not_enough_memory);
253 MAP_ERR_TO_COND(ERROR_NOT_READY, resource_unavailable_try_again);
254 MAP_ERR_TO_COND(ERROR_OPEN_FAILED, io_error);
255 MAP_ERR_TO_COND(ERROR_OPEN_FILES, device_or_resource_busy);
256 MAP_ERR_TO_COND(ERROR_OUTOFMEMORY, not_enough_memory);
257 MAP_ERR_TO_COND(ERROR_PATH_NOT_FOUND, no_such_file_or_directory);
258 MAP_ERR_TO_COND(ERROR_BAD_NETPATH, no_such_file_or_directory);
259 MAP_ERR_TO_COND(ERROR_READ_FAULT, io_error);
260 MAP_ERR_TO_COND(ERROR_RETRY, resource_unavailable_try_again);
261 MAP_ERR_TO_COND(ERROR_SEEK, io_error);
262 MAP_ERR_TO_COND(ERROR_SHARING_VIOLATION, permission_denied);
263 MAP_ERR_TO_COND(ERROR_TOO_MANY_OPEN_FILES, too_many_files_open);
264 MAP_ERR_TO_COND(ERROR_WRITE_FAULT, io_error);
265 MAP_ERR_TO_COND(ERROR_WRITE_PROTECT, permission_denied);
266 MAP_ERR_TO_COND(WSAEACCES, permission_denied);
267 MAP_ERR_TO_COND(WSAEBADF, bad_file_descriptor);
268 MAP_ERR_TO_COND(WSAEFAULT, bad_address);
269 MAP_ERR_TO_COND(WSAEINTR, interrupted);
270 MAP_ERR_TO_COND(WSAEINVAL, invalid_argument);
271 MAP_ERR_TO_COND(WSAEMFILE, too_many_files_open);
272 MAP_ERR_TO_COND(WSAENAMETOOLONG, filename_too_long);
274 return std::error_code(EV, std::system_category());