Loading...
1# SPDX-License-Identifier: GPL-2.0
2#
3# Runs UML kernel, collects output, and handles errors.
4#
5# Copyright (C) 2019, Google LLC.
6# Author: Felix Guo <felixguoxiuping@gmail.com>
7# Author: Brendan Higgins <brendanhiggins@google.com>
8
9import importlib.abc
10import importlib.util
11import logging
12import subprocess
13import os
14import shlex
15import shutil
16import signal
17import threading
18from typing import Iterator, List, Optional, Tuple
19from types import FrameType
20
21import kunit_config
22import qemu_config
23
24KCONFIG_PATH = '.config'
25KUNITCONFIG_PATH = '.kunitconfig'
26OLD_KUNITCONFIG_PATH = 'last_used_kunitconfig'
27DEFAULT_KUNITCONFIG_PATH = 'tools/testing/kunit/configs/default.config'
28ALL_TESTS_CONFIG_PATH = 'tools/testing/kunit/configs/all_tests.config'
29UML_KCONFIG_PATH = 'tools/testing/kunit/configs/arch_uml.config'
30OUTFILE_PATH = 'test.log'
31ABS_TOOL_PATH = os.path.abspath(os.path.dirname(__file__))
32QEMU_CONFIGS_DIR = os.path.join(ABS_TOOL_PATH, 'qemu_configs')
33
34class ConfigError(Exception):
35 """Represents an error trying to configure the Linux kernel."""
36
37
38class BuildError(Exception):
39 """Represents an error trying to build the Linux kernel."""
40
41
42class LinuxSourceTreeOperations:
43 """An abstraction over command line operations performed on a source tree."""
44
45 def __init__(self, linux_arch: str, cross_compile: Optional[str]):
46 self._linux_arch = linux_arch
47 self._cross_compile = cross_compile
48
49 def make_mrproper(self) -> None:
50 try:
51 subprocess.check_output(['make', 'mrproper'], stderr=subprocess.STDOUT)
52 except OSError as e:
53 raise ConfigError('Could not call make command: ' + str(e))
54 except subprocess.CalledProcessError as e:
55 raise ConfigError(e.output.decode())
56
57 def make_arch_config(self, base_kunitconfig: kunit_config.Kconfig) -> kunit_config.Kconfig:
58 return base_kunitconfig
59
60 def make_olddefconfig(self, build_dir: str, make_options: Optional[List[str]]) -> None:
61 command = ['make', 'ARCH=' + self._linux_arch, 'O=' + build_dir, 'olddefconfig']
62 if self._cross_compile:
63 command += ['CROSS_COMPILE=' + self._cross_compile]
64 if make_options:
65 command.extend(make_options)
66 print('Populating config with:\n$', ' '.join(command))
67 try:
68 subprocess.check_output(command, stderr=subprocess.STDOUT)
69 except OSError as e:
70 raise ConfigError('Could not call make command: ' + str(e))
71 except subprocess.CalledProcessError as e:
72 raise ConfigError(e.output.decode())
73
74 def make(self, jobs: int, build_dir: str, make_options: Optional[List[str]]) -> None:
75 command = ['make', 'ARCH=' + self._linux_arch, 'O=' + build_dir, '--jobs=' + str(jobs)]
76 if make_options:
77 command.extend(make_options)
78 if self._cross_compile:
79 command += ['CROSS_COMPILE=' + self._cross_compile]
80 print('Building with:\n$', ' '.join(command))
81 try:
82 proc = subprocess.Popen(command,
83 stderr=subprocess.PIPE,
84 stdout=subprocess.DEVNULL)
85 except OSError as e:
86 raise BuildError('Could not call execute make: ' + str(e))
87 except subprocess.CalledProcessError as e:
88 raise BuildError(e.output)
89 _, stderr = proc.communicate()
90 if proc.returncode != 0:
91 raise BuildError(stderr.decode())
92 if stderr: # likely only due to build warnings
93 print(stderr.decode())
94
95 def start(self, params: List[str], build_dir: str) -> subprocess.Popen:
96 raise RuntimeError('not implemented!')
97
98
99class LinuxSourceTreeOperationsQemu(LinuxSourceTreeOperations):
100
101 def __init__(self, qemu_arch_params: qemu_config.QemuArchParams, cross_compile: Optional[str]):
102 super().__init__(linux_arch=qemu_arch_params.linux_arch,
103 cross_compile=cross_compile)
104 self._kconfig = qemu_arch_params.kconfig
105 self._qemu_arch = qemu_arch_params.qemu_arch
106 self._kernel_path = qemu_arch_params.kernel_path
107 self._kernel_command_line = qemu_arch_params.kernel_command_line + ' kunit_shutdown=reboot'
108 self._extra_qemu_params = qemu_arch_params.extra_qemu_params
109 self._serial = qemu_arch_params.serial
110
111 def make_arch_config(self, base_kunitconfig: kunit_config.Kconfig) -> kunit_config.Kconfig:
112 kconfig = kunit_config.parse_from_string(self._kconfig)
113 kconfig.merge_in_entries(base_kunitconfig)
114 return kconfig
115
116 def start(self, params: List[str], build_dir: str) -> subprocess.Popen:
117 kernel_path = os.path.join(build_dir, self._kernel_path)
118 qemu_command = ['qemu-system-' + self._qemu_arch,
119 '-nodefaults',
120 '-m', '1024',
121 '-kernel', kernel_path,
122 '-append', ' '.join(params + [self._kernel_command_line]),
123 '-no-reboot',
124 '-nographic',
125 '-serial', self._serial] + self._extra_qemu_params
126 # Note: shlex.join() does what we want, but requires python 3.8+.
127 print('Running tests with:\n$', ' '.join(shlex.quote(arg) for arg in qemu_command))
128 return subprocess.Popen(qemu_command,
129 stdin=subprocess.PIPE,
130 stdout=subprocess.PIPE,
131 stderr=subprocess.STDOUT,
132 text=True, errors='backslashreplace')
133
134class LinuxSourceTreeOperationsUml(LinuxSourceTreeOperations):
135 """An abstraction over command line operations performed on a source tree."""
136
137 def __init__(self, cross_compile: Optional[str]=None):
138 super().__init__(linux_arch='um', cross_compile=cross_compile)
139
140 def make_arch_config(self, base_kunitconfig: kunit_config.Kconfig) -> kunit_config.Kconfig:
141 kconfig = kunit_config.parse_file(UML_KCONFIG_PATH)
142 kconfig.merge_in_entries(base_kunitconfig)
143 return kconfig
144
145 def start(self, params: List[str], build_dir: str) -> subprocess.Popen:
146 """Runs the Linux UML binary. Must be named 'linux'."""
147 linux_bin = os.path.join(build_dir, 'linux')
148 params.extend(['mem=1G', 'console=tty', 'kunit_shutdown=halt'])
149 return subprocess.Popen([linux_bin] + params,
150 stdin=subprocess.PIPE,
151 stdout=subprocess.PIPE,
152 stderr=subprocess.STDOUT,
153 text=True, errors='backslashreplace')
154
155def get_kconfig_path(build_dir: str) -> str:
156 return os.path.join(build_dir, KCONFIG_PATH)
157
158def get_kunitconfig_path(build_dir: str) -> str:
159 return os.path.join(build_dir, KUNITCONFIG_PATH)
160
161def get_old_kunitconfig_path(build_dir: str) -> str:
162 return os.path.join(build_dir, OLD_KUNITCONFIG_PATH)
163
164def get_parsed_kunitconfig(build_dir: str,
165 kunitconfig_paths: Optional[List[str]]=None) -> kunit_config.Kconfig:
166 if not kunitconfig_paths:
167 path = get_kunitconfig_path(build_dir)
168 if not os.path.exists(path):
169 shutil.copyfile(DEFAULT_KUNITCONFIG_PATH, path)
170 return kunit_config.parse_file(path)
171
172 merged = kunit_config.Kconfig()
173
174 for path in kunitconfig_paths:
175 if os.path.isdir(path):
176 path = os.path.join(path, KUNITCONFIG_PATH)
177 if not os.path.exists(path):
178 raise ConfigError(f'Specified kunitconfig ({path}) does not exist')
179
180 partial = kunit_config.parse_file(path)
181 diff = merged.conflicting_options(partial)
182 if diff:
183 diff_str = '\n\n'.join(f'{a}\n vs from {path}\n{b}' for a, b in diff)
184 raise ConfigError(f'Multiple values specified for {len(diff)} options in kunitconfig:\n{diff_str}')
185 merged.merge_in_entries(partial)
186 return merged
187
188def get_outfile_path(build_dir: str) -> str:
189 return os.path.join(build_dir, OUTFILE_PATH)
190
191def _default_qemu_config_path(arch: str) -> str:
192 config_path = os.path.join(QEMU_CONFIGS_DIR, arch + '.py')
193 if os.path.isfile(config_path):
194 return config_path
195
196 options = [f[:-3] for f in os.listdir(QEMU_CONFIGS_DIR) if f.endswith('.py')]
197 raise ConfigError(arch + ' is not a valid arch, options are ' + str(sorted(options)))
198
199def _get_qemu_ops(config_path: str,
200 extra_qemu_args: Optional[List[str]],
201 cross_compile: Optional[str]) -> Tuple[str, LinuxSourceTreeOperations]:
202 # The module name/path has very little to do with where the actual file
203 # exists (I learned this through experimentation and could not find it
204 # anywhere in the Python documentation).
205 #
206 # Bascially, we completely ignore the actual file location of the config
207 # we are loading and just tell Python that the module lives in the
208 # QEMU_CONFIGS_DIR for import purposes regardless of where it actually
209 # exists as a file.
210 module_path = '.' + os.path.join(os.path.basename(QEMU_CONFIGS_DIR), os.path.basename(config_path))
211 spec = importlib.util.spec_from_file_location(module_path, config_path)
212 assert spec is not None
213 config = importlib.util.module_from_spec(spec)
214 # See https://github.com/python/typeshed/pull/2626 for context.
215 assert isinstance(spec.loader, importlib.abc.Loader)
216 spec.loader.exec_module(config)
217
218 if not hasattr(config, 'QEMU_ARCH'):
219 raise ValueError('qemu_config module missing "QEMU_ARCH": ' + config_path)
220 params: qemu_config.QemuArchParams = config.QEMU_ARCH
221 if extra_qemu_args:
222 params.extra_qemu_params.extend(extra_qemu_args)
223 return params.linux_arch, LinuxSourceTreeOperationsQemu(
224 params, cross_compile=cross_compile)
225
226class LinuxSourceTree:
227 """Represents a Linux kernel source tree with KUnit tests."""
228
229 def __init__(
230 self,
231 build_dir: str,
232 kunitconfig_paths: Optional[List[str]]=None,
233 kconfig_add: Optional[List[str]]=None,
234 arch: Optional[str]=None,
235 cross_compile: Optional[str]=None,
236 qemu_config_path: Optional[str]=None,
237 extra_qemu_args: Optional[List[str]]=None) -> None:
238 signal.signal(signal.SIGINT, self.signal_handler)
239 if qemu_config_path:
240 self._arch, self._ops = _get_qemu_ops(qemu_config_path, extra_qemu_args, cross_compile)
241 else:
242 self._arch = 'um' if arch is None else arch
243 if self._arch == 'um':
244 self._ops = LinuxSourceTreeOperationsUml(cross_compile=cross_compile)
245 else:
246 qemu_config_path = _default_qemu_config_path(self._arch)
247 _, self._ops = _get_qemu_ops(qemu_config_path, extra_qemu_args, cross_compile)
248
249 self._kconfig = get_parsed_kunitconfig(build_dir, kunitconfig_paths)
250 if kconfig_add:
251 kconfig = kunit_config.parse_from_string('\n'.join(kconfig_add))
252 self._kconfig.merge_in_entries(kconfig)
253
254 def arch(self) -> str:
255 return self._arch
256
257 def clean(self) -> bool:
258 try:
259 self._ops.make_mrproper()
260 except ConfigError as e:
261 logging.error(e)
262 return False
263 return True
264
265 def validate_config(self, build_dir: str) -> bool:
266 kconfig_path = get_kconfig_path(build_dir)
267 validated_kconfig = kunit_config.parse_file(kconfig_path)
268 if self._kconfig.is_subset_of(validated_kconfig):
269 return True
270 missing = set(self._kconfig.as_entries()) - set(validated_kconfig.as_entries())
271 message = 'Not all Kconfig options selected in kunitconfig were in the generated .config.\n' \
272 'This is probably due to unsatisfied dependencies.\n' \
273 'Missing: ' + ', '.join(str(e) for e in missing)
274 if self._arch == 'um':
275 message += '\nNote: many Kconfig options aren\'t available on UML. You can try running ' \
276 'on a different architecture with something like "--arch=x86_64".'
277 logging.error(message)
278 return False
279
280 def build_config(self, build_dir: str, make_options: Optional[List[str]]) -> bool:
281 kconfig_path = get_kconfig_path(build_dir)
282 if build_dir and not os.path.exists(build_dir):
283 os.mkdir(build_dir)
284 try:
285 self._kconfig = self._ops.make_arch_config(self._kconfig)
286 self._kconfig.write_to_file(kconfig_path)
287 self._ops.make_olddefconfig(build_dir, make_options)
288 except ConfigError as e:
289 logging.error(e)
290 return False
291 if not self.validate_config(build_dir):
292 return False
293
294 old_path = get_old_kunitconfig_path(build_dir)
295 if os.path.exists(old_path):
296 os.remove(old_path) # write_to_file appends to the file
297 self._kconfig.write_to_file(old_path)
298 return True
299
300 def _kunitconfig_changed(self, build_dir: str) -> bool:
301 old_path = get_old_kunitconfig_path(build_dir)
302 if not os.path.exists(old_path):
303 return True
304
305 old_kconfig = kunit_config.parse_file(old_path)
306 return old_kconfig != self._kconfig
307
308 def build_reconfig(self, build_dir: str, make_options: Optional[List[str]]) -> bool:
309 """Creates a new .config if it is not a subset of the .kunitconfig."""
310 kconfig_path = get_kconfig_path(build_dir)
311 if not os.path.exists(kconfig_path):
312 print('Generating .config ...')
313 return self.build_config(build_dir, make_options)
314
315 existing_kconfig = kunit_config.parse_file(kconfig_path)
316 self._kconfig = self._ops.make_arch_config(self._kconfig)
317
318 if self._kconfig.is_subset_of(existing_kconfig) and not self._kunitconfig_changed(build_dir):
319 return True
320 print('Regenerating .config ...')
321 os.remove(kconfig_path)
322 return self.build_config(build_dir, make_options)
323
324 def build_kernel(self, jobs: int, build_dir: str, make_options: Optional[List[str]]) -> bool:
325 try:
326 self._ops.make_olddefconfig(build_dir, make_options)
327 self._ops.make(jobs, build_dir, make_options)
328 except (ConfigError, BuildError) as e:
329 logging.error(e)
330 return False
331 return self.validate_config(build_dir)
332
333 def run_kernel(self, args: Optional[List[str]]=None, build_dir: str='', filter_glob: str='', filter: str='', filter_action: Optional[str]=None, timeout: Optional[int]=None) -> Iterator[str]:
334 if not args:
335 args = []
336 if filter_glob:
337 args.append('kunit.filter_glob=' + filter_glob)
338 if filter:
339 args.append('kunit.filter="' + filter + '"')
340 if filter_action:
341 args.append('kunit.filter_action=' + filter_action)
342 args.append('kunit.enable=1')
343
344 process = self._ops.start(args, build_dir)
345 assert process.stdout is not None # tell mypy it's set
346
347 # Enforce the timeout in a background thread.
348 def _wait_proc() -> None:
349 try:
350 process.wait(timeout=timeout)
351 except Exception as e:
352 print(e)
353 process.terminate()
354 process.wait()
355 waiter = threading.Thread(target=_wait_proc)
356 waiter.start()
357
358 output = open(get_outfile_path(build_dir), 'w')
359 try:
360 # Tee the output to the file and to our caller in real time.
361 for line in process.stdout:
362 output.write(line)
363 yield line
364 # This runs even if our caller doesn't consume every line.
365 finally:
366 # Flush any leftover output to the file
367 output.write(process.stdout.read())
368 output.close()
369 process.stdout.close()
370
371 waiter.join()
372 subprocess.call(['stty', 'sane'])
373
374 def signal_handler(self, unused_sig: int, unused_frame: Optional[FrameType]) -> None:
375 logging.error('Build interruption occurred. Cleaning console.')
376 subprocess.call(['stty', 'sane'])
1# SPDX-License-Identifier: GPL-2.0
2#
3# Runs UML kernel, collects output, and handles errors.
4#
5# Copyright (C) 2019, Google LLC.
6# Author: Felix Guo <felixguoxiuping@gmail.com>
7# Author: Brendan Higgins <brendanhiggins@google.com>
8
9import importlib.util
10import logging
11import subprocess
12import os
13import shutil
14import signal
15from typing import Iterator, Optional, Tuple
16
17from contextlib import ExitStack
18
19from collections import namedtuple
20
21import kunit_config
22import kunit_parser
23import qemu_config
24
25KCONFIG_PATH = '.config'
26KUNITCONFIG_PATH = '.kunitconfig'
27DEFAULT_KUNITCONFIG_PATH = 'tools/testing/kunit/configs/default.config'
28BROKEN_ALLCONFIG_PATH = 'tools/testing/kunit/configs/broken_on_uml.config'
29OUTFILE_PATH = 'test.log'
30ABS_TOOL_PATH = os.path.abspath(os.path.dirname(__file__))
31QEMU_CONFIGS_DIR = os.path.join(ABS_TOOL_PATH, 'qemu_configs')
32
33def get_file_path(build_dir, default):
34 if build_dir:
35 default = os.path.join(build_dir, default)
36 return default
37
38class ConfigError(Exception):
39 """Represents an error trying to configure the Linux kernel."""
40
41
42class BuildError(Exception):
43 """Represents an error trying to build the Linux kernel."""
44
45
46class LinuxSourceTreeOperations(object):
47 """An abstraction over command line operations performed on a source tree."""
48
49 def __init__(self, linux_arch: str, cross_compile: Optional[str]):
50 self._linux_arch = linux_arch
51 self._cross_compile = cross_compile
52
53 def make_mrproper(self) -> None:
54 try:
55 subprocess.check_output(['make', 'mrproper'], stderr=subprocess.STDOUT)
56 except OSError as e:
57 raise ConfigError('Could not call make command: ' + str(e))
58 except subprocess.CalledProcessError as e:
59 raise ConfigError(e.output.decode())
60
61 def make_arch_qemuconfig(self, kconfig: kunit_config.Kconfig) -> None:
62 pass
63
64 def make_allyesconfig(self, build_dir, make_options) -> None:
65 raise ConfigError('Only the "um" arch is supported for alltests')
66
67 def make_olddefconfig(self, build_dir, make_options) -> None:
68 command = ['make', 'ARCH=' + self._linux_arch, 'olddefconfig']
69 if self._cross_compile:
70 command += ['CROSS_COMPILE=' + self._cross_compile]
71 if make_options:
72 command.extend(make_options)
73 if build_dir:
74 command += ['O=' + build_dir]
75 print('Populating config with:\n$', ' '.join(command))
76 try:
77 subprocess.check_output(command, stderr=subprocess.STDOUT)
78 except OSError as e:
79 raise ConfigError('Could not call make command: ' + str(e))
80 except subprocess.CalledProcessError as e:
81 raise ConfigError(e.output.decode())
82
83 def make(self, jobs, build_dir, make_options) -> None:
84 command = ['make', 'ARCH=' + self._linux_arch, '--jobs=' + str(jobs)]
85 if make_options:
86 command.extend(make_options)
87 if self._cross_compile:
88 command += ['CROSS_COMPILE=' + self._cross_compile]
89 if build_dir:
90 command += ['O=' + build_dir]
91 print('Building with:\n$', ' '.join(command))
92 try:
93 proc = subprocess.Popen(command,
94 stderr=subprocess.PIPE,
95 stdout=subprocess.DEVNULL)
96 except OSError as e:
97 raise BuildError('Could not call execute make: ' + str(e))
98 except subprocess.CalledProcessError as e:
99 raise BuildError(e.output)
100 _, stderr = proc.communicate()
101 if proc.returncode != 0:
102 raise BuildError(stderr.decode())
103 if stderr: # likely only due to build warnings
104 print(stderr.decode())
105
106 def run(self, params, timeout, build_dir, outfile) -> None:
107 pass
108
109
110class LinuxSourceTreeOperationsQemu(LinuxSourceTreeOperations):
111
112 def __init__(self, qemu_arch_params: qemu_config.QemuArchParams, cross_compile: Optional[str]):
113 super().__init__(linux_arch=qemu_arch_params.linux_arch,
114 cross_compile=cross_compile)
115 self._kconfig = qemu_arch_params.kconfig
116 self._qemu_arch = qemu_arch_params.qemu_arch
117 self._kernel_path = qemu_arch_params.kernel_path
118 self._kernel_command_line = qemu_arch_params.kernel_command_line + ' kunit_shutdown=reboot'
119 self._extra_qemu_params = qemu_arch_params.extra_qemu_params
120
121 def make_arch_qemuconfig(self, base_kunitconfig: kunit_config.Kconfig) -> None:
122 kconfig = kunit_config.Kconfig()
123 kconfig.parse_from_string(self._kconfig)
124 base_kunitconfig.merge_in_entries(kconfig)
125
126 def run(self, params, timeout, build_dir, outfile):
127 kernel_path = os.path.join(build_dir, self._kernel_path)
128 qemu_command = ['qemu-system-' + self._qemu_arch,
129 '-nodefaults',
130 '-m', '1024',
131 '-kernel', kernel_path,
132 '-append', '\'' + ' '.join(params + [self._kernel_command_line]) + '\'',
133 '-no-reboot',
134 '-nographic',
135 '-serial stdio'] + self._extra_qemu_params
136 print('Running tests with:\n$', ' '.join(qemu_command))
137 with open(outfile, 'w') as output:
138 process = subprocess.Popen(' '.join(qemu_command),
139 stdin=subprocess.PIPE,
140 stdout=output,
141 stderr=subprocess.STDOUT,
142 text=True, shell=True)
143 try:
144 process.wait(timeout=timeout)
145 except Exception as e:
146 print(e)
147 process.terminate()
148 return process
149
150class LinuxSourceTreeOperationsUml(LinuxSourceTreeOperations):
151 """An abstraction over command line operations performed on a source tree."""
152
153 def __init__(self, cross_compile=None):
154 super().__init__(linux_arch='um', cross_compile=cross_compile)
155
156 def make_allyesconfig(self, build_dir, make_options) -> None:
157 kunit_parser.print_with_timestamp(
158 'Enabling all CONFIGs for UML...')
159 command = ['make', 'ARCH=um', 'allyesconfig']
160 if make_options:
161 command.extend(make_options)
162 if build_dir:
163 command += ['O=' + build_dir]
164 process = subprocess.Popen(
165 command,
166 stdout=subprocess.DEVNULL,
167 stderr=subprocess.STDOUT)
168 process.wait()
169 kunit_parser.print_with_timestamp(
170 'Disabling broken configs to run KUnit tests...')
171 with ExitStack() as es:
172 config = open(get_kconfig_path(build_dir), 'a')
173 disable = open(BROKEN_ALLCONFIG_PATH, 'r').read()
174 config.write(disable)
175 kunit_parser.print_with_timestamp(
176 'Starting Kernel with all configs takes a few minutes...')
177
178 def run(self, params, timeout, build_dir, outfile):
179 """Runs the Linux UML binary. Must be named 'linux'."""
180 linux_bin = get_file_path(build_dir, 'linux')
181 outfile = get_outfile_path(build_dir)
182 with open(outfile, 'w') as output:
183 process = subprocess.Popen([linux_bin] + params,
184 stdin=subprocess.PIPE,
185 stdout=output,
186 stderr=subprocess.STDOUT,
187 text=True)
188 process.wait(timeout)
189
190def get_kconfig_path(build_dir) -> str:
191 return get_file_path(build_dir, KCONFIG_PATH)
192
193def get_kunitconfig_path(build_dir) -> str:
194 return get_file_path(build_dir, KUNITCONFIG_PATH)
195
196def get_outfile_path(build_dir) -> str:
197 return get_file_path(build_dir, OUTFILE_PATH)
198
199def get_source_tree_ops(arch: str, cross_compile: Optional[str]) -> LinuxSourceTreeOperations:
200 config_path = os.path.join(QEMU_CONFIGS_DIR, arch + '.py')
201 if arch == 'um':
202 return LinuxSourceTreeOperationsUml(cross_compile=cross_compile)
203 elif os.path.isfile(config_path):
204 return get_source_tree_ops_from_qemu_config(config_path, cross_compile)[1]
205 else:
206 raise ConfigError(arch + ' is not a valid arch')
207
208def get_source_tree_ops_from_qemu_config(config_path: str,
209 cross_compile: Optional[str]) -> Tuple[
210 str, LinuxSourceTreeOperations]:
211 # The module name/path has very little to do with where the actual file
212 # exists (I learned this through experimentation and could not find it
213 # anywhere in the Python documentation).
214 #
215 # Bascially, we completely ignore the actual file location of the config
216 # we are loading and just tell Python that the module lives in the
217 # QEMU_CONFIGS_DIR for import purposes regardless of where it actually
218 # exists as a file.
219 module_path = '.' + os.path.join(os.path.basename(QEMU_CONFIGS_DIR), os.path.basename(config_path))
220 spec = importlib.util.spec_from_file_location(module_path, config_path)
221 config = importlib.util.module_from_spec(spec)
222 # TODO(brendanhiggins@google.com): I looked this up and apparently other
223 # Python projects have noted that pytype complains that "No attribute
224 # 'exec_module' on _importlib_modulespec._Loader". Disabling for now.
225 spec.loader.exec_module(config) # pytype: disable=attribute-error
226 return config.QEMU_ARCH.linux_arch, LinuxSourceTreeOperationsQemu(
227 config.QEMU_ARCH, cross_compile=cross_compile)
228
229class LinuxSourceTree(object):
230 """Represents a Linux kernel source tree with KUnit tests."""
231
232 def __init__(
233 self,
234 build_dir: str,
235 load_config=True,
236 kunitconfig_path='',
237 arch=None,
238 cross_compile=None,
239 qemu_config_path=None) -> None:
240 signal.signal(signal.SIGINT, self.signal_handler)
241 if qemu_config_path:
242 self._arch, self._ops = get_source_tree_ops_from_qemu_config(
243 qemu_config_path, cross_compile)
244 else:
245 self._arch = 'um' if arch is None else arch
246 self._ops = get_source_tree_ops(self._arch, cross_compile)
247
248 if not load_config:
249 return
250
251 if kunitconfig_path:
252 if os.path.isdir(kunitconfig_path):
253 kunitconfig_path = os.path.join(kunitconfig_path, KUNITCONFIG_PATH)
254 if not os.path.exists(kunitconfig_path):
255 raise ConfigError(f'Specified kunitconfig ({kunitconfig_path}) does not exist')
256 else:
257 kunitconfig_path = get_kunitconfig_path(build_dir)
258 if not os.path.exists(kunitconfig_path):
259 shutil.copyfile(DEFAULT_KUNITCONFIG_PATH, kunitconfig_path)
260
261 self._kconfig = kunit_config.Kconfig()
262 self._kconfig.read_from_file(kunitconfig_path)
263
264 def clean(self) -> bool:
265 try:
266 self._ops.make_mrproper()
267 except ConfigError as e:
268 logging.error(e)
269 return False
270 return True
271
272 def validate_config(self, build_dir) -> bool:
273 kconfig_path = get_kconfig_path(build_dir)
274 validated_kconfig = kunit_config.Kconfig()
275 validated_kconfig.read_from_file(kconfig_path)
276 if not self._kconfig.is_subset_of(validated_kconfig):
277 invalid = self._kconfig.entries() - validated_kconfig.entries()
278 message = 'Provided Kconfig is not contained in validated .config. Following fields found in kunitconfig, ' \
279 'but not in .config: %s' % (
280 ', '.join([str(e) for e in invalid])
281 )
282 logging.error(message)
283 return False
284 return True
285
286 def build_config(self, build_dir, make_options) -> bool:
287 kconfig_path = get_kconfig_path(build_dir)
288 if build_dir and not os.path.exists(build_dir):
289 os.mkdir(build_dir)
290 try:
291 self._ops.make_arch_qemuconfig(self._kconfig)
292 self._kconfig.write_to_file(kconfig_path)
293 self._ops.make_olddefconfig(build_dir, make_options)
294 except ConfigError as e:
295 logging.error(e)
296 return False
297 return self.validate_config(build_dir)
298
299 def build_reconfig(self, build_dir, make_options) -> bool:
300 """Creates a new .config if it is not a subset of the .kunitconfig."""
301 kconfig_path = get_kconfig_path(build_dir)
302 if os.path.exists(kconfig_path):
303 existing_kconfig = kunit_config.Kconfig()
304 existing_kconfig.read_from_file(kconfig_path)
305 self._ops.make_arch_qemuconfig(self._kconfig)
306 if not self._kconfig.is_subset_of(existing_kconfig):
307 print('Regenerating .config ...')
308 os.remove(kconfig_path)
309 return self.build_config(build_dir, make_options)
310 else:
311 return True
312 else:
313 print('Generating .config ...')
314 return self.build_config(build_dir, make_options)
315
316 def build_kernel(self, alltests, jobs, build_dir, make_options) -> bool:
317 try:
318 if alltests:
319 self._ops.make_allyesconfig(build_dir, make_options)
320 self._ops.make_olddefconfig(build_dir, make_options)
321 self._ops.make(jobs, build_dir, make_options)
322 except (ConfigError, BuildError) as e:
323 logging.error(e)
324 return False
325 return self.validate_config(build_dir)
326
327 def run_kernel(self, args=None, build_dir='', filter_glob='', timeout=None) -> Iterator[str]:
328 if not args:
329 args = []
330 args.extend(['mem=1G', 'console=tty', 'kunit_shutdown=halt'])
331 if filter_glob:
332 args.append('kunit.filter_glob='+filter_glob)
333 outfile = get_outfile_path(build_dir)
334 self._ops.run(args, timeout, build_dir, outfile)
335 subprocess.call(['stty', 'sane'])
336 with open(outfile, 'r') as file:
337 for line in file:
338 yield line
339
340 def signal_handler(self, sig, frame) -> None:
341 logging.error('Build interruption occurred. Cleaning console.')
342 subprocess.call(['stty', 'sane'])