-
Notifications
You must be signed in to change notification settings - Fork 25
/
test_qemu_fw.py
executable file
·216 lines (186 loc) · 7.95 KB
/
test_qemu_fw.py
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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import argparse
import os
import re
import sys
import zipfile
import logging
import tempfile
import shutil
import pexpect
OCBUILD_PATH = os.path.dirname(os.path.realpath(__file__))
TEST_LINUX_PATH = f"{OCBUILD_PATH}/TestLinux"
TEST_WINPE_PATH = f"{OCBUILD_PATH}/winpe.iso"
TESTCONSOLE_PATH = f"{OCBUILD_PATH}/TestConsole"
def get_qemu_version() -> tuple:
"""
Get QEMU version in system
:return version tuple (major, minor, patch):
"""
version = None
p = pexpect.spawn('qemu-system-x86_64 -version')
p.expect(pexpect.EOF)
output = p.before.decode('utf-8')
version_pattern = re.compile("(\\d+\\.)(\\d+\\.)(\\*|\\d+)")
collection = version_pattern.findall(output)
if collection:
version = tuple(int(el.strip('.')) for el in collection[0])
return version
def test_firmware(fw_path: str, boot_drive_path: str, expected_string: str, timeout: int, rdrand: bool, smap: bool, fw_arch: str) -> bool:
"""
Run QEMU and check whether firmware can start given image
:param fw_path: The path points to the firmware to run (OVMF)
:param boot_drive_path: The path points to ESP or raw image to boot from
:param expected_string: The expected string we wait for during image run
:param timeout: Timeout for image run
:param rdrand: Run with rdrand support or not
:param smap: Run with SMAP support or not
:return the boolean result:
"""
result = False
qemu_version = get_qemu_version()
if qemu_version is None:
logging.error("Can't retrieve QEMU version!")
return False
qemu_x86_runner = f"qemu-system-x86_64 {'-enable-kvm ' if qemu_version < (6, 2, 0) else ''}"
qemu_arm_runner = 'qemu-system-arm '
qemu_arm64_runner = 'qemu-system-aarch64 '
machine_string_x86 = f" -cpu Penryn,+smep{',+smap' if smap else ''}{',+rdrand' if rdrand else ''} -smp 2 -machine q35 -m 2048 "
machine_string_arm = ' -cpu cortex-a15 -smp 2 -machine virt,highmem=off ' \
' -accel tcg,tb-size=1024 -m 2048 '
machine_string_arm64 = ' -cpu cortex-a76 -smp 2 -machine virt,virtualization=on ' \
'-accel tcg,tb-size=1024 -m 2048 '
if fw_arch == "x86":
p = pexpect.spawn(qemu_x86_runner + machine_string_x86 +
'-bios ' + fw_path + ' -display none -serial stdio '
+ boot_drive_path)
elif fw_arch == "arm":
p = pexpect.spawn(qemu_arm_runner + machine_string_arm +
'-bios ' + fw_path + ' -display none -serial stdio '
+ boot_drive_path)
elif fw_arch == "arm64":
p = pexpect.spawn(qemu_arm64_runner + machine_string_arm64 +
'-bios ' + fw_path + ' -display none -serial stdio '
+ boot_drive_path)
else:
logging.error("Unsupported arch specified!")
return False
p.timeout = timeout
res = p.expect([expected_string, pexpect.TIMEOUT])
if res == 0:
print("OK")
result = True
else:
logging.error("Timeout! Something went wrong, check log below")
try:
error_log = p.before.decode()
except UnicodeDecodeError:
error_log = p.before
logging.error("Process output before timeout:\n %s", error_log)
return result
def prepare_test_console(esp_path: str) -> bool:
"""
Prepares ESP folder with TestConsole application
:param esp_path: The path points to ESP folder
:return the boolean result:
"""
if not os.path.exists(esp_path):
# Unpack TestConsole
print("Preparing ESP with TestConsole")
try:
with zipfile.ZipFile(f'{OCBUILD_PATH}/external/TestConsole.zip', 'r') as zip_ref:
zip_ref.extractall(esp_path)
except Exception as e:
logging.error("%s", e)
return False
return True
def prepare_test_linux_image(esp_path: str) -> bool:
"""
Prepares ESP folder with tiny linux kernel with efistub and W^X patches
It prints Hello World and gives simple shell /bin/sh
:param esp_path: The path points to ESP folder
:return the boolean result:
"""
if not os.path.exists(esp_path):
# Unpack TestLinux
print("Preparing ESP with TestLinux")
try:
with zipfile.ZipFile(f'{OCBUILD_PATH}/external/TestLinux.zip', 'r') as zip_ref:
zip_ref.extractall(esp_path)
except Exception as e:
logging.error("%s", e)
return False
return True
def parse_fw_arch(fw_arch: str) -> str:
if fw_arch in ['i386', 'x86', 'IA32', 'Ia32', 'X64', 'x64', 'x86_64', 'X86', '3264']:
return 'x86'
if fw_arch in ['arm', 'arm32', 'aarch32', 'AARCH32', 'ARM']:
return 'arm'
if fw_arch in ['AARCH64', 'aarch64', 'arm64', 'ARM64', 'AA64', 'aa64']:
return 'arm64'
return "Unknown"
def main():
""" The QEMU-based firmware checker """
parser = argparse.ArgumentParser(description='Run QEMU and determine whether firmware can start bootloader.')
parser.add_argument('fw_path', type=str, help='Path to firmware.')
parser.add_argument('--no-rdrand', dest='rdrand', action='store_false')
parser.add_argument('--test-console-path', dest='user_testconsole_path', action='store')
parser.add_argument('--test-linux-path', dest='user_testlinux_path', action='store')
parser.add_argument('--test-linux', dest='test_linux', action='store_true')
parser.add_argument('--test-winpe-path', dest='user_testwinpe_path', action='store')
parser.add_argument('--test-winpe', dest='test_winpe', action='store_true')
parser.add_argument('--fw-arch', dest='fw_arch', action='store')
parser.set_defaults(rdrand=True)
parser.set_defaults(test_linux=False)
parser.set_defaults(test_winpe=False)
parser.set_defaults(fw_arch="x86")
pexpect_timeout = 60 # default 30
testconsole_path = TESTCONSOLE_PATH
testlinux_path = TEST_LINUX_PATH
testwinpe_path = TEST_WINPE_PATH
args = parser.parse_args()
logging.basicConfig(
format="%(asctime)-15s [%(levelname)s] %(funcName)s: %(message)s",
level=logging.INFO)
fw_arch = parse_fw_arch(args.fw_arch)
if not args.test_linux and args.user_testlinux_path:
parser.error("--test-linux-path requires --test-linux")
if args.test_linux and args.test_winpe:
parser.error("you can't specify both --test-linux and --test-winpe simultaneously")
if args.user_testlinux_path is not None:
testlinux_path = args.user_testlinux_path
elif args.user_testconsole_path is not None:
testconsole_path = args.user_testconsole_path
elif args.user_testwinpe_path is not None:
testwinpe_path = args.user_testwinpe_path
# Use a temporary directory for the ESP to combat NvVars mixing and QEMU
# host directory corruption.
with tempfile.TemporaryDirectory() as temp_dir:
esp_dir = os.path.join(temp_dir, 'ESP')
boot_drive = '-drive format=raw,file=fat:rw:' + esp_dir
smap = True
if args.test_linux:
if not prepare_test_linux_image(testlinux_path):
sys.exit(1)
shutil.copytree(testlinux_path, esp_dir)
expected_string = 'Hello World!'
pexpect_timeout = 180
elif args.test_winpe:
os.makedirs(esp_dir)
boot_drive = ' -cdrom ' + testwinpe_path
expected_string = 'EVENT: The CMD command is now available'
pexpect_timeout = 600
smap = False
else:
if not prepare_test_console(testconsole_path):
sys.exit(1)
shutil.copytree(testconsole_path, esp_dir)
expected_string = 'GPT entry is not accessible'
print("Testing ...")
if test_firmware(args.fw_path, boot_drive, expected_string, pexpect_timeout, args.rdrand, smap, fw_arch):
sys.exit(0)
else:
sys.exit(1)
if __name__ == '__main__':
main()