blob: 673771c3775fc4ca924a81dcb9a471ccf3113e74 [file] [log] [blame]
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +01001#!/usr/bin/env python3
2
3""" tfm_build_manager.py:
4
5 Controlling class managing multiple build configruations for tfm """
6
7from __future__ import print_function
8
9__copyright__ = """
10/*
Feder Liang357b1602022-01-11 16:47:49 +080011 * Copyright (c) 2018-2022, Arm Limited. All rights reserved.
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +010012 *
13 * SPDX-License-Identifier: BSD-3-Clause
14 *
15 */
16 """
Karl Zhang08681e62020-10-30 13:56:03 +080017
18__author__ = "tf-m@lists.trustedfirmware.org"
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +010019__project__ = "Trusted Firmware-M Open CI"
Xinyu Zhang06286a92021-07-22 14:00:51 +080020__version__ = "1.4.0"
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +010021
22import os
23import sys
Karl Zhangaff558a2020-05-15 14:28:23 +010024from .utils import *
Minos Galanakisea421232019-06-20 17:11:28 +010025from time import time
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +010026from copy import deepcopy
27from .utils import gen_cfg_combinations, list_chunks, load_json,\
Minos Galanakisea421232019-06-20 17:11:28 +010028 save_json, print_test, show_progress, \
29 resolve_rel_path
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +010030from .structured_task import structuredTask
31from .tfm_builder import TFM_Builder
32
33
Xinyu Zhang38b76742021-11-11 13:57:56 +080034mapPlatform = {"cypress/psoc64": "psoc64",
35 "arm/mps2/an519": "AN519",
36 "arm/mps2/an521": "AN521",
37 "arm/mps2/an539": "AN539",
38 "arm/mps2/sse-200_aws": "SSE-200_AWS",
39 "arm/mps3/an524": "AN524",
40 "arm/musca_b1/sse_200": "MUSCA_B1",
41 "arm/musca_b1/secure_enclave": "MUSCA_B1_SE",
42 "arm/musca_s1": "MUSCA_S1",
43 "stm/stm32l562e_dk": "stm32l562e_dk",
44 "arm/corstone1000": "corstone1000",
45 "nxp/lpcxpresso55s69": "lpcxpresso55s69",
46 "arm/mps3/an547": "AN547",
47 "arm/mps3/corstone_polaris": "Polaris",
48 "lairdconnectivity/bl5340_dvk_cpuapp": "BL5340",
49 "nordic_nrf/nrf5340dk_nrf5340_cpuapp": "nrf5340dk",
50 "nordic_nrf/nrf9160dk_nrf9160": "nrf9160dk",
51 "nuvoton/m2351": "M2351",
52 "nuvoton/m2354": "M2354",
53 "stm/b_u585i_iot02a": "b_u585i_iot02a",
54 "stm/nucleo_l552ze_q": "nucleo_l552ze_q"}
Xinyu Zhang1078e812020-10-15 11:52:36 +080055
56mapCompiler = {"toolchain_GNUARM.cmake": "GNUARM",
57 "toolchain_ARMCLANG.cmake": "ARMCLANG"}
58
Xinyu Zhangc371af62020-10-21 10:41:57 +080059mapTestPsaApi = {"IPC": "FF",
Xinyu Zhang1078e812020-10-15 11:52:36 +080060 "CRYPTO": "CRYPTO",
Xinyu Zhang1078e812020-10-15 11:52:36 +080061 "INITIAL_ATTESTATION": "ATTEST",
Xinyu Zhang39acb412021-07-09 20:35:19 +080062 "STORAGE": "STORAGE"}
Xinyu Zhang1078e812020-10-15 11:52:36 +080063
Xinyu Zhang9fd74242020-10-22 11:30:50 +080064mapProfile = {"profile_small": "SMALL",
Xinyu Zhang9b1aef92021-03-12 15:36:44 +080065 "profile_medium": "MEDIUM",
66 "profile_large": "LARGE"}
Xinyu Zhang1078e812020-10-15 11:52:36 +080067
Xinyu Zhangfd2e1152021-12-17 18:09:01 +080068mapExtraParams = {"": "",
69 "CRYPTO_OFF": ("-DTEST_S_CRYPTO=OFF "
70 "-DTEST_NS_CRYPTO=OFF "),
Xinyu Zhang7c8d3372021-12-22 11:15:42 +080071 "CRYPTO_ON": ("-DTEST_S_CRYPTO=ON "
72 "-DTEST_NS_CRYPTO=ON "),
Xinyu Zhang3bb01af2021-12-20 14:45:49 +080073 "NSCE": "-DTFM_NS_MANAGE_NSID=ON ",
Feder Liang357b1602022-01-11 16:47:49 +080074 "MMIO": "-DPSA_FRAMEWORK_HAS_MM_IOVEC=ON ",
75 "FPSOFT": "-DCONFIG_TFM_FP=soft ",
76 "FPHARD": "-DCONFIG_TFM_FP=hard ",
77 "FPHARD_LOFF": ("-DCONFIG_TFM_FP=hard "
78 "-DCONFIG_TFM_LAZY_STACKING=OFF ")
79 }
Xinyu Zhangfd2e1152021-12-17 18:09:01 +080080
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +010081class TFM_Build_Manager(structuredTask):
82 """ Class that will load a configuration out of a json file, schedule
83 the builds, and produce a report """
84
85 def __init__(self,
86 tfm_dir, # TFM root directory
87 work_dir, # Current working directory(ie logs)
88 cfg_dict, # Input config dictionary of the following form
89 # input_dict = {"PROJ_CONFIG": "ConfigRegression",
90 # "TARGET_PLATFORM": "MUSCA_A",
91 # "COMPILER": "ARMCLANG",
92 # "CMAKE_BUILD_TYPE": "Debug"}
93 report=None, # File to produce report
94 parallel_builds=3, # Number of builds to run in parallel
Minos Galanakisea421232019-06-20 17:11:28 +010095 build_threads=3, # Number of threads used per build
96 install=False, # Install libraries after build
97 img_sizes=False, # Use arm-none-eabi-size for size info
98 relative_paths=False): # Store relative paths in report
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +010099 self._tbm_build_threads = build_threads
100 self._tbm_conc_builds = parallel_builds
101 self._tbm_install = install
Minos Galanakisea421232019-06-20 17:11:28 +0100102 self._tbm_img_sizes = img_sizes
103 self._tbm_relative_paths = relative_paths
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100104
105 # Required by other methods, always set working directory first
106 self._tbm_work_dir = os.path.abspath(os.path.expanduser(work_dir))
107
108 self._tbm_tfm_dir = os.path.abspath(os.path.expanduser(tfm_dir))
109
Karl Zhangaff558a2020-05-15 14:28:23 +0100110 print("bm param tfm_dir %s" % tfm_dir)
111 print("bm %s %s %s" % (work_dir, cfg_dict, self._tbm_work_dir))
Minos Galanakisea421232019-06-20 17:11:28 +0100112 # Internal flag to tag simple (non combination formatted configs)
113 self.simple_config = False
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100114 self._tbm_report = report
115
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100116 self._tbm_cfg = self.load_config(cfg_dict, self._tbm_work_dir)
Minos Galanakisea421232019-06-20 17:11:28 +0100117 self._tbm_build_cfg, \
118 self.tbm_common_cfg = self.parse_config(self._tbm_cfg)
Karl Zhangaff558a2020-05-15 14:28:23 +0100119 self._tfb_code_base_updated = False
120 self._tfb_log_f = "CodeBasePrepare.log"
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100121
122 super(TFM_Build_Manager, self).__init__(name="TFM_Build_Manager")
123
Xinyu Zhangff5d7712022-01-14 13:48:59 +0800124 def set_compiler_version(self, config):
125 compiler_version = ""
126 # Set GCC version
127 if "GNUARM" in config.toolchain_file:
Feder Liang357b1602022-01-11 16:47:49 +0800128 if "FPHARD" in config.extra_params:
129 # TF-M FPU feature requires GCC v10.3
130 compiler_version = "GCC_10_3"
131 else:
132 # Use GCC v7.3.1 by default
133 compiler_version = "GCC_7_3_1"
Xinyu Zhangff5d7712022-01-14 13:48:59 +0800134 # Set ARMClang version
135 elif "ARMCLANG" in config.toolchain_file:
136 # Use ARMClang v6.13 by default
137 compiler_version = "ARMCLANG_6_13"
138
139 return compiler_version
140
Dean Bircha6ede7e2020-03-13 14:00:33 +0000141 def get_config(self):
142 return list(self._tbm_build_cfg.keys())
Dean Birch5cb5a882020-01-24 11:37:13 +0000143
Dean Bircha6ede7e2020-03-13 14:00:33 +0000144 def print_config_environment(self, config, silence_stderr=False):
Dean Birch5cb5a882020-01-24 11:37:13 +0000145 """
146 For a given build configuration from output of print_config
147 method, print environment variables to build.
148 """
149 if config not in self._tbm_build_cfg:
Dean Bircha6ede7e2020-03-13 14:00:33 +0000150 if not silence_stderr:
151 print("Error: no such config {}".format(config), file=sys.stderr)
Dean Birch5cb5a882020-01-24 11:37:13 +0000152 sys.exit(1)
153 config_details = self._tbm_build_cfg[config]
154 argument_list = [
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000155 "CONFIG_NAME={}",
Xinyu Zhangb708f572020-09-15 11:43:46 +0800156 "TFM_PLATFORM={}",
157 "TOOLCHAIN_FILE={}",
Xinyu Zhangff5d7712022-01-14 13:48:59 +0800158 "COMPILER_VERSION={}",
Xinyu Zhang73ed2992021-09-15 11:38:23 +0800159 "LIB_MODEL={}",
Xinyu Zhangb708f572020-09-15 11:43:46 +0800160 "ISOLATION_LEVEL={}",
161 "TEST_REGRESSION={}",
162 "TEST_PSA_API={}",
Dean Birch5cb5a882020-01-24 11:37:13 +0000163 "CMAKE_BUILD_TYPE={}",
Xinyu Zhangb708f572020-09-15 11:43:46 +0800164 "OTP={}",
Dean Birch5cb5a882020-01-24 11:37:13 +0000165 "BL2={}",
Xinyu Zhangb708f572020-09-15 11:43:46 +0800166 "NS={}",
Xinyu Zhang9fd74242020-10-22 11:30:50 +0800167 "PROFILE={}",
Xinyu Zhang9bfe8a92021-10-28 16:27:12 +0800168 "PARTITION_PS={}",
Xinyu Zhangfd2e1152021-12-17 18:09:01 +0800169 "EXTRA_PARAMS={}"
Dean Birch5cb5a882020-01-24 11:37:13 +0000170 ]
171 print(
172 "\n".join(argument_list)
173 .format(
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000174 config,
Xinyu Zhangb708f572020-09-15 11:43:46 +0800175 config_details.tfm_platform,
176 config_details.toolchain_file,
Xinyu Zhangff5d7712022-01-14 13:48:59 +0800177 self.set_compiler_version(config_details),
Xinyu Zhang73ed2992021-09-15 11:38:23 +0800178 config_details.lib_model,
Xinyu Zhangb708f572020-09-15 11:43:46 +0800179 config_details.isolation_level,
180 config_details.test_regression,
181 config_details.test_psa_api,
Dean Birch5cb5a882020-01-24 11:37:13 +0000182 config_details.cmake_build_type,
Xinyu Zhangb708f572020-09-15 11:43:46 +0800183 config_details.with_otp,
184 config_details.with_bl2,
185 config_details.with_ns,
Xinyu Zhang9fd74242020-10-22 11:30:50 +0800186 "N.A" if not config_details.profile else config_details.profile,
Xinyu Zhang9bfe8a92021-10-28 16:27:12 +0800187 config_details.partition_ps,
Xinyu Zhangfd2e1152021-12-17 18:09:01 +0800188 "N.A" if not config_details.extra_params else config_details.extra_params,
Dean Birch5cb5a882020-01-24 11:37:13 +0000189 )
190 .strip()
191 )
192
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000193 def print_build_commands(self, config, silence_stderr=False):
194 config_details = self._tbm_build_cfg[config]
195 codebase_dir = os.path.join(os.getcwd(),"trusted-firmware-m")
Xinyu Zhangb708f572020-09-15 11:43:46 +0800196 build_dir=os.path.join(os.getcwd(),"trusted-firmware-m/build")
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000197 build_config = self.get_build_config(config_details, config, silence=silence_stderr, build_dir=build_dir, codebase_dir=codebase_dir)
Xinyu Zhang694eb492020-11-04 18:29:08 +0800198 build_commands = [build_config["config_template"]]
199 for command in build_config["build_cmds"]:
200 build_commands.append(command)
Xinyu Zhangb708f572020-09-15 11:43:46 +0800201 print(" ;\n".join(build_commands))
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000202
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100203 def pre_eval(self):
204 """ Tests that need to be run in set-up state """
205 return True
206
207 def pre_exec(self, eval_ret):
208 """ """
209
Minos Galanakisea421232019-06-20 17:11:28 +0100210 def override_tbm_cfg_params(self, config, override_keys, **params):
211 """ Using a dictionay as input, for each key defined in
212 override_keys it will replace the config[key] entries with
213 the key=value parameters provided """
214
215 for key in override_keys:
216 if isinstance(config[key], list):
217 config[key] = [n % params for n in config[key]]
218 elif isinstance(config[key], str):
219 config[key] = config[key] % params
220 else:
221 raise Exception("Config does not contain key %s "
222 "of type %s" % (key, config[key]))
223 return config
224
Karl Zhangaff558a2020-05-15 14:28:23 +0100225 def pre_build(self, build_cfg):
226 print("pre_build start %s \r\nself._tfb_cfg %s\r\n" %
227 (self, build_cfg))
228
229 try:
230 if self._tfb_code_base_updated:
231 print("Code base has been updated")
232 return True
233
234 self._tfb_code_base_updated = True
235
236 if "build_psa_api" in build_cfg:
237 # FF IPC build needs repo manifest update for TFM and PSA arch test
238 if "build_ff_ipc" in build_cfg:
239 print("Checkout to FF IPC code base")
240 os.chdir(build_cfg["codebase_root_dir"] + "/../psa-arch-tests/api-tests")
241 _api_test_manifest = "git checkout . ; python3 tools/scripts/manifest_update.py"
242 if subprocess_log(_api_test_manifest,
243 self._tfb_log_f,
244 append=True,
245 prefix=_api_test_manifest):
246
247 raise Exception("Python Failed please check log: %s" %
248 self._tfb_log_f)
249
250 _api_test_manifest_tfm = "python3 tools/tfm_parse_manifest_list.py -m tools/tfm_psa_ff_test_manifest_list.yaml append"
251 os.chdir(build_cfg["codebase_root_dir"])
252 if subprocess_log(_api_test_manifest_tfm,
253 self._tfb_log_f,
254 append=True,
255 prefix=_api_test_manifest_tfm):
256
257 raise Exception("Python TFM Failed please check log: %s" %
258 self._tfb_log_f)
259 return True
260
261 print("Checkout to default code base")
262 os.chdir(build_cfg["codebase_root_dir"] + "/../psa-arch-tests/api-tests")
263 _api_test_manifest = "git checkout ."
264 if subprocess_log(_api_test_manifest,
265 self._tfb_log_f,
266 append=True,
267 prefix=_api_test_manifest):
268
269 raise Exception("Python Failed please check log: %s" %
270 self._tfb_log_f)
271
272 _api_test_manifest_tfm = "python3 tools/tfm_parse_manifest_list.py"
273 os.chdir(build_cfg["codebase_root_dir"])
274 if subprocess_log(_api_test_manifest_tfm,
275 self._tfb_log_f,
276 append=True,
277 prefix=_api_test_manifest_tfm):
278
279 raise Exception("Python TFM Failed please check log: %s" %
280 self._tfb_log_f)
281 finally:
282 print("python pass after builder prepare")
283 os.chdir(build_cfg["codebase_root_dir"] + "/../")
284
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100285 def task_exec(self):
286 """ Create a build pool and execute them in parallel """
287
288 build_pool = []
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100289
Minos Galanakisea421232019-06-20 17:11:28 +0100290 # When a config is flagged as a single build config.
291 # Name is evaluated by config type
292 if self.simple_config:
293
294 build_cfg = deepcopy(self.tbm_common_cfg)
295
296 # Extract the common for all elements of config
297 for key in ["build_cmds", "required_artefacts"]:
298 try:
299 build_cfg[key] = build_cfg[key]["all"]
300 except KeyError:
301 build_cfg[key] = []
302 name = build_cfg["config_type"]
303
304 # Override _tbm_xxx paths in commands
305 # plafrom in not guaranteed without seeds so _tbm_target_platform
306 # is ignored
307 over_dict = {"_tbm_build_dir_": os.path.join(self._tbm_work_dir,
308 name),
309 "_tbm_code_dir_": build_cfg["codebase_root_dir"]}
310
311 build_cfg = self.override_tbm_cfg_params(build_cfg,
312 ["build_cmds",
313 "required_artefacts",
314 "artifact_capture_rex"],
315 **over_dict)
316
317 # Overrides path in expected artefacts
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100318 print("Loading config %s" % name)
Minos Galanakisea421232019-06-20 17:11:28 +0100319
320 build_pool.append(TFM_Builder(
321 name=name,
322 work_dir=self._tbm_work_dir,
323 cfg_dict=build_cfg,
324 build_threads=self._tbm_build_threads,
325 img_sizes=self._tbm_img_sizes,
326 relative_paths=self._tbm_relative_paths))
327 # When a seed pool is provided iterate through the entries
328 # and update platform spefific parameters
329 elif len(self._tbm_build_cfg):
Karl Zhangaff558a2020-05-15 14:28:23 +0100330 print("\r\n_tbm_build_cfg %s\r\n tbm_common_cfg %s\r\n" \
331 % (self._tbm_build_cfg, self.tbm_common_cfg))
Minos Galanakisea421232019-06-20 17:11:28 +0100332 for name, i in self._tbm_build_cfg.items():
333 # Do not modify the original config
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000334 build_cfg = self.get_build_config(i, name)
Karl Zhangaff558a2020-05-15 14:28:23 +0100335 self.pre_build(build_cfg)
Minos Galanakisea421232019-06-20 17:11:28 +0100336 # Overrides path in expected artefacts
337 print("Loading config %s" % name)
338
339 build_pool.append(TFM_Builder(
340 name=name,
341 work_dir=self._tbm_work_dir,
342 cfg_dict=build_cfg,
343 build_threads=self._tbm_build_threads,
344 img_sizes=self._tbm_img_sizes,
345 relative_paths=self._tbm_relative_paths))
346 else:
347 print("Could not find any configuration. Check the rejection list")
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100348
349 status_rep = {}
Minos Galanakisea421232019-06-20 17:11:28 +0100350 build_rep = {}
351 completed_build_count = 0
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100352 print("Build: Running %d parallel build jobs" % self._tbm_conc_builds)
353 for build_pool_slice in list_chunks(build_pool, self._tbm_conc_builds):
354
355 # Start the builds
356 for build in build_pool_slice:
357 # Only produce output for the first build
358 if build_pool_slice.index(build) != 0:
359 build.mute()
360 print("Build: Starting %s" % build.get_name())
361 build.start()
362
363 # Wait for the builds to complete
364 for build in build_pool_slice:
365 # Wait for build to finish
366 build.join()
367 # Similarly print the logs of the other builds as they complete
368 if build_pool_slice.index(build) != 0:
369 build.log()
Minos Galanakisea421232019-06-20 17:11:28 +0100370 completed_build_count += 1
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100371 print("Build: Finished %s" % build.get_name())
Minos Galanakisea421232019-06-20 17:11:28 +0100372 print("Build Progress:")
373 show_progress(completed_build_count, len(build_pool))
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100374
375 # Store status in report
376 status_rep[build.get_name()] = build.get_status()
Minos Galanakisea421232019-06-20 17:11:28 +0100377 build_rep[build.get_name()] = build.report()
378
379 # Include the original input configuration in the report
380
381 metadata = {"input_build_cfg": self._tbm_cfg,
382 "build_dir": self._tbm_work_dir
383 if not self._tbm_relative_paths
384 else resolve_rel_path(self._tbm_work_dir),
385 "time": time()}
386
387 full_rep = {"report": build_rep,
388 "_metadata_": metadata}
389
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100390 # Store the report
391 self.stash("Build Status", status_rep)
392 self.stash("Build Report", full_rep)
393
394 if self._tbm_report:
395 print("Exported build report to file:", self._tbm_report)
396 save_json(self._tbm_report, full_rep)
397
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000398 def get_build_config(self, i, name, silence=False, build_dir=None, codebase_dir=None):
399 psa_build_dir = self._tbm_work_dir + "/" + name + "/BUILD"
400 if not build_dir:
401 build_dir = os.path.join(self._tbm_work_dir, name)
402 else:
403 psa_build_dir = os.path.join(build_dir, "../../psa-arch-tests/api-tests/build")
404 build_cfg = deepcopy(self.tbm_common_cfg)
405 if not codebase_dir:
406 codebase_dir = build_cfg["codebase_root_dir"]
407 else:
408 # Would prefer to do all with the new variable
409 # However, many things use this from build_cfg elsewhere
410 build_cfg["codebase_root_dir"] = codebase_dir
411 # Extract the common for all elements of config
412 for key in ["build_cmds", "required_artefacts"]:
413 try:
414 build_cfg[key] = deepcopy(self.tbm_common_cfg[key]
415 ["all"])
416 except KeyError as E:
417 build_cfg[key] = []
418 # Extract the platform specific elements of config
419 for key in ["build_cmds", "required_artefacts"]:
420 try:
Xinyu Zhang694eb492020-11-04 18:29:08 +0800421 if i.tfm_platform in self.tbm_common_cfg[key].keys() and i.with_ns:
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000422 build_cfg[key] += deepcopy(self.tbm_common_cfg[key]
Xinyu Zhangb708f572020-09-15 11:43:46 +0800423 [i.tfm_platform])
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000424 except Exception as E:
425 pass
Karl Zhang1eed6322020-07-01 15:38:10 +0800426
427 if os.cpu_count() >= 8:
428 #run in a serviver with scripts, parallel build will use CPU numbers
429 thread_no = " -j 2"
430 else:
431 #run in a docker, usually docker with CPUs less than 8
432 thread_no = " -j " + str(os.cpu_count())
Xinyu Zhangb708f572020-09-15 11:43:46 +0800433 build_cfg["build_cmds"][0] += thread_no
434 overwrite_params = {"codebase_root_dir": build_cfg["codebase_root_dir"],
435 "tfm_platform": i.tfm_platform,
436 "toolchain_file": i.toolchain_file,
Xinyu Zhang73ed2992021-09-15 11:38:23 +0800437 "lib_model": i.lib_model,
Xinyu Zhangb708f572020-09-15 11:43:46 +0800438 "isolation_level": i.isolation_level,
439 "test_regression": i.test_regression,
440 "test_psa_api": i.test_psa_api,
441 "cmake_build_type": i.cmake_build_type,
442 "with_otp": i.with_otp,
443 "with_bl2": i.with_bl2,
444 "with_ns": i.with_ns,
Xinyu Zhang9fd74242020-10-22 11:30:50 +0800445 "profile": "" if i.profile=="N.A" else i.profile,
Xinyu Zhang9bfe8a92021-10-28 16:27:12 +0800446 "partition_ps": i.partition_ps,
Xinyu Zhangfd2e1152021-12-17 18:09:01 +0800447 "extra_params": mapExtraParams[i.extra_params]}
Xinyu Zhanga0086022020-11-10 18:11:12 +0800448 if i.test_psa_api == "IPC":
Xinyu Zhangcd1ed962020-11-11 16:00:52 +0800449 overwrite_params["test_psa_api"] += " -DINCLUDE_PANIC_TESTS=1"
Xinyu Zhang8cee3312021-11-12 11:06:39 +0800450 if i.tfm_platform == "arm/musca_b1/sse_200":
451 overwrite_params["test_psa_api"] += " -DITS_RAM_FS=ON -DPS_RAM_FS=ON"
Feder Liang357b1602022-01-11 16:47:49 +0800452 if i.extra_params == "FPHARD" or i.extra_params == "FPHARD_LOFF":
Feder Liang567e8c22021-10-26 14:16:21 +0800453 overwrite_params["test_psa_api"] += " -DTEST_S_FPU=ON -DTEST_NS_FPU=ON"
Xinyu Zhangb708f572020-09-15 11:43:46 +0800454 build_cfg["config_template"] %= overwrite_params
Xinyu Zhang694eb492020-11-04 18:29:08 +0800455 if len(build_cfg["build_cmds"]) > 1:
456 overwrite_build_dir = {"_tbm_build_dir_": build_dir}
457 build_cfg["build_cmds"][1] %= overwrite_build_dir
Dean Birchd0f9f8c2020-03-26 11:10:33 +0000458 return build_cfg
459
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100460 def post_eval(self):
461 """ If a single build failed fail the test """
462 try:
Minos Galanakisea421232019-06-20 17:11:28 +0100463 status_dict = self.unstash("Build Status")
464 if not status_dict:
465 raise Exception()
466 retcode_sum = sum(status_dict.values())
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100467 if retcode_sum != 0:
468 raise Exception()
469 return True
470 except Exception as e:
471 return False
472
473 def post_exec(self, eval_ret):
474 """ Generate a report and fail the script if build == unsuccessfull"""
475
476 self.print_summary()
477 if not eval_ret:
478 print("ERROR: ====> Build Failed! %s" % self.get_name())
479 self.set_status(1)
480 else:
481 print("SUCCESS: ====> Build Complete!")
482 self.set_status(0)
483
484 def get_report(self):
485 """ Expose the internal report to a new object for external classes """
486 return deepcopy(self.unstash("Build Report"))
487
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100488 def load_config(self, config, work_dir):
489 try:
490 # passing config_name param supersseeds fileparam
491 if isinstance(config, dict):
492 ret_cfg = deepcopy(config)
493 elif isinstance(config, str):
494 # If the string does not descrive a file try to look for it in
495 # work directory
496 if not os.path.isfile(config):
497 # remove path from file
498 config_2 = os.path.split(config)[-1]
499 # look in the current working directory
500 config_2 = os.path.join(work_dir, config_2)
501 if not os.path.isfile(config_2):
502 m = "Could not find cfg in %s or %s " % (config,
503 config_2)
504 raise Exception(m)
505 # If fille exists in working directory
506 else:
507 config = config_2
508 ret_cfg = load_json(config)
509
510 else:
511 raise Exception("Need to provide a valid config name or file."
512 "Please use --config/--config-file parameter.")
513 except Exception as e:
514 print("Error:%s \nCould not load a valid config" % e)
515 sys.exit(1)
516
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100517 return ret_cfg
518
519 def parse_config(self, cfg):
520 """ Parse a valid configuration file into a set of build dicts """
521
Minos Galanakisea421232019-06-20 17:11:28 +0100522 ret_cfg = {}
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100523
Minos Galanakisea421232019-06-20 17:11:28 +0100524 # Config entries which are not subject to changes during combinations
525 static_cfg = cfg["common_params"]
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100526
Minos Galanakisea421232019-06-20 17:11:28 +0100527 # Converth the code path to absolute path
528 abs_code_dir = static_cfg["codebase_root_dir"]
529 abs_code_dir = os.path.abspath(os.path.expanduser(abs_code_dir))
530 static_cfg["codebase_root_dir"] = abs_code_dir
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100531
Minos Galanakisea421232019-06-20 17:11:28 +0100532 # seed_params is an optional field. Do not proccess if it is missing
533 if "seed_params" in cfg:
534 comb_cfg = cfg["seed_params"]
535 # Generate a list of all possible confugration combinations
536 ret_cfg = TFM_Build_Manager.generate_config_list(comb_cfg,
537 static_cfg)
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100538
Xinyu Zhang2c63ce72021-07-23 14:01:59 +0800539 # valid is an optional field. Do not proccess if it is missing
540 if "valid" in cfg:
541 # Valid configurations(Need to build)
542 valid_cfg = cfg["valid"]
543 # Add valid configs to build list
544 ret_cfg.update(TFM_Build_Manager.generate_optional_list(
545 comb_cfg,
546 static_cfg,
547 valid_cfg))
548
Minos Galanakisea421232019-06-20 17:11:28 +0100549 # invalid is an optional field. Do not proccess if it is missing
550 if "invalid" in cfg:
551 # Invalid configurations(Do not build)
552 invalid_cfg = cfg["invalid"]
553 # Remove the rejected entries from the test list
Xinyu Zhang0581b082021-05-17 10:46:57 +0800554 rejection_cfg = TFM_Build_Manager.generate_optional_list(
Minos Galanakisea421232019-06-20 17:11:28 +0100555 comb_cfg,
556 static_cfg,
557 invalid_cfg)
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100558
Minos Galanakisea421232019-06-20 17:11:28 +0100559 # Subtract the two configurations
560 ret_cfg = {k: v for k, v in ret_cfg.items()
561 if k not in rejection_cfg}
562 self.simple_config = False
563 else:
564 self.simple_config = True
565 return ret_cfg, static_cfg
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100566
Minos Galanakisea421232019-06-20 17:11:28 +0100567 # ----- Override bellow methods when subclassing for other projects ----- #
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100568
Minos Galanakisea421232019-06-20 17:11:28 +0100569 def print_summary(self):
570 """ Print an comprehensive list of the build jobs with their status """
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100571
Minos Galanakisea421232019-06-20 17:11:28 +0100572 try:
573 full_rep = self.unstash("Build Report")["report"]
574 fl = ([k for k, v in full_rep.items() if v['status'] == 'Failed'])
575 ps = ([k for k, v in full_rep.items() if v['status'] == 'Success'])
576 except Exception as E:
Karl Zhangaff558a2020-05-15 14:28:23 +0100577 print("No report generated", E)
Minos Galanakisea421232019-06-20 17:11:28 +0100578 return
579 if fl:
580 print_test(t_list=fl, status="failed", tname="Builds")
581 if ps:
582 print_test(t_list=ps, status="passed", tname="Builds")
Minos Galanakisf4ca6ac2017-12-11 02:39:21 +0100583
Minos Galanakisea421232019-06-20 17:11:28 +0100584 @staticmethod
585 def generate_config_list(seed_config, static_config):
586 """ Generate all possible configuration combinations from a group of
587 lists of compiler options"""
588 config_list = []
589
590 if static_config["config_type"] == "tf-m":
591 cfg_name = "TFM_Build_CFG"
592 # Ensure the fieds are sorted in the desired order
593 # seed_config can be a subset of sort order for configurations with
594 # optional parameters.
595 tags = [n for n in static_config["sort_order"]
596 if n in seed_config.keys()]
Karl Zhangaff558a2020-05-15 14:28:23 +0100597 print("!!!!!!!!!!!gen list %s\r\n" % tags)
Minos Galanakisea421232019-06-20 17:11:28 +0100598
599 data = []
600 for key in tags:
601 data.append(seed_config[key])
602 config_list = gen_cfg_combinations(cfg_name,
603 " ".join(tags),
604 *data)
605 else:
606 print("Not information for project type: %s."
607 " Please check config" % static_config["config_type"])
608
609 ret_cfg = {}
610 # Notify the user for the rejected configuations
611 for i in config_list:
Xinyu Zhang1078e812020-10-15 11:52:36 +0800612 # Convert named tuples to string in a brief format
613 config_param = []
614 config_param.append(mapPlatform[list(i)[0]])
615 config_param.append(mapCompiler[list(i)[1]])
Xinyu Zhang73ed2992021-09-15 11:38:23 +0800616 if list(i)[2]: # LIB_MODEL
617 config_param.append("LIB")
618 else:
619 config_param.append("IPC")
Xinyu Zhang1078e812020-10-15 11:52:36 +0800620 config_param.append(list(i)[3]) # ISOLATION_LEVEL
621 if list(i)[4]: # TEST_REGRESSION
622 config_param.append("REG")
623 if list(i)[5] != "OFF": #TEST_PSA_API
624 config_param.append(mapTestPsaApi[list(i)[5]])
625 config_param.append(list(i)[6]) # BUILD_TYPE
Xinyu Zhanga50432e2020-10-23 18:00:18 +0800626 if list(i)[7] == "ENABLED": # OTP
Xinyu Zhang1078e812020-10-15 11:52:36 +0800627 config_param.append("OTP")
628 if list(i)[8]: # BL2
629 config_param.append("BL2")
630 if list(i)[9]: # NS
631 config_param.append("NS")
632 if list(i)[10]: # PROFILE
633 config_param.append(mapProfile[list(i)[10]])
Xinyu Zhang9fd74242020-10-22 11:30:50 +0800634 if list(i)[11] == "OFF": #PARTITION_PS
635 config_param.append("PSOFF")
Feder Liang357b1602022-01-11 16:47:49 +0800636 if list(i)[12]: # EXTRA_PARAMS
637 config_param.append(list(i)[12])
Xinyu Zhang1078e812020-10-15 11:52:36 +0800638 i_str = "_".join(config_param)
Karl Zhangaff558a2020-05-15 14:28:23 +0100639 ret_cfg[i_str] = i
Minos Galanakisea421232019-06-20 17:11:28 +0100640 return ret_cfg
641
642 @staticmethod
Xinyu Zhang0581b082021-05-17 10:46:57 +0800643 def generate_optional_list(seed_config,
644 static_config,
645 optional_list):
646 optional_cfg = {}
Minos Galanakisea421232019-06-20 17:11:28 +0100647
648 if static_config["config_type"] == "tf-m":
649
Xinyu Zhang0581b082021-05-17 10:46:57 +0800650 # If optional list is empty do nothing
651 if not optional_list:
652 return optional_cfg
Minos Galanakisea421232019-06-20 17:11:28 +0100653
654 tags = [n for n in static_config["sort_order"]
655 if n in seed_config.keys()]
656 sorted_default_lst = [seed_config[k] for k in tags]
657
Xinyu Zhang0581b082021-05-17 10:46:57 +0800658 # If tags are not alligned with optional list entries quit
659 if len(tags) != len(optional_list[0]):
660 print(len(tags), len(optional_list[0]))
Minos Galanakisea421232019-06-20 17:11:28 +0100661 print("Error, tags should be assigned to each "
Xinyu Zhang0581b082021-05-17 10:46:57 +0800662 "of the optional inputs")
Minos Galanakisea421232019-06-20 17:11:28 +0100663 return []
664
665 # Replace wildcard ( "*") entries with every
666 # inluded in cfg variant
Xinyu Zhang0581b082021-05-17 10:46:57 +0800667 for k in optional_list:
Minos Galanakisea421232019-06-20 17:11:28 +0100668 # Pad the omitted values with wildcard char *
669 res_list = list(k) + ["*"] * (5 - len(k))
Xinyu Zhang0581b082021-05-17 10:46:57 +0800670 print("Working on optional input: %s" % (res_list))
Minos Galanakisea421232019-06-20 17:11:28 +0100671
672 for n in range(len(res_list)):
673
674 res_list[n] = [res_list[n]] if res_list[n] != "*" \
675 else sorted_default_lst[n]
676
677 # Generate a configuration and a name for the completed array
Xinyu Zhang0581b082021-05-17 10:46:57 +0800678 op_cfg = TFM_Build_Manager.generate_config_list(
Minos Galanakisea421232019-06-20 17:11:28 +0100679 dict(zip(tags, res_list)),
680 static_config)
681
682 # Append the configuration to the existing ones
Xinyu Zhang0581b082021-05-17 10:46:57 +0800683 optional_cfg = dict(optional_cfg, **op_cfg)
Minos Galanakisea421232019-06-20 17:11:28 +0100684
Xinyu Zhang0581b082021-05-17 10:46:57 +0800685 # Notify the user for the optional configuations
686 for i in optional_cfg.keys():
687 print("Generating optional config %s" % i)
Minos Galanakisea421232019-06-20 17:11:28 +0100688 else:
689 print("Not information for project type: %s."
690 " Please check config" % static_config["config_type"])
Xinyu Zhang0581b082021-05-17 10:46:57 +0800691 return optional_cfg