blob: 281cf2fa11e7f74bdc88ab8910e778345d8efaa0 [file] [log] [blame]
Chris Lattner35f0a4f2005-06-27 06:29:00 +00001//===-- ELFWriter.cpp - Target-independent ELF Writer code ----------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner35f0a4f2005-06-27 06:29:00 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file implements the target-independent ELF writer. This file writes out
11// the ELF file in the following order:
12//
13// #1. ELF Header
Chris Lattner80ed8fa2005-07-07 07:02:20 +000014// #2. '.text' section
15// #3. '.data' section
16// #4. '.bss' section (conceptual position in file)
Chris Lattner35f0a4f2005-06-27 06:29:00 +000017// ...
18// #X. '.shstrtab' section
19// #Y. Section Table
20//
21// The entries in the section table are laid out as:
22// #0. Null entry [required]
Chris Lattner80ed8fa2005-07-07 07:02:20 +000023// #1. ".text" entry - the program code
24// #2. ".data" entry - global variables with initializers. [ if needed ]
25// #3. ".bss" entry - global variables without initializers. [ if needed ]
Chris Lattner35f0a4f2005-06-27 06:29:00 +000026// ...
27// #N. ".shstrtab" entry - String table for the section names.
Chris Lattner35f0a4f2005-06-27 06:29:00 +000028//
Chris Lattner35f0a4f2005-06-27 06:29:00 +000029//===----------------------------------------------------------------------===//
30
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +000031#define DEBUG_TYPE "elfwriter"
32
Bill Wendling8f84f1f2007-02-08 01:35:27 +000033#include "ELFWriter.h"
Bruno Cardoso Lopes4cb31432009-06-03 17:47:27 +000034#include "ELFCodeEmitter.h"
Bruno Cardoso Lopesf5b0c5a2009-06-06 03:56:29 +000035#include "ELF.h"
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +000036#include "llvm/Constants.h"
Chris Lattner35f0a4f2005-06-27 06:29:00 +000037#include "llvm/Module.h"
Bill Wendling8f84f1f2007-02-08 01:35:27 +000038#include "llvm/PassManager.h"
Chris Lattner02b73ab2009-01-04 20:19:20 +000039#include "llvm/DerivedTypes.h"
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +000040#include "llvm/CodeGen/BinaryObject.h"
Bill Wendling8f84f1f2007-02-08 01:35:27 +000041#include "llvm/CodeGen/FileWriters.h"
Chris Lattneraa507db2005-07-11 05:17:18 +000042#include "llvm/CodeGen/MachineCodeEmitter.h"
43#include "llvm/CodeGen/MachineConstantPool.h"
Bill Wendling8f84f1f2007-02-08 01:35:27 +000044#include "llvm/CodeGen/MachineFunctionPass.h"
Owen Anderson07000c62006-05-12 06:33:49 +000045#include "llvm/Target/TargetData.h"
Chris Lattner35f0a4f2005-06-27 06:29:00 +000046#include "llvm/Target/TargetMachine.h"
Chris Lattner5acd1202005-07-11 03:11:47 +000047#include "llvm/Support/Mangler.h"
Bill Wendlingbdc679d2006-11-29 00:39:47 +000048#include "llvm/Support/Streams.h"
Owen Andersoncb371882008-08-21 00:14:44 +000049#include "llvm/Support/raw_ostream.h"
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +000050#include "llvm/Support/Debug.h"
Bill Wendling8f84f1f2007-02-08 01:35:27 +000051#include <list>
Chris Lattner35f0a4f2005-06-27 06:29:00 +000052using namespace llvm;
53
Devang Patel19974732007-05-03 01:11:54 +000054char ELFWriter::ID = 0;
Bill Wendling8f84f1f2007-02-08 01:35:27 +000055/// AddELFWriter - Concrete function to add the ELF writer to the function pass
56/// manager.
Dan Gohmanbfae8312008-03-11 22:29:46 +000057MachineCodeEmitter *llvm::AddELFWriter(PassManagerBase &PM,
Owen Andersoncb371882008-08-21 00:14:44 +000058 raw_ostream &O,
Bill Wendling8f84f1f2007-02-08 01:35:27 +000059 TargetMachine &TM) {
60 ELFWriter *EW = new ELFWriter(O, TM);
Dan Gohmanbfae8312008-03-11 22:29:46 +000061 PM.add(EW);
Bill Wendling8f84f1f2007-02-08 01:35:27 +000062 return &EW->getMachineCodeEmitter();
63}
64
Chris Lattner0e180502005-07-11 06:34:30 +000065//===----------------------------------------------------------------------===//
Chris Lattner0e180502005-07-11 06:34:30 +000066// ELFWriter Implementation
67//===----------------------------------------------------------------------===//
Chris Lattneraa507db2005-07-11 05:17:18 +000068
Bruno Cardoso Lopes4cb31432009-06-03 17:47:27 +000069ELFWriter::ELFWriter(raw_ostream &o, TargetMachine &tm)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +000070 : MachineFunctionPass(&ID), O(o), TM(tm),
71 is64Bit(TM.getTargetData()->getPointerSizeInBits() == 64),
72 isLittleEndian(TM.getTargetData()->isLittleEndian()),
73 ElfHdr(isLittleEndian, is64Bit) {
Chris Lattneraa507db2005-07-11 05:17:18 +000074
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +000075 TAI = TM.getTargetAsmInfo();
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +000076 TEW = TM.getELFWriterInfo();
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +000077
Chris Lattneraa507db2005-07-11 05:17:18 +000078 // Create the machine code emitter object for this target.
Bill Wendlinge9116152007-01-17 09:06:13 +000079 MCE = new ELFCodeEmitter(*this);
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +000080
81 // Inital number of sections
Chris Lattner5f48ff72005-07-16 08:01:13 +000082 NumSections = 0;
Chris Lattneraa507db2005-07-11 05:17:18 +000083}
84
85ELFWriter::~ELFWriter() {
86 delete MCE;
Chris Lattner35f0a4f2005-06-27 06:29:00 +000087}
88
89// doInitialization - Emit the file header and all of the global variables for
90// the module to the ELF file.
91bool ELFWriter::doInitialization(Module &M) {
Chris Lattner5acd1202005-07-11 03:11:47 +000092 Mang = new Mangler(M);
93
Bruno Cardoso Lopesf5b0c5a2009-06-06 03:56:29 +000094 // ELF Header
95 // ----------
96 // Fields e_shnum e_shstrndx are only known after all section have
97 // been emitted. They locations in the ouput buffer are recorded so
98 // to be patched up later.
99 //
100 // Note
101 // ----
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000102 // emitWord method behaves differently for ELF32 and ELF64, writing
Bruno Cardoso Lopesf5b0c5a2009-06-06 03:56:29 +0000103 // 4 bytes in the former and 8 in the last for *_off and *_addr elf types
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000104
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000105 ElfHdr.emitByte(0x7f); // e_ident[EI_MAG0]
106 ElfHdr.emitByte('E'); // e_ident[EI_MAG1]
107 ElfHdr.emitByte('L'); // e_ident[EI_MAG2]
108 ElfHdr.emitByte('F'); // e_ident[EI_MAG3]
Bruno Cardoso Lopesf5b0c5a2009-06-06 03:56:29 +0000109
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000110 ElfHdr.emitByte(TEW->getEIClass()); // e_ident[EI_CLASS]
111 ElfHdr.emitByte(TEW->getEIData()); // e_ident[EI_DATA]
112 ElfHdr.emitByte(EV_CURRENT); // e_ident[EI_VERSION]
113 ElfHdr.emitAlignment(16); // e_ident[EI_NIDENT-EI_PAD]
Bruno Cardoso Lopesf5b0c5a2009-06-06 03:56:29 +0000114
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000115 ElfHdr.emitWord16(ET_REL); // e_type
116 ElfHdr.emitWord16(TEW->getEMachine()); // e_machine = target
117 ElfHdr.emitWord32(EV_CURRENT); // e_version
118 ElfHdr.emitWord(0); // e_entry, no entry point in .o file
119 ElfHdr.emitWord(0); // e_phoff, no program header for .o
120 ELFHdr_e_shoff_Offset = ElfHdr.size();
121 ElfHdr.emitWord(0); // e_shoff = sec hdr table off in bytes
122 ElfHdr.emitWord32(TEW->getEFlags()); // e_flags = whatever the target wants
123 ElfHdr.emitWord16(TEW->getHdrSize()); // e_ehsize = ELF header size
124 ElfHdr.emitWord16(0); // e_phentsize = prog header entry size
125 ElfHdr.emitWord16(0); // e_phnum = # prog header entries = 0
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000126
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000127 // e_shentsize = Section header entry size
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000128 ElfHdr.emitWord16(TEW->getSHdrSize());
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000129
Bruno Cardoso Lopesf5b0c5a2009-06-06 03:56:29 +0000130 // e_shnum = # of section header ents
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000131 ELFHdr_e_shnum_Offset = ElfHdr.size();
132 ElfHdr.emitWord16(0); // Placeholder
Jeff Cohen00b168892005-07-27 06:12:32 +0000133
Bruno Cardoso Lopesf5b0c5a2009-06-06 03:56:29 +0000134 // e_shstrndx = Section # of '.shstrtab'
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000135 ELFHdr_e_shstrndx_Offset = ElfHdr.size();
136 ElfHdr.emitWord16(0); // Placeholder
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000137
Chris Lattner5f48ff72005-07-16 08:01:13 +0000138 // Add the null section, which is required to be first in the file.
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000139 getNullSection();
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000140
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000141 return false;
142}
143
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000144unsigned ELFWriter::getGlobalELFLinkage(const GlobalVariable *GV) {
145 if (GV->hasInternalLinkage())
146 return ELFSym::STB_LOCAL;
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000147
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000148 if (GV->hasWeakLinkage())
149 return ELFSym::STB_WEAK;
150
151 return ELFSym::STB_GLOBAL;
152}
153
154// For global symbols without a section, return the Null section as a
155// placeholder
156ELFSection &ELFWriter::getGlobalSymELFSection(const GlobalVariable *GV,
157 ELFSym &Sym) {
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000158 const Section *S = TAI->SectionForGlobal(GV);
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000159 unsigned Flags = S->getFlags();
160 unsigned SectionType = ELFSection::SHT_PROGBITS;
161 unsigned SHdrFlags = ELFSection::SHF_ALLOC;
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000162 const TargetData *TD = TM.getTargetData();
163 unsigned Align = TD->getPreferredAlignment(GV);
164 Constant *CV = GV->getInitializer();
Chris Lattner4c47e3a2005-07-08 05:47:00 +0000165
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000166 DOUT << "Section " << S->getName() << " for global " << GV->getName() << "\n";
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000167
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000168 // If this is an external global, the symbol does not have a section.
169 if (!GV->hasInitializer()) {
170 Sym.SectionIdx = ELFSection::SHN_UNDEF;
171 return getNullSection();
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000172 }
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000173
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000174 if (Flags & SectionFlags::Code)
175 SHdrFlags |= ELFSection::SHF_EXECINSTR;
176 if (Flags & SectionFlags::Writeable)
177 SHdrFlags |= ELFSection::SHF_WRITE;
178 if (Flags & SectionFlags::Mergeable)
179 SHdrFlags |= ELFSection::SHF_MERGE;
180 if (Flags & SectionFlags::TLS)
181 SHdrFlags |= ELFSection::SHF_TLS;
182 if (Flags & SectionFlags::Strings)
183 SHdrFlags |= ELFSection::SHF_STRINGS;
184
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000185 // If this global has a zero initializer, go to .bss or common section.
186 // Variables are part of the common block if they are zero initialized
187 // and allowed to be merged with other symbols.
188 if (CV->isNullValue() || isa<UndefValue>(CV)) {
189 SectionType = ELFSection::SHT_NOBITS;
190 ELFSection &ElfS = getSection(S->getName(), SectionType, SHdrFlags);
191 if (GV->hasLinkOnceLinkage() || GV->hasWeakLinkage() ||
192 GV->hasCommonLinkage()) {
193 Sym.SectionIdx = ELFSection::SHN_COMMON;
194 Sym.IsCommon = true;
195 return ElfS;
196 }
197 Sym.IsBss = true;
198 Sym.SectionIdx = ElfS.SectionIdx;
199 if (Align) ElfS.Size = (ElfS.Size + Align-1) & ~(Align-1);
200 ElfS.Align = std::max(ElfS.Align, Align);
201 return ElfS;
202 }
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000203
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000204 Sym.IsConstant = true;
205 ELFSection &ElfS = getSection(S->getName(), SectionType, SHdrFlags);
206 Sym.SectionIdx = ElfS.SectionIdx;
207 ElfS.Align = std::max(ElfS.Align, Align);
208 return ElfS;
209}
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000210
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000211void ELFWriter::EmitFunctionDeclaration(const Function *F) {
212 ELFSym GblSym(F);
213 GblSym.setBind(ELFSym::STB_GLOBAL);
214 GblSym.setType(ELFSym::STT_NOTYPE);
215 GblSym.SectionIdx = ELFSection::SHN_UNDEF;
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000216 SymbolList.push_back(GblSym);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000217}
218
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000219void ELFWriter::EmitGlobalVar(const GlobalVariable *GV) {
220 unsigned SymBind = getGlobalELFLinkage(GV);
221 ELFSym GblSym(GV);
222 GblSym.setBind(SymBind);
223
224 if (GV->hasInitializer())
225 GblSym.setType(ELFSym::STT_OBJECT);
226 else
227 GblSym.setType(ELFSym::STT_NOTYPE);
228
229 ELFSection &GblSection = getGlobalSymELFSection(GV, GblSym);
230 const TargetData *TD = TM.getTargetData();
231 unsigned Align = TD->getPreferredAlignment(GV);
232 unsigned Size = TD->getTypeAllocSize(GV->getInitializer()->getType());
233 GblSym.Size = Size;
234
235 if (GblSym.IsCommon) {
236 GblSym.Value = Align;
237 } else if (GblSym.IsBss) {
238 GblSym.Value = GblSection.Size;
239 GblSection.Size += Size;
240 } else if (GblSym.IsConstant){
241 // GblSym.Value should contain the symbol index inside the section,
242 // and all symbols should start on their required alignment boundary
243 GblSym.Value = (GblSection.size() + (Align-1)) & (-Align);
244 GblSection.emitAlignment(Align);
245 EmitGlobalConstant(GV->getInitializer(), GblSection);
246 }
247
248 // Local symbols should come first on the symbol table.
249 if (!GV->hasPrivateLinkage()) {
250 if (SymBind == ELFSym::STB_LOCAL)
251 SymbolList.push_front(GblSym);
252 else
253 SymbolList.push_back(GblSym);
254 }
255}
256
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000257void ELFWriter::EmitGlobalConstantStruct(const ConstantStruct *CVS,
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000258 ELFSection &GblS) {
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000259
260 // Print the fields in successive locations. Pad to align if needed!
261 const TargetData *TD = TM.getTargetData();
262 unsigned Size = TD->getTypeAllocSize(CVS->getType());
263 const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
264 uint64_t sizeSoFar = 0;
265 for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
266 const Constant* field = CVS->getOperand(i);
267
268 // Check if padding is needed and insert one or more 0s.
269 uint64_t fieldSize = TD->getTypeAllocSize(field->getType());
270 uint64_t padSize = ((i == e-1 ? Size : cvsLayout->getElementOffset(i+1))
271 - cvsLayout->getElementOffset(i)) - fieldSize;
272 sizeSoFar += fieldSize + padSize;
273
274 // Now print the actual field value.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000275 EmitGlobalConstant(field, GblS);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000276
277 // Insert padding - this may include padding to increase the size of the
278 // current field up to the ABI size (if the struct is not packed) as well
279 // as padding to ensure that the next field starts at the right offset.
280 for (unsigned p=0; p < padSize; p++)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000281 GblS.emitByte(0);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000282 }
283 assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
284 "Layout of constant struct may be incorrect!");
285}
286
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000287void ELFWriter::EmitGlobalConstant(const Constant *CV, ELFSection &GblS) {
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000288 const TargetData *TD = TM.getTargetData();
289 unsigned Size = TD->getTypeAllocSize(CV->getType());
290
291 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
292 if (CVA->isString()) {
293 std::string GblStr = CVA->getAsString();
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000294 GblStr.resize(GblStr.size()-1);
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000295 GblS.emitString(GblStr);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000296 } else { // Not a string. Print the values in successive locations
297 for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000298 EmitGlobalConstant(CVA->getOperand(i), GblS);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000299 }
300 return;
301 } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000302 EmitGlobalConstantStruct(CVS, GblS);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000303 return;
304 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
305 uint64_t Val = CFP->getValueAPF().bitcastToAPInt().getZExtValue();
306 if (CFP->getType() == Type::DoubleTy)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000307 GblS.emitWord64(Val);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000308 else if (CFP->getType() == Type::FloatTy)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000309 GblS.emitWord32(Val);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000310 else if (CFP->getType() == Type::X86_FP80Ty) {
311 assert(0 && "X86_FP80Ty global emission not implemented");
312 } else if (CFP->getType() == Type::PPC_FP128Ty)
313 assert(0 && "PPC_FP128Ty global emission not implemented");
314 return;
315 } else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
316 if (Size == 4)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000317 GblS.emitWord32(CI->getZExtValue());
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000318 else if (Size == 8)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000319 GblS.emitWord64(CI->getZExtValue());
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000320 else
321 assert(0 && "LargeInt global emission not implemented");
322 return;
323 } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
324 const VectorType *PTy = CP->getType();
325 for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000326 EmitGlobalConstant(CP->getOperand(I), GblS);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000327 return;
328 }
329 assert(0 && "unknown global constant");
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000330}
331
332
333bool ELFWriter::runOnMachineFunction(MachineFunction &MF) {
Chris Lattneraa507db2005-07-11 05:17:18 +0000334 // Nothing to do here, this is all done through the MCE object above.
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000335 return false;
336}
337
338/// doFinalization - Now that the module has been completely processed, emit
339/// the ELF file to 'O'.
340bool ELFWriter::doFinalization(Module &M) {
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000341 /// FIXME: This should be removed when moving to ObjectCodeEmiter. Since the
342 /// current ELFCodeEmiter uses CurrBuff, ... it doesn't update S.Data
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000343 /// vector size for .text sections, so this is a quick dirty fix
344 ELFSection &TS = getTextSection();
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000345 if (TS.Size) {
346 BinaryData &BD = TS.getData();
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000347 for (unsigned e=0; e<TS.Size; ++e)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000348 BD.push_back(BD[e]);
349 }
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000350
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000351 // Emit .data section placeholder
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000352 getDataSection();
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000353
354 // Emit .bss section placeholder
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000355 getBSSSection();
356
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000357 // Build and emit data, bss and "common" sections.
Chris Lattner5f48ff72005-07-16 08:01:13 +0000358 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000359 I != E; ++I) {
360 EmitGlobalVar(I);
361 GblSymLookup[I] = 0;
362 }
363
364 // Emit all pending globals
365 // TODO: this should be done only for referenced symbols
366 for (SetVector<GlobalValue*>::const_iterator I = PendingGlobals.begin(),
367 E = PendingGlobals.end(); I != E; ++I) {
368
369 // No need to emit the symbol again
370 if (GblSymLookup.find(*I) != GblSymLookup.end())
371 continue;
372
373 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
374 EmitGlobalVar(GV);
375 } else if (Function *F = dyn_cast<Function>(*I)) {
376 // If function is not in GblSymLookup, it doesn't have a body,
377 // so emit the symbol as a function declaration (no section associated)
378 EmitFunctionDeclaration(F);
379 } else {
380 assert("unknown howto handle pending global");
381 }
382 GblSymLookup[*I] = 0;
383 }
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000384
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000385 // Emit non-executable stack note
386 if (TAI->getNonexecutableStackDirective())
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000387 getNonExecStackSection();
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000388
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000389 // Emit the symbol table now, if non-empty.
390 EmitSymbolTable();
391
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000392 // Emit the relocation sections.
393 EmitRelocations();
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000394
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000395 // Emit the sections string table.
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000396 EmitSectionTableStringTable();
397
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000398 // Dump the sections and section table to the .o file.
Chris Lattner5f48ff72005-07-16 08:01:13 +0000399 OutputSectionsAndSectionTable();
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000400
Chris Lattner5f48ff72005-07-16 08:01:13 +0000401 // We are done with the abstract symbols.
402 SectionList.clear();
403 NumSections = 0;
Chris Lattner5acd1202005-07-11 03:11:47 +0000404
405 // Release the name mangler object.
406 delete Mang; Mang = 0;
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000407 return false;
408}
409
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000410/// EmitRelocations - Emit relocations
411void ELFWriter::EmitRelocations() {
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000412
413 // Create Relocation sections for each section which needs it.
414 for (std::list<ELFSection>::iterator I = SectionList.begin(),
415 E = SectionList.end(); I != E; ++I) {
416
417 // This section does not have relocations
418 if (!I->hasRelocations()) continue;
419
420 // Get the relocation section for section 'I'
421 bool HasRelA = TEW->hasRelocationAddend();
422 ELFSection &RelSec = getRelocSection(I->getName(), HasRelA);
423
424 // 'Link' - Section hdr idx of the associated symbol table
425 // 'Info' - Section hdr idx of the section to which the relocation applies
426 ELFSection &SymTab = getSymbolTableSection();
427 RelSec.Link = SymTab.SectionIdx;
428 RelSec.Info = I->SectionIdx;
429 RelSec.EntSize = TEW->getRelocationEntrySize();
430
431 // Get the relocations from Section
432 std::vector<MachineRelocation> Relos = I->getRelocations();
433 for (std::vector<MachineRelocation>::iterator MRI = Relos.begin(),
434 MRE = Relos.end(); MRI != MRE; ++MRI) {
435 MachineRelocation &MR = *MRI;
436
437 // Offset from the start of the section containing the symbol
438 unsigned Offset = MR.getMachineCodeOffset();
439
440 // Symbol index in the symbol table
441 unsigned SymIdx = 0;
442
443 // Target specific ELF relocation type
444 unsigned RelType = TEW->getRelocationType(MR.getRelocationType());
445
446 // Constant addend used to compute the value to be stored
447 // into the relocatable field
448 int64_t Addend = TEW->getAddendForRelTy(RelType);
449
450 // There are several machine relocations types, and each one of
451 // them needs a different approach to retrieve the symbol table index.
452 if (MR.isGlobalValue()) {
453 const GlobalValue *G = MR.getGlobalValue();
454 SymIdx = GblSymLookup[G];
455 } else {
456 assert(0 && "dunno how to handle other relocation types");
457 }
458
459 // Get the relocation entry and emit to the relocation section
460 ELFRelocation Rel(Offset, SymIdx, RelType, HasRelA, Addend);
461 EmitRelocation(RelSec, Rel, HasRelA);
462 }
463 }
464}
465
466/// EmitRelocation - Write relocation 'Rel' to the relocation section 'Rel'
467void ELFWriter::EmitRelocation(BinaryObject &RelSec, ELFRelocation &Rel,
468 bool HasRelA) {
469 RelSec.emitWord(Rel.getOffset());
470 RelSec.emitWord(Rel.getInfo(is64Bit));
471 if (HasRelA)
472 RelSec.emitWord(Rel.getAddend());
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000473}
474
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000475/// EmitSymbol - Write symbol 'Sym' to the symbol table 'SymbolTable'
476void ELFWriter::EmitSymbol(BinaryObject &SymbolTable, ELFSym &Sym) {
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000477 if (is64Bit) {
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000478 SymbolTable.emitWord32(Sym.NameIdx);
479 SymbolTable.emitByte(Sym.Info);
480 SymbolTable.emitByte(Sym.Other);
481 SymbolTable.emitWord16(Sym.SectionIdx);
482 SymbolTable.emitWord64(Sym.Value);
483 SymbolTable.emitWord64(Sym.Size);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000484 } else {
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000485 SymbolTable.emitWord32(Sym.NameIdx);
486 SymbolTable.emitWord32(Sym.Value);
487 SymbolTable.emitWord32(Sym.Size);
488 SymbolTable.emitByte(Sym.Info);
489 SymbolTable.emitByte(Sym.Other);
490 SymbolTable.emitWord16(Sym.SectionIdx);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000491 }
492}
493
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000494/// EmitSectionHeader - Write section 'Section' header in 'SHdrTab'
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000495/// Section Header Table
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000496void ELFWriter::EmitSectionHeader(BinaryObject &SHdrTab,
497 const ELFSection &SHdr) {
498 SHdrTab.emitWord32(SHdr.NameIdx);
499 SHdrTab.emitWord32(SHdr.Type);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000500 if (is64Bit) {
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000501 SHdrTab.emitWord64(SHdr.Flags);
502 SHdrTab.emitWord(SHdr.Addr);
503 SHdrTab.emitWord(SHdr.Offset);
504 SHdrTab.emitWord64(SHdr.Size);
505 SHdrTab.emitWord32(SHdr.Link);
506 SHdrTab.emitWord32(SHdr.Info);
507 SHdrTab.emitWord64(SHdr.Align);
508 SHdrTab.emitWord64(SHdr.EntSize);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000509 } else {
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000510 SHdrTab.emitWord32(SHdr.Flags);
511 SHdrTab.emitWord(SHdr.Addr);
512 SHdrTab.emitWord(SHdr.Offset);
513 SHdrTab.emitWord32(SHdr.Size);
514 SHdrTab.emitWord32(SHdr.Link);
515 SHdrTab.emitWord32(SHdr.Info);
516 SHdrTab.emitWord32(SHdr.Align);
517 SHdrTab.emitWord32(SHdr.EntSize);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000518 }
519}
520
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000521/// EmitSymbolTable - If the current symbol table is non-empty, emit the string
522/// table for it and then the symbol table itself.
523void ELFWriter::EmitSymbolTable() {
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000524 if (!SymbolList.size()) return; // Empty symbol table.
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000525
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000526 unsigned FirstNonLocalSymbol = 1;
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000527 ELFSection &StrTab = getStringTableSection();
Chris Lattner5f48ff72005-07-16 08:01:13 +0000528
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000529 // Set the zero'th symbol to a null byte, as required.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000530 StrTab.emitByte(0);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000531
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000532 // Walk on the symbol list and write symbol names into the
533 // string table.
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000534 unsigned Index = 1;
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000535 for (std::list<ELFSym>::iterator I = SymbolList.begin(),
536 E = SymbolList.end(); I != E; ++I) {
537
Chris Lattner5acd1202005-07-11 03:11:47 +0000538 // Use the name mangler to uniquify the LLVM symbol.
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000539 std::string Name = Mang->getValueName(I->GV);
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000540
541 if (Name.empty()) {
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000542 I->NameIdx = 0;
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000543 } else {
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000544 I->NameIdx = Index;
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000545 StrTab.emitString(Name);
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000546
547 // Keep track of the number of bytes emitted to this section.
548 Index += Name.size()+1;
549 }
550 }
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000551 assert(Index == StrTab.size());
Chris Lattner5f48ff72005-07-16 08:01:13 +0000552 StrTab.Size = Index;
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000553
554 // Now that we have emitted the string table and know the offset into the
555 // string table of each symbol, emit the symbol table itself.
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000556 ELFSection &SymTab = getSymbolTableSection();
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000557 SymTab.Align = TEW->getPrefELFAlignment();
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000558 SymTab.Link = StrTab.SectionIdx; // Section Index of .strtab.
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000559
560 // Size of each symtab entry.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000561 SymTab.EntSize = TEW->getSymTabEntrySize();
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000562
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000563 // The first entry in the symtab is the null symbol
564 ELFSym NullSym = ELFSym(0);
565 EmitSymbol(SymTab, NullSym);
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000566
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000567 // Emit all the symbols to the symbol table. Skip the null
568 // symbol, cause it's emitted already
569 Index = 1;
570 for (std::list<ELFSym>::iterator I = SymbolList.begin(),
571 E = SymbolList.end(); I != E; ++I, ++Index) {
572 // Keep track of the first non-local symbol
573 if (I->getBind() == ELFSym::STB_LOCAL)
574 FirstNonLocalSymbol++;
575
576 // Emit symbol to the symbol table
577 EmitSymbol(SymTab, *I);
578
579 // Record the symbol table index for each global value
580 GblSymLookup[I->GV] = Index;
581 }
582
583 SymTab.Info = FirstNonLocalSymbol;
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000584 SymTab.Size = SymTab.size();
Chris Lattner80ed8fa2005-07-07 07:02:20 +0000585}
586
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000587/// EmitSectionTableStringTable - This method adds and emits a section for the
588/// ELF Section Table string table: the string table that holds all of the
589/// section names.
590void ELFWriter::EmitSectionTableStringTable() {
591 // First step: add the section for the string table to the list of sections:
Chris Lattner00033952005-07-16 17:36:04 +0000592 ELFSection &SHStrTab = getSection(".shstrtab", ELFSection::SHT_STRTAB, 0);
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000593
594 // Now that we know which section number is the .shstrtab section, update the
595 // e_shstrndx entry in the ELF header.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000596 ElfHdr.fixWord16(SHStrTab.SectionIdx, ELFHdr_e_shstrndx_Offset);
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000597
598 // Set the NameIdx of each section in the string table and emit the bytes for
599 // the string table.
600 unsigned Index = 0;
601
Chris Lattner5f48ff72005-07-16 08:01:13 +0000602 for (std::list<ELFSection>::iterator I = SectionList.begin(),
603 E = SectionList.end(); I != E; ++I) {
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000604 // Set the index into the table. Note if we have lots of entries with
605 // common suffixes, we could memoize them here if we cared.
Chris Lattner5f48ff72005-07-16 08:01:13 +0000606 I->NameIdx = Index;
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000607 SHStrTab.emitString(I->getName());
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000608
609 // Keep track of the number of bytes emitted to this section.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000610 Index += I->getName().size()+1;
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000611 }
612
613 // Set the size of .shstrtab now that we know what it is.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000614 assert(Index == SHStrTab.size());
Chris Lattner5f48ff72005-07-16 08:01:13 +0000615 SHStrTab.Size = Index;
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000616}
617
Chris Lattner5f48ff72005-07-16 08:01:13 +0000618/// OutputSectionsAndSectionTable - Now that we have constructed the file header
619/// and all of the sections, emit these to the ostream destination and emit the
620/// SectionTable.
621void ELFWriter::OutputSectionsAndSectionTable() {
622 // Pass #1: Compute the file offset for each section.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000623 size_t FileOff = ElfHdr.size(); // File header first.
Chris Lattner5f48ff72005-07-16 08:01:13 +0000624
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000625 // Adjust alignment of all section if needed.
Chris Lattner5f48ff72005-07-16 08:01:13 +0000626 for (std::list<ELFSection>::iterator I = SectionList.begin(),
627 E = SectionList.end(); I != E; ++I) {
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000628
629 // Section idx 0 has 0 offset
630 if (!I->SectionIdx)
631 continue;
632
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000633 if (!I->size()) {
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000634 I->Offset = FileOff;
635 continue;
636 }
637
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000638 // Update Section size
639 if (!I->Size)
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000640 I->Size = I->size();
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000641
Chris Lattner5f48ff72005-07-16 08:01:13 +0000642 // Align FileOff to whatever the alignment restrictions of the section are.
643 if (I->Align)
644 FileOff = (FileOff+I->Align-1) & ~(I->Align-1);
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000645
Chris Lattner5f48ff72005-07-16 08:01:13 +0000646 I->Offset = FileOff;
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000647 FileOff += I->Size;
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000648 }
649
Chris Lattner5f48ff72005-07-16 08:01:13 +0000650 // Align Section Header.
Bruno Cardoso Lopes0d3193e2009-06-22 19:16:16 +0000651 unsigned TableAlign = TEW->getPrefELFAlignment();
Chris Lattner5f48ff72005-07-16 08:01:13 +0000652 FileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
653
654 // Now that we know where all of the sections will be emitted, set the e_shnum
655 // entry in the ELF header.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000656 ElfHdr.fixWord16(NumSections, ELFHdr_e_shnum_Offset);
Jeff Cohen00b168892005-07-27 06:12:32 +0000657
Chris Lattner5f48ff72005-07-16 08:01:13 +0000658 // Now that we know the offset in the file of the section table, update the
659 // e_shoff address in the ELF header.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000660 ElfHdr.fixWord(FileOff, ELFHdr_e_shoff_Offset);
Jeff Cohen00b168892005-07-27 06:12:32 +0000661
Chris Lattner5f48ff72005-07-16 08:01:13 +0000662 // Now that we know all of the data in the file header, emit it and all of the
663 // sections!
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000664 O.write((char *)&ElfHdr.getData()[0], ElfHdr.size());
665 FileOff = ElfHdr.size();
Chris Lattner5f48ff72005-07-16 08:01:13 +0000666
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000667 // Section Header Table blob
668 BinaryObject SHdrTable(isLittleEndian, is64Bit);
Chris Lattner5f48ff72005-07-16 08:01:13 +0000669
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000670 // Emit all of sections to the file and build the section header table.
Chris Lattner5f48ff72005-07-16 08:01:13 +0000671 while (!SectionList.empty()) {
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000672 ELFSection &S = *SectionList.begin();
673 DOUT << "SectionIdx: " << S.SectionIdx << ", Name: " << S.getName()
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000674 << ", Size: " << S.Size << ", Offset: " << S.Offset
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000675 << ", SectionData Size: " << S.size() << "\n";
Chris Lattner5f48ff72005-07-16 08:01:13 +0000676
677 // Align FileOff to whatever the alignment restrictions of the section are.
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000678 if (S.Align) {
Chris Lattner5f48ff72005-07-16 08:01:13 +0000679 for (size_t NewFileOff = (FileOff+S.Align-1) & ~(S.Align-1);
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000680 FileOff != NewFileOff; ++FileOff)
Owen Andersoncb371882008-08-21 00:14:44 +0000681 O << (char)0xAB;
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000682 }
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000683
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000684 if (S.size()) {
685 O.write((char *)&S.getData()[0], S.Size);
Bruno Cardoso Lopesc997d452009-06-11 19:16:03 +0000686 FileOff += S.Size;
687 }
Bruno Cardoso Lopesa029a272009-06-07 21:22:38 +0000688
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000689 EmitSectionHeader(SHdrTable, S);
Chris Lattner5f48ff72005-07-16 08:01:13 +0000690 SectionList.pop_front();
691 }
692
693 // Align output for the section table.
694 for (size_t NewFileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
695 FileOff != NewFileOff; ++FileOff)
Owen Andersoncb371882008-08-21 00:14:44 +0000696 O << (char)0xAB;
Jeff Cohen00b168892005-07-27 06:12:32 +0000697
Chris Lattner5f48ff72005-07-16 08:01:13 +0000698 // Emit the section table itself.
Bruno Cardoso Lopesae9163f2009-06-14 07:53:21 +0000699 O.write((char *)&SHdrTable.getData()[0], SHdrTable.size());
Chris Lattner35f0a4f2005-06-27 06:29:00 +0000700}