registry.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_RUNTIME_REGISTRY_H_
#define TVM_RUNTIME_REGISTRY_H_
 
#include <tvm/runtime/container/string.h>
#include <tvm/runtime/packed_func.h>
 
#include <type_traits>
#include <utility>
#include <vector>
 
namespace tvm {
namespace runtime {
 
TVM_DLL void EnvCheckSignals();
 
class WrappedPythonObject {
 public:
  WrappedPythonObject() : python_obj_(nullptr) {}
 
  explicit WrappedPythonObject(std::nullptr_t) : python_obj_(nullptr) {}
 
  explicit WrappedPythonObject(void* python_obj);
 
  ~WrappedPythonObject();
 
  WrappedPythonObject(WrappedPythonObject&&);
  WrappedPythonObject& operator=(WrappedPythonObject&&);
 
  WrappedPythonObject(const WrappedPythonObject&);
  WrappedPythonObject& operator=(const WrappedPythonObject&);
  WrappedPythonObject& operator=(std::nullptr_t);
 
  operator bool() { return python_obj_; }
 
  void* raw_pointer() { return python_obj_; }
 
 private:
  void* python_obj_ = nullptr;
};
 
class Registry {
 public:
  TVM_DLL Registry& set_body(PackedFunc f);  // NOLINT(*)
  template <typename TCallable,
            typename = typename std::enable_if_t<
                std::is_convertible<TCallable, std::function<void(TVMArgs, TVMRetValue*)>>::value &&
                !std::is_base_of<PackedFunc, TCallable>::value>>
  Registry& set_body(TCallable f) {  // NOLINT(*)
    return set_body(PackedFunc(f));
  }
  template <typename FLambda>
  Registry& set_body_typed(FLambda f) {
    using FType = typename detail::function_signature<FLambda>::FType;
    return set_body(TypedPackedFunc<FType>(std::move(f), name_).packed());
  }
  template <typename T, typename R, typename... Args>
  Registry& set_body_method(R (T::*f)(Args...)) {
    using R_ = typename std::remove_reference<R>::type;
    auto fwrap = [f](T target, Args... params) -> R_ {
      // call method pointer
      return (target.*f)(params...);
    };
    return set_body(TypedPackedFunc<R_(T, Args...)>(fwrap, name_));
  }
 
  template <typename T, typename R, typename... Args>
  Registry& set_body_method(R (T::*f)(Args...) const) {
    auto fwrap = [f](const T target, Args... params) -> R {
      // call method pointer
      return (target.*f)(params...);
    };
    return set_body(TypedPackedFunc<R(const T, Args...)>(fwrap, name_));
  }
 
  template <typename TObjectRef, typename TNode, typename R, typename... Args,
            typename = typename std::enable_if<std::is_base_of<ObjectRef, TObjectRef>::value>::type>
  Registry& set_body_method(R (TNode::*f)(Args...)) {
    auto fwrap = [f](TObjectRef ref, Args... params) {
      TNode* target = ref.operator->();
      // call method pointer
      return (target->*f)(params...);
    };
    return set_body(TypedPackedFunc<R(TObjectRef, Args...)>(fwrap, name_));
  }
 
  template <typename TObjectRef, typename TNode, typename R, typename... Args,
            typename = typename std::enable_if<std::is_base_of<ObjectRef, TObjectRef>::value>::type>
  Registry& set_body_method(R (TNode::*f)(Args...) const) {
    auto fwrap = [f](TObjectRef ref, Args... params) {
      const TNode* target = ref.operator->();
      // call method pointer
      return (target->*f)(params...);
    };
    return set_body(TypedPackedFunc<R(TObjectRef, Args...)>(fwrap, name_));
  }
 
  TVM_DLL static Registry& Register(const String& name, bool override = false);  // NOLINT(*)
  TVM_DLL static bool Remove(const String& name);
  TVM_DLL static const PackedFunc* Get(const String& name);  // NOLINT(*)
  TVM_DLL static std::vector<String> ListNames();
 
  // Internal class.
  struct Manager;
 
 protected:
  String name_;
  PackedFunc func_;
  friend struct Manager;
};
 
#define TVM_FUNC_REG_VAR_DEF static TVM_ATTRIBUTE_UNUSED ::tvm::runtime::Registry& __mk_##TVM
 
#define TVM_REGISTER_GLOBAL(OpName) \
  TVM_STR_CONCAT(TVM_FUNC_REG_VAR_DEF, __COUNTER__) = ::tvm::runtime::Registry::Register(OpName)
 
#define TVM_STRINGIZE_DETAIL(x) #x
#define TVM_STRINGIZE(x) TVM_STRINGIZE_DETAIL(x)
#define TVM_DESCRIBE(...) describe(__VA_ARGS__ "\n\nFrom:" __FILE__ ":" TVM_STRINGIZE(__LINE__))
#define TVM_ADD_FILELINE "\n\nDefined in " __FILE__ ":L" TVM_STRINGIZE(__LINE__)
 
}  // namespace runtime
}  // namespace tvm
#endif  // TVM_RUNTIME_REGISTRY_H_