1 # Copyright (c) 2016, 2017 ARM Limited.
3 # SPDX-License-Identifier: MIT
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:
12 # The above copyright notice and this permission notice shall be included in all
13 # copies or substantial portions of the Software.
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
27 def version_at_least(version, required):
28 end = min(len(version), len(required))
30 for i in range(0, end, 2):
31 if int(version[i]) < int(required[i]):
33 elif int(version[i]) > int(required[i]):
38 vars = Variables("scons")
40 BoolVariable("debug", "Debug", False),
41 BoolVariable("asserts", "Enable asserts (this flag is forced to 1 for debug=1)", False),
42 EnumVariable("arch", "Target Architecture", "armv7a", allowed_values=("armv7a", "arm64-v8a", "arm64-v8.2-a", "x86_32", "x86_64")),
43 EnumVariable("os", "Target OS", "linux", allowed_values=("linux", "android", "bare_metal")),
44 EnumVariable("build", "Build type", "cross_compile", allowed_values=("native", "cross_compile")),
45 BoolVariable("examples", "Build example programs", True),
46 BoolVariable("Werror", "Enable/disable the -Werror compilation flag", True),
47 BoolVariable("standalone", "Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute", False),
48 BoolVariable("opencl", "Enable OpenCL support", True),
49 BoolVariable("neon", "Enable Neon support", False),
50 BoolVariable("embed_kernels", "Embed OpenCL kernels in library binary", False),
51 BoolVariable("set_soname", "Set the library's soname and shlibversion (requires SCons 2.4 or above)", False),
52 BoolVariable("openmp", "Enable OpenMP backend", False),
53 BoolVariable("cppthreads", "Enable C++11 threads backend", True),
54 PathVariable("build_dir", "Specify sub-folder for the build", ".", PathVariable.PathAccept),
55 ("extra_cxx_flags", "Extra CXX flags to be appended to the build command", "")
58 env = Environment(platform="posix", variables=vars, ENV = os.environ)
59 env.Append(LIBPATH = ["#build/%s" % env['build_dir']])
61 SConsignFile('build/.%s' % env['build_dir'])
63 Help(vars.GenerateHelpText(env))
65 if env['neon'] and 'x86' in env['arch']:
66 print "Cannot compile NEON for x86"
69 if env['set_soname'] and not version_at_least(SCons.__version__, "2.4"):
70 print "Setting the library's SONAME / SHLIBVERSION requires SCons 2.4 or above"
71 print "Update your version of SCons or use set_soname=0"
74 if env['os'] == 'bare_metal':
75 if env['cppthreads'] or env['openmp']:
76 print("ERROR: OpenMP and C++11 threads not supported in bare_metal. Use cppthreads=0 openmp=0")
79 env.Append(CXXFLAGS = ['-Wno-deprecated-declarations','-Wall','-DARCH_ARM',
80 '-Wextra','-Wno-unused-parameter','-pedantic','-Wdisabled-optimization','-Wformat=2',
81 '-Winit-self','-Wstrict-overflow=2','-Wswitch-default',
82 '-fpermissive','-std=gnu++11','-Wno-vla','-Woverloaded-virtual',
83 '-Wctor-dtor-privacy','-Wsign-promo','-Weffc++','-Wno-format-nonliteral','-Wno-overlength-strings','-Wno-strict-overflow'])
84 env.Append(CPPDEFINES = ['_GLIBCXX_USE_NANOSLEEP'])
86 if os.environ.get('CXX', 'g++') == 'clang++':
87 env.Append(CXXFLAGS = ['-Wno-format-nonliteral','-Wno-deprecated-increment-bool','-Wno-vla-extension','-Wno-mismatched-tags'])
89 env.Append(CXXFLAGS = ['-Wlogical-op','-Wnoexcept','-Wstrict-null-sentinel'])
92 env.Append(CPPDEFINES = [('ARM_COMPUTE_CPP_SCHEDULER', 1)])
95 if os.environ.get('CXX', 'g++') == 'clang++':
96 print "Clang does not support OpenMP. Use scheduler=cpp."
99 env.Append(CPPDEFINES = [('ARM_COMPUTE_OPENMP_SCHEDULER', 1)])
100 env.Append(CXXFLAGS = ['-fopenmp'])
101 env.Append(LINKFLAGS = ['-fopenmp'])
104 if env['arch'] == 'armv7a':
105 env.Append(CXXFLAGS = ['-march=armv7-a', '-mthumb', '-mfpu=neon'])
107 if env['os'] == 'linux':
108 prefix = "arm-linux-gnueabihf-"
109 env.Append(CXXFLAGS = ['-mfloat-abi=hard'])
110 elif env['os'] == 'bare_metal':
112 env.Append(CXXFLAGS = ['-mfloat-abi=hard'])
113 elif env['os'] == 'android':
114 prefix = "arm-linux-androideabi-"
115 env.Append(CXXFLAGS = ['-mfloat-abi=softfp'])
116 elif env['arch'] == 'arm64-v8a':
117 env.Append(CXXFLAGS = ['-march=armv8-a'])
119 if env['os'] == 'linux':
120 prefix = "aarch64-linux-gnu-"
121 elif env['os'] == 'bare_metal':
122 prefix = "aarch64-elf-"
123 elif env['os'] == 'android':
124 prefix = "aarch64-linux-android-"
125 elif env['arch'] == 'arm64-v8.2-a':
126 env.Append(CXXFLAGS = ['-march=armv8.2-a+fp16+simd'])
127 env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_FP16'])
128 if env['os'] == 'linux':
129 prefix = "aarch64-linux-gnu-"
130 elif env['os'] == 'bare_metal':
131 prefix = "aarch64-elf-"
132 elif env['os'] == 'android':
133 prefix = "aarch64-linux-android-"
134 elif env['arch'] == 'x86_32':
135 env.Append(CCFLAGS = ['-m32'])
136 env.Append(LINKFLAGS = ['-m32'])
137 elif env['arch'] == 'x86_64':
138 env.Append(CCFLAGS = ['-m64'])
139 env.Append(LINKFLAGS = ['-m64'])
141 if env['build'] == 'native':
144 env['CC'] = prefix + os.environ.get('CC', 'gcc')
145 env['CXX'] = prefix + os.environ.get('CXX', 'g++')
146 env['LD'] = prefix + "ld"
147 env['AS'] = prefix + "as"
148 env['AR'] = prefix + "ar"
149 env['RANLIB'] = prefix + "ranlib"
151 if not GetOption("help"):
153 compiler_ver = subprocess.check_output(env['CXX'].split() + ["-dumpversion"]).strip()
155 print("ERROR: Compiler '%s' not found" % env['CXX'])
158 if os.environ.get('CXX','g++') == 'g++':
159 if env['arch'] == 'arm64-v8.2-a' and not version_at_least(compiler_ver, '6.2.1'):
160 print "GCC 6.2.1 or newer is required to compile armv8.2-a code"
162 elif env['arch'] == 'arm64-v8a' and not version_at_least(compiler_ver, '4.9'):
163 print "GCC 4.9 or newer is required to compile NEON code for AArch64"
166 if version_at_least(compiler_ver, '6.1'):
167 env.Append(CXXFLAGS = ['-Wno-ignored-attributes'])
169 if compiler_ver == '4.8.3':
170 env.Append(CXXFLAGS = ['-Wno-array-bounds'])
172 if env['standalone']:
173 env.Append(CXXFLAGS = ['-fPIC'])
174 env.Append(LINKFLAGS = ['-static-libgcc','-static-libstdc++'])
177 env.Append(CXXFLAGS = ['-Werror'])
179 if env['os'] == 'android':
180 env.Append(CPPDEFINES = ['ANDROID'])
181 env.Append(LINKFLAGS = ['-pie', '-static-libstdc++'])
182 elif env['os'] == 'bare_metal':
183 env.Append(LINKFLAGS = ['-static'])
184 env.Append(LINKFLAGS = ['-specs=rdimon.specs'])
185 env.Append(CXXFLAGS = ['-fPIC'])
186 env.Append(CPPDEFINES = ['NO_MULTI_THREADING'])
187 env.Append(CPPDEFINES = ['BARE_METAL'])
190 if env['os'] == 'bare_metal':
191 print("Cannot link OpenCL statically, which is required on bare metal")
194 if env['embed_kernels']:
195 env.Append(CPPDEFINES = ['EMBEDDED_KERNELS'])
198 env['asserts'] = True
199 env.Append(CXXFLAGS = ['-O0','-g','-gdwarf-2'])
200 env.Append(CPPDEFINES = ['ARM_COMPUTE_DEBUG_ENABLED'])
202 env.Append(CXXFLAGS = ['-O3','-ftree-vectorize'])
205 env.Append(CPPDEFINES = ['ARM_COMPUTE_ASSERTS_ENABLED'])
206 env.Append(CXXFLAGS = ['-fstack-protector-strong'])
208 env.Append(CPPPATH = ['#/include', "#"])
209 env.Append(CXXFLAGS = env['extra_cxx_flags'])
213 Export('version_at_least')
215 SConscript('./SConscript', variant_dir='#build/%s' % env['build_dir'], duplicate=0)
218 SConscript("./opencl-1.2-stubs/SConscript", variant_dir="build/%s/opencl-1.2-stubs" % env['build_dir'], duplicate=0)
220 if env['examples'] and env['os'] != 'bare_metal':
221 SConscript('./examples/SConscript', variant_dir='#build/%s/examples' % env['build_dir'], duplicate=0)
223 if env['os'] != 'bare_metal':
224 SConscript('./tests/SConscript', variant_dir='#build/%s/tests' % env['build_dir'], duplicate=0)