world.cpp

Go to the documentation of this file.

#include "thorin/world.h"
 
#include "thorin/check.h"
#include "thorin/def.h"
#include "thorin/driver.h"
#include "thorin/rewrite.h"
#include "thorin/tuple.h"
 
#include "thorin/analyses/scope.h"
#include "thorin/util/util.h"
 
namespace thorin {
 
namespace {
bool is_shape(Ref s) {
    if (s->isa<Nat>()) return true;
    if (auto arr = s->isa<Arr>()) return arr->body()->isa<Nat>();
    if (auto sig = s->isa_imm<Sigma>()) return std::ranges::all_of(sig->ops(), [](Ref op) { return op->isa<Nat>(); });
 
    return false;
}
 
const Def* infer_sigma(World& world, Defs ops) {
    DefVec elems(ops.size());
    for (size_t i = 0, e = ops.size(); i != e; ++i) elems[i] = ops[i]->type();
    return world.sigma(elems);
}
} // namespace
 
/*
 * constructor & destructor
 */
 
#if (!defined(_MSC_VER) && defined(NDEBUG))
bool World::Lock::guard_ = false;
#endif
 
World::World(Driver* driver, const State& state)
    : driver_(driver)
    , state_(state) {
    data_.univ        = insert<Univ>(0, *this);
    data_.lit_univ_0  = lit_univ(0);
    data_.lit_univ_1  = lit_univ(1);
    data_.type_0      = type(lit_univ_0());
    data_.type_1      = type(lit_univ_1());
    data_.Bot         = insert<thorin::Bot>(0, type());
    data_.sigma       = insert<Sigma>(0, type(), Defs{})->as<Sigma>();
    data_.tuple       = insert<Tuple>(0, sigma(), Defs{})->as<Tuple>();
    data_.type_nat    = insert<thorin::Nat>(0, *this);
    data_.type_idx    = insert<thorin::Idx>(0, pi(type_nat(), type()));
    data_.top_nat     = insert<Top>(0, type_nat());
    data_.lit_nat_0   = lit_nat(0);
    data_.lit_nat_1   = lit_nat(1);
    data_.lit_0_1     = lit_idx(1, 0);
    data_.type_bool   = type_idx(2);
    data_.lit_bool[0] = lit_idx(2, 0_u64);
    data_.lit_bool[1] = lit_idx(2, 1_u64);
    data_.lit_nat_max = lit_nat(nat_t(-1));
    data_.exit        = mut_lam(cn(Bot()))->set(sym("exit"));
}
 
World::World(Driver* driver)
    : World(driver, State()) {}
 
World::~World() {
    for (auto def : move_.defs) def->~Def();
}
 
/*
 * Driver
 */
 
Log& World::log() { return driver().log(); }
Flags& World::flags() { return driver().flags(); }
 
Sym World::sym(const char* s) { return driver().sym(s); }
Sym World::sym(std::string_view s) { return driver().sym(s); }
Sym World::sym(const std::string& s) { return driver().sym(s); }
 
const Def* World::register_annex(flags_t f, const Def* def) {
    auto plugin = Annex::demangle(*this, f);
    if (driver().is_loaded(plugin)) {
        assert_emplace(move_.annexes, f, def);
        return def;
    }
    return nullptr;
}
/*
 * factory methods
 */
 
const Type* World::type(Ref level) {
    if (!level->type()->isa<Univ>())
        error(level, "argument `{}` to `.Type` must be of type `.Univ` but is of type `{}`", level, level->type());
 
    return unify<Type>(1, level)->as<Type>();
}
 
Ref World::uinc(Ref op, level_t offset) {
    if (!op->type()->isa<Univ>())
        error(op, "operand '{}' of a universe increment must be of type `.Univ` but is of type `{}`", op, op->type());
 
    if (auto l = Lit::isa(op)) return lit_univ(*l + 1);
    return unify<UInc>(1, op, offset);
}
 
template<Sort sort> Ref World::umax(Defs ops_) {
    // consume nested umax
    DefVec ops;
    for (auto op : ops_)
        if (auto um = op->isa<UMax>())
            ops.insert(ops.end(), um->ops().begin(), um->ops().end());
        else
            ops.emplace_back(op);
 
    level_t lvl = 0;
    for (auto& op : ops) {
        Ref r = op;
        if (sort == Sort::Term) r = r->unfold_type();
        if (sort <= Sort::Type) r = r->unfold_type();
        if (sort <= Sort::Kind) {
            if (auto type = r->isa<Type>())
                r = type->level();
            else
                error(r, "operand '{}' must be a .Type of some level", r);
        }
 
        if (!r->type()->isa<Univ>())
            error(r, "operand '{}' of a universe max must be of type '.Univ' but is of type '{}'", r, r->type());
 
        op = r;
 
        if (auto l = Lit::isa(op))
            lvl = std::max(lvl, *l);
        else
            lvl = level_t(-1);
    }
 
    const Def* ldef;
    if (lvl != level_t(-1))
        ldef = lit_univ(lvl);
    else {
        std::ranges::sort(ops, [](auto op1, auto op2) { return op1->gid() < op2->gid(); });
        ops.erase(std::unique(ops.begin(), ops.end()), ops.end());
        ldef = unify<UMax>(ops.size(), *this, ops);
    }
 
    return sort == Sort::Univ ? ldef : type(ldef);
}
 
// TODO more thorough & consistent checks for singleton types
 
Ref World::var(Ref type, Def* mut) {
    if (auto s = Idx::size(type)) {
        if (auto l = Lit::isa(s); l && l == 1) return lit_0_1();
    }
 
    if (auto var = mut->var_) return var;
    return mut->var_ = unify<Var>(1, type, mut);
}
 
Ref World::iapp(Ref callee, Ref arg) {
    while (auto pi = callee->type()->isa<Pi>()) {
        if (pi->is_implicit()) {
            auto infer = mut_infer(pi->dom());
            auto a     = app(callee, infer);
            callee     = a;
        } else {
            // resolve Infers now if possible before normalizers are run
            if (auto app = callee->isa<App>(); app && app->curry() == 1) {
                Check::assignable(callee->type()->as<Pi>()->dom(), arg);
                auto apps = decurry(app);
                callee    = apps.front()->callee();
                for (auto app : apps) callee = this->app(callee, Ref::refer(app->arg()));
            }
            break;
        }
    }
 
    return app(callee, arg);
}
 
Ref World::app(Ref callee, Ref arg) {
    Infer::eliminate(Vector<Ref*>{&callee, &arg});
    auto pi = callee->type()->isa<Pi>();
 
    if (!pi) error(callee, "called expression '{}' : '{}' is not of function type", callee, callee->type());
    if (!Check::assignable(pi->dom(), arg))
        error(arg, "cannot pass argument \n'{}' of type \n'{}' to \n'{}' of domain \n'{}'", arg, arg->type(), callee,
              pi->dom());
 
    if (auto imm = callee->isa_imm<Lam>()) return imm->body();
    if (auto lam = callee->isa_mut<Lam>(); lam && lam->is_set() && lam->filter() != lit_ff()) {
        VarRewriter rw(lam->var(), arg);
        if (rw.rewrite(lam->filter()) == lit_tt()) {
            DLOG("partial evaluate: {} ({})", lam, arg);
            return rw.rewrite(lam->body());
        }
    }
 
    auto type = pi->reduce(arg).back();
    return raw_app<true>(type, callee, arg);
}
 
template<bool Normalize> Ref World::raw_app(Ref type, Ref callee, Ref arg) {
    auto [axiom, curry, trip] = Axiom::get(callee);
    if (axiom) {
        curry = curry == 0 ? trip : curry;
        curry = curry == Axiom::Trip_End ? curry : curry - 1;
 
        if (auto normalize = axiom->normalizer(); Normalize && normalize && curry == 0)
            return normalize(type, callee, arg);
    }
 
    return unify<App>(2, axiom, curry, trip, type, callee, arg);
}
 
Ref World::sigma(Defs ops) {
    auto n = ops.size();
    if (n == 0) return sigma();
    if (n == 1) return ops[0];
    if (auto uni = Check::is_uniform(ops)) return arr(n, uni);
    return unify<Sigma>(ops.size(), umax<Sort::Type>(ops), ops);
}
 
Ref World::tuple(Defs ops) {
    if (ops.size() == 1) return ops[0];
 
    auto sigma = infer_sigma(*this, ops);
    auto t     = tuple(sigma, ops);
    if (!Check::assignable(sigma, t))
        error(t, "cannot assign tuple '{}' of type '{}' to incompatible tuple type '{}'", t, t->type(), sigma);
 
    return t;
}
 
Ref World::tuple(Ref type, Defs ops) {
    // TODO type-check type vs inferred type
 
    auto n = ops.size();
    if (!type->isa_mut<Sigma>()) {
        if (n == 0) return tuple();
        if (n == 1) return ops[0];
        if (auto uni = Check::is_uniform(ops)) return pack(n, uni);
    }
 
    if (n != 0) {
        // eta rule for tuples:
        // (extract(tup, 0), extract(tup, 1), extract(tup, 2)) -> tup
        if (auto extract = ops[0]->isa<Extract>()) {
            auto tup = extract->tuple();
            bool eta = tup->type() == type;
            for (size_t i = 0; i != n && eta; ++i) {
                if (auto extract = ops[i]->isa<Extract>()) {
                    if (auto index = Lit::isa(extract->index())) {
                        if (eta &= u64(i) == *index) {
                            eta &= extract->tuple() == tup;
                            continue;
                        }
                    }
                }
                eta = false;
            }
 
            if (eta) return tup;
        }
    }
 
    return unify<Tuple>(ops.size(), type, ops);
}
 
Ref World::tuple(Sym sym) {
    DefVec defs;
    std::ranges::transform(sym, std::back_inserter(defs), [this](auto c) { return lit_i8(c); });
    return tuple(defs);
}
 
Ref World::extract(Ref d, Ref index) {
    assert(d);
    if (index->isa<Tuple>()) {
        auto n   = index->num_ops();
        auto idx = DefVec(n, [&](size_t i) { return index->op(i); });
        auto ops = DefVec(n, [&](size_t i) { return d->proj(n, Lit::as(idx[i])); });
        return tuple(ops);
    } else if (index->isa<Pack>()) {
        auto ops = DefVec(index->as_lit_arity(), [&](size_t) { return extract(d, index->ops().back()); });
        return tuple(ops);
    }
 
    Ref size = Idx::size(index->type());
    Ref type = d->unfold_type();
 
    if (auto l = Lit::isa(size); l && *l == 1) {
        if (auto l = Lit::isa(index); !l || *l != 0) WLOG("unknown Idx of size 1: {}", index);
        if (auto sigma = type->isa_mut<Sigma>(); sigma && sigma->num_ops() == 1) {
            // mut sigmas can be 1-tuples; TODO mutables Arr?
        } else {
            return d;
        }
    }
 
    if (auto pack = d->isa_imm<Pack>()) return pack->body();
 
    if (!Check::alpha(type->arity(), size))
        error(index, "index '{}' does not fit within arity '{}'", index, type->arity());
 
    // extract(insert(x, index, val), index) -> val
    if (auto insert = d->isa<Insert>()) {
        if (index == insert->index()) return insert->value();
    }
 
    if (auto i = Lit::isa(index)) {
        if (auto tuple = d->isa<Tuple>()) return tuple->op(*i);
 
        // extract(insert(x, j, val), i) -> extract(x, i) where i != j (guaranteed by rule above)
        if (auto insert = d->isa<Insert>()) {
            if (insert->index()->isa<Lit>()) return extract(insert->tuple(), index);
        }
 
        if (auto sigma = type->isa<Sigma>()) {
            if (auto mut_sigma = sigma->isa_mut<Sigma>()) {
                auto t = VarRewriter(mut_sigma->var(), d).rewrite(sigma->op(*i));
                return unify<Extract>(2, t, d, index);
            }
 
            return unify<Extract>(2, sigma->op(*i), d, index);
        }
    }
 
    const Def* elem_t;
    if (auto arr = type->isa<Arr>())
        elem_t = arr->reduce(index);
    else
        elem_t = extract(tuple(type->as<Sigma>()->ops()), index);
 
    assert(d);
    return unify<Extract>(2, elem_t, d, index);
}
 
Ref World::insert(Ref d, Ref index, Ref val) {
    auto type = d->unfold_type();
    auto size = Idx::size(index->type());
    auto lidx = Lit::isa(index);
 
    if (!Check::alpha(type->arity(), size))
        error(index, "index '{}' does not fit within arity '{}'", index, type->arity());
 
    if (lidx) {
        auto target_type = type->proj(*lidx);
        if (!Check::assignable(target_type, val))
            error(val, "value of type {} is not assignable to type {}", val->type(), target_type);
    }
 
    if (auto l = Lit::isa(size); l && *l == 1)
        return tuple(d, {val}); // d could be mut - that's why the tuple ctor is needed
 
    // insert((a, b, c, d), 2, x) -> (a, b, x, d)
    if (auto t = d->isa<Tuple>(); t && lidx) return t->refine(*lidx, val);
 
    // insert(‹4; x›, 2, y) -> (x, x, y, x)
    if (auto pack = d->isa<Pack>(); pack && lidx) {
        if (auto a = pack->isa_lit_arity(); a && *a < flags().scalerize_threshold) {
            auto new_ops   = DefVec(*a, pack->body());
            new_ops[*lidx] = val;
            return tuple(type, new_ops);
        }
    }
 
    // insert(insert(x, index, y), index, val) -> insert(x, index, val)
    if (auto insert = d->isa<Insert>()) {
        if (insert->index() == index) d = insert->tuple();
    }
 
    return unify<Insert>(3, d, index, val);
}
 
// TODO merge this code with pack
Ref World::arr(Ref shape, Ref body) {
    if (!is_shape(shape->type())) error(shape, "expected shape but got '{}' of type '{}'", shape, shape->type());
 
    if (auto a = Lit::isa(shape)) {
        if (*a == 0) return sigma();
        if (*a == 1) return body;
    }
 
    // «(a, b)#i; T» -> («a, T», <b, T»)#i
    if (auto ex = shape->isa<Extract>()) {
        if (auto tup = ex->tuple()->isa<Tuple>()) {
            auto arrs = DefVec(tup->num_ops(), [&](size_t i) { return arr(tup->op(i), body); });
            return extract(tuple(arrs), ex->index());
        }
    }
 
    // «(a, b, c); body» -> «a; «(b, c); body»»
    if (auto tuple = shape->isa<Tuple>()) return arr(tuple->ops().front(), arr(tuple->ops().subspan(1), body));
 
    // «<n; x>; body» -> «x; «<n-1, x>; body»»
    if (auto p = shape->isa<Pack>()) {
        if (auto s = Lit::isa(p->shape())) return arr(*s, arr(pack(*s - 1, p->body()), body));
    }
 
    return unify<Arr>(2, body->unfold_type(), shape, body);
}
 
Ref World::pack(Ref shape, Ref body) {
    if (!is_shape(shape->type())) error(shape, "expected shape but got '{}' of type '{}'", shape, shape->type());
 
    if (auto a = Lit::isa(shape)) {
        if (*a == 0) return tuple();
        if (*a == 1) return body;
    }
 
    // <(a, b, c); body> -> <a; «(b, c); body>>
    if (auto tuple = shape->isa<Tuple>()) return pack(tuple->ops().front(), pack(tuple->ops().subspan(1), body));
 
    // <<n; x>; body> -> <x; <<n-1, x>; body>>
    if (auto p = shape->isa<Pack>()) {
        if (auto s = Lit::isa(p->shape())) return pack(*s, pack(pack(*s - 1, p->body()), body));
    }
 
    auto type = arr(shape, body->type());
    return unify<Pack>(1, type, body);
}
 
Ref World::arr(Defs shape, Ref body) {
    if (shape.empty()) return body;
    return arr(shape.rsubspan(1), arr(shape.back(), body));
}
 
Ref World::pack(Defs shape, Ref body) {
    if (shape.empty()) return body;
    return pack(shape.rsubspan(1), pack(shape.back(), body));
}
 
const Lit* World::lit(Ref type, u64 val) {
    if (auto size = Idx::size(type)) {
        if (auto s = Lit::isa(size)) {
            if (*s != 0 && val >= *s) error(type, "index '{}' does not fit within arity '{}'", size, val);
        } else if (val != 0) { // 0 of any size is allowed
            error(type, "cannot create literal '{}' of '.Idx {}' as size is unknown", val, size);
        }
    }
 
    return unify<Lit>(0, type, val);
}
 
/*
 * set
 */
 
template<bool Up> Ref World::ext(Ref type) {
    if (auto arr = type->isa<Arr>()) return pack(arr->shape(), ext<Up>(arr->body()));
    if (auto sigma = type->isa<Sigma>())
        return tuple(sigma, DefVec(sigma->num_ops(), [&](size_t i) { return ext<Up>(sigma->op(i)); }));
    return unify<TExt<Up>>(0, type);
}
 
template<bool Up> Ref World::bound(Defs ops) {
    auto kind = umax<Sort::Type>(ops);
 
    // has ext<Up> value?
    if (std::ranges::any_of(ops, [&](Ref op) { return Up ? bool(op->isa<Top>()) : bool(op->isa<thorin::Bot>()); }))
        return ext<Up>(kind);
 
    // ignore: ext<!Up>
    DefVec cpy(ops.begin(), ops.end());
    auto [_, end] = std::ranges::copy_if(ops, cpy.begin(), [&](Ref op) { return !op->isa<Ext>(); });
 
    // sort and remove duplicates
    std::sort(cpy.begin(), end, GIDLt<const Def*>());
    end = std::unique(cpy.begin(), end);
    cpy.resize(std::distance(cpy.begin(), end));
 
    if (cpy.size() == 0) return ext<!Up>(kind);
    if (cpy.size() == 1) return cpy[0];
 
    // TODO simplify mixed terms with joins and meets
 
    return unify<TBound<Up>>(cpy.size(), kind, cpy);
}
 
Ref World::ac(Ref type, Defs ops) {
    if (type->isa<Meet>()) {
        auto types = DefVec(ops.size(), [&](size_t i) { return ops[i]->type(); });
        return unify<Ac>(ops.size(), meet(types), ops);
    }
 
    assert(ops.size() == 1);
    return ops[0];
}
 
Ref World::ac(Defs ops) { return ac(umax<Sort::Term>(ops), ops); }
 
Ref World::vel(Ref type, Ref value) {
    if (type->isa<Join>()) return unify<Vel>(1, type, value);
    return value;
}
 
Ref World::pick(Ref type, Ref value) { return unify<Pick>(1, type, value); }
 
Ref World::test(Ref value, Ref probe, Ref match, Ref clash) {
    auto m_pi = match->type()->isa<Pi>();
    auto c_pi = clash->type()->isa<Pi>();
 
    // TODO proper error msg
    assert(m_pi && c_pi);
    auto a = m_pi->dom()->isa_lit_arity();
    assert_unused(a && *a == 2);
    assert(Check::alpha(m_pi->dom(2, 0_s), c_pi->dom()));
 
    auto codom = join({m_pi->codom(), c_pi->codom()});
    return unify<Test>(4, pi(c_pi->dom(), codom), value, probe, match, clash);
}
 
Ref World::singleton(Ref inner_type) { return unify<Singleton>(1, this->type<1>(), inner_type); }
 
Sym World::append_suffix(Sym symbol, std::string suffix) {
    auto name = symbol.str();
 
    auto pos = name.find(suffix);
    if (pos != std::string::npos) {
        auto num = name.substr(pos + suffix.size());
        if (num.empty()) {
            name += "_1";
        } else {
            num  = num.substr(1);
            num  = std::to_string(std::stoi(num) + 1);
            name = name.substr(0, pos + suffix.size()) + "_" + num;
        }
    } else {
        name += suffix;
    }
 
    return sym(std::move(name));
}
 
/*
 * debugging
 */
 
#ifdef THORIN_ENABLE_CHECKS
 
void World::breakpoint(u32 gid) { state_.breakpoints.emplace(gid); }
 
Ref World::gid2def(u32 gid) {
    auto i = std::ranges::find_if(move_.defs, [=](auto def) { return def->gid() == gid; });
    if (i == move_.defs.end()) return nullptr;
    return *i;
}
 
World& World::verify() {
    for (auto [_, mut] : externals()) assert(mut->is_closed() && mut->is_set());
    for (auto [_, annex] : annexes()) assert(annex->is_closed());
    return *this;
}
 
#endif
 
#ifndef DOXYGEN
template Ref World::raw_app<true>(Ref, Ref, Ref);
template Ref World::raw_app<false>(Ref, Ref, Ref);
template Ref World::umax<Sort::Term>(Defs);
template Ref World::umax<Sort::Type>(Defs);
template Ref World::umax<Sort::Kind>(Defs);
template Ref World::umax<Sort::Univ>(Defs);
template Ref World::ext<true>(Ref);
template Ref World::ext<false>(Ref);
template Ref World::bound<true>(Defs);
template Ref World::bound<false>(Defs);
#endif
 
} // namespace thorin