target.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_H_
#define TVM_TARGET_TARGET_H_
 
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/expr.h>
#include <tvm/ir/function.h>
#include <tvm/node/attr_registry_map.h>
#include <tvm/node/node.h>
#include <tvm/runtime/device_api.h>
#include <tvm/support/with.h>
#include <tvm/target/target_kind.h>
 
#include <string>
#include <unordered_set>
#include <vector>
 
namespace tvm {
 
class TargetInternal;
class Target;
 
class TargetNode : public Object {
 public:
  TargetKind kind;
  ffi::Optional<ObjectRef> host;
  ffi::String tag;
  ffi::Array<ffi::String> keys;
  ffi::Map<ffi::String, Any> attrs;
  ffi::Map<ffi::String, Any> features;
 
  TVM_DLL const std::string& str() const;
  TVM_DLL ffi::Map<ffi::String, ffi::Any> Export() const;
  TVM_DLL ffi::Optional<Target> GetHost() const;
  TVM_DLL int GetTargetDeviceType() const;
 
  TVM_DLL bool HasKey(const std::string& query_key) const;
 
  ffi::String ToDebugString() const;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TargetNode>()
        .def_ro("kind", &TargetNode::kind)
        .def_ro("tag", &TargetNode::tag)
        .def_ro("keys", &TargetNode::keys)
        .def_ro("attrs", &TargetNode::attrs)
        .def_ro("features", &TargetNode::features)
        .def_ro("host", &TargetNode::host);
  }
 
  template <typename TObjectRef>
  ffi::Optional<TObjectRef> GetAttr(
      const std::string& attr_key,
      ffi::Optional<TObjectRef> default_value = ffi::Optional<TObjectRef>(std::nullopt)) const {
    auto it = attrs.find(attr_key);
    if (it != attrs.end()) {
      return Downcast<ffi::Optional<TObjectRef>>((*it).second);
    } else {
      return default_value;
    }
  }
  template <typename TObjectRef>
  ffi::Optional<TObjectRef> GetAttr(const std::string& attr_key, TObjectRef default_value) const {
    return GetAttr<TObjectRef>(attr_key, ffi::Optional<TObjectRef>(default_value));
  }
 
  template <typename TObjectRef>
  ffi::Optional<TObjectRef> GetFeature(
      const std::string& feature_key,
      ffi::Optional<TObjectRef> default_value = std::nullopt) const {
    if (auto feature = features.Get(feature_key)) {
      return Downcast<TObjectRef>(feature.value());
    } else {
      return default_value;
    }
  }
  // variant that uses TObjectRef to enable implicit conversion to default value.
  template <typename TObjectRef>
  ffi::Optional<TObjectRef> GetFeature(const std::string& attr_key,
                                       TObjectRef default_value) const {
    return GetFeature<TObjectRef>(attr_key, ffi::Optional<TObjectRef>(default_value));
  }
 
  TVM_DLL std::vector<std::string> GetKeys() const;
  TVM_DLL std::unordered_set<std::string> GetLibs() const;
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("target.Target", TargetNode, Object);
 
 private:
  mutable std::string str_repr_;
 
  friend class TargetInternal;
};
 
class Target : public ObjectRef {
 public:
  TVM_DLL explicit Target(std::nullptr_t) { data_ = nullptr; }
  TVM_DLL explicit Target(const ffi::String& tag_or_config_or_target_str);
  TVM_DLL explicit Target(const ffi::Map<ffi::String, ffi::Any>& config);
  TVM_DLL static tvm::Target Current(bool allow_not_defined = true);
  TVM_DLL explicit Target(Target target, Target host);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(Target, ObjectRef, TargetNode);
  static Target WithHost(const Target& target, const Target& host);
 
  Target WithoutHost() const;
 
 private:
  Target(TargetKind kind, ffi::Optional<ObjectRef> host, ffi::String tag,
         ffi::Array<ffi::String> keys, ffi::Map<ffi::String, ffi::Any> attrs);
 
  // enable with syntax.
  friend class TargetInternal;
  friend class With<Target>;
  TVM_DLL void EnterWithScope();
  TVM_DLL void ExitWithScope();
};
 
void CheckAndUpdateHostConsistency(Target* target, Target* host);
 
}  // namespace tvm
#endif  // TVM_TARGET_TARGET_H_