Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | # Copyright (c) 2016, 2017 ARM Limited. |
| 2 | # |
| 3 | # SPDX-License-Identifier: MIT |
| 4 | # |
| 5 | # Permission is hereby granted, free of charge, to any person obtaining a copy |
| 6 | # of this software and associated documentation files (the "Software"), to |
| 7 | # deal in the Software without restriction, including without limitation the |
| 8 | # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 9 | # sell copies of the Software, and to permit persons to whom the Software is |
| 10 | # furnished to do so, subject to the following conditions: |
| 11 | # |
| 12 | # The above copyright notice and this permission notice shall be included in all |
| 13 | # copies or substantial portions of the Software. |
| 14 | # |
| 15 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 16 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 17 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 18 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 19 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 20 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 21 | # SOFTWARE. |
| 22 | |
| 23 | import SCons |
| 24 | import os |
| 25 | import subprocess |
| 26 | |
| 27 | def version_at_least(version, required): |
| 28 | end = min(len(version), len(required)) |
| 29 | |
| 30 | for i in range(0, end, 2): |
| 31 | if int(version[i]) < int(required[i]): |
| 32 | return False |
| 33 | elif int(version[i]) > int(required[i]): |
| 34 | return True |
| 35 | |
| 36 | return True |
| 37 | |
| 38 | vars = Variables("scons") |
| 39 | vars.AddVariables( |
| 40 | BoolVariable("debug", "Debug", False), |
| 41 | BoolVariable("asserts", "Enable asserts (this flag is forced to 1 for debug=1)", False), |
Georgios Pinitas | 3faea25 | 2017-10-30 14:13:50 +0000 | [diff] [blame] | 42 | BoolVariable("logging", "Logging (this flag is forced to 1 for debug=1)", False), |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 43 | EnumVariable("arch", "Target Architecture", "armv7a", allowed_values=("armv7a", "arm64-v8a", "arm64-v8.2-a", "x86_32", "x86_64")), |
| 44 | EnumVariable("os", "Target OS", "linux", allowed_values=("linux", "android", "bare_metal")), |
| 45 | EnumVariable("build", "Build type", "cross_compile", allowed_values=("native", "cross_compile")), |
| 46 | BoolVariable("examples", "Build example programs", True), |
| 47 | BoolVariable("Werror", "Enable/disable the -Werror compilation flag", True), |
Pablo Tello | c6cb35a | 2017-06-21 15:39:47 +0100 | [diff] [blame] | 48 | BoolVariable("standalone", "Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute", False), |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 49 | BoolVariable("opencl", "Enable OpenCL support", True), |
| 50 | BoolVariable("neon", "Enable Neon support", False), |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 51 | BoolVariable("gles_compute", "Enable OpenGL ES Compute Shader support", False), |
Anthony Barbier | cc0a80b | 2017-12-15 11:37:29 +0000 | [diff] [blame] | 52 | BoolVariable("embed_kernels", "Embed OpenCL kernels and OpenGL ES compute shaders in library binary", True), |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 53 | BoolVariable("set_soname", "Set the library's soname and shlibversion (requires SCons 2.4 or above)", False), |
| 54 | BoolVariable("openmp", "Enable OpenMP backend", False), |
| 55 | BoolVariable("cppthreads", "Enable C++11 threads backend", True), |
| 56 | PathVariable("build_dir", "Specify sub-folder for the build", ".", PathVariable.PathAccept), |
Anthony Barbier | a4e5e1e | 2017-10-05 14:55:34 +0100 | [diff] [blame] | 57 | #FIXME Remove before release (And remove all references to INTERNAL_ONLY) |
| 58 | BoolVariable("internal_only", "Enable ARM internal only tests", True), |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 59 | ("extra_cxx_flags", "Extra CXX flags to be appended to the build command", "") |
| 60 | ) |
| 61 | |
| 62 | env = Environment(platform="posix", variables=vars, ENV = os.environ) |
Anthony Barbier | b2881fc | 2017-09-29 17:12:12 +0100 | [diff] [blame] | 63 | env.Append(LIBPATH = ["#build/%s" % env['build_dir']]) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 64 | |
| 65 | SConsignFile('build/.%s' % env['build_dir']) |
| 66 | |
| 67 | Help(vars.GenerateHelpText(env)) |
| 68 | |
| 69 | if env['neon'] and 'x86' in env['arch']: |
| 70 | print "Cannot compile NEON for x86" |
| 71 | Exit(1) |
| 72 | |
| 73 | if env['set_soname'] and not version_at_least(SCons.__version__, "2.4"): |
| 74 | print "Setting the library's SONAME / SHLIBVERSION requires SCons 2.4 or above" |
| 75 | print "Update your version of SCons or use set_soname=0" |
| 76 | Exit(1) |
| 77 | |
| 78 | if env['os'] == 'bare_metal': |
| 79 | if env['cppthreads'] or env['openmp']: |
| 80 | print("ERROR: OpenMP and C++11 threads not supported in bare_metal. Use cppthreads=0 openmp=0") |
| 81 | Exit(1) |
| 82 | |
| 83 | env.Append(CXXFLAGS = ['-Wno-deprecated-declarations','-Wall','-DARCH_ARM', |
| 84 | '-Wextra','-Wno-unused-parameter','-pedantic','-Wdisabled-optimization','-Wformat=2', |
| 85 | '-Winit-self','-Wstrict-overflow=2','-Wswitch-default', |
| 86 | '-fpermissive','-std=gnu++11','-Wno-vla','-Woverloaded-virtual', |
| 87 | '-Wctor-dtor-privacy','-Wsign-promo','-Weffc++','-Wno-format-nonliteral','-Wno-overlength-strings','-Wno-strict-overflow']) |
Isabella Gottardi | b28f29d | 2017-11-09 17:05:07 +0000 | [diff] [blame] | 88 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 89 | env.Append(CPPDEFINES = ['_GLIBCXX_USE_NANOSLEEP']) |
| 90 | |
Anthony Barbier | a026e98 | 2018-01-18 10:57:52 +0000 | [diff] [blame] | 91 | default_cpp_compiler = 'g++' if env['os'] != 'android' else 'clang++' |
| 92 | default_c_compiler = 'gcc' if env['os'] != 'android' else 'clang' |
| 93 | cpp_compiler = os.environ.get('CXX', default_cpp_compiler) |
| 94 | c_compiler = os.environ.get('CC', default_c_compiler) |
| 95 | |
| 96 | if env['os'] == 'android' and ( cpp_compiler != 'clang++' or c_compiler != 'clang'): |
| 97 | print "WARNING: Only clang is officially supported to build the Compute Library for Android" |
| 98 | |
| 99 | if cpp_compiler == 'clang++': |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 100 | env.Append(CXXFLAGS = ['-Wno-format-nonliteral','-Wno-deprecated-increment-bool','-Wno-vla-extension','-Wno-mismatched-tags']) |
| 101 | else: |
| 102 | env.Append(CXXFLAGS = ['-Wlogical-op','-Wnoexcept','-Wstrict-null-sentinel']) |
| 103 | |
| 104 | if env['cppthreads']: |
| 105 | env.Append(CPPDEFINES = [('ARM_COMPUTE_CPP_SCHEDULER', 1)]) |
| 106 | |
| 107 | if env['openmp']: |
Anthony Barbier | a026e98 | 2018-01-18 10:57:52 +0000 | [diff] [blame] | 108 | if cpp_compiler == 'clang++': |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 109 | print "Clang does not support OpenMP. Use scheduler=cpp." |
| 110 | Exit(1) |
| 111 | |
| 112 | env.Append(CPPDEFINES = [('ARM_COMPUTE_OPENMP_SCHEDULER', 1)]) |
| 113 | env.Append(CXXFLAGS = ['-fopenmp']) |
| 114 | env.Append(LINKFLAGS = ['-fopenmp']) |
| 115 | |
| 116 | prefix = "" |
| 117 | if env['arch'] == 'armv7a': |
| 118 | env.Append(CXXFLAGS = ['-march=armv7-a', '-mthumb', '-mfpu=neon']) |
| 119 | |
Michalis Spyrou | 07781ac | 2017-08-31 15:11:41 +0100 | [diff] [blame] | 120 | if env['os'] == 'linux': |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 121 | prefix = "arm-linux-gnueabihf-" |
| 122 | env.Append(CXXFLAGS = ['-mfloat-abi=hard']) |
Michalis Spyrou | 07781ac | 2017-08-31 15:11:41 +0100 | [diff] [blame] | 123 | elif env['os'] == 'bare_metal': |
Michalis Spyrou | 6e52ba3 | 2017-10-04 15:40:38 +0100 | [diff] [blame] | 124 | prefix = "arm-eabi-" |
Michalis Spyrou | 07781ac | 2017-08-31 15:11:41 +0100 | [diff] [blame] | 125 | env.Append(CXXFLAGS = ['-mfloat-abi=hard']) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 126 | elif env['os'] == 'android': |
| 127 | prefix = "arm-linux-androideabi-" |
| 128 | env.Append(CXXFLAGS = ['-mfloat-abi=softfp']) |
| 129 | elif env['arch'] == 'arm64-v8a': |
| 130 | env.Append(CXXFLAGS = ['-march=armv8-a']) |
Pablo Tello | 181e651 | 2017-11-15 13:28:27 +0000 | [diff] [blame] | 131 | env.Append(CPPDEFINES = ['ARM_COMPUTE_AARCH64_V8A']) |
Michalis Spyrou | 07781ac | 2017-08-31 15:11:41 +0100 | [diff] [blame] | 132 | if env['os'] == 'linux': |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 133 | prefix = "aarch64-linux-gnu-" |
Michalis Spyrou | 07781ac | 2017-08-31 15:11:41 +0100 | [diff] [blame] | 134 | elif env['os'] == 'bare_metal': |
Michalis Spyrou | 6e52ba3 | 2017-10-04 15:40:38 +0100 | [diff] [blame] | 135 | prefix = "aarch64-elf-" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 136 | elif env['os'] == 'android': |
| 137 | prefix = "aarch64-linux-android-" |
| 138 | elif env['arch'] == 'arm64-v8.2-a': |
Pablo Tello | fa7dc84 | 2018-01-25 10:48:46 +0000 | [diff] [blame] | 139 | env.Append(CXXFLAGS = ['-march=armv8.2-a+fp16']) # explicitly enable fp16 extension otherwise __ARM_FEATURE_FP16_VECTOR_ARITHMETIC is undefined |
Ioan-Cristian Szabo | 33fd07b | 2017-10-26 15:42:24 +0100 | [diff] [blame] | 140 | env.Append(CPPDEFINES = ['ARM_COMPUTE_AARCH64_V8_2']) |
Anthony Barbier | a026e98 | 2018-01-18 10:57:52 +0000 | [diff] [blame] | 141 | if cpp_compiler == 'clang++': |
Ioan-Cristian Szabo | 5edbd1c | 2017-11-13 13:34:08 +0000 | [diff] [blame] | 142 | env.Append(CXXFLAGS = ['-fno-integrated-as']) |
| 143 | |
Pablo Tello | 9e40cf7 | 2017-09-15 16:14:55 +0100 | [diff] [blame] | 144 | if env['os'] == 'linux': |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 145 | prefix = "aarch64-linux-gnu-" |
Pablo Tello | 9e40cf7 | 2017-09-15 16:14:55 +0100 | [diff] [blame] | 146 | elif env['os'] == 'bare_metal': |
| 147 | prefix = "aarch64-elf-" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 148 | elif env['os'] == 'android': |
| 149 | prefix = "aarch64-linux-android-" |
| 150 | elif env['arch'] == 'x86_32': |
| 151 | env.Append(CCFLAGS = ['-m32']) |
| 152 | env.Append(LINKFLAGS = ['-m32']) |
| 153 | elif env['arch'] == 'x86_64': |
| 154 | env.Append(CCFLAGS = ['-m64']) |
| 155 | env.Append(LINKFLAGS = ['-m64']) |
| 156 | |
| 157 | if env['build'] == 'native': |
| 158 | prefix = "" |
| 159 | |
Anthony Barbier | a026e98 | 2018-01-18 10:57:52 +0000 | [diff] [blame] | 160 | env['CC'] = prefix + c_compiler |
| 161 | env['CXX'] = prefix + cpp_compiler |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 162 | env['LD'] = prefix + "ld" |
| 163 | env['AS'] = prefix + "as" |
| 164 | env['AR'] = prefix + "ar" |
| 165 | env['RANLIB'] = prefix + "ranlib" |
| 166 | |
| 167 | if not GetOption("help"): |
| 168 | try: |
Anthony Barbier | 907dba8 | 2017-08-25 10:11:39 +0100 | [diff] [blame] | 169 | compiler_ver = subprocess.check_output(env['CXX'].split() + ["-dumpversion"]).strip() |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 170 | except OSError: |
| 171 | print("ERROR: Compiler '%s' not found" % env['CXX']) |
| 172 | Exit(1) |
| 173 | |
Anthony Barbier | a026e98 | 2018-01-18 10:57:52 +0000 | [diff] [blame] | 174 | if cpp_compiler == 'g++': |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 175 | if env['arch'] == 'arm64-v8.2-a' and not version_at_least(compiler_ver, '6.2.1'): |
| 176 | print "GCC 6.2.1 or newer is required to compile armv8.2-a code" |
| 177 | Exit(1) |
| 178 | elif env['arch'] == 'arm64-v8a' and not version_at_least(compiler_ver, '4.9'): |
| 179 | print "GCC 4.9 or newer is required to compile NEON code for AArch64" |
| 180 | Exit(1) |
| 181 | |
| 182 | if version_at_least(compiler_ver, '6.1'): |
| 183 | env.Append(CXXFLAGS = ['-Wno-ignored-attributes']) |
| 184 | |
| 185 | if compiler_ver == '4.8.3': |
| 186 | env.Append(CXXFLAGS = ['-Wno-array-bounds']) |
| 187 | |
Pablo Tello | c6cb35a | 2017-06-21 15:39:47 +0100 | [diff] [blame] | 188 | if env['standalone']: |
| 189 | env.Append(CXXFLAGS = ['-fPIC']) |
| 190 | env.Append(LINKFLAGS = ['-static-libgcc','-static-libstdc++']) |
Pablo Tello | 8951933 | 2017-11-17 11:52:36 +0000 | [diff] [blame] | 191 | if env['cppthreads']: |
| 192 | env.Append(LINKFLAGS = ['-lpthread']) |
Pablo Tello | c6cb35a | 2017-06-21 15:39:47 +0100 | [diff] [blame] | 193 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 194 | if env['Werror']: |
| 195 | env.Append(CXXFLAGS = ['-Werror']) |
| 196 | |
| 197 | if env['os'] == 'android': |
| 198 | env.Append(CPPDEFINES = ['ANDROID']) |
Georgios Pinitas | 9873ea3 | 2017-12-05 15:28:55 +0000 | [diff] [blame] | 199 | env.Append(LINKFLAGS = ['-pie', '-static-libstdc++']) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 200 | elif env['os'] == 'bare_metal': |
| 201 | env.Append(LINKFLAGS = ['-static']) |
Michalis Spyrou | 07781ac | 2017-08-31 15:11:41 +0100 | [diff] [blame] | 202 | env.Append(LINKFLAGS = ['-specs=rdimon.specs']) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 203 | env.Append(CXXFLAGS = ['-fPIC']) |
| 204 | env.Append(CPPDEFINES = ['NO_MULTI_THREADING']) |
Michalis Spyrou | 07781ac | 2017-08-31 15:11:41 +0100 | [diff] [blame] | 205 | env.Append(CPPDEFINES = ['BARE_METAL']) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 206 | |
| 207 | if env['opencl']: |
Georgios Pinitas | e6032da | 2017-10-26 14:13:35 +0100 | [diff] [blame] | 208 | if env['os'] in ['bare_metal'] or env['standalone']: |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 209 | print("Cannot link OpenCL statically, which is required on bare metal") |
| 210 | Exit(1) |
| 211 | |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 212 | if env['opencl'] or env['gles_compute']: |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 213 | if env['embed_kernels']: |
| 214 | env.Append(CPPDEFINES = ['EMBEDDED_KERNELS']) |
| 215 | |
| 216 | if env['debug']: |
| 217 | env['asserts'] = True |
Georgios Pinitas | 3faea25 | 2017-10-30 14:13:50 +0000 | [diff] [blame] | 218 | env['logging'] = True |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 219 | env.Append(CXXFLAGS = ['-O0','-g','-gdwarf-2']) |
| 220 | env.Append(CPPDEFINES = ['ARM_COMPUTE_DEBUG_ENABLED']) |
| 221 | else: |
| 222 | env.Append(CXXFLAGS = ['-O3','-ftree-vectorize']) |
| 223 | |
| 224 | if env['asserts']: |
| 225 | env.Append(CPPDEFINES = ['ARM_COMPUTE_ASSERTS_ENABLED']) |
Moritz Pflanzer | 8b74c78 | 2017-09-14 14:33:20 +0100 | [diff] [blame] | 226 | env.Append(CXXFLAGS = ['-fstack-protector-strong']) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 227 | |
Georgios Pinitas | 7d3d1b9 | 2017-10-12 17:34:20 +0100 | [diff] [blame] | 228 | if env['logging']: |
| 229 | env.Append(CPPDEFINES = ['ARM_COMPUTE_LOGGING_ENABLED']) |
| 230 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 231 | env.Append(CPPPATH = ['#/include', "#"]) |
| 232 | env.Append(CXXFLAGS = env['extra_cxx_flags']) |
| 233 | |
| 234 | Export('vars') |
| 235 | Export('env') |
| 236 | Export('version_at_least') |
| 237 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 238 | if env['opencl']: |
| 239 | SConscript("./opencl-1.2-stubs/SConscript", variant_dir="build/%s/opencl-1.2-stubs" % env['build_dir'], duplicate=0) |
| 240 | |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 241 | if env['gles_compute'] and env['os'] != 'android': |
Anthony Barbier | 14c86a9 | 2017-12-14 16:27:41 +0000 | [diff] [blame] | 242 | env.Append(CPPPATH = ['#/include/linux']) |
| 243 | env.Append(LIBPATH = ["#build/%s/opengles-3.1-stubs" % env['build_dir']]) |
| 244 | SConscript("./opengles-3.1-stubs/SConscript", variant_dir="build/%s/opengles-3.1-stubs" % env['build_dir'], duplicate=0) |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 245 | |
Anthony Barbier | 6c0348f | 2017-11-10 18:32:38 +0000 | [diff] [blame] | 246 | SConscript('./SConscript', variant_dir='#build/%s' % env['build_dir'], duplicate=0) |
| 247 | |
Michalis Spyrou | 6e52ba3 | 2017-10-04 15:40:38 +0100 | [diff] [blame] | 248 | if env['examples'] and env['os'] != 'bare_metal': |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 249 | SConscript('./examples/SConscript', variant_dir='#build/%s/examples' % env['build_dir'], duplicate=0) |
| 250 | |
Pablo Tello | 9e40cf7 | 2017-09-15 16:14:55 +0100 | [diff] [blame] | 251 | if env['os'] != 'bare_metal': |
| 252 | SConscript('./tests/SConscript', variant_dir='#build/%s/tests' % env['build_dir'], duplicate=0) |