print st_type with the correct number of bits.
[oota-llvm.git] / test / Scripts / elf-dump
1 #!/usr/bin/env python
2
3 import struct
4 import sys
5 import StringIO
6
7 import common_dump
8
9 class Reader:
10     def __init__(self, path):
11         if path == "-":
12             # Snarf all the data so we can seek.
13             self.file = StringIO.StringIO(sys.stdin.read())
14         else:
15             self.file = open(path, "rb")
16         self.isLSB = None
17         self.is64Bit = None
18
19     def seek(self, pos):
20         self.file.seek(pos)
21
22     def read(self, N):
23         data = self.file.read(N)
24         if len(data) != N:
25             raise ValueError, "Out of data!"
26         return data
27
28     def read8(self):
29         return ord(self.read(1))
30
31     def read16(self):
32         return struct.unpack('><'[self.isLSB] + 'H', self.read(2))[0]
33
34     def read32(self):
35         return struct.unpack('><'[self.isLSB] + 'I', self.read(4))[0]
36
37     def read64(self):
38         return struct.unpack('><'[self.isLSB] + 'Q', self.read(8))[0]
39
40     def readWord(self):
41         if self.is64Bit:
42             return self.read64()
43         else:
44             return self.read32()
45
46 class StringTable:
47     def __init__(self, strings):
48        self.string_table = strings
49
50     def __getitem__(self, index):
51        end = self.string_table.index('\x00', index)
52        return self.string_table[index:end]
53
54 class Section:
55     def __init__(self, f):
56         self.sh_name = f.read32()
57         self.sh_type = f.read32()
58         self.sh_flags = f.readWord()
59         self.sh_addr = f.readWord()
60         self.sh_offset = f.readWord()
61         self.sh_size = f.readWord()
62         self.sh_link = f.read32()
63         self.sh_info = f.read32()
64         self.sh_addralign = f.readWord()
65         self.sh_entsize = f.readWord()
66
67     def dump(self, shstrtab, f, strtab, dumpdata):
68         print "  (('sh_name', %s)" % common_dump.HexDump(self.sh_name), "# %r" % shstrtab[self.sh_name]
69         print "   ('sh_type', %s)" % common_dump.HexDump(self.sh_type)
70         print "   ('sh_flags', %s)" % common_dump.HexDump(self.sh_flags)
71         print "   ('sh_addr', %s)" % common_dump.HexDump(self.sh_addr)
72         print "   ('sh_offset', %s)" % common_dump.HexDump(self.sh_offset)
73         print "   ('sh_size', %s)" % common_dump.HexDump(self.sh_size)
74         print "   ('sh_link', %s)" % common_dump.HexDump(self.sh_link)
75         print "   ('sh_info', %s)" % common_dump.HexDump(self.sh_info)
76         print "   ('sh_addralign', %s)" % common_dump.HexDump(self.sh_addralign)
77         print "   ('sh_entsize', %s)" % common_dump.HexDump(self.sh_entsize)
78         if self.sh_type == 2: # SHT_SYMTAB
79             print "   ('_symbols', ["
80             dumpSymtab(f, self, strtab)
81             print "   ])"
82         elif self.sh_type == 4 or self.sh_type == 9: # SHT_RELA / SHT_REL
83             print "   ('_relocations', ["
84             dumpRel(f, self, self.sh_type == 4)
85             print "   ])"
86         elif dumpdata:
87             f.seek(self.sh_offset)
88             if self.sh_type != 8: # != SHT_NOBITS
89                 data = f.read(self.sh_size)
90                 print "   ('_section_data', '%s')" % common_dump.dataToHex(data)
91             else:
92                 print "   ('_section_data', '')" 
93         print "  ),"
94
95 def dumpSymtab(f, section, strtab):
96     entries = section.sh_size // section.sh_entsize
97
98     for index in range(entries):
99         f.seek(section.sh_offset + index * section.sh_entsize)
100         print "    # Symbol %s" % index
101         name = f.read32()
102         print "    (('st_name', %s)" % common_dump.HexDump(name), "# %r" % strtab[name]
103         if not f.is64Bit:
104             print "     ('st_value', %s)" % common_dump.HexDump(f.read32())
105             print "     ('st_size', %s)" % common_dump.HexDump(f.read32())
106         st_info = f.read8()
107         st_bind = (st_info >> 4, 4)
108         st_type = (st_info & 0xf, 4)
109         print "     ('st_bind', %s)" % common_dump.HexDump(st_bind[0], st_bind[1])
110         print "     ('st_type', %s)" % common_dump.HexDump(st_type[0], st_type[1])
111         print "     ('st_other', %s)" % common_dump.HexDump(f.read8())
112         print "     ('st_shndx', %s)" % common_dump.HexDump(f.read16())
113         if f.is64Bit:
114             print "     ('st_value', %s)" % common_dump.HexDump(f.read64(), 64)
115             print "     ('st_size', %s)" % common_dump.HexDump(f.read64(), 64)
116         print "    ),"
117
118 def dumpRel(f, section, dumprela = False):
119     entries = section.sh_size // section.sh_entsize
120
121     for index in range(entries):
122         f.seek(section.sh_offset + index * section.sh_entsize)
123         print "    # Relocation %s" % index
124         print "    (('r_offset', %s)" % common_dump.HexDump(f.readWord())
125         r_info = f.readWord()
126         if f.is64Bit:
127             r_sym = (r_info >> 32, 32)
128             r_type = (r_info & 0xffffffff, 32)
129         else:
130             r_sym = (r_info >> 8, 24)
131             r_type = (r_info & 0xff, 8)
132         print "     ('r_sym', %s)" % common_dump.HexDump(r_sym[0], r_sym[1])
133         print "     ('r_type', %s)" % common_dump.HexDump(r_type[0], r_type[1])
134         if dumprela:
135             val = f.readWord()
136             if f.is64Bit:
137                 numBits = 64
138             else:
139                 numBits = 32
140             print "     ('r_addend', %s)" % common_dump.HexDump(val, numBits)
141         print "    ),"
142
143 def dumpELF(path, opts):
144     f = Reader(path)
145
146     magic = f.read(4)
147     assert magic == '\x7FELF'
148
149     fileclass = f.read8()
150     if fileclass == 1: # ELFCLASS32
151         f.is64Bit = False
152     elif fileclass == 2: # ELFCLASS64
153         f.is64Bit = True
154     else:
155         raise ValueError, "Unknown file class %s" % common_dump.HexDump(fileclass)
156     print "('e_indent[EI_CLASS]', %s)" % common_dump.HexDump(fileclass)
157
158     byteordering = f.read8()
159     if byteordering == 1: # ELFDATA2LSB
160         f.isLSB = True
161     elif byteordering == 2: # ELFDATA2MSB
162         f.isLSB = False
163     else:
164         raise ValueError, "Unknown byte ordering %s" % common_dump.HexDump(byteordering)
165     print "('e_indent[EI_DATA]', %s)" % common_dump.HexDump(byteordering)
166
167     print "('e_indent[EI_VERSION]', %s)" % common_dump.HexDump(f.read8())
168     print "('e_indent[EI_OSABI]', %s)" % common_dump.HexDump(f.read8())
169     print "('e_indent[EI_ABIVERSION]', %s)" % common_dump.HexDump(f.read8())
170
171     f.seek(16) # Seek to end of e_ident.
172
173     print "('e_type', %s)" % common_dump.HexDump(f.read16())
174     print "('e_machine', %s)" % common_dump.HexDump(f.read16())
175     print "('e_version', %s)" % common_dump.HexDump(f.read32())
176     print "('e_entry', %s)" % common_dump.HexDump(f.readWord())
177     print "('e_phoff', %s)" % common_dump.HexDump(f.readWord())
178     e_shoff = f.readWord()
179     print "('e_shoff', %s)" % common_dump.HexDump(e_shoff)
180     print "('e_flags', %s)" % common_dump.HexDump(f.read32())
181     print "('e_ehsize', %s)" % common_dump.HexDump(f.read16())
182     print "('e_phentsize', %s)" % common_dump.HexDump(f.read16())
183     print "('e_phnum', %s)" % common_dump.HexDump(f.read16())
184     e_shentsize = f.read16()
185     print "('e_shentsize', %s)" % common_dump.HexDump(e_shentsize)
186     e_shnum = f.read16()
187     print "('e_shnum', %s)" % common_dump.HexDump(e_shnum)
188     e_shstrndx = f.read16()
189     print "('e_shstrndx', %s)" % common_dump.HexDump(e_shstrndx)
190
191     # Read all section headers
192     sections = []
193     for index in range(e_shnum):
194         f.seek(e_shoff + index * e_shentsize)
195         s = Section(f)
196         sections.append(s)
197
198     # Read .shstrtab so we can resolve section names
199     f.seek(sections[e_shstrndx].sh_offset)
200     shstrtab = StringTable(f.read(sections[e_shstrndx].sh_size))
201
202     # Get the symbol string table
203     strtab = None
204     for section in sections:
205         if shstrtab[section.sh_name] == ".strtab":
206             f.seek(section.sh_offset)
207             strtab = StringTable(f.read(section.sh_size))
208             break
209
210     print "('_sections', ["
211     for index in range(e_shnum):
212         print "  # Section %s" % index
213         sections[index].dump(shstrtab, f, strtab, opts.dumpSectionData)
214     print "])"
215
216 if __name__ == "__main__":
217     from optparse import OptionParser, OptionGroup
218     parser = OptionParser("usage: %prog [options] {files}")
219     parser.add_option("", "--dump-section-data", dest="dumpSectionData",
220                       help="Dump the contents of sections",
221                       action="store_true", default=False)
222     (opts, args) = parser.parse_args()
223
224     if not args:
225         args.append('-')
226
227     for arg in args:
228         dumpELF(arg, opts)