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/ir/expr.h>
#include <tvm/ir/module.h>
#include <tvm/node/node.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;
  Optional<ObjectRef> host;
  String tag;
  Array<String> keys;
  Map<String, ObjectRef> attrs;
  Map<String, ObjectRef> features;

  TVM_DLL const std::string& str() const;
  TVM_DLL Map<String, ObjectRef> Export() const;
  TVM_DLL Optional<Target> GetHost() const;
  TVM_DLL int GetTargetDeviceType() const;

  String ToDebugString() const;

  void VisitAttrs(AttrVisitor* v) {
    v->Visit("kind", &kind);
    v->Visit("tag", &tag);
    v->Visit("keys", &keys);
    v->Visit("attrs", &attrs);
    v->Visit("features", &features);
    v->Visit("host", &host);
  }

  template <typename TObjectRef>
  Optional<TObjectRef> GetAttr(
      const std::string& attr_key,
      Optional<TObjectRef> default_value = Optional<TObjectRef>(nullptr)) const {
    static_assert(std::is_base_of<ObjectRef, TObjectRef>::value,
                  "Can only call GetAttr with ObjectRef types.");
    auto it = attrs.find(attr_key);
    if (it != attrs.end()) {
      return Downcast<Optional<TObjectRef>>((*it).second);
    } else {
      return 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));
  }

  template <typename TObjectRef>
  Optional<TObjectRef> GetFeature(
      const std::string& feature_key,
      Optional<TObjectRef> default_value = Optional<TObjectRef>(nullptr)) const {
    Optional<TObjectRef> feature = Downcast<Optional<TObjectRef>>(features.Get(feature_key));
    if (!feature) {
      return default_value;
    }
    return feature;
  }
  // variant that uses TObjectRef to enable implicit conversion to default value.
  template <typename TObjectRef>
  Optional<TObjectRef> GetFeature(const std::string& attr_key, TObjectRef default_value) const {
    return GetFeature<TObjectRef>(attr_key, Optional<TObjectRef>(default_value));
  }

  TVM_DLL std::vector<std::string> GetKeys() const;
  TVM_DLL std::unordered_set<std::string> GetLibs() const;

  bool SEqualReduce(const TargetNode* other, SEqualReducer equal) const;
  void SHashReduce(SHashReducer hash_reduce) const;

  static constexpr const char* _type_key = "Target";
  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(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 String& tag_or_config_or_target_str);
  TVM_DLL explicit Target(const Map<String, ObjectRef>& config);
  TVM_DLL static tvm::Target Current(bool allow_not_defined = true);
  TVM_DLL explicit Target(Target target, Target host);
  TVM_DEFINE_OBJECT_REF_METHODS(Target, ObjectRef, TargetNode);
  static Target WithHost(const Target& target, const Target& host);

  bool IsExternalCodegen() const;

  bool IsExternalCodegenFor(const Target& that) const;

 private:
  Target(TargetKind kind, Optional<ObjectRef> host, String tag, Array<String> keys,
         Map<String, ObjectRef> 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);

void CheckAndUpdateHostConsistency(Map<Target, IRModule>* ir_modules, Target* host);

}  // namespace tvm
#endif  // TVM_TARGET_TARGET_H_