env_func.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_ENV_FUNC_H_
#define TVM_IR_ENV_FUNC_H_
 
#include <tvm/ffi/function.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/node/node.h>
 
#include <string>
#include <utility>
 
namespace tvm {
class EnvFuncNode : public Object {
 public:
  String name;
  ffi::Function func;
  EnvFuncNode() {}
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    // func do not participate in structural equal and hash.
    refl::ObjectDef<EnvFuncNode>()
        .def_ro("name", &EnvFuncNode::name)
        .def_ro("func", &EnvFuncNode::func, refl::AttachFieldFlag::SEqHashIgnore());
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
  static constexpr const char* _type_key = "ir.EnvFunc";
 
  TVM_DECLARE_FINAL_OBJECT_INFO(EnvFuncNode, Object);
};
 
class EnvFunc : public ObjectRef {
 public:
  EnvFunc() {}
  explicit EnvFunc(ObjectPtr<Object> n) : ObjectRef(n) {}
  const EnvFuncNode* operator->() const { return static_cast<const EnvFuncNode*>(get()); }
  template <typename... Args>
  ffi::Any operator()(Args&&... args) const {
    const EnvFuncNode* n = operator->();
    ICHECK(n != nullptr);
    return n->func(std::forward<Args>(args)...);
  }
  TVM_DLL static EnvFunc Get(const String& name);
  using ContainerType = EnvFuncNode;
};
 
template <typename FType>
class TypedEnvFunc;
 
template <typename R, typename... Args>
class TypedEnvFunc<R(Args...)> : public ObjectRef {
 public:
  using TSelf = TypedEnvFunc<R(Args...)>;
  TypedEnvFunc() {}
  explicit TypedEnvFunc(ObjectPtr<Object> n) : ObjectRef(n) {}
  TSelf& operator=(const EnvFunc& other) {
    ObjectRef::operator=(other);
    return *this;
  }
  const EnvFuncNode* operator->() const { return static_cast<const EnvFuncNode*>(get()); }
  R operator()(Args... args) const {
    const EnvFuncNode* n = operator->();
    ICHECK(n != nullptr);
    if constexpr (std::is_same_v<R, void>) {
      n->func(std::forward<Args>(args)...);
    } else {
      ffi::Any res = n->func(std::forward<Args>(args)...);
      if constexpr (std::is_same_v<R, ffi::Any>) {
        return res;
      } else {
        return std::move(res).cast<R>();
      }
    }
  }
  using ContainerType = EnvFuncNode;
};
 
}  // namespace tvm
#endif  // TVM_IR_ENV_FUNC_H_