kunit_kernel.py 11.9 KB
Newer Older
1
2
3
4
5
6
7
8
# SPDX-License-Identifier: GPL-2.0
#
# Runs UML kernel, collects output, and handles errors.
#
# Copyright (C) 2019, Google LLC.
# Author: Felix Guo <felixguoxiuping@gmail.com>
# Author: Brendan Higgins <brendanhiggins@google.com>

9
import importlib.util
10
11
12
import logging
import subprocess
import os
13
import shutil
14
import signal
15
from typing import Iterator, Optional, Tuple
16
17

from contextlib import ExitStack
18

19
20
from collections import namedtuple

21
import kunit_config
22
import kunit_parser
23
import qemu_config
24
25

KCONFIG_PATH = '.config'
26
KUNITCONFIG_PATH = '.kunitconfig'
27
DEFAULT_KUNITCONFIG_PATH = 'tools/testing/kunit/configs/default.config'
28
BROKEN_ALLCONFIG_PATH = 'tools/testing/kunit/configs/broken_on_uml.config'
29
OUTFILE_PATH = 'test.log'
30
31
ABS_TOOL_PATH = os.path.abspath(os.path.dirname(__file__))
QEMU_CONFIGS_DIR = os.path.join(ABS_TOOL_PATH, 'qemu_configs')
32

33
34
35
36
37
def get_file_path(build_dir, default):
	if build_dir:
		default = os.path.join(build_dir, default)
	return default

38
39
40
41
42
43
44
45
46
47
48
class ConfigError(Exception):
	"""Represents an error trying to configure the Linux kernel."""


class BuildError(Exception):
	"""Represents an error trying to build the Linux kernel."""


class LinuxSourceTreeOperations(object):
	"""An abstraction over command line operations performed on a source tree."""

49
50
51
52
	def __init__(self, linux_arch: str, cross_compile: Optional[str]):
		self._linux_arch = linux_arch
		self._cross_compile = cross_compile

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
62
63
64
65
66
	def make_arch_qemuconfig(self, kconfig: kunit_config.Kconfig) -> None:
		pass

	def make_allyesconfig(self, build_dir, make_options) -> None:
		raise ConfigError('Only the "um" arch is supported for alltests')

67
	def make_olddefconfig(self, build_dir, make_options) -> None:
68
69
70
		command = ['make', 'ARCH=' + self._linux_arch, 'olddefconfig']
		if self._cross_compile:
			command += ['CROSS_COMPILE=' + self._cross_compile]
Greg Thelen's avatar
Greg Thelen committed
71
72
		if make_options:
			command.extend(make_options)
73
74
		if build_dir:
			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
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
	def make(self, jobs, build_dir, make_options) -> None:
		command = ['make', 'ARCH=' + self._linux_arch, '--jobs=' + str(jobs)]
		if make_options:
			command.extend(make_options)
		if self._cross_compile:
			command += ['CROSS_COMPILE=' + self._cross_compile]
		if build_dir:
			command += ['O=' + build_dir]
		print('Building with:\n$', ' '.join(command))
		try:
			proc = subprocess.Popen(command,
						stderr=subprocess.PIPE,
						stdout=subprocess.DEVNULL)
		except OSError as e:
			raise BuildError('Could not call execute make: ' + str(e))
		except subprocess.CalledProcessError as e:
			raise BuildError(e.output)
		_, stderr = proc.communicate()
		if proc.returncode != 0:
			raise BuildError(stderr.decode())
		if stderr:  # likely only due to build warnings
			print(stderr.decode())

	def run(self, params, timeout, build_dir, outfile) -> None:
		pass


class LinuxSourceTreeOperationsQemu(LinuxSourceTreeOperations):

	def __init__(self, qemu_arch_params: qemu_config.QemuArchParams, cross_compile: Optional[str]):
		super().__init__(linux_arch=qemu_arch_params.linux_arch,
				 cross_compile=cross_compile)
		self._kconfig = qemu_arch_params.kconfig
		self._qemu_arch = qemu_arch_params.qemu_arch
		self._kernel_path = qemu_arch_params.kernel_path
		self._kernel_command_line = qemu_arch_params.kernel_command_line + ' kunit_shutdown=reboot'
		self._extra_qemu_params = qemu_arch_params.extra_qemu_params

	def make_arch_qemuconfig(self, base_kunitconfig: kunit_config.Kconfig) -> None:
		kconfig = kunit_config.Kconfig()
		kconfig.parse_from_string(self._kconfig)
		base_kunitconfig.merge_in_entries(kconfig)

	def run(self, params, timeout, build_dir, outfile):
		kernel_path = os.path.join(build_dir, self._kernel_path)
		qemu_command = ['qemu-system-' + self._qemu_arch,
				'-nodefaults',
				'-m', '1024',
				'-kernel', kernel_path,
				'-append', '\'' + ' '.join(params + [self._kernel_command_line]) + '\'',
				'-no-reboot',
				'-nographic',
				'-serial stdio'] + self._extra_qemu_params
		print('Running tests with:\n$', ' '.join(qemu_command))
		with open(outfile, 'w') as output:
			process = subprocess.Popen(' '.join(qemu_command),
						   stdin=subprocess.PIPE,
						   stdout=output,
						   stderr=subprocess.STDOUT,
						   text=True, shell=True)
		try:
			process.wait(timeout=timeout)
		except Exception as e:
			print(e)
			process.terminate()
		return process

