blob: 890c51977d341793ac62d2626e25783901437b36 [file] [log] [blame]
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +00001# -*- coding: utf-8 -*-
2
Pablo Tello4e66d702022-03-07 18:20:12 +00003# Copyright (c) 2016-2022 Arm Limited.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01004#
5# SPDX-License-Identifier: MIT
6#
7# Permission is hereby granted, free of charge, to any person obtaining a copy
8# of this software and associated documentation files (the "Software"), to
9# deal in the Software without restriction, including without limitation the
10# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11# sell copies of the Software, and to permit persons to whom the Software is
12# furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included in all
15# copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23# SOFTWARE.
24
25import SCons
Georgios Pinitasb6af4822021-09-14 12:33:34 +010026import json
Anthony Barbier6ff3b192017-09-04 18:44:23 +010027import os
Giorgio Arenab83e6722022-03-24 14:23:07 +000028from subprocess import check_output
Anthony Barbier6ff3b192017-09-04 18:44:23 +010029
30def version_at_least(version, required):
Anthony Barbier6ff3b192017-09-04 18:44:23 +010031
Michalis Spyroucfac3052020-10-14 12:06:28 +010032 version_list = version.split('.')
33 required_list = required.split('.')
34 end = min(len(version_list), len(required_list))
35 for i in range(0, end):
36 if int(version_list[i]) < int(required_list[i]):
Anthony Barbier6ff3b192017-09-04 18:44:23 +010037 return False
Michalis Spyroucfac3052020-10-14 12:06:28 +010038 elif int(version_list[i]) > int(required_list[i]):
Anthony Barbier6ff3b192017-09-04 18:44:23 +010039 return True
40
41 return True
42
Freddie Liardet487d3902021-09-21 12:36:43 +010043def read_build_config_json(build_config):
44 build_config_contents = {}
45 custom_types = []
46 custom_layouts = []
47 if os.path.isfile(build_config):
48 with open(build_config) as f:
49 try:
50 build_config_contents = json.load(f)
51 except:
52 print("Warning: Build configuration file is of invalid JSON format!")
53 else:
54 try:
55 build_config_contents = json.loads(build_config)
56 except:
57 print("Warning: Build configuration string is of invalid JSON format!")
58 if build_config_contents:
59 custom_types = build_config_contents.get("data_types", [])
60 custom_layouts = build_config_contents.get("data_layouts", [])
61 return custom_types, custom_layouts
62
63def update_data_type_layout_flags(env, data_types, data_layouts):
64 # Manage data-types
65 if any(i in data_types for i in ['all', 'fp16']):
66 env.Append(CXXFLAGS = ['-DENABLE_FP16_KERNELS'])
67 if any(i in data_types for i in ['all', 'fp32']):
68 env.Append(CXXFLAGS = ['-DENABLE_FP32_KERNELS'])
69 if any(i in data_types for i in ['all', 'qasymm8']):
70 env.Append(CXXFLAGS = ['-DENABLE_QASYMM8_KERNELS'])
71 if any(i in data_types for i in ['all', 'qasymm8_signed']):
72 env.Append(CXXFLAGS = ['-DENABLE_QASYMM8_SIGNED_KERNELS'])
73 if any(i in data_types for i in ['all', 'qsymm16']):
74 env.Append(CXXFLAGS = ['-DENABLE_QSYMM16_KERNELS'])
75 if any(i in data_types for i in ['all', 'integer']):
76 env.Append(CXXFLAGS = ['-DENABLE_INTEGER_KERNELS'])
77
78 # Manage data-layouts
79 if any(i in data_layouts for i in ['all', 'nhwc']):
80 env.Append(CXXFLAGS = ['-DENABLE_NHWC_KERNELS'])
81 if any(i in data_layouts for i in ['all', 'nchw']):
82 env.Append(CXXFLAGS = ['-DENABLE_NCHW_KERNELS'])
83
84 return env
85
86
Anthony Barbier6ff3b192017-09-04 18:44:23 +010087vars = Variables("scons")
88vars.AddVariables(
89 BoolVariable("debug", "Debug", False),
90 BoolVariable("asserts", "Enable asserts (this flag is forced to 1 for debug=1)", False),
ramelg0193d6cf02021-09-23 13:59:22 +010091 BoolVariable("logging", "Enable Logging", False),
Georgios Pinitasf2cdce32019-12-09 18:35:57 +000092 EnumVariable("arch", "Target Architecture", "armv7a",
Slava Barinovdb0e2c82021-04-07 11:23:27 +030093 allowed_values=("armv7a", "armv7a-hf", "arm64-v8a", "arm64-v8.2-a", "arm64-v8.2-a-sve", "arm64-v8.2-a-sve2", "x86_32", "x86_64",
Sang-Hoon Park50e98bb2021-01-14 14:54:14 +000094 "armv8a", "armv8.2-a", "armv8.2-a-sve", "armv8.6-a", "armv8.6-a-sve", "armv8.6-a-sve2", "armv8r64", "x86")),
Georgios Pinitasf2cdce32019-12-09 18:35:57 +000095 EnumVariable("estate", "Execution State", "auto", allowed_values=("auto", "32", "64")),
Pablo Tello4e66d702022-03-07 18:20:12 +000096 EnumVariable("os", "Target OS", "linux", allowed_values=("linux", "android", "tizen", "macos", "bare_metal", "openbsd","windows")),
Anthony Barbier6a3daf12018-02-19 17:24:27 +000097 EnumVariable("build", "Build type", "cross_compile", allowed_values=("native", "cross_compile", "embed_only")),
Anthony Barbier6ff3b192017-09-04 18:44:23 +010098 BoolVariable("examples", "Build example programs", True),
SiCong Li8b4c7302019-09-19 12:18:15 +010099 BoolVariable("gemm_tuner", "Build gemm_tuner programs", True),
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100100 BoolVariable("Werror", "Enable/disable the -Werror compilation flag", True),
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200101 BoolVariable("multi_isa", "Build Multi ISA binary version of library. Note works only for armv8.2-a", False),
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100102 BoolVariable("standalone", "Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute", False),
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100103 BoolVariable("opencl", "Enable OpenCL support", True),
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +0000104 BoolVariable("neon", "Enable Arm® Neon™ support", False),
Anthony Barbiercc0a80b2017-12-15 11:37:29 +0000105 BoolVariable("embed_kernels", "Embed OpenCL kernels and OpenGL ES compute shaders in library binary", True),
Georgios Pinitasea857272021-01-22 05:47:37 +0000106 BoolVariable("compress_kernels", "Compress embedded OpenCL kernels in library binary. Note embed_kernels should be enabled", False),
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100107 BoolVariable("set_soname", "Set the library's soname and shlibversion (requires SCons 2.4 or above)", False),
108 BoolVariable("openmp", "Enable OpenMP backend", False),
109 BoolVariable("cppthreads", "Enable C++11 threads backend", True),
110 PathVariable("build_dir", "Specify sub-folder for the build", ".", PathVariable.PathAccept),
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000111 PathVariable("install_dir", "Specify sub-folder for the install", "", PathVariable.PathAccept),
Michalis Spyrou323ce0f2018-11-30 16:30:43 +0000112 BoolVariable("exceptions", "Enable/disable C++ exception support", True),
Michalis Spyrou62c2ad62021-06-21 17:40:09 +0100113 BoolVariable("high_priority", "Generate a library containing only the high priority operators", False),
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100114 PathVariable("linker_script", "Use an external linker script", "", PathVariable.PathAccept),
Michele Di Giorgio72610dc2020-11-18 15:29:08 +0000115 PathVariable("external_tests_dir", "Add examples, benchmarks and tests to the tests suite", "", PathVariable.PathAccept),
Giorgio Arena232c4522022-03-03 10:09:01 +0000116 BoolVariable("experimental_dynamic_fusion", "Build the experimental dynamic fusion files", False),
Francesco.Petrogalli@arm.com5fcf22d2022-04-05 10:31:08 +0000117 BoolVariable("experimental_fixed_format_kernels", "Enable fixed format kernels for GEMM", False),
Georgios Pinitas49c6ced2020-09-21 17:16:09 +0100118 ListVariable("custom_options", "Custom options that can be used to turn on/off features", "none", ["disable_mmla_fp"]),
Michalis Spyroua3c9a3b2020-12-08 21:02:16 +0000119 ListVariable("data_type_support", "Enable a list of data types to support", "all", ["qasymm8", "qasymm8_signed", "qsymm16", "fp16", "fp32", "integer"]),
Sheri Zhang79144a62021-02-08 17:43:04 +0000120 ListVariable("data_layout_support", "Enable a list of data layout to support", "all", ["nhwc", "nchw"]),
SiCong Life1b1f62022-05-19 18:58:31 +0100121 ("toolchain_prefix", "Override the toolchain prefix; used by all toolchain components: compilers, linker, assembler etc. If unspecified, use default(auto) prefixes; if passed an empty string '' prefixes would be disabled", "auto"),
122 ("compiler_prefix", "Override the compiler prefix; used by just compilers (CC,CXX); further overrides toolchain_prefix for compilers; this is for when the compiler prefixes are different from that of the linkers, archivers etc. If unspecified, this is the same as toolchain_prefix; if passed an empty string '' prefixes would be disabled", "auto"),
Anthony Barbier7390e052018-03-13 09:29:41 +0000123 ("extra_cxx_flags", "Extra CXX flags to be appended to the build command", ""),
Georgios Pinitas421405b2018-10-26 19:05:32 +0100124 ("extra_link_flags", "Extra LD flags to be appended to the build command", ""),
Manuel Bottinie5a9ad82020-11-18 16:22:16 +0000125 ("compiler_cache", "Command to prefix to the C and C++ compiler (e.g ccache)", ""),
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100126 ("specs_file", "Specs file to use (e.g. rdimon.specs)", ""),
127 ("build_config", "Operator/Data-type/Data-layout configuration to use for tailored ComputeLibrary builds. Can be a JSON file or a JSON formatted string", "")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100128)
129
Motti Gondabif76a5022021-12-21 13:19:29 +0200130
Pablo Tello4e66d702022-03-07 18:20:12 +0000131env = Environment(variables=vars, ENV = os.environ)
132
133
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100134build_path = env['build_dir']
135# If build_dir is a relative path then add a #build/ prefix:
136if not env['build_dir'].startswith('/'):
137 SConsignFile('build/%s/.scons' % build_path)
138 build_path = "#build/%s" % build_path
139else:
140 SConsignFile('%s/.scons' % build_path)
141
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000142install_path = env['install_dir']
143#If the install_dir is a relative path then assume it's from inside build_dir
144if not env['install_dir'].startswith('/') and install_path != "":
145 install_path = "%s/%s" % (build_path, install_path)
146
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100147env.Append(LIBPATH = [build_path])
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000148Export('env')
149Export('vars')
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100150
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000151def install_lib( lib ):
152 # If there is no install folder, then there is nothing to do:
153 if install_path == "":
154 return lib
155 return env.Install( "%s/lib/" % install_path, lib)
156def install_bin( bin ):
157 # If there is no install folder, then there is nothing to do:
158 if install_path == "":
159 return bin
160 return env.Install( "%s/bin/" % install_path, bin)
161def install_include( inc ):
162 if install_path == "":
163 return inc
164 return env.Install( "%s/include/" % install_path, inc)
165
166Export('install_lib')
167Export('install_bin')
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100168
169Help(vars.GenerateHelpText(env))
170
Michalis Spyrou14ce0942022-06-13 15:40:35 +0100171if 'armv7a' in env['arch'] and env['os'] == 'android':
172 print("armv7a is not supported on Android")
173 Exit(1)
174
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100175if env['linker_script'] and env['os'] != 'bare_metal':
176 print("Linker script is only supported for bare_metal builds")
177 Exit(1)
178
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000179if env['build'] == "embed_only":
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100180 SConscript('./SConscript', variant_dir=build_path, duplicate=0)
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000181 Return()
182
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100183if env['neon'] and 'x86' in env['arch']:
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +0000184 print("Cannot compile Arm® Neon™ for x86")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100185 Exit(1)
186
187if env['set_soname'] and not version_at_least(SCons.__version__, "2.4"):
ggardet767c9f72018-06-29 17:01:01 +0200188 print("Setting the library's SONAME / SHLIBVERSION requires SCons 2.4 or above")
189 print("Update your version of SCons or use set_soname=0")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100190 Exit(1)
191
192if env['os'] == 'bare_metal':
193 if env['cppthreads'] or env['openmp']:
194 print("ERROR: OpenMP and C++11 threads not supported in bare_metal. Use cppthreads=0 openmp=0")
195 Exit(1)
196
Georgios Pinitasea857272021-01-22 05:47:37 +0000197if env['opencl'] and env['embed_kernels'] and env['compress_kernels'] and env['os'] not in ['android']:
198 print("Compressed kernels are supported only for android builds")
199 Exit(1)
200
Michalis Spyrou323ce0f2018-11-30 16:30:43 +0000201if not env['exceptions']:
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000202 if env['opencl']:
203 print("ERROR: OpenCL is not supported when building without exceptions. Use opencl=0")
Michalis Spyrou323ce0f2018-11-30 16:30:43 +0000204 Exit(1)
205
206 env.Append(CPPDEFINES = ['ARM_COMPUTE_EXCEPTIONS_DISABLED'])
207 env.Append(CXXFLAGS = ['-fno-exceptions'])
208
Michalis Spyrou6bff1952019-10-02 17:22:11 +0100209env.Append(CXXFLAGS = ['-Wall','-DARCH_ARM',
Pablo Tello4e66d702022-03-07 18:20:12 +0000210 '-Wextra','-Wdisabled-optimization','-Wformat=2',
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100211 '-Winit-self','-Wstrict-overflow=2','-Wswitch-default',
Pablo Tello4e66d702022-03-07 18:20:12 +0000212 '-Woverloaded-virtual', '-Wformat-security',
Michalis Spyroufae513c2019-10-16 17:41:33 +0100213 '-Wctor-dtor-privacy','-Wsign-promo','-Weffc++','-Wno-overlength-strings'])
Isabella Gottardib28f29d2017-11-09 17:05:07 +0000214
Pablo Tello4e66d702022-03-07 18:20:12 +0000215if not 'windows' in env['os']:
216 env.Append(CXXFLAGS = ['-std=c++14', '-pedantic' ])
217
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100218env.Append(CPPDEFINES = ['_GLIBCXX_USE_NANOSLEEP'])
219
Pablo Tello4e66d702022-03-07 18:20:12 +0000220cpp_tool = {'linux': 'g++', 'android' : 'clang++',
221 'tizen': 'g++', 'macos':'clang++',
222 'bare_metal':'g++', 'openbsd':'g++','windows':'clang-cl'}
223
224c_tool = {'linux':'gcc', 'android': 'clang', 'tizen':'gcc',
225 'macos':'clang','bare_metal':'gcc',
226 'openbsd':'gcc','windows':'clang-cl'}
227
228default_cpp_compiler = cpp_tool[env['os']]
229default_c_compiler = c_tool[env['os']]
Anthony Barbiera026e982018-01-18 10:57:52 +0000230cpp_compiler = os.environ.get('CXX', default_cpp_compiler)
231c_compiler = os.environ.get('CC', default_c_compiler)
232
Anthony Barbierdd669372018-03-01 17:08:54 +0000233if env['os'] == 'android' and ( 'clang++' not in cpp_compiler or 'clang' not in c_compiler ):
ggardet767c9f72018-06-29 17:01:01 +0200234 print( "WARNING: Only clang is officially supported to build the Compute Library for Android")
Anthony Barbiera026e982018-01-18 10:57:52 +0000235
Anthony Barbierdd669372018-03-01 17:08:54 +0000236if 'clang++' in cpp_compiler:
Michalis Spyrou7c60c992019-10-10 14:33:47 +0100237 env.Append(CXXFLAGS = ['-Wno-vla-extension'])
Georgios Pinitase874ef92019-09-09 17:40:33 +0100238elif 'armclang' in cpp_compiler:
239 pass
Pablo Tello4e66d702022-03-07 18:20:12 +0000240elif not 'windows' in env['os']:
Giorgio Arenab83e6722022-03-24 14:23:07 +0000241 env.Append(CXXFLAGS = ['-Wlogical-op','-Wnoexcept','-Wstrict-null-sentinel','-Wno-misleading-indentation'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100242
SiCongLi410e21e2020-12-11 15:07:53 +0000243if cpp_compiler == 'g++':
244 # Don't strip comments that could include markers
245 env.Append(CXXFLAGS = ['-C'])
246
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100247if env['cppthreads']:
248 env.Append(CPPDEFINES = [('ARM_COMPUTE_CPP_SCHEDULER', 1)])
249
250if env['openmp']:
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100251 env.Append(CPPDEFINES = [('ARM_COMPUTE_OPENMP_SCHEDULER', 1)])
252 env.Append(CXXFLAGS = ['-fopenmp'])
253 env.Append(LINKFLAGS = ['-fopenmp'])
254
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000255# Validate and define state
256if env['estate'] == 'auto':
257 if 'v7a' in env['arch']:
258 env['estate'] = '32'
259 else:
260 env['estate'] = '64'
261
262# Map legacy arch
263if 'arm64' in env['arch']:
264 env['estate'] = '64'
265
266if 'v7a' in env['estate'] and env['estate'] == '64':
267 print("ERROR: armv7a architecture has only 32-bit execution state")
268 Exit(1)
269
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200270env.Append(CPPDEFINES = ['ENABLE_NEON', 'ARM_COMPUTE_ENABLE_NEON'])
271
Motti Gondabif76a5022021-12-21 13:19:29 +0200272if 'sve' in env['arch']:
273 env.Append(CPPDEFINES = ['ENABLE_SVE', 'ARM_COMPUTE_ENABLE_SVE'])
274 if 'sve2' in env['arch']:
275 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SVE2'])
Motti Gondabif76a5022021-12-21 13:19:29 +0200276
Georgios Pinitase874ef92019-09-09 17:40:33 +0100277# Add architecture specific flags
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200278if env['multi_isa']:
279 # assert arch version is v8
280 if 'v8' not in env['arch']:
281 print("Currently Multi ISA binary is only supported for arm v8 family")
282 Exit(1)
Georgios Pinitas94672fb2020-01-22 18:36:27 +0000283
Georgios Pinitas8e2f64f2021-07-28 13:18:46 +0100284 if 'v8.6-a' in env['arch']:
Georgios Pinitas49c6ced2020-09-21 17:16:09 +0100285 if "disable_mmla_fp" not in env['custom_options']:
Michalis Spyrou20fca522021-06-07 14:23:57 +0100286 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SVEF32MM'])
Georgios Pinitas8e2f64f2021-07-28 13:18:46 +0100287
Giorgio Arena73fa0a72022-02-10 15:06:51 +0000288 env.Append(CXXFLAGS = ['-march=armv8.2-a+fp16']) # explicitly enable fp16 extension otherwise __ARM_FEATURE_FP16_VECTOR_ARITHMETIC is undefined
289
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200290else: # NONE "multi_isa" builds
291
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200292 if 'v7a' in env['arch']:
293 env.Append(CXXFLAGS = ['-march=armv7-a', '-mthumb', '-mfpu=neon'])
294 if (env['os'] == 'android' or env['os'] == 'tizen') and not 'hf' in env['arch']:
295 env.Append(CXXFLAGS = ['-mfloat-abi=softfp'])
296 else:
297 env.Append(CXXFLAGS = ['-mfloat-abi=hard'])
298 elif 'v8' in env['arch']:
299 # Preserve the V8 archs for non-multi-ISA variants
300 if 'sve2' in env['arch']:
301 env.Append(CXXFLAGS = ['-march=armv8.2-a+sve2+fp16+dotprod'])
302 elif 'sve' in env['arch']:
303 env.Append(CXXFLAGS = ['-march=armv8.2-a+sve+fp16+dotprod'])
304 elif 'armv8r64' in env['arch']:
305 env.Append(CXXFLAGS = ['-march=armv8.4-a'])
306 elif 'v8.' in env['arch']:
307 env.Append(CXXFLAGS = ['-march=armv8.2-a+fp16']) # explicitly enable fp16 extension otherwise __ARM_FEATURE_FP16_VECTOR_ARITHMETIC is undefined
308 else:
309 env.Append(CXXFLAGS = ['-march=armv8-a'])
310
311 if 'v8.6-a' in env['arch']:
312 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_I8MM', 'ARM_COMPUTE_ENABLE_BF16'])
313 if "disable_mmla_fp" not in env['custom_options']:
314 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SVEF32MM'])
315 if 'v8.' in env['arch']:
316 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_FP16'])
317
318 elif 'x86' in env['arch']:
319 if env['estate'] == '32':
320 env.Append(CCFLAGS = ['-m32'])
321 env.Append(LINKFLAGS = ['-m32'])
322 else:
323 env.Append(CXXFLAGS = ['-fPIC'])
324 env.Append(CCFLAGS = ['-m64'])
325 env.Append(LINKFLAGS = ['-m64'])
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000326
327# Define toolchain
SiCongLifecdb8f2022-01-04 18:33:17 +0000328# The reason why we distinguish toolchain_prefix from compiler_prefix is for cases where the linkers/archivers use a
329# different prefix than the compilers. An example is the NDK r20 toolchain
SiCong Life1b1f62022-05-19 18:58:31 +0100330auto_toolchain_prefix = ""
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000331if 'x86' not in env['arch']:
332 if env['estate'] == '32':
333 if env['os'] == 'linux':
SiCong Life1b1f62022-05-19 18:58:31 +0100334 auto_toolchain_prefix = "arm-linux-gnueabihf-" if 'v7' in env['arch'] else "armv8l-linux-gnueabihf-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000335 elif env['os'] == 'bare_metal':
SiCong Life1b1f62022-05-19 18:58:31 +0100336 auto_toolchain_prefix = "arm-eabi-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000337 elif env['os'] == 'android':
SiCong Life1b1f62022-05-19 18:58:31 +0100338 auto_toolchain_prefix = "arm-linux-androideabi-"
Inki Dae51a95582020-03-23 08:29:02 +0900339 elif env['os'] == 'tizen':
SiCong Life1b1f62022-05-19 18:58:31 +0100340 auto_toolchain_prefix = "armv7l-tizen-linux-gnueabi-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000341 elif env['estate'] == '64' and 'v8' in env['arch']:
342 if env['os'] == 'linux':
SiCong Life1b1f62022-05-19 18:58:31 +0100343 auto_toolchain_prefix = "aarch64-linux-gnu-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000344 elif env['os'] == 'bare_metal':
SiCong Life1b1f62022-05-19 18:58:31 +0100345 auto_toolchain_prefix = "aarch64-elf-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000346 elif env['os'] == 'android':
SiCong Life1b1f62022-05-19 18:58:31 +0100347 auto_toolchain_prefix = "aarch64-linux-android-"
Inki Dae51a95582020-03-23 08:29:02 +0900348 elif env['os'] == 'tizen':
SiCong Life1b1f62022-05-19 18:58:31 +0100349 auto_toolchain_prefix = "aarch64-tizen-linux-gnu-"
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100350
351if env['build'] == 'native':
SiCongLifecdb8f2022-01-04 18:33:17 +0000352 toolchain_prefix = ""
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100353
SiCong Life1b1f62022-05-19 18:58:31 +0100354if env["toolchain_prefix"] == "":
355 toolchain_prefix = ""
356elif env["toolchain_prefix"] == "auto":
357 toolchain_prefix = auto_toolchain_prefix
358else:
SiCongLifecdb8f2022-01-04 18:33:17 +0000359 toolchain_prefix = env["toolchain_prefix"]
Anthony Barbier149de5b2018-12-06 10:27:37 +0000360
SiCong Life1b1f62022-05-19 18:58:31 +0100361if env["compiler_prefix"] == "":
362 compiler_prefix = ""
363elif env["compiler_prefix"] == "auto":
364 compiler_prefix = toolchain_prefix
365else:
alered01d8872c12020-02-10 11:29:45 +0000366 compiler_prefix = env["compiler_prefix"]
367
368env['CC'] = env['compiler_cache']+ " " + compiler_prefix + c_compiler
369env['CXX'] = env['compiler_cache']+ " " + compiler_prefix + cpp_compiler
SiCongLifecdb8f2022-01-04 18:33:17 +0000370env['LD'] = toolchain_prefix + "ld"
371env['AS'] = toolchain_prefix + "as"
Pablo Tello4e66d702022-03-07 18:20:12 +0000372if env['os'] == 'windows':
373 env['AR'] = "LIB"
374else:
SiCongLifecdb8f2022-01-04 18:33:17 +0000375 env['AR'] = toolchain_prefix + "ar"
376env['RANLIB'] = toolchain_prefix + "ranlib"
Pablo Tello4e66d702022-03-07 18:20:12 +0000377
SiCong Life1b1f62022-05-19 18:58:31 +0100378print("Using compilers:")
379print("CC", env['CC'])
380print("CXX", env['CXX'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100381
382if not GetOption("help"):
383 try:
Pablo Tello4e66d702022-03-07 18:20:12 +0000384 if env['os'] == 'windows':
Giorgio Arenab83e6722022-03-24 14:23:07 +0000385 compiler_ver = check_output("clang++ -dumpversion").decode().strip()
Pablo Tello4e66d702022-03-07 18:20:12 +0000386 else:
Giorgio Arenab83e6722022-03-24 14:23:07 +0000387 compiler_ver = check_output(env['CXX'].split() + ["-dumpversion"]).decode().strip()
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100388 except OSError:
389 print("ERROR: Compiler '%s' not found" % env['CXX'])
390 Exit(1)
391
Georgios Pinitase874ef92019-09-09 17:40:33 +0100392 if 'armclang' in cpp_compiler:
393 pass
394 elif 'clang++' not in cpp_compiler:
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100395 if env['arch'] == 'arm64-v8.2-a' and not version_at_least(compiler_ver, '6.2.1'):
ggardet767c9f72018-06-29 17:01:01 +0200396 print("GCC 6.2.1 or newer is required to compile armv8.2-a code")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100397 Exit(1)
398 elif env['arch'] == 'arm64-v8a' and not version_at_least(compiler_ver, '4.9'):
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +0000399 print("GCC 4.9 or newer is required to compile Arm® Neon™ code for AArch64")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100400 Exit(1)
401
402 if version_at_least(compiler_ver, '6.1'):
403 env.Append(CXXFLAGS = ['-Wno-ignored-attributes'])
404
405 if compiler_ver == '4.8.3':
406 env.Append(CXXFLAGS = ['-Wno-array-bounds'])
407
Michalis Spyroucfac3052020-10-14 12:06:28 +0100408 if not version_at_least(compiler_ver, '7.0.0') and env['os'] == 'bare_metal':
409 env.Append(LINKFLAGS = ['-fstack-protector-strong'])
410
Giorgio Arenab83e6722022-03-24 14:23:07 +0000411 # For NDK >= r21, clang 9 or above is used
412 if env['os'] == 'android' and version_at_least(compiler_ver, '9.0.0'):
413 env['ndk_above_r21'] = True
414
415 if env['openmp']:
416 env.Append(LINKFLAGS = ['-static-openmp'])
417
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100418if env['high_priority'] and env['build_config']:
SiCongLidc85d782021-12-17 13:22:55 +0000419 print("The high priority library cannot be built in conjunction with a user-specified build configuration")
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100420 Exit(1)
421
422if not env['high_priority'] and not env['build_config']:
423 env.Append(CPPDEFINES = ['ARM_COMPUTE_GRAPH_ENABLED'])
424
Freddie Liardet487d3902021-09-21 12:36:43 +0100425data_types = []
426data_layouts = []
Georgios Pinitasff4fca02020-10-02 21:00:00 +0100427
Freddie Liardet487d3902021-09-21 12:36:43 +0100428# Set correct data types / layouts to build
429if env['high_priority']:
430 data_types = ['all']
431 data_layouts = ['all']
432elif env['build_config']:
433 data_types, data_layouts = read_build_config_json(env['build_config'])
434else:
435 data_types = env['data_type_support']
436 data_layouts = env['data_layout_support']
437
438env = update_data_type_layout_flags(env, data_types, data_layouts)
Sheri Zhang79144a62021-02-08 17:43:04 +0000439
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100440if env['standalone']:
Pablo Tello4e66d702022-03-07 18:20:12 +0000441 if not 'windows' in env['os']:
442 env.Append(CXXFLAGS = ['-fPIC'])
Anthony Barbier665c89b2018-07-16 11:40:09 +0100443 env.Append(LINKFLAGS = ['-static-libgcc','-static-libstdc++'])
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100444
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100445if env['Werror']:
446 env.Append(CXXFLAGS = ['-Werror'])
447
448if env['os'] == 'android':
449 env.Append(CPPDEFINES = ['ANDROID'])
Michalis Spyrou2d22c3f2020-02-12 14:50:19 +0000450 env.Append(LINKFLAGS = ['-pie', '-static-libstdc++', '-ldl'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100451elif env['os'] == 'bare_metal':
452 env.Append(LINKFLAGS = ['-static'])
453 env.Append(CXXFLAGS = ['-fPIC'])
Manuel Bottinie5a9ad82020-11-18 16:22:16 +0000454 if env['specs_file'] == "":
455 env.Append(LINKFLAGS = ['-specs=rdimon.specs'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100456 env.Append(CPPDEFINES = ['NO_MULTI_THREADING'])
Michalis Spyrou07781ac2017-08-31 15:11:41 +0100457 env.Append(CPPDEFINES = ['BARE_METAL'])
Manuel Bottini827817e2020-11-19 12:12:06 +0000458if env['os'] == 'linux' and env['arch'] == 'armv7a':
459 env.Append(CXXFLAGS = [ '-Wno-psabi' ])
Pablo Tello4e66d702022-03-07 18:20:12 +0000460if env['os'] == 'windows':
461 env.Append(CXXFLAGS = [ '/std:c++14','/EHa'])
462 env.Append(CXXFLAGS = [ '-Wno-c++98-compat', '-Wno-covered-switch-default','-Wno-c++98-compat-pedantic'])
463 env.Append(CXXFLAGS = [ '-Wno-shorten-64-to-32', '-Wno-sign-conversion','-Wno-documentation'])
464 env.Append(CXXFLAGS = [ '-Wno-extra-semi-stmt', '-Wno-float-equal','-Wno-implicit-int-conversion'])
465 env.Append(CXXFLAGS = [ '-Wno-documentation-pedantic', '-Wno-extra-semi','-Wno-shadow-field-in-constructor'])
466 env.Append(CXXFLAGS = [ '-Wno-float-conversion', '-Wno-switch-enum','-Wno-comma'])
467 env.Append(CXXFLAGS = [ '-Wno-implicit-float-conversion', '-Wno-deprecated-declarations','-Wno-old-style-cast'])
468 env.Append(CXXFLAGS = [ '-Wno-zero-as-null-pointer-constant', '-Wno-inconsistent-missing-destructor-override'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100469
Manuel Bottinie5a9ad82020-11-18 16:22:16 +0000470if env['specs_file'] != "":
471 env.Append(LINKFLAGS = ['-specs='+env['specs_file']])
472
Georgios Pinitas8a5146f2021-01-12 15:51:07 +0000473if env['neon']:
474 env.Append(CPPDEFINES = ['ARM_COMPUTE_CPU_ENABLED'])
475
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100476if env['opencl']:
Georgios Pinitas8a5146f2021-01-12 15:51:07 +0000477 env.Append(CPPDEFINES = ['ARM_COMPUTE_OPENCL_ENABLED'])
Georgios Pinitase6032da2017-10-26 14:13:35 +0100478 if env['os'] in ['bare_metal'] or env['standalone']:
Anthony Barbier5f0124d2018-04-13 14:05:34 +0100479 print("Cannot link OpenCL statically, which is required for bare metal / standalone builds")
480 Exit(1)
481
Anthony Barbier9fb0cac2018-04-20 15:46:21 +0100482if env["os"] not in ["android", "bare_metal"] and (env['opencl'] or env['cppthreads']):
483 env.Append(LIBS = ['pthread'])
484
Kevin Lo7195f712022-01-07 15:46:02 +0800485if env['os'] == 'openbsd':
486 env.Append(LIBS = ['c'])
487 env.Append(CXXFLAGS = ['-fPIC'])
488
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000489if env['opencl']:
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100490 if env['embed_kernels']:
491 env.Append(CPPDEFINES = ['EMBEDDED_KERNELS'])
Georgios Pinitasea857272021-01-22 05:47:37 +0000492 if env['compress_kernels']:
493 env.Append(CPPDEFINES = ['ARM_COMPUTE_COMPRESSED_KERNELS'])
494 env.Append(LIBS = ['z'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100495
496if env['debug']:
497 env['asserts'] = True
498 env.Append(CXXFLAGS = ['-O0','-g','-gdwarf-2'])
499 env.Append(CPPDEFINES = ['ARM_COMPUTE_DEBUG_ENABLED'])
500else:
Pablo Tello4e66d702022-03-07 18:20:12 +0000501 if not 'windows' in env['os']:
502 env.Append(CXXFLAGS = ['-O3'])
503 else:
504 # on windows we use clang-cl which does not support the option -O3
505 env.Append(CXXFLAGS = ['-O2'])
506
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100507if env['asserts']:
508 env.Append(CPPDEFINES = ['ARM_COMPUTE_ASSERTS_ENABLED'])
Moritz Pflanzer8b74c782017-09-14 14:33:20 +0100509 env.Append(CXXFLAGS = ['-fstack-protector-strong'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100510
Georgios Pinitas7d3d1b92017-10-12 17:34:20 +0100511if env['logging']:
512 env.Append(CPPDEFINES = ['ARM_COMPUTE_LOGGING_ENABLED'])
513
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100514env.Append(CPPPATH = ['#/include', "#"])
515env.Append(CXXFLAGS = env['extra_cxx_flags'])
Georgios Pinitas421405b2018-10-26 19:05:32 +0100516env.Append(LINKFLAGS = env['extra_link_flags'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100517
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000518Default( install_include("arm_compute"))
Anthony Barbier10565952018-11-15 09:50:06 +0000519Default( install_include("support"))
Michele Di Giorgio6afea902019-04-03 11:40:20 +0100520Default( install_include("utils"))
521for dirname in os.listdir("./include"):
522 Default( install_include("include/%s" % dirname))
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000523
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100524Export('version_at_least')
525
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100526SConscript('./SConscript', variant_dir=build_path, duplicate=0)
Anthony Barbier6c0348f2017-11-10 18:32:38 +0000527
Freddie Liardet487d3902021-09-21 12:36:43 +0100528if env['examples'] and (env['build_config'] or env['high_priority']):
529 print("WARNING: Building examples for selected operators not supported. Use examples=0")
530 Return()
531
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100532if env['examples'] and env['exceptions']:
533 if env['os'] == 'bare_metal' and env['arch'] == 'armv7a':
Michalis Spyrou35f35a62019-12-23 11:29:52 +0000534 print("WARNING: Building examples for bare metal and armv7a is not supported. Use examples=0")
535 Return()
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100536 SConscript('./examples/SConscript', variant_dir='%s/examples' % build_path, duplicate=0)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100537
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100538if env['exceptions']:
Freddie Liardet487d3902021-09-21 12:36:43 +0100539 if env['build_config'] or env['high_priority']:
540 print("WARNING: Building tests for selected operators not supported")
541 Return()
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100542 if env['os'] == 'bare_metal' and env['arch'] == 'armv7a':
543 print("WARNING: Building tests for bare metal and armv7a is not supported")
544 Return()
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100545 SConscript('./tests/SConscript', variant_dir='%s/tests' % build_path, duplicate=0)
Motti Gondabif76a5022021-12-21 13:19:29 +0200546
547# Unknown variables are not allowed
548# Note: we must delay the call of UnknownVariables until after
549# we have applied the Variables object to the construction environment
550unknown = vars.UnknownVariables()
551if unknown:
552 print("Unknown variables: %s" % " ".join(unknown.keys()))
Ramy Elgammal451c3092022-02-01 23:01:27 +0000553 Exit(1)