op_registry.h 14.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>
20 21
#include <unordered_map>
#include <unordered_set>
Y
Yi Wang 已提交
22
#include "paddle/framework/attribute.h"
Y
Yu Yang 已提交
23
#include "paddle/framework/framework.pb.h"
F
fengjiayi 已提交
24
#include "paddle/framework/grad_op_builder.h"
25
#include "paddle/framework/operator.h"
D
dongzhihong 已提交
26
#include "paddle/framework/scope.h"
27 28 29 30 31 32 33 34 35 36

namespace paddle {
namespace framework {

// this class not only make proto but also init attribute checkers.
class OpProtoAndCheckerMaker {
 public:
  OpProtoAndCheckerMaker(OpProto* proto, OpAttrChecker* op_checker)
      : proto_(proto), op_checker_(op_checker) {}

37 38 39 40 41 42 43 44
  ~OpProtoAndCheckerMaker() {
    PADDLE_ENFORCE(validated_, "should call Validate after build");
  }

  void Validate() {
    validated_ = true;
    CheckNoDuplicatedInOutAttrs();
  }
45

46
 protected:
Y
Yu Yang 已提交
47
  struct VariableBuilder {
Y
Yu Yang 已提交
48
    OpProto::Var* var_;
Y
Yu Yang 已提交
49

Y
Yu Yang 已提交
50
    VariableBuilder& AsDuplicable() {
Y
Yu Yang 已提交
51
      var_->set_duplicable(true);
Y
Yu Yang 已提交
52 53 54
      return *this;
    }

Y
Yu Yang 已提交
55
    VariableBuilder& AsIntermediate() {
Y
Yu Yang 已提交
56
      var_->set_intermediate(true);
Y
Yu Yang 已提交
57 58 59
      return *this;
    }

Y
Yu Yang 已提交
60 61 62 63
    // TODO(FengJiayi, yuyang18): `AsNoGradient` is a very bad name, because it
    // means that input/output is not needed when calculate gradient. It does
    // not mean no gradient when backward. It should be changed soon.
    VariableBuilder& AsNoGradient() {
Y
Yu Yang 已提交
64
      var_->set_no_gradient(true);
Y
Yu Yang 已提交
65 66 67 68 69 70
      return *this;
    }
  };

  VariableBuilder AddInput(const std::string& name,
                           const std::string& comment) {
71
    auto* input = proto_->add_inputs();
72 73
    input->set_name(name);
    input->set_comment(comment);
Y
Yu Yang 已提交
74
    return VariableBuilder{input};
75 76
  }

Y
Yu Yang 已提交
77 78
  VariableBuilder AddOutput(const std::string& name,
                            const std::string& comment) {
79
    auto* output = proto_->add_outputs();
80 81
    output->set_name(name);
    output->set_comment(comment);
Y
Yu Yang 已提交
82
    return VariableBuilder{output};
83 84 85 86
  }

  template <typename T>
  TypedAttrChecker<T>& AddAttr(const std::string& name,
87 88
                               const std::string& comment,
                               bool generated = false) {
89
    auto* attr = proto_->add_attrs();
90 91
    attr->set_name(name);
    attr->set_comment(comment);
92
    attr->set_generated(generated);
Y
Yi Wang 已提交
93
    attr->set_type(AttrTypeID<T>());
94 95 96
    return op_checker_->AddAttrChecker<T>(name);
  }

97
  void AddComment(const std::string& comment) { proto_->set_comment(comment); }
98

99
 private:
100
  void CheckNoDuplicatedInOutAttrs() {
101
    std::unordered_set<std::string> names;
102 103 104 105
    auto checker = [&](const std::string& name) {
      PADDLE_ENFORCE(!names.count(name), "[%s] is duplicated", name);
      names.insert(name);
    };
106
    for (auto& attr : proto_->attrs()) {
107 108 109 110 111 112 113
      checker(attr.name());
    }
    for (auto& input : proto_->inputs()) {
      checker(input.name());
    }
    for (auto& output : proto_->outputs()) {
      checker(output.name());
114 115 116
    }
  }

117 118
  OpProto* proto_;
  OpAttrChecker* op_checker_;
119
  bool validated_{false};
120 121 122
};

class OpRegistry {
Y
Yu Yang 已提交
123 124 125 126
  using VarNameMap = OperatorBase::VarNameMap;
  using OpCreator = std::function<OperatorBase*(
      const std::string& /*type*/, const VarNameMap& /*inputs*/,
      const VarNameMap& /*outputs*/, const AttributeMap& /*attrs*/)>;
127 128 129 130

