Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | # SPDX-License-Identifier: GPL-2.0+ |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 2 | # Copyright (c) 2017 Google, Inc |
| 3 | # Written by Simon Glass <sjg@chromium.org> |
| 4 | # |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 5 | # Test for the elf module |
| 6 | |
| 7 | import os |
Simon Glass | 4f379ea | 2019-07-08 13:18:34 -0600 | [diff] [blame] | 8 | import shutil |
Simon Glass | a4e259e | 2021-11-03 21:09:16 -0600 | [diff] [blame] | 9 | import struct |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 10 | import sys |
Simon Glass | 4f379ea | 2019-07-08 13:18:34 -0600 | [diff] [blame] | 11 | import tempfile |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 12 | import unittest |
| 13 | |
Simon Glass | c585dd4 | 2020-04-17 18:09:03 -0600 | [diff] [blame] | 14 | from binman import elf |
Simon Glass | a997ea5 | 2020-04-17 18:09:04 -0600 | [diff] [blame] | 15 | from patman import command |
| 16 | from patman import test_util |
| 17 | from patman import tools |
| 18 | from patman import tout |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 19 | |
| 20 | binman_dir = os.path.dirname(os.path.realpath(sys.argv[0])) |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 21 | |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 22 | |
| 23 | class FakeEntry: |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 24 | """A fake Entry object, usedfor testing |
| 25 | |
| 26 | This supports an entry with a given size. |
| 27 | """ |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 28 | def __init__(self, contents_size): |
| 29 | self.contents_size = contents_size |
Simon Glass | 8002552 | 2022-01-29 14:14:04 -0700 | [diff] [blame] | 30 | self.data = tools.get_bytes(ord('a'), contents_size) |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 31 | |
| 32 | def GetPath(self): |
| 33 | return 'entry_path' |
| 34 | |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 35 | |
Simon Glass | 8a6f56e | 2018-06-01 09:38:13 -0600 | [diff] [blame] | 36 | class FakeSection: |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 37 | """A fake Section object, used for testing |
| 38 | |
| 39 | This has the minimum feature set needed to support testing elf functions. |
| 40 | A LookupSymbol() function is provided which returns a fake value for amu |
| 41 | symbol requested. |
| 42 | """ |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 43 | def __init__(self, sym_value=1): |
| 44 | self.sym_value = sym_value |
| 45 | |
| 46 | def GetPath(self): |
Simon Glass | 8a6f56e | 2018-06-01 09:38:13 -0600 | [diff] [blame] | 47 | return 'section_path' |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 48 | |
Simon Glass | ecbe473 | 2021-01-06 21:35:15 -0700 | [diff] [blame] | 49 | def LookupImageSymbol(self, name, weak, msg, base_addr): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 50 | """Fake implementation which returns the same value for all symbols""" |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 51 | return self.sym_value |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 52 | |
Simon Glass | ecbe473 | 2021-01-06 21:35:15 -0700 | [diff] [blame] | 53 | def GetImage(self): |
| 54 | return self |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 55 | |
Simon Glass | f629089 | 2019-08-24 07:22:53 -0600 | [diff] [blame] | 56 | def BuildElfTestFiles(target_dir): |
| 57 | """Build ELF files used for testing in binman |
| 58 | |
Simon Glass | 571adc8 | 2022-02-08 11:49:55 -0700 | [diff] [blame] | 59 | This compiles and links the test files into the specified directory. It uses |
| 60 | the Makefile and source files in the binman test/ directory. |
Simon Glass | f629089 | 2019-08-24 07:22:53 -0600 | [diff] [blame] | 61 | |
| 62 | Args: |
| 63 | target_dir: Directory to put the files into |
| 64 | """ |
| 65 | if not os.path.exists(target_dir): |
| 66 | os.mkdir(target_dir) |
| 67 | testdir = os.path.join(binman_dir, 'test') |
| 68 | |
| 69 | # If binman is involved from the main U-Boot Makefile the -r and -R |
| 70 | # flags are set in MAKEFLAGS. This prevents this Makefile from working |
| 71 | # correctly. So drop any make flags here. |
| 72 | if 'MAKEFLAGS' in os.environ: |
| 73 | del os.environ['MAKEFLAGS'] |
Simon Glass | 271fd8f | 2021-11-03 21:09:15 -0600 | [diff] [blame] | 74 | try: |
Simon Glass | 8002552 | 2022-01-29 14:14:04 -0700 | [diff] [blame] | 75 | tools.run('make', '-C', target_dir, '-f', |
Simon Glass | 271fd8f | 2021-11-03 21:09:15 -0600 | [diff] [blame] | 76 | os.path.join(testdir, 'Makefile'), 'SRC=%s/' % testdir) |
| 77 | except ValueError as e: |
| 78 | # The test system seems to suppress this in a strange way |
| 79 | print(e) |
Simon Glass | f629089 | 2019-08-24 07:22:53 -0600 | [diff] [blame] | 80 | |
| 81 | |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 82 | class TestElf(unittest.TestCase): |
Simon Glass | 752e755 | 2018-10-01 21:12:41 -0600 | [diff] [blame] | 83 | @classmethod |
Simon Glass | 4affd4b | 2019-08-24 07:22:54 -0600 | [diff] [blame] | 84 | def setUpClass(cls): |
| 85 | cls._indir = tempfile.mkdtemp(prefix='elf.') |
Simon Glass | 8002552 | 2022-01-29 14:14:04 -0700 | [diff] [blame] | 86 | tools.set_input_dirs(['.']) |
Simon Glass | 4affd4b | 2019-08-24 07:22:54 -0600 | [diff] [blame] | 87 | BuildElfTestFiles(cls._indir) |
| 88 | |
| 89 | @classmethod |
| 90 | def tearDownClass(cls): |
| 91 | if cls._indir: |
| 92 | shutil.rmtree(cls._indir) |
| 93 | |
| 94 | @classmethod |
| 95 | def ElfTestFile(cls, fname): |
| 96 | return os.path.join(cls._indir, fname) |
Simon Glass | 752e755 | 2018-10-01 21:12:41 -0600 | [diff] [blame] | 97 | |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 98 | def testAllSymbols(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 99 | """Test that we can obtain a symbol from the ELF file""" |
Simon Glass | 4affd4b | 2019-08-24 07:22:54 -0600 | [diff] [blame] | 100 | fname = self.ElfTestFile('u_boot_ucode_ptr') |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 101 | syms = elf.GetSymbols(fname, []) |
Simon Glass | 315400e | 2022-01-09 20:13:37 -0700 | [diff] [blame] | 102 | self.assertIn('_dt_ucode_base_size', syms) |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 103 | |
| 104 | def testRegexSymbols(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 105 | """Test that we can obtain from the ELF file by regular expression""" |
Simon Glass | 4affd4b | 2019-08-24 07:22:54 -0600 | [diff] [blame] | 106 | fname = self.ElfTestFile('u_boot_ucode_ptr') |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 107 | syms = elf.GetSymbols(fname, ['ucode']) |
Simon Glass | 315400e | 2022-01-09 20:13:37 -0700 | [diff] [blame] | 108 | self.assertIn('_dt_ucode_base_size', syms) |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 109 | syms = elf.GetSymbols(fname, ['missing']) |
Simon Glass | 315400e | 2022-01-09 20:13:37 -0700 | [diff] [blame] | 110 | self.assertNotIn('_dt_ucode_base_size', syms) |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 111 | syms = elf.GetSymbols(fname, ['missing', 'ucode']) |
Simon Glass | 315400e | 2022-01-09 20:13:37 -0700 | [diff] [blame] | 112 | self.assertIn('_dt_ucode_base_size', syms) |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 113 | |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 114 | def testMissingFile(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 115 | """Test that a missing file is detected""" |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 116 | entry = FakeEntry(10) |
Simon Glass | 8a6f56e | 2018-06-01 09:38:13 -0600 | [diff] [blame] | 117 | section = FakeSection() |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 118 | with self.assertRaises(ValueError) as e: |
Simon Glass | 2a0fa98 | 2022-02-11 13:23:21 -0700 | [diff] [blame] | 119 | elf.LookupAndWriteSymbols('missing-file', entry, section) |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 120 | self.assertIn("Filename 'missing-file' not found in input path", |
| 121 | str(e.exception)) |
| 122 | |
| 123 | def testOutsideFile(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 124 | """Test a symbol which extends outside the entry area is detected""" |
Stefan Herbrechtsmeier | 732742e | 2022-08-19 16:25:18 +0200 | [diff] [blame] | 125 | if not elf.ELF_TOOLS: |
| 126 | self.skipTest('Python elftools not available') |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 127 | entry = FakeEntry(10) |
Simon Glass | 8a6f56e | 2018-06-01 09:38:13 -0600 | [diff] [blame] | 128 | section = FakeSection() |
Simon Glass | 5d0c026 | 2019-08-24 07:22:56 -0600 | [diff] [blame] | 129 | elf_fname = self.ElfTestFile('u_boot_binman_syms') |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 130 | with self.assertRaises(ValueError) as e: |
Simon Glass | 2a0fa98 | 2022-02-11 13:23:21 -0700 | [diff] [blame] | 131 | elf.LookupAndWriteSymbols(elf_fname, entry, section) |
Alper Nebi Yasak | 9634dc9 | 2022-06-18 15:13:11 +0300 | [diff] [blame] | 132 | self.assertIn('entry_path has offset 8 (size 8) but the contents size ' |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 133 | 'is a', str(e.exception)) |
| 134 | |
| 135 | def testMissingImageStart(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 136 | """Test that we detect a missing __image_copy_start symbol |
| 137 | |
| 138 | This is needed to mark the start of the image. Without it we cannot |
| 139 | locate the offset of a binman symbol within the image. |
| 140 | """ |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 141 | entry = FakeEntry(10) |
Simon Glass | 8a6f56e | 2018-06-01 09:38:13 -0600 | [diff] [blame] | 142 | section = FakeSection() |
Simon Glass | 46ea691 | 2019-08-24 07:22:58 -0600 | [diff] [blame] | 143 | elf_fname = self.ElfTestFile('u_boot_binman_syms_bad') |
Simon Glass | 2a0fa98 | 2022-02-11 13:23:21 -0700 | [diff] [blame] | 144 | elf.LookupAndWriteSymbols(elf_fname, entry, section) |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 145 | |
| 146 | def testBadSymbolSize(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 147 | """Test that an attempt to use an 8-bit symbol are detected |
| 148 | |
| 149 | Only 32 and 64 bits are supported, since we need to store an offset |
| 150 | into the image. |
| 151 | """ |
Stefan Herbrechtsmeier | 732742e | 2022-08-19 16:25:18 +0200 | [diff] [blame] | 152 | if not elf.ELF_TOOLS: |
| 153 | self.skipTest('Python elftools not available') |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 154 | entry = FakeEntry(10) |
Simon Glass | 8a6f56e | 2018-06-01 09:38:13 -0600 | [diff] [blame] | 155 | section = FakeSection() |
Simon Glass | b8deb12 | 2019-08-24 07:22:57 -0600 | [diff] [blame] | 156 | elf_fname =self.ElfTestFile('u_boot_binman_syms_size') |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 157 | with self.assertRaises(ValueError) as e: |
Simon Glass | 2a0fa98 | 2022-02-11 13:23:21 -0700 | [diff] [blame] | 158 | elf.LookupAndWriteSymbols(elf_fname, entry, section) |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 159 | self.assertIn('has size 1: only 4 and 8 are supported', |
| 160 | str(e.exception)) |
| 161 | |
| 162 | def testNoValue(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 163 | """Test the case where we have no value for the symbol |
| 164 | |
| 165 | This should produce -1 values for all thress symbols, taking up the |
| 166 | first 16 bytes of the image. |
| 167 | """ |
Stefan Herbrechtsmeier | 732742e | 2022-08-19 16:25:18 +0200 | [diff] [blame] | 168 | if not elf.ELF_TOOLS: |
| 169 | self.skipTest('Python elftools not available') |
Alper Nebi Yasak | 9634dc9 | 2022-06-18 15:13:11 +0300 | [diff] [blame] | 170 | entry = FakeEntry(28) |
Simon Glass | 8a6f56e | 2018-06-01 09:38:13 -0600 | [diff] [blame] | 171 | section = FakeSection(sym_value=None) |
Simon Glass | 5d0c026 | 2019-08-24 07:22:56 -0600 | [diff] [blame] | 172 | elf_fname = self.ElfTestFile('u_boot_binman_syms') |
Simon Glass | 2a0fa98 | 2022-02-11 13:23:21 -0700 | [diff] [blame] | 173 | elf.LookupAndWriteSymbols(elf_fname, entry, section) |
Alper Nebi Yasak | 9634dc9 | 2022-06-18 15:13:11 +0300 | [diff] [blame] | 174 | expected = (struct.pack('<L', elf.BINMAN_SYM_MAGIC_VALUE) + |
| 175 | tools.get_bytes(255, 20) + |
| 176 | tools.get_bytes(ord('a'), 4)) |
| 177 | self.assertEqual(expected, entry.data) |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 178 | |
| 179 | def testDebug(self): |
Simon Glass | 4114f97 | 2018-07-17 13:25:26 -0600 | [diff] [blame] | 180 | """Check that enabling debug in the elf module produced debug output""" |
Stefan Herbrechtsmeier | 732742e | 2022-08-19 16:25:18 +0200 | [diff] [blame] | 181 | if not elf.ELF_TOOLS: |
| 182 | self.skipTest('Python elftools not available') |
Simon Glass | b6dff4c | 2019-07-20 12:23:36 -0600 | [diff] [blame] | 183 | try: |
Simon Glass | 011f1b3 | 2022-01-29 14:14:15 -0700 | [diff] [blame] | 184 | tout.init(tout.DEBUG) |
Alper Nebi Yasak | 9634dc9 | 2022-06-18 15:13:11 +0300 | [diff] [blame] | 185 | entry = FakeEntry(24) |
Simon Glass | b6dff4c | 2019-07-20 12:23:36 -0600 | [diff] [blame] | 186 | section = FakeSection() |
Simon Glass | 5d0c026 | 2019-08-24 07:22:56 -0600 | [diff] [blame] | 187 | elf_fname = self.ElfTestFile('u_boot_binman_syms') |
Simon Glass | b6dff4c | 2019-07-20 12:23:36 -0600 | [diff] [blame] | 188 | with test_util.capture_sys_output() as (stdout, stderr): |
Simon Glass | 2a0fa98 | 2022-02-11 13:23:21 -0700 | [diff] [blame] | 189 | elf.LookupAndWriteSymbols(elf_fname, entry, section) |
Simon Glass | b6dff4c | 2019-07-20 12:23:36 -0600 | [diff] [blame] | 190 | self.assertTrue(len(stdout.getvalue()) > 0) |
| 191 | finally: |
Simon Glass | 011f1b3 | 2022-01-29 14:14:15 -0700 | [diff] [blame] | 192 | tout.init(tout.WARNING) |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 193 | |
Simon Glass | 4f379ea | 2019-07-08 13:18:34 -0600 | [diff] [blame] | 194 | def testMakeElf(self): |
| 195 | """Test for the MakeElf function""" |
| 196 | outdir = tempfile.mkdtemp(prefix='elf.') |
| 197 | expected_text = b'1234' |
| 198 | expected_data = b'wxyz' |
| 199 | elf_fname = os.path.join(outdir, 'elf') |
Simon Glass | d349ada | 2019-08-24 07:22:45 -0600 | [diff] [blame] | 200 | bin_fname = os.path.join(outdir, 'bin') |
Simon Glass | 4f379ea | 2019-07-08 13:18:34 -0600 | [diff] [blame] | 201 | |
| 202 | # Make an Elf file and then convert it to a fkat binary file. This |
| 203 | # should produce the original data. |
| 204 | elf.MakeElf(elf_fname, expected_text, expected_data) |
Simon Glass | 8002552 | 2022-01-29 14:14:04 -0700 | [diff] [blame] | 205 | objcopy, args = tools.get_target_compile_tool('objcopy') |
Alper Nebi Yasak | 5cd321d | 2020-09-06 14:46:05 +0300 | [diff] [blame] | 206 | args += ['-O', 'binary', elf_fname, bin_fname] |
Simon Glass | 840be73 | 2022-01-29 14:14:05 -0700 | [diff] [blame] | 207 | stdout = command.output(objcopy, *args) |
Simon Glass | 4f379ea | 2019-07-08 13:18:34 -0600 | [diff] [blame] | 208 | with open(bin_fname, 'rb') as fd: |
| 209 | data = fd.read() |
| 210 | self.assertEqual(expected_text + expected_data, data) |
| 211 | shutil.rmtree(outdir) |
| 212 | |
Simon Glass | 567b682 | 2019-07-08 13:18:35 -0600 | [diff] [blame] | 213 | def testDecodeElf(self): |
| 214 | """Test for the MakeElf function""" |
| 215 | if not elf.ELF_TOOLS: |
| 216 | self.skipTest('Python elftools not available') |
| 217 | outdir = tempfile.mkdtemp(prefix='elf.') |
| 218 | expected_text = b'1234' |
| 219 | expected_data = b'wxyz' |
| 220 | elf_fname = os.path.join(outdir, 'elf') |
| 221 | elf.MakeElf(elf_fname, expected_text, expected_data) |
Simon Glass | 8002552 | 2022-01-29 14:14:04 -0700 | [diff] [blame] | 222 | data = tools.read_file(elf_fname) |
Simon Glass | 567b682 | 2019-07-08 13:18:35 -0600 | [diff] [blame] | 223 | |
| 224 | load = 0xfef20000 |
| 225 | entry = load + 2 |
| 226 | expected = expected_text + expected_data |
| 227 | self.assertEqual(elf.ElfInfo(expected, load, entry, len(expected)), |
| 228 | elf.DecodeElf(data, 0)) |
| 229 | self.assertEqual(elf.ElfInfo(b'\0\0' + expected[2:], |
| 230 | load, entry, len(expected)), |
| 231 | elf.DecodeElf(data, load + 2)) |
Simon Glass | 4affd4b | 2019-08-24 07:22:54 -0600 | [diff] [blame] | 232 | shutil.rmtree(outdir) |
Simon Glass | 567b682 | 2019-07-08 13:18:35 -0600 | [diff] [blame] | 233 | |
Simon Glass | a4e259e | 2021-11-03 21:09:16 -0600 | [diff] [blame] | 234 | def testEmbedData(self): |
| 235 | """Test for the GetSymbolFileOffset() function""" |
| 236 | if not elf.ELF_TOOLS: |
| 237 | self.skipTest('Python elftools not available') |
| 238 | |
| 239 | fname = self.ElfTestFile('embed_data') |
| 240 | offset = elf.GetSymbolFileOffset(fname, ['embed_start', 'embed_end']) |
| 241 | start = offset['embed_start'].offset |
| 242 | end = offset['embed_end'].offset |
Simon Glass | 8002552 | 2022-01-29 14:14:04 -0700 | [diff] [blame] | 243 | data = tools.read_file(fname) |
Simon Glass | a4e259e | 2021-11-03 21:09:16 -0600 | [diff] [blame] | 244 | embed_data = data[start:end] |
Simon Glass | 6490d4b | 2023-01-23 11:29:41 -0700 | [diff] [blame] | 245 | expect = struct.pack('<IIIII', 2, 3, 0x1234, 0x5678, 0) |
Simon Glass | a4e259e | 2021-11-03 21:09:16 -0600 | [diff] [blame] | 246 | self.assertEqual(expect, embed_data) |
| 247 | |
| 248 | def testEmbedFail(self): |
| 249 | """Test calling GetSymbolFileOffset() without elftools""" |
| 250 | try: |
| 251 | old_val = elf.ELF_TOOLS |
| 252 | elf.ELF_TOOLS = False |
| 253 | fname = self.ElfTestFile('embed_data') |
| 254 | with self.assertRaises(ValueError) as e: |
| 255 | elf.GetSymbolFileOffset(fname, ['embed_start', 'embed_end']) |
Simon Glass | acc0375 | 2022-03-05 20:18:57 -0700 | [diff] [blame] | 256 | self.assertIn("Python: No module named 'elftools'", |
Simon Glass | a4e259e | 2021-11-03 21:09:16 -0600 | [diff] [blame] | 257 | str(e.exception)) |
| 258 | finally: |
| 259 | elf.ELF_TOOLS = old_val |
| 260 | |
| 261 | def testEmbedDataNoSym(self): |
| 262 | """Test for GetSymbolFileOffset() getting no symbols""" |
| 263 | if not elf.ELF_TOOLS: |
| 264 | self.skipTest('Python elftools not available') |
| 265 | |
| 266 | fname = self.ElfTestFile('embed_data') |
| 267 | offset = elf.GetSymbolFileOffset(fname, ['missing_sym']) |
| 268 | self.assertEqual({}, offset) |
| 269 | |
Simon Glass | acc0375 | 2022-03-05 20:18:57 -0700 | [diff] [blame] | 270 | def test_read_loadable_segments(self): |
| 271 | """Test for read_loadable_segments()""" |
Simon Glass | 571adc8 | 2022-02-08 11:49:55 -0700 | [diff] [blame] | 272 | if not elf.ELF_TOOLS: |
| 273 | self.skipTest('Python elftools not available') |
| 274 | fname = self.ElfTestFile('embed_data') |
Simon Glass | acc0375 | 2022-03-05 20:18:57 -0700 | [diff] [blame] | 275 | segments, entry = elf.read_loadable_segments(tools.read_file(fname)) |
Simon Glass | 571adc8 | 2022-02-08 11:49:55 -0700 | [diff] [blame] | 276 | |
| 277 | def test_read_segments_fail(self): |
Simon Glass | acc0375 | 2022-03-05 20:18:57 -0700 | [diff] [blame] | 278 | """Test for read_loadable_segments() without elftools""" |
Simon Glass | 571adc8 | 2022-02-08 11:49:55 -0700 | [diff] [blame] | 279 | try: |
| 280 | old_val = elf.ELF_TOOLS |
| 281 | elf.ELF_TOOLS = False |
| 282 | fname = self.ElfTestFile('embed_data') |
| 283 | with self.assertRaises(ValueError) as e: |
Simon Glass | acc0375 | 2022-03-05 20:18:57 -0700 | [diff] [blame] | 284 | elf.read_loadable_segments(tools.read_file(fname)) |
| 285 | self.assertIn("Python: No module named 'elftools'", |
Simon Glass | 571adc8 | 2022-02-08 11:49:55 -0700 | [diff] [blame] | 286 | str(e.exception)) |
| 287 | finally: |
| 288 | elf.ELF_TOOLS = old_val |
| 289 | |
| 290 | def test_read_segments_bad_data(self): |
Simon Glass | acc0375 | 2022-03-05 20:18:57 -0700 | [diff] [blame] | 291 | """Test for read_loadable_segments() with an invalid ELF file""" |
Stefan Herbrechtsmeier | 732742e | 2022-08-19 16:25:18 +0200 | [diff] [blame] | 292 | if not elf.ELF_TOOLS: |
| 293 | self.skipTest('Python elftools not available') |
Simon Glass | 571adc8 | 2022-02-08 11:49:55 -0700 | [diff] [blame] | 294 | fname = self.ElfTestFile('embed_data') |
| 295 | with self.assertRaises(ValueError) as e: |
Simon Glass | acc0375 | 2022-03-05 20:18:57 -0700 | [diff] [blame] | 296 | elf.read_loadable_segments(tools.get_bytes(100, 100)) |
Simon Glass | 571adc8 | 2022-02-08 11:49:55 -0700 | [diff] [blame] | 297 | self.assertIn('Magic number does not match', str(e.exception)) |
| 298 | |
Simon Glass | ea64c02 | 2022-03-18 19:19:49 -0600 | [diff] [blame] | 299 | def test_get_file_offset(self): |
| 300 | """Test GetFileOffset() gives the correct file offset for a symbol""" |
Stefan Herbrechtsmeier | 732742e | 2022-08-19 16:25:18 +0200 | [diff] [blame] | 301 | if not elf.ELF_TOOLS: |
| 302 | self.skipTest('Python elftools not available') |
Simon Glass | ea64c02 | 2022-03-18 19:19:49 -0600 | [diff] [blame] | 303 | fname = self.ElfTestFile('embed_data') |
| 304 | syms = elf.GetSymbols(fname, ['embed']) |
| 305 | addr = syms['embed'].address |
| 306 | offset = elf.GetFileOffset(fname, addr) |
| 307 | data = tools.read_file(fname) |
| 308 | |
| 309 | # Just use the first 4 bytes and assume it is little endian |
| 310 | embed_data = data[offset:offset + 4] |
| 311 | embed_value = struct.unpack('<I', embed_data)[0] |
| 312 | self.assertEqual(0x1234, embed_value) |
| 313 | |
| 314 | def test_get_file_offset_fail(self): |
| 315 | """Test calling GetFileOffset() without elftools""" |
| 316 | try: |
| 317 | old_val = elf.ELF_TOOLS |
| 318 | elf.ELF_TOOLS = False |
| 319 | fname = self.ElfTestFile('embed_data') |
| 320 | with self.assertRaises(ValueError) as e: |
| 321 | elf.GetFileOffset(fname, 0) |
| 322 | self.assertIn("Python: No module named 'elftools'", |
| 323 | str(e.exception)) |
| 324 | finally: |
| 325 | elf.ELF_TOOLS = old_val |
| 326 | |
| 327 | def test_get_symbol_from_address(self): |
| 328 | """Test GetSymbolFromAddress()""" |
Stefan Herbrechtsmeier | 732742e | 2022-08-19 16:25:18 +0200 | [diff] [blame] | 329 | if not elf.ELF_TOOLS: |
| 330 | self.skipTest('Python elftools not available') |
Simon Glass | ea64c02 | 2022-03-18 19:19:49 -0600 | [diff] [blame] | 331 | fname = self.ElfTestFile('elf_sections') |
| 332 | sym_name = 'calculate' |
| 333 | syms = elf.GetSymbols(fname, [sym_name]) |
| 334 | addr = syms[sym_name].address |
| 335 | sym = elf.GetSymbolFromAddress(fname, addr) |
| 336 | self.assertEqual(sym_name, sym) |
| 337 | |
| 338 | def test_get_symbol_from_address_fail(self): |
| 339 | """Test calling GetSymbolFromAddress() without elftools""" |
| 340 | try: |
| 341 | old_val = elf.ELF_TOOLS |
| 342 | elf.ELF_TOOLS = False |
| 343 | fname = self.ElfTestFile('embed_data') |
| 344 | with self.assertRaises(ValueError) as e: |
| 345 | elf.GetSymbolFromAddress(fname, 0x1000) |
| 346 | self.assertIn("Python: No module named 'elftools'", |
| 347 | str(e.exception)) |
| 348 | finally: |
| 349 | elf.ELF_TOOLS = old_val |
| 350 | |
Simon Glass | 6e657f6 | 2023-01-07 14:07:13 -0700 | [diff] [blame] | 351 | def test_is_valid(self): |
| 352 | """Test is_valid()""" |
| 353 | self.assertEqual(False, elf.is_valid(b'')) |
| 354 | self.assertEqual(False, elf.is_valid(b'1234')) |
| 355 | |
| 356 | fname = self.ElfTestFile('elf_sections') |
| 357 | data = tools.read_file(fname) |
| 358 | self.assertEqual(True, elf.is_valid(data)) |
| 359 | self.assertEqual(False, elf.is_valid(data[4:])) |
| 360 | |
Simon Glass | 6490d4b | 2023-01-23 11:29:41 -0700 | [diff] [blame] | 361 | def test_get_symbol_offset(self): |
| 362 | fname = self.ElfTestFile('embed_data') |
| 363 | syms = elf.GetSymbols(fname, ['embed_start', 'embed']) |
| 364 | expected = syms['embed'].address - syms['embed_start'].address |
| 365 | val = elf.GetSymbolOffset(fname, 'embed', 'embed_start') |
| 366 | self.assertEqual(expected, val) |
| 367 | |
| 368 | with self.assertRaises(KeyError) as e: |
| 369 | elf.GetSymbolOffset(fname, 'embed') |
| 370 | self.assertIn('__image_copy_start', str(e.exception)) |
| 371 | |
Simon Glass | 4ca8e04 | 2017-11-13 18:55:01 -0700 | [diff] [blame] | 372 | |
Simon Glass | 24ad365 | 2017-11-13 18:54:54 -0700 | [diff] [blame] | 373 | if __name__ == '__main__': |
| 374 | unittest.main() |