op_registry.h 10.1 KB
Newer Older
F
fengjiayi 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* Copyright (c) 2016 PaddlePaddle Authors. All Rights Reserve.

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

15 16
#pragma once

17
#include <algorithm>
18
#include <atomic>
Y
Yu Yang 已提交
19
#include <type_traits>
F
WIP  
fengjiayi 已提交
20
#include <typeinfo>
21 22
#include <unordered_map>
#include <unordered_set>
Y
Yi Wang 已提交
23
#include "paddle/framework/attribute.h"
24
#include "paddle/framework/details/op_registry.h"
Y
Yu Yang 已提交
25
#include "paddle/framework/framework.pb.h"
Y
Yu Yang 已提交
26
#include "paddle/framework/grad_op_desc_maker.h"
Y
Yu Yang 已提交
27
#include "paddle/framework/op_desc.h"
28
#include "paddle/framework/operator.h"
D
dongzhihong 已提交
29
#include "paddle/framework/scope.h"
30 31 32

namespace paddle {
namespace framework {
Y
Yu Yang 已提交
33 34 35 36 37 38 39 40 41 42 43 44
class Registrar {
 public:
  // In our design, various kinds of classes, e.g., operators and kernels,
  // have their corresponding registry and registrar. The action of
  // registration is in the constructor of a global registrar variable, which,
  // however, are not used in the code that calls package framework, and would
  // be removed from the generated binary file by the linker. To avoid such
  // removal, we add Touch to all registrar classes and make USE_OP macros to
  // call this method. So, as long as the callee code calls USE_OP, the global
  // registrar variable won't be removed by the linker.
  void Touch() {}
};
45

46
template <typename... ARGS>
Y
Yu Yang 已提交
47
struct OperatorRegistrar : public Registrar {
48 49 50 51 52 53
  explicit OperatorRegistrar(const char* op_type) : op_type(op_type) {
    PADDLE_ENFORCE(!OpInfoMap::Instance().Has(op_type),
                   "'%s' is registered more than once.", op_type);
    static_assert(sizeof...(ARGS) != 0,
                  "OperatorRegistrar should be invoked at least by OpClass");
    details::OperatorRegistrarRecursive<0, false, ARGS...>(op_type, &info);
Y
Yu Yang 已提交
54
    OpInfoMap::Instance().Insert(op_type, info);
55 56 57 58 59 60 61
  }

  const char* op_type;

  OpInfo info;
};

62 63
class OpRegistry {
 public:
64
  template <typename OpType, typename ProtoMakerType, typename GradOpType>
65 66
  static void RegisterOp(const std::string& op_type,
                         const std::string& grad_op_type) {
67 68
    OperatorRegistrar<OpType, ProtoMakerType> reg(op_type.c_str());
    reg.info.grad_op_type_ = grad_op_type;
69 70
    // register gradient op
    if (!grad_op_type.empty()) {
71
      OperatorRegistrar<GradOpType> grad_reg(grad_op_type.c_str());
72
    }
F
fengjiayi 已提交
73 74
  }

Y
Yu Yang 已提交
75
  static std::unique_ptr<OperatorBase> CreateOp(const std::string& type,
Y
Yu Yang 已提交
76 77
                                                const VariableNameMap& inputs,
                                                const VariableNameMap& outputs,
78
                                                AttributeMap attrs);
Y
Yu Yang 已提交
79

80
  static std::unique_ptr<OperatorBase> CreateOp(const OpDesc& op_desc);
Y
Yu Yang 已提交
81

F
Update  
fengjiayi 已提交
82
  static std::vector<std::unique_ptr<OpDescBind>> CreateGradOpDescs(
83
      OpDescBind* op_desc);
84

Y
Yu Yang 已提交
85
  static std::unique_ptr<OperatorBase> CreateOp(const OpDescBind& op_desc);
F
Fix bug  
fengjiayi 已提交
86
};
F
fengjiayi 已提交
87

88
template <typename OpType, typename ProtoMakerType, typename GradOpType>
F
fengjiayi 已提交
89
class OpRegistrar : public Registrar {
90
 public:
91 92 93 94
  explicit OpRegistrar(const char* op_type) { OpRegistrar(op_type, ""); }
  OpRegistrar(const char* op_type, const char* grad_op_type) {
    OpRegistry::RegisterOp<OpType, ProtoMakerType, GradOpType>(op_type,
                                                               grad_op_type);
D
dongzhihong 已提交
95 96 97
  }
};

98 99 100
template <typename PlaceType, bool at_end, size_t I, typename... KernelType>
struct OpKernelRegistrarFunctor;

101 102 103 104
template <typename PlaceType, size_t I, typename... KernelTypes>
struct OpKernelRegistrarFunctor<PlaceType, false, I, KernelTypes...> {
  using KERNEL_TYPE =
      typename std::tuple_element<I, std::tuple<KernelTypes...>>::type;
105 106

