1#!/usr/bin/env vpython 2# Copyright 2015 The Chromium Authors. All rights reserved. 3# Use of this source code is governed by a BSD-style license that can be 4# found in the LICENSE file. 5 6import unittest 7 8import symbol_extractor 9 10 11# The number of spaces that objdump prefixes each symbol with. 12SPACES = ' ' * 14 13 14 15class TestLlvmBitcodeSymbolExtractor(unittest.TestCase): 16 17 def testBasicParsing(self): 18 data = '''-------- T _ZN4base11GetFileSizeERKNS_8FilePathEPx 19aaaaaaaa W _ZNKSt3__19basic_iosIcNS_11char_traitsIcEEE5widenEc 20-------- T _ZN4base13ContentsEqualERKNS_8FilePathES2_ 21---------------- T _SymbolWithA64BitAddress_ 2200000000 W _ZNSt3__113basic_filebufIcNS_11char_traitsIcEEE11__read_modeEv''' 23 lines = data.split('\n') 24 25 symbol_names = symbol_extractor._SymbolInfosFromLlvmNm(lines) 26 self.assertEqual(5, len(symbol_names)) 27 self.assertListEqual( 28 ['_ZN4base11GetFileSizeERKNS_8FilePathEPx', 29 '_ZNKSt3__19basic_iosIcNS_11char_traitsIcEEE5widenEc', 30 '_ZN4base13ContentsEqualERKNS_8FilePathES2_', 31 '_SymbolWithA64BitAddress_', 32 '_ZNSt3__113basic_filebufIcNS_11char_traitsIcEEE11__read_modeEv'], 33 symbol_names) 34 35 36class TestSymbolInfo(unittest.TestCase): 37 38 def testIgnoresBlankLine(self): 39 symbol_info = symbol_extractor._FromObjdumpLine('') 40 self.assertIsNone(symbol_info) 41 42 def testIgnoresMalformedLine(self): 43 # This line is too short: only 6 flags. 44 line = ('00c1b228 F .text\t00000060' + SPACES + '_ZN20trace_event') 45 symbol_info = symbol_extractor._FromObjdumpLine(line) 46 self.assertIsNone(symbol_info) 47 48 def testWrongSymbolType(self): 49 # This line has unsupported 'f' as symbol type. 50 line = '00c1b228 l f .text\t00000060' + SPACES + '_ZN20trace_event' 51 self.assertRaises(AssertionError, symbol_extractor._FromObjdumpLine, line) 52 53 def testAssertionErrorOnInvalidLines(self): 54 # This line has an invalid scope. 55 line = ('00c1b228 z F .text\t00000060' + SPACES + '_ZN20trace_event') 56 self.assertRaises(AssertionError, symbol_extractor._FromObjdumpLine, line) 57 # This line has the symbol name with spaces in it. 58 line = ('00c1b228 l F .text\t00000060' + SPACES + 59 '_ZN20trace_event too many') 60 self.assertRaises(AssertionError, symbol_extractor._FromObjdumpLine, line) 61 # This line has invalid characters in the symbol name. 62 line = ('00c1b228 l F .text\t00000060' + SPACES + '_ZN20trace_?bad') 63 self.assertRaises(AssertionError, symbol_extractor._FromObjdumpLine, line) 64 # This line has an invalid character at the start of the symbol name. 65 line = ('00c1b228 l F .text\t00000060' + SPACES + '$_ZN20trace_bad') 66 self.assertRaises(AssertionError, symbol_extractor._FromObjdumpLine, line) 67 68 def testSymbolTypeObject(self): 69 # Builds with ThinLTO produce symbols of type 'O'. 70 line = ('009faf60 l O .text\t00000500' + SPACES + 'AES_Td') 71 symbol_info = symbol_extractor._FromObjdumpLine(line) 72 self.assertIsNotNone(symbol_info) 73 self.assertEquals(0x009faf60, symbol_info.offset) 74 self.assertEquals('.text', symbol_info.section) 75 self.assertEquals(0x500, symbol_info.size) 76 self.assertEquals('AES_Td', symbol_info.name) 77 78 def testSymbolFromLocalLabel(self): 79 line = ('00f64b80 l .text\t00000000' + SPACES + 'Builtins_Abort') 80 symbol_info = symbol_extractor._FromObjdumpLine(line) 81 self.assertIsNone(symbol_info) 82 83 def testStartOfText(self): 84 line = ('00918000 l .text\t00000000' + SPACES + 85 '.hidden linker_script_start_of_text') 86 symbol_info = symbol_extractor._FromObjdumpLine(line) 87 self.assertIsNotNone(symbol_info) 88 self.assertEquals(0x00918000, symbol_info.offset) 89 self.assertEquals('linker_script_start_of_text', symbol_info.name) 90 91 def testSymbolInfo(self): 92 line = ('00c1c05c l F .text\t0000002c' + SPACES + 93 '_GLOBAL__sub_I_chrome_main_delegate.cc') 94 test_name = '_GLOBAL__sub_I_chrome_main_delegate.cc' 95 test_offset = 0x00c1c05c 96 test_size = 0x2c 97 test_section = '.text' 98 symbol_info = symbol_extractor._FromObjdumpLine(line) 99 self.assertIsNotNone(symbol_info) 100 self.assertEquals(test_offset, symbol_info.offset) 101 self.assertEquals(test_size, symbol_info.size) 102 self.assertEquals(test_name, symbol_info.name) 103 self.assertEquals(test_section, symbol_info.section) 104 105 def testHiddenSymbol(self): 106 line = ('00c1c05c l F .text\t0000002c' + SPACES + 107 '.hidden _GLOBAL__sub_I_chrome_main_delegate.cc') 108 test_name = '_GLOBAL__sub_I_chrome_main_delegate.cc' 109 test_offset = 0x00c1c05c 110 test_size = 0x2c 111 test_section = '.text' 112 symbol_info = symbol_extractor._FromObjdumpLine(line) 113 self.assertIsNotNone(symbol_info) 114 self.assertEquals(test_offset, symbol_info.offset) 115 self.assertEquals(test_size, symbol_info.size) 116 self.assertEquals(test_name, symbol_info.name) 117 self.assertEquals(test_section, symbol_info.section) 118 119 def testDollarInSymbolName(self): 120 # A $ character elsewhere in the symbol name is fine. 121 # This is an example of a lambda function name from Clang. 122 line = ('00c1b228 l F .text\t00000060' + SPACES + 123 '_ZZL11get_globalsvENK3$_1clEv') 124 symbol_info = symbol_extractor._FromObjdumpLine(line) 125 self.assertIsNotNone(symbol_info) 126 self.assertEquals(0xc1b228, symbol_info.offset) 127 self.assertEquals(0x60, symbol_info.size) 128 self.assertEquals('_ZZL11get_globalsvENK3$_1clEv', symbol_info.name) 129 self.assertEquals('.text', symbol_info.section) 130 131 def testOutlinedFunction(self): 132 # Test that an outlined function is reported normally. Also note that 133 # outlined functions are in 64 bit builds which have longer addresses. 134 line = ('00000000020fab4c l F .text\t0000000000000014' + SPACES + 135 'OUTLINED_FUNCTION_4') 136 symbol_info = symbol_extractor._FromObjdumpLine(line) 137 self.assertIsNotNone(symbol_info) 138 self.assertEquals(0x20fab4c, symbol_info.offset) 139 self.assertEquals(0x14, symbol_info.size) 140 self.assertEquals('OUTLINED_FUNCTION_4', symbol_info.name) 141 self.assertEquals('.text', symbol_info.section) 142 143 def testNeitherLocalNorGlobalSymbol(self): 144 # This happens, see crbug.com/992884. 145 # Symbol which is neither local nor global. 146 line = '0287ae50 w F .text\t000001e8 log2l' 147 symbol_info = symbol_extractor._FromObjdumpLine(line) 148 self.assertIsNotNone(symbol_info) 149 self.assertEquals(0x287ae50, symbol_info.offset) 150 self.assertEquals(0x1e8, symbol_info.size) 151 self.assertEquals('log2l', symbol_info.name) 152 self.assertEquals('.text', symbol_info.section) 153 154class TestSymbolInfosFromStream(unittest.TestCase): 155 156 def testSymbolInfosFromStream(self): 157 lines = ['Garbage', 158 '', 159 '00c1c05c l F .text\t0000002c' + SPACES + 'first', 160 '' 161 'more garbage', 162 '00155 g F .text\t00000012' + SPACES + 'second'] 163 symbol_infos = symbol_extractor._SymbolInfosFromStream(lines) 164 self.assertEquals(len(symbol_infos), 2) 165 first = symbol_extractor.SymbolInfo('first', 0x00c1c05c, 0x2c, '.text') 166 self.assertEquals(first, symbol_infos[0]) 167 second = symbol_extractor.SymbolInfo('second', 0x00155, 0x12, '.text') 168 self.assertEquals(second, symbol_infos[1]) 169 170 171class TestSymbolInfoMappings(unittest.TestCase): 172 173 def setUp(self): 174 self.symbol_infos = [ 175 symbol_extractor.SymbolInfo('firstNameAtOffset', 0x42, 42, '.text'), 176 symbol_extractor.SymbolInfo('secondNameAtOffset', 0x42, 42, '.text'), 177 symbol_extractor.SymbolInfo('thirdSymbol', 0x64, 20, '.text')] 178 179 def testGroupSymbolInfosByOffset(self): 180 offset_to_symbol_info = symbol_extractor.GroupSymbolInfosByOffset( 181 self.symbol_infos) 182 self.assertEquals(len(offset_to_symbol_info), 2) 183 self.assertIn(0x42, offset_to_symbol_info) 184 self.assertEquals(offset_to_symbol_info[0x42][0], self.symbol_infos[0]) 185 self.assertEquals(offset_to_symbol_info[0x42][1], self.symbol_infos[1]) 186 self.assertIn(0x64, offset_to_symbol_info) 187 self.assertEquals(offset_to_symbol_info[0x64][0], self.symbol_infos[2]) 188 189 def testCreateNameToSymbolInfo(self): 190 name_to_symbol_info = symbol_extractor.CreateNameToSymbolInfo( 191 self.symbol_infos) 192 self.assertEquals(len(name_to_symbol_info), 3) 193 for i in range(3): 194 name = self.symbol_infos[i].name 195 self.assertIn(name, name_to_symbol_info) 196 self.assertEquals(self.symbol_infos[i], name_to_symbol_info[name]) 197 198 def testSymbolCollisions(self): 199 symbol_infos_with_collision = list(self.symbol_infos) 200 symbol_infos_with_collision.append(symbol_extractor.SymbolInfo( 201 'secondNameAtOffset', 0x84, 42, '.text')) 202 203 # The symbol added above should not affect the output. 204 name_to_symbol_info = symbol_extractor.CreateNameToSymbolInfo( 205 self.symbol_infos) 206 self.assertEquals(len(name_to_symbol_info), 3) 207 for i in range(3): 208 name = self.symbol_infos[i].name 209 self.assertIn(name, name_to_symbol_info) 210 self.assertEquals(self.symbol_infos[i], name_to_symbol_info[name]) 211 212if __name__ == '__main__': 213 unittest.main() 214