op_registry.h 8.9 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"
Y
Yu Yang 已提交
24
#include "paddle/framework/framework.pb.h"
F
fengjiayi 已提交
25
#include "paddle/framework/grad_op_builder.h"
Y
Yu Yang 已提交
26
#include "paddle/framework/op_info.h"
27
#include "paddle/framework/operator.h"
D
dongzhihong 已提交
28
#include "paddle/framework/scope.h"
29 30 31 32 33 34

namespace paddle {
namespace framework {

class OpRegistry {
 public:
35
  template <typename OpType, typename ProtoMakerType, typename GradOpType>
F
WIP  
fengjiayi 已提交
36 37
  static void RegisterOp(const std::string& op_type,
                         const std::string& grad_op_type) {
Y
Yu Yang 已提交
38
    PADDLE_ENFORCE(OpInfoMap().count(op_type) == 0,
F
WIP  
fengjiayi 已提交
39 40
                   "'%s' is registered more than once.", op_type);
    OpInfo op_info;
Y
Yu Yang 已提交
41 42 43
    op_info.creator_ = [](
        const std::string& type, const VariableNameMap& inputs,
        const VariableNameMap& outputs, const AttributeMap& attrs) {
Y
Yu Yang 已提交
44 45
      return new OpType(type, inputs, outputs, attrs);
    };
F
WIP  
fengjiayi 已提交
46 47 48 49
    op_info.grad_op_type_ = grad_op_type;
    if (std::type_index(typeid(ProtoMakerType)) !=
        std::type_index(typeid(NOPMaker))) {
      op_info.proto_ = new OpProto;
F
fengjiayi 已提交
50 51
      op_info.checker_ = new OpAttrChecker;
      auto maker = ProtoMakerType(op_info.proto_, op_info.checker_);
F
WIP  
fengjiayi 已提交
52
      maker.Validate();
53
      op_info.proto_->set_type(op_type);
F
WIP  
fengjiayi 已提交
54 55 56 57
      PADDLE_ENFORCE(
          op_info.proto_->IsInitialized(),
          "Fail to initialize %s's OpProto, because %s is not initialized",
          op_type, op_info.proto_->InitializationErrorString());
F
fengjiayi 已提交
58 59 60
    } else {
      op_info.proto_ = nullptr;
      op_info.checker_ = nullptr;
Y
Yu Yang 已提交
61
    }
Y
Yu Yang 已提交
62
    OpInfoMap().insert(std::make_pair(op_type, op_info));
63 64 65 66
    // register gradient op
    if (!grad_op_type.empty()) {
      RegisterOp<GradOpType, NOPMaker, NOP>(grad_op_type, "");
    }
F
fengjiayi 已提交
67 68
  }

Y
Yu Yang 已提交
69
  static std::unique_ptr<OperatorBase> CreateOp(const std::string& type,
Y
Yu Yang 已提交
70 71
                                                const VariableNameMap& inputs,
                                                const VariableNameMap& outputs,
72
                                                AttributeMap attrs);
Y
Yu Yang 已提交
73

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

76
  static std::unique_ptr<OperatorBase> CreateGradOp(const OperatorBase& op);
77
};
78

F
Fix bug  
fengjiayi 已提交
79 80
class Registrar {
 public:
81 82 83 84 85 86 87
  // 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
88
  // registrar variable won't be removed by the linker.
F
Fix bug  
fengjiayi 已提交
89 90
  void Touch() {}
};
F
fengjiayi 已提交
91

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

F
fengjiayi 已提交
102 103 104 105
template <typename PlaceType, typename KernelType>
class OpKernelRegistrar : public Registrar {
 public:
  explicit OpKernelRegistrar(const char* op_type) {
106
    OperatorWithKernel::OpKernelKey key;
F
fengjiayi 已提交
107
    key.place_ = PlaceType();
108
    OperatorWithKernel::AllOpKernels()[op_type][key].reset(new KernelType);
F
fengjiayi 已提交
109 110 111
  }
};

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

121
/**
122
 * Macro to register Operator.
123
 */
124 125
#define REGISTER_OP(op_type, op_class, op_maker_class, grad_op_type,          \
                    grad_op_class)                                            \
F
fengjiayi 已提交
126 127
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                             \
      __reg_op__##op_type, "REGISTER_OP must be called in global namespace"); \
Y
Yu Yang 已提交
128 129 130
  class _OpClass_##op_type##_ : public op_class {                             \
   public:                                                                    \
    DEFINE_OP_CLONE_METHOD(_OpClass_##op_type##_);                            \
Y
Yu Yang 已提交
131
    DEFINE_OP_CONSTRUCTOR(_OpClass_##op_type##_, op_class);                   \
Y
Yu Yang 已提交
132
  };                                                                          \
133 134 135 136 137 138 139
  class _OpGradClass_##op_type##_ : public grad_op_class {                    \
   public:                                                                    \
    DEFINE_OP_CLONE_METHOD(_OpGradClass_##op_type##_);                        \
    DEFINE_OP_CONSTRUCTOR(_OpGradClass_##op_type##_, grad_op_class);          \
  };                                                                          \
  static ::paddle::framework::OpRegistrar<                                    \
      _OpClass_##op_type##_, op_maker_class, _OpGradClass_##op_type##_>       \
F
WIP  
fengjiayi 已提交
140
      __op_registrar_##op_type##__(#op_type, #grad_op_type);                  \
F
fengjiayi 已提交
141
  int TouchOpRegistrar_##op_type() {                                          \
F
Fix bug  
fengjiayi 已提交
142
    __op_registrar_##op_type##__.Touch();                                     \
F
fengjiayi 已提交
143 144
    return 0;                                                                 \
  }
Y
Yu Yang 已提交
145

F
WIP  
fengjiayi 已提交
146
#define REGISTER_OP_WITHOUT_GRADIENT(op_type, op_class, op_maker_class) \
147
  REGISTER_OP(op_type, op_class, op_maker_class, , ::paddle::framework::NOP)
D
dongzhihong 已提交
148

D
dongzhihong 已提交
149
/**
150
 * Macro to register OperatorKernel.
D
dongzhihong 已提交
151
 */
F
Fix bug  
fengjiayi 已提交
152 153 154 155 156 157 158 159 160
#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 已提交
161
  }
D
dongzhihong 已提交
162

F
fengjiayi 已提交
163 164
#define REGISTER_OP_GPU_KERNEL(op_type, ...) \
  REGISTER_OP_KERNEL(op_type, GPU, ::paddle::platform::GPUPlace, __VA_ARGS__)
F
fengjiayi 已提交
165

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

169
/**
170 171
 * Macro to mark what Operator and Kernel
 * we will use and tell the compiler to
172 173
 * link them into target.
 */
F
fengjiayi 已提交
174 175 176 177 178 179
#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 已提交
180
      TouchOpRegistrar_##op_type()
F
fengjiayi 已提交
181

182
#define USE_OP_DEVICE_KERNEL(op_type, DEVICE_TYPE)               \
F
fengjiayi 已提交
183 184
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                \
      __use_op_kernel_##op_type##_##DEVICE_TYPE##__,             \
185
      "USE_OP_DEVICE_KERNEL must be in global namespace");       \
