blob: e3d218a89e92ee414fd4fa8af41e0c23e6087c31 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
Simon Glassb50e5612017-11-13 18:54:54 -07002# Copyright (c) 2017 Google, Inc
3# Written by Simon Glass <sjg@chromium.org>
4#
Simon Glassb50e5612017-11-13 18:54:54 -07005# Test for the elf module
6
7import os
Simon Glassf58558a2019-07-08 13:18:34 -06008import shutil
Simon Glassb50e5612017-11-13 18:54:54 -07009import sys
Simon Glassf58558a2019-07-08 13:18:34 -060010import tempfile
Simon Glassb50e5612017-11-13 18:54:54 -070011import unittest
12
Simon Glass16287932020-04-17 18:09:03 -060013from binman import elf
Simon Glassbf776672020-04-17 18:09:04 -060014from patman import command
15from patman import test_util
16from patman import tools
17from patman import tout
Simon Glassb50e5612017-11-13 18:54:54 -070018
19binman_dir = os.path.dirname(os.path.realpath(sys.argv[0]))
Simon Glass19790632017-11-13 18:55:01 -070020
Simon Glass19790632017-11-13 18:55:01 -070021
22class FakeEntry:
Simon Glassb2b0df82018-07-17 13:25:26 -060023 """A fake Entry object, usedfor testing
24
25 This supports an entry with a given size.
26 """
Simon Glass19790632017-11-13 18:55:01 -070027 def __init__(self, contents_size):
28 self.contents_size = contents_size
Simon Glassc6c10e72019-05-17 22:00:46 -060029 self.data = tools.GetBytes(ord('a'), contents_size)
Simon Glass19790632017-11-13 18:55:01 -070030
31 def GetPath(self):
32 return 'entry_path'
33
Simon Glassb2b0df82018-07-17 13:25:26 -060034
Simon Glassf55382b2018-06-01 09:38:13 -060035class FakeSection:
Simon Glassb2b0df82018-07-17 13:25:26 -060036 """A fake Section object, used for testing
37
38 This has the minimum feature set needed to support testing elf functions.
39 A LookupSymbol() function is provided which returns a fake value for amu
40 symbol requested.
41 """
Simon Glass19790632017-11-13 18:55:01 -070042 def __init__(self, sym_value=1):
43 self.sym_value = sym_value
44
45 def GetPath(self):
Simon Glassf55382b2018-06-01 09:38:13 -060046 return 'section_path'
Simon Glass19790632017-11-13 18:55:01 -070047
Simon Glass7c150132019-11-06 17:22:44 -070048 def LookupSymbol(self, name, weak, msg, base_addr):
Simon Glassb2b0df82018-07-17 13:25:26 -060049 """Fake implementation which returns the same value for all symbols"""
Simon Glass19790632017-11-13 18:55:01 -070050 return self.sym_value
Simon Glassb50e5612017-11-13 18:54:54 -070051
Simon Glassb2b0df82018-07-17 13:25:26 -060052
Simon Glass53e22bf2019-08-24 07:22:53 -060053def BuildElfTestFiles(target_dir):
54 """Build ELF files used for testing in binman
55
56 This compiles and links the test files into the specified directory. It the
57 Makefile and source files in the binman test/ directory.
58
59 Args:
60 target_dir: Directory to put the files into
61 """
62 if not os.path.exists(target_dir):
63 os.mkdir(target_dir)
64 testdir = os.path.join(binman_dir, 'test')
65
66 # If binman is involved from the main U-Boot Makefile the -r and -R
67 # flags are set in MAKEFLAGS. This prevents this Makefile from working
68 # correctly. So drop any make flags here.
69 if 'MAKEFLAGS' in os.environ:
70 del os.environ['MAKEFLAGS']
71 tools.Run('make', '-C', target_dir, '-f',
Simon Glassc9a0b272019-08-24 07:22:59 -060072 os.path.join(testdir, 'Makefile'), 'SRC=%s/' % testdir)
Simon Glass53e22bf2019-08-24 07:22:53 -060073
74
Simon Glassb50e5612017-11-13 18:54:54 -070075class TestElf(unittest.TestCase):
Simon Glasse0e62752018-10-01 21:12:41 -060076 @classmethod
Simon Glassf514d8f2019-08-24 07:22:54 -060077 def setUpClass(cls):
78 cls._indir = tempfile.mkdtemp(prefix='elf.')
Simon Glasse0e62752018-10-01 21:12:41 -060079 tools.SetInputDirs(['.'])
Simon Glassf514d8f2019-08-24 07:22:54 -060080 BuildElfTestFiles(cls._indir)
81
82 @classmethod
83 def tearDownClass(cls):
84 if cls._indir:
85 shutil.rmtree(cls._indir)
86
87 @classmethod
88 def ElfTestFile(cls, fname):
89 return os.path.join(cls._indir, fname)
Simon Glasse0e62752018-10-01 21:12:41 -060090
Simon Glassb50e5612017-11-13 18:54:54 -070091 def testAllSymbols(self):
Simon Glassb2b0df82018-07-17 13:25:26 -060092 """Test that we can obtain a symbol from the ELF file"""
Simon Glassf514d8f2019-08-24 07:22:54 -060093 fname = self.ElfTestFile('u_boot_ucode_ptr')
Simon Glassb50e5612017-11-13 18:54:54 -070094 syms = elf.GetSymbols(fname, [])
95 self.assertIn('.ucode', syms)
96
97 def testRegexSymbols(self):
Simon Glassb2b0df82018-07-17 13:25:26 -060098 """Test that we can obtain from the ELF file by regular expression"""
Simon Glassf514d8f2019-08-24 07:22:54 -060099 fname = self.ElfTestFile('u_boot_ucode_ptr')
Simon Glassb50e5612017-11-13 18:54:54 -0700100 syms = elf.GetSymbols(fname, ['ucode'])
101 self.assertIn('.ucode', syms)
102 syms = elf.GetSymbols(fname, ['missing'])
103 self.assertNotIn('.ucode', syms)
104 syms = elf.GetSymbols(fname, ['missing', 'ucode'])
105 self.assertIn('.ucode', syms)
106
Simon Glass19790632017-11-13 18:55:01 -0700107 def testMissingFile(self):
Simon Glassb2b0df82018-07-17 13:25:26 -0600108 """Test that a missing file is detected"""
Simon Glass19790632017-11-13 18:55:01 -0700109 entry = FakeEntry(10)
Simon Glassf55382b2018-06-01 09:38:13 -0600110 section = FakeSection()
Simon Glass19790632017-11-13 18:55:01 -0700111 with self.assertRaises(ValueError) as e:
Simon Glassf55382b2018-06-01 09:38:13 -0600112 syms = elf.LookupAndWriteSymbols('missing-file', entry, section)
Simon Glass19790632017-11-13 18:55:01 -0700113 self.assertIn("Filename 'missing-file' not found in input path",
114 str(e.exception))
115
116 def testOutsideFile(self):
Simon Glassb2b0df82018-07-17 13:25:26 -0600117 """Test a symbol which extends outside the entry area is detected"""
Simon Glass19790632017-11-13 18:55:01 -0700118 entry = FakeEntry(10)
Simon Glassf55382b2018-06-01 09:38:13 -0600119 section = FakeSection()
Simon Glass1542c8b2019-08-24 07:22:56 -0600120 elf_fname = self.ElfTestFile('u_boot_binman_syms')
Simon Glass19790632017-11-13 18:55:01 -0700121 with self.assertRaises(ValueError) as e:
Simon Glassf55382b2018-06-01 09:38:13 -0600122 syms = elf.LookupAndWriteSymbols(elf_fname, entry, section)
Simon Glass19790632017-11-13 18:55:01 -0700123 self.assertIn('entry_path has offset 4 (size 8) but the contents size '
124 'is a', str(e.exception))
125
126 def testMissingImageStart(self):
Simon Glassb2b0df82018-07-17 13:25:26 -0600127 """Test that we detect a missing __image_copy_start symbol
128
129 This is needed to mark the start of the image. Without it we cannot
130 locate the offset of a binman symbol within the image.
131 """
Simon Glass19790632017-11-13 18:55:01 -0700132 entry = FakeEntry(10)
Simon Glassf55382b2018-06-01 09:38:13 -0600133 section = FakeSection()
Simon Glass8dc60f92019-08-24 07:22:58 -0600134 elf_fname = self.ElfTestFile('u_boot_binman_syms_bad')
Simon Glassf55382b2018-06-01 09:38:13 -0600135 self.assertEqual(elf.LookupAndWriteSymbols(elf_fname, entry, section),
Simon Glass19790632017-11-13 18:55:01 -0700136 None)
137
138 def testBadSymbolSize(self):
Simon Glassb2b0df82018-07-17 13:25:26 -0600139 """Test that an attempt to use an 8-bit symbol are detected
140
141 Only 32 and 64 bits are supported, since we need to store an offset
142 into the image.
143 """
Simon Glass19790632017-11-13 18:55:01 -0700144 entry = FakeEntry(10)
Simon Glassf55382b2018-06-01 09:38:13 -0600145 section = FakeSection()
Simon Glasse9d2ee32019-08-24 07:22:57 -0600146 elf_fname =self.ElfTestFile('u_boot_binman_syms_size')
Simon Glass19790632017-11-13 18:55:01 -0700147 with self.assertRaises(ValueError) as e:
Simon Glassf55382b2018-06-01 09:38:13 -0600148 syms = elf.LookupAndWriteSymbols(elf_fname, entry, section)
Simon Glass19790632017-11-13 18:55:01 -0700149 self.assertIn('has size 1: only 4 and 8 are supported',
150 str(e.exception))
151
152 def testNoValue(self):
Simon Glassb2b0df82018-07-17 13:25:26 -0600153 """Test the case where we have no value for the symbol
154
155 This should produce -1 values for all thress symbols, taking up the
156 first 16 bytes of the image.
157 """
Simon Glassb87064c2019-08-24 07:23:05 -0600158 entry = FakeEntry(24)
Simon Glassf55382b2018-06-01 09:38:13 -0600159 section = FakeSection(sym_value=None)
Simon Glass1542c8b2019-08-24 07:22:56 -0600160 elf_fname = self.ElfTestFile('u_boot_binman_syms')
Simon Glassf55382b2018-06-01 09:38:13 -0600161 syms = elf.LookupAndWriteSymbols(elf_fname, entry, section)
Simon Glassb87064c2019-08-24 07:23:05 -0600162 self.assertEqual(tools.GetBytes(255, 20) + tools.GetBytes(ord('a'), 4),
Simon Glassc6c10e72019-05-17 22:00:46 -0600163 entry.data)
Simon Glass19790632017-11-13 18:55:01 -0700164
165 def testDebug(self):
Simon Glassb2b0df82018-07-17 13:25:26 -0600166 """Check that enabling debug in the elf module produced debug output"""
Simon Glass9f297b02019-07-20 12:23:36 -0600167 try:
168 tout.Init(tout.DEBUG)
169 entry = FakeEntry(20)
170 section = FakeSection()
Simon Glass1542c8b2019-08-24 07:22:56 -0600171 elf_fname = self.ElfTestFile('u_boot_binman_syms')
Simon Glass9f297b02019-07-20 12:23:36 -0600172 with test_util.capture_sys_output() as (stdout, stderr):
173 syms = elf.LookupAndWriteSymbols(elf_fname, entry, section)
174 self.assertTrue(len(stdout.getvalue()) > 0)
175 finally:
176 tout.Init(tout.WARNING)
Simon Glass19790632017-11-13 18:55:01 -0700177
Simon Glassf58558a2019-07-08 13:18:34 -0600178 def testMakeElf(self):
179 """Test for the MakeElf function"""
180 outdir = tempfile.mkdtemp(prefix='elf.')
181 expected_text = b'1234'
182 expected_data = b'wxyz'
183 elf_fname = os.path.join(outdir, 'elf')
Simon Glass9d44a7e2019-08-24 07:22:45 -0600184 bin_fname = os.path.join(outdir, 'bin')
Simon Glassf58558a2019-07-08 13:18:34 -0600185
186 # Make an Elf file and then convert it to a fkat binary file. This
187 # should produce the original data.
188 elf.MakeElf(elf_fname, expected_text, expected_data)
Alper Nebi Yasak1e4687a2020-09-06 14:46:05 +0300189 objcopy, args = tools.GetTargetCompileTool('objcopy')
190 args += ['-O', 'binary', elf_fname, bin_fname]
191 stdout = command.Output(objcopy, *args)
Simon Glassf58558a2019-07-08 13:18:34 -0600192 with open(bin_fname, 'rb') as fd:
193 data = fd.read()
194 self.assertEqual(expected_text + expected_data, data)
195 shutil.rmtree(outdir)
196
Simon Glassd8d40742019-07-08 13:18:35 -0600197 def testDecodeElf(self):
198 """Test for the MakeElf function"""
199 if not elf.ELF_TOOLS:
200 self.skipTest('Python elftools not available')
201 outdir = tempfile.mkdtemp(prefix='elf.')
202 expected_text = b'1234'
203 expected_data = b'wxyz'
204 elf_fname = os.path.join(outdir, 'elf')
205 elf.MakeElf(elf_fname, expected_text, expected_data)
206 data = tools.ReadFile(elf_fname)
207
208 load = 0xfef20000
209 entry = load + 2
210 expected = expected_text + expected_data
211 self.assertEqual(elf.ElfInfo(expected, load, entry, len(expected)),
212 elf.DecodeElf(data, 0))
213 self.assertEqual(elf.ElfInfo(b'\0\0' + expected[2:],
214 load, entry, len(expected)),
215 elf.DecodeElf(data, load + 2))
Simon Glassf514d8f2019-08-24 07:22:54 -0600216 shutil.rmtree(outdir)
Simon Glassd8d40742019-07-08 13:18:35 -0600217
Simon Glass19790632017-11-13 18:55:01 -0700218
Simon Glassb50e5612017-11-13 18:54:54 -0700219if __name__ == '__main__':
220 unittest.main()