class LinuxSourceTreeOperationsUml(LinuxSourceTreeOperations):
	"""An abstraction over command line operations performed on a source tree."""

	def __init__(self, cross_compile=None):
		super().__init__(linux_arch='um', cross_compile=cross_compile)

156
	def make_allyesconfig(self, build_dir, make_options) -> None:
157
158
		kunit_parser.print_with_timestamp(
			'Enabling all CONFIGs for UML...')
159
160
161
162
163
		command = ['make', 'ARCH=um', 'allyesconfig']
		if make_options:
			command.extend(make_options)
		if build_dir:
			command += ['O=' + build_dir]
164
		process = subprocess.Popen(
165
			command,
166
167
168
169
170
171
			stdout=subprocess.DEVNULL,
			stderr=subprocess.STDOUT)
		process.wait()
		kunit_parser.print_with_timestamp(
			'Disabling broken configs to run KUnit tests...')
		with ExitStack() as es:
172
			config = open(get_kconfig_path(build_dir), 'a')
173
174
175
176
177
			disable = open(BROKEN_ALLCONFIG_PATH, 'r').read()
			config.write(disable)
		kunit_parser.print_with_timestamp(
			'Starting Kernel with all configs takes a few minutes...')

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
183
		with open(outfile, 'w') as output:
			process = subprocess.Popen([linux_bin] + params,
184
						   stdin=subprocess.PIPE,
185
						   stdout=output,
186
187
						   stderr=subprocess.STDOUT,
						   text=True)
188
			process.wait(timeout)
189

190
def get_kconfig_path(build_dir) -> str:
191
	return get_file_path(build_dir, KCONFIG_PATH)
192

193
def get_kunitconfig_path(build_dir) -> str:
194
	return get_file_path(build_dir, KUNITCONFIG_PATH)
195

196
def get_outfile_path(build_dir) -> str:
197
	return get_file_path(build_dir, OUTFILE_PATH)
198

199
200
201
202
203
204
205
206
207
208
def get_source_tree_ops(arch: str, cross_compile: Optional[str]) -> LinuxSourceTreeOperations:
	config_path = os.path.join(QEMU_CONFIGS_DIR, arch + '.py')
	if arch == 'um':
		return LinuxSourceTreeOperationsUml(cross_compile=cross_compile)
	elif os.path.isfile(config_path):
		return get_source_tree_ops_from_qemu_config(config_path, cross_compile)[1]
	else:
		raise ConfigError(arch + ' is not a valid arch')

def get_source_tree_ops_from_qemu_config(config_path: str,
209
					 cross_compile: Optional[str]) -> Tuple[
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
							 str, LinuxSourceTreeOperations]:
	# The module name/path has very little to do with where the actual file
	# exists (I learned this through experimentation and could not find it
	# anywhere in the Python documentation).
	#
	# Bascially, we completely ignore the actual file location of the config
	# we are loading and just tell Python that the module lives in the
	# QEMU_CONFIGS_DIR for import purposes regardless of where it actually
	# exists as a file.
	module_path = '.' + os.path.join(os.path.basename(QEMU_CONFIGS_DIR), os.path.basename(config_path))
	spec = importlib.util.spec_from_file_location(module_path, config_path)
	config = importlib.util.module_from_spec(spec)
	# TODO(brendanhiggins@google.com): I looked this up and apparently other
	# Python projects have noted that pytype complains that "No attribute
	# 'exec_module' on _importlib_modulespec._Loader". Disabling for now.
	spec.loader.exec_module(config) # pytype: disable=attribute-error
	return config.QEMU_ARCH.linux_arch, LinuxSourceTreeOperationsQemu(
			config.QEMU_ARCH, cross_compile=cross_compile)

229
230
231
class LinuxSourceTree(object):
	"""Represents a Linux kernel source tree with KUnit tests."""

