blob: f6c90c3098d2f4793ccef605779800927f74d7d6 [file] [log] [blame]
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +00001# -*- coding: utf-8 -*-
2
Pablo Marquez Tello6bcdc572023-01-11 09:54:00 +00003# Copyright (c) 2016-2023 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),
Michalis Spyroua3f7cd22022-07-04 15:32:02 +010092 EnumVariable("arch", "Target Architecture. The x86_32 and x86_64 targets can only be used with neon=0 and opencl=1.", "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",
Viet-Hoa Do03b29712022-06-01 11:47:14 +010094 "armv8a", "armv8.2-a", "armv8.2-a-sve", "armv8.6-a", "armv8.6-a-sve", "armv8.6-a-sve2", "armv8.6-a-sve2-sme2", "armv8r64", "x86")),
Georgios Pinitasf2cdce32019-12-09 18:35:57 +000095 EnumVariable("estate", "Execution State", "auto", allowed_values=("auto", "32", "64")),
Michalis Spyroua3f7cd22022-07-04 15:32:02 +010096 EnumVariable("os", "Target OS. With bare metal selected, only Arm® Neon™ (not OpenCL) can be used, static libraries get built and Neon™'s multi-threading support is disabled.", "linux", allowed_values=("linux", "android", "tizen", "macos", "bare_metal", "openbsd","windows")),
97 EnumVariable("build", "Either build directly on your device (native) or cross compile from your desktop machine (cross-compile). In both cases make sure the compiler is available in your path.", "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),
Sunita Nadampalli911d5722023-05-02 14:05:39 +0000101 BoolVariable("multi_isa", "Build Multi ISA binary version of library. Works for armv8a without the support for FP16 vector arithmetic. Use armv8.2-a or beyond to enable FP16 vector arithmetic support", 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),
Michalis Spyroua3f7cd22022-07-04 15:32:02 +0100105 BoolVariable("embed_kernels", "Enable if you want the OpenCL kernels to be built in the library's binaries instead of being read from separate '.cl' / '.cs' files. If embed_kernels is set to 0 then the application can set the path to the folder containing the OpenCL kernel files by calling CLKernelLibrary::init(). By default the path is set to './cl_kernels'.", True),
106 BoolVariable("compress_kernels", "Compress embedded OpenCL kernels in library binary using zlib. Useful for reducing the binary size. embed_kernels should be enabled", False),
107 BoolVariable("set_soname", "If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects. (requires SCons 2.4 or above)", False),
108 BoolVariable("openmp", "Enable OpenMP backend. Only works when building with g++ and not clang++", False),
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100109 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),
Michalis Spyroua3f7cd22022-07-04 15:32:02 +0100115 PathVariable("external_tests_dir", """Add examples, benchmarks and tests to the tests suite from an external path. In order to use this option, the external tests directory must have the following structure:
116 EXTERNAL_TESTS_DIR:
117 └── tests
118 ├── benchmark
119 │   ├── CL
120 │   ├── datasets
121 │   ├── fixtures
122 │   └── Neon
123 └── validation
124     ├── CL
125     ├── datasets
126     ├── fixtures
127     └── Neon\n""", "", PathVariable.PathAccept),
Giorgio Arena232c4522022-03-03 10:09:01 +0000128 BoolVariable("experimental_dynamic_fusion", "Build the experimental dynamic fusion files", False),
Nathan John Sircombed7113e42023-04-26 15:02:43 +0100129 BoolVariable("fixed_format_kernels", "Enable fixed format kernels for GEMM", False),
Pablo Marquez Tello299d3a12022-10-12 14:58:24 +0100130 BoolVariable("mapfile", "Generate a map file", False),
Georgios Pinitas49c6ced2020-09-21 17:16:09 +0100131 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 +0000132 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 +0000133 ListVariable("data_layout_support", "Enable a list of data layout to support", "all", ["nhwc", "nchw"]),
SiCong Life1b1f62022-05-19 18:58:31 +0100134 ("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"),
135 ("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 +0000136 ("extra_cxx_flags", "Extra CXX flags to be appended to the build command", ""),
Georgios Pinitas421405b2018-10-26 19:05:32 +0100137 ("extra_link_flags", "Extra LD flags to be appended to the build command", ""),
Manuel Bottinie5a9ad82020-11-18 16:22:16 +0000138 ("compiler_cache", "Command to prefix to the C and C++ compiler (e.g ccache)", ""),
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100139 ("specs_file", "Specs file to use (e.g. rdimon.specs)", ""),
140 ("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 +0100141)
142
Viet-Hoa Do36dc77d2023-03-03 10:44:58 +0000143if version_at_least(SCons.__version__, "4.0"):
144 vars.Add(BoolVariable("export_compile_commands", "Export compile_commands.json file.", False))
145
Motti Gondabif76a5022021-12-21 13:19:29 +0200146
Pablo Tello4e66d702022-03-07 18:20:12 +0000147env = Environment(variables=vars, ENV = os.environ)
148
149
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100150build_path = env['build_dir']
151# If build_dir is a relative path then add a #build/ prefix:
152if not env['build_dir'].startswith('/'):
153 SConsignFile('build/%s/.scons' % build_path)
154 build_path = "#build/%s" % build_path
155else:
156 SConsignFile('%s/.scons' % build_path)
157
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000158install_path = env['install_dir']
159#If the install_dir is a relative path then assume it's from inside build_dir
160if not env['install_dir'].startswith('/') and install_path != "":
161 install_path = "%s/%s" % (build_path, install_path)
162
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100163env.Append(LIBPATH = [build_path])
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000164Export('env')
165Export('vars')
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100166
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000167def install_lib( lib ):
168 # If there is no install folder, then there is nothing to do:
169 if install_path == "":
170 return lib
171 return env.Install( "%s/lib/" % install_path, lib)
172def install_bin( bin ):
173 # If there is no install folder, then there is nothing to do:
174 if install_path == "":
175 return bin
176 return env.Install( "%s/bin/" % install_path, bin)
177def install_include( inc ):
178 if install_path == "":
179 return inc
180 return env.Install( "%s/include/" % install_path, inc)
181
182Export('install_lib')
183Export('install_bin')
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100184
185Help(vars.GenerateHelpText(env))
186
Viet-Hoa Do36dc77d2023-03-03 10:44:58 +0000187# Export compile_commands.json file
188if env.get("export_compile_commands", False):
189 env.Tool("compilation_db")
190 env.CompilationDatabase("%s/compile_commands.json" % build_path)
191
Michalis Spyrou14ce0942022-06-13 15:40:35 +0100192if 'armv7a' in env['arch'] and env['os'] == 'android':
SiCong Li13f96d02022-06-21 10:06:51 +0100193 print("WARNING: armv7a on Android is no longer maintained")
Michalis Spyrou14ce0942022-06-13 15:40:35 +0100194
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100195if env['linker_script'] and env['os'] != 'bare_metal':
196 print("Linker script is only supported for bare_metal builds")
197 Exit(1)
198
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000199if env['build'] == "embed_only":
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100200 SConscript('./SConscript', variant_dir=build_path, duplicate=0)
Anthony Barbier6a3daf12018-02-19 17:24:27 +0000201 Return()
202
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100203if env['neon'] and 'x86' in env['arch']:
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +0000204 print("Cannot compile Arm® Neon™ for x86")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100205 Exit(1)
206
207if env['set_soname'] and not version_at_least(SCons.__version__, "2.4"):
ggardet767c9f72018-06-29 17:01:01 +0200208 print("Setting the library's SONAME / SHLIBVERSION requires SCons 2.4 or above")
209 print("Update your version of SCons or use set_soname=0")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100210 Exit(1)
211
212if env['os'] == 'bare_metal':
213 if env['cppthreads'] or env['openmp']:
214 print("ERROR: OpenMP and C++11 threads not supported in bare_metal. Use cppthreads=0 openmp=0")
215 Exit(1)
216
Georgios Pinitasea857272021-01-22 05:47:37 +0000217if env['opencl'] and env['embed_kernels'] and env['compress_kernels'] and env['os'] not in ['android']:
218 print("Compressed kernels are supported only for android builds")
219 Exit(1)
220
Michalis Spyrou323ce0f2018-11-30 16:30:43 +0000221if not env['exceptions']:
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000222 if env['opencl']:
223 print("ERROR: OpenCL is not supported when building without exceptions. Use opencl=0")
Michalis Spyrou323ce0f2018-11-30 16:30:43 +0000224 Exit(1)
225
226 env.Append(CPPDEFINES = ['ARM_COMPUTE_EXCEPTIONS_DISABLED'])
227 env.Append(CXXFLAGS = ['-fno-exceptions'])
228
Pablo Tello29cab362022-03-10 17:05:34 +0000229env.Append(CXXFLAGS = ['-DARCH_ARM',
Pablo Tello4e66d702022-03-07 18:20:12 +0000230 '-Wextra','-Wdisabled-optimization','-Wformat=2',
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100231 '-Winit-self','-Wstrict-overflow=2','-Wswitch-default',
Pablo Tello4e66d702022-03-07 18:20:12 +0000232 '-Woverloaded-virtual', '-Wformat-security',
Michalis Spyroufae513c2019-10-16 17:41:33 +0100233 '-Wctor-dtor-privacy','-Wsign-promo','-Weffc++','-Wno-overlength-strings'])
Isabella Gottardib28f29d2017-11-09 17:05:07 +0000234
Pablo Tello4e66d702022-03-07 18:20:12 +0000235if not 'windows' in env['os']:
Pablo Tello29cab362022-03-10 17:05:34 +0000236 env.Append(CXXFLAGS = ['-Wall','-std=c++14', '-pedantic' ])
Pablo Tello4e66d702022-03-07 18:20:12 +0000237
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100238env.Append(CPPDEFINES = ['_GLIBCXX_USE_NANOSLEEP'])
239
Pablo Tello4e66d702022-03-07 18:20:12 +0000240cpp_tool = {'linux': 'g++', 'android' : 'clang++',
241 'tizen': 'g++', 'macos':'clang++',
242 'bare_metal':'g++', 'openbsd':'g++','windows':'clang-cl'}
243
244c_tool = {'linux':'gcc', 'android': 'clang', 'tizen':'gcc',
245 'macos':'clang','bare_metal':'gcc',
246 'openbsd':'gcc','windows':'clang-cl'}
247
248default_cpp_compiler = cpp_tool[env['os']]
249default_c_compiler = c_tool[env['os']]
Anthony Barbiera026e982018-01-18 10:57:52 +0000250cpp_compiler = os.environ.get('CXX', default_cpp_compiler)
251c_compiler = os.environ.get('CC', default_c_compiler)
252
Anthony Barbierdd669372018-03-01 17:08:54 +0000253if env['os'] == 'android' and ( 'clang++' not in cpp_compiler or 'clang' not in c_compiler ):
ggardet767c9f72018-06-29 17:01:01 +0200254 print( "WARNING: Only clang is officially supported to build the Compute Library for Android")
Anthony Barbiera026e982018-01-18 10:57:52 +0000255
Anthony Barbierdd669372018-03-01 17:08:54 +0000256if 'clang++' in cpp_compiler:
Michalis Spyrou7c60c992019-10-10 14:33:47 +0100257 env.Append(CXXFLAGS = ['-Wno-vla-extension'])
Georgios Pinitase874ef92019-09-09 17:40:33 +0100258elif 'armclang' in cpp_compiler:
259 pass
Pablo Tello4e66d702022-03-07 18:20:12 +0000260elif not 'windows' in env['os']:
Giorgio Arenab83e6722022-03-24 14:23:07 +0000261 env.Append(CXXFLAGS = ['-Wlogical-op','-Wnoexcept','-Wstrict-null-sentinel','-Wno-misleading-indentation'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100262
SiCongLi410e21e2020-12-11 15:07:53 +0000263if cpp_compiler == 'g++':
264 # Don't strip comments that could include markers
265 env.Append(CXXFLAGS = ['-C'])
266
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100267if env['cppthreads']:
268 env.Append(CPPDEFINES = [('ARM_COMPUTE_CPP_SCHEDULER', 1)])
269
270if env['openmp']:
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100271 env.Append(CPPDEFINES = [('ARM_COMPUTE_OPENMP_SCHEDULER', 1)])
272 env.Append(CXXFLAGS = ['-fopenmp'])
273 env.Append(LINKFLAGS = ['-fopenmp'])
274
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000275# Validate and define state
276if env['estate'] == 'auto':
277 if 'v7a' in env['arch']:
278 env['estate'] = '32'
279 else:
280 env['estate'] = '64'
281
282# Map legacy arch
283if 'arm64' in env['arch']:
284 env['estate'] = '64'
285
286if 'v7a' in env['estate'] and env['estate'] == '64':
287 print("ERROR: armv7a architecture has only 32-bit execution state")
288 Exit(1)
289
Motti Gondabi9d9ad332022-01-23 12:42:24 +0200290env.Append(CPPDEFINES = ['ENABLE_NEON', 'ARM_COMPUTE_ENABLE_NEON'])
291
Motti Gondabif76a5022021-12-21 13:19:29 +0200292if 'sve' in env['arch']:
293 env.Append(CPPDEFINES = ['ENABLE_SVE', 'ARM_COMPUTE_ENABLE_SVE'])
294 if 'sve2' in env['arch']:
295 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SVE2'])
Motti Gondabif76a5022021-12-21 13:19:29 +0200296
Viet-Hoa Do03b29712022-06-01 11:47:14 +0100297if 'sme' in env['arch']:
298 env.Append(CPPDEFINES = ['ENABLE_SME', 'ARM_COMPUTE_ENABLE_SME'])
299 if 'sme2' in env['arch']:
300 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SME2'])
301
Georgios Pinitase874ef92019-09-09 17:40:33 +0100302# Add architecture specific flags
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200303if env['multi_isa']:
304 # assert arch version is v8
305 if 'v8' not in env['arch']:
306 print("Currently Multi ISA binary is only supported for arm v8 family")
307 Exit(1)
Georgios Pinitas94672fb2020-01-22 18:36:27 +0000308
Sunita Nadampalli911d5722023-05-02 14:05:39 +0000309 if 'v8a' in env['arch']:
310 print("INFO: multi_isa armv8-a architecture build doesn't enable __ARM_FEATURE_FP16_VECTOR_ARITHMETIC. Use armv8.2-a or beyond to enable FP16 vector arithmetic support")
311 env.Append(CXXFLAGS = ['-march=armv8-a']) # note: this will disable fp16 extension __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
312 else:
313 if 'v8.6-a' in env['arch']:
314 if "disable_mmla_fp" not in env['custom_options']:
315 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SVEF32MM'])
Georgios Pinitas8e2f64f2021-07-28 13:18:46 +0100316
Sunita Nadampalli911d5722023-05-02 14:05:39 +0000317 env.Append(CXXFLAGS = ['-march=armv8.2-a+fp16']) # explicitly enable fp16 extension otherwise __ARM_FEATURE_FP16_VECTOR_ARITHMETIC is undefined
Giorgio Arena73fa0a72022-02-10 15:06:51 +0000318
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200319else: # NONE "multi_isa" builds
320
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200321 if 'v7a' in env['arch']:
322 env.Append(CXXFLAGS = ['-march=armv7-a', '-mthumb', '-mfpu=neon'])
323 if (env['os'] == 'android' or env['os'] == 'tizen') and not 'hf' in env['arch']:
324 env.Append(CXXFLAGS = ['-mfloat-abi=softfp'])
325 else:
326 env.Append(CXXFLAGS = ['-mfloat-abi=hard'])
Pablo Marquez Tellod208f4f2022-07-19 12:19:46 +0100327 elif 'v8.6-a' in env['arch']:
Viet-Hoa Do03b29712022-06-01 11:47:14 +0100328 if 'armv8.6-a-sve2' in env['arch']:
Pablo Marquez Tellod208f4f2022-07-19 12:19:46 +0100329 env.Append(CXXFLAGS = ['-march=armv8.6-a+sve2'])
330 elif 'armv8.6-a-sve' == env['arch']:
331 env.Append(CXXFLAGS = ['-march=armv8.6-a+sve'])
332 elif 'armv8.6-a' == env['arch']:
Pablo Marquez Tellocf07d112022-09-28 21:37:37 +0100333 env.Append(CXXFLAGS = ['-march=armv8.6-a+fp16'])
Pablo Marquez Tellod208f4f2022-07-19 12:19:46 +0100334
335 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_I8MM', 'ARM_COMPUTE_ENABLE_BF16','ARM_COMPUTE_ENABLE_FP16'])
336 if "disable_mmla_fp" not in env['custom_options']:
337 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_SVEF32MM'])
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200338 elif 'v8' in env['arch']:
339 # Preserve the V8 archs for non-multi-ISA variants
340 if 'sve2' in env['arch']:
341 env.Append(CXXFLAGS = ['-march=armv8.2-a+sve2+fp16+dotprod'])
342 elif 'sve' in env['arch']:
343 env.Append(CXXFLAGS = ['-march=armv8.2-a+sve+fp16+dotprod'])
344 elif 'armv8r64' in env['arch']:
345 env.Append(CXXFLAGS = ['-march=armv8.4-a'])
346 elif 'v8.' in env['arch']:
347 env.Append(CXXFLAGS = ['-march=armv8.2-a+fp16']) # explicitly enable fp16 extension otherwise __ARM_FEATURE_FP16_VECTOR_ARITHMETIC is undefined
348 else:
349 env.Append(CXXFLAGS = ['-march=armv8-a'])
350
Motti Gondabi6f3a9f52021-11-09 15:47:17 +0200351 if 'v8.' in env['arch']:
352 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_FP16'])
353
354 elif 'x86' in env['arch']:
355 if env['estate'] == '32':
356 env.Append(CCFLAGS = ['-m32'])
357 env.Append(LINKFLAGS = ['-m32'])
358 else:
359 env.Append(CXXFLAGS = ['-fPIC'])
360 env.Append(CCFLAGS = ['-m64'])
361 env.Append(LINKFLAGS = ['-m64'])
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000362
363# Define toolchain
SiCongLifecdb8f2022-01-04 18:33:17 +0000364# The reason why we distinguish toolchain_prefix from compiler_prefix is for cases where the linkers/archivers use a
365# different prefix than the compilers. An example is the NDK r20 toolchain
SiCong Life1b1f62022-05-19 18:58:31 +0100366auto_toolchain_prefix = ""
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000367if 'x86' not in env['arch']:
368 if env['estate'] == '32':
369 if env['os'] == 'linux':
SiCong Life1b1f62022-05-19 18:58:31 +0100370 auto_toolchain_prefix = "arm-linux-gnueabihf-" if 'v7' in env['arch'] else "armv8l-linux-gnueabihf-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000371 elif env['os'] == 'bare_metal':
SiCong Life1b1f62022-05-19 18:58:31 +0100372 auto_toolchain_prefix = "arm-eabi-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000373 elif env['os'] == 'android':
SiCong Life1b1f62022-05-19 18:58:31 +0100374 auto_toolchain_prefix = "arm-linux-androideabi-"
Inki Dae51a95582020-03-23 08:29:02 +0900375 elif env['os'] == 'tizen':
SiCong Life1b1f62022-05-19 18:58:31 +0100376 auto_toolchain_prefix = "armv7l-tizen-linux-gnueabi-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000377 elif env['estate'] == '64' and 'v8' in env['arch']:
378 if env['os'] == 'linux':
SiCong Life1b1f62022-05-19 18:58:31 +0100379 auto_toolchain_prefix = "aarch64-linux-gnu-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000380 elif env['os'] == 'bare_metal':
SiCong Life1b1f62022-05-19 18:58:31 +0100381 auto_toolchain_prefix = "aarch64-elf-"
Georgios Pinitasf2cdce32019-12-09 18:35:57 +0000382 elif env['os'] == 'android':
SiCong Life1b1f62022-05-19 18:58:31 +0100383 auto_toolchain_prefix = "aarch64-linux-android-"
Inki Dae51a95582020-03-23 08:29:02 +0900384 elif env['os'] == 'tizen':
SiCong Life1b1f62022-05-19 18:58:31 +0100385 auto_toolchain_prefix = "aarch64-tizen-linux-gnu-"
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100386
Pablo Marquez Telloddf2f6c2022-06-28 12:56:27 +0100387if env['build'] == 'native' or env["toolchain_prefix"] == "":
SiCong Life1b1f62022-05-19 18:58:31 +0100388 toolchain_prefix = ""
389elif env["toolchain_prefix"] == "auto":
390 toolchain_prefix = auto_toolchain_prefix
391else:
SiCongLifecdb8f2022-01-04 18:33:17 +0000392 toolchain_prefix = env["toolchain_prefix"]
Anthony Barbier149de5b2018-12-06 10:27:37 +0000393
Pablo Marquez Telloddf2f6c2022-06-28 12:56:27 +0100394if env['build'] == 'native' or env["compiler_prefix"] == "":
SiCong Life1b1f62022-05-19 18:58:31 +0100395 compiler_prefix = ""
396elif env["compiler_prefix"] == "auto":
397 compiler_prefix = toolchain_prefix
398else:
alered01d8872c12020-02-10 11:29:45 +0000399 compiler_prefix = env["compiler_prefix"]
400
401env['CC'] = env['compiler_cache']+ " " + compiler_prefix + c_compiler
402env['CXX'] = env['compiler_cache']+ " " + compiler_prefix + cpp_compiler
SiCongLifecdb8f2022-01-04 18:33:17 +0000403env['LD'] = toolchain_prefix + "ld"
404env['AS'] = toolchain_prefix + "as"
Pablo Tello29cab362022-03-10 17:05:34 +0000405
Pablo Tello4e66d702022-03-07 18:20:12 +0000406if env['os'] == 'windows':
Pablo Tello29cab362022-03-10 17:05:34 +0000407 env['AR'] = "llvm-lib"
408 env['RANLIB'] = "llvm-ranlib"
Pablo Tello4e66d702022-03-07 18:20:12 +0000409else:
SiCongLifecdb8f2022-01-04 18:33:17 +0000410 env['AR'] = toolchain_prefix + "ar"
Pablo Tello29cab362022-03-10 17:05:34 +0000411
SiCongLifecdb8f2022-01-04 18:33:17 +0000412env['RANLIB'] = toolchain_prefix + "ranlib"
Pablo Tello4e66d702022-03-07 18:20:12 +0000413
SiCong Life1b1f62022-05-19 18:58:31 +0100414print("Using compilers:")
415print("CC", env['CC'])
416print("CXX", env['CXX'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100417
418if not GetOption("help"):
419 try:
Pablo Tello4e66d702022-03-07 18:20:12 +0000420 if env['os'] == 'windows':
Giorgio Arenab83e6722022-03-24 14:23:07 +0000421 compiler_ver = check_output("clang++ -dumpversion").decode().strip()
Pablo Tello4e66d702022-03-07 18:20:12 +0000422 else:
Giorgio Arenab83e6722022-03-24 14:23:07 +0000423 compiler_ver = check_output(env['CXX'].split() + ["-dumpversion"]).decode().strip()
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100424 except OSError:
425 print("ERROR: Compiler '%s' not found" % env['CXX'])
426 Exit(1)
427
Georgios Pinitase874ef92019-09-09 17:40:33 +0100428 if 'armclang' in cpp_compiler:
429 pass
430 elif 'clang++' not in cpp_compiler:
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100431 if env['arch'] == 'arm64-v8.2-a' and not version_at_least(compiler_ver, '6.2.1'):
ggardet767c9f72018-06-29 17:01:01 +0200432 print("GCC 6.2.1 or newer is required to compile armv8.2-a code")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100433 Exit(1)
434 elif env['arch'] == 'arm64-v8a' and not version_at_least(compiler_ver, '4.9'):
Michele Di Giorgio33f41fa2021-03-09 14:09:08 +0000435 print("GCC 4.9 or newer is required to compile Arm® Neon™ code for AArch64")
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100436 Exit(1)
437
438 if version_at_least(compiler_ver, '6.1'):
439 env.Append(CXXFLAGS = ['-Wno-ignored-attributes'])
440
441 if compiler_ver == '4.8.3':
442 env.Append(CXXFLAGS = ['-Wno-array-bounds'])
443
Michalis Spyroucfac3052020-10-14 12:06:28 +0100444 if not version_at_least(compiler_ver, '7.0.0') and env['os'] == 'bare_metal':
445 env.Append(LINKFLAGS = ['-fstack-protector-strong'])
446
SiCong Libf5274d2022-07-20 17:45:36 +0100447 # Add Android NDK toolchain specific flags
448 if 'clang++' in cpp_compiler and env['os'] == 'android':
449 # For NDK >= r21, clang 9 or above is used
450 if version_at_least(compiler_ver, '9.0.0'):
451 env['ndk_above_r21'] = True
Giorgio Arenab83e6722022-03-24 14:23:07 +0000452
SiCong Libf5274d2022-07-20 17:45:36 +0100453 if env['openmp']:
454 env.Append(LINKFLAGS = ['-static-openmp'])
455
456 # For NDK >= r23, clang 12 or above is used. This condition detects NDK < r23
457 if not version_at_least(compiler_ver, '12.0.0'):
458 # System assembler is deprecated and integrated assembler is preferred since r23.
459 # However integrated assembler has always been suppressed for NDK < r23.
460 # Thus for backward compatibility, we include this flag only for NDK < r23
461 env.Append(CXXFLAGS = ['-no-integrated-as'])
Giorgio Arenab83e6722022-03-24 14:23:07 +0000462
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100463if env['high_priority'] and env['build_config']:
SiCongLidc85d782021-12-17 13:22:55 +0000464 print("The high priority library cannot be built in conjunction with a user-specified build configuration")
Georgios Pinitasb6af4822021-09-14 12:33:34 +0100465 Exit(1)
466
467if not env['high_priority'] and not env['build_config']:
468 env.Append(CPPDEFINES = ['ARM_COMPUTE_GRAPH_ENABLED'])
469
Freddie Liardet487d3902021-09-21 12:36:43 +0100470data_types = []
471data_layouts = []
Georgios Pinitasff4fca02020-10-02 21:00:00 +0100472
Freddie Liardet487d3902021-09-21 12:36:43 +0100473# Set correct data types / layouts to build
474if env['high_priority']:
475 data_types = ['all']
476 data_layouts = ['all']
477elif env['build_config']:
478 data_types, data_layouts = read_build_config_json(env['build_config'])
479else:
480 data_types = env['data_type_support']
481 data_layouts = env['data_layout_support']
482
483env = update_data_type_layout_flags(env, data_types, data_layouts)
Sheri Zhang79144a62021-02-08 17:43:04 +0000484
Pablo Telloc6cb35a2017-06-21 15:39:47 +0100485if env['standalone']:
Pablo Tello29cab362022-03-10 17:05:34 +0000486 if not 'windows' in env['os']:
Pablo Tello4e66d702022-03-07 18:20:12 +0000487 env.Append(CXXFLAGS = ['-fPIC'])
Pablo Tello29cab362022-03-10 17:05:34 +0000488 env.Append(LINKFLAGS = ['-static-libgcc','-static-libstdc++'])
489
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100490if env['Werror']:
491 env.Append(CXXFLAGS = ['-Werror'])
492
493if env['os'] == 'android':
494 env.Append(CPPDEFINES = ['ANDROID'])
Michalis Spyrou2d22c3f2020-02-12 14:50:19 +0000495 env.Append(LINKFLAGS = ['-pie', '-static-libstdc++', '-ldl'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100496elif env['os'] == 'bare_metal':
497 env.Append(LINKFLAGS = ['-static'])
498 env.Append(CXXFLAGS = ['-fPIC'])
Manuel Bottinie5a9ad82020-11-18 16:22:16 +0000499 if env['specs_file'] == "":
500 env.Append(LINKFLAGS = ['-specs=rdimon.specs'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100501 env.Append(CPPDEFINES = ['NO_MULTI_THREADING'])
Michalis Spyrou07781ac2017-08-31 15:11:41 +0100502 env.Append(CPPDEFINES = ['BARE_METAL'])
Manuel Bottini827817e2020-11-19 12:12:06 +0000503if env['os'] == 'linux' and env['arch'] == 'armv7a':
504 env.Append(CXXFLAGS = [ '-Wno-psabi' ])
Pablo Tello4e66d702022-03-07 18:20:12 +0000505if env['os'] == 'windows':
506 env.Append(CXXFLAGS = [ '/std:c++14','/EHa'])
507 env.Append(CXXFLAGS = [ '-Wno-c++98-compat', '-Wno-covered-switch-default','-Wno-c++98-compat-pedantic'])
508 env.Append(CXXFLAGS = [ '-Wno-shorten-64-to-32', '-Wno-sign-conversion','-Wno-documentation'])
509 env.Append(CXXFLAGS = [ '-Wno-extra-semi-stmt', '-Wno-float-equal','-Wno-implicit-int-conversion'])
510 env.Append(CXXFLAGS = [ '-Wno-documentation-pedantic', '-Wno-extra-semi','-Wno-shadow-field-in-constructor'])
511 env.Append(CXXFLAGS = [ '-Wno-float-conversion', '-Wno-switch-enum','-Wno-comma'])
512 env.Append(CXXFLAGS = [ '-Wno-implicit-float-conversion', '-Wno-deprecated-declarations','-Wno-old-style-cast'])
513 env.Append(CXXFLAGS = [ '-Wno-zero-as-null-pointer-constant', '-Wno-inconsistent-missing-destructor-override'])
Pablo Tellofbbfa532023-01-26 16:24:04 +0000514 env.Append(CXXFLAGS = [ '-Wno-asm-operand-widths'])
515
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100516
Manuel Bottinie5a9ad82020-11-18 16:22:16 +0000517if env['specs_file'] != "":
518 env.Append(LINKFLAGS = ['-specs='+env['specs_file']])
519
Georgios Pinitas8a5146f2021-01-12 15:51:07 +0000520if env['neon']:
521 env.Append(CPPDEFINES = ['ARM_COMPUTE_CPU_ENABLED'])
522
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100523if env['opencl']:
Georgios Pinitas8a5146f2021-01-12 15:51:07 +0000524 env.Append(CPPDEFINES = ['ARM_COMPUTE_OPENCL_ENABLED'])
Georgios Pinitase6032da2017-10-26 14:13:35 +0100525 if env['os'] in ['bare_metal'] or env['standalone']:
Anthony Barbier5f0124d2018-04-13 14:05:34 +0100526 print("Cannot link OpenCL statically, which is required for bare metal / standalone builds")
527 Exit(1)
528
Pablo Tello29cab362022-03-10 17:05:34 +0000529if env["os"] not in ["windows","android", "bare_metal"] and (env['opencl'] or env['cppthreads']):
Anthony Barbier9fb0cac2018-04-20 15:46:21 +0100530 env.Append(LIBS = ['pthread'])
531
Kevin Lo7195f712022-01-07 15:46:02 +0800532if env['os'] == 'openbsd':
533 env.Append(LIBS = ['c'])
534 env.Append(CXXFLAGS = ['-fPIC'])
535
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000536if env['opencl']:
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100537 if env['embed_kernels']:
538 env.Append(CPPDEFINES = ['EMBEDDED_KERNELS'])
Georgios Pinitasea857272021-01-22 05:47:37 +0000539 if env['compress_kernels']:
540 env.Append(CPPDEFINES = ['ARM_COMPUTE_COMPRESSED_KERNELS'])
541 env.Append(LIBS = ['z'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100542
543if env['debug']:
544 env['asserts'] = True
Pablo Tello29cab362022-03-10 17:05:34 +0000545 if not 'windows' in env['os']:
546 env.Append(CXXFLAGS = ['-O0','-g','-gdwarf-2'])
547 else:
548 env.Append(CXXFLAGS = ['-Z7','-MTd','-fms-compatibility','-fdelayed-template-parsing'])
549 env.Append(LINKFLAGS = ['-DEBUG'])
550
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100551 env.Append(CPPDEFINES = ['ARM_COMPUTE_DEBUG_ENABLED'])
552else:
Pablo Tello4e66d702022-03-07 18:20:12 +0000553 if not 'windows' in env['os']:
554 env.Append(CXXFLAGS = ['-O3'])
555 else:
556 # on windows we use clang-cl which does not support the option -O3
557 env.Append(CXXFLAGS = ['-O2'])
Pablo Tello29cab362022-03-10 17:05:34 +0000558
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100559if env['asserts']:
560 env.Append(CPPDEFINES = ['ARM_COMPUTE_ASSERTS_ENABLED'])
Pablo Tello29cab362022-03-10 17:05:34 +0000561 if not 'windows' in env['os']:
562 env.Append(CXXFLAGS = ['-fstack-protector-strong'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100563
Georgios Pinitas7d3d1b92017-10-12 17:34:20 +0100564if env['logging']:
565 env.Append(CPPDEFINES = ['ARM_COMPUTE_LOGGING_ENABLED'])
566
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100567env.Append(CPPPATH = ['#/include', "#"])
568env.Append(CXXFLAGS = env['extra_cxx_flags'])
Georgios Pinitas421405b2018-10-26 19:05:32 +0100569env.Append(LINKFLAGS = env['extra_link_flags'])
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100570
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000571Default( install_include("arm_compute"))
Anthony Barbier10565952018-11-15 09:50:06 +0000572Default( install_include("support"))
Michele Di Giorgio6afea902019-04-03 11:40:20 +0100573Default( install_include("utils"))
574for dirname in os.listdir("./include"):
575 Default( install_include("include/%s" % dirname))
Anthony Barbier01bbd5f2018-11-01 15:10:51 +0000576
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100577Export('version_at_least')
578
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100579SConscript('./SConscript', variant_dir=build_path, duplicate=0)
Anthony Barbier6c0348f2017-11-10 18:32:38 +0000580
Freddie Liardet487d3902021-09-21 12:36:43 +0100581if env['examples'] and (env['build_config'] or env['high_priority']):
582 print("WARNING: Building examples for selected operators not supported. Use examples=0")
583 Return()
584
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100585if env['examples'] and env['exceptions']:
586 if env['os'] == 'bare_metal' and env['arch'] == 'armv7a':
Michalis Spyrou35f35a62019-12-23 11:29:52 +0000587 print("WARNING: Building examples for bare metal and armv7a is not supported. Use examples=0")
588 Return()
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100589 SConscript('./examples/SConscript', variant_dir='%s/examples' % build_path, duplicate=0)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100590
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100591if env['exceptions']:
Freddie Liardet487d3902021-09-21 12:36:43 +0100592 if env['build_config'] or env['high_priority']:
593 print("WARNING: Building tests for selected operators not supported")
594 Return()
Michalis Spyrou748a7c82019-10-07 13:00:44 +0100595 if env['os'] == 'bare_metal' and env['arch'] == 'armv7a':
596 print("WARNING: Building tests for bare metal and armv7a is not supported")
597 Return()
Anthony Barbiere8a55df2018-10-26 09:05:01 +0100598 SConscript('./tests/SConscript', variant_dir='%s/tests' % build_path, duplicate=0)
Motti Gondabif76a5022021-12-21 13:19:29 +0200599
600# Unknown variables are not allowed
601# Note: we must delay the call of UnknownVariables until after
602# we have applied the Variables object to the construction environment
603unknown = vars.UnknownVariables()
604if unknown:
605 print("Unknown variables: %s" % " ".join(unknown.keys()))
Ramy Elgammal451c3092022-02-01 23:01:27 +0000606 Exit(1)