1 //===- COFF.h - COFF object file implementation -----------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the COFFObjectFile class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_OBJECT_COFF_H
15 #define LLVM_OBJECT_COFF_H
17 #include "llvm/Object/ObjectFile.h"
18 #include "llvm/Support/COFF.h"
19 #include "llvm/Support/Endian.h"
27 struct coff_file_header {
28 support::ulittle16_t Machine;
29 support::ulittle16_t NumberOfSections;
30 support::ulittle32_t TimeDateStamp;
31 support::ulittle32_t PointerToSymbolTable;
32 support::ulittle32_t NumberOfSymbols;
33 support::ulittle16_t SizeOfOptionalHeader;
34 support::ulittle16_t Characteristics;
38 struct StringTableOffset {
39 support::ulittle32_t Zeroes;
40 support::ulittle32_t Offset;
45 StringTableOffset Offset;
48 support::ulittle32_t Value;
49 support::little16_t SectionNumber;
51 support::ulittle16_t Type;
53 support::ulittle8_t StorageClass;
54 support::ulittle8_t NumberOfAuxSymbols;
56 uint8_t getBaseType() const {
60 uint8_t getComplexType() const {
61 return (Type & 0xF0) >> 4;
67 support::ulittle32_t VirtualSize;
68 support::ulittle32_t VirtualAddress;
69 support::ulittle32_t SizeOfRawData;
70 support::ulittle32_t PointerToRawData;
71 support::ulittle32_t PointerToRelocations;
72 support::ulittle32_t PointerToLinenumbers;
73 support::ulittle16_t NumberOfRelocations;
74 support::ulittle16_t NumberOfLinenumbers;
75 support::ulittle32_t Characteristics;
78 struct coff_relocation {
79 support::ulittle32_t VirtualAddress;
80 support::ulittle32_t SymbolTableIndex;
81 support::ulittle16_t Type;
84 struct coff_aux_section_definition {
85 support::ulittle32_t Length;
86 support::ulittle16_t NumberOfRelocations;
87 support::ulittle16_t NumberOfLinenumbers;
88 support::ulittle32_t CheckSum;
89 support::ulittle16_t Number;
90 support::ulittle8_t Selection;
94 class COFFObjectFile : public ObjectFile {
96 const coff_file_header *Header;
97 const coff_section *SectionTable;
98 const coff_symbol *SymbolTable;
99 const char *StringTable;
100 uint32_t StringTableSize;
102 error_code getString(uint32_t offset, StringRef &Res) const;
104 const coff_symbol *toSymb(DataRefImpl Symb) const;
105 const coff_section *toSec(DataRefImpl Sec) const;
106 const coff_relocation *toRel(DataRefImpl Rel) const;
109 virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
110 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
111 virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
112 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
113 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
114 virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
115 virtual error_code getSymbolFlags(DataRefImpl Symb, uint32_t &Res) const;
116 virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
117 virtual error_code getSymbolSection(DataRefImpl Symb,
118 section_iterator &Res) const;
120 virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
121 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
122 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
123 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
124 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
125 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
126 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
127 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
128 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
129 virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const;
130 virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const;
131 virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const;
132 virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
134 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
136 virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
137 virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
139 virtual error_code getRelocationNext(DataRefImpl Rel,
140 RelocationRef &Res) const;
141 virtual error_code getRelocationAddress(DataRefImpl Rel,
142 uint64_t &Res) const;
143 virtual error_code getRelocationOffset(DataRefImpl Rel,
144 uint64_t &Res) const;
145 virtual error_code getRelocationSymbol(DataRefImpl Rel,
146 SymbolRef &Res) const;
147 virtual error_code getRelocationType(DataRefImpl Rel,
148 uint64_t &Res) const;
149 virtual error_code getRelocationTypeName(DataRefImpl Rel,
150 SmallVectorImpl<char> &Result) const;
151 virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
153 virtual error_code getRelocationValueString(DataRefImpl Rel,
154 SmallVectorImpl<char> &Result) const;
156 virtual error_code getLibraryNext(DataRefImpl LibData,
157 LibraryRef &Result) const;
158 virtual error_code getLibraryPath(DataRefImpl LibData,
159 StringRef &Result) const;
162 COFFObjectFile(MemoryBuffer *Object, error_code &ec);
163 virtual symbol_iterator begin_symbols() const;
164 virtual symbol_iterator end_symbols() const;
165 virtual symbol_iterator begin_dynamic_symbols() const;
166 virtual symbol_iterator end_dynamic_symbols() const;
167 virtual library_iterator begin_libraries_needed() const;
168 virtual library_iterator end_libraries_needed() const;
169 virtual section_iterator begin_sections() const;
170 virtual section_iterator end_sections() const;
172 const coff_section *getCOFFSection(section_iterator &It) const;
173 const coff_symbol *getCOFFSymbol(symbol_iterator &It) const;
174 const coff_relocation *getCOFFRelocation(relocation_iterator &It) const;
176 virtual uint8_t getBytesInAddress() const;
177 virtual StringRef getFileFormatName() const;
178 virtual unsigned getArch() const;
179 virtual StringRef getLoadName() const;
181 error_code getHeader(const coff_file_header *&Res) const;
182 error_code getSection(int32_t index, const coff_section *&Res) const;
183 error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
184 template <typename T>
185 error_code getAuxSymbol(uint32_t index, const T *&Res) const {
186 const coff_symbol *s;
187 error_code ec = getSymbol(index, s);
188 Res = reinterpret_cast<const T*>(s);
191 error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
192 ArrayRef<uint8_t> getSymbolAuxData(const coff_symbol *symbol) const;
194 error_code getSectionName(const coff_section *Sec, StringRef &Res) const;
195 error_code getSectionContents(const coff_section *Sec,
196 ArrayRef<uint8_t> &Res) const;
198 static inline bool classof(const Binary *v) {