// This file is part of the Luau programming language and is licensed under MIT License; see LICENSE.txt for details #pragma once #include "Luau/Common.h" #include "Luau/Id.h" #include "Luau/UnionFind.h" #include "Luau/VecDeque.h" #include #include #include namespace Luau::EqSat { template class EGraph; template struct Analysis final { N analysis; using D = typename N::Data; D make(const EGraph& egraph, const L& enode) const { return analysis.make(egraph, enode); } void join(D& a, const D& b) { return analysis.join(a, b); } }; /// Each e-class is a set of e-nodes representing equivalent terms from a given language, /// and an e-node is a function symbol paired with a list of children e-classes. template struct EClass final { Id id; std::vector nodes; D data; std::vector> parents; }; /// See . template class EGraph final { Analysis analysis; /// A union-find data structure 𝑈 stores an equivalence relation over e-class ids. UnionFind unionfind; /// The e-class map 𝑀 maps e-class ids to e-classes. All equivalent e-class ids map to the same /// e-class, i.e., 𝑎 ≡id 𝑏 iff 𝑀[𝑎] is the same set as 𝑀[𝑏]. An e-class id 𝑎 is said to refer to the /// e-class 𝑀[find(𝑎)]. std::unordered_map> classes; /// The hashcons 𝐻 is a map from e-nodes to e-class ids. std::unordered_map hashcons; private: void canonicalize(L& enode) { // An e-node 𝑛 is canonical iff 𝑛 = canonicalize(𝑛), where // canonicalize(𝑓(𝑎1, 𝑎2, ...)) = 𝑓(find(𝑎1), find(𝑎2), ...). for (Id& id : enode.operands()) id = find(id); } bool isCanonical(const L& enode) const { bool canonical = true; for (Id id : enode.operands()) canonical &= (id == find(id)); return canonical; } Id makeEClass(const L& enode) { LUAU_ASSERT(isCanonical(enode)); Id id = unionfind.makeSet(); classes.insert_or_assign(id, EClass{ id, {enode}, analysis.make(*this, enode), {}, }); for (Id operand : enode.operands()) get(operand).parents.push_back({enode, id}); hashcons.insert_or_assign(enode, id); return id; } // Looks up for an eclass from a given non-canonicalized `id`. // For a canonicalized eclass, use `get(find(id))` or `egraph[id]`. EClass& get(Id id) { auto it = classes.find(id); LUAU_ASSERT(it != classes.end()); return it->second; } public: Id find(Id id) const { return unionfind.find(id); } std::optional lookup(const L& enode) const { LUAU_ASSERT(isCanonical(enode)); if (auto it = hashcons.find(enode); it != hashcons.end()) return it->second; return std::nullopt; } Id add(L enode) { canonicalize(enode); if (auto id = lookup(enode)) return *id; Id id = makeEClass(enode); // TODO clean = false return id; } void merge(Id id1, Id id2) { id1 = find(id1); id2 = find(id2); if (id1 == id2) return; unionfind.merge(id1, id2); EClass& eclass1 = get(id1); EClass eclass2 = get(id2); classes.erase(id2); analysis.join(eclass1.data, eclass2.data); } EClass& operator[](Id id) { return get(find(id)); } const EClass& operator[](Id id) const { return const_cast(this)->get(find(id)); } }; } // namespace Luau::EqSat