 public:
  template <typename OpType, typename ProtoMakerType>
  static void RegisterOp(const std::string& op_type) {
Y
Yu Yang 已提交
131 132 133 134 135
    op_creators()[op_type] = [](
        const std::string& type, const VarNameMap& inputs,
        const VarNameMap& outputs, const AttributeMap& attrs) {
      return new OpType(type, inputs, outputs, attrs);
    };
136
    OpAttrChecker& op_checker = op_checkers()[op_type];
137
    OpProto& op_proto = OpProtos()[op_type];
138 139
    auto maker = ProtoMakerType(&op_proto, &op_checker);
    maker.Validate();
140
    op_proto.set_type(op_type);
Y
Yu Yang 已提交
141 142 143 144
    PADDLE_ENFORCE(
        op_proto.IsInitialized(),
        "Fail to initialize %s's OpProto, because %s is not initialized",
        op_type, op_proto.InitializationErrorString());
145 146
  }

147 148 149
  template <typename GradOpType>
  static void RegisterGradOp(const std::string& op_type,
                             const std::string& grad_op_type) {
Y
Yu Yang 已提交
150 151 152 153 154
    op_creators()[grad_op_type] = [](
        const std::string& type, const VarNameMap& inputs,
        const VarNameMap& outputs, const AttributeMap& attrs) {
      return new GradOpType(type, inputs, outputs, attrs);
    };
155
    grad_ops()[op_type] = grad_op_type;
F
fengjiayi 已提交
156 157
  }

Y
Yu Yang 已提交
158
  static std::shared_ptr<OperatorBase> CreateOp(const std::string& type,
Y
Yu Yang 已提交
159 160
                                                const VarNameMap& inputs,
                                                const VarNameMap& outputs,
Y
Yu Yang 已提交
161
                                                AttributeMap attrs) {
162 163
    auto op_create_it = op_creators().find(type);
    PADDLE_ENFORCE(op_create_it != op_creators().end(),
F
fengjiayi 已提交
164
                   "Operator %s cannot be found.", type);
Y
Yu Yang 已提交
165
    op_checkers().at(type).Check(attrs);
166

Y
Yu Yang 已提交
167
    auto op = op_create_it->second(type, inputs, outputs, attrs);
168

Y
Yu Yang 已提交
169
    return std::shared_ptr<OperatorBase>(op);
170 171
  }

Y
Yu Yang 已提交
172 173 174 175 176 177
  static VarNameMap ConvertOpDescVarsToVarNameMap(
      const google::protobuf::RepeatedPtrField<OpDesc::Var>& op_desc_vars) {
    VarNameMap ret_val;
    for (auto& var : op_desc_vars) {
      auto& var_names = ret_val[var.parameter()];
      auto& var_names_in_proto = var.arguments();
Y
Yu Yang 已提交
178 179 180 181
      var_names.reserve(static_cast<size_t>(var_names_in_proto.size()));
      std::copy(var_names_in_proto.begin(), var_names_in_proto.end(),
                std::back_inserter(var_names));
    }
Y
Yu Yang 已提交
182 183
    return ret_val;
  }
Y
Yu Yang 已提交
184

Y
Yu Yang 已提交
185 186 187
  static std::shared_ptr<OperatorBase> CreateOp(const OpDesc& op_desc) {
    VarNameMap inputs = ConvertOpDescVarsToVarNameMap(op_desc.inputs());
    VarNameMap outputs = ConvertOpDescVarsToVarNameMap(op_desc.outputs());
Y
Yu Yang 已提交
188
    AttributeMap attrs;
189
    for (auto& attr : op_desc.attrs()) {
Y
Yi Wang 已提交
190
      attrs[attr.name()] = GetAttrValue(attr);
191
    }
Y
Yu Yang 已提交
192 193

    return CreateOp(op_desc.type(), inputs, outputs, attrs);
194 195
  }

Y
Yu Yang 已提交
196 197
  static std::shared_ptr<OperatorBase> CreateGradOp(const OperatorBase& op) {
    PADDLE_ENFORCE(!op.IsNetOp(),
Y
Yu Yang 已提交
198
                   "Use framework::Backward to get backward ops");
199
    std::shared_ptr<OperatorBase> grad_op(BuildGradOp(&op));
F
fengjiayi 已提交
200
    return grad_op;
D
dongzhihong 已提交
201 202
  }

203 204 205
  static std::unordered_map<std::string, std::string>& grad_ops() {
    static std::unordered_map<std::string, std::string> grad_ops_;
    return grad_ops_;
206 207
  }

208 209 210
  static std::unordered_map<std::string, OpCreator>& op_creators() {
    static std::unordered_map<std::string, OpCreator> op_creators_;
    return op_creators_;
F
fengjiayi 已提交
211 212
  }

213
 private:
F
fengjiayi 已提交
214 215 216
  static std::unordered_map<std::string, OpAttrChecker>& op_checkers() {
    static std::unordered_map<std::string, OpAttrChecker> op_checkers_;
    return op_checkers_;
L
liaogang 已提交
217
  }
218
};
219

F
Fix bug  
fengjiayi 已提交
220 221
class Registrar {
 public:
222 223 224 225 226 227 228 229
  // 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.
F
Fix bug  
fengjiayi 已提交
230 231
  void Touch() {}
};
F
fengjiayi 已提交
232

233
template <typename OpType, typename ProtoMakerType>
F
fengjiayi 已提交
234
class OpRegistrar : public Registrar {
235
 public:
F
fengjiayi 已提交
236
  explicit OpRegistrar(const char* op_type) {
237 238 239 240
    OpRegistry::RegisterOp<OpType, ProtoMakerType>(op_type);
  }
};

241
template <typename GradOpType>
F
fengjiayi 已提交
242
class GradOpRegistrar : public Registrar {
D
dongzhihong 已提交
243
 public:
F
fengjiayi 已提交
244
  GradOpRegistrar(const char* op_type, const char* grad_op_type) {
245
    OpRegistry::RegisterGradOp<GradOpType>(op_type, grad_op_type);
D
dongzhihong 已提交
246 247 248
  }
};

F
fengjiayi 已提交
249 250 251 252
template <typename PlaceType, typename KernelType>
class OpKernelRegistrar : public Registrar {
 public:
  explicit OpKernelRegistrar(const char* op_type) {
253
    OperatorWithKernel::OpKernelKey key;
F
fengjiayi 已提交
254
    key.place_ = PlaceType();
255
    OperatorWithKernel::AllOpKernels()[op_type][key].reset(new KernelType);
F
fengjiayi 已提交
256 257 258
  }
};

259 260 261
/**
 * check if MACRO is used in GLOBAL NAMESPACE.
 */
Y
Yu Yang 已提交
262 263 264 265 266 267
#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)

268
/**
269
 * Macro to register Operator.
270
 */
F
fengjiayi 已提交
271 272 273
#define REGISTER_OP(op_type, op_class, op_maker_class)                        \
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                             \
      __reg_op__##op_type, "REGISTER_OP must be called in global namespace"); \
F
Fix bug  
fengjiayi 已提交
274 275
  static ::paddle::framework::OpRegistrar<op_class, op_maker_class>           \
      __op_registrar_##op_type##__(#op_type);                                 \
F
fengjiayi 已提交
276
  int TouchOpRegistrar_##op_type() {                                          \
F
Fix bug  
fengjiayi 已提交
277
    __op_registrar_##op_type##__.Touch();                                     \
F
fengjiayi 已提交
278 279
    return 0;                                                                 \
  }
Y
Yu Yang 已提交
280

D
dongzhihong 已提交
281
/**
282
 * Macro to register Gradient Operator.
D
dongzhihong 已提交
283
 */
F
Fix bug  
fengjiayi 已提交
284 285 286 287 288 289 290 291 292 293
#define REGISTER_GRADIENT_OP(op_type, grad_op_type, grad_op_class)           \
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                            \
      __reg_gradient_op__##op_type##_##grad_op_type,                         \
      "REGISTER_GRADIENT_OP must be called in global namespace");            \
  static ::paddle::framework::GradOpRegistrar<grad_op_class>                 \
      __op_gradient_registrar_##op_type##_##grad_op_type##__(#op_type,       \
                                                             #grad_op_type); \
  int TouchOpGradientRegistrar_##op_type() {                                 \
    __op_gradient_registrar_##op_type##_##grad_op_type##__.Touch();          \
    return 0;                                                                \
