blob: c86f4dab0772f68047610c295c8888da988b09f4 [file] [log] [blame]
Alexandre Ramesb78f1392016-07-01 14:22:22 +01001# Copyright 2015, VIXL authors
armvixlad96eda2013-06-14 11:42:37 +01002# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are met:
6#
7# * Redistributions of source code must retain the above copyright notice,
8# this list of conditions and the following disclaimer.
9# * Redistributions in binary form must reproduce the above copyright notice,
10# this list of conditions and the following disclaimer in the documentation
11# and/or other materials provided with the distribution.
12# * Neither the name of ARM Limited nor the names of its contributors may be
13# used to endorse or promote products derived from this software without
14# specific prior written permission.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS CONTRIBUTORS "AS IS" AND
17# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
20# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
armvixldb644342015-07-21 11:37:10 +010027import glob
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +000028import itertools
armvixlad96eda2013-06-14 11:42:37 +010029import os
armvixldb644342015-07-21 11:37:10 +010030from os.path import join
armvixlc68cb642014-09-25 18:49:30 +010031import platform
armvixl4a102ba2014-07-14 09:02:40 +010032import subprocess
armvixlad96eda2013-06-14 11:42:37 +010033import sys
Pierre Langloisa3b21462016-08-04 16:01:51 +010034from collections import OrderedDict
armvixlad96eda2013-06-14 11:42:37 +010035
armvixl4a102ba2014-07-14 09:02:40 +010036root_dir = os.path.dirname(File('SConstruct').rfile().abspath)
armvixldb644342015-07-21 11:37:10 +010037sys.path.insert(0, join(root_dir, 'tools'))
38import config
armvixl4a102ba2014-07-14 09:02:40 +010039import util
40
Pierre Langlois8253a3c2016-12-14 18:54:22 +000041from SCons.Errors import UserError
42
armvixlc68cb642014-09-25 18:49:30 +010043
44Help('''
45Build system for the VIXL project.
46See README.md for documentation and details about the build system.
armvixlc68cb642014-09-25 18:49:30 +010047''')
48
49
armvixldb644342015-07-21 11:37:10 +010050# We track top-level targets to automatically generate help and alias them.
Pierre Langlois287e6d12016-11-21 14:56:01 +000051class VIXLTargets:
armvixldb644342015-07-21 11:37:10 +010052 def __init__(self):
53 self.targets = []
54 self.help_messages = []
55 def Add(self, target, help_message):
56 self.targets.append(target)
57 self.help_messages.append(help_message)
58 def Help(self):
armvixl684cd2a2015-10-23 13:38:33 +010059 res = ""
armvixldb644342015-07-21 11:37:10 +010060 for i in range(len(self.targets)):
61 res += '\t{0:<{1}}{2:<{3}}\n'.format(
62 'scons ' + self.targets[i],
63 len('scons ') + max(map(len, self.targets)),
64 ' : ' + self.help_messages[i],
65 len(' : ') + max(map(len, self.help_messages)))
66 return res
armvixlad96eda2013-06-14 11:42:37 +010067
Pierre Langlois287e6d12016-11-21 14:56:01 +000068top_level_targets = VIXLTargets()
armvixlad96eda2013-06-14 11:42:37 +010069
70
armvixldb644342015-07-21 11:37:10 +010071
72# Build options ----------------------------------------------------------------
73
74# Store all the options in a dictionary.
75# The SConstruct will check the build variables and construct the build
76# environment as appropriate.
77options = {
78 'all' : { # Unconditionally processed.
79 'CCFLAGS' : ['-Wall',
80 '-Werror',
81 '-fdiagnostics-show-option',
82 '-Wextra',
83 '-Wredundant-decls',
84 '-pedantic',
Alexandre Ramesfd098172016-08-09 10:29:53 +010085 '-Wwrite-strings',
Jacob Bramleycff5a2e2019-03-15 09:34:56 +000086 '-Wunused',
87 '-Wno-missing-noreturn'],
armvixldb644342015-07-21 11:37:10 +010088 'CPPPATH' : [config.dir_src_vixl]
89 },
90# 'build_option:value' : {
91# 'environment_key' : 'values to append'
92# },
93 'mode:debug' : {
94 'CCFLAGS' : ['-DVIXL_DEBUG', '-O0']
95 },
96 'mode:release' : {
Alexandre Ramesfa4a4bd2016-07-25 14:14:22 +010097 'CCFLAGS' : ['-O3'],
armvixldb644342015-07-21 11:37:10 +010098 },
Pierre Langloisa3b21462016-08-04 16:01:51 +010099 'simulator:aarch64' : {
Pierre Langlois1e85b7f2016-08-05 14:20:36 +0100100 'CCFLAGS' : ['-DVIXL_INCLUDE_SIMULATOR_AARCH64'],
armvixldb644342015-07-21 11:37:10 +0100101 },
102 'symbols:on' : {
103 'CCFLAGS' : ['-g'],
104 'LINKFLAGS' : ['-g']
105 },
Georgia Kouveli38d5d1b2016-11-16 11:58:41 +0000106 'negative_testing:on' : {
107 'CCFLAGS' : ['-DVIXL_NEGATIVE_TESTING']
Jacob Bramley1fa6f062016-12-19 11:40:08 +0000108 },
109 'code_buffer_allocator:mmap' : {
110 'CCFLAGS' : ['-DVIXL_CODE_BUFFER_MMAP']
111 },
112 'code_buffer_allocator:malloc' : {
113 'CCFLAGS' : ['-DVIXL_CODE_BUFFER_MALLOC']
Vincent Belliard4e52d4d2018-04-03 13:34:44 -0700114 },
115 'ubsan:on' : {
116 'CCFLAGS': ['-fsanitize=undefined'],
117 'LINKFLAGS': ['-fsanitize=undefined']
Georgia Kouveli38d5d1b2016-11-16 11:58:41 +0000118 }
armvixldb644342015-07-21 11:37:10 +0100119 }
armvixlad96eda2013-06-14 11:42:37 +0100120
121
armvixldb644342015-07-21 11:37:10 +0100122# A `DefaultVariable` has a default value that depends on elements not known
123# when variables are first evaluated.
124# Each `DefaultVariable` has a handler that will compute the default value for
125# the given environment.
126def modifiable_flags_handler(env):
127 env['modifiable_flags'] = \
128 'on' if 'mode' in env and env['mode'] == 'debug' else 'off'
armvixl6e2c8272015-03-31 11:04:14 +0100129
130
armvixldb644342015-07-21 11:37:10 +0100131def symbols_handler(env):
132 env['symbols'] = 'on' if 'mode' in env and env['mode'] == 'debug' else 'off'
armvixlad96eda2013-06-14 11:42:37 +0100133
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000134def Is32BitHost(env):
135 return env['host_arch'] in ['aarch32', 'i386']
136
137def IsAArch64Host(env):
138 return env['host_arch'] == 'aarch64'
139
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000140def CanTargetA32(env):
141 return 'a32' in env['target']
142
143def CanTargetT32(env):
144 return 't32' in env['target']
145
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000146def CanTargetAArch32(env):
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000147 return CanTargetA32(env) or CanTargetT32(env)
148
149def CanTargetA64(env):
150 return 'a64' in env['target']
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000151
152def CanTargetAArch64(env):
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000153 return CanTargetA64(env)
Pierre Langloisa3b21462016-08-04 16:01:51 +0100154
155
156# By default, include the simulator only if AArch64 is targeted and we are not
157# building VIXL natively for AArch64.
158def simulator_handler(env):
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000159 if not IsAArch64Host(env) and CanTargetAArch64(env):
Pierre Langloisa3b21462016-08-04 16:01:51 +0100160 env['simulator'] = 'aarch64'
161 else:
162 env['simulator'] = 'none'
163
164
Jacob Bramley1fa6f062016-12-19 11:40:08 +0000165# 'mmap' is required for use with 'mprotect', which is needed for the tests
166# (when running natively), so we use it by default where we can.
167def code_buffer_allocator_handler(env):
168 directives = util.GetCompilerDirectives(env)
169 if '__linux__' in directives:
170 env['code_buffer_allocator'] = 'mmap'
171 else:
172 env['code_buffer_allocator'] = 'malloc'
173
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000174# A validator checks the consistency of provided options against the environment.
175def default_validator(env):
176 pass
177
178
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000179def simulator_validator(env):
180 if env['simulator'] == 'aarch64' and not CanTargetAArch64(env):
181 raise UserError('Building an AArch64 simulator implies that VIXL targets '
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000182 'AArch64. Set `target` to include `aarch64` or `a64`.')
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000183
184
Pierre Langloisa3b21462016-08-04 16:01:51 +0100185# Default variables may depend on each other, therefore we need this dictionnary
186# to be ordered.
187vars_default_handlers = OrderedDict({
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000188 # variable_name : [ 'default val', 'handler', 'validator']
189 'symbols' : [ 'mode==debug', symbols_handler, default_validator ],
190 'modifiable_flags' : [ 'mode==debug', modifiable_flags_handler, default_validator],
Jacob Bramley1fa6f062016-12-19 11:40:08 +0000191 'simulator' : [ 'on if the target architectures include AArch64 but '
Pierre Langloisa3b21462016-08-04 16:01:51 +0100192 'the host is not AArch64, else off',
Jacob Bramley1fa6f062016-12-19 11:40:08 +0000193 simulator_handler, simulator_validator ],
194 'code_buffer_allocator' : [ 'mmap with __linux__, malloc otherwise',
195 code_buffer_allocator_handler, default_validator ]
Pierre Langloisa3b21462016-08-04 16:01:51 +0100196 })
armvixldb644342015-07-21 11:37:10 +0100197
198
Pierre Langloisa3b21462016-08-04 16:01:51 +0100199def DefaultVariable(name, help, allowed_values):
200 help = '%s (%s)' % (help, '|'.join(allowed_values))
armvixldb644342015-07-21 11:37:10 +0100201 default_value = vars_default_handlers[name][0]
Pierre Langloisa3b21462016-08-04 16:01:51 +0100202 def validator(name, value, env):
203 if value != default_value and value not in allowed_values:
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000204 raise UserError('Invalid value for option {name}: {value}. '
205 'Valid values are: {allowed_values}'.format(
206 name, value, allowed_values))
Pierre Langloisa3b21462016-08-04 16:01:51 +0100207 return (name, help, default_value, validator)
armvixldb644342015-07-21 11:37:10 +0100208
209
Matthew Bentham6ebcc8a2020-06-04 12:02:38 +0100210def SortListVariable(iterator):
211 # Previously this code relied on the order of items in a list
212 # converted from a set. However in Python 3 the order changes each run.
213 # Here we do a custom partial sort to ensure that the build directory
214 # name is stable, the same across Python 2 and 3, and the same as the
215 # old code.
216 result = list(sorted(iterator))
217 result = sorted(result, key=lambda x: x == 't32', reverse=True)
218 result = sorted(result, key=lambda x: x == 'a32', reverse=True)
219 result = sorted(result, key=lambda x: x == 'a64', reverse=True)
220 return result
221
222
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000223def AliasedListVariable(name, help, default_value, allowed_values, aliasing):
224 help = '%s (all|auto|comma-separated list) (any combination from [%s])' % \
225 (help, ', '.join(allowed_values))
226
227 def validator(name, value, env):
228 # Here list has been converted to space separated strings.
229 if value == '': return # auto
230 for v in value.split():
231 if v not in allowed_values:
232 raise UserError('Invalid value for %s: %s' % (name, value))
233
234 def converter(value):
235 if value == 'auto': return []
236 if value == 'all':
237 translated = [aliasing[v] for v in allowed_values]
Matthew Bentham6ebcc8a2020-06-04 12:02:38 +0100238 return SortListVariable(itertools.chain.from_iterable(translated))
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000239 # The validator is run later hence the get.
240 translated = [aliasing.get(v, v) for v in value.split(',')]
Matthew Bentham6ebcc8a2020-06-04 12:02:38 +0100241 return SortListVariable(itertools.chain.from_iterable(translated))
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000242
243 return (name, help, default_value, validator, converter)
244
245
armvixldb644342015-07-21 11:37:10 +0100246vars = Variables()
247# Define command line build options.
armvixldb644342015-07-21 11:37:10 +0100248vars.AddVariables(
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000249 AliasedListVariable('target', 'Target ISA/Architecture', 'auto',
250 ['aarch32', 'a32', 't32', 'aarch64', 'a64'],
251 {'aarch32' : ['a32', 't32'],
252 'a32' : ['a32'], 't32' : ['t32'],
253 'aarch64' : ['a64'], 'a64' : ['a64']}),
armvixldb644342015-07-21 11:37:10 +0100254 EnumVariable('mode', 'Build mode',
255 'release', allowed_values=config.build_options_modes),
Vincent Belliard4e52d4d2018-04-03 13:34:44 -0700256 EnumVariable('ubsan', 'Enable undefined behavior checks',
257 'off', allowed_values=['on', 'off']),
Jacob Bramley1fa6f062016-12-19 11:40:08 +0000258 EnumVariable('negative_testing',
259 'Enable negative testing (needs exceptions)',
Georgia Kouveli38d5d1b2016-11-16 11:58:41 +0000260 'off', allowed_values=['on', 'off']),
armvixldb644342015-07-21 11:37:10 +0100261 DefaultVariable('symbols', 'Include debugging symbols in the binaries',
262 ['on', 'off']),
Pierre Langloisa3b21462016-08-04 16:01:51 +0100263 DefaultVariable('simulator', 'Simulators to include', ['aarch64', 'none']),
Jacob Bramley1fa6f062016-12-19 11:40:08 +0000264 DefaultVariable('code_buffer_allocator',
265 'Configure the allocation mechanism in the CodeBuffer',
266 ['malloc', 'mmap']),
armvixldb644342015-07-21 11:37:10 +0100267 ('std', 'C++ standard. The standards tested are: %s.' % \
Anthony Barbier9c4ba7a2019-02-15 15:20:25 +0000268 ', '.join(config.tested_cpp_standards)),
269 ('compiler_wrapper', 'Command to prefix to the C and C++ compiler (e.g ccache)', '')
armvixldb644342015-07-21 11:37:10 +0100270 )
armvixlad96eda2013-06-14 11:42:37 +0100271
armvixldb644342015-07-21 11:37:10 +0100272# We use 'variant directories' to avoid recompiling multiple times when build
273# options are changed, different build paths are used depending on the options
274# set. These are the options that should be reflected in the build directory
275# path.
Pierre Langloisa3b21462016-08-04 16:01:51 +0100276options_influencing_build_path = [
Anthony Barbier9c4ba7a2019-02-15 15:20:25 +0000277 'target', 'mode', 'symbols', 'compiler', 'std', 'simulator', 'negative_testing',
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000278 'code_buffer_allocator'
Pierre Langloisa3b21462016-08-04 16:01:51 +0100279]
armvixlad96eda2013-06-14 11:42:37 +0100280
armvixlad96eda2013-06-14 11:42:37 +0100281
armvixldb644342015-07-21 11:37:10 +0100282
283# Build helpers ----------------------------------------------------------------
284
285def RetrieveEnvironmentVariables(env):
Pierre Langlois88c46b82016-06-02 18:15:32 +0100286 for key in ['CC', 'CXX', 'AR', 'RANLIB', 'LD']:
armvixldb644342015-07-21 11:37:10 +0100287 if os.getenv(key): env[key] = os.getenv(key)
288 if os.getenv('LD_LIBRARY_PATH'): env['LIBPATH'] = os.getenv('LD_LIBRARY_PATH')
Pierre Langlois88c46b82016-06-02 18:15:32 +0100289 if os.getenv('CCFLAGS'):
290 env.Append(CCFLAGS = os.getenv('CCFLAGS').split())
armvixldb644342015-07-21 11:37:10 +0100291 if os.getenv('CXXFLAGS'):
292 env.Append(CXXFLAGS = os.getenv('CXXFLAGS').split())
293 if os.getenv('LINKFLAGS'):
294 env.Append(LINKFLAGS = os.getenv('LINKFLAGS').split())
armvixl4a102ba2014-07-14 09:02:40 +0100295
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000296# The architecture targeted by default will depend on the compiler being
297# used. 'host_arch' is extracted from the compiler while 'target' can be
298# set by the user.
299# By default, we target both AArch32 and AArch64 unless the compiler targets a
300# 32-bit architecture. At the moment, we cannot build VIXL's AArch64 support on
301# a 32-bit platform.
302# TODO: Port VIXL to build on a 32-bit platform.
303def target_handler(env):
304 # Auto detect
305 if Is32BitHost(env):
306 # We use list(set(...)) to keep the same order as if it was specify as
307 # an option.
Matthew Bentham6ebcc8a2020-06-04 12:02:38 +0100308 env['target'] = SortListVariable(['a32', 't32'])
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000309 else:
Matthew Bentham6ebcc8a2020-06-04 12:02:38 +0100310 env['target'] = SortListVariable(['a64', 'a32', 't32'])
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000311
312
313def target_validator(env):
314 # TODO: Port VIXL64 to work on a 32-bit platform.
315 if Is32BitHost(env) and CanTargetAArch64(env):
316 raise UserError('Building VIXL for AArch64 in 32-bit is not supported. Set '
317 '`target` to `aarch32`')
318
319
320# The target option is handled differently from the rest.
321def ProcessTargetOption(env):
322 if env['target'] == []: target_handler(env)
323
324 if 'a32' in env['target']: env['CCFLAGS'] += ['-DVIXL_INCLUDE_TARGET_A32']
325 if 't32' in env['target']: env['CCFLAGS'] += ['-DVIXL_INCLUDE_TARGET_T32']
326 if 'a64' in env['target']: env['CCFLAGS'] += ['-DVIXL_INCLUDE_TARGET_A64']
327
328 target_validator(env)
329
330
armvixldb644342015-07-21 11:37:10 +0100331def ProcessBuildOptions(env):
332 # 'all' is unconditionally processed.
333 if 'all' in options:
334 for var in options['all']:
335 if var in env and env[var]:
336 env[var] += options['all'][var]
337 else:
338 env[var] = options['all'][var]
Pierre Langloisa3b21462016-08-04 16:01:51 +0100339
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000340 # The target option *must* be processed before the options defined in
341 # vars_default_handlers.
342 ProcessTargetOption(env)
343
armvixldb644342015-07-21 11:37:10 +0100344 # Other build options must match 'option:value'
345 env_dict = env.Dictionary()
Pierre Langloisa3b21462016-08-04 16:01:51 +0100346
347 # First apply the default variables handlers in order.
348 for key, value in vars_default_handlers.items():
349 default = value[0]
350 handler = value[1]
351 if env_dict.get(key) == default:
352 handler(env_dict)
353
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000354 # Second, run the series of validators, to check for errors.
355 for _, value in vars_default_handlers.items():
356 validator = value[2]
357 validator(env)
358
armvixldb644342015-07-21 11:37:10 +0100359 for key in env_dict.keys():
armvixldb644342015-07-21 11:37:10 +0100360 # Then update the environment according to the value of the variable.
361 key_val_couple = key + ':%s' % env_dict[key]
362 if key_val_couple in options:
363 for var in options[key_val_couple]:
364 env[var] += options[key_val_couple][var]
365
366
367def ConfigureEnvironmentForCompiler(env):
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000368 compiler = util.CompilerInformation(env)
Pierre Langloisf737e0a2016-11-02 13:08:11 +0000369 if compiler == 'clang':
armvixldb644342015-07-21 11:37:10 +0100370 # These warnings only work for Clang.
371 # -Wimplicit-fallthrough only works when compiling the code base as C++11 or
372 # newer. The compiler does not complain if the option is passed when
373 # compiling earlier C++ standards.
374 env.Append(CPPFLAGS = ['-Wimplicit-fallthrough', '-Wshorten-64-to-32'])
375
376 # The '-Wunreachable-code' flag breaks builds for clang 3.4.
Jacob Bramley176a3792016-11-09 14:44:39 +0000377 if compiler != 'clang-3.4':
armvixldb644342015-07-21 11:37:10 +0100378 env.Append(CPPFLAGS = ['-Wunreachable-code'])
379
Vincent Belliard4e52d4d2018-04-03 13:34:44 -0700380 if env['ubsan'] == 'on':
381 env.Append(LINKFLAGS = ['-fuse-ld=lld'])
382
armvixldb644342015-07-21 11:37:10 +0100383 # GCC 4.8 has a bug which produces a warning saying that an anonymous Operand
384 # object might be used uninitialized:
385 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=57045
386 # The bug does not seem to appear in GCC 4.7, or in debug builds with GCC 4.8.
387 if env['mode'] == 'release':
Pierre Langloisf737e0a2016-11-02 13:08:11 +0000388 if compiler == 'gcc-4.8':
armvixldb644342015-07-21 11:37:10 +0100389 env.Append(CPPFLAGS = ['-Wno-maybe-uninitialized'])
Pierre Langloisf737e0a2016-11-02 13:08:11 +0000390
Pierre Langloisf7bf6552017-05-05 13:14:35 +0100391 # GCC 6 and higher is able to detect throwing from inside a destructor and
392 # reports a warning. However, if negative testing is enabled then assertions
393 # will throw exceptions.
394 if env['negative_testing'] == 'on' and env['mode'] == 'debug' \
395 and compiler >= 'gcc-6':
396 env.Append(CPPFLAGS = ['-Wno-terminate'])
397 # The C++11 compatibility warning will also be triggered for this case, as
398 # the behavior of throwing from desctructors has changed.
399 if 'std' in env and env['std'] == 'c++98':
400 env.Append(CPPFLAGS = ['-Wno-c++11-compat'])
401
Pierre Langloisc1253072016-06-15 14:36:10 +0100402 # When compiling with c++98 (the default), allow long long constants.
armvixl0f35e362016-05-10 13:57:58 +0100403 if 'std' not in env or env['std'] == 'c++98':
Pierre Langloisc1253072016-06-15 14:36:10 +0100404 env.Append(CPPFLAGS = ['-Wno-long-long'])
Jacob Bramley5997b462018-06-05 14:05:30 +0100405 env.Append(CPPFLAGS = ['-Wno-variadic-macros'])
Pierre Langlois3fac43c2016-10-31 13:38:47 +0000406 # When compiling with c++11, suggest missing override keywords on methods.
407 if 'std' in env and env['std'] in ['c++11', 'c++14']:
Pierre Langloisf737e0a2016-11-02 13:08:11 +0000408 if compiler >= 'gcc-5':
Pierre Langlois3fac43c2016-10-31 13:38:47 +0000409 env.Append(CPPFLAGS = ['-Wsuggest-override'])
Pierre Langloisf737e0a2016-11-02 13:08:11 +0000410 elif compiler >= 'clang-3.6':
Pierre Langlois3fac43c2016-10-31 13:38:47 +0000411 env.Append(CPPFLAGS = ['-Winconsistent-missing-override'])
armvixldb644342015-07-21 11:37:10 +0100412
413
414def ConfigureEnvironment(env):
415 RetrieveEnvironmentVariables(env)
Anthony Barbier9c4ba7a2019-02-15 15:20:25 +0000416 env['compiler'] = env['CXX']
417 if env['compiler_wrapper'] != '':
418 env['CXX'] = env['compiler_wrapper'] + ' ' + env['CXX']
419 env['CC'] = env['compiler_wrapper'] + ' ' + env['CC']
Pierre Langlois8253a3c2016-12-14 18:54:22 +0000420 env['host_arch'] = util.GetHostArch(env)
armvixldb644342015-07-21 11:37:10 +0100421 ProcessBuildOptions(env)
422 if 'std' in env:
423 env.Append(CPPFLAGS = ['-std=' + env['std']])
424 std_path = env['std']
425 ConfigureEnvironmentForCompiler(env)
426
427
428def TargetBuildDir(env):
429 # Build-time option values are embedded in the build path to avoid requiring a
430 # full build when an option changes.
431 build_dir = config.dir_build
432 for option in options_influencing_build_path:
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000433 option_value = ''.join(env[option]) if option in env else ''
armvixldb644342015-07-21 11:37:10 +0100434 build_dir = join(build_dir, option + '_'+ option_value)
435 return build_dir
436
437
438def PrepareVariantDir(location, build_dir):
439 location_build_dir = join(build_dir, location)
440 VariantDir(location_build_dir, location)
441 return location_build_dir
442
443
444def VIXLLibraryTarget(env):
445 build_dir = TargetBuildDir(env)
446 # Create a link to the latest build directory.
Alexandre Rames4e241932016-06-08 21:32:03 +0100447 # Use `-r` to avoid failure when `latest` exists and is a directory.
448 subprocess.check_call(["rm", "-rf", config.dir_build_latest])
armvixldb644342015-07-21 11:37:10 +0100449 util.ensure_dir(build_dir)
450 subprocess.check_call(["ln", "-s", build_dir, config.dir_build_latest])
Alexandre Ramesd3832962016-07-04 15:03:43 +0100451 # Source files are in `src` and in `src/aarch64/`.
Alexandre Rames39c32a62016-05-23 15:47:22 +0100452 variant_dir_vixl = PrepareVariantDir(join('src'), build_dir)
Pierre Langloisa3b21462016-08-04 16:01:51 +0100453 sources = [Glob(join(variant_dir_vixl, '*.cc'))]
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000454 if CanTargetAArch32(env):
Pierre Langloisa3b21462016-08-04 16:01:51 +0100455 variant_dir_aarch32 = PrepareVariantDir(join('src', 'aarch32'), build_dir)
456 sources.append(Glob(join(variant_dir_aarch32, '*.cc')))
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000457 if CanTargetAArch64(env):
Pierre Langloisa3b21462016-08-04 16:01:51 +0100458 variant_dir_aarch64 = PrepareVariantDir(join('src', 'aarch64'), build_dir)
459 sources.append(Glob(join(variant_dir_aarch64, '*.cc')))
armvixldb644342015-07-21 11:37:10 +0100460 return env.Library(join(build_dir, 'vixl'), sources)
461
462
463
464# Build ------------------------------------------------------------------------
465
466# The VIXL library, built by default.
Pierre Langlois287e6d12016-11-21 14:56:01 +0000467env = Environment(variables = vars,
468 BUILDERS = {
469 'Markdown': Builder(action = 'markdown $SOURCE > $TARGET',
470 suffix = '.html')
Anthony Barbierf2986e12019-02-28 16:49:23 +0000471 }, ENV = os.environ)
Alexandre Ramesf5de33d2016-10-25 09:51:11 +0100472# Abort the build if any command line option is unknown or invalid.
473unknown_build_options = vars.UnknownVariables()
474if unknown_build_options:
Matthew Benthamfe7cb102020-05-30 13:28:36 +0100475 print('Unknown build options: ' + str(unknown_build_options.keys()))
Alexandre Ramesf5de33d2016-10-25 09:51:11 +0100476 Exit(1)
477
Anthony Barbierf2986e12019-02-28 16:49:23 +0000478if env['negative_testing'] == 'on' and env['mode'] != 'debug':
Matthew Benthamfe7cb102020-05-30 13:28:36 +0100479 print('negative_testing only works in debug mode')
Anthony Barbierf2986e12019-02-28 16:49:23 +0000480 Exit(1)
481
armvixldb644342015-07-21 11:37:10 +0100482ConfigureEnvironment(env)
armvixldb644342015-07-21 11:37:10 +0100483Help(vars.GenerateHelpText(env))
484libvixl = VIXLLibraryTarget(env)
485Default(libvixl)
486env.Alias('libvixl', libvixl)
487top_level_targets.Add('', 'Build the VIXL library.')
488
armvixl4a102ba2014-07-14 09:02:40 +0100489
Pierre Langloisa3b21462016-08-04 16:01:51 +0100490# Common test code.
armvixldb644342015-07-21 11:37:10 +0100491test_build_dir = PrepareVariantDir('test', TargetBuildDir(env))
Pierre Langlois88c46b82016-06-02 18:15:32 +0100492test_objects = [env.Object(Glob(join(test_build_dir, '*.cc')))]
493
Pierre Langloisa3b21462016-08-04 16:01:51 +0100494# AArch32 support
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000495if CanTargetAArch32(env):
Pierre Langloisa3b21462016-08-04 16:01:51 +0100496 # The examples.
497 aarch32_example_names = util.ListCCFilesWithoutExt(config.dir_aarch32_examples)
498 aarch32_examples_build_dir = PrepareVariantDir('examples/aarch32', TargetBuildDir(env))
499 aarch32_example_targets = []
500 for example in aarch32_example_names:
501 prog = env.Program(join(aarch32_examples_build_dir, example),
502 join(aarch32_examples_build_dir, example + '.cc'),
503 LIBS=[libvixl])
504 aarch32_example_targets.append(prog)
505 env.Alias('aarch32_examples', aarch32_example_targets)
506 top_level_targets.Add('aarch32_examples', 'Build the examples for AArch32.')
Pierre Langlois88c46b82016-06-02 18:15:32 +0100507
Vincent Belliard32cf2542016-07-14 10:04:09 -0700508 # The benchmarks
509 aarch32_benchmark_names = util.ListCCFilesWithoutExt(config.dir_aarch32_benchmarks)
510 aarch32_benchmarks_build_dir = PrepareVariantDir('benchmarks/aarch32', TargetBuildDir(env))
511 aarch32_benchmark_targets = []
512 for bench in aarch32_benchmark_names:
513 prog = env.Program(join(aarch32_benchmarks_build_dir, bench),
514 join(aarch32_benchmarks_build_dir, bench + '.cc'),
515 LIBS=[libvixl])
516 aarch32_benchmark_targets.append(prog)
517 env.Alias('aarch32_benchmarks', aarch32_benchmark_targets)
518 top_level_targets.Add('aarch32_benchmarks', 'Build the benchmarks for AArch32.')
519
Pierre Langloisa3b21462016-08-04 16:01:51 +0100520 # The tests.
521 test_aarch32_build_dir = PrepareVariantDir(join('test', 'aarch32'), TargetBuildDir(env))
522 test_objects.append(env.Object(
523 Glob(join(test_aarch32_build_dir, '*.cc')),
Anthony Barbier7b4df2b2019-03-12 17:36:15 +0000524 CPPPATH = env['CPPPATH'] + [config.dir_tests],
525 CCFLAGS = [flag for flag in env['CCFLAGS'] if flag != '-O3']))
Pierre Langlois88c46b82016-06-02 18:15:32 +0100526
Pierre Langloisa3b21462016-08-04 16:01:51 +0100527# AArch64 support
Rodolph Perfetta9a9331f2016-12-09 22:05:48 +0000528if CanTargetAArch64(env):
Pierre Langloisa3b21462016-08-04 16:01:51 +0100529 # The benchmarks.
530 aarch64_benchmark_names = util.ListCCFilesWithoutExt(config.dir_aarch64_benchmarks)
531 aarch64_benchmarks_build_dir = PrepareVariantDir('benchmarks/aarch64', TargetBuildDir(env))
532 aarch64_benchmark_targets = []
Jacob Bramley1d925c02019-06-17 16:51:23 +0100533 bench_utils = env.Object(join(aarch64_benchmarks_build_dir, 'bench-utils.o'),
534 join(aarch64_benchmarks_build_dir, 'bench-utils.cc'))
Pierre Langloisa3b21462016-08-04 16:01:51 +0100535 for bench in aarch64_benchmark_names:
Jacob Bramley1d925c02019-06-17 16:51:23 +0100536 if bench != 'bench-utils':
537 prog = env.Program(join(aarch64_benchmarks_build_dir, bench),
538 [join(aarch64_benchmarks_build_dir, bench + '.cc'), bench_utils],
539 LIBS=[libvixl])
540 aarch64_benchmark_targets.append(prog)
Pierre Langloisa3b21462016-08-04 16:01:51 +0100541 env.Alias('aarch64_benchmarks', aarch64_benchmark_targets)
542 top_level_targets.Add('aarch64_benchmarks', 'Build the benchmarks for AArch64.')
543
544 # The examples.
545 aarch64_example_names = util.ListCCFilesWithoutExt(config.dir_aarch64_examples)
546 aarch64_examples_build_dir = PrepareVariantDir('examples/aarch64', TargetBuildDir(env))
547 aarch64_example_targets = []
548 for example in aarch64_example_names:
549 prog = env.Program(join(aarch64_examples_build_dir, example),
550 join(aarch64_examples_build_dir, example + '.cc'),
551 LIBS=[libvixl])
552 aarch64_example_targets.append(prog)
553 env.Alias('aarch64_examples', aarch64_example_targets)
554 top_level_targets.Add('aarch64_examples', 'Build the examples for AArch64.')
555
556 # The tests.
557 test_aarch64_build_dir = PrepareVariantDir(join('test', 'aarch64'), TargetBuildDir(env))
558 test_objects.append(env.Object(
559 Glob(join(test_aarch64_build_dir, '*.cc')),
Anthony Barbier7b4df2b2019-03-12 17:36:15 +0000560 CPPPATH = env['CPPPATH'] + [config.dir_tests],
561 CCFLAGS = [flag for flag in env['CCFLAGS'] if flag != '-O3']))
Pierre Langloisa3b21462016-08-04 16:01:51 +0100562
563 # The test requires building the example files with specific options, so we
564 # create a separate variant dir for the example objects built this way.
565 test_aarch64_examples_vdir = join(TargetBuildDir(env), 'test', 'aarch64', 'test_examples')
566 VariantDir(test_aarch64_examples_vdir, '.')
567 test_aarch64_examples_obj = env.Object(
Jacob Bramley0f71a762018-08-30 12:09:34 +0100568 [Glob(join(test_aarch64_examples_vdir, join('test', 'aarch64', 'examples', '*.cc'))),
Pierre Langloisa3b21462016-08-04 16:01:51 +0100569 Glob(join(test_aarch64_examples_vdir, join('examples/aarch64', '*.cc')))],
570 CCFLAGS = env['CCFLAGS'] + ['-DTEST_EXAMPLES'],
571 CPPPATH = env['CPPPATH'] + [config.dir_aarch64_examples] + [config.dir_tests])
572 test_objects.append(test_aarch64_examples_obj)
Pierre Langlois88c46b82016-06-02 18:15:32 +0100573
574test = env.Program(join(test_build_dir, 'test-runner'), test_objects,
armvixldb644342015-07-21 11:37:10 +0100575 LIBS=[libvixl])
576env.Alias('tests', test)
577top_level_targets.Add('tests', 'Build the tests.')
armvixl4a102ba2014-07-14 09:02:40 +0100578
armvixl4a102ba2014-07-14 09:02:40 +0100579
armvixldb644342015-07-21 11:37:10 +0100580env.Alias('all', top_level_targets.targets)
581top_level_targets.Add('all', 'Build all the targets above.')
582
583Help('\n\nAvailable top level targets:\n' + top_level_targets.Help())
Pierre Langlois287e6d12016-11-21 14:56:01 +0000584
585extra_targets = VIXLTargets()
586
587# Build documentation
588doc = [
589 env.Markdown('README.md'),
590 env.Markdown('doc/changelog.md'),
591 env.Markdown('doc/aarch32/getting-started-aarch32.md'),
592 env.Markdown('doc/aarch32/design/code-generation-aarch32.md'),
593 env.Markdown('doc/aarch32/design/literal-pool-aarch32.md'),
594 env.Markdown('doc/aarch64/supported-instructions-aarch64.md'),
595 env.Markdown('doc/aarch64/getting-started-aarch64.md'),
596 env.Markdown('doc/aarch64/topics/ycm.md'),
597 env.Markdown('doc/aarch64/topics/extending-the-disassembler.md'),
598 env.Markdown('doc/aarch64/topics/index.md'),
599]
600env.Alias('doc', doc)
601extra_targets.Add('doc', 'Convert documentation to HTML (requires the '
602 '`markdown` program).')
603
604Help('\nAvailable extra targets:\n' + extra_targets.Help())