jroesch commented on a change in pull request #7518: URL: https://github.com/apache/tvm/pull/7518#discussion_r664942432
########## File path: src/relay/backend/te_compiler.cc ########## @@ -0,0 +1,760 @@ +/* + * 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. + */ + +#include "te_compiler.h" + +#include <tvm/driver/driver_api.h> +#include <tvm/ir/type_functor.h> +#include <tvm/relay/analysis.h> +#include <tvm/relay/attrs/annotation.h> +#include <tvm/relay/attrs/device_copy.h> +#include <tvm/relay/expr.h> +#include <tvm/relay/expr_functor.h> +#include <tvm/relay/op.h> +#include <tvm/relay/op_attr_types.h> +#include <tvm/runtime/device_api.h> +#include <tvm/runtime/registry.h> +#include <tvm/te/operation.h> +#include <tvm/te/schedule.h> +#include <tvm/te/schedule_pass.h> +#include <tvm/topi/tags.h> + +#include <functional> +#include <limits> +#include <mutex> +#include <tuple> +#include <unordered_map> +#include <utility> +#include <vector> + +#include "../transforms/pass_utils.h" +#include "te_compiler.h" +#include "te_compiler_cache.h" +#include "utils.h" + +namespace tvm { +namespace relay { +// TODO(@jroesch, @csullivan): declare directly elsewhere +backend::StaticMemoryPlan GraphPlanMemory(const Function& func); + +namespace tec { + +using namespace tvm::relay::transform; + +TVM_REGISTER_OBJECT_TYPE(TECompilerNode); + +class TECompilerImpl : public TECompilerNode { + public: + // Lower the function. + CachedFunc Lower(const CCacheKey& key, std::function<String(String)> mangle_fn) { + return LowerInternal(key, mangle_fn)->cached_func; + } + + CachedFunc Lower(const CCacheKey& key, const String mod_name) { + auto mangle_fn = [mod_name](String name) { + std::cout << "inner mod name" << mod_name << std::endl; + return runtime::get_name_mangled(mod_name, name); + }; + + return Lower(key, mangle_fn); + } + + // For now, build one module per function. + PackedFunc JIT(const CCacheKey& key) final { + auto mangle_fn = [](String name) { return name; }; + CCacheValue value = LowerInternal(key, mangle_fn); + if (value->packed_func != nullptr) { + return value->packed_func; + } + auto m = build(value->cached_func->funcs, key->target, Target(nullptr)); + value->packed_func = m.GetFunction(value->cached_func->prim_fn_var->name_hint); + return value->packed_func; + } + + CachedFunc LowerShapeFunc(const CCacheKey& key) final { + return LowerShapeFuncInternal(key)->cached_func; + } + + Map<String, IRModule> GetLoweredFunctions() { + Map<String, IRModule> lowered_functions; + for (const auto& it : cache_) { + auto source_func = it.first; + auto lowered_func = it.second; + auto target = source_func->target; + + if (!lowered_functions.count(target->str())) { + lowered_functions.Set(target->str(), IRModule(Map<GlobalVar, BaseFunc>({}))); + } + + lowered_functions[target->str()]->Update(lowered_func->cached_func->funcs); + } + return lowered_functions; + } + + Array<tvm::runtime::Module> LowerExternalFunctions() { + Array<tvm::runtime::Module> ret; + std::unordered_map<std::string, std::string> cached_symbol; + std::vector<CCacheKey> cached_ext_funcs; + for (const auto& it : cache_) { + auto src_func = it.first->source_func; + ICHECK(src_func.defined()); + if (src_func->GetAttr<String>(attr::kCompiler).defined()) { + auto code_gen = src_func->GetAttr<String>(attr::kCompiler); + std::string code_gen_name = code_gen.value(); + cached_ext_funcs.push_back(it.first); + + auto symbol_name = src_func->GetAttr<String>(tvm::attr::kGlobalSymbol); + ICHECK(symbol_name.defined()) << "No external symbol is set for:\n" + << AsText(src_func, false); + + std::string sn = symbol_name.value(); + if (cached_symbol.count(sn)) { + cached_symbol[sn] = code_gen_name; + } else { + ICHECK_NE(sn, code_gen_name) + << "Found duplicated symbol: " << sn << " for: " << code_gen_name; + } + + std::string ext_name = "relay.ext." + code_gen_name; + auto pf = tvm::runtime::Registry::Get(ext_name); + ICHECK(pf) << "Failed to find the codegen tool for " << ext_name; + // No need to keep compiler attribute at this point, functions have been + // extracted for specific codegen. + src_func = WithAttr(std::move(src_func), attr::kCompiler, NullValue<ObjectRef>()); + runtime::Module ext_mod = (*pf)(src_func); + + ICHECK(ext_mod.defined()) << "No external runtime is generated."; + ret.push_back(ext_mod); + } + } + + // No need to cache external functions as we collected them all to create + // external runtime modules. + for (const auto& it : cached_ext_funcs) { + cache_.erase(it); + } + return ret; + } + + void Clear() final { cache_.clear(); } + + // List all items in the cache. + Array<ObjectRef> ListItems() { + std::lock_guard<std::mutex> lock(mutex_); + Array<ObjectRef> items; + for (auto& kv : cache_) { + items.push_back(kv.first); + items.push_back(kv.second); + } + return items; + } + + /*! + * \brief Get the cache key of the function that is being lowered currently + * \return the cache key + */ + CCacheKey GetCurrentCCacheKey() { return cur_ccache_key_; } + + private: + // implement lowered func + CCacheValue LowerInternal(const CCacheKey& key, std::function<String(String)> mangle_fn) { + std::lock_guard<std::mutex> lock(mutex_); + CCacheValue value; + auto it = cache_.find(key); + if (it != cache_.end()) { + it->second->use_count += 1; + if (it->second->cached_func.defined()) return it->second; + value = it->second; + } else { + value = CCacheValue(make_object<CCacheValueNode>()); + value->use_count = 1; + cache_[key] = value; + } + cur_ccache_key_ = key; + + // No need to lower external functions for now. We will invoke the external + // codegen tool once and lower all functions together. + if (key->source_func->GetAttr<String>(attr::kCompiler).defined()) { + auto ir_module = IRModule(); + const auto name_node = key->source_func->GetAttr<String>(tvm::attr::kGlobalSymbol); + ICHECK(name_node.defined()) << "External function has not been attached a name yet."; + auto func_name = GetUniqueName(name_node.value(), &name_map_); + auto target = Target("ext_dev"); + auto global_var = GlobalVar(func_name); + global_var->checked_type_ = key->source_func->checked_type(); + value->cached_func = CachedFunc(target, global_var, {}, {}, te::Schedule(), {}, ir_module); + return value; + } + + // Enforce use the target. + With<Target> target_scope(key->target); + + ICHECK(!value->cached_func.defined()); + auto cfunc = PrimFuncFor(key->source_func, key->target, [&](std::string name) { + auto mangled = mangle_fn(name); + std::cout << "Mangled: " << mangled << std::endl; + return GetUniqueName(mangled, &name_map_); + }); + + // Skip lowering for device copy node. + const Expr body = (key->source_func)->body; + if (const CallNode* call_node = body.as<CallNode>()) { + if (call_node->attrs.as<DeviceCopyAttrs>()) { + value->cached_func = cfunc; + return value; + } + } + + // NOTE: array will copy on write. + Array<te::Tensor> all_args = Array<te::Tensor>(cfunc->inputs); + for (te::Tensor arg : cfunc->outputs) { + all_args.push_back(arg); + } + + std::unordered_map<te::Tensor, tir::Buffer> binds; + auto func_name = cfunc->prim_fn_var->name_hint; + cfunc->funcs->Update(tvm::LowerSchedule(cfunc->schedule, all_args, func_name, binds)); + value->cached_func = cfunc; + return value; + } + + // implement lowered shape func + CCacheValue LowerShapeFuncInternal(const CCacheKey& key) { + std::lock_guard<std::mutex> lock(mutex_); + CCacheValue value; + auto it = shape_func_cache_.find(key); + if (it != shape_func_cache_.end()) { + it->second->use_count += 1; + if (it->second->cached_func.defined()) return it->second; + value = it->second; + } else { + value = CCacheValue(make_object<CCacheValueNode>()); + value->use_count = 0; + shape_func_cache_[key] = value; + } + // Enforce use the target. + With<Target> target_scope(key->target); + + ICHECK(!value->cached_func.defined()); + + using tvm::transform::PassContext; + With<PassContext> fresh_pass_ctx_scope(PassContext::Create()); + auto cached_func = ShapeFuncFor(key->source_func, key->target, [&](std::string name) { + return GetUniqueName(name, &name_map_); + }); + + value->cached_func = cached_func; + return value; + } + + std::unordered_map<std::string, int> GetOpWeights() { + std::unordered_map<std::string, int> weights; + for (auto pair : cache_) { + auto value = pair.second; + auto name = value->cached_func->prim_fn_var->name_hint; + weights[name] = value->use_count; + } + return weights; + } + + /*! \brief compiler cache lock*/ + std::mutex mutex_; + /*! \brief internal name map to get an unique name */ + std::unordered_map<std::string, int> name_map_; + /*! \brief internal compiler cache */ + std::unordered_map<CCacheKey, CCacheValue> cache_; + /*! \brief internal compiler cache for shape funcs */ + std::unordered_map<CCacheKey, CCacheValue> shape_func_cache_; + /*! \brief the cache key of the function that is being lowered currently*/ + CCacheKey cur_ccache_key_; +}; + +TECompiler::TECompiler() { + auto object = make_object<TECompilerImpl>(); + data_ = object; +} + +using AnalysisRemapping = std::unordered_map<Expr, Expr, ObjectHash, ObjectEqual>; + +std::tuple<bool, int, int> IsDeviceCopy(const Function& func) { + if (auto call_node = func->body.as<CallNode>()) { + if (auto op_node = call_node->op.as<OpNode>()) { + if (op_node->name == "device_copy") { + auto attrs = call_node->attrs.as<DeviceCopyAttrs>(); + auto dst = attrs->dst_dev_type; + auto src = attrs->src_dev_type; + return std::tuple<bool, int, int>(true, src, dst); + } + } + } + + return std::tuple<bool, int, int>(false, -1, -1); +} + +class LowerTensorExpr : public ExprMutator { + public: + LowerTensorExpr(const IRModule& module, const TargetMap& targets, const DeviceMap& device_ctx_map, + ProcessFn process_fn, AnalysisRemapping* prim_fn_to_call, + const String& module_name, TECompiler compiler) + : module_(module), + targets_(targets), + device_context_map_(device_ctx_map), + process_fn(process_fn), + prim_fn_to_call(prim_fn_to_call), + module_name_(module_name), + compiler_(compiler) {} + + Expr VisitExpr_(const CallNode* call) override { + Call expr = GetRef<Call>(call); + Function func; + + if (call->op.as<FunctionNode>()) { + func = GetRef<Function>(call->op.as<FunctionNode>()); + } else { + return ExprMutator::VisitExpr_(call); + } + + if (!func->HasNonzeroAttr(attr::kPrimitive)) { + // Provide a callback hook which allows one-level up code generators to + // act when we process a function. + this->process_fn(func); + return ExprMutator::VisitExpr_(call); + } + + // Process inputs. + Array<Expr> args; + for (size_t i = 0; i < expr->args.size(); i++) { + args.push_back(VisitExpr(expr->args[i])); + } + + Target target; + + if (func->GetAttr<String>(attr::kCompiler).defined()) { + target = Target("ext_dev"); + CCacheKey key = CCacheKey(func, target); + CachedFunc ext_func = compiler_->Lower(key, module_name_); + ICHECK(ext_func.defined()) << "Lowering returned undefined function for " + << ext_func->prim_fn_var->name_hint; + + Map<GlobalVar, tir::PrimFunc> prim_fns; + + for (auto prim_fn : ext_func->funcs->functions) { + CHECK(prim_fn.second.as<tir::PrimFuncNode>()) << "must be a prim fn"; + prim_fns.Set(prim_fn.first, Downcast<tir::PrimFunc>(prim_fn.second)); + } + + relay::Function func_with_metadata = func; + func_with_metadata = WithAttr(func_with_metadata, "prim_fn_var", ext_func->prim_fn_var); + func_with_metadata = WithAttr(func_with_metadata, "prim_funcs", prim_fns); + func_with_metadata = WithAttr(func_with_metadata, "target", ext_func->target); + + // Provide a callback hook which allows one-level up code generators to + // act when we process a function. + this->process_fn(func_with_metadata); + + auto ret_call = Call(ext_func->prim_fn_var, args, {}); + (*prim_fn_to_call)[func] = ret_call; + return std::move(ret_call); + } + + ICHECK_GE(device_context_map_.count(expr), 0) + << "Could not find an entry in the device context map for " << PrettyPrint(expr) + << "The memory planning was either not performed for this precise node, or there is bug " + "in the memory planner."; + + auto& device_context = this->device_context_map_[expr]; + auto call_dev_type = device_context.device_type; + + // Non-External Relay Function + if (targets_.size() == 1) { + // The homogeneous execution case, we should only have one target + // so we just grab it. + const auto& it = targets_.begin(); + target = (*it).second; + } else { + // The heterogeneous execution case we have multiple targets + // in this case. + // + // We need to identify the target and translate. + std::string call_dev_name; + if (call_dev_type == 0) { + call_dev_name = "llvm"; + call_dev_type = kDLCPU; + } else { + call_dev_name = ::tvm::runtime::DeviceName(call_dev_type); + } + + if (targets_.count(call_dev_type) == 0) { + std::stringstream msg; + msg << "No target is specified for provided device name: `" << call_dev_name << "`\n\n"; + msg << call_dev_name << " mapped to device type (" << call_dev_type + << ") which was not found in the target map.\n"; + msg << "Availible targets: \n"; + for (auto target : targets_) { + msg << " " << target.first << "-> " << target.second << "\n"; + } + LOG(FATAL) << msg.str(); + } + + target = targets_[call_dev_type]; + } + + CCacheKey key = CCacheKey(func, target); + CachedFunc lowered_func = compiler_->Lower(key, module_name_); + + Map<GlobalVar, tir::PrimFunc> prim_fns; + + for (auto prim_fn : lowered_func->funcs->functions) { + CHECK(prim_fn.second.as<tir::PrimFuncNode>()) << "must be a prim fn"; + prim_fns.Set(prim_fn.first, Downcast<tir::PrimFunc>(prim_fn.second)); + } + + // TODO(@areusch, @jroesch): this metadata is for AOT, this should be our interface for AOT + relay::Function func_with_metadata = func; + func_with_metadata = WithAttr(func_with_metadata, "prim_fn_var", lowered_func->prim_fn_var); + func_with_metadata = WithAttr(func_with_metadata, "prim_funcs", prim_fns); + func_with_metadata = WithAttr(func_with_metadata, "target", lowered_func->target); + + // Provide a callback hook which allows one-level up code generators to + // act when we process a function. + this->process_fn(func_with_metadata); + + auto tir_call_attrs = make_object<TIRCallAttrs>(); + if (func->HasNonzeroAttr(attr::kReshapeOnly)) { + tir_call_attrs->metadata.Set(attr::kReshapeOnly, tvm::Integer(1)); + } + + auto device_copy = IsDeviceCopy(func); + if (std::get<0>(device_copy)) { + std::cout << "DeviceCopy" << std::endl; Review comment: Remove this -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
