mirror of
https://github.com/Z3Prover/z3
synced 2025-08-26 21:16:02 +00:00
0a93ff515d
* Introduce X-macro-based trace tag definition - Created trace_tags.def to centralize TRACE tag definitions - Each tag includes a symbolic name and description - Set up enum class TraceTag for type-safe usage in TRACE macros * Add script to generate Markdown documentation from trace_tags.def - Python script parses trace_tags.def and outputs trace_tags.md * Refactor TRACE_NEW to prepend TraceTag and pass enum to is_trace_enabled * trace: improve trace tag handling system with hierarchical tagging - Introduce hierarchical tag-class structure: enabling a tag class activates all child tags - Unify TRACE, STRACE, SCTRACE, and CTRACE under enum TraceTag - Implement initial version of trace_tag.def using X(tag, tag_class, description) (class names and descriptions to be refined in a future update) * trace: replace all string-based TRACE tags with enum TraceTag - Migrated all TRACE, STRACE, SCTRACE, and CTRACE macros to use enum TraceTag values instead of raw string literals * trace : add cstring header * trace : Add Markdown documentation generation from trace_tags.def via mk_api_doc.py * trace : rename macro parameter 'class' to 'tag_class' and remove Unicode comment in trace_tags.h. * trace : Add TODO comment for future implementation of tag_class activation * trace : Disable code related to tag_class until implementation is ready (#7663).
87 lines
2.4 KiB
C++
87 lines
2.4 KiB
C++
/*++
|
|
Copyright (c) 2006 Microsoft Corporation
|
|
|
|
Module Name:
|
|
|
|
trace.h
|
|
|
|
Abstract:
|
|
|
|
Trace message support.
|
|
|
|
Author:
|
|
|
|
Leonardo de Moura (leonardo) 2006-09-13.
|
|
|
|
Revision History:
|
|
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include<fstream>
|
|
#include "trace_tags.h"
|
|
|
|
#ifdef SINGLE_THREAD
|
|
# define is_threaded() false
|
|
#else
|
|
bool is_threaded();
|
|
#endif
|
|
|
|
#ifdef SINGLE_THREAD
|
|
#define LOCK_CODE(CODE) CODE;
|
|
#define THREAD_LOCK(CODE) CODE
|
|
|
|
#else
|
|
void verbose_lock();
|
|
void verbose_unlock();
|
|
|
|
#define LOCK_CODE(CODE) \
|
|
{ \
|
|
verbose_lock(); \
|
|
CODE; \
|
|
verbose_unlock(); \
|
|
}
|
|
|
|
#define THREAD_LOCK(CODE) if (is_threaded()) { LOCK_CODE(CODE); } else { CODE; }
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef _TRACE
|
|
extern std::ofstream tout;
|
|
#define TRACE_CODE(CODE) { CODE } ((void) 0 )
|
|
|
|
void enable_trace(const char * tag);
|
|
void enable_all_trace(bool flag);
|
|
void disable_trace(const char * tag);
|
|
bool is_trace_enabled(TraceTag tag);
|
|
void close_trace();
|
|
void open_trace();
|
|
void finalize_trace();
|
|
/*
|
|
ADD_FINALIZER('finalize_trace();')
|
|
*/
|
|
|
|
#else
|
|
#define TRACE_CODE(CODE) ((void) 0)
|
|
|
|
static inline void enable_trace(const char * tag) {}
|
|
static inline void enable_all_trace(bool flag) {}
|
|
static inline void disable_trace(const char * tag) {}
|
|
static inline bool is_trace_enabled(TraceTag tag) { return false; }
|
|
static inline void close_trace() {}
|
|
static inline void open_trace() {}
|
|
static inline void finalize_trace() {}
|
|
#endif
|
|
|
|
#define TRACEH(TAG) tout << "-------- [" << tracetag_to_string(TraceTag::TAG) << "] " << __FUNCTION__ << " " << __FILE__ << ":" << __LINE__ << " ---------\n"
|
|
#define TRACEEND tout << "------------------------------------------------\n"
|
|
#define TRACEBODY(TAG, CODE) TRACEH(TAG); CODE; TRACEEND; tout.flush()
|
|
#define STRACEBODY(CODE) CODE; tout.flush()
|
|
|
|
#define TRACE(TAG, CODE) TRACE_CODE(if (is_trace_enabled(TraceTag::TAG)) { THREAD_LOCK(TRACEBODY(TAG, CODE)); })
|
|
#define STRACE(TAG, CODE) TRACE_CODE(if (is_trace_enabled(TraceTag::TAG)) { THREAD_LOCK(STRACEBODY(CODE)); })
|
|
#define SCTRACE(TAG, COND, CODE) TRACE_CODE(if (is_trace_enabled(TraceTag::TAG) && (COND)) { THREAD_LOCK(STRACEBODY(CODE)); })
|
|
#define CTRACE(TAG, COND, CODE) TRACE_CODE(if (is_trace_enabled(TraceTag::TAG) && (COND)) { THREAD_LOCK(TRACEBODY(TAG, CODE)); })
|