3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-06-28 00:48:45 +00:00
z3/src/smt/fingerprints.cpp
LeeYoungJoon 0a93ff515d
Centralize and document TRACE tags using X-macros (#7657)
* 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).
2025-05-28 14:31:25 +01:00

174 lines
5.4 KiB
C++

/*++
Copyright (c) 2006 Microsoft Corporation
Module Name:
fingerprints.cpp
Abstract:
<abstract>
Author:
Leonardo de Moura (leonardo) 2007-02-24.
Revision History:
--*/
#include "smt/fingerprints.h"
namespace smt {
fingerprint::fingerprint(region & r, void * d, unsigned d_h, expr* def, unsigned n, enode * const * args):
m_data(d),
m_data_hash(d_h),
m_def(def),
m_num_args(n),
m_args(nullptr) {
m_args = new (r) enode*[n];
memcpy(m_args, args, sizeof(enode*) * n);
}
bool fingerprint_set::fingerprint_eq_proc::operator()(fingerprint const * f1, fingerprint const * f2) const {
if (f1->get_data() != f2->get_data())
return false;
if (f1->get_num_args() != f2->get_num_args())
return false;
unsigned n = f1->get_num_args();
for(unsigned i = 0; i < n; i++)
if (f1->get_arg(i) != f2->get_arg(i))
return false;
return true;
}
fingerprint * fingerprint_set::mk_dummy(void * data, unsigned data_hash, unsigned num_args, enode * const * args) {
m_tmp.reset();
m_tmp.append(num_args, args);
m_dummy.m_data = data;
m_dummy.m_data_hash = data_hash;
m_dummy.m_num_args = num_args;
m_dummy.m_args = m_tmp.data();
return &m_dummy;
}
std::ostream& operator<<(std::ostream& out, fingerprint const& f) {
out << f.get_data_hash() << " " << " num_args " << f.get_num_args() << " ";
for (enode const * arg : f) {
out << " " << arg->get_owner_id();
}
out << "\n";
return out;
}
fingerprint * fingerprint_set::insert(void * data, unsigned data_hash, unsigned num_args, enode * const * args, expr* def) {
struct arg_data {
unsigned data_hash;
enode* const* args;
};
struct khash {
unsigned operator()(arg_data const& d) const {
return d.data_hash;
}
};
struct arghash {
unsigned operator()(arg_data const& d, unsigned i) const {
return d.args[i]->hash();
}
};
arg_data arg_data({ data_hash, args });
khash kh;
arghash ah;
data_hash = get_composite_hash(arg_data, num_args, kh, ah);
fingerprint * d = mk_dummy(data, data_hash, num_args, args);
if (m_set.contains(d))
return nullptr;
for (unsigned i = 0; i < num_args; i++)
d->m_args[i] = d->m_args[i]->get_root();
if (m_set.contains(d)) {
TRACE(fingerprint_bug, tout << "failed: " << *d;);
return nullptr;
}
TRACE(fingerprint_bug, tout << "inserting @" << m_scopes.size() << " " << *d;);
fingerprint * f = new (m_region) fingerprint(m_region, data, data_hash, def, num_args, d->m_args);
m_fingerprints.push_back(f);
m_defs.push_back(def);
m_set.insert(f);
return f;
}
bool fingerprint_set::contains(void * data, unsigned data_hash, unsigned num_args, enode * const * args) {
fingerprint * d = mk_dummy(data, data_hash, num_args, args);
if (m_set.contains(d))
return true;
for (unsigned i = 0; i < num_args; i++)
d->m_args[i] = d->m_args[i]->get_root();
if (m_set.contains(d))
return true;
return false;
}
void fingerprint_set::reset() {
m_set.reset();
m_fingerprints.reset();
m_defs.reset();
}
void fingerprint_set::push_scope() {
m_scopes.push_back(m_fingerprints.size());
}
void fingerprint_set::pop_scope(unsigned num_scopes) {
unsigned lvl = m_scopes.size();
SASSERT(num_scopes <= lvl);
unsigned new_lvl = lvl - num_scopes;
unsigned old_size = m_scopes[new_lvl];
unsigned size = m_fingerprints.size();
if (old_size == 0 && size > 0)
m_set.reset();
else {
for (unsigned i = old_size; i < size; i++)
m_set.erase(m_fingerprints[i]);
}
m_fingerprints.shrink(old_size);
m_defs.shrink(old_size);
m_scopes.shrink(new_lvl);
TRACE(fingerprint_bug, tout << "pop @" << m_scopes.size() << "\n";);
}
void fingerprint_set::display(std::ostream & out) const {
out << "fingerprints:\n";
SASSERT(m_set.size() == m_fingerprints.size());
for (fingerprint const * f : m_fingerprints) {
out << f->get_data() << " " << *f;
}
}
#ifdef Z3DEBUG
/**
\brief Slow function for checking if there is a fingerprint congruent to (data args[0] ... args[num_args-1])
*/
bool fingerprint_set::slow_contains(void const * data, unsigned data_hash, unsigned num_args, enode * const * args) const {
for (fingerprint const* f : m_fingerprints) {
if (f->get_data() != data)
continue;
if (f->get_num_args() != num_args)
continue;
unsigned i = 0;
for (i = 0; i < num_args; i++)
if (f->get_arg(i)->get_root() != args[i]->get_root())
break;
if (i == num_args) {
TRACE(missing_instance_detail, tout << "found instance data: " << data << "=" << *f;);
return true;
}
}
return false;
}
#endif
};