  void operator()(const char* op_type) const {
107
    using T = typename KERNEL_TYPE::ELEMENT_TYPE;
108 109
    OperatorWithKernel::OpKernelKey key(ToDataType(std::type_index(typeid(T))),
                                        PlaceType());
110
    OperatorWithKernel::AllOpKernels()[op_type][key].reset(new KERNEL_TYPE);
111

112 113
    constexpr auto size = std::tuple_size<std::tuple<KernelTypes...>>::value;
    OpKernelRegistrarFunctor<PlaceType, I + 1 == size, I + 1, KernelTypes...>
114 115 116 117 118 119 120 121 122 123 124 125
        func;
    func(op_type);
  }
};

template <typename PlaceType, size_t I, typename... KernelType>
struct OpKernelRegistrarFunctor<PlaceType, true, I, KernelType...> {
  void operator()(const char* op_type) const {}
};

// User can register many kernel in one place. The data type could be different.
template <typename PlaceType, typename... KernelType>
F
fengjiayi 已提交
126 127 128
class OpKernelRegistrar : public Registrar {
 public:
  explicit OpKernelRegistrar(const char* op_type) {
129 130
    OpKernelRegistrarFunctor<PlaceType, false, 0, KernelType...> func;
    func(op_type);
F
fengjiayi 已提交
131 132 133
  }
};

134 135 136
/**
 * check if MACRO is used in GLOBAL NAMESPACE.
 */
Y
Yu Yang 已提交
137 138 139 140 141 142
#define STATIC_ASSERT_GLOBAL_NAMESPACE(uniq_name, msg)                        \
  struct __test_global_namespace_##uniq_name##__ {};                          \
  static_assert(std::is_same<::__test_global_namespace_##uniq_name##__,       \
                             __test_global_namespace_##uniq_name##__>::value, \
                msg)

Y
Yu Yang 已提交
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
#define REGISTER_OPERATOR(op_type, op_class, ...)                      \
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                      \
      __reg_op__##op_type,                                             \
      "REGISTER_OPERATOR must be called in global namespace");         \
  class _OpClass_##op_type##_ : public op_class {                      \
   public:                                                             \
    DEFINE_OP_CLONE_METHOD(_OpClass_##op_type##_);                     \
    DEFINE_OP_CONSTRUCTOR(_OpClass_##op_type##_, op_class);            \
  };                                                                   \
  static ::paddle::framework::OperatorRegistrar<_OpClass_##op_type##_, \
                                                ##__VA_ARGS__>         \
      __op_registrar_##op_type##__(#op_type);                          \
  int TouchOpRegistrar_##op_type() {                                   \
    __op_registrar_##op_type##__.Touch();                              \
    return 0;                                                          \
Y
Yu Yang 已提交
158 159
  }

160
/**
161
 * Macro to register Operator.
162
 */
Y
Yu Yang 已提交
163 164 165 166 167 168 169 170 171 172 173
#define REGISTER_OP(op_type, op_class, op_maker_class, grad_op_type,           \
                    grad_op_class)                                             \
  REGISTER_OPERATOR(grad_op_type, grad_op_class);                              \
  class _GradOpDescMaker_##grad_op_type##_                                     \
      : public ::paddle::framework::DefaultGradOpDescMaker {                   \
    using ::paddle::framework::DefaultGradOpDescMaker::DefaultGradOpDescMaker; \
                                                                               \
   protected:                                                                  \
    virtual std::string GradOpType() const { return #grad_op_type; }           \
  };                                                                           \
  REGISTER_OPERATOR(op_type, op_class, _GradOpDescMaker_##grad_op_type##_,     \
Y
Yu Yang 已提交
174
                    op_maker_class);
Y
Yu Yang 已提交
175

F
WIP  
fengjiayi 已提交
176
#define REGISTER_OP_WITHOUT_GRADIENT(op_type, op_class, op_maker_class) \
Y
Yu Yang 已提交
177
  REGISTER_OPERATOR(op_type, op_class, op_maker_class)
D
dongzhihong 已提交
178

D
dongzhihong 已提交
179
/**
180
 * Macro to register OperatorKernel.
D
dongzhihong 已提交
181
 */
F
Fix bug  
fengjiayi 已提交
182 183 184 185 186 187 188 189 190
#define REGISTER_OP_KERNEL(op_type, DEVICE_TYPE, place_class, ...)        \
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                         \
      __reg_op_kernel_##op_type##_##DEVICE_TYPE##__,                      \
      "REGISTER_OP_KERNEL must be called in global namespace");           \
  static ::paddle::framework::OpKernelRegistrar<place_class, __VA_ARGS__> \
      __op_kernel_registrar_##op_type##_##DEVICE_TYPE##__(#op_type);      \
  int TouchOpKernelRegistrar_##op_type##_##DEVICE_TYPE() {                \
    __op_kernel_registrar_##op_type##_##DEVICE_TYPE##__.Touch();          \
    return 0;                                                             \
