mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-08-20 10:10:21 +00:00
Code Activity

Centralize and document TRACE tags using X-macros (#7657)

Browse source 
* 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).
This commit is contained in:
LeeYoungJoon 2025-05-28 22:31:25 +09:00 • committed by GitHub
parent d766292dab
commit 0a93ff515d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
583 changed files with 8698 additions and 7299 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/ackermannization/ackermannize_bv_tactic.cpp
View file

@ -35,7 +35,7 @@ public:
tactic_report report("ackermannize_bv", *g);
fail_if_unsat_core_generation("ackermannize", g);
fail_if_proof_generation("ackermannize", g);
TRACE("goal", g->display(tout << "in\n"););
TRACE(goal, g->display(tout << "in\n"););
ptr_vector<expr> flas;
const unsigned sz = g->size();
@ -46,7 +46,7 @@ public:
goal_ref resg(alloc(goal, *g, true));
const bool success = lackr.mk_ackermann(resg, m_lemma_limit);
if (!success) { // Just pass on the input unchanged
TRACE("ackermannize", tout << "ackermannize not run due to limit" << std::endl;);
TRACE(ackermannize, tout << "ackermannize not run due to limit" << std::endl;);
result.reset();
result.push_back(g.get());
return;
@ -58,7 +58,7 @@ public:
}
resg->inc_depth();
TRACE("goal", resg->display(tout << "out\n"););
TRACE(goal, resg->display(tout << "out\n"););
}

2
src/ackermannization/ackr_bound_probe.cpp
View file

@ -69,7 +69,7 @@ public:
}
p.prune_non_select();
double total = ackr_helper::calculate_lemma_bound(p.m_fun2terms, p.m_sel2terms);
TRACE("ackermannize", tout << "total=" << total << std::endl;);
TRACE(ackermannize, tout << "total=" << total << std::endl;);
return result(total);
}

16
src/ackermannization/ackr_model_converter.cpp
View file