294
  }
D
dongzhihong 已提交
295

D
dongzhihong 已提交
296
/**
297
 * Macro to register OperatorKernel.
D
dongzhihong 已提交
298
 */
F
Fix bug  
fengjiayi 已提交
299 300 301 302 303 304 305 306 307
#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 已提交
308
  }
D
dongzhihong 已提交
309

310
/**
F
fengjiayi 已提交
311
 * Macro to Forbid user register Gradient Operator.
312
 */
F
fengjiayi 已提交
313 314 315 316 317
#define NO_GRADIENT(op_type)                           \
  STATIC_ASSERT_GLOBAL_NAMESPACE(                      \
      __reg_gradient_op__##op_type##_##op_type##_grad, \
      "NO_GRADIENT must be called in global namespace")

F
fengjiayi 已提交
318 319
#define REGISTER_OP_GPU_KERNEL(op_type, ...) \
  REGISTER_OP_KERNEL(op_type, GPU, ::paddle::platform::GPUPlace, __VA_ARGS__)
F
fengjiayi 已提交
320

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

324 325 326 327
/**
 * Macro to mark what Operator and Kernel we will use and tell the compiler to
 * link them into target.
 */
F
fengjiayi 已提交
328 329 330 331 332 333
#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 已提交
334
      TouchOpRegistrar_##op_type()