232
233
234
235
236
237
238
239
	def __init__(
	      self,
	      build_dir: str,
	      load_config=True,
	      kunitconfig_path='',
	      arch=None,
	      cross_compile=None,
	      qemu_config_path=None) -> None:
240
		signal.signal(signal.SIGINT, self.signal_handler)
241
242
243
244
245
246
		if qemu_config_path:
			self._arch, self._ops = get_source_tree_ops_from_qemu_config(
					qemu_config_path, cross_compile)
		else:
			self._arch = 'um' if arch is None else arch
			self._ops = get_source_tree_ops(self._arch, cross_compile)
247
248
249

		if not load_config:
			return
250

251
		if kunitconfig_path:
252
253
			if os.path.isdir(kunitconfig_path):
				kunitconfig_path = os.path.join(kunitconfig_path, KUNITCONFIG_PATH)
254
255
256
257
258
259
			if not os.path.exists(kunitconfig_path):
				raise ConfigError(f'Specified kunitconfig ({kunitconfig_path}) does not exist')
		else:
			kunitconfig_path = get_kunitconfig_path(build_dir)
			if not os.path.exists(kunitconfig_path):
				shutil.copyfile(DEFAULT_KUNITCONFIG_PATH, kunitconfig_path)
260
261
262
263

		self._kconfig = kunit_config.Kconfig()
		self._kconfig.read_from_file(kunitconfig_path)

264
265
266
267
268
269
270
271
	def clean(self) -> bool:
		try:
			self._ops.make_mrproper()
		except ConfigError as e:
			logging.error(e)
			return False
		return True

272
	def validate_config(self, build_dir) -> bool:
273
274
275
276
277
278
279
280
281
282
283
284
285
		kconfig_path = get_kconfig_path(build_dir)
		validated_kconfig = kunit_config.Kconfig()
		validated_kconfig.read_from_file(kconfig_path)
		if not self._kconfig.is_subset_of(validated_kconfig):
			invalid = self._kconfig.entries() - validated_kconfig.entries()
			message = 'Provided Kconfig is not contained in validated .config. Following fields found in kunitconfig, ' \
					  'but not in .config: %s' % (
					', '.join([str(e) for e in invalid])
			)
			logging.error(message)
			return False
		return True

286
	def build_config(self, build_dir, make_options) -> bool:
287
288
289
290
		kconfig_path = get_kconfig_path(build_dir)
		if build_dir and not os.path.exists(build_dir):
			os.mkdir(build_dir)
		try:
291
292
			self._ops.make_arch_qemuconfig(self._kconfig)
			self._kconfig.write_to_file(kconfig_path)
Greg Thelen's avatar
Greg Thelen committed
293
			self._ops.make_olddefconfig(build_dir, make_options)
294
295
296
		except ConfigError as e:
			logging.error(e)
			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
302
303
304
		kconfig_path = get_kconfig_path(build_dir)
		if os.path.exists(kconfig_path):
			existing_kconfig = kunit_config.Kconfig()
			existing_kconfig.read_from_file(kconfig_path)
305
			self._ops.make_arch_qemuconfig(self._kconfig)
306
307
308
			if not self._kconfig.is_subset_of(existing_kconfig):
				print('Regenerating .config ...')
				os.remove(kconfig_path)
Greg Thelen's avatar
Greg Thelen committed
309
				return self.build_config(build_dir, make_options)
310
311
312
313
			else:
				return True
		else:
			print('Generating .config ...')
Greg Thelen's avatar
Greg Thelen committed
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
319
			if alltests:
				self._ops.make_allyesconfig(build_dir, make_options)
Greg Thelen's avatar
Greg Thelen committed
320
321
			self._ops.make_olddefconfig(build_dir, make_options)
			self._ops.make(jobs, build_dir, make_options)
322
323
324
		except (ConfigError, BuildError) as e:
			logging.error(e)
			return False
325
		return self.validate_config(build_dir)
326

327
328
329
	def run_kernel(self, args=None, build_dir='', filter_glob='', timeout=None) -> Iterator[str]:
		if not args:
			args = []
David Gow's avatar
David Gow committed
330
		args.extend(['mem=1G', 'console=tty', 'kunit_shutdown=halt'])
331
332
		if filter_glob:
			args.append('kunit.filter_glob='+filter_glob)
333
		outfile = get_outfile_path(build_dir)
334
		self._ops.run(args, timeout, build_dir, outfile)
335
336
337
338
339
		subprocess.call(['stty', 'sane'])
		with open(outfile, 'r') as file:
			for line in file:
				yield line

340
	def signal_handler(self, sig, frame) -> None:
341
342
		logging.error('Build interruption occurred. Cleaning console.')
		subprocess.call(['stty', 'sane'])