op_utils.h 7.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* Copyright (c) 2022 PaddlePaddle Authors. All Rights Reserved.

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

#pragma once

17 18
#include <string>
#include <unordered_set>
19 20

#include "paddle/pten/core/compat/arg_map_context.h"
21
#include "paddle/pten/core/enforce.h"
22 23
#include "paddle/pten/core/infermeta_utils.h"
#include "paddle/pten/core/macros.h"
24
#include "paddle/pten/core/type_defs.h"
25 26 27 28
#include "paddle/utils/flat_hash_map.h"

namespace pten {

29 30 31 32 33
const std::unordered_set<std::string> standard_kernel_suffixs({
    "sr",  // SelectedRows kernel
    "raw"  // fallback kernel of origfinal fluid op
});

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
/**
 * Some fluid ops are no longer used under the corresponding official API
 * system of 2.0. These names need to correspond to the official API names
 * after 2.0, and can no longer be occupied by the previously abandoned ops.
 * They are marked here uniformly.
 */
const std::unordered_set<std::string> deprecated_op_names({"flatten",
                                                           "flatten_grad",
                                                           "matmul",
                                                           "matmul_grad",
                                                           "matmul_grad_grad",
                                                           "mean",
                                                           "reshape",
                                                           "reshape_grad",
                                                           "sum"});

50 51 52 53 54 55 56 57 58 59 60
class DefaultKernelSignatureMap {
 public:
  static DefaultKernelSignatureMap& Instance();

  bool Has(const std::string& op_type) const { return map_.count(op_type) > 0; }

  const KernelSignature& Get(const std::string& op_type) const {
    auto it = map_.find(op_type);
    PADDLE_ENFORCE_NE(
        it,
        map_.end(),
61
        pten::errors::NotFound(
62 63 64 65 66 67 68 69
            "Operator `%s`'s kernel signature is not registered.", op_type));
    return it->second;
  }

  void Insert(std::string op_type, KernelSignature signature) {
    PADDLE_ENFORCE_NE(
        Has(op_type),
        true,
70
        pten::errors::AlreadyExists(
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
            "Operator (%s)'s Kernel Siginature has been registered.", op_type));
    map_.insert({std::move(op_type), std::move(signature)});
  }

 private:
  DefaultKernelSignatureMap() = default;

  paddle::flat_hash_map<std::string, KernelSignature> map_;

  DISABLE_COPY_AND_ASSIGN(DefaultKernelSignatureMap);
};

class OpUtilsMap {
 public:
  static OpUtilsMap& Instance();

  bool Contains(const std::string& op_type) const {
88 89
    return base_kernel_name_map_.count(op_type) ||
           arg_mapping_fn_map_.count(op_type);
90 91
  }

92
  void InsertBaseKernelName(std::string op_type, std::string base_kernel_name) {
93
    PADDLE_ENFORCE_EQ(
94
        base_kernel_name_map_.count(op_type),
95
        0UL,
96
        pten::errors::AlreadyExists(
97
            "Operator (%s)'s api name has been registered.", op_type));
98 99
    base_kernel_name_map_.insert(
        {std::move(op_type), std::move(base_kernel_name)});
100 101 102 103 104 105
  }

  void InsertArgumentMappingFn(std::string op_type, ArgumentMappingFn fn) {
    PADDLE_ENFORCE_EQ(
        arg_mapping_fn_map_.count(op_type),
        0UL,
106
        pten::errors::AlreadyExists(
107 108 109 110 111
            "Operator (%s)'s argu,emt mapping function has been registered.",
            op_type));
    arg_mapping_fn_map_.insert({std::move(op_type), std::move(fn)});
  }

112 113
  std::string GetBaseKernelName(const std::string& op_type) const {
    if (deprecated_op_names.find(op_type) != deprecated_op_names.end()) {
114
      return "deprecated";
115 116 117 118
    }
    auto it = base_kernel_name_map_.find(op_type);
    if (it == base_kernel_name_map_.end()) {
      return op_type;
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
    } else {
      return it->second;
    }
  }

