2009-07-07 19:32:34 +02:00
|
|
|
//===- llvm/Support/ErrorHandling.h - Callbacks for errors ------*- C++ -*-===//
|
|
|
|
//
|
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This file defines an API used to indicate error conditions.
|
|
|
|
// Callbacks can be registered for these errors through this API.
|
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_SUPPORT_ERRORHANDLING_H
|
|
|
|
#define LLVM_SUPPORT_ERRORHANDLING_H
|
|
|
|
|
|
|
|
#include "llvm/Support/Compiler.h"
|
2009-07-08 11:04:19 +02:00
|
|
|
#include <string>
|
2009-07-07 19:32:34 +02:00
|
|
|
|
|
|
|
namespace llvm {
|
2009-07-08 19:09:18 +02:00
|
|
|
/// An error handler callback.
|
2009-07-07 19:32:34 +02:00
|
|
|
typedef void (*llvm_error_handler_t)(const std::string& reason);
|
|
|
|
|
2009-07-08 19:09:18 +02:00
|
|
|
/// Installs a new error handler: this function will be called whenever a
|
|
|
|
/// serious error is encountered by LLVM.
|
|
|
|
/// If you are using llvm_start_multithreaded, you should register the handler
|
|
|
|
/// before doing that.
|
|
|
|
///
|
|
|
|
/// If no error handler is installed the default is to print the error message
|
|
|
|
/// to stderr, and call exit(1).
|
|
|
|
/// If an error handler is installed then it is the handler's responsibility
|
|
|
|
/// to log the message, it will no longer be printed to stderr.
|
|
|
|
/// If the error handler returns, then exit(1) will be called.
|
2009-07-07 19:32:34 +02:00
|
|
|
void llvm_install_error_handler(llvm_error_handler_t handler);
|
|
|
|
|
2009-07-08 19:09:18 +02:00
|
|
|
/// Restores default error handling behaviour.
|
|
|
|
/// This must not be called between llvm_start_multithreaded() and
|
|
|
|
/// llvm_stop_multithreaded().
|
2009-07-07 19:32:34 +02:00
|
|
|
void llvm_remove_error_handler(void);
|
|
|
|
|
2009-07-08 19:09:18 +02:00
|
|
|
/// Reports a serious error, calling any installed error handler.
|
|
|
|
/// If no error handler is installed the default is to print the message to
|
2009-07-11 22:13:58 +02:00
|
|
|
/// standard error, followed by a newline.
|
2009-07-12 23:01:44 +02:00
|
|
|
/// After the error handler is called this function will call exit(1), it
|
|
|
|
/// does not return.
|
2009-07-07 19:32:34 +02:00
|
|
|
void llvm_report_error(const std::string &reason) NORETURN;
|
|
|
|
|
2009-07-11 22:13:58 +02:00
|
|
|
/// This function calls abort(), and prints the optional message to stderr.
|
|
|
|
/// Call this instead of assert(0), so that compiler knows the path is not
|
|
|
|
/// reachable even for NDEBUG builds.
|
2009-07-14 14:49:22 +02:00
|
|
|
/// Use the LLVM_UNREACHABLE macro instead that adds location info.
|
|
|
|
void llvm_unreachable(const char *msg=0, const char *file=0,
|
|
|
|
unsigned line=0) NORETURN;
|
2009-07-07 19:32:34 +02:00
|
|
|
}
|
|
|
|
|
2009-07-14 14:49:22 +02:00
|
|
|
/// Macro that calls llvm_unreachable with location info and message in
|
|
|
|
/// debug mode. In NDEBUG mode it calls llvm_unreachable with no message.
|
2009-07-08 22:53:28 +02:00
|
|
|
#ifndef NDEBUG
|
2009-07-14 14:49:22 +02:00
|
|
|
#define LLVM_UNREACHABLE(msg) llvm_unreachable(msg, __FILE__, __LINE__)
|
2009-07-08 22:53:28 +02:00
|
|
|
#else
|
|
|
|
#define LLVM_UNREACHABLE(msg) llvm_unreachable()
|
|
|
|
#endif
|
2009-07-08 20:01:40 +02:00
|
|
|
|
2009-07-07 19:32:34 +02:00
|
|
|
#endif
|
|
|
|
|