F
fengjiayi 已提交
335

336
// TODO(fengjiayi): Most ops' gradient op have not been compeleted. So we use
337 338 339 340 341
// `NO_GRAD` to disable micro USE_OP_GRADIENT(op_type). Otherwise the code can't
// be compiled. `NO_GRAD` should be removed after all gradient ops are
// compeleted.
#define NO_GRAD
#ifndef NO_GRAD
F
fengjiayi 已提交
342 343 344 345 346 347 348
#define USE_OP_GRADIENT(op_type)                                    \
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                   \
      __use_op_gradient_##op_type,                                  \
      "USE_OP_GRADIENT must be called in global namespace");        \
  extern int TouchOpGradientRegistrar_##op_type();                  \
  static int use_op_gradient_##op_type##_ __attribute__((unused)) = \
      TouchOpGradientRegistrar_##op_type()
349 350 351
#else
#define USE_OP_GRADIENT(op_type)
#endif
F
fengjiayi 已提交
352

353
#define USE_OP_DEVICE_KERNEL(op_type, DEVICE_TYPE)               \
F
fengjiayi 已提交
354 355
  STATIC_ASSERT_GLOBAL_NAMESPACE(                                \
      __use_op_kernel_##op_type##_##DEVICE_TYPE##__,             \
356
      "USE_OP_DEVICE_KERNEL must be in global namespace");       \
F
fengjiayi 已提交
357 358 359
  extern int TouchOpKernelRegistrar_##op_type##_##DEVICE_TYPE(); \
  static int use_op_kernel_##op_type##_##DEVICE_TYPE##_          \
      __attribute__((unused)) =                                  \
F
Fix bug  
fengjiayi 已提交
360
          TouchOpKernelRegistrar_##op_type##_##DEVICE_TYPE()
Y
Yu Yang 已提交
361

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

364
#ifdef PADDLE_ONLY_CPU
365
#define USE_OP_KERNEL(op_type) USE_OP_DEVICE_KERNEL(op_type, CPU)
Y
Yu Yang 已提交
366
#else
367 368 369
#define USE_OP_KERNEL(op_type)        \
  USE_OP_DEVICE_KERNEL(op_type, CPU); \
  USE_OP_DEVICE_KERNEL(op_type, GPU)
Y
Yu Yang 已提交
370
#endif
371

372 373 374 375 376 377 378 379 380 381 382 383 384
#define USE_NO_GRAD_OP(op_type) \
  USE_OP_ITSELF(op_type);       \
  USE_OP_KERNEL(op_type)

#define USE_CPU_OP(op_type)           \
  USE_OP_ITSELF(op_type);             \
  USE_OP_DEVICE_KERNEL(op_type, CPU); \
  USE_OP_GRADIENT(op_type)

#define USE_OP(op_type)    \
  USE_NO_GRAD_OP(op_type); \
  USE_OP_GRADIENT(op_type)

385 386
}  // namespace framework
}  // namespace paddle