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.
 */

// Acknowledgement: This file originates from incubator-tvm
#ifndef MXNET_RUNTIME_REGISTRY_H_
#define MXNET_RUNTIME_REGISTRY_H_

#include <string>
#include <vector>
#include "packed_func.h"

namespace mxnet {
namespace runtime {

class Registry {
 public:
  MXNET_DLL Registry& set_body(PackedFunc f);  // NOLINT(*)
  Registry& set_body(PackedFunc::FType f) {  // NOLINT(*)
    return set_body(PackedFunc(f));
  }
  template<typename FType, typename FLambda>
  Registry& set_body_typed(FLambda f) {
    return set_body(TypedPackedFunc<FType>(f).packed());
  }

  template<typename R, typename ...Args>
  Registry& set_body_typed(R (*f)(Args...)) {
    return set_body(TypedPackedFunc<R(Args...)>(f));
  }

  template<typename T, typename R, typename ...Args>
  Registry& set_body_method(R (T::*f)(Args...)) {
    return set_body_typed<R(T, Args...)>([f](T target, Args... params) -> R {
      // call method pointer
      return (target.*f)(params...);
    });
  }

  template<typename T, typename R, typename ...Args>
  Registry& set_body_method(R (T::*f)(Args...) const) {
    return set_body_typed<R(T, Args...)>([f](const T target, Args... params) -> R {
      // call method pointer
      return (target.*f)(params...);
    });
  }

  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...)) {
    return set_body_typed<R(TObjectRef, Args...)>([f](TObjectRef ref, Args... params) {
      TNode* target = ref.operator->();
      // call method pointer
      return (target->*f)(params...);
    });
  }

  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) {
    return set_body_typed<R(TObjectRef, Args...)>([f](TObjectRef ref, Args... params) {
      const TNode* target = ref.operator->();
      // call method pointer
      return (target->*f)(params...);
    });
  }

  MXNET_DLL static Registry& Register(const std::string& name, bool override = false);  // NOLINT(*)
  MXNET_DLL static bool Remove(const std::string& name);
  MXNET_DLL static const PackedFunc* Get(const std::string& name);  // NOLINT(*)
  MXNET_DLL static std::vector<std::string> ListNames();

  // Internal class.
  struct Manager;

 protected:
  std::string name_;
  PackedFunc func_;
  friend struct Manager;
};

#if defined(__GNUC__)
#define MXNET_ATTRIBUTE_UNUSED __attribute__((unused))
#else
#define MXNET_ATTRIBUTE_UNUSED
#endif

#define MXNET_STR_CONCAT_(__x, __y) __x##__y
#define MXNET_STR_CONCAT(__x, __y) MXNET_STR_CONCAT_(__x, __y)

#define MXNET_FUNC_REG_VAR_DEF                                            \
  static MXNET_ATTRIBUTE_UNUSED ::mxnet::runtime::Registry& __mk_ ## MXNET

#define MXNET_REGISTER_GLOBAL(OpName)                              \
  MXNET_STR_CONCAT(MXNET_FUNC_REG_VAR_DEF, __COUNTER__) =            \
      ::mxnet::runtime::Registry::Register(OpName)

}  // namespace runtime
}  // namespace mxnet
#endif  // MXNET_RUNTIME_REGISTRY_H_