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"
24 struct coff_file_header {
25 support::ulittle16_t Machine;
26 support::ulittle16_t NumberOfSections;
27 support::ulittle32_t TimeDateStamp;
28 support::ulittle32_t PointerToSymbolTable;
29 support::ulittle32_t NumberOfSymbols;
30 support::ulittle16_t SizeOfOptionalHeader;
31 support::ulittle16_t Characteristics;
35 struct StringTableOffset {
36 support::ulittle32_t Zeroes;
37 support::ulittle32_t Offset;
42 StringTableOffset Offset;
45 support::ulittle32_t Value;
46 support::little16_t SectionNumber;
48 support::ulittle16_t Type;
50 support::ulittle8_t StorageClass;
51 support::ulittle8_t NumberOfAuxSymbols;
53 uint8_t getBaseType() const {
57 uint8_t getComplexType() const {
58 return (Type & 0xF0) >> 4;
64 support::ulittle32_t VirtualSize;
65 support::ulittle32_t VirtualAddress;
66 support::ulittle32_t SizeOfRawData;
67 support::ulittle32_t PointerToRawData;
68 support::ulittle32_t PointerToRelocations;
69 support::ulittle32_t PointerToLinenumbers;
70 support::ulittle16_t NumberOfRelocations;
71 support::ulittle16_t NumberOfLinenumbers;
72 support::ulittle32_t Characteristics;
75 struct coff_relocation {
76 support::ulittle32_t VirtualAddress;
77 support::ulittle32_t SymbolTableIndex;
78 support::ulittle16_t Type;
81 struct coff_aux_section_definition {
82 support::ulittle32_t Length;
83 support::ulittle16_t NumberOfRelocations;
84 support::ulittle16_t NumberOfLinenumbers;
85 support::ulittle32_t CheckSum;
86 support::ulittle16_t Number;
87 support::ulittle8_t Selection;
91 class COFFObjectFile : public ObjectFile {
93 const coff_file_header *Header;
94 const coff_section *SectionTable;
95 const coff_symbol *SymbolTable;
96 const char *StringTable;
97 uint32_t StringTableSize;
99 error_code getString(uint32_t offset, StringRef &Res) const;
101 const coff_symbol *toSymb(DataRefImpl Symb) const;
102 const coff_section *toSec(DataRefImpl Sec) const;
103 const coff_relocation *toRel(DataRefImpl Rel) const;
106 virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
107 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
108 virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const;
109 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
110 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
111 virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
112 virtual error_code isSymbolInternal(DataRefImpl Symb, bool &Res) const;
113 virtual error_code isSymbolGlobal(DataRefImpl Symb, bool &Res) const;
114 virtual error_code isSymbolWeak(DataRefImpl Symb, bool &Res) const;
115 virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
116 virtual error_code isSymbolAbsolute(DataRefImpl Symb, bool &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 sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
131 virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
132 virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
134 virtual error_code getRelocationNext(DataRefImpl Rel,
135 RelocationRef &Res) const;
136 virtual error_code getRelocationAddress(DataRefImpl Rel,
137 uint64_t &Res) const;
138 virtual error_code getRelocationOffset(DataRefImpl Rel,
139 uint64_t &Res) const;
140 virtual error_code getRelocationSymbol(DataRefImpl Rel,
141 SymbolRef &Res) const;
142 virtual error_code getRelocationType(DataRefImpl Rel,
143 uint64_t &Res) const;
144 virtual error_code getRelocationTypeName(DataRefImpl Rel,
145 SmallVectorImpl<char> &Result) const;
146 virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
148 virtual error_code getRelocationValueString(DataRefImpl Rel,
149 SmallVectorImpl<char> &Result) const;
152 COFFObjectFile(MemoryBuffer *Object, error_code &ec);
153 virtual symbol_iterator begin_symbols() const;
154 virtual symbol_iterator end_symbols() const;
155 virtual symbol_iterator begin_dynamic_symbols() const;
156 virtual symbol_iterator end_dynamic_symbols() const;
157 virtual section_iterator begin_sections() const;
158 virtual section_iterator end_sections() const;
160 virtual uint8_t getBytesInAddress() const;
161 virtual StringRef getFileFormatName() const;
162 virtual unsigned getArch() const;
164 error_code getHeader(const coff_file_header *&Res) const;
165 error_code getSection(int32_t index, const coff_section *&Res) const;
166 error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
167 template <typename T>
168 error_code getAuxSymbol(uint32_t index, const T *&Res) const {
169 const coff_symbol *s;
170 error_code ec = getSymbol(index, s);
171 Res = reinterpret_cast<const T*>(s);
174 error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
176 static inline bool classof(const Binary *v) {
177 return v->getType() == isCOFF;
179 static inline bool classof(const COFFObjectFile *v) { return true; }