| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| /*! |
| * \file tvm/src/pass/lower_custom_datatypes.cc |
| * \brief Pass for lowering custom datatypes |
| */ |
| |
| #include <tvm/runtime/registry.h> |
| #include <tvm/target/target.h> |
| #include <tvm/tir/op.h> |
| #include <tvm/tir/stmt_functor.h> |
| #include <tvm/tir/transform.h> |
| |
| #include "../../target/datatype/registry.h" |
| |
| namespace tvm { |
| namespace tir { |
| |
| /*! |
| * \brief Helper mutator to implement lowering of custom datatypes. |
| * |
| * Lowering datatypes works as follows: for every expression containing a custom |
| * datatype, we search for a global (registered by the implementer of the custom |
| * datatype) for lowering this type of expression, and uses it to lower the |
| * expression. |
| */ |
| class CustomDatatypesLowerer : public StmtExprMutator { |
| public: |
| explicit CustomDatatypesLowerer(const std::string& target) : target_(target) {} |
| |
| inline PrimExpr VisitExpr_(const CastNode* op) final { |
| auto type_code = op->dtype.code(); |
| auto src_type_code = op->value.dtype().code(); |
| // If either datatype is a registered custom datatype, we must lower. |
| bool toBeLowered = datatype::Registry::Global()->GetTypeRegistered(type_code) || |
| datatype::Registry::Global()->GetTypeRegistered(src_type_code); |
| PrimExpr expr = StmtExprMutator::VisitExpr_(op); |
| if (toBeLowered) { |
| auto lower = datatype::GetCastLowerFunc(target_, type_code, src_type_code); |
| CHECK(lower) << "Cast lowering function for target " << target_ << " destination type " |
| << static_cast<unsigned>(type_code) << " source type " |
| << static_cast<unsigned>(src_type_code) << " not found"; |
| return (*lower)(expr); |
| } |
| return expr; |
| } |
| |
| inline PrimExpr VisitExpr_(const FloatImmNode* imm) final { |
| auto type_code = imm->dtype.code(); |
| auto e = GetRef<PrimExpr>(imm); |
| if (datatype::Registry::Global()->GetTypeRegistered(type_code)) { |
| auto lower = datatype::GetFloatImmLowerFunc(target_, type_code); |
| CHECK(lower) << "FloatImm lowering function for target " << target_ << " type " |
| << static_cast<unsigned>(type_code) << " not found"; |
| return (*lower)(e); |
| } |
| return e; |
| } |
| |
| inline Stmt VisitStmt_(const AllocateNode* allocate) final { |
| bool toBeLowered = datatype::Registry::Global()->GetTypeRegistered(allocate->dtype.code()); |
| Stmt stmt = StmtExprMutator::VisitStmt_(allocate); |
| allocate = stmt.as<AllocateNode>(); |
| |
| if (toBeLowered) { |
| auto new_allocate_type = DataType::UInt(allocate->dtype.bits(), allocate->dtype.lanes()); |
| return Allocate(allocate->buffer_var, new_allocate_type, allocate->extents, |
| allocate->condition, allocate->body); |
| } |
| return stmt; |
| } |
| |
| inline PrimExpr VisitExpr_(const LoadNode* load) final { |
| bool toBeLowered = datatype::Registry::Global()->GetTypeRegistered(load->dtype.code()); |
| PrimExpr expr = StmtExprMutator::VisitExpr_(load); |
| load = expr.as<LoadNode>(); |
| if (toBeLowered) { |
| auto new_load_type = DataType::UInt(load->dtype.bits()); |
| return Load(new_load_type, load->buffer_var, load->index, load->predicate); |
| } |
| return expr; |
| } |
| |
| inline PrimExpr VisitExpr_(const CallNode* call) final { |
| bool toBeLowered = datatype::Registry::Global()->GetTypeRegistered(call->dtype.code()); |
| PrimExpr expr = StmtExprMutator::VisitExpr_(call); |
| call = expr.as<CallNode>(); |
| if (toBeLowered) { |
| auto op = call->op.as<OpNode>(); |
| CHECK(op != nullptr) << "Lowering non-intrinsic Calls not implemented"; |
| auto lower = datatype::GetIntrinLowerFunc(target_, op->name, call->dtype.code()); |
| CHECK(lower) << "Intrinsic lowering function for target " << target_ << ", intrinsic name " |
| << op->name << ", type " << static_cast<unsigned>(call->dtype.code()) |
| << " not found"; |
| return (*lower)(expr); |
| } |
| return expr; |
| } |
| |
| #define DEFINE_MUTATE(OP, NodeName) \ |
| inline PrimExpr VisitExpr_(const NodeName* op) final { \ |
| auto type_code = op->dtype.code(); \ |
| bool toBeLowered = datatype::Registry::Global()->GetTypeRegistered(type_code); \ |
| PrimExpr expr = StmtExprMutator::VisitExpr_(op); \ |
| op = expr.as<NodeName>(); \ |
| if (toBeLowered) { \ |
| auto lower = datatype::Get##OP##LowerFunc(target_, type_code); \ |
| CHECK(lower) << #OP " lowering function for target " << target_ << " type " \ |
| << static_cast<unsigned>(type_code) << " not found"; \ |
| return (*lower)(expr); \ |
| } \ |
| return expr; \ |
| } |
| |
| DEFINE_MUTATE(Add, AddNode); |
| DEFINE_MUTATE(Sub, SubNode); |
| DEFINE_MUTATE(Mul, MulNode); |
| DEFINE_MUTATE(Div, DivNode); |
| DEFINE_MUTATE(Mod, ModNode); |
| DEFINE_MUTATE(Min, MinNode); |
| DEFINE_MUTATE(Max, MaxNode); |
| DEFINE_MUTATE(EQ, EQNode); |
| DEFINE_MUTATE(NE, NENode); |
| DEFINE_MUTATE(LT, LTNode); |
| DEFINE_MUTATE(LE, LENode); |
| DEFINE_MUTATE(GT, GTNode); |
| DEFINE_MUTATE(GE, GENode); |
| // Later changes may need to add more mutate functions as we support workloads with more ops. |
| |
| private: |
| std::string target_; |
| }; |
| |
| namespace transform { |
| |
| Pass LowerCustomDatatypes() { |
| auto pass_func = [](PrimFunc f, IRModule m, PassContext ctx) { |
| auto* n = f.CopyOnWrite(); |
| auto target = f->GetAttr<Target>(tvm::attr::kTarget); |
| CHECK(target.defined()) << "LowerCustomDatatypes: Require the target attribute"; |
| |
| n->body = CustomDatatypesLowerer(target.value()->kind->name)(std::move(n->body)); |
| return f; |
| }; |
| return CreatePrimFuncPass(pass_func, 0, "tir.LowerCustomDatatypes", {}); |
| } |
| |
| TVM_REGISTER_GLOBAL("tir.transform.LowerCustomDatatypes").set_body_typed(LowerCustomDatatypes); |
| |
| } // namespace transform |
| |
| } // namespace tir |
| } // namespace tvm |