  ArgumentMappingFn GetArgumentMappingFn(const std::string& op_type) const {
    auto it = arg_mapping_fn_map_.find(op_type);
    if (it == arg_mapping_fn_map_.end()) {
      auto func =
          [op_type](const ArgumentMappingContext& ctx) -> KernelSignature {
        return DefaultKernelSignatureMap::Instance().Get(op_type);
      };
      return func;
    } else {
      return it->second;
    }
  }

137 138 139 140 141
  const paddle::flat_hash_map<std::string, std::string>& base_kernel_name_map()
      const {
    return base_kernel_name_map_;
  }

142 143 144
 private:
  OpUtilsMap() = default;

145
  paddle::flat_hash_map<std::string, std::string> base_kernel_name_map_;
146 147 148 149 150
  paddle::flat_hash_map<std::string, ArgumentMappingFn> arg_mapping_fn_map_;

  DISABLE_COPY_AND_ASSIGN(OpUtilsMap);
};

151 152 153
struct BaseKernelNameRegistrar {
  BaseKernelNameRegistrar(const char* op_type, const char* base_kernel_name) {
    OpUtilsMap::Instance().InsertBaseKernelName(op_type, base_kernel_name);
154 155 156 157 158 159 160 161 162 163 164
  }
};

struct ArgumentMappingFnRegistrar {
  ArgumentMappingFnRegistrar(const char* op_type,
                             ArgumentMappingFn arg_mapping_fn) {
    OpUtilsMap::Instance().InsertArgumentMappingFn(op_type,
                                                   std::move(arg_mapping_fn));
  }
};

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
#define PT_REGISTER_BASE_KERNEL_NAME(op_type, base_kernel_name)                \
  PT_STATIC_ASSERT_GLOBAL_NAMESPACE(                                           \
      pt_register_base_kernel_name_ns_check_##op_type,                         \
      "PT_REGISTER_BASE_KERNEL_NAME must be called in global namespace.");     \
  static const ::pten::BaseKernelNameRegistrar                                 \
      __registrar_base_kernel_name_for_##op_type(#op_type, #base_kernel_name); \
  int TouchBaseKernelNameSymbol_##op_type() { return 0; }

#define PT_DECLARE_BASE_KERNEL_NAME(op_type)                              \
  PT_STATIC_ASSERT_GLOBAL_NAMESPACE(                                      \
      pt_declare_ai_name_ns_check_##op_type,                              \
      "PT_DECLARE_BASE_KERNEL_NAME must be called in global namespace."); \
  extern int TouchBaseKernelNameSymbol_##op_type();                       \
  UNUSED static int __declare_base_kernel_name_symbol_for_##op_type =     \
      TouchBaseKernelNameSymbol_##op_type()
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197

#define PT_REGISTER_ARG_MAPPING_FN(op_type, arg_mapping_fn)              \
  PT_STATIC_ASSERT_GLOBAL_NAMESPACE(                                     \
      pt_register_arg_map_fn_ns_check_##op_type,                         \
      "PT_REGISTER_ARG_MAPPING_FN must be called in global namespace."); \
  static const ::pten::ArgumentMappingFnRegistrar                        \
      __registrar_arg_map_fn_for_##op_type(#op_type, arg_mapping_fn);    \
  int TouchArgumentMappingFnSymbol_##op_type() { return 0; }

#define PT_DECLARE_ARG_MAPPING_FN(op_type)                              \
  PT_STATIC_ASSERT_GLOBAL_NAMESPACE(                                    \
      pt_declare_arg_map_fn_ns_check_##op_type,                         \
      "PT_DECLARE_ARG_MAPPING_FN must be called in global namespace."); \
  extern int TouchArgumentMappingFnSymbol_##op_type();                  \
  UNUSED static int __declare_arg_map_fn_symbol_for_##op_type =         \
      TouchArgumentMappingFnSymbol_##op_type()

}  // namespace pten