@ -43,9 +43,9 @@ public:
void get_units(obj_map<expr, bool>& units) override { units.reset(); }
void operator()(model_ref & md) override {
TRACE("ackermannize", tout << (fixed_model? "fixed" : "nonfixed") << "\n";);
CTRACE("ackermannize", md, tout << *md << "\n");
CTRACE("ackermannize", fixed_model, tout << *abstr_model << "\n");
TRACE(ackermannize, tout << (fixed_model? "fixed" : "nonfixed") << "\n";);
CTRACE(ackermannize, md, tout << *md << "\n");
CTRACE(ackermannize, fixed_model, tout << *abstr_model << "\n");
model* new_model = alloc(model, m);
@ -96,7 +96,7 @@ void ackr_model_converter::convert(model * source, model * destination) {
}
void ackr_model_converter::convert_constants(model * source, model * destination) {
TRACE("ackermannize", tout << "converting constants\n";);
TRACE(ackermannize, tout << "converting constants\n";);
obj_map<func_decl, func_interp*> interpretations;
obj_map<app, expr*> array_interpretations;
model_evaluator evaluator(*source);
@ -107,7 +107,7 @@ void ackr_model_converter::convert_constants(model * source, model * destination
func_decl * const c = source->get_constant(i);
app * const term = info->find_term(c);
expr * value = source->get_const_interp(c);
TRACE("ackermannize", tout << mk_ismt2_pp(c, m) << " " << mk_ismt2_pp(term, m) << "\n";);
TRACE(ackermannize, tout << mk_ismt2_pp(c, m) << " " << mk_ismt2_pp(term, m) << "\n";);
if (!term)
destination->register_decl(c, value);
else if (autil.is_select(term))
@ -160,7 +160,7 @@ void ackr_model_converter::add_entry(model_evaluator & evaluator,
void ackr_model_converter::add_entry(model_evaluator & evaluator,
app* term, expr* value,
obj_map<func_decl, func_interp*>& interpretations) {
TRACE("ackermannize", tout << "add_entry"
TRACE(ackermannize, tout << "add_entry"
<< mk_ismt2_pp(term, m, 2)
<< "->"
<< mk_ismt2_pp(value, m, 2) << "\n";);
@ -178,7 +178,7 @@ void ackr_model_converter::add_entry(model_evaluator & evaluator,
args.push_back(evaluator(info->abstract(arg)));
}
if (fi->get_entry(args.data()) == nullptr) {
TRACE("ackermannize",
TRACE(ackermannize,
tout << mk_ismt2_pp(declaration, m) << " args: " << std::endl;
for (expr* arg : args) {
tout << mk_ismt2_pp(arg, m) << std::endl;
@ -187,7 +187,7 @@ void ackr_model_converter::add_entry(model_evaluator & evaluator,
fi->insert_new_entry(args.data(), value);
}
else {
TRACE("ackermannize", tout << "entry already present\n";);
TRACE(ackermannize, tout << "entry already present\n";);
}
}

16
src/ackermannization/lackr.cpp
View file

@ -65,7 +65,7 @@ lbool lackr::operator()() {
if (rv == l_true) {
m_solver->get_model(m_model);
}
CTRACE("ackermannize", rv == l_true, model_smt2_pp(tout << "abstr_model(\n", m, *(m_model.get()), 2); tout << ")\n"; );
CTRACE(ackermannize, rv == l_true, model_smt2_pp(tout << "abstr_model(\n", m, *(m_model.get()), 2); tout << ")\n"; );
return rv;
}
@ -103,7 +103,7 @@ bool lackr::init() {
// Introduce ackermann lemma for the two given terms.
//
bool lackr::ackr(app * const t1, app * const t2) {
TRACE("ackermannize", tout << "ackr " << mk_ismt2_pp(t1, m, 2) << " , " << mk_ismt2_pp(t2, m, 2) << "\n";);
TRACE(ackermannize, tout << "ackr " << mk_ismt2_pp(t1, m, 2) << " , " << mk_ismt2_pp(t2, m, 2) << "\n";);
const unsigned sz = t1->get_num_args();
SASSERT(t2->get_num_args() == sz);
expr_ref_vector eqs(m);
@ -112,7 +112,7 @@ bool lackr::ackr(app * const t1, app * const t2) {
expr * const arg2 = t2->get_arg(i);
if (m.are_equal(arg1, arg2)) continue; // quickly skip syntactically equal
if (m.are_distinct(arg1, arg2)){ // quickly abort if there are two distinct (e.g. numerals)
TRACE("ackermannize", tout << "never eq\n";);
TRACE(ackermannize, tout << "never eq\n";);
return false;
}
eqs.push_back(m.mk_eq(arg1, arg2));
@ -125,7 +125,7 @@ bool lackr::ackr(app * const t1, app * const t2) {
expr_ref cg(m.mk_implies(lhs, rhs), m);
expr_ref cga = m_info->abstract(cg); // constraint needs abstraction due to nested applications
m_simp(cga);
TRACE("ackermannize",
TRACE(ackermannize,
tout << "abstr1 " << mk_ismt2_pp(a1, m, 2) << "\n";
tout << "abstr2 " << mk_ismt2_pp(a2, m, 2) << "\n";
tout << "ackr constr lhs" << mk_ismt2_pp(lhs, m, 2) << "\n";
@ -144,7 +144,7 @@ bool lackr::ackr(app * const t1, app * const t2) {
// Introduce the ackermann lemma for each pair of terms.
//
void lackr::eager_enc() {
TRACE("ackermannize", tout << "#funs: " << m_fun2terms.size() << " #sels: " << m_sel2terms.size() << std::endl;);
TRACE(ackermannize, tout << "#funs: " << m_fun2terms.size() << " #sels: " << m_sel2terms.size() << std::endl;);
for (auto const& [k,v] : m_fun2terms) {
checkpoint();
ackr(v);
@ -227,7 +227,7 @@ void lackr::push_abstraction() {
lbool lackr::eager() {
SASSERT(m_is_init);
push_abstraction();
TRACE("ackermannize", tout << "run sat 0\n"; );
TRACE(ackermannize, tout << "run sat 0\n"; );
lbool rv0 = m_solver->check_sat(0, nullptr);
if (rv0 == l_false) {
return l_false;
@ -236,7 +236,7 @@ lbool lackr::eager() {
expr_ref all = mk_and(m_ackrs);
m_simp(all);
m_solver->assert_expr(all);
TRACE("ackermannize", tout << "run sat all\n"; );
TRACE(ackermannize, tout << "run sat all\n"; );
return m_solver->check_sat(0, nullptr);
}
@ -248,7 +248,7 @@ lbool lackr::lazy() {
while (true) {
m_st.m_it++;
checkpoint();
TRACE("ackermannize", tout << "lazy check: " << m_st.m_it << "\n";);
TRACE(ackermannize, tout << "lazy check: " << m_st.m_it << "\n";);
const lbool r = m_solver->check_sat(0, nullptr);
if (r == l_undef) return l_undef; // give up
if (r == l_false) return l_false; // abstraction unsat

14
src/ackermannization/lackr_model_constructor.cpp
View file

@ -199,12 +199,12 @@ private:
for (unsigned i = 0; i < num; ++i) {
expr * val = nullptr;
const bool b = eval_cached(to_app(args[i]), val); // TODO: OK conversion to_app?
CTRACE("model_constructor", m_conflicts.empty() && !b, tout << "fail arg val(\n" << mk_ismt2_pp(args[i], m, 2) << '\n'; );
CTRACE(model_constructor, m_conflicts.empty() && !b, tout << "fail arg val(\n" << mk_ismt2_pp(args[i], m, 2) << '\n'; );
if (!b) {
// bailing out because args eval failed previously
return false;
}
TRACE("model_constructor", tout <<
TRACE(model_constructor, tout <<
"arg val " << i << "(\n" << mk_ismt2_pp(args[i], m, 2)
<< " : " << mk_ismt2_pp(val, m, 2) << '\n'; );
SASSERT(b);
@ -233,15 +233,15 @@ private:
bool mk_value(app * a) {
if (is_val(a))
return true; // skip numerals
TRACE("model_constructor", tout << "mk_value(\n" << mk_ismt2_pp(a, m, 2) << ")\n";);
TRACE(model_constructor, tout << "mk_value(\n" << mk_ismt2_pp(a, m, 2) << ")\n";);
SASSERT(!m_app2val.contains(a));
expr_ref result(m);
if (!evaluate(a, result))
return false;
TRACE("model_constructor",
TRACE(model_constructor,
tout << "map term(\n" << mk_ismt2_pp(a, m, 2) << "\n->"
<< mk_ismt2_pp(result.get(), m, 2)<< ")\n"; );
CTRACE("model_constructor",
CTRACE(model_constructor,
!is_val(result.get()),
tout << "eval didn't create a constant \n" << mk_ismt2_pp(a, m, 2) << " " << mk_ismt2_pp(result, m, 2) << "\n";
);
@ -284,7 +284,7 @@ private:
SASSERT(vi.source_term);
const bool ok = vi.value == value;
if (!ok) {
TRACE("model_constructor",
TRACE(model_constructor,
tout << "already mapped by(\n" << mk_ismt2_pp(vi.source_term, m, 2) << "\n->"
<< mk_ismt2_pp(vi.value, m, 2) << ")\n"; );
m_conflicts.push_back(std::make_pair(a, vi.source_term));
@ -315,7 +315,7 @@ private:
expr_ref term(m);
term = m.mk_app(a->get_decl(), num, values.data());
m_evaluator->operator() (term, result);
TRACE("model_constructor",
TRACE(model_constructor,
tout << "eval(\n" << mk_ismt2_pp(term.get(), m, 2) << "\n->"
<< mk_ismt2_pp(result.get(), m, 2) << ")\n"; );
return;