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/ir/adt.h>
#include <tvm/ir/expr.h>
#include <tvm/ir/function.h>
#include <tvm/ir/source_map.h>
#include <tvm/ir/type.h>
#include <tvm/runtime/container/array.h>
#include <tvm/runtime/container/map.h>
#include <tvm/runtime/container/string.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;
  Map<GlobalTypeVar, TypeData> type_definitions;
  SourceMap source_map;
  /* \brief Additional attributes storing meta-data about the module. */
  DictAttrs attrs;
  Map<String, GlobalVar> global_var_map_;

  Map<String, GlobalTypeVar> global_type_var_map_;

  std::unordered_map<int32_t, Constructor> constructor_tag_map_;

  std::unordered_set<String> import_set_;

  template <typename TObjectRef>
  Optional<TObjectRef> GetAttr(
      const std::string& attr_key,
      Optional<TObjectRef> default_value = Optional<TObjectRef>(nullptr)) 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));
  }

  bool HasNonzeroAttr(const std::string& attr_key) const { return attrs.HasNonzeroAttr(attr_key); }

  IRModuleNode() : source_map() {}

  void VisitAttrs(AttrVisitor* v) {
    v->Visit("functions", &functions);
    v->Visit("type_definitions", &type_definitions);
    v->Visit("global_var_map_", &global_var_map_);
    v->Visit("global_type_var_map_", &global_type_var_map_);
    v->Visit("source_map", &source_map);
    v->Visit("attrs", &attrs);
  }

  TVM_DLL bool SEqualReduce(const IRModuleNode* other, SEqualReducer equal) const;

  TVM_DLL void SHashReduce(SHashReducer hash_reduce) 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 AddTypeDef(const GlobalTypeVar& var, const TypeData& type, bool update = false);

  TVM_DLL void AddTypeDefUnchecked(const GlobalTypeVar& var, const TypeData& type,
                                   bool update = false);

  TVM_DLL void Update(const GlobalVar& var, const BaseFunc& func);

  TVM_DLL void UpdateTypeDef(const GlobalTypeVar& var, const TypeData& type);

  TVM_DLL void Remove(const GlobalVar& var);

  TVM_DLL bool ContainGlobalVar(const String& name) const;

  TVM_DLL bool ContainGlobalTypeVar(const String& name) const;

  TVM_DLL GlobalVar GetGlobalVar(const String& str) const;

  TVM_DLL Array<GlobalVar> GetGlobalVars() const;

  TVM_DLL GlobalTypeVar GetGlobalTypeVar(const String& str) const;

  TVM_DLL Array<GlobalTypeVar> GetGlobalTypeVars() const;

  TVM_DLL Constructor GetConstructor(const String& adt, const String& cons) const;

  TVM_DLL BaseFunc Lookup(const GlobalVar& var) const;

  TVM_DLL BaseFunc Lookup(const String& name) const;

  TVM_DLL TypeData LookupTypeDef(const GlobalTypeVar& var) const;

  TVM_DLL TypeData LookupTypeDef(const String& var) const;

  TVM_DLL Constructor LookupTag(const int32_t tag);

  TVM_DLL void Update(const IRModule& other);

  TVM_DLL IRModule ShallowCopy();

  TVM_DLL void Import(const String& path);

  TVM_DLL void ImportFromStd(const String& path);

  TVM_DLL std::unordered_set<String> Imports() const;

  TVM_OBJECT_ENABLE_SCRIPT_PRINTER();

  static constexpr const char* _type_key = "IRModule";
  static constexpr const bool _type_has_method_sequal_reduce = true;
  static constexpr const bool _type_has_method_shash_reduce = true;
  TVM_DECLARE_FINAL_OBJECT_INFO(IRModuleNode, Object);

 private:
  void RegisterConstructors(const GlobalTypeVar& var, const TypeData& type);
  friend class IRModule;
};

class IRModule : public ObjectRef {
 public:
  TVM_DLL explicit IRModule(Map<GlobalVar, BaseFunc> functions,
                            Map<GlobalTypeVar, TypeData> type_definitions = {},
                            std::unordered_set<String> import_set = {}, SourceMap map = {},
                            DictAttrs attrs = {});

  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);
  }

  static std::pair<IRModule, GlobalVar> FromExprInContext(
      const RelayExpr& expr, const Map<GlobalVar, BaseFunc>& global_funcs = {},
      const Map<GlobalTypeVar, TypeData>& type_definitions = {},
      std::unordered_set<String> import_set = {});

  TVM_DLL static IRModule FromExpr(const RelayExpr& expr,
                                   const Map<GlobalVar, BaseFunc>& global_funcs = {},
                                   const Map<GlobalTypeVar, TypeData>& type_definitions = {});

  TVM_DLL static IRModule FromText(const String& text, const String& source_path);

  IRModule ShallowCopyIRModule(IRModule mod);

  using ContainerType = IRModuleNode;

  static constexpr bool _type_is_nullable = false;

  // 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";

constexpr const char* kExecutor = "executor";

constexpr const char* kRuntime = "runtime";

constexpr const char* kWorkspaceMemoryPools = "workspace_memory_pools";

constexpr const char* kConstantMemoryPools = "constant_memory_pools";

/*
 * \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* kConstNameToConstant = "const_name_to_constant";

}  // namespace attr
}  // namespace tvm
#endif  // TVM_IR_MODULE_H_