iter_var.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_S_TIR_ITER_VAR_H_
#define TVM_S_TIR_ITER_VAR_H_
 
#include <tvm/ffi/optional.h>
#include <tvm/ir/cow.h>
#include <tvm/ir/expr.h>
 
namespace tvm {
namespace s_tir {
enum IterVarType : int {
  kDataPar = 0,
  kThreadIndex = 1,
  kCommReduce = 2,
  kOrdered = 3,
  kOpaque = 4,
  // The following are possible additional
  // types that are provided during schedule
  kUnrolled = 5,
  kVectorized = 6,
  kParallelized = 7,
  kTensorized = 8
};
 
class IterVarNode : public OpaqueExprNode {
 public:
  explicit IterVarNode(ffi::UnsafeInit tag) : var(tag) {}
 
  explicit IterVarNode(PrimVar var) : var(std::move(var)) { ty = this->var.ty(); }
 
  ffi::Optional<Range> dom;
  PrimVar var;
  IterVarType iter_type;
  ffi::String thread_tag;
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<IterVarNode>()
        .def_ro("dom", &IterVarNode::dom)
        .def_ro("var", &IterVarNode::var, refl::AttachFieldFlag::SEqHashDefSimple())
        .def_ro("iter_type", &IterVarNode::iter_type)
        .def_ro("thread_tag", &IterVarNode::thread_tag);
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("s_tir.IterVar", IterVarNode, OpaqueExprNode);
};
 
class IterVar : public PrimExpr {
 public:
  TVM_DLL IterVar(ffi::Optional<Range> dom, PrimVar var, IterVarType iter_type,
                  ffi::String thread_tag = "", Location loc = UnknownLoc());
 
  explicit IterVar(ffi::ObjectPtr<IterVarNode> node) : PrimExpr(std::move(node)) {}
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(IterVar, PrimExpr, IterVarNode);
  static constexpr bool _type_container_is_exact = true;
  TVM_DEFINE_OBJECT_REF_COW_METHOD(IterVarNode);
};
 
inline const char* IterVarType2String(IterVarType t) {
  switch (t) {
    case kDataPar:
      return "DataPar";
    case kThreadIndex:
      return "ThreadIndex";
    case kCommReduce:
      return "CommReduce";
    case kOrdered:
      return "Ordered";
    case kOpaque:
      return "Opaque";
    case kUnrolled:
      return "Unrolled";
    case kVectorized:
      return "Vectorized";
    case kParallelized:
      return "Parallelized";
    case kTensorized:
      return "Tensorized";
  }
  return "Unknown";
}
}  // namespace s_tir
}  // namespace tvm
 
namespace std {
template <>
struct hash<::tvm::s_tir::IterVar> : public ::tvm::ffi::ObjectPtrHash {};
}  // namespace std
 
#endif  // TVM_S_TIR_ITER_VAR_H_