1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2017-2023, 2024 Arm Limited.
#
# SPDX-License-Identifier: MIT
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import os.path
import SCons
Import('env')
Import('vars')
Import('install_bin')
# vars is imported from arm_compute:
variables = [
BoolVariable("benchmark_examples", "Build benchmark examples programs", False),
BoolVariable("validate_examples", "Build validate examples programs", False),
BoolVariable("reference_openmp", "Build reference validation with openmp", True),
BoolVariable("validation_tests", "Build validation test programs", False),
BoolVariable("benchmark_tests", "Build benchmark test programs", False),
("test_filter", "Pattern to specify the tests' filenames to be compiled", "*.cpp")
]
# We need a separate set of Variables for the Help message (Otherwise the global variables will get displayed twice)
new_options = Variables('scons')
for v in variables:
new_options.Add(v)
vars.Add(v)
# Clone the environment to make sure we're not polluting the arm_compute one:
test_env = env.Clone()
vars.Update(test_env)
Help(new_options.GenerateHelpText(test_env))
# Check if we need to build the test framework
build_test_framework = False
for opt in new_options.keys():
option_value = test_env[opt]
if type(option_value) is bool and option_value:
build_test_framework = True
break
if not build_test_framework:
Return()
else:
SConscript('./framework/SConscript', duplicate=0)
Import("arm_compute_test_framework")
test_env.Append(LIBS = arm_compute_test_framework)
# Disable floating-point expression contraction (e.g. fused multiply-add operations)
if not 'windows' in env['os']:
test_env.Append(CXXFLAGS = ['-ffp-contract=off'])
# Remove -Wnoexcept from tests
if 'g++' in test_env['CXX'] and '-Wnoexcept' in test_env['CXXFLAGS']:
test_env['CXXFLAGS'].remove("-Wnoexcept")
load_whole_archive = '-Wl,--whole-archive'
noload_whole_archive = '-Wl,--no-whole-archive'
if 'macos' in test_env['os']:
load_whole_archive = '-Wl,-force_load'
noload_whole_archive = ''
if (env['multi_isa']):
test_env.Append(CPPDEFINES=['ARM_COMPUTE_ENABLE_BF16'])
if env['os'] in ['android', 'macos', 'bare_metal'] or env['standalone']:
Import("arm_compute_a")
Import("arm_compute_graph_a")
test_env.Append(LIBS = [arm_compute_graph_a, arm_compute_a])
arm_compute_lib = arm_compute_graph_a
else:
Import("arm_compute_graph_so")
test_env.Append(LIBS = ["arm_compute_graph", "arm_compute"])
arm_compute_lib = arm_compute_graph_so
if env['os'] in ['bare_metal']:
Import("bootcode_o")
if env['external_tests_dir']:
test_env.Append(CPPPATH = [env['external_tests_dir'] + "/include"])
test_env.Append(LIBPATH = [env['external_tests_dir'] + "/%s/%s" % (env['os'], env['arch'])])
common_files = Glob('*.cpp')
common_objects = [test_env.StaticObject(f) for f in common_files]
files_benchmark = Glob('benchmark/*.cpp')
if env['external_tests_dir']:
files_benchmark += Glob(env['external_tests_dir'] + '/tests/benchmark/*.cpp')
# Add unit tests
files_validation = Glob('validation/UNIT/*/*.cpp')
files_validation += Glob('validation/UNIT/*.cpp')
# Add CPP tests
filter_pattern = test_env['test_filter']
files_validation += Glob('validation/CPP/' + filter_pattern)
if env['opencl']:
if env['experimental_dynamic_fusion']:
files_validation += Glob('validation/dynamic_fusion/gpu/' + filter_pattern)
files_validation += Glob('validation/dynamic_fusion/gpu/cl/' + filter_pattern)
filter_pattern = test_env['test_filter']
test_env.Append(CPPDEFINES=['ARM_COMPUTE_CL'])
files_benchmark += Glob('benchmark/CL/*/' + filter_pattern)
files_benchmark += Glob('benchmark/CL/' + filter_pattern)
if env['external_tests_dir']:
files_benchmark += Glob(env['external_tests_dir'] + '/tests/benchmark/CL/' + filter_pattern)
files_validation += Glob('validation/CL/*/' + filter_pattern)
files_validation += Glob('validation/CL/' + filter_pattern)
if env['external_tests_dir']:
files_validation += Glob(env['external_tests_dir'] + '/tests/validation/CL/' + filter_pattern)
files_validation += Glob('validation/gpu/unit/*.cpp')
if env['neon']:
filter_pattern = test_env['test_filter']
files_benchmark += Glob('benchmark/NEON/*/' + filter_pattern)
files_benchmark += Glob('benchmark/NEON/' + filter_pattern)
test_env.Append(CPPPATH = ["#/src/cpu/kernels/assembly/"])
if env['external_tests_dir']:
files_benchmark += Glob(env['external_tests_dir'] + '/tests/benchmark/NEON/' + filter_pattern)
files_validation += Glob('validation/NEON/' + filter_pattern)
if env['os'] == 'bare_metal':
files_validation += Glob('validation/NEON/UNIT/MemoryManager.cpp' + filter_pattern)
files_validation += Glob('validation/NEON/UNIT/DynamicTensor.cpp' + filter_pattern)
files_validation += Glob('validation/NEON/UNIT/TensorAllocator.cpp' + filter_pattern)
else:
files_validation += Glob('validation/NEON/*/' + filter_pattern)
if env['external_tests_dir']:
files_validation += Glob(env['external_tests_dir'] + '/tests/validation/NEON/' + filter_pattern)
files_validation += Glob('validation/cpu/unit/*.cpp')
# Add wrapper tests
files_validation += Glob('validation/runtime/experimental/*/' + filter_pattern)
extra_link_flags = []
if env['os'] == 'android':
test_env.Append(LIBS = ["log"])
elif env['os'] not in ['windows','bare_metal', 'macos']:
test_env.Append(LIBS = ["rt"])
extra_link_flags += ['-fstack-protector-strong']
if test_env['benchmark_tests']:
arm_compute_benchmark = test_env.Program('arm_compute_benchmark', files_benchmark + common_objects)
arm_compute_benchmark = install_bin(arm_compute_benchmark)
Depends(arm_compute_benchmark, arm_compute_test_framework)
Depends(arm_compute_benchmark, arm_compute_lib)
Default(arm_compute_benchmark)
Export('arm_compute_benchmark')
bm_link_flags = []
if test_env['linker_script']:
bm_link_flags += ['-Wl,--build-id=none', '-T', env['linker_script']]
if test_env['reference_openmp'] and env['os'] not in ['bare_metal', 'macos','windows']:
test_env['CXXFLAGS'].append('-fopenmp')
test_env['LINKFLAGS'].append('-fopenmp')
if 'ndk_above_r21' in env:
test_env['LINKFLAGS'].append('-static-openmp')
# Testing for fixed format GEMM kernels.
if env['fixed_format_kernels'] and test_env['validation_tests']:
test_env.Append(CPPDEFINES = ['ARM_COMPUTE_ENABLE_FIXED_FORMAT_KERNELS'])
if test_env['validation_tests']:
#The following set up only works for posix system, RANLIBCOM env variable isn't available on win32 HOST_OS
if test_env['HOST_OS'] == 'posix':
#Set up to use temp file for long command when building and linking libraries
test_env['TEMPFILE'] = SCons.Platform.TempFileMunge
#To use temp file for any command, the following pattern should be used:
# env['COMMAND'] = "{$TEMPFILE('$COMMANDSTRING')}"
#See: https://github.com/SCons/scons/blob/05f2992377844bbfec9bcd4a9c7f5479c634b91b/SCons/Platform/__init__.py#L147
#The commands' string are taken from https://github.com/SCons/scons
#The commands' explanations are taken from Scons userguide
#The command line used to compile C++ source file to an object files
test_env['CXXCOM'] = "${TEMPFILE('"+ test_env['CXXCOM'] + "')}"
#The command line used to generate a static library from object files
test_env['ARCOM'] = "${TEMPFILE('"+ test_env['ARCOM'] + "')}"
#The command line used to index a static library archive
test_env['RANLIBCOM'] = "${TEMPFILE('"+ test_env['RANLIBCOM'] + "')}"
#The command line used to link object files into an executable
test_env['LINKCOM'] = "${TEMPFILE('"+ test_env['LINKCOM'] + "')}"
#Set up directory for temp files. To prevent permission issue, the temp files are in the same directory with output files
test_env['TEMPFILEDIR'] = test_env['build_dir']
arm_compute_validation_framework = test_env.StaticLibrary('arm_compute_validation_framework', Glob('validation/reference/*.cpp') + Glob('validation/*.cpp'), LINKFLAGS=test_env['LINKFLAGS'], CXXFLAGS=test_env['CXXFLAGS'], LIBS= [ arm_compute_test_framework ])
Depends(arm_compute_validation_framework , arm_compute_test_framework)
program_objects = files_validation + common_objects
if test_env['os'] == 'bare_metal':
Depends(arm_compute_validation_framework , bootcode_o)
program_objects += bootcode_o
arm_compute_validation = test_env.Program('arm_compute_validation', program_objects, LIBS=[arm_compute_validation_framework] + test_env['LIBS'], LINKFLAGS=test_env['LINKFLAGS'] + bm_link_flags)
arm_compute_validation = install_bin(arm_compute_validation)
Depends(arm_compute_validation, arm_compute_validation_framework)
Depends(arm_compute_validation, arm_compute_test_framework)
Depends(arm_compute_validation, arm_compute_lib)
Default(arm_compute_validation)
Export('arm_compute_validation')
if test_env['validate_examples']:
files_validate_examples = [ test_env.Object('validate_examples/RunExample.cpp') ] + [ x for x in common_objects if not "main.o" in str(x)]
if test_env['os'] == 'bare_metal':
files_validate_examples += bootcode_o
arm_compute_validate_examples = []
if test_env['neon']:
for file in Glob("validate_examples/neon_*.cpp"):
example = "validate_" + os.path.basename(os.path.splitext(str(file))[0])
arm_compute_validate_examples += [ test_env.Program(example, [ test_env.Object(source=file, target=example) ] + files_validate_examples, LIBS = [ arm_compute_validation_framework], LINKFLAGS=test_env['LINKFLAGS'] + bm_link_flags) ]
if test_env['opencl']:
cl_examples = []
files = Glob("validate_examples/cl_*.cpp")
if test_env['neon']:
files += Glob("validate_examples/neoncl_*.cpp")
for file in files:
example = "validate_" + os.path.basename(os.path.splitext(str(file))[0])
cl_examples += [ test_env.Program(example, [ test_env.Object(source=file, target=example) ] + files_validate_examples, LIBS = test_env["LIBS"] + [ arm_compute_validation_framework ]) ]
arm_compute_validate_examples += cl_examples
if test_env['opencl'] and test_env['neon']:
graph_utils = test_env.Object(source="../utils/GraphUtils.cpp", target="GraphUtils")
for file in Glob("validate_examples/graph_*.cpp"):
example = "validate_" + os.path.basename(os.path.splitext(str(file))[0])
if env['os'] in ['android', 'macos', 'bare_metal'] or env['standalone']:
prog = test_env.Program(example, [ test_env.Object(source=file, target=example), graph_utils]+ files_validate_examples, LIBS = test_env["LIBS"] + [ arm_compute_validation_framework ], LINKFLAGS=test_env["LINKFLAGS"]+[load_whole_archive, arm_compute_lib, noload_whole_archive] + bm_link_flags + extra_link_flags)
arm_compute_validate_examples += [ prog ]
else:
#-Wl,--allow-shlib-undefined: Ignore dependencies of dependencies
prog = test_env.Program(example, [ test_env.Object(source=file, target=example), graph_utils]+ files_validate_examples, LIBS = test_env["LIBS"] + ["arm_compute_graph", arm_compute_validation_framework], LINKFLAGS=test_env["LINKFLAGS"]+['-Wl,--allow-shlib-undefined'] )
arm_compute_validate_examples += [ prog ]
arm_compute_validate_examples = install_bin(arm_compute_validate_examples)
Depends(arm_compute_validate_examples, arm_compute_validation_framework)
Depends(arm_compute_validate_examples, arm_compute_test_framework)
Depends(arm_compute_validate_examples, arm_compute_lib)
Default(arm_compute_validate_examples)
Export('arm_compute_validate_examples')
if test_env['benchmark_examples']:
files_benchmark_examples = test_env.Object('benchmark_examples/RunExample.cpp')
if test_env['os'] == 'bare_metal':
files_benchmark_examples += bootcode_o
graph_utils = test_env.Object(source="../utils/GraphUtils.cpp", target="GraphUtils")
graph_params = test_env.Object(source="../utils/CommonGraphOptions.cpp", target="CommonGraphOptions")
arm_compute_benchmark_examples = []
all_examples_folders = ["../examples"]
if env['external_tests_dir']:
all_examples_folders.append(env['external_tests_dir'] + "/examples")
for examples_folder in all_examples_folders:
if test_env['neon']:
for file in Glob("%s/neon_*.cpp" % examples_folder):
example = "benchmark_" + os.path.basename(os.path.splitext(str(file))[0])
arm_compute_benchmark_examples += [ test_env.Program(example, [ test_env.Object(source=file, target=example) ] + files_benchmark_examples, LINKFLAGS=test_env["LINKFLAGS"]+ bm_link_flags) ]
if test_env['opencl']:
cl_examples = []
files = Glob("%s/cl_*.cpp" % examples_folder)
if test_env['neon']:
files += Glob("%s/neoncl_*.cpp" % examples_folder)
for file in files:
example = "benchmark_" + os.path.basename(os.path.splitext(str(file))[0])
cl_examples += [ test_env.Program(example, [ test_env.Object(source=file, target=example) ] + files_benchmark_examples, LIBS = test_env["LIBS"]) ]
arm_compute_benchmark_examples += cl_examples
if test_env['gemm_tuner'] and test_env['opencl']:
gemm_tuner_examples = []
gemm_tuner_common_options = test_env.Object(source="../examples/gemm_tuner/CommonGemmExampleOptions.cpp", target="CommonGemmExampleOptions")
files = Glob("%s/gemm_tuner/cl_*.cpp" % examples_folder)
for file in files:
example = "benchmark_" + os.path.basename(os.path.splitext(str(file))[0])
example = os.path.join("gemm_tuner", example)
gemm_tuner_examples += [ test_env.Program(example, [ test_env.Object(source=file, target=example), gemm_tuner_common_options ] + files_benchmark_examples, LIBS = test_env["LIBS"]) ]
arm_compute_benchmark_examples += gemm_tuner_examples
# Graph examples
for file in Glob("%s/graph_*.cpp" % examples_folder ):
example = "benchmark_" + os.path.basename(os.path.splitext(str(file))[0])
if env['os'] in ['android', 'macos', 'bare_metal'] or env['standalone']:
prog = test_env.Program(example, [ test_env.Object(source=file, target=example), graph_utils, graph_params]+ files_benchmark_examples, LIBS = test_env["LIBS"], LINKFLAGS=test_env["LINKFLAGS"]+[load_whole_archive, arm_compute_lib, noload_whole_archive] + bm_link_flags + extra_link_flags)
arm_compute_benchmark_examples += [ prog ]
else:
#-Wl,--allow-shlib-undefined: Ignore dependencies of dependencies
prog = test_env.Program(example, [ test_env.Object(source=file, target=example), graph_utils, graph_params]+ files_benchmark_examples, LIBS = test_env["LIBS"] + ["arm_compute_graph"], LINKFLAGS=test_env["LINKFLAGS"]+['-Wl,--allow-shlib-undefined'])
arm_compute_benchmark_examples += [ prog ]
arm_compute_benchmark_examples = install_bin(arm_compute_benchmark_examples)
Depends(arm_compute_benchmark_examples, arm_compute_test_framework)
Depends(arm_compute_benchmark_examples, arm_compute_lib)
Default(arm_compute_benchmark_examples)
Export('arm_compute_benchmark_examples')
|
