module.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef TVM_IR_MODULE_H_
#define TVM_IR_MODULE_H_
 
#include <tvm/ffi/container/array.h>
#include <tvm/ffi/container/map.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ffi/string.h>
#include <tvm/ir/expr.h>
#include <tvm/ir/function.h>
#include <tvm/ir/global_info.h>
#include <tvm/ir/source_map.h>
#include <tvm/ir/type.h>
 
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <utility>
#include <vector>
 
namespace tvm {
 
class IRModule;
 
class IRModuleNode : public Object {
 public:
  Map<GlobalVar, BaseFunc> functions;
  SourceMap source_map;
  /* \brief Additional attributes storing meta-data about the module. */
  DictAttrs attrs;
  Map<String, Array<GlobalInfo>> global_infos;
  Map<String, GlobalVar> global_var_map_;
 
  template <typename TObjectRef>
  Optional<TObjectRef> GetAttr(
      const std::string& attr_key,
      Optional<TObjectRef> default_value = Optional<TObjectRef>(std::nullopt)) const {
    return attrs.GetAttr(attr_key, default_value);
  }
  // variant that uses TObjectRef to enable implicit conversion to default value.
  template <typename TObjectRef>
  Optional<TObjectRef> GetAttr(const std::string& attr_key, TObjectRef default_value) const {
    return GetAttr<TObjectRef>(attr_key, Optional<TObjectRef>(default_value));
  }
 
  DictAttrs GetAttrs() const { return attrs; }
 
  bool HasNonzeroAttr(const std::string& attr_key) const { return attrs.HasNonzeroAttr(attr_key); }
 
  IRModuleNode() : source_map() {}
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<IRModuleNode>()
        .def_ro("functions", &IRModuleNode::functions)
        .def_ro("global_var_map_", &IRModuleNode::global_var_map_)
        .def_ro("source_map", &IRModuleNode::source_map)
        .def_ro("attrs", &IRModuleNode::attrs)
        .def_ro("global_infos", &IRModuleNode::global_infos);
    // register custom structural equal and hash.
    refl::TypeAttrDef<IRModuleNode>()
        .def("__s_equal__", &IRModuleNode::SEqual)
        .def("__s_hash__", &IRModuleNode::SHash);
  }
 
  TVM_DLL bool SEqual(const IRModuleNode* other,
                      ffi::TypedFunction<bool(AnyView, AnyView, bool, AnyView)> equal) const;
  TVM_DLL uint64_t SHash(uint64_t init_hash,
                         ffi::TypedFunction<uint64_t(AnyView, uint64_t, bool)> hash) const;
 
  TVM_DLL void Add(const GlobalVar& var, const BaseFunc& func, bool update = false);
 
  TVM_DLL void AddUnchecked(const GlobalVar& var, const BaseFunc& func);
 
  TVM_DLL void Update(const GlobalVar& var, const BaseFunc& func);
 
  TVM_DLL void UpdateGlobalInfo(const String& name, const Array<GlobalInfo>& info);
 
  TVM_DLL void Remove(const GlobalVar& var);
 
  TVM_DLL bool ContainGlobalVar(const String& name) const;
 
  TVM_DLL GlobalVar GetGlobalVar(const String& str) const;
 
  TVM_DLL Array<GlobalVar> GetGlobalVars() const;
 
  TVM_DLL BaseFunc Lookup(const GlobalVar& var) const;
 
  TVM_DLL BaseFunc Lookup(const String& name) const;
 
  TVM_DLL void Update(const IRModule& other);
 
  TVM_DLL IRModule ShallowCopy();
  TVM_DLL std::unordered_set<String> Imports() const;
 
  TVM_OBJECT_ENABLE_SCRIPT_PRINTER();
 
  static constexpr const char* _type_key = "ir.IRModule";
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
 
  TVM_DECLARE_FINAL_OBJECT_INFO(IRModuleNode, Object);
 
 private:
  friend class IRModule;
};
 
class IRModule : public ObjectRef {
 public:
  TVM_DLL explicit IRModule(Map<GlobalVar, BaseFunc> functions, SourceMap map = {},
                            DictAttrs attrs = DictAttrs(),
                            Map<String, Array<GlobalInfo>> global_infos = {});
 
  IRModule() : IRModule(Map<GlobalVar, BaseFunc>({})) {}
  explicit IRModule(ObjectPtr<Object> n) : ObjectRef(n) {}
  IRModuleNode* operator->() const {
    auto* ptr = get_mutable();
    ICHECK(ptr != nullptr);
    return static_cast<IRModuleNode*>(ptr);
  }
 
  TVM_DLL static IRModule FromExpr(const RelaxExpr& expr,
                                   const Map<GlobalVar, BaseFunc>& global_funcs = {});
 
  IRModule ShallowCopyIRModule(IRModule mod);
 
  using ContainerType = IRModuleNode;
 
  // allow copy on write.
  TVM_DEFINE_OBJECT_REF_COW_METHOD(IRModuleNode);
};
 
namespace attr {
 
// Following are attributes for IRModule only.
 
constexpr const char* kModuleName = "mod_name";
 
/*
 * \brief All the runtime::NDArrays extracted from PrimFunc tir::AllocateConst nodes. The
 * node will record the index into this array. See also kConstNameToConstant below, which is
 * the analog for Realy Functions.
 *
 * Type: Array<runtime::NDArray>
 */
constexpr const char* kConstants = "constants";
 
constexpr const char* kExternalMods = "external_mods";
 
constexpr const char* kSystemLibPrefix = "system_lib_prefix";
 
constexpr const char* kConstNameToConstant = "const_name_to_constant";
 
}  // namespace attr
}  // namespace tvm
#endif  // TVM_IR_MODULE_H_