F
fengjiayi 已提交
186 187 188
  extern int TouchOpKernelRegistrar_##op_type##_##DEVICE_TYPE(); \
  static int use_op_kernel_##op_type##_##DEVICE_TYPE##_          \
      __attribute__((unused)) =                                  \
F
Fix bug  
fengjiayi 已提交
189
          TouchOpKernelRegistrar_##op_type##_##DEVICE_TYPE()
Y
Yu Yang 已提交
190

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

194
#ifdef PADDLE_ONLY_CPU
195
#define USE_OP_KERNEL(op_type) USE_OP_DEVICE_KERNEL(op_type, CPU)
Y
Yu Yang 已提交
196
#else
197 198 199
#define USE_OP_KERNEL(op_type)        \
  USE_OP_DEVICE_KERNEL(op_type, CPU); \
  USE_OP_DEVICE_KERNEL(op_type, GPU)
Y
Yu Yang 已提交
200
#endif
201

F
WIP  
fengjiayi 已提交
202 203 204
#define USE_CPU_ONLY_OP(op_type) \
  USE_OP_ITSELF(op_type);        \
  USE_OP_DEVICE_KERNEL(op_type, CPU);
205

F
WIP  
fengjiayi 已提交
206 207 208
#define USE_OP(op_type)   \
  USE_OP_ITSELF(op_type); \
  USE_OP_KERNEL(op_type)
209

210 211
}  // namespace framework
}  // namespace paddle