Mirrors/u-boot
1
0
Fork 0
mirror of https://source.denx.de/u-boot/u-boot.git synced 2026-06-12 22:49:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4feabb2b8a50737f55ffe2ab85568fd0a04954d2
u-boot/test/py/tests/test_fit.py
Tom Rini 77efd55f89 Merge patch series "boot/fit: use fdt_for_each_subnode() in image-fit.c" 
Aristo Chen <aristo.chen@canonical.com> says:

This series ends with replacing the verbose fdt_next_node() + ndepth
idiom in boot/image-fit.c with fdt_for_each_subnode(), bringing the
file in line with boot/image-fit-sig.c. Six of the seven sites in
image-fit.c predate the macro by 2-6 years; the seventh was
copy-pasted from a neighbour in 2015 just after the macro landed.
The old idiom is legacy, not a deliberate technical choice.

Converting straight to the macro turned out to need a prerequisite,
which is patch 1. fit_print_contents() reads the default-config
property using the loop variable left over after iterating /images
children. With /images defined first in the source (the conventional
layout) libfdt's walker happens to leave that variable pointing at
/configurations and the read works. With /configurations defined
first the read returns NULL and the "Default Configuration" line is
silently omitted. fdt_for_each_subnode()'s post-loop value is
unconditionally a negative error code, so a naive conversion would
have made the missing line the unconditional behaviour. Patch 1
reads the property from confs_noffset directly and removes the
layout dependency.

Patch 2 adds a regression test for the configs-before-images
layout, which had no coverage.

Patch 3 is the mechanical conversion at all seven sites,
equivalence-preserving as described in the per-patch message.

Link: https://lore.kernel.org/r/20260508213217.3807786-1-aristo.chen@canonical.com
2026-05-25 13:44:28 -06:00

482 lines
18 KiB
Python
Executable File
Raw Blame History

