target_kind.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_TARGET_TARGET_KIND_H_
#define TVM_TARGET_TARGET_KIND_H_
 
#include <tvm/ffi/function.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/attr_registry_map.h>
#include <tvm/ir/config_schema.h>
#include <tvm/runtime/base.h>
 
#include <memory>
#include <unordered_map>
#include <utility>
#include <vector>
 
namespace tvm {
 
class Target;
 
using FTargetCanonicalizer =
    ffi::TypedFunction<ffi::Map<ffi::String, ffi::Any>(ffi::Map<ffi::String, ffi::Any>)>;
 
class TargetInternal;
 
template <typename>
class TargetKindAttrMap;
 
class TargetKindNode : public ffi::Object {
 public:
  ffi::String name;
  int default_device_type;
  ffi::Array<ffi::String> default_keys;
  FTargetCanonicalizer target_canonicalizer;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TargetKindNode>()
        .def_ro("name", &TargetKindNode::name)
        .def_ro("default_device_type", &TargetKindNode::default_device_type,
                refl::AttachFieldFlag::SEqHashIgnore())
        .def_ro("default_keys", &TargetKindNode::default_keys,
                refl::AttachFieldFlag::SEqHashIgnore());
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindUniqueInstance;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("target.TargetKind", TargetKindNode, ffi::Object);
 
 private:
  uint32_t AttrRegistryIndex() const { return index_; }
  ffi::String AttrRegistryName() const { return name; }
  ir::ConfigSchema schema_;
  uint32_t index_;
 
  template <typename, typename>
  friend class AttrRegistry;
  template <typename>
  friend class AttrRegistryMapContainerMap;
  friend class TargetKindRegEntry;
  friend class TargetInternal;
};
 
class TargetKind : public ffi::ObjectRef {
 public:
  TargetKind() = default;
  explicit TargetKind(ffi::ObjectPtr<TargetKindNode> data) : ffi::ObjectRef(data) {
    TVM_FFI_ICHECK(data != nullptr);
  }
  template <typename ValueType>
  static inline TargetKindAttrMap<ValueType> GetAttrMap(const ffi::String& attr_name);
  TVM_DLL static ffi::Optional<TargetKind> Get(const ffi::String& target_kind_name);
  TargetKindNode* operator->() { return static_cast<TargetKindNode*>(data_.get()); }
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(TargetKind, ffi::ObjectRef, TargetKindNode);
 
 private:
  TVM_DLL static const AttrRegistryMapContainerMap<TargetKind>& GetAttrMapContainer(
      const ffi::String& attr_name);
  friend class TargetKindRegEntry;
  friend class TargetInternal;
};
 
template <typename ValueType>
class TargetKindAttrMap : public AttrRegistryMap<TargetKind, ValueType> {
 public:
  using TParent = AttrRegistryMap<TargetKind, ValueType>;
  using TParent::count;
  using TParent::get;
  using TParent::operator[];
  explicit TargetKindAttrMap(const AttrRegistryMapContainerMap<TargetKind>& map) : TParent(map) {}
};
 
static constexpr const char* kTvmRuntimeCpp = "c++";
 
static constexpr const char* kTvmRuntimeCrt = "c";
 
class TargetKindRegEntry {
 public:
  template <typename ValueType>
  inline TargetKindRegEntry& set_attr(const ffi::String& attr_name, const ValueType& value,
                                      int plevel = 10);
  inline TargetKindRegEntry& set_default_device_type(int device_type);
  inline TargetKindRegEntry& set_default_keys(std::vector<ffi::String> keys);
  inline TargetKindRegEntry& set_target_canonicalizer(FTargetCanonicalizer canonicalizer);
  template <typename ValueType, typename... Traits>
  inline TargetKindRegEntry& add_attr_option(const ffi::String& key, Traits&&... traits);
  inline TargetKindRegEntry& set_name();
  TVM_DLL static ffi::Array<ffi::String> ListTargetKinds();
  TVM_DLL static ffi::Map<ffi::String, ffi::String> ListTargetKindOptions(const TargetKind& kind);
 
  TVM_DLL static TargetKindRegEntry& RegisterOrGet(const ffi::String& target_kind_name);
 
 private:
  TargetKind kind_;
  ffi::String name;
 
  explicit TargetKindRegEntry(uint32_t reg_index) : kind_(ffi::make_object<TargetKindNode>()) {
    kind_->index_ = reg_index;
  }
  TVM_DLL void UpdateAttr(const ffi::String& key, ffi::Any value, int plevel);
  template <typename, typename>
  friend class AttrRegistry;
  friend class TargetKind;
};
 
template <typename ValueType>
inline TargetKindAttrMap<ValueType> TargetKind::GetAttrMap(const ffi::String& attr_name) {
  return TargetKindAttrMap<ValueType>(GetAttrMapContainer(attr_name));
}
 
template <typename ValueType>
inline TargetKindRegEntry& TargetKindRegEntry::set_attr(const ffi::String& attr_name,
                                                        const ValueType& value, int plevel) {
  TVM_FFI_ICHECK_GT(plevel, 0) << "plevel in set_attr must be greater than 0";
  ffi::Any rv;
  rv = value;
  UpdateAttr(attr_name, rv, plevel);
  return *this;
}
 
inline TargetKindRegEntry& TargetKindRegEntry::set_default_device_type(int device_type) {
  kind_->default_device_type = device_type;
  return *this;
}
 
inline TargetKindRegEntry& TargetKindRegEntry::set_default_keys(std::vector<ffi::String> keys) {
  kind_->default_keys = keys;
  return *this;
}
 
inline TargetKindRegEntry& TargetKindRegEntry::set_target_canonicalizer(
    FTargetCanonicalizer canonicalizer) {
  kind_->target_canonicalizer = canonicalizer;
  kind_->schema_.set_canonicalizer(canonicalizer);
  return *this;
}
 
template <typename ValueType, typename... Traits>
inline TargetKindRegEntry& TargetKindRegEntry::add_attr_option(const ffi::String& key,
                                                               Traits&&... traits) {
  kind_->schema_.def_option<ValueType>(key, std::forward<Traits>(traits)...);
  return *this;
}
 
inline TargetKindRegEntry& TargetKindRegEntry::set_name() {
  if (kind_->name.empty()) {
    kind_->name = name;
  }
  return *this;
}
 
#define TVM_TARGET_KIND_REGISTER_VAR_DEF \
  [[maybe_unused]] static ::tvm::TargetKindRegEntry& __make_##TargetKind
 
#define TVM_REGISTER_TARGET_KIND(TargetKindName, DeviceType)          \
  TVM_FFI_STR_CONCAT(TVM_TARGET_KIND_REGISTER_VAR_DEF, __COUNTER__) = \
      ::tvm::TargetKindRegEntry::RegisterOrGet(TargetKindName)        \
          .set_name()                                                 \
          .set_default_device_type(DeviceType)                        \
          .add_attr_option<ffi::String>("kind")                       \
          .add_attr_option<ffi::Array<ffi::String>>("keys")           \
          .add_attr_option<ffi::String>("tag")                        \
          .add_attr_option<ffi::String>("device")                     \
          .add_attr_option<ffi::String>("model")                      \
          .add_attr_option<ffi::Array<ffi::String>>("libs")           \
          .add_attr_option<Target>("host")                            \
          .add_attr_option<int64_t>("from_device")                    \
          .add_attr_option<int64_t>("target_device_type")
 
}  // namespace tvm
 
#endif  // TVM_TARGET_TARGET_KIND_H_