Files
2026-07-13 12:40:42 +08:00

782 lines
29 KiB
Python

# Copyright (c) 2021 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.
import argparse
import re
import yaml
from api_base import PREFIX_TENSOR_NAME, BaseAPI, IsUsePredefinedOut
backward_api_black_list = [
"scale_grad", # tensor = scale is not implemented in api_custom_impl.cc
]
inplace_out_type_map = {
"Tensor": "Tensor&",
"std::vector<Tensor>": "std::vector<Tensor>&",
}
inplace_optional_out_type_map = {
"Tensor": "paddle::optional<Tensor>&",
"std::vector<Tensor>": "paddle::optional<std::vector<Tensor>>&",
}
optional_out_type_map = {
"Tensor": "paddle::optional<Tensor>",
"std::vector<Tensor>": "paddle::optional<std::vector<Tensor>>",
}
class ForwardAPI(BaseAPI):
def __init__(self, api_item_yaml):
super().__init__(api_item_yaml)
self.is_dygraph_api, self.intermediate_outs = self.parse_intermediate(
api_item_yaml
)
self.inplace_map, self.view_map = self.parse_inplace_and_view(
api_item_yaml
)
def get_api_func_name(self):
if self.is_dygraph_api:
return self.api + '_intermediate'
else:
return self.api
def gene_input(self, kernel_tensor_type=None, code_indent=''):
kernel_param = self.kernel['param']
input_name_tensor_map, input_tensor_code = super().gene_input(
kernel_tensor_type, code_indent
)
# generate the input that is in view list
for i, input_name in enumerate(self.inputs['names']):
if (
input_name in self.view_map.values()
and input_name not in input_name_tensor_map.keys()
):
if (
kernel_tensor_type is None
or kernel_tensor_type[0][kernel_param.index(input_name)]
== 'dense'
):
trans_flag = self.gene_trans_flag(input_name)
input_tensor_code = (
input_tensor_code
+ f"""
{code_indent} auto {PREFIX_TENSOR_NAME}{input_name} = PrepareData({input_name}, kernel.InputAt(0), {trans_flag}, kernel_result.is_stride_kernel);"""
)
else:
# do nothing
pass
return input_name_tensor_map, input_tensor_code
def parse_intermediate(self, api_item_yaml):
if 'intermediate' in api_item_yaml:
intermediate_outs = [
item.strip()
for item in api_item_yaml['intermediate'].split(',')
]
return True, intermediate_outs
else:
return False, []
def parse_inplace_and_view(self, api_item_yaml):
inplace_map, view_map = {}, {}
for mode in ['inplace', 'view']:
if mode in api_item_yaml:
if mode == 'inplace':
inplace_map = {}
else:
view_map = {}
in_out_mapping_list = api_item_yaml[mode].split(',')
for item in in_out_mapping_list:
result = re.search(r"(?P<in>\w+)\s*->\s*(?P<out>\w+)", item)
in_val = result.group('in')
out_val = result.group('out')
assert in_val in self.inputs['names'], (
f"{self.api} : {mode} input error: the input var name('{in_val}') is not found in the input args of {self.api}."
)
assert out_val in self.outputs['names'], (
f"{self.api} : {mode} output error: the output var name('{out_val}') is not found in the output args of {self.api}."
)
if mode == 'inplace':
inplace_map[out_val] = in_val
else:
view_map[out_val] = in_val
return inplace_map, view_map
def get_return_type_with_intermediate(self, inplace_flag=False):
out_type_list = []
for i, out_type in enumerate(self.outputs['types']):
out_name = self.outputs['names'][i].split('@')[0]
if inplace_flag and out_name in self.inplace_map:
if self.inplace_map[out_name] in self.optional_vars:
out_type_list.append(
inplace_optional_out_type_map[out_type]
)
else:
out_type_list.append(inplace_out_type_map[out_type])
else:
out_type_list.append(out_type)
if len(out_type_list) == 1:
return out_type_list[0]
else:
return "std::tuple<" + ", ".join(out_type_list) + ">"
def get_return_type(self, inplace_flag=False):
out_type_list = []
for i, out_type in enumerate(self.outputs['types']):
out_name = self.outputs['names'][i].split('@')[0]
if inplace_flag and out_name in self.inplace_map:
if self.inplace_map[out_name] in self.optional_vars:
out_type_list.append(
inplace_optional_out_type_map[out_type]
)
else:
out_type_list.append(inplace_out_type_map[out_type])
elif self.is_dygraph_api or out_name not in self.intermediate_outs:
out_type_list.append(out_type)
if len(out_type_list) == 1:
return out_type_list[0]
else:
return "std::tuple<" + ", ".join(out_type_list) + ">"
def gene_return_code(self):
if self.is_dygraph_api or len(self.intermediate_outs) == 0:
return "return api_output;"
else:
return_out_list = []
for i, name in enumerate(self.outputs['names']):
if name.split('@')[0] not in self.intermediate_outs:
return_out_list.append(i)
if len(return_out_list) == 1:
return f"return std::get<{return_out_list[0]}>(api_output);"
else:
selected_code = [
f"std::get<{i}>(api_output)" for i in return_out_list
]
return 'return std::make_tuple(' + ", ".join(selected_code) + ');'
def gene_fallback_code_after_gene_output_of_vector(
self, code_indent, output_idx, is_inplace, is_optional
):
fallback_code = ""
if is_inplace and is_optional:
fallback_code = f"""
{code_indent} if (kernel_result.has_fallback_cpu) {{
{code_indent} for (size_t i = 0; i < kernel_out_{output_idx}.size(); ++i) {{
{code_indent} kernel_out_{output_idx}[i] = const_cast<phi::DenseTensor*>({PREFIX_TENSOR_NAME}{self.inplace_map[self.outputs['names'][output_idx]]}->at(i));
{code_indent} }}
{code_indent} }}"""
elif is_inplace:
fallback_code = f"""
{code_indent} if (kernel_result.has_fallback_cpu) {{
{code_indent} for (size_t i = 0; i < kernel_out_{output_idx}.size(); ++i) {{
{code_indent} kernel_out_{output_idx}[i] = const_cast<phi::DenseTensor*>({PREFIX_TENSOR_NAME}{self.inplace_map[self.outputs['names'][output_idx]]}[i]);
{code_indent} }}
{code_indent} }}"""
else:
fallback_code = ""
return fallback_code
def gene_output(
self,
out_dtype_list,
out_tensor_type_list=None,
code_indent='',
inplace_flag=False,
):
kernel_output = []
output_names = []
output_create = ""
return_type = self.get_return_type_with_intermediate(inplace_flag)
if len(out_dtype_list) == 1:
kernel_output.append('kernel_out')
output_names.append('kernel_out')
inplace_assign = (
" = " + self.inplace_map[self.outputs['names'][0]]
if inplace_flag and self.outputs['names'][0] in self.inplace_map
else ""
)
if (
len(self.outputs['names']) == 1
and self.outputs['types'][0] == "Tensor"
and not (
inplace_flag
and self.outputs['names'][0].split('@')[0]
in self.inplace_map
)
and self.api != "empty_like"
):
output_create = f"""
{code_indent} Tensor out_tmp; Tensor& api_output = predefined_out ? **predefined_out : out_tmp;"""
else:
output_create = f"""
{code_indent} {return_type} api_output{inplace_assign};"""
set_out_func = (
'SetKernelOutput'
if out_tensor_type_list is None
or out_tensor_type_list[0] == 'dense'
else 'SetSelectedRowsKernelOutput'
)
if (
return_type == 'std::vector<Tensor>'
or return_type == 'std::vector<Tensor>&'
):
assert self.outputs['out_size_expr'][0] is not None, (
f"{self.api}: The out size expr : '{{expr}}' should be set when output has Tensor[]. You can refer 'split' api."
)
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out = {set_out_func}({self.outputs['out_size_expr'][0]}, &api_output);"""
)
elif (
return_type == 'paddle::optional<std::vector<Tensor>>'
or return_type == 'paddle::optional<std::vector<Tensor>>&'
):
assert self.outputs['out_size_expr'][0] is not None, (
f"{self.api}: The out size expr : '{{expr}}' should be set when output has Tensor[]. You can refer 'split' api."
)
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out = {set_out_func}({self.outputs['out_size_expr'][0]}, api_output.get_ptr());"""
)
elif (
return_type == 'paddle::optional<Tensor>'
or return_type == 'paddle::optional<Tensor>&'
):
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out = {set_out_func}(api_output.get_ptr());"""
)
elif return_type == 'Tensor' or return_type == 'Tensor&':
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out = {set_out_func}(&api_output);"""
)
if (
not inplace_flag
and self.view_map is not None
and self.outputs['names'][0] in self.view_map
):
output_create = (
output_create
+ f"""
{code_indent} kernel_out->ShareBufferWith(*{PREFIX_TENSOR_NAME}{self.view_map[self.outputs['names'][0]]});
{code_indent} kernel_out->ShareInplaceVersionCounterWith(*{PREFIX_TENSOR_NAME}{self.view_map[self.outputs['names'][0]]});
{code_indent} VLOG(5) << "Perform View between Output and Input Tensor, share allocation and inplace version.";"""
)
elif len(out_dtype_list) > 1:
if not (
inplace_flag
and any(
name.split('@')[0] in self.inplace_map
for name in self.outputs['names']
)
):
if IsUsePredefinedOut(self.outputs['types']):
length = len(self.outputs['names'])
if length == 1:
output_create = f"""
{code_indent} Tensor out_tmp; Tensor& api_output = predefined_out ? **predefined_out : out_tmp;"""
else:
tuple_types = ", ".join(["Tensor"] * length)
get_indices = ", ".join(
f"*std::get<{i}>(*predefined_out)"
for i in range(length)
)
output_create = f"""
{code_indent} std::tuple<{tuple_types}> out_tmp;
{code_indent} paddle::optional<std::tuple<{tuple_types}>> predefined_out_value;
{code_indent} if(predefined_out) {{ predefined_out_value = std::make_tuple({get_indices}); }}
{code_indent} std::tuple<{tuple_types}>& api_output = predefined_out_value ? *predefined_out_value : out_tmp;"""
else:
output_create = f"""
{code_indent} {return_type} api_output;"""
else:
output_create = f"""
{code_indent} {return_type} api_output;"""
if inplace_flag:
output_create = f"""
{code_indent} {return_type} api_output{{"""
for out_name in self.outputs['names']:
if out_name in self.inplace_map:
output_create += self.inplace_map[out_name] + ', '
else:
output_create += 'Tensor(), '
output_create = output_create[:-2] + '};'
for i in range(len(out_dtype_list)):
kernel_output.append(f'kernel_out_{i}')
output_names.append(f'kernel_out_{i}')
set_out_func = (
'SetKernelOutput'
if out_tensor_type_list is None
or out_tensor_type_list[i] == 'dense'
else 'SetSelectedRowsKernelOutput'
)
get_out_code = f"&std::get<{i}>(api_output)"
if (
inplace_flag
and self.outputs['names'][i] in self.inplace_map
and self.inplace_map[self.outputs['names'][i]]
in self.optional_vars
):
get_out_code = f"std::get<{i}>(api_output).get_ptr()"
if out_dtype_list[i] == 'std::vector<Tensor>':
assert self.outputs['out_size_expr'][i] is not None, (
f"{self.api}: The out size expr : '{{expr}}' should be set when output has Tensor[]. You can refer 'split' api."
)
# Special case for inplace vector and inplace optional<vector>
if self.outputs['names'][i] in self.inplace_map:
set_out_func = "SetInplaceVectorKernelOutput"
if (
self.inplace_map[self.outputs['names'][i]]
in self.optional_vars
):
set_out_func = (
"SetInplaceOptionalVectorKernelOutput"
)
get_out_code = f"std::get<{i}>(api_output)"
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out_{i} = {set_out_func}({self.outputs['out_size_expr'][i]}, {get_out_code});"""
+ self.gene_fallback_code_after_gene_output_of_vector(
code_indent, i, True, True
)
)
else:
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out_{i} = {set_out_func}({self.outputs['out_size_expr'][i]}, {get_out_code});"""
+ self.gene_fallback_code_after_gene_output_of_vector(
code_indent, i, True, False
)
)
else:
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out_{i} = {set_out_func}({self.outputs['out_size_expr'][i]}, {get_out_code});"""
)
else:
output_create = (
output_create
+ f"""
{code_indent} auto kernel_out_{i} = {set_out_func}({get_out_code});"""
)
if (
not inplace_flag
and self.view_map is not None
and self.outputs['names'][i] in self.view_map
):
if out_dtype_list[i] == 'Tensor':
output_create = (
output_create
+ f"""
{code_indent} kernel_out_{i}->ShareBufferWith(*{PREFIX_TENSOR_NAME}{self.view_map[self.outputs['names'][i]]});
{code_indent} kernel_out_{i}->ShareInplaceVersionCounterWith(*{PREFIX_TENSOR_NAME}{self.view_map[self.outputs['names'][i]]});
{code_indent} VLOG(5) << "Perform View between Output and Input Tensor, share allocation and inplace version.";"""
)
else:
raise ValueError(
f"{self.api} : Output error: only support Tensor type when use view in yaml. But get {out_dtype_list[i]}"
)
else:
raise ValueError(
f"{self.api} : Output error: the output should not be empty."
)
return kernel_output, output_names, output_create
def reset_view_after_fallback(
self, out_dtype_list, code_indent='', inplace_flag=False
):
remap_code = ''
if len(out_dtype_list) == 1:
if (
not inplace_flag
and self.view_map is not None
and self.outputs['names'][0] in self.view_map
):
remap_code += f"""
{code_indent} phi::DenseTensor * {self.view_map[self.outputs['names'][0]]}_remap = static_cast<phi::DenseTensor*>({self.view_map[self.outputs['names'][0]]}.impl().get());
{code_indent} {self.view_map[self.outputs['names'][0]]}_remap->ShareBufferWith(*kernel_out);
{code_indent} kernel_out->ShareInplaceVersionCounterWith(*{self.view_map[self.outputs['names'][0]]}_remap);
"""
elif len(out_dtype_list) > 1:
for i in range(len(out_dtype_list)):
if (
not inplace_flag
and self.view_map is not None
and self.outputs['names'][i] in self.view_map
):
remap_code += f"""
{code_indent} phi::DenseTensor * {self.view_map[self.outputs['names'][i]]}_remap = static_cast<phi::DenseTensor*>({self.view_map[self.outputs['names'][i]]}.impl().get());
{code_indent} {self.view_map[self.outputs['names'][i]]}_remap->ShareBufferWith(*kernel_out_{i});
{code_indent} kernel_out_{i}->ShareInplaceVersionCounterWith(*{self.view_map[self.outputs['names'][i]]}_remap);
"""
return remap_code
class BackwardAPI(ForwardAPI):
def gene_base_api_code(
self, inplace_flag=False, grad_flag=False, append_predefined_out=True
):
api_func_name = self.get_api_func_name()
if inplace_flag and api_func_name[-1] != '_':
inplace_name = api_func_name + '_'
else:
inplace_name = api_func_name
api_code = f"""
PADDLE_API {self.get_return_type(inplace_flag)} {inplace_name}({self.get_define_args(inplace_flag, grad_flag=grad_flag, append_predefined_out=append_predefined_out)}) {{
{self.get_grad_outputs_define(inplace_flag)}
{self.get_optional_inputs_change(inplace_flag)}
{api_func_name}({self.get_grad_api_call_args(inplace_flag)});
return {self.get_grad_output(inplace_flag)};
}}
"""
return api_code
def gene_api_code(self, grad_flag=False, append_predefined_out=False):
if not self.is_base_api and not self.is_only_composite_api:
invoke_func_name = self.invoke.split('(')[0]
if (not invoke_func_name.endswith("_grad")) and (
not invoke_func_name.endswith('_impl')
):
return ""
if self.is_only_composite_api:
return ""
api_code = self.gene_base_api_code(
grad_flag=grad_flag, append_predefined_out=append_predefined_out
)
if self.is_base_api and len(self.inplace_map) > 0:
if self.api[-1] == '_':
api_code = ""
api_code = api_code + self.gene_base_api_code_for_inplace()
return api_code
def gene_api_declaration(self, grad_flag=False, append_predefined_out=True):
if not self.is_base_api and not self.is_only_composite_api:
invoke_func_name = self.invoke.split('(')[0]
if (not invoke_func_name.endswith("_grad")) and (
not invoke_func_name.endswith('_impl')
):
return ""
if self.is_only_composite_api:
return ""
api_declaration = ""
api_func_name = self.get_api_func_name()
if api_func_name[-1] != '_':
api_declaration = f"""
PADDLE_API {self.get_return_type()} {api_func_name}({self.get_declare_args(append_predefined_out=append_predefined_out)});
"""
if self.is_base_api and len(self.inplace_map) > 0:
if api_func_name[-1] != '_':
api_func_name += '_'
api_declaration = (
api_declaration
+ f"""
PADDLE_API {self.get_return_type(inplace_flag=True)} {api_func_name}({self.get_declare_args(inplace_flag=True, append_predefined_out=append_predefined_out)});
"""
)
return api_declaration
def header_include():
return """
#include <tuple>
#include "paddle/phi/api/include/tensor.h"
#include "paddle/phi/common/scalar.h"
#include "paddle/phi/common/int_array.h"
#include "paddle/utils/optional.h"
"""
def source_include(header_file_path):
return f"""
#include <memory>
#include "glog/logging.h"
#include "paddle/common/flags.h"
{header_file_path}
#include "paddle/phi/api/lib/api_custom_impl.h"
#include "paddle/phi/api/lib/api_gen_utils.h"
#include "paddle/phi/api/lib/api_registry.h"
#include "paddle/phi/api/lib/data_transform.h"
#include "paddle/phi/api/include/tensor_utils.h"
#include "paddle/phi/api/lib/kernel_dispatch.h"
#include "paddle/phi/common/type_traits.h"
#include "paddle/phi/core/kernel_registry.h"
#include "paddle/phi/infermeta/binary.h"
#include "paddle/phi/infermeta/multiary.h"
#include "paddle/phi/infermeta/nullary.h"
#include "paddle/phi/infermeta/unary.h"
#include "paddle/phi/infermeta/ternary.h"
#include "paddle/phi/infermeta/fusion.h"
#include "paddle/phi/infermeta/backward.h"
#include "paddle/phi/api/profiler/event_tracing.h"
#include "paddle/phi/api/profiler/supplement_tracing.h"
#if defined(PADDLE_WITH_NCCL) || defined(PADDLE_WITH_RCCL)
#include "paddle/phi/core/distributed/comm_context_manager.h"
#include "paddle/phi/core/distributed/nccl_comm_context.h"
#elif (defined(PADDLE_WITH_XPU) && defined(PADDLE_WITH_XPU_BKCL))
#include "paddle/phi/core/distributed/comm_context_manager.h"
#include "paddle/phi/core/distributed/bkcl_comm_context.h"
#elif PADDLE_WITH_CUSTOM_DEVICE
#include "paddle/phi/core/distributed/comm_context_manager.h"
#include "paddle/phi/core/distributed/xccl_comm_context.h"
#endif
#ifdef PADDLE_WITH_DISTRIBUTE
#include "paddle/phi/core/distributed/store/store_utils.h"
#include "paddle/phi/infermeta/spmd_rules/rules.h"
#include "paddle/phi/core/distributed/auto_parallel/reshard/reshard_utils.h"
#endif
PD_DECLARE_bool(conv2d_disable_cudnn);
COMMON_DECLARE_int32(low_precision_op_list);
COMMON_DECLARE_bool(benchmark);
"""
def api_namespace():
return (
"""
namespace paddle {
namespace experimental {
""",
"""
} // namespace experimental
} // namespace paddle
""",
)
def declare_extension_api():
return """
namespace paddle {
PD_DECLARE_API(from_blob);
#ifdef PADDLE_WITH_DISTRIBUTE
PD_DECLARE_API(reshard);
#endif
} // namespace paddle
"""
def generate_api(
api_yaml_path,
is_fused_ops_yaml,
header_file_path,
source_file_path,
grad_flag,
):
apis = []
for each_api_yaml in api_yaml_path:
with open(each_api_yaml, 'r') as f:
api_list = yaml.load(f, Loader=yaml.FullLoader)
if api_list:
apis.extend(api_list)
header_file = open(header_file_path, 'w')
source_file = open(source_file_path, 'w')
namespace = api_namespace()
header_file.write("#pragma once\n")
header_file.write(header_include())
header_file.write(namespace[0])
if not grad_flag:
include_header_file = (
'#include "paddle/phi/api/include/fused_api.h"'
if is_fused_ops_yaml is True
else '#include "paddle/phi/api/include/api.h"'
)
else:
include_header_file = (
'#include "paddle/phi/api/backward/fused_backward_api.h" \n'
'#include "paddle/phi/api/backward/fused_backward_api_base.h" '
if is_fused_ops_yaml is True
else '#include "paddle/phi/api/backward/backward_api.h" \n'
'#include "paddle/phi/api/backward/backward_api_base.h" '
)
# not all fused ops support dygraph
if is_fused_ops_yaml is True:
new_apis = [
api
for api in apis
if "support_dygraph_mode" in api
and api["support_dygraph_mode"] is True
]
apis = new_apis
source_file.write(source_include(include_header_file))
source_file.write(namespace[0])
for api in apis:
if not grad_flag:
forward_api = ForwardAPI(api)
else:
forward_api = BackwardAPI(api)
if forward_api.api in backward_api_black_list:
continue
if forward_api.is_dygraph_api and not is_fused_ops_yaml:
forward_api.is_dygraph_api = False
if forward_api.is_dygraph_api and is_fused_ops_yaml:
forward_api.is_dygraph_api = False
header_file.write(
forward_api.gene_api_declaration(
grad_flag=grad_flag, append_predefined_out=not grad_flag
)
)
source_file.write(forward_api.gene_api_code(grad_flag=grad_flag))
forward_api.is_dygraph_api = True
header_file.write(
forward_api.gene_api_declaration(
grad_flag=grad_flag, append_predefined_out=not grad_flag
)
)
source_file.write(forward_api.gene_api_code(grad_flag=grad_flag))
header_file.write(namespace[1])
source_file.write(namespace[1])
source_file.write(declare_extension_api())
header_file.close()
source_file.close()
def main():
parser = argparse.ArgumentParser(
description='Generate PaddlePaddle C++ API files'
)
parser.add_argument(
'--api_yaml_path',
help='path to api yaml file',
nargs='+',
default=['paddle/phi/ops/yaml/ops.yaml'],
)
parser.add_argument(
'--backward_api_yaml_path',
help='path to api yaml file',
nargs='+',
default=['paddle/phi/ops/yaml/backward.yaml'],
)
parser.add_argument(
'--is_fused_ops_yaml',
help='flag of fused ops yaml',
action='store_true',
)
parser.add_argument(
'--api_header_path',
help='output of generated api header code file',
default='paddle/phi/api/include/api.h',
)
parser.add_argument(
'--api_source_path',
help='output of generated api source code file',
default='paddle/phi/api/lib/api.cc',
)
parser.add_argument(
'--backward_api_header_path',
help='output of generated api header code file',
default='paddle/phi/api/backward/backward_api.h',
)
parser.add_argument(
'--backward_api_source_path',
help='output of generated api source code file',
default='paddle/phi/api/lib/backward_api.cc',
)
options = parser.parse_args()
api_yaml_path = options.api_yaml_path
backward_api_yaml_path = options.backward_api_yaml_path
is_fused_ops_yaml = options.is_fused_ops_yaml
header_file_path = options.api_header_path
source_file_path = options.api_source_path
backward_header_file_path = options.backward_api_header_path
backward_source_file_path = options.backward_api_source_path
generate_api(
api_yaml_path,
is_fused_ops_yaml,
header_file_path,
source_file_path,
False,
)
generate_api(
backward_api_yaml_path,
is_fused_ops_yaml,
backward_header_file_path,
backward_source_file_path,
True,
)
if __name__ == '__main__':
main()