# SPDX-License-Identifier: GPL-2.0+
# Copyright (c) 2013, Google Inc.
"""Sanity check of the FIT handling in U-Boot"""
import os
import struct
import pytest
import fit_util
import utils
# Define a base ITS which we can adjust using % and a dictionary
BASE_ITS = '''
/dts-v1/;
/ {
description = "Chrome OS kernel image with one or more FDT blobs";
#address-cells = <1>;
images {
kernel-1 {
data = /incbin/("%(kernel)s");
type = "kernel";
arch = "sandbox";
os = "linux";
compression = "%(compression)s";
load = <0x40000>;
entry = <0x8>;
};
kernel-2 {
data = /incbin/("%(loadables1)s");
type = "kernel";
arch = "sandbox";
os = "linux";
compression = "none";
%(loadables1_load)s
entry = <0x0>;
};
fdt-1 {
description = "snow";
data = /incbin/("%(fdt)s");
type = "flat_dt";
arch = "sandbox";
%(fdt_load)s
compression = "%(compression)s";
signature-1 {
algo = "sha1,rsa2048";
key-name-hint = "dev";
};
};
ramdisk-1 {
description = "snow";
data = /incbin/("%(ramdisk)s");
type = "ramdisk";
arch = "sandbox";
os = "linux";
%(ramdisk_load)s
compression = "%(compression)s";
};
ramdisk-2 {
description = "snow";
data = /incbin/("%(loadables2)s");
type = "ramdisk";
arch = "sandbox";
os = "linux";
%(loadables2_load)s
compression = "none";
};
};
configurations {
default = "conf-1";
conf-1 {
%(kernel_config)s
fdt = "fdt-1";
%(ramdisk_config)s
%(loadables_config)s
};
};
};
'''
# Define a base FDT - currently we don't use anything in this
BASE_FDT = '''
/dts-v1/;
/ {
#address-cells = <1>;
#size-cells = <0>;
model = "Sandbox Verified Boot Test";
compatible = "sandbox";
binman {
};
reset@0 {
compatible = "sandbox,reset";
reg = <0>;
};
};
'''
# This is the U-Boot script that is run for each test. First load the FIT,
# then run the 'bootm' command, then save out memory from the places where
# we expect 'bootm' to write things. Then quit.
BASE_SCRIPT = '''
mw.b 0 0 160000
host load hostfs 0 %(fit_addr)x %(fit)s
fdt addr %(fit_addr)x
bootm start %(fit_addr)x
bootm loados
host save hostfs 0 %(kernel_addr)x %(kernel_out)s %(kernel_size)x
host save hostfs 0 %(fdt_addr)x %(fdt_out)s %(fdt_size)x
host save hostfs 0 %(ramdisk_addr)x %(ramdisk_out)s %(ramdisk_size)x
host save hostfs 0 %(loadables1_addr)x %(loadables1_out)s %(loadables1_size)x
host save hostfs 0 %(loadables2_addr)x %(loadables2_out)s %(loadables2_size)x
'''
@pytest.mark.boardspec('sandbox')
@pytest.mark.buildconfigspec('fit')
@pytest.mark.requiredtool('dtc')
class TestFitImage:
"""Test class for FIT image handling in U-Boot
TODO: Almost everything:
- hash algorithms - invalid hash/contents should be detected
- signature algorithms - invalid sig/contents should be detected
- compression
- checking that errors are detected like:
- image overwriting
- missing images
- invalid configurations
- incorrect os/arch/type fields
- empty data
- images too large/small
- invalid FDT (e.g. putting a random binary in instead)
- default configuration selection
- bootm command line parameters should have desired effect
- run code coverage to make sure we are testing all the code
"""
def filesize(self, fname):
"""Get the size of a file
Args:
fname (str): Filename to check
Return:
int: Size of file in bytes
"""
return os.stat(fname).st_size
def read_file(self, fname):
"""Read the contents of a file
Args:
fname (str): Filename to read
Return:
str: Contents of file
"""
with open(fname, 'rb') as fd:
return fd.read()
def make_ramdisk(self, ubman, filename, text):
"""Make a sample ramdisk with test data
Returns:
str: Filename of ramdisk created
"""
fname = fit_util.make_fname(ubman, filename)
data = ''
for i in range(100):
data += f'{text} {i} was seldom used in the middle ages\n'
with open(fname, 'w', encoding='ascii') as fd:
print(data, file=fd)
return fname
def make_compressed(self, ubman, filename):
"""Compress a file using gzip"""
utils.run_and_log(ubman, ['gzip', '-f', '-k', filename])
return filename + '.gz'
def find_matching(self, text, match):
"""Find a match in a line of text, and return the unmatched line portion
This is used to extract a part of a line from some text. The match string
is used to locate the line - we use the first line that contains that
match text.
Once we find a match, we discard the match string itself from the line,
and return what remains.
TODO: If this function becomes more generally useful, we could change it
to use regex and return groups.
Args:
text (list of str): Text to check, one for each command issued
match (str): String to search for
Return:
str: unmatched portion of line
Raises:
ValueError: If match is not found
.. code-block:: python
>>> find_matching(['first line:10', 'second_line:20'], 'first line:')
'10'
>>> find_matching(['first line:10', 'second_line:20'], 'second line')
Traceback (most recent call last):
...
ValueError: Test aborted
>>> find_matching(['first line:10', 'second_line:20'], 'second_line:')
'20'
>>> find_matching(['first line:10', 'second_line:20\\nthird_line:30'],
... 'third_line:')
'30'
"""
# pylint: disable=W0612
__tracebackhide__ = True
for line in '\n'.join(text).splitlines():
pos = line.find(match)
if pos != -1:
return line[:pos] + line[pos + len(match):]
pytest.fail("Expected '%s' but not found in output")
return '<no-match>'
def check_equal(self, params, expected_key, actual_key, failure_msg):
"""Check that a file matches its expected contents
This is always used on out-buffers whose size is decided by the test
script anyway, which in some cases may be larger than what we're
actually looking for. So it's safe to truncate it to the size of the
expected data.
"""
expected_data = self.read_file(params[expected_key])
actual_data = self.read_file(params[actual_key])
if len(expected_data) < len(actual_data):
actual_data = actual_data[:len(expected_data)]
assert expected_data == actual_data, failure_msg
def check_not_equal(self, params, expected_key, actual_key, failure_msg):
"""Check that a file does not match its expected contents"""
expected_data = self.read_file(params[expected_key])
actual_data = self.read_file(params[actual_key])
assert expected_data != actual_data, failure_msg
@pytest.fixture()
def fsetup(self, ubman):
"""Set up files and default parameters for FIT tests"""
mkimage = os.path.join(ubman.config.build_dir, 'tools/mkimage')
fdt_data = fit_util.make_dtb(ubman, BASE_FDT, 'u-boot')
kernel = fit_util.make_kernel(ubman, 'test-kernel.bin', 'kernel')
ramdisk = self.make_ramdisk(ubman, 'test-ramdisk.bin', 'ramdisk')
loadables1 = fit_util.make_kernel(ubman, 'test-loadables1.bin',
'lenrek')
loadables2 = self.make_ramdisk(ubman, 'test-loadables2.bin',
'ksidmar')
yield {
'mkimage' : mkimage,
'fit_addr' : 0x1000,
'kernel' : kernel,
'kernel_out' : fit_util.make_fname(ubman, 'kernel-out.bin'),
'kernel_addr' : 0x40000,
'kernel_size' : self.filesize(kernel),
'kernel_config' : 'kernel = "kernel-1";',
'fdt_data' : fdt_data,
'fdt' : fit_util.make_fname(ubman, 'u-boot.dtb'),
'fdt_out' : fit_util.make_fname(ubman, 'fdt-out.dtb'),
'fdt_addr' : 0x80000,
'fdt_size' : self.filesize(fdt_data),
'fdt_load' : '',
'ramdisk' : ramdisk,
'ramdisk_out' : fit_util.make_fname(ubman, 'ramdisk-out.bin'),
'ramdisk_addr' : 0xc0000,
'ramdisk_size' : self.filesize(ramdisk),
'ramdisk_load' : '',
'ramdisk_config' : '',
'loadables1' : loadables1,
'loadables1_out' : fit_util.make_fname(ubman, 'loadables1-out.bin'),
'loadables1_addr' : 0x100000,
'loadables1_size' : self.filesize(loadables1),
'loadables1_load' : '',
'loadables2' : loadables2,
'loadables2_out' : fit_util.make_fname(ubman, 'loadables2-out.bin'),
'loadables2_addr' : 0x140000,
'loadables2_size' : self.filesize(loadables2),
'loadables2_load' : '',
'loadables_config' : '',
'compression' : 'none',
}
def prepare(self, ubman, fsetup, **kwargs):
"""Build a FIT with given overrides
Args:
ubman (ConsoleBase): U-Boot fixture
fsetup (dict): Default parameters from the fsetup fixture
kwargs: Parameter overrides for this particular test
Return:
tuple:
list of str: Commands to run for the test
dict: Parameters used by the test
str: Filename of the FIT that was created
"""
params = {**fsetup, **kwargs}
fit = fit_util.make_fit(ubman, params['mkimage'], BASE_ITS, params)
params['fit'] = fit
cmds = (BASE_SCRIPT % params).splitlines()
return cmds, params, fit
def test_fit_kernel_load(self, ubman, fsetup):
"""Test loading a FIT image with only a kernel"""
cmds, params, fit = self.prepare(ubman, fsetup)
output = ubman.run_command_list(cmds)
self.check_equal(params, 'kernel', 'kernel_out', 'Kernel not loaded')
self.check_not_equal(params, 'fdt_data', 'fdt_out',
'FDT loaded but should be ignored')
self.check_not_equal(params, 'ramdisk', 'ramdisk_out',
'Ramdisk loaded but should not be')
# Find out the offset in the FIT where U-Boot has found the FDT
line = self.find_matching(output, 'Booting using the fdt blob at ')
fit_offset = int(line, 16) - params['fit_addr']
fdt_magic = struct.pack('>L', 0xd00dfeed)
data = self.read_file(fit)
# Now find where it actually is in the FIT (skip the first word)
real_fit_offset = data.find(fdt_magic, 4)
assert fit_offset == real_fit_offset, (
'U-Boot loaded FDT from offset %#x, FDT is actually at %#x' %
(fit_offset, real_fit_offset))
# Check bootargs string substitution
output = ubman.run_command_list([
'env set bootargs \\"\'my_boot_var=${foo}\'\\"',
'env set foo bar',
'bootm prep',
'env print bootargs'])
assert 'bootargs="my_boot_var=bar"' in output, \
"Bootargs strings not substituted"
def test_fit_kernel_fdt_load(self, ubman, fsetup):
"""Test loading a FIT image with a kernel and FDT"""
cmds, params, _ = self.prepare(
ubman, fsetup,
fdt_load='load = <%#x>;' % fsetup['fdt_addr'])
ubman.run_command_list(cmds)
self.check_equal(params, 'kernel', 'kernel_out', 'Kernel not loaded')
self.check_equal(params, 'fdt_data', 'fdt_out', 'FDT not loaded')
self.check_not_equal(params, 'ramdisk', 'ramdisk_out',
'Ramdisk loaded but should not be')
def test_fit_kernel_fdt_ramdisk_load(self, ubman, fsetup):
"""Test loading a FIT image with kernel, FDT, and ramdisk"""
cmds, params, _ = self.prepare(
ubman, fsetup,
fdt_load='load = <%#x>;' % fsetup['fdt_addr'],
ramdisk_config='ramdisk = "ramdisk-1";',
ramdisk_load='load = <%#x>;' % fsetup['ramdisk_addr'])
ubman.run_command_list(cmds)
self.check_equal(params, 'ramdisk', 'ramdisk_out',
'Ramdisk not loaded')
def test_fit_loadables_load(self, ubman, fsetup):
"""Test a configuration with loadables"""
cmds, params, _ = self.prepare(
ubman, fsetup,
fdt_load='load = <%#x>;' % fsetup['fdt_addr'],
ramdisk_config='ramdisk = "ramdisk-1";',
ramdisk_load='load = <%#x>;' % fsetup['ramdisk_addr'],
loadables_config='loadables = "kernel-2", "ramdisk-2";',
loadables1_load='load = <%#x>;' % fsetup['loadables1_addr'],
loadables2_load='load = <%#x>;' % fsetup['loadables2_addr'])
ubman.run_command_list(cmds)
self.check_equal(params, 'loadables1', 'loadables1_out',
'Loadables1 (kernel) not loaded')
self.check_equal(params, 'loadables2', 'loadables2_out',
'Loadables2 (ramdisk) not loaded')
def test_fit_compressed_images_load(self, ubman, fsetup):
"""Test loading compressed kernel, FDT, and ramdisk images"""
cmds, params, _ = self.prepare(
ubman, fsetup,
fdt_load='load = <%#x>;' % fsetup['fdt_addr'],
ramdisk_config='ramdisk = "ramdisk-1";',
ramdisk_load='load = <%#x>;' % fsetup['ramdisk_addr'],
compression='gzip',
kernel=self.make_compressed(ubman, fsetup['kernel']),
fdt=self.make_compressed(ubman, fsetup['fdt']),
ramdisk=self.make_compressed(ubman, fsetup['ramdisk']))
ubman.run_command_list(cmds)
self.check_equal(fsetup, 'kernel', 'kernel_out',
'Kernel not loaded')
self.check_equal(fsetup, 'fdt_data', 'fdt_out', 'FDT not loaded')
self.check_not_equal(fsetup, 'ramdisk', 'ramdisk_out',
'Ramdisk got decompressed?')
self.check_equal(params, 'ramdisk', 'ramdisk_out',
'Ramdisk not loaded')
def test_fit_no_kernel_load(self, ubman, fsetup):
"""Test that bootm fails when no kernel is specified"""
cmds = self.prepare(
ubman, fsetup,
fdt_load='load = <%#x>;' % fsetup['fdt_addr'],
kernel_config='',
ramdisk_config='',
ramdisk_load='')[0]
output = ubman.run_command_list(cmds)
assert "can't get kernel image!" in '\n'.join(output)
def test_fit_iminfo_configs_first(self, ubman, fsetup):
"""Regression: iminfo prints "Default Configuration" even when
/configurations is defined before /images in the source.
fit_print_contents() in boot/image-fit.c used to read the default
configuration name from whatever offset libfdt happened to return
after iterating /images children. With /images defined first that
offset accidentally landed on /configurations; with /configurations
defined first the read returned NULL and the line silently went
missing. Fixed in commit "boot/fit: read default-config property
from the configurations node".
"""
configs_first_its = '''
/dts-v1/;
/ {
description = "FIT with /configurations before /images";
#address-cells = <1>;
configurations {
default = "conf-1";
conf-1 {
description = "first config";
kernel = "kernel-1";
};
};
images {
kernel-1 {
description = "first image";
data = /incbin/("%(kernel)s");
type = "kernel";
arch = "sandbox";
os = "linux";
compression = "none";
load = <0x40000>;
entry = <0x40000>;
};
};
};
'''
fit = fit_util.make_fit(ubman, fsetup['mkimage'], configs_first_its,
fsetup, basename='configs-first.fit')
cmds = [
'host load hostfs 0 %#x %s' % (fsetup['fit_addr'], fit),
'iminfo %#x' % fsetup['fit_addr'],
]
output = '\n'.join(ubman.run_command_list(cmds))
assert "Default Configuration: 'conf-1'" in output, (
'iminfo output is missing the "Default Configuration" line for a '
'FIT whose /configurations node precedes /images. Output was:\n'
+ output)
Reference in New Issue View Git Blame Copy Permalink