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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Module for Corstone based FVPs.
The import of subprocess module raises a B404 bandit error. MLIA usage of
subprocess is needed and can be considered safe hence disabling the security
check.
"""
from __future__ import annotations
import logging
import platform
import subprocess # nosec
import tarfile
from dataclasses import dataclass
from pathlib import Path
from typing import Callable
from typing import Iterable
from typing import Optional
import mlia.backend.manager as backend_manager
from mlia.tools.metadata.common import DownloadAndInstall
from mlia.tools.metadata.common import Installation
from mlia.tools.metadata.common import InstallationType
from mlia.tools.metadata.common import InstallFromPath
from mlia.utils.download import DownloadArtifact
from mlia.utils.filesystem import all_files_exist
from mlia.utils.filesystem import all_paths_valid
from mlia.utils.filesystem import copy_all
from mlia.utils.filesystem import get_mlia_resources
from mlia.utils.filesystem import temp_directory
from mlia.utils.filesystem import working_directory
logger = logging.getLogger(__name__)
@dataclass
class BackendInfo:
"""Backend information."""
backend_path: Path
copy_source: bool = True
system_config: str | None = None
PathChecker = Callable[[Path], Optional[BackendInfo]]
BackendInstaller = Callable[[bool, Path], Path]
class BackendMetadata:
"""Backend installation metadata."""
def __init__(
self,
name: str,
description: str,
system_config: str,
apps_resources: list[str],
fvp_dir_name: str,
download_artifact: DownloadArtifact | None,
supported_platforms: list[str] | None = None,
) -> None:
"""
Initialize BackendMetadata.
Members expected_systems and expected_apps are filled automatically.
"""
self.name = name
self.description = description
self.system_config = system_config
self.apps_resources = apps_resources
self.fvp_dir_name = fvp_dir_name
self.download_artifact = download_artifact
self.supported_platforms = supported_platforms
self.expected_systems = backend_manager.get_all_system_names(name)
self.expected_apps = backend_manager.get_all_application_names(name)
@property
def expected_resources(self) -> Iterable[Path]:
"""Return list of expected resources."""
resources = [self.system_config, *self.apps_resources]
return (get_mlia_resources() / resource for resource in resources)
@property
def supported_platform(self) -> bool:
"""Return true if current platform supported."""
if not self.supported_platforms:
return True
return platform.system() in self.supported_platforms
class BackendInstallation(Installation):
"""Backend installation."""
def __init__(
self,
backend_runner: backend_manager.BackendRunner,
metadata: BackendMetadata,
path_checker: PathChecker,
backend_installer: BackendInstaller | None,
) -> None:
"""Init the backend installation."""
self.backend_runner = backend_runner
self.metadata = metadata
self.path_checker = path_checker
self.backend_installer = backend_installer
@property
def name(self) -> str:
"""Return name of the backend."""
return self.metadata.name
@property
def description(self) -> str:
"""Return description of the backend."""
return self.metadata.description
@property
def already_installed(self) -> bool:
"""Return true if backend already installed."""
return self.backend_runner.all_installed(
self.metadata.expected_systems, self.metadata.expected_apps
)
@property
def could_be_installed(self) -> bool:
"""Return true if backend could be installed."""
if not self.metadata.supported_platform:
return False
return all_paths_valid(self.metadata.expected_resources)
def supports(self, install_type: InstallationType) -> bool:
"""Return true if backends supported type of the installation."""
if isinstance(install_type, DownloadAndInstall):
return self.metadata.download_artifact is not None
if isinstance(install_type, InstallFromPath):
return self.path_checker(install_type.backend_path) is not None
return False # type: ignore
def install(self, install_type: InstallationType) -> None:
"""Install the backend."""
if isinstance(install_type, DownloadAndInstall):
download_artifact = self.metadata.download_artifact
assert download_artifact is not None, "No artifact provided"
self.download_and_install(download_artifact, install_type.eula_agreement)
elif isinstance(install_type, InstallFromPath):
backend_path = self.path_checker(install_type.backend_path)
assert backend_path is not None, "Unable to resolve backend path"
self.install_from(backend_path)
else:
raise Exception(f"Unable to install {install_type}")
def install_from(self, backend_info: BackendInfo) -> None:
"""Install backend from the directory."""
mlia_resources = get_mlia_resources()
with temp_directory() as tmpdir:
fvp_dist_dir = tmpdir / self.metadata.fvp_dir_name
system_config = self.metadata.system_config
if backend_info.system_config:
system_config = backend_info.system_config
resources_to_copy = [mlia_resources / system_config]
if backend_info.copy_source:
resources_to_copy.append(backend_info.backend_path)
copy_all(*resources_to_copy, dest=fvp_dist_dir)
self.backend_runner.install_system(fvp_dist_dir)
for app in self.metadata.apps_resources:
self.backend_runner.install_application(mlia_resources / app)
def download_and_install(
self, download_artifact: DownloadArtifact, eula_agrement: bool
) -> None:
"""Download and install the backend."""
with temp_directory() as tmpdir:
try:
downloaded_to = download_artifact.download_to(tmpdir)
except Exception as err:
raise Exception("Unable to download backend artifact") from err
with working_directory(tmpdir / "dist", create_dir=True) as dist_dir:
with tarfile.open(downloaded_to) as archive:
archive.extractall(dist_dir)
assert self.backend_installer, (
f"Backend '{self.metadata.name}' does not support "
"download and installation."
)
backend_path = self.backend_installer(eula_agrement, dist_dir)
if self.path_checker(backend_path) is None:
raise Exception("Downloaded artifact has invalid structure")
self.install(InstallFromPath(backend_path))
class PackagePathChecker:
"""Package path checker."""
def __init__(
self, expected_files: list[str], backend_subfolder: str | None = None
) -> None:
"""Init the path checker."""
self.expected_files = expected_files
self.backend_subfolder = backend_subfolder
def __call__(self, backend_path: Path) -> BackendInfo | None:
"""Check if directory contains all expected files."""
resolved_paths = (backend_path / file for file in self.expected_files)
if not all_files_exist(resolved_paths):
return None
if self.backend_subfolder:
subfolder = backend_path / self.backend_subfolder
if not subfolder.is_dir():
return None
return BackendInfo(subfolder)
return BackendInfo(backend_path)
class StaticPathChecker:
"""Static path checker."""
def __init__(
self,
static_backend_path: Path,
expected_files: list[str],
copy_source: bool = False,
system_config: str | None = None,
) -> None:
"""Init static path checker."""
self.static_backend_path = static_backend_path
self.expected_files = expected_files
self.copy_source = copy_source
self.system_config = system_config
def __call__(self, backend_path: Path) -> BackendInfo | None:
"""Check if directory equals static backend path with all expected files."""
if backend_path != self.static_backend_path:
return None
resolved_paths = (backend_path / file for file in self.expected_files)
if not all_files_exist(resolved_paths):
return None
return BackendInfo(
backend_path,
copy_source=self.copy_source,
system_config=self.system_config,
)
class CompoundPathChecker:
"""Compound path checker."""
def __init__(self, *path_checkers: PathChecker) -> None:
"""Init compound path checker."""
self.path_checkers = path_checkers
def __call__(self, backend_path: Path) -> BackendInfo | None:
"""Iterate over checkers and return first non empty backend info."""
first_resolved_backend_info = (
backend_info
for path_checker in self.path_checkers
if (backend_info := path_checker(backend_path)) is not None
)
return next(first_resolved_backend_info, None)
class Corstone300Installer:
"""Helper class that wraps Corstone 300 installation logic."""
def __call__(self, eula_agreement: bool, dist_dir: Path) -> Path:
"""Install Corstone-300 and return path to the models."""
with working_directory(dist_dir):
install_dir = "corstone-300"
try:
fvp_install_cmd = [
"./FVP_Corstone_SSE-300.sh",
"-q",
"-d",
install_dir,
]
if not eula_agreement:
fvp_install_cmd += [
"--nointeractive",
"--i-agree-to-the-contained-eula",
]
# The following line raises a B603 error for bandit. In this
# specific case, the input is pretty much static and cannot be
# changed byt the user hence disabling the security check for
# this instance
subprocess.check_call(fvp_install_cmd) # nosec
except subprocess.CalledProcessError as err:
raise Exception(
"Error occurred during Corstone-300 installation"
) from err
return dist_dir / install_dir
def get_corstone_300_installation() -> Installation:
"""Get Corstone-300 installation."""
corstone_300 = BackendInstallation(
backend_runner=backend_manager.BackendRunner(),
# pylint: disable=line-too-long
metadata=BackendMetadata(
name="Corstone-300",
description="Corstone-300 FVP",
system_config="backend_configs/systems/corstone-300/backend-config.json",
apps_resources=[],
fvp_dir_name="corstone_300",
download_artifact=DownloadArtifact(
name="Corstone-300 FVP",
url="https://developer.arm.com/-/media/Arm%20Developer%20Community/Downloads/OSS/FVP/Corstone-300/FVP_Corstone_SSE-300_11.16_26.tgz",
filename="FVP_Corstone_SSE-300_11.16_26.tgz",
version="11.16_26",
sha256_hash="e26139be756b5003a30d978c629de638aed1934d597dc24a17043d4708e934d7",
),
supported_platforms=["Linux"],
),
# pylint: enable=line-too-long
path_checker=CompoundPathChecker(
PackagePathChecker(
expected_files=[
"models/Linux64_GCC-6.4/FVP_Corstone_SSE-300_Ethos-U55",
"models/Linux64_GCC-6.4/FVP_Corstone_SSE-300_Ethos-U65",
],
backend_subfolder="models/Linux64_GCC-6.4",
),
StaticPathChecker(
static_backend_path=Path("/opt/VHT"),
expected_files=[
"VHT_Corstone_SSE-300_Ethos-U55",
"VHT_Corstone_SSE-300_Ethos-U65",
],
copy_source=False,
system_config=(
"backend_configs/systems/corstone-300-vht/backend-config.json"
),
),
),
backend_installer=Corstone300Installer(),
)
return corstone_300
def get_corstone_310_installation() -> Installation:
"""Get Corstone-310 installation."""
corstone_310 = BackendInstallation(
backend_runner=backend_manager.BackendRunner(),
# pylint: disable=line-too-long
metadata=BackendMetadata(
name="Corstone-310",
description="Corstone-310 FVP",
system_config="backend_configs/systems/corstone-310/backend-config.json",
apps_resources=[],
fvp_dir_name="corstone_310",
download_artifact=None,
supported_platforms=["Linux"],
),
# pylint: enable=line-too-long
path_checker=CompoundPathChecker(
PackagePathChecker(
expected_files=[
"models/Linux64_GCC-9.3/FVP_Corstone_SSE-310",
"models/Linux64_GCC-9.3/FVP_Corstone_SSE-310_Ethos-U65",
],
backend_subfolder="models/Linux64_GCC-9.3",
),
StaticPathChecker(
static_backend_path=Path("/opt/VHT"),
expected_files=[
"VHT_Corstone_SSE-310",
"VHT_Corstone_SSE-310_Ethos-U65",
],
copy_source=False,
system_config=(
"backend_configs/systems/corstone-310-vht/backend-config.json"
),
),
),
backend_installer=None,
)
return corstone_310
def get_corstone_installations() -> list[Installation]:
"""Get Corstone installations."""
return [
get_corstone_300_installation(),
get_corstone_310_installation(),
]
|