symbol_extractor_unittest.py 8.9 KB

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