Object: Add isSymbolAbsolute and getSymbolSection.
[oota-llvm.git] / include / llvm / Object / COFF.h
1 //===- COFF.h - COFF object file implementation -----------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file declares the COFFObjectFile class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_OBJECT_COFF_H
15 #define LLVM_OBJECT_COFF_H
16
17 #include "llvm/Object/ObjectFile.h"
18 #include "llvm/Support/COFF.h"
19 #include "llvm/Support/Endian.h"
20
21 namespace llvm {
22 namespace object {
23
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;
32 };
33
34 struct coff_symbol {
35   struct StringTableOffset {
36     support::ulittle32_t Zeroes;
37     support::ulittle32_t Offset;
38   };
39
40   union {
41     char ShortName[8];
42     StringTableOffset Offset;
43   } Name;
44
45   support::ulittle32_t Value;
46   support::little16_t SectionNumber;
47
48   struct {
49     support::ulittle8_t BaseType;
50     support::ulittle8_t ComplexType;
51   } Type;
52
53   support::ulittle8_t  StorageClass;
54   support::ulittle8_t  NumberOfAuxSymbols;
55 };
56
57 struct coff_section {
58   char Name[8];
59   support::ulittle32_t VirtualSize;
60   support::ulittle32_t VirtualAddress;
61   support::ulittle32_t SizeOfRawData;
62   support::ulittle32_t PointerToRawData;
63   support::ulittle32_t PointerToRelocations;
64   support::ulittle32_t PointerToLinenumbers;
65   support::ulittle16_t NumberOfRelocations;
66   support::ulittle16_t NumberOfLinenumbers;
67   support::ulittle32_t Characteristics;
68 };
69
70 struct coff_relocation {
71   support::ulittle32_t VirtualAddress;
72   support::ulittle32_t SymbolTableIndex;
73   support::ulittle16_t Type;
74 };
75
76 struct coff_aux_section_definition {
77   support::ulittle32_t Length;
78   support::ulittle16_t NumberOfRelocations;
79   support::ulittle16_t NumberOfLinenumbers;
80   support::ulittle32_t CheckSum;
81   support::ulittle16_t Number;
82   support::ulittle8_t Selection;
83   char Unused[3];
84 };
85
86 class COFFObjectFile : public ObjectFile {
87 private:
88   const coff_file_header *Header;
89   const coff_section     *SectionTable;
90   const coff_symbol      *SymbolTable;
91   const char             *StringTable;
92         uint32_t          StringTableSize;
93
94         error_code        getString(uint32_t offset, StringRef &Res) const;
95
96   const coff_symbol      *toSymb(DataRefImpl Symb) const;
97   const coff_section     *toSec(DataRefImpl Sec) const;
98   const coff_relocation  *toRel(DataRefImpl Rel) const;
99
100 protected:
101   virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const;
102   virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const;
103   virtual error_code getSymbolOffset(DataRefImpl Symb, uint64_t &Res) const;
104   virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const;
105   virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const;
106   virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const;
107   virtual error_code isSymbolInternal(DataRefImpl Symb, bool &Res) const;
108   virtual error_code isSymbolGlobal(DataRefImpl Symb, bool &Res) const;
109   virtual error_code isSymbolWeak(DataRefImpl Symb, bool &Res) const;
110   virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::Type &Res) const;
111   virtual error_code isSymbolAbsolute(DataRefImpl Symb, bool &Res) const;
112   virtual error_code getSymbolSection(DataRefImpl Symb,
113                                       section_iterator &Res) const;
114
115   virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const;
116   virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const;
117   virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const;
118   virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const;
119   virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res) const;
120   virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res) const;
121   virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const;
122   virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const;
123   virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const;
124   virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
125                                            bool &Result) const;
126   virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const;
127   virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const;
128
129   virtual error_code getRelocationNext(DataRefImpl Rel,
130                                        RelocationRef &Res) const;
131   virtual error_code getRelocationAddress(DataRefImpl Rel,
132                                           uint64_t &Res) const;
133   virtual error_code getRelocationSymbol(DataRefImpl Rel,
134                                          SymbolRef &Res) const;
135   virtual error_code getRelocationType(DataRefImpl Rel,
136                                        uint32_t &Res) const;
137   virtual error_code getRelocationTypeName(DataRefImpl Rel,
138                                            SmallVectorImpl<char> &Result) const;
139   virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
140                                                  int64_t &Res) const;
141   virtual error_code getRelocationValueString(DataRefImpl Rel,
142                                            SmallVectorImpl<char> &Result) const;
143
144 public:
145   COFFObjectFile(MemoryBuffer *Object, error_code &ec);
146   virtual symbol_iterator begin_symbols() const;
147   virtual symbol_iterator end_symbols() const;
148   virtual section_iterator begin_sections() const;
149   virtual section_iterator end_sections() const;
150
151   virtual uint8_t getBytesInAddress() const;
152   virtual StringRef getFileFormatName() const;
153   virtual unsigned getArch() const;
154
155   error_code getHeader(const coff_file_header *&Res) const;
156   error_code getSection(int32_t index, const coff_section *&Res) const;
157   error_code getSymbol(uint32_t index, const coff_symbol *&Res) const;
158   template <typename T>
159   error_code getAuxSymbol(uint32_t index, const T *&Res) const {
160     const coff_symbol *s;
161     error_code ec = getSymbol(index, s);
162     Res = reinterpret_cast<const T*>(s);
163     return ec;
164   }
165   error_code getSymbolName(const coff_symbol *symbol, StringRef &Res) const;
166
167   static inline bool classof(const Binary *v) {
168     return v->getType() == isCOFF;
169   }
170   static inline bool classof(const COFFObjectFile *v) { return true; }
171 };
172
173 }
174 }
175
176 #endif