op_registry.h 10.5 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
Yu Yang 已提交
23 24

#include "glog/logging.h"  // For VLOG()
Y
Yi Wang 已提交
25
#include "paddle/framework/attribute.h"
26
#include "paddle/framework/details/op_registry.h"
Y
Yu Yang 已提交
27
#include "paddle/framework/framework.pb.h"
Y
Yu Yang 已提交
28
#include "paddle/framework/grad_op_desc_maker.h"
Y
Yu Yang 已提交
29
#include "paddle/framework/op_desc.h"
30
#include "paddle/framework/operator.h"
D
dongzhihong 已提交
31
#include "paddle/framework/scope.h"
32
#include "paddle/framework/shape_inference.h"
33 34 35

namespace paddle {
namespace framework {
Y
Yu Yang 已提交
36 37 38 39
class Registrar {
 public:
  // In our design, various kinds of classes, e.g., operators and kernels,
  // have their corresponding registry and registrar. The action of
40 41
  // registration is in the constructor of a global registrar variable, which
  // are not used in the code that calls package framework, and would
Y
Yu Yang 已提交
42 43 44 45 46 47
  // 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() {}
};
48

49
template <typename... ARGS>
Y
Yu Yang 已提交
50
struct OperatorRegistrar : public Registrar {
51
  explicit OperatorRegistrar(const char* op_type) {
52 53 54 55
    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");
56
    OpInfo info;
57
    details::OperatorRegistrarRecursive<0, false, ARGS...>(op_type, &info);
Y
Yu Yang 已提交
58
    OpInfoMap::Instance().Insert(op_type, info);
59 60 61
  }
};

62 63
class OpRegistry {
 public:
Y
Yu Yang 已提交
64
  static std::unique_ptr<OperatorBase> CreateOp(const std::string& type,
Y
Yu Yang 已提交
65 66
                                                const VariableNameMap& inputs,
                                                const VariableNameMap& outputs,
67
                                                AttributeMap attrs);
Y
Yu Yang 已提交
68

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

Y
Yu Yang 已提交
71
  static std::unique_ptr<OperatorBase> CreateOp(const OpDesc& op_desc);
F
Fix bug  
fengjiayi 已提交
72
};
F
fengjiayi 已提交
73

74 75 76
template <typename PlaceType, bool at_end, size_t I, typename... KernelType>
struct OpKernelRegistrarFunctor;

77 78 79 80
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;
81

D
dzhwinter 已提交
82
  void operator()(const char* op_type, const char* library_type) const {
83
    using T = typename KERNEL_TYPE::ELEMENT_TYPE;
D
dzhwinter 已提交
84 85
    OpKernelType key(ToDataType(std::type_index(typeid(T))), PlaceType(),
                     DataLayout::kAnyLayout, StringToLibraryType(library_type));
86
    OperatorWithKernel::AllOpKernels()[op_type][key].reset(new KERNEL_TYPE);
87

88 89
    constexpr auto size = std::tuple_size<std::tuple<KernelTypes...>>::value;
    OpKernelRegistrarFunctor<PlaceType, I + 1 == size, I + 1, KernelTypes...>
90
        func;
D
dzhwinter 已提交
91
    func(op_type, library_type);
92 93 94 95 96
  }
};

template <typename PlaceType, size_t I, typename... KernelType>
struct OpKernelRegistrarFunctor<PlaceType, true, I, KernelType...> {
D
dzhwinter 已提交
97
  void operator()(const char* op_type, const char* library_type) const {}
98 99 100 101
};

// User can register many kernel in one place. The data type could be different.
template <typename PlaceType, typename... KernelType>
F
fengjiayi 已提交
102 103
class OpKernelRegistrar : public Registrar {
 public:
D
dzhwinter 已提交
104
  explicit OpKernelRegistrar(const char* op_type, const char* library_type) {
105
    OpKernelRegistrarFunctor<PlaceType, false, 0, KernelType...> func;
D
dzhwinter 已提交
106
    func(op_type, library_type);
F
fengjiayi 已提交
107 108 109
  }
};

110 111 112
/**
 * check if MACRO is used in GLOBAL NAMESPACE.
 */
Y
Yu Yang 已提交
113 114 115 116 117 118
#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)

119 120 121 122 123 124 125 126
/*
  The variadic arguments should be class types derived from one of the
  following classes:
    OpProtoAndCheckerMaker
    GradOpDescMakerBase
    VarTypeInference
    InferShapeBase
*/
Y
Yu Yang 已提交
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
#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 已提交
142 143
  }

144
/**
145 146
 * Macro to register Operator. When the input is duplicable, you should
 * use REGISTER_OP_EX with deop_empty_grad=false instead.
147
 */
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
#define REGISTER_OP(op_type, op_class, op_maker_class, grad_op_type, \
                    grad_op_class)                                   \
  REGISTER_OP_EX(op_type, op_class, op_maker_class, grad_op_type,    \
                 grad_op_class, true)

// When an argument is duplicable, we need to use this version.
// Perhaps we can omit DropEmptyIG template parameter and
// only have one version of REGISTER_OP.
#define REGISTER_OP_EX(op_type, op_class, op_maker_class, grad_op_type,       \
                       grad_op_class, drop_empty_grad)                        \
  REGISTER_OPERATOR(grad_op_type, grad_op_class);                             \
  class _GradOpDescMaker_##grad_op_type##_                                    \
      : public ::paddle::framework::DefaultGradOpDescMaker<drop_empty_grad> { \
    using ::paddle::framework::DefaultGradOpDescMaker<                        \
        drop_empty_grad>::DefaultGradOpDescMaker;                             \
                                                                              \
   protected:                                                                 \
    virtual std::string GradOpType() const { return #grad_op_type; }          \
  };                                                                          \
  REGISTER_OPERATOR(op_type, op_class, _GradOpDescMaker_##grad_op_type##_,    \
Y
Yu Yang 已提交
168
                    op_maker_class);
Y
Yu Yang 已提交
169

Y
Yu Yang 已提交
170 171 172 173
#define REGISTER_OP_WITH_KERNEL(op_type, ...)                         \
  REGISTER_OPERATOR(op_type, ::paddle::framework::OperatorWithKernel, \
                    ##__VA_ARGS__)

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

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

Q
QI JUN 已提交
192
#define REGISTER_OP_CUDA_KERNEL(op_type, ...) \
D
dzhwinter 已提交
193
  REGISTER_OP_KERNEL(op_type, CUDA, ::paddle::platform::CUDAPlace, __VA_ARGS__)
F
fengjiayi 已提交
194

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

198
/**
199 200
 * Macro to mark what Operator and Kernel
 * we will use and tell the compiler to
201 202
 * link them into target.
 */
F
fengjiayi 已提交
203 204 205 206 207 208
#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 已提交
209
      TouchOpRegistrar_##op_type()
F
fengjiayi 已提交
210

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

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

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

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

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

Q
QI JUN 已提交
237 238 239
#define USE_CUDA_ONLY_OP(op_type) \
  USE_OP_ITSELF(op_type);         \
  USE_OP_DEVICE_KERNEL(op_type, CUDA)
D
Dong Zhihong 已提交
240

F
WIP  
fengjiayi 已提交
241 242 243
#define USE_OP(op_type)   \
  USE_OP_ITSELF(op_type); \
  USE_OP_KERNEL(op_type)
244

245 246
}  // namespace framework
}  // namespace paddle