mirror of
https://github.com/Z3Prover/z3
synced 2025-04-09 19:01:50 +00:00
111fcb9366
* Implement API to set exit action to exception * Turn on exit_action_to_throw_exception upon API context creation
125 lines
3.9 KiB
C++
125 lines
3.9 KiB
C++
/*++
|
|
Copyright (c) 2006 Microsoft Corporation
|
|
|
|
Module Name:
|
|
|
|
debug.h
|
|
|
|
Abstract:
|
|
|
|
Basic debugging support.
|
|
|
|
Author:
|
|
|
|
Leonardo de Moura (leonardo) 2006-09-11.
|
|
|
|
Revision History:
|
|
|
|
--*/
|
|
#pragma once
|
|
|
|
#include <stdlib.h>
|
|
#include <iostream>
|
|
|
|
void enable_assertions(bool f);
|
|
bool assertions_enabled();
|
|
|
|
enum class debug_action {
|
|
ask,
|
|
cont,
|
|
abort,
|
|
stop,
|
|
throw_exception,
|
|
invoke_debugger,
|
|
};
|
|
debug_action get_default_debug_action();
|
|
void set_default_debug_action(debug_action a);
|
|
|
|
enum class exit_action {
|
|
exit,
|
|
throw_exception,
|
|
};
|
|
exit_action get_default_exit_action();
|
|
void set_default_exit_action(exit_action a);
|
|
void invoke_exit_action(unsigned int code);
|
|
|
|
#include "util/error_codes.h"
|
|
#include "util/warning.h"
|
|
|
|
#ifdef Z3DEBUG
|
|
#define DEBUG_CODE(CODE) { CODE } ((void) 0)
|
|
#else
|
|
#define DEBUG_CODE(CODE) ((void) 0)
|
|
#endif
|
|
|
|
#ifdef __APPLE__
|
|
#include <TargetConditionals.h>
|
|
#if !TARGET_OS_OSX
|
|
#define NO_Z3_DEBUGGER
|
|
#endif
|
|
#endif
|
|
|
|
#ifdef __EMSCRIPTEN__
|
|
#define NO_Z3_DEBUGGER
|
|
#endif
|
|
|
|
#ifdef NO_Z3_DEBUGGER
|
|
#define INVOKE_DEBUGGER() invoke_exit_action(ERR_INTERNAL_FATAL)
|
|
#else
|
|
#ifdef _WINDOWS
|
|
#define INVOKE_DEBUGGER() __debugbreak()
|
|
#else
|
|
void invoke_gdb();
|
|
#define INVOKE_DEBUGGER() invoke_gdb()
|
|
#endif
|
|
#endif
|
|
|
|
void notify_assertion_violation(const char * file_name, int line, const char * condition);
|
|
void enable_debug(const char * tag);
|
|
void disable_debug(const char * tag);
|
|
bool is_debug_enabled(const char * tag);
|
|
|
|
|
|
#define SASSERT(COND) DEBUG_CODE(if (assertions_enabled() && !(COND)) { notify_assertion_violation(__FILE__, __LINE__, #COND); INVOKE_DEBUGGER(); })
|
|
#define CASSERT(TAG, COND) DEBUG_CODE(if (assertions_enabled() && is_debug_enabled(TAG) && !(COND)) { notify_assertion_violation(__FILE__, __LINE__, #COND); INVOKE_DEBUGGER(); })
|
|
#define XASSERT(COND, EXTRA_CODE) DEBUG_CODE(if (assertions_enabled() && !(COND)) { notify_assertion_violation(__FILE__, __LINE__, #COND); { EXTRA_CODE } INVOKE_DEBUGGER(); })
|
|
|
|
#define SASSERT_EQ(LHS, RHS) \
|
|
DEBUG_CODE(if (assertions_enabled() && !((LHS) == (RHS))) { \
|
|
notify_assertion_violation(__FILE__, __LINE__, #LHS " == " #RHS); \
|
|
std::cerr << "LHS value: " << (LHS) << "\nRHS value: " << (RHS) << "\n"; \
|
|
INVOKE_DEBUGGER(); \
|
|
})
|
|
|
|
#ifdef Z3DEBUG
|
|
# define UNREACHABLE() DEBUG_CODE(notify_assertion_violation(__FILE__, __LINE__, "UNEXPECTED CODE WAS REACHED."); INVOKE_DEBUGGER();)
|
|
#else
|
|
# define UNREACHABLE() { notify_assertion_violation(__FILE__, __LINE__, "UNEXPECTED CODE WAS REACHED."); invoke_exit_action(ERR_UNREACHABLE); } ((void) 0)
|
|
#endif
|
|
|
|
#ifdef Z3DEBUG
|
|
# define NOT_IMPLEMENTED_YET() DEBUG_CODE(notify_assertion_violation(__FILE__, __LINE__, "NOT IMPLEMENTED YET!"); INVOKE_DEBUGGER();)
|
|
#else
|
|
# define NOT_IMPLEMENTED_YET() { notify_assertion_violation(__FILE__, __LINE__, "NOT IMPLEMENTED YET!"); invoke_exit_action(ERR_NOT_IMPLEMENTED_YET); } ((void) 0)
|
|
#endif
|
|
|
|
#define VERIFY(_x_) if (!(_x_)) { \
|
|
notify_assertion_violation(__FILE__, __LINE__, "Failed to verify: " #_x_ "\n"); \
|
|
invoke_exit_action(ERR_UNREACHABLE); \
|
|
}
|
|
|
|
#define VERIFY_EQ(LHS, RHS) \
|
|
if (!((LHS) == (RHS))) { \
|
|
notify_assertion_violation(__FILE__, __LINE__, "Failed to verify: " #LHS " == " #RHS "\n"); \
|
|
std::cerr << "LHS value: " << (LHS) << "\nRHS value: " << (RHS) << "\n"; \
|
|
invoke_exit_action(ERR_UNREACHABLE); \
|
|
}
|
|
|
|
#define ENSURE(_x_) VERIFY(_x_)
|
|
|
|
|
|
void finalize_debug();
|
|
/*
|
|
ADD_FINALIZER('finalize_debug();')
|
|
*/
|