blob: 4a832fcfaa779d15fe047f8a4a30b16ba71f1cef [file] [log] [blame]
Motti Gondabi9d9ad332022-01-23 12:42:24 +02001#!/usr/bin/python
2# -*- coding: utf-8 -*-
3
Mohammed Suhail Munshiaae18e12022-05-11 16:38:12 +01004# Copyright (c) 2016-2022 Arm Limited.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01005#
6# SPDX-License-Identifier: MIT
7#
8# Permission is hereby granted, free of charge, to any person obtaining a copy
9# of this software and associated documentation files (the "Software"), to
10# deal in the Software without restriction, including without limitation the
11# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12# sell copies of the Software, and to permit persons to whom the Software is
13# furnished to do so, subject to the following conditions:
14#
15# The above copyright notice and this permission notice shall be included in all
16# copies or substantial portions of the Software.
17#
18# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24# SOFTWARE.
Motti Gondabi6f3a9f52021-11-09 15:47:17 +020025
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026import collections
27import os.path
28import re
29import subprocess
Georgios Pinitasea857272021-01-22 05:47:37 +000030import zlib
Georgios Pinitasbdcdc392021-04-22 16:42:03 +010031import json
Adnan AlSinan39aebd12021-08-06 12:44:51 +010032import codecs
Anthony Barbier6ff3b192017-09-04 18:44:23 +010033
34VERSION = "v0.0-unreleased"
Mohammed Suhail Munshiaae18e12022-05-11 16:38:12 +010035LIBRARY_VERSION_MAJOR = 27
Sang-Hoon Park6d0b3842020-08-14 14:48:08 +010036LIBRARY_VERSION_MINOR = 0
Georgios Pinitas35fcc432020-03-26 18:47:46 +000037LIBRARY_VERSION_PATCH = 0
38SONAME_VERSION = str(LIBRARY_VERSION_MAJOR) + "." + str(LIBRARY_VERSION_MINOR) + "." + str(LIBRARY_VERSION_PATCH)
Anthony Barbier6ff3b192017-09-04 18:44:23 +010039
40Import('env')
41Import('vars')
Anthony Barbier01bbd5f2018-11-01 15:10:51 +000042Import('install_lib')
Anthony Barbier6ff3b192017-09-04 18:44:23 +010043
Michalis Spyrou748a7c82019-10-07 13:00:44 +010044def build_bootcode_objs(sources):
Michalis Spyrou748a7c82019-10-07 13:00:44 +010045 arm_compute_env.Append(ASFLAGS = "-I bootcode/")
46 obj = arm_compute_env.Object(sources)
47 obj = install_lib(obj)
48 Default(obj)
49 return obj
50
Motti Gondabi9d9ad332022-01-23 12:42:24 +020051
52
53
54# @brief Create a list of object from a given file list.
Motti Gondabi6f3a9f52021-11-09 15:47:17 +020055#
Motti Gondabi9d9ad332022-01-23 12:42:24 +020056# @param arch_info A dictionary represents the architecture info such as the
57# compiler flags and defines (filedefs.json).
58#
59# @param sources A list of files to build
Motti Gondabi6f3a9f52021-11-09 15:47:17 +020060#
61# @return A list of objects for the corresponding architecture.
Michalis Spyrou20fca522021-06-07 14:23:57 +010062
Motti Gondabi9d9ad332022-01-23 12:42:24 +020063def build_obj_list(arch_info, sources, static=False):
Motti Gondabi6f3a9f52021-11-09 15:47:17 +020064
Motti Gondabi9d9ad332022-01-23 12:42:24 +020065 # Clone environment
Georgios Pinitasbdcdc392021-04-22 16:42:03 +010066 tmp_env = arm_compute_env.Clone()
Motti Gondabi6f3a9f52021-11-09 15:47:17 +020067
Motti Gondabi9d9ad332022-01-23 12:42:24 +020068 # Append architecture spec
69 if 'cxxflags' in arch_info and len(arch_info['cxxflags']) > 0:
70 tmp_env.Append(CXXFLAGS = arch_info['cxxflags'])
Motti Gondabi6f3a9f52021-11-09 15:47:17 +020071
Motti Gondabi9d9ad332022-01-23 12:42:24 +020072 # Build and return objects
73 if static:
74 objs = tmp_env.StaticObject(sources)
Motti Gondabi6f3a9f52021-11-09 15:47:17 +020075 else:
Motti Gondabi9d9ad332022-01-23 12:42:24 +020076 objs = tmp_env.SharedObject(sources)
Giorgio Arena892b70a2022-03-30 12:23:10 +010077
Motti Gondabif76a5022021-12-21 13:19:29 +020078 tmp_env.Default(objs)
79 return objs
Georgios Pinitasbdcdc392021-04-22 16:42:03 +010080
Motti Gondabi9d9ad332022-01-23 12:42:24 +020081# @brief Build multi-ISA files with the respective architecture.
82#
83# @return Two distinct lists:
84# A list of static objects
85# A list of shared objects
Michalis Spyrou20fca522021-06-07 14:23:57 +010086
Motti Gondabi9d9ad332022-01-23 12:42:24 +020087def build_lib_objects():
88 lib_static_objs = [] # static objects
89 lib_shared_objs = [] # shared objects
90
91 arm_compute_env.Append(CPPDEFINES = ['ENABLE_NEON', 'ARM_COMPUTE_ENABLE_NEON',
92 'ENABLE_SVE', 'ARM_COMPUTE_ENABLE_SVE',
93 'ARM_COMPUTE_ENABLE_FP16', 'ARM_COMPUTE_ENABLE_BF16',
94 'ARM_COMPUTE_ENABLE_I8MM', 'ARM_COMPUTE_ENABLE_SVEF32MM'])
95
96 # Build all the common files for the base architecture
97 lib_static_objs += build_obj_list(filedefs["armv8.2-a"], lib_files, static=True)
98 lib_shared_objs += build_obj_list(filedefs["armv8.2-a"], lib_files, static=False)
Giorgio Arena892b70a2022-03-30 12:23:10 +010099
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200100 # Build the SVE specific files
101 lib_static_objs += build_obj_list(filedefs["armv8.2-a-sve"], lib_files_sve, static=True)
102 lib_shared_objs += build_obj_list(filedefs["armv8.2-a-sve"], lib_files_sve, static=False)
103
104 # Build the SVE2 specific files
105 arm_compute_env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SVE2'])
106 lib_static_objs += build_obj_list(filedefs["armv8.6-a-sve2"], lib_files_sve2, static=True)
107 lib_shared_objs += build_obj_list(filedefs["armv8.6-a-sve2"], lib_files_sve2, static=False)
108
109 return lib_static_objs, lib_shared_objs
110
Michalis Spyrou20fca522021-06-07 14:23:57 +0100111
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100112
Georgios Pinitas4d9687e2020-10-21 18:33:36 +0100113def build_library(name, build_env, sources, static=False, libs=[]):
Mohammed Suhail Munshide60ed92021-12-21 11:07:27 +0000114 cloned_build_env = build_env.Clone()
Motti Gondabif76a5022021-12-21 13:19:29 +0200115 if env['os'] == 'android' and static == False:
Mohammed Suhail Munshide60ed92021-12-21 11:07:27 +0000116 cloned_build_env["LINKFLAGS"].remove('-pie')
117 cloned_build_env["LINKFLAGS"].remove('-static-libstdc++')
118
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100119 if static:
Mohammed Suhail Munshide60ed92021-12-21 11:07:27 +0000120 obj = cloned_build_env.StaticLibrary(name, source=sources, LIBS = arm_compute_env["LIBS"] + libs)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100121 else:
122 if env['set_soname']:
Mohammed Suhail Munshide60ed92021-12-21 11:07:27 +0000123 obj = cloned_build_env.SharedLibrary(name, source=sources, SHLIBVERSION = SONAME_VERSION, LIBS = arm_compute_env["LIBS"] + libs)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100124 else:
Mohammed Suhail Munshide60ed92021-12-21 11:07:27 +0000125 obj = cloned_build_env.SharedLibrary(name, source=sources, LIBS = arm_compute_env["LIBS"] + libs)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100126
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000127 obj = install_lib(obj)
Motti Gondabif76a5022021-12-21 13:19:29 +0200128 build_env.Default(obj)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100129 return obj
130
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100131
Georgios Pinitasf605bd22020-11-26 11:55:09 +0000132def remove_incode_comments(code):
133 def replace_with_empty(match):
134 s = match.group(0)
135 if s.startswith('/'):
136 return " "
137 else:
138 return s
139
140 comment_regex = re.compile(r'//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"', re.DOTALL | re.MULTILINE)
141 return re.sub(comment_regex, replace_with_empty, code)
142
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100143
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100144def resolve_includes(target, source, env):
145 # File collection
146 FileEntry = collections.namedtuple('FileEntry', 'target_name file_contents')
147
148 # Include pattern
149 pattern = re.compile("#include \"(.*)\"")
150
151 # Get file contents
152 files = []
153 for i in range(len(source)):
154 src = source[i]
155 dst = target[i]
Georgios Pinitasf605bd22020-11-26 11:55:09 +0000156 contents = src.get_contents().decode('utf-8')
157 contents = remove_incode_comments(contents).splitlines()
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100158 entry = FileEntry(target_name=dst, file_contents=contents)
159 files.append((os.path.basename(src.get_path()),entry))
160
161 # Create dictionary of tupled list
162 files_dict = dict(files)
163
164 # Check for includes (can only be files in the same folder)
165 final_files = []
166 for file in files:
167 done = False
168 tmp_file = file[1].file_contents
169 while not done:
170 file_count = 0
171 updated_file = []
172 for line in tmp_file:
173 found = pattern.search(line)
174 if found:
Giorgio Arena09adcc42022-03-08 11:12:27 +0000175 # Only get the header file name and discard the relative path.
176 # E.g. "common/experimental/gemm_fused_post_ops/fp_mixed_precision_helpers.h" -> "fp_mixed_precision_helpers.h"
Giorgio Arena232c4522022-03-03 10:09:01 +0000177 include_file = found.group(1).split('/')[-1]
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100178 data = files_dict[include_file].file_contents
179 updated_file.extend(data)
180 else:
181 updated_file.append(line)
182 file_count += 1
183
184 # Check if all include are replaced.
185 if file_count == len(tmp_file):
186 done = True
187
188 # Update temp file
189 tmp_file = updated_file
190
191 # Append and prepend string literal identifiers and add expanded file to final list
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100192 entry = FileEntry(target_name=file[1].target_name, file_contents=tmp_file)
193 final_files.append((file[0], entry))
194
195 # Write output files
196 for file in final_files:
197 with open(file[1].target_name.get_path(), 'w+') as out_file:
Georgios Pinitasea857272021-01-22 05:47:37 +0000198 file_to_write = "\n".join( file[1].file_contents )
199 if env['compress_kernels']:
Adnan AlSinan39aebd12021-08-06 12:44:51 +0100200 file_to_write = zlib.compress(file_to_write.encode('utf-8'), 9)
201 file_to_write = codecs.encode(file_to_write, "base64").decode('utf-8').replace("\n", "")
Georgios Pinitasea857272021-01-22 05:47:37 +0000202 file_to_write = "R\"(" + file_to_write + ")\""
203 out_file.write(file_to_write)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100204
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100205
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100206def create_version_file(target, source, env):
207# Generate string with build options library version to embed in the library:
208 try:
209 git_hash = subprocess.check_output(["git", "rev-parse", "HEAD"])
210 except (OSError, subprocess.CalledProcessError):
211 git_hash="unknown"
212
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100213 build_info = "\"arm_compute_version=%s Build options: %s Git hash=%s\"" % (VERSION, vars.args, git_hash.strip())
214 with open(target[0].get_path(), "w") as fd:
215 fd.write(build_info)
216
Michalis Spyrou20fca522021-06-07 14:23:57 +0100217
Freddie Liardet487d3902021-09-21 12:36:43 +0100218def get_attrs_list(env, data_types, data_layouts):
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100219 attrs = []
Michalis Spyrou20fca522021-06-07 14:23:57 +0100220
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100221 # Manage data-types
Freddie Liardet487d3902021-09-21 12:36:43 +0100222 if 'all' in data_types:
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100223 attrs += ['fp16', 'fp32', 'integer', 'qasymm8', 'qasymm8_signed', 'qsymm16']
224 else:
Freddie Liardet487d3902021-09-21 12:36:43 +0100225 if 'fp16' in data_types: attrs += ['fp16']
226 if 'fp32' in data_types: attrs += ['fp32']
227 if 'integer' in data_types: attrs += ['integer']
228 if 'qasymm8' in data_types: attrs += ['qasymm8']
229 if 'qasymm8_signed' in data_types: attrs += ['qasymm8_signed']
230 if 'qsymm16' in data_types: attrs += ['qsymm16']
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100231 # Manage data-layouts
Freddie Liardet487d3902021-09-21 12:36:43 +0100232 if 'all' in data_layouts:
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100233 attrs += ['nhwc', 'nchw']
234 else:
Freddie Liardet487d3902021-09-21 12:36:43 +0100235 if 'nhwc' in data_layouts: attrs += ['nhwc']
236 if 'nchw' in data_layouts: attrs += ['nchw']
Michalis Spyrou20fca522021-06-07 14:23:57 +0100237
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100238 # Manage execution state
Freddie Liardet487d3902021-09-21 12:36:43 +0100239 attrs += ['estate32' if (env['estate'] == 'auto' and 'v7a' in env['arch']) or '32' in env['estate'] else 'estate64']
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200240
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100241 return attrs
Michalis Spyrou20fca522021-06-07 14:23:57 +0100242
Michalis Spyrou20fca522021-06-07 14:23:57 +0100243
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100244def get_operator_backend_files(filelist, operators, backend='', techs=[], attrs=[]):
245 files = { "common" : [] }
Michalis Spyrou20fca522021-06-07 14:23:57 +0100246
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100247 # Early return if filelist is empty
248 if backend not in filelist:
249 return files
Michalis Spyrou20fca522021-06-07 14:23:57 +0100250
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100251 # Iterate over operators and create the file lists to compiler
252 for operator in operators:
253 if operator in filelist[backend]['operators']:
254 files['common'] += filelist[backend]['operators'][operator]["files"]["common"]
255 for tech in techs:
256 if tech in filelist[backend]['operators'][operator]["files"]:
257 # Add tech as a key to dictionary if not there
258 if tech not in files:
259 files[tech] = []
Michalis Spyrou20fca522021-06-07 14:23:57 +0100260
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100261 # Add tech files to the tech file list
262 tech_files = filelist[backend]['operators'][operator]["files"][tech]
263 files[tech] += tech_files.get('common', [])
264 for attr in attrs:
265 files[tech] += tech_files.get(attr, [])
266
267 # Remove duplicates if they exist
268 return {k: list(set(v)) for k,v in files.items()}
269
270def collect_operators(filelist, operators, backend=''):
271 ops = set()
272 for operator in operators:
273 if operator in filelist[backend]['operators']:
274 ops.add(operator)
275 if 'deps' in filelist[backend]['operators'][operator]:
276 ops.update(filelist[backend]['operators'][operator]['deps'])
277 else:
278 print("Operator {0} is unsupported on {1} backend!".format(operator, backend))
279
280 return ops
281
282
283def resolve_operator_dependencies(filelist, operators, backend=''):
284 resolved_operators = collect_operators(filelist, operators, backend)
285
286 are_ops_resolved = False
287 while not are_ops_resolved:
288 resolution_pass = collect_operators(filelist, resolved_operators, backend)
289 if len(resolution_pass) != len(resolved_operators):
290 resolved_operators.update(resolution_pass)
291 else:
292 are_ops_resolved = True
293
294 return resolved_operators
295
Freddie Liardet487d3902021-09-21 12:36:43 +0100296def read_build_config_json(build_config):
297 build_config_contents = {}
298 custom_operators = []
299 custom_types = []
300 custom_layouts = []
301 if os.path.isfile(build_config):
302 with open(build_config) as f:
303 try:
304 build_config_contents = json.load(f)
305 except:
306 print("Warning: Build configuration file is of invalid JSON format!")
307 else:
308 try:
309 build_config_contents = json.loads(build_config)
310 except:
311 print("Warning: Build configuration string is of invalid JSON format!")
312 if build_config_contents:
313 custom_operators = build_config_contents.get("operators", [])
314 custom_types = build_config_contents.get("data_types", [])
315 custom_layouts = build_config_contents.get("data_layouts", [])
316 return custom_operators, custom_types, custom_layouts
Michalis Spyrou20fca522021-06-07 14:23:57 +0100317
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100318arm_compute_env = env.Clone()
Anthony Barbier0e72c692018-08-24 11:22:08 +0100319version_file = arm_compute_env.Command("src/core/arm_compute_version.embed", "", action=create_version_file)
320arm_compute_env.AlwaysBuild(version_file)
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000321
Kevin Lo7195f712022-01-07 15:46:02 +0800322default_cpp_compiler = 'g++' if env['os'] not in ['android', 'macos', 'openbsd'] else 'clang++'
Georgios Pinitas4d9687e2020-10-21 18:33:36 +0100323cpp_compiler = os.environ.get('CXX', default_cpp_compiler)
324
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000325# Generate embed files
Anthony Barbier0e72c692018-08-24 11:22:08 +0100326generate_embed = [ version_file ]
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000327if env['opencl'] and env['embed_kernels']:
Giorgio Arena892b70a2022-03-30 12:23:10 +0100328
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100329 # Header files
330 cl_helper_files = [ 'src/core/CL/cl_kernels/activation_float_helpers.h',
331 'src/core/CL/cl_kernels/activation_quant_helpers.h',
332 'src/core/CL/cl_kernels/gemm_helpers.h',
333 'src/core/CL/cl_kernels/helpers_asymm.h',
334 'src/core/CL/cl_kernels/helpers.h',
335 'src/core/CL/cl_kernels/load_store_utility.h',
336 'src/core/CL/cl_kernels/repeat.h',
337 'src/core/CL/cl_kernels/tile_helpers.h',
338 'src/core/CL/cl_kernels/types.h',
SiCongLi1af54162021-10-06 15:25:57 +0100339 'src/core/CL/cl_kernels/warp_helpers.h',
340 'src/core/CL/cl_kernels/common/experimental/gemm_fused_post_ops/act_eltwise_op_act/fp_post_ops_act_eltwise_op_act.h',
341 'src/core/CL/cl_kernels/common/experimental/gemm_fused_post_ops/fp_mixed_precision_helpers.h',
342 'src/core/CL/cl_kernels/common/experimental/gemm_fused_post_ops/fp_elementwise_op_helpers.h',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100343 ]
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000344
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100345 # Common kernels
346 cl_files_common = ['src/core/CL/cl_kernels/common/activation_layer.cl',
347 'src/core/CL/cl_kernels/common/activation_layer_quant.cl',
348 'src/core/CL/cl_kernels/common/arg_min_max.cl',
349 'src/core/CL/cl_kernels/common/batchnormalization_layer.cl',
350 'src/core/CL/cl_kernels/common/bounding_box_transform.cl',
351 'src/core/CL/cl_kernels/common/bounding_box_transform_quantized.cl',
352 'src/core/CL/cl_kernels/common/bitwise_op.cl',
353 'src/core/CL/cl_kernels/common/cast.cl',
354 'src/core/CL/cl_kernels/common/comparisons.cl',
355 'src/core/CL/cl_kernels/common/concatenate.cl',
356 'src/core/CL/cl_kernels/common/col2im.cl',
357 'src/core/CL/cl_kernels/common/convert_fc_weights.cl',
358 'src/core/CL/cl_kernels/common/copy_tensor.cl',
359 'src/core/CL/cl_kernels/common/crop_tensor.cl',
360 'src/core/CL/cl_kernels/common/deconvolution_layer.cl',
361 'src/core/CL/cl_kernels/common/dequantization_layer.cl',
362 'src/core/CL/cl_kernels/common/elementwise_operation.cl',
363 'src/core/CL/cl_kernels/common/elementwise_operation_quantized.cl',
364 'src/core/CL/cl_kernels/common/elementwise_unary.cl',
365 'src/core/CL/cl_kernels/common/fft_digit_reverse.cl',
366 'src/core/CL/cl_kernels/common/fft.cl',
367 'src/core/CL/cl_kernels/common/fft_scale.cl',
368 'src/core/CL/cl_kernels/common/fill_border.cl',
369 'src/core/CL/cl_kernels/common/floor.cl',
370 'src/core/CL/cl_kernels/common/gather.cl',
371 'src/core/CL/cl_kernels/common/gemm.cl',
ramelg019cca5922021-11-11 10:05:00 +0000372 'src/core/CL/cl_kernels/common/gemm_utils.cl',
SiCongLiafa19722021-10-24 19:12:33 +0100373 'src/core/CL/cl_kernels/common/experimental/gemm_fused_post_ops/act_eltwise_op_act/gemm_mm_native.cl',
SiCongLi1af54162021-10-06 15:25:57 +0100374 'src/core/CL/cl_kernels/common/experimental/gemm_fused_post_ops/act_eltwise_op_act/gemm_mm_reshaped.cl',
Ramy Elgammal451c3092022-02-01 23:01:27 +0000375 'src/core/CL/cl_kernels/common/experimental/gemm_fused_post_ops/act_eltwise_op_act/gemm_mm_reshaped_only_rhs.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100376 'src/core/CL/cl_kernels/common/gemv.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100377 'src/core/CL/cl_kernels/common/gemmlowp.cl',
378 'src/core/CL/cl_kernels/common/generate_proposals.cl',
379 'src/core/CL/cl_kernels/common/generate_proposals_quantized.cl',
380 'src/core/CL/cl_kernels/common/instance_normalization.cl',
381 'src/core/CL/cl_kernels/common/l2_normalize.cl',
382 'src/core/CL/cl_kernels/common/mean_stddev_normalization.cl',
383 'src/core/CL/cl_kernels/common/unpooling_layer.cl',
384 'src/core/CL/cl_kernels/common/memset.cl',
385 'src/core/CL/cl_kernels/common/nonmax.cl',
386 'src/core/CL/cl_kernels/common/minmax_layer.cl',
387 'src/core/CL/cl_kernels/common/pad_layer.cl',
388 'src/core/CL/cl_kernels/common/permute.cl',
389 'src/core/CL/cl_kernels/common/pixelwise_mul_float.cl',
390 'src/core/CL/cl_kernels/common/pixelwise_mul_int.cl',
391 'src/core/CL/cl_kernels/common/qlstm_layer_normalization.cl',
392 'src/core/CL/cl_kernels/common/quantization_layer.cl',
393 'src/core/CL/cl_kernels/common/range.cl',
394 'src/core/CL/cl_kernels/common/reduction_operation.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100395 'src/core/CL/cl_kernels/common/reshape_layer.cl',
396 'src/core/CL/cl_kernels/common/convolution_layer.cl',
397 'src/core/CL/cl_kernels/common/reverse.cl',
398 'src/core/CL/cl_kernels/common/roi_align_layer.cl',
399 'src/core/CL/cl_kernels/common/roi_align_layer_quantized.cl',
400 'src/core/CL/cl_kernels/common/roi_pooling_layer.cl',
401 'src/core/CL/cl_kernels/common/select.cl',
402 'src/core/CL/cl_kernels/common/softmax_layer.cl',
403 'src/core/CL/cl_kernels/common/softmax_layer_quantized.cl',
404 'src/core/CL/cl_kernels/common/stack_layer.cl',
405 'src/core/CL/cl_kernels/common/slice_ops.cl',
406 'src/core/CL/cl_kernels/common/tile.cl',
407 'src/core/CL/cl_kernels/common/transpose.cl'
408 ]
409
410 # NCHW kernels
411 cl_files_nchw = ['src/core/CL/cl_kernels/nchw/batch_to_space.cl',
412 'src/core/CL/cl_kernels/nchw/batchnormalization_layer.cl',
413 'src/core/CL/cl_kernels/nchw/channel_shuffle.cl',
414 'src/core/CL/cl_kernels/nchw/depth_to_space.cl',
Adnan AlSinan30124352021-12-02 19:12:20 +0000415 'src/core/CL/cl_kernels/nchw/direct_convolution.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100416 'src/core/CL/cl_kernels/nchw/dequantization_layer.cl',
417 'src/core/CL/cl_kernels/nchw/im2col.cl',
418 'src/core/CL/cl_kernels/nchw/normalization_layer.cl',
419 'src/core/CL/cl_kernels/nchw/normalize_planar_yuv_layer.cl',
420 'src/core/CL/cl_kernels/nchw/normalize_planar_yuv_layer_quantized.cl',
421 'src/core/CL/cl_kernels/nchw/pooling_layer.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100422 'src/core/CL/cl_kernels/nchw/prior_box_layer.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100423 'src/core/CL/cl_kernels/nchw/reorg_layer.cl',
424 'src/core/CL/cl_kernels/nchw/scale.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100425 'src/core/CL/cl_kernels/nchw/space_to_batch.cl',
426 'src/core/CL/cl_kernels/nchw/space_to_depth.cl',
427 'src/core/CL/cl_kernels/nchw/upsample_layer.cl',
428 'src/core/CL/cl_kernels/nchw/winograd_filter_transform.cl',
429 'src/core/CL/cl_kernels/nchw/winograd_input_transform.cl',
430 'src/core/CL/cl_kernels/nchw/winograd_output_transform.cl'
431 ]
432
433 # NHWC kernels
434 cl_files_nhwc = ['src/core/CL/cl_kernels/nhwc/batch_to_space.cl',
435 'src/core/CL/cl_kernels/nhwc/batchnormalization_layer.cl',
436 'src/core/CL/cl_kernels/nhwc/channel_shuffle.cl',
437 'src/core/CL/cl_kernels/nhwc/direct_convolution.cl',
Giorgio Arena945ae9e2021-10-13 11:13:04 +0100438 'src/core/CL/cl_kernels/nhwc/direct_convolution3d.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100439 'src/core/CL/cl_kernels/nhwc/depth_to_space.cl',
440 'src/core/CL/cl_kernels/nhwc/dequantization_layer.cl',
441 'src/core/CL/cl_kernels/nhwc/dwc_native_fp_nhwc.cl',
442 'src/core/CL/cl_kernels/nhwc/dwc_native_quantized_nhwc.cl',
443 'src/core/CL/cl_kernels/nhwc/im2col.cl',
444 'src/core/CL/cl_kernels/nhwc/normalization_layer.cl',
445 'src/core/CL/cl_kernels/nhwc/normalize_planar_yuv_layer.cl',
446 'src/core/CL/cl_kernels/nhwc/normalize_planar_yuv_layer_quantized.cl',
447 'src/core/CL/cl_kernels/nhwc/pooling_layer.cl',
ramelg0137515692022-02-26 22:06:20 +0000448 'src/core/CL/cl_kernels/nhwc/pooling_3d_layer.cl',
Mohammed Suhail Munshi5e549fa2022-03-16 11:14:06 +0000449 'src/core/CL/cl_kernels/nhwc/pooling_3d_layer_quantized.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100450 'src/core/CL/cl_kernels/nhwc/pooling_layer_quantized.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100451 'src/core/CL/cl_kernels/nhwc/reorg_layer.cl',
452 'src/core/CL/cl_kernels/nhwc/scale.cl',
Adnan AlSinan7075fe22021-07-05 13:12:52 +0100453 'src/core/CL/cl_kernels/nhwc/space_to_batch.cl',
454 'src/core/CL/cl_kernels/nhwc/space_to_depth.cl',
455 'src/core/CL/cl_kernels/nhwc/upsample_layer.cl',
456 'src/core/CL/cl_kernels/nhwc/winograd_filter_transform.cl',
457 'src/core/CL/cl_kernels/nhwc/winograd_input_transform.cl',
458 'src/core/CL/cl_kernels/nhwc/winograd_output_transform.cl'
459 ]
460
461 cl_files = cl_helper_files + cl_files_common + cl_files_nchw + cl_files_nhwc
462
463 embed_files = [ f+"embed" for f in cl_files ]
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000464 arm_compute_env.Append(CPPPATH =[Dir("./src/core/CL/").path] )
465
466 generate_embed.append(arm_compute_env.Command(embed_files, cl_files, action=resolve_includes))
467
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000468Default(generate_embed)
469if env["build"] == "embed_only":
470 Return()
471
Georgios Pinitas35fcc432020-03-26 18:47:46 +0000472# Append version defines for semantic versioning
473arm_compute_env.Append(CPPDEFINES = [('ARM_COMPUTE_VERSION_MAJOR', LIBRARY_VERSION_MAJOR),
474 ('ARM_COMPUTE_VERSION_MINOR', LIBRARY_VERSION_MINOR),
475 ('ARM_COMPUTE_VERSION_PATCH', LIBRARY_VERSION_PATCH)])
476
Isabella Gottardib28f29d2017-11-09 17:05:07 +0000477# Don't allow undefined references in the libraries:
Georgios Pinitas45514032020-12-30 00:03:09 +0000478undefined_flag = '-Wl,-undefined,error' if 'macos' in arm_compute_env["os"] else '-Wl,--no-undefined'
479arm_compute_env.Append(LINKFLAGS=[undefined_flag])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100480arm_compute_env.Append(CPPPATH =[Dir("./src/core/").path] )
481
Kevin Lo7195f712022-01-07 15:46:02 +0800482if env['os'] != 'openbsd':
483 arm_compute_env.Append(LIBS = ['dl'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100484
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200485# Load build definitions file
486with (open(Dir('#').path + '/filedefs.json')) as fd:
487 filedefs = json.load(fd)
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200488 filedefs = filedefs['cpu']['arch']
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200489
490
Georgios Pinitasbdcdc392021-04-22 16:42:03 +0100491with (open(Dir('#').path + '/filelist.json')) as fp:
492 filelist = json.load(fp)
493
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100494# Common backend files
495lib_files = filelist['common']
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100496
Giorgio Arena232c4522022-03-03 10:09:01 +0000497# Experimental files
498# Dynamic fusion
499if env['experimental_dynamic_fusion']:
Giorgio Arena892b70a2022-03-30 12:23:10 +0100500 lib_files += filelist['experimental']['dynamic_fusion']
501 arm_compute_env.Append(CPPDEFINES = ['ENABLE_EXPERIMENTAL_DYNAMIC_FUSION'])
Giorgio Arena232c4522022-03-03 10:09:01 +0000502
503
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100504# Logging files
505if env["logging"]:
506 lib_files += filelist['logging']
Georgios Pinitas8795ffb2017-12-01 16:13:40 +0000507
Georgios Pinitasc3c352e2021-03-18 10:59:40 +0000508# C API files
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100509lib_files += filelist['c_api']['common']
510lib_files += filelist['c_api']['operators']
Georgios Pinitasbdcdc392021-04-22 16:42:03 +0100511
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100512# Scheduler infrastructure
513lib_files += filelist['scheduler']['single']
514if env['cppthreads']:
515 lib_files += filelist['scheduler']['threads']
516if env['openmp']:
517 lib_files += filelist['scheduler']['omp']
Georgios Pinitas8a5146f2021-01-12 15:51:07 +0000518
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100519# Graph files
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100520graph_files = Glob('src/graph/*.cpp')
521graph_files += Glob('src/graph/*/*.cpp')
Georgios Pinitasd8734b52017-12-22 15:27:52 +0000522
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100523# Specify user-defined priority operators
Freddie Liardet487d3902021-09-21 12:36:43 +0100524custom_operators = []
525custom_types = []
526custom_layouts = []
527
528use_custom_ops = env['high_priority'] or env['build_config'];
529
530if env['high_priority']:
531 custom_operators = filelist['high_priority']
532 custom_types = ['all']
533 custom_layouts = ['all']
534
535if env['build_config']:
536 custom_operators, custom_types, custom_layouts = read_build_config_json(env['build_config'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100537
538if env['opencl']:
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100539 lib_files += filelist['c_api']['gpu']
540 lib_files += filelist['gpu']['common']
Michele Di Giorgio760c7832021-08-05 10:54:13 +0100541
Freddie Liardet487d3902021-09-21 12:36:43 +0100542 cl_operators = custom_operators if use_custom_ops else filelist['gpu']['operators'].keys()
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100543 cl_ops_to_build = resolve_operator_dependencies(filelist, cl_operators, 'gpu')
544 lib_files += get_operator_backend_files(filelist, cl_ops_to_build, 'gpu')['common']
Georgios Pinitasd8734b52017-12-22 15:27:52 +0000545
Georgios Pinitas13ef1762021-07-14 17:14:43 +0100546 graph_files += Glob('src/graph/backends/CL/*.cpp')
547
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200548
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100549lib_files_sve = []
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200550lib_files_sve2 = []
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200551
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100552if env['neon']:
Georgios Pinitas30271c72019-06-24 14:56:34 +0100553 # build winograd/depthwise sources for either v7a / v8a
Sang-Hoon Park68dd25f2020-10-19 16:00:11 +0100554 arm_compute_env.Append(CPPPATH = ["src/core/NEON/kernels/convolution/common/",
Michele Di Giorgio6ad60af2020-06-09 14:52:15 +0100555 "src/core/NEON/kernels/convolution/winograd/",
ramelg01c827e992022-04-08 03:52:28 +0100556 "src/core/NEON/kernels/arm_conv/depthwise/",
557 "src/core/NEON/kernels/arm_conv/pooling/",
ramelg018a164882022-04-07 02:42:52 +0100558 "src/core/NEON/kernels/arm_conv/",
Sang-Hoon Park68dd25f2020-10-19 16:00:11 +0100559 "src/core/NEON/kernels/assembly/",
Sang-Hoon Park4f7693d2021-05-12 13:59:10 +0100560 "arm_compute/core/NEON/kernels/assembly/",
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200561 "src/cpu/kernels/assembly/"])
Pablo Tello9ceebbe2018-01-10 16:44:13 +0000562
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100563 lib_files += filelist['cpu']['common']
Georgios Pinitasff4fca02020-10-02 21:00:00 +0100564
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100565 # Setup SIMD file list to include
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200566 simd = ['neon']
567 if env['multi_isa']:
568 simd += ['sve', 'sve2']
569 else:
570 if 'sve' in env['arch']: simd += ['sve']
571 if 'sve2' in env['arch']: simd += ['sve2']
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100572
573 # Get attributes
Freddie Liardet487d3902021-09-21 12:36:43 +0100574 if(use_custom_ops):
575 attrs = get_attrs_list(env, custom_types, custom_layouts)
576 else:
577 attrs = get_attrs_list(env, env['data_type_support'], env['data_layout_support'])
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100578
579 # Setup data-type and data-layout files to include
Freddie Liardet487d3902021-09-21 12:36:43 +0100580 cpu_operators = custom_operators if use_custom_ops else filelist['cpu']['operators'].keys()
581 cpu_ops_to_build = resolve_operator_dependencies(filelist, cpu_operators, 'cpu')
582
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100583 cpu_files = get_operator_backend_files(filelist, cpu_ops_to_build, 'cpu', simd, attrs)
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200584
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200585 # Shared among ALL CPU files
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100586 lib_files += cpu_files.get('common', [])
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200587
588 # Arm® Neon™ specific files
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100589 lib_files += cpu_files.get('neon', [])
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200590
591 # SVE files only
592 lib_files_sve = cpu_files.get('sve', [])
593
594 # SVE2 files only
595 lib_files_sve2 = cpu_files.get('sve2', [])
Georgios Pinitas13ef1762021-07-14 17:14:43 +0100596
597 graph_files += Glob('src/graph/backends/NEON/*.cpp')
Georgios Pinitas70eb53b2021-01-06 19:42:21 +0000598
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100599# Restrict from building graph API if a reduced operator list has been provided
Freddie Liardet487d3902021-09-21 12:36:43 +0100600if use_custom_ops:
601 print("WARNING: Graph library requires all operators to be built")
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100602 graph_files = []
603
604# Build bootcode in case of bare-metal
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100605bootcode_o = []
606if env['os'] == 'bare_metal':
607 bootcode_files = Glob('bootcode/*.s')
608 bootcode_o = build_bootcode_objs(bootcode_files)
609Export('bootcode_o')
610
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200611
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200612if (env['multi_isa']):
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200613 lib_static_objs, lib_shared_objs = build_lib_objects()
614
615
616# STATIC library build.
617if (env['multi_isa']):
618 arm_compute_a = build_library('arm_compute-static', arm_compute_env, lib_static_objs, static=True)
619else:
620 if 'sve2' in env['arch']:
621 lib_files += lib_files_sve
622 lib_files += lib_files_sve2
623 elif 'sve' in env['arch']:
624 lib_files += lib_files_sve
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200625
Motti Gondabif76a5022021-12-21 13:19:29 +0200626 arm_compute_a = build_library('arm_compute-static', arm_compute_env, lib_files, static=True)
Motti Gondabif76a5022021-12-21 13:19:29 +0200627
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100628Export('arm_compute_a')
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100629
Motti Gondabif76a5022021-12-21 13:19:29 +0200630# SHARED library build.
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100631if env['os'] != 'bare_metal' and not env['standalone']:
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200632 if (env['multi_isa']):
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200633
634 arm_compute_so = build_library('arm_compute', arm_compute_env, lib_shared_objs, static=False)
Georgios Pinitasbdcdc392021-04-22 16:42:03 +0100635 else:
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200636 arm_compute_so = build_library('arm_compute', arm_compute_env, lib_files, static=False)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100637
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100638 Export('arm_compute_so')
639
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100640# Generate dummy core lib for backwards compatibility
Pablo Marquez Tello48f26152021-11-18 10:15:23 +0000641if env['os'] == 'macos':
642 # macos static library archiver fails if given an empty list of files
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200643 arm_compute_core_a = build_library('arm_compute_core-static', arm_compute_env, lib_files, static=True)
Pablo Marquez Tello48f26152021-11-18 10:15:23 +0000644else:
645 arm_compute_core_a = build_library('arm_compute_core-static', arm_compute_env, [], static=True)
646
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100647Export('arm_compute_core_a')
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100648
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100649if env['os'] != 'bare_metal' and not env['standalone']:
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100650 arm_compute_core_a_so = build_library('arm_compute_core', arm_compute_env, [], static=False)
651 Export('arm_compute_core_a_so')
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100652
Sang-Hoon Park18fbb922021-01-14 14:50:25 +0000653arm_compute_graph_env = arm_compute_env.Clone()
654
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100655# Build graph libraries
Sang-Hoon Park18fbb922021-01-14 14:50:25 +0000656arm_compute_graph_env.Append(CXXFLAGS = ['-Wno-redundant-move', '-Wno-pessimizing-move'])
657
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200658arm_compute_graph_a = build_library('arm_compute_graph-static', arm_compute_graph_env, graph_files, static=True, libs = [ arm_compute_a ])
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100659Export('arm_compute_graph_a')
Georgios Pinitasd8734b52017-12-22 15:27:52 +0000660
661if env['os'] != 'bare_metal' and not env['standalone']:
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100662 arm_compute_graph_so = build_library('arm_compute_graph', arm_compute_graph_env, graph_files, static=False, libs = [ "arm_compute" ])
Georgios Pinitas9873ea32017-12-05 15:28:55 +0000663 Depends(arm_compute_graph_so, arm_compute_so)
Anthony Barbier2a07e182017-08-04 18:20:27 +0100664 Export('arm_compute_graph_so')
665
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100666if env['standalone']:
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200667 alias = arm_compute_env.Alias("arm_compute", [arm_compute_a])
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100668else:
669 alias = arm_compute_env.Alias("arm_compute", [arm_compute_a, arm_compute_so])
670
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100671Default(alias)
672
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100673if env['standalone']:
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100674 Depends([alias], generate_embed)
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100675else:
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100676 Depends([alias], generate_embed)