F
fengjiayi 已提交
191
  }
D
dongzhihong 已提交
192

F
fengjiayi 已提交
193 194
#define REGISTER_OP_GPU_KERNEL(op_type, ...) \
  REGISTER_OP_KERNEL(op_type, GPU, ::paddle::platform::GPUPlace, __VA_ARGS__)
F
fengjiayi 已提交
195

F
fengjiayi 已提交
196 197
#define REGISTER_OP_CPU_KERNEL(op_type, ...) \
  REGISTER_OP_KERNEL(op_type, CPU, ::paddle::platform::CPUPlace, __VA_ARGS__)
Y
Yu Yang 已提交
198

199
/**
200 201
 * Macro to mark what Operator and Kernel
 * we will use and tell the compiler to
202 203
 * link them into target.
 */
F
fengjiayi 已提交
204 205 206 207 208 209
#define USE_OP_ITSELF(op_type)                                    \
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                 \
      __use_op_itself_##op_type,                                  \
      "USE_OP_ITSELF must be called in global namespace");        \
  extern int TouchOpRegistrar_##op_type();                        \
  static int use_op_itself_##op_type##_ __attribute__((unused)) = \
F
Fix bug  
fengjiayi 已提交
210
      TouchOpRegistrar_##op_type()
F
fengjiayi 已提交
211

212
#define USE_OP_DEVICE_KERNEL(op_type, DEVICE_TYPE)               \
F
fengjiayi 已提交
213 214
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                \
      __use_op_kernel_##op_type##_##DEVICE_TYPE##__,             \
215
      "USE_OP_DEVICE_KERNEL must be in global namespace");       \
F
fengjiayi 已提交
216 217 218
  extern int TouchOpKernelRegistrar_##op_type##_##DEVICE_TYPE(); \
  static int use_op_kernel_##op_type##_##DEVICE_TYPE##_          \
      __attribute__((unused)) =                                  \
F
Fix bug  
fengjiayi 已提交
219
          TouchOpKernelRegistrar_##op_type##_##DEVICE_TYPE()
Y
Yu Yang 已提交
220

221 222
// TODO(fengjiayi): The following macros
// seems ugly, do we have better method?
Y
Yu Yang 已提交
223

224
#ifndef PADDLE_WITH_CUDA
225
#define USE_OP_KERNEL(op_type) USE_OP_DEVICE_KERNEL(op_type, CPU)
Y
Yu Yang 已提交
226
#else
227 228 229
#define USE_OP_KERNEL(op_type)        \
  USE_OP_DEVICE_KERNEL(op_type, CPU); \
  USE_OP_DEVICE_KERNEL(op_type, GPU)
Y
Yu Yang 已提交
230
#endif
231

232 233
#define USE_NO_KERNEL_OP(op_type) USE_OP_ITSELF(op_type);

F
WIP  
fengjiayi 已提交
234 235 236
#define USE_CPU_ONLY_OP(op_type) \
  USE_OP_ITSELF(op_type);        \
  USE_OP_DEVICE_KERNEL(op_type, CPU);
237

F
WIP  
fengjiayi 已提交
238 239 240
#define USE_OP(op_type)   \
  USE_OP_ITSELF(op_type); \
  USE_OP_KERNEL(op_type)
241

242 243
}  // namespace framework
}  // namespace paddle