1 //===-- ELFWriter.cpp - Target-independent ELF Writer code ----------------===//
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 implements the target-independent ELF writer. This file writes out
11 // the ELF file in the following order:
14 // #2. '.text' section
15 // #3. '.data' section
16 // #4. '.bss' section (conceptual position in file)
18 // #X. '.shstrtab' section
21 // The entries in the section table are laid out as:
22 // #0. Null entry [required]
23 // #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 ]
27 // #N. ".shstrtab" entry - String table for the section names.
29 // NOTE: This code should eventually be extended to support 64-bit ELF (this
30 // won't be hard), but we haven't done so yet!
32 //===----------------------------------------------------------------------===//
34 #include "ELFWriter.h"
35 #include "llvm/Module.h"
36 #include "llvm/PassManager.h"
37 #include "llvm/CodeGen/FileWriters.h"
38 #include "llvm/CodeGen/MachineCodeEmitter.h"
39 #include "llvm/CodeGen/MachineConstantPool.h"
40 #include "llvm/CodeGen/MachineFunctionPass.h"
41 #include "llvm/Target/TargetData.h"
42 #include "llvm/Target/TargetELFWriterInfo.h"
43 #include "llvm/Target/TargetMachine.h"
44 #include "llvm/Support/Mangler.h"
45 #include "llvm/Support/OutputBuffer.h"
46 #include "llvm/Support/Streams.h"
50 char ELFWriter::ID = 0;
51 /// AddELFWriter - Concrete function to add the ELF writer to the function pass
53 MachineCodeEmitter *llvm::AddELFWriter(PassManagerBase &PM,
56 ELFWriter *EW = new ELFWriter(O, TM);
58 return &EW->getMachineCodeEmitter();
61 //===----------------------------------------------------------------------===//
62 // ELFCodeEmitter Implementation
63 //===----------------------------------------------------------------------===//
66 /// ELFCodeEmitter - This class is used by the ELFWriter to emit the code for
67 /// functions to the ELF file.
68 class ELFCodeEmitter : public MachineCodeEmitter {
71 ELFWriter::ELFSection *ES; // Section to write to.
72 std::vector<unsigned char> *OutBuffer;
75 explicit ELFCodeEmitter(ELFWriter &ew) : EW(ew), TM(EW.TM), OutBuffer(0) {}
77 void startFunction(MachineFunction &F);
78 bool finishFunction(MachineFunction &F);
80 void addRelocation(const MachineRelocation &MR) {
81 assert(0 && "relo not handled yet!");
84 virtual void StartMachineBasicBlock(MachineBasicBlock *MBB) {
87 virtual intptr_t getConstantPoolEntryAddress(unsigned Index) const {
88 assert(0 && "CP not implementated yet!");
91 virtual intptr_t getJumpTableEntryAddress(unsigned Index) const {
92 assert(0 && "JT not implementated yet!");
96 virtual intptr_t getMachineBasicBlockAddress(MachineBasicBlock *MBB) const {
97 assert(0 && "JT not implementated yet!");
101 virtual intptr_t getLabelAddress(uint64_t Label) const {
102 assert(0 && "Label address not implementated yet!");
107 virtual void emitLabel(uint64_t LabelID) {
108 assert(0 && "emit Label not implementated yet!");
113 virtual void setModuleInfo(llvm::MachineModuleInfo* MMI) { }
116 /// JIT SPECIFIC FUNCTIONS - DO NOT IMPLEMENT THESE HERE!
117 void startFunctionStub(const GlobalValue* F, unsigned StubSize,
118 unsigned Alignment = 1) {
119 assert(0 && "JIT specific function called!");
122 void *finishFunctionStub(const GlobalValue *F) {
123 assert(0 && "JIT specific function called!");
130 /// startFunction - This callback is invoked when a new machine function is
131 /// about to be emitted.
132 void ELFCodeEmitter::startFunction(MachineFunction &F) {
133 // Align the output buffer to the appropriate alignment.
134 unsigned Align = 16; // FIXME: GENERICIZE!!
135 // Get the ELF Section that this function belongs in.
136 ES = &EW.getSection(".text", ELFWriter::ELFSection::SHT_PROGBITS,
137 ELFWriter::ELFSection::SHF_EXECINSTR |
138 ELFWriter::ELFSection::SHF_ALLOC);
139 OutBuffer = &ES->SectionData;
140 cerr << "FIXME: This code needs to be updated for changes in the "
141 << "CodeEmitter interfaces. In particular, this should set "
142 << "BufferBegin/BufferEnd/CurBufferPtr, not deal with OutBuffer!";
145 // Upgrade the section alignment if required.
146 if (ES->Align < Align) ES->Align = Align;
148 // Add padding zeros to the end of the buffer to make sure that the
149 // function will start on the correct byte alignment within the section.
150 OutputBuffer OB(*OutBuffer,
151 TM.getTargetData()->getPointerSizeInBits() == 64,
152 TM.getTargetData()->isLittleEndian());
154 FnStart = OutBuffer->size();
157 /// finishFunction - This callback is invoked after the function is completely
159 bool ELFCodeEmitter::finishFunction(MachineFunction &F) {
160 // We now know the size of the function, add a symbol to represent it.
161 ELFWriter::ELFSym FnSym(F.getFunction());
163 // Figure out the binding (linkage) of the symbol.
164 switch (F.getFunction()->getLinkage()) {
166 // appending linkage is illegal for functions.
167 assert(0 && "Unknown linkage type!");
168 case GlobalValue::ExternalLinkage:
169 FnSym.SetBind(ELFWriter::ELFSym::STB_GLOBAL);
171 case GlobalValue::LinkOnceLinkage:
172 case GlobalValue::WeakLinkage:
173 FnSym.SetBind(ELFWriter::ELFSym::STB_WEAK);
175 case GlobalValue::InternalLinkage:
176 FnSym.SetBind(ELFWriter::ELFSym::STB_LOCAL);
180 ES->Size = OutBuffer->size();
182 FnSym.SetType(ELFWriter::ELFSym::STT_FUNC);
183 FnSym.SectionIdx = ES->SectionIdx;
184 FnSym.Value = FnStart; // Value = Offset from start of Section.
185 FnSym.Size = OutBuffer->size()-FnStart;
187 // Finally, add it to the symtab.
188 EW.SymbolTable.push_back(FnSym);
192 //===----------------------------------------------------------------------===//
193 // ELFWriter Implementation
194 //===----------------------------------------------------------------------===//
196 ELFWriter::ELFWriter(std::ostream &o, TargetMachine &tm)
197 : MachineFunctionPass((intptr_t)&ID), O(o), TM(tm) {
198 e_flags = 0; // e_flags defaults to 0, no flags.
200 is64Bit = TM.getTargetData()->getPointerSizeInBits() == 64;
201 isLittleEndian = TM.getTargetData()->isLittleEndian();
203 // Create the machine code emitter object for this target.
204 MCE = new ELFCodeEmitter(*this);
208 ELFWriter::~ELFWriter() {
212 // doInitialization - Emit the file header and all of the global variables for
213 // the module to the ELF file.
214 bool ELFWriter::doInitialization(Module &M) {
215 Mang = new Mangler(M);
217 // Local alias to shortenify coming code.
218 std::vector<unsigned char> &FH = FileHeader;
219 OutputBuffer FHOut(FH, is64Bit, isLittleEndian);
221 FHOut.outbyte(0x7F); // EI_MAG0
222 FHOut.outbyte('E'); // EI_MAG1
223 FHOut.outbyte('L'); // EI_MAG2
224 FHOut.outbyte('F'); // EI_MAG3
225 FHOut.outbyte(is64Bit ? 2 : 1); // EI_CLASS
226 FHOut.outbyte(isLittleEndian ? 1 : 2); // EI_DATA
227 FHOut.outbyte(1); // EI_VERSION
228 FH.resize(16); // EI_PAD up to 16 bytes.
230 // This should change for shared objects.
231 FHOut.outhalf(1); // e_type = ET_REL
232 FHOut.outhalf(TM.getELFWriterInfo()->getEMachine()); // target-defined
233 FHOut.outword(1); // e_version = 1
234 FHOut.outaddr(0); // e_entry = 0 -> no entry point in .o file
235 FHOut.outaddr(0); // e_phoff = 0 -> no program header for .o
237 ELFHeader_e_shoff_Offset = FH.size();
238 FHOut.outaddr(0); // e_shoff
239 FHOut.outword(e_flags); // e_flags = whatever the target wants
241 FHOut.outhalf(is64Bit ? 64 : 52); // e_ehsize = ELF header size
242 FHOut.outhalf(0); // e_phentsize = prog header entry size
243 FHOut.outhalf(0); // e_phnum = # prog header entries = 0
244 FHOut.outhalf(is64Bit ? 64 : 40); // e_shentsize = sect hdr entry size
247 ELFHeader_e_shnum_Offset = FH.size();
248 FHOut.outhalf(0); // e_shnum = # of section header ents
249 ELFHeader_e_shstrndx_Offset = FH.size();
250 FHOut.outhalf(0); // e_shstrndx = Section # of '.shstrtab'
252 // Add the null section, which is required to be first in the file.
253 getSection("", 0, 0);
255 // Start up the symbol table. The first entry in the symtab is the null
257 SymbolTable.push_back(ELFSym(0));
262 void ELFWriter::EmitGlobal(GlobalVariable *GV) {
263 // If this is an external global, emit it now. TODO: Note that it would be
264 // better to ignore the symbol here and only add it to the symbol table if
266 if (!GV->hasInitializer()) {
267 ELFSym ExternalSym(GV);
268 ExternalSym.SetBind(ELFSym::STB_GLOBAL);
269 ExternalSym.SetType(ELFSym::STT_NOTYPE);
270 ExternalSym.SectionIdx = ELFSection::SHN_UNDEF;
271 SymbolTable.push_back(ExternalSym);
275 const Type *GVType = (const Type*)GV->getType();
276 unsigned Align = TM.getTargetData()->getPreferredAlignment(GV);
277 unsigned Size = TM.getTargetData()->getABITypeSize(GVType);
279 // If this global has a zero initializer, it is part of the .bss or common
281 if (GV->getInitializer()->isNullValue()) {
282 // If this global is part of the common block, add it now. Variables are
283 // part of the common block if they are zero initialized and allowed to be
284 // merged with other symbols.
285 if (GV->hasLinkOnceLinkage() || GV->hasWeakLinkage()) {
286 ELFSym CommonSym(GV);
287 // Value for common symbols is the alignment required.
288 CommonSym.Value = Align;
289 CommonSym.Size = Size;
290 CommonSym.SetBind(ELFSym::STB_GLOBAL);
291 CommonSym.SetType(ELFSym::STT_OBJECT);
292 // TODO SOMEDAY: add ELF visibility.
293 CommonSym.SectionIdx = ELFSection::SHN_COMMON;
294 SymbolTable.push_back(CommonSym);
298 // Otherwise, this symbol is part of the .bss section. Emit it now.
300 // Handle alignment. Ensure section is aligned at least as much as required
302 ELFSection &BSSSection = getBSSSection();
303 BSSSection.Align = std::max(BSSSection.Align, Align);
305 // Within the section, emit enough virtual padding to get us to an alignment
308 BSSSection.Size = (BSSSection.Size + Align - 1) & ~(Align-1);
311 BSSSym.Value = BSSSection.Size;
313 BSSSym.SetType(ELFSym::STT_OBJECT);
315 switch (GV->getLinkage()) {
316 default: // weak/linkonce handled above
317 assert(0 && "Unexpected linkage type!");
318 case GlobalValue::AppendingLinkage: // FIXME: This should be improved!
319 case GlobalValue::ExternalLinkage:
320 BSSSym.SetBind(ELFSym::STB_GLOBAL);
322 case GlobalValue::InternalLinkage:
323 BSSSym.SetBind(ELFSym::STB_LOCAL);
327 // Set the idx of the .bss section
328 BSSSym.SectionIdx = BSSSection.SectionIdx;
329 SymbolTable.push_back(BSSSym);
331 // Reserve space in the .bss section for this symbol.
332 BSSSection.Size += Size;
336 // FIXME: handle .rodata
337 //assert(!GV->isConstant() && "unimp");
339 // FIXME: handle .data
340 //assert(0 && "unimp");
344 bool ELFWriter::runOnMachineFunction(MachineFunction &MF) {
345 // Nothing to do here, this is all done through the MCE object above.
349 /// doFinalization - Now that the module has been completely processed, emit
350 /// the ELF file to 'O'.
351 bool ELFWriter::doFinalization(Module &M) {
352 // Okay, the ELF header and .text sections have been completed, build the
353 // .data, .bss, and "common" sections next.
354 for (Module::global_iterator I = M.global_begin(), E = M.global_end();
358 // Emit the symbol table now, if non-empty.
361 // FIXME: Emit the relocations now.
363 // Emit the string table for the sections in the ELF file we have.
364 EmitSectionTableStringTable();
366 // Emit the sections to the .o file, and emit the section table for the file.
367 OutputSectionsAndSectionTable();
369 // We are done with the abstract symbols.
373 // Release the name mangler object.
374 delete Mang; Mang = 0;
378 /// EmitSymbolTable - If the current symbol table is non-empty, emit the string
379 /// table for it and then the symbol table itself.
380 void ELFWriter::EmitSymbolTable() {
381 if (SymbolTable.size() == 1) return; // Only the null entry.
383 // FIXME: compact all local symbols to the start of the symtab.
384 unsigned FirstNonLocalSymbol = 1;
386 ELFSection &StrTab = getSection(".strtab", ELFSection::SHT_STRTAB, 0);
389 DataBuffer &StrTabBuf = StrTab.SectionData;
390 OutputBuffer StrTabOut(StrTabBuf, is64Bit, isLittleEndian);
392 // Set the zero'th symbol to a null byte, as required.
393 StrTabOut.outbyte(0);
394 SymbolTable[0].NameIdx = 0;
396 for (unsigned i = 1, e = SymbolTable.size(); i != e; ++i) {
397 // Use the name mangler to uniquify the LLVM symbol.
398 std::string Name = Mang->getValueName(SymbolTable[i].GV);
401 SymbolTable[i].NameIdx = 0;
403 SymbolTable[i].NameIdx = Index;
405 // Add the name to the output buffer, including the null terminator.
406 StrTabBuf.insert(StrTabBuf.end(), Name.begin(), Name.end());
408 // Add a null terminator.
409 StrTabBuf.push_back(0);
411 // Keep track of the number of bytes emitted to this section.
412 Index += Name.size()+1;
415 assert(Index == StrTabBuf.size());
418 // Now that we have emitted the string table and know the offset into the
419 // string table of each symbol, emit the symbol table itself.
420 ELFSection &SymTab = getSection(".symtab", ELFSection::SHT_SYMTAB, 0);
421 SymTab.Align = is64Bit ? 8 : 4;
422 SymTab.Link = SymTab.SectionIdx; // Section Index of .strtab.
423 SymTab.Info = FirstNonLocalSymbol; // First non-STB_LOCAL symbol.
424 SymTab.EntSize = 16; // Size of each symtab entry. FIXME: wrong for ELF64
425 DataBuffer &SymTabBuf = SymTab.SectionData;
426 OutputBuffer SymTabOut(SymTabBuf, is64Bit, isLittleEndian);
428 if (!is64Bit) { // 32-bit and 64-bit formats are shuffled a bit.
429 for (unsigned i = 0, e = SymbolTable.size(); i != e; ++i) {
430 ELFSym &Sym = SymbolTable[i];
431 SymTabOut.outword(Sym.NameIdx);
432 SymTabOut.outaddr32(Sym.Value);
433 SymTabOut.outword(Sym.Size);
434 SymTabOut.outbyte(Sym.Info);
435 SymTabOut.outbyte(Sym.Other);
436 SymTabOut.outhalf(Sym.SectionIdx);
439 for (unsigned i = 0, e = SymbolTable.size(); i != e; ++i) {
440 ELFSym &Sym = SymbolTable[i];
441 SymTabOut.outword(Sym.NameIdx);
442 SymTabOut.outbyte(Sym.Info);
443 SymTabOut.outbyte(Sym.Other);
444 SymTabOut.outhalf(Sym.SectionIdx);
445 SymTabOut.outaddr64(Sym.Value);
446 SymTabOut.outxword(Sym.Size);
450 SymTab.Size = SymTabBuf.size();
453 /// EmitSectionTableStringTable - This method adds and emits a section for the
454 /// ELF Section Table string table: the string table that holds all of the
456 void ELFWriter::EmitSectionTableStringTable() {
457 // First step: add the section for the string table to the list of sections:
458 ELFSection &SHStrTab = getSection(".shstrtab", ELFSection::SHT_STRTAB, 0);
460 // Now that we know which section number is the .shstrtab section, update the
461 // e_shstrndx entry in the ELF header.
462 OutputBuffer FHOut(FileHeader, is64Bit, isLittleEndian);
463 FHOut.fixhalf(SHStrTab.SectionIdx, ELFHeader_e_shstrndx_Offset);
465 // Set the NameIdx of each section in the string table and emit the bytes for
468 DataBuffer &Buf = SHStrTab.SectionData;
470 for (std::list<ELFSection>::iterator I = SectionList.begin(),
471 E = SectionList.end(); I != E; ++I) {
472 // Set the index into the table. Note if we have lots of entries with
473 // common suffixes, we could memoize them here if we cared.
476 // Add the name to the output buffer, including the null terminator.
477 Buf.insert(Buf.end(), I->Name.begin(), I->Name.end());
479 // Add a null terminator.
482 // Keep track of the number of bytes emitted to this section.
483 Index += I->Name.size()+1;
486 // Set the size of .shstrtab now that we know what it is.
487 assert(Index == Buf.size());
488 SHStrTab.Size = Index;
491 /// OutputSectionsAndSectionTable - Now that we have constructed the file header
492 /// and all of the sections, emit these to the ostream destination and emit the
494 void ELFWriter::OutputSectionsAndSectionTable() {
495 // Pass #1: Compute the file offset for each section.
496 size_t FileOff = FileHeader.size(); // File header first.
498 // Emit all of the section data in order.
499 for (std::list<ELFSection>::iterator I = SectionList.begin(),
500 E = SectionList.end(); I != E; ++I) {
501 // Align FileOff to whatever the alignment restrictions of the section are.
503 FileOff = (FileOff+I->Align-1) & ~(I->Align-1);
505 FileOff += I->SectionData.size();
508 // Align Section Header.
509 unsigned TableAlign = is64Bit ? 8 : 4;
510 FileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
512 // Now that we know where all of the sections will be emitted, set the e_shnum
513 // entry in the ELF header.
514 OutputBuffer FHOut(FileHeader, is64Bit, isLittleEndian);
515 FHOut.fixhalf(NumSections, ELFHeader_e_shnum_Offset);
517 // Now that we know the offset in the file of the section table, update the
518 // e_shoff address in the ELF header.
519 FHOut.fixaddr(FileOff, ELFHeader_e_shoff_Offset);
521 // Now that we know all of the data in the file header, emit it and all of the
523 O.write((char*)&FileHeader[0], FileHeader.size());
524 FileOff = FileHeader.size();
525 DataBuffer().swap(FileHeader);
528 OutputBuffer TableOut(Table, is64Bit, isLittleEndian);
530 // Emit all of the section data and build the section table itself.
531 while (!SectionList.empty()) {
532 const ELFSection &S = *SectionList.begin();
534 // Align FileOff to whatever the alignment restrictions of the section are.
536 for (size_t NewFileOff = (FileOff+S.Align-1) & ~(S.Align-1);
537 FileOff != NewFileOff; ++FileOff)
539 O.write((char*)&S.SectionData[0], S.SectionData.size());
540 FileOff += S.SectionData.size();
542 TableOut.outword(S.NameIdx); // sh_name - Symbol table name idx
543 TableOut.outword(S.Type); // sh_type - Section contents & semantics
544 TableOut.outword(S.Flags); // sh_flags - Section flags.
545 TableOut.outaddr(S.Addr); // sh_addr - The mem addr this section is in.
546 TableOut.outaddr(S.Offset); // sh_offset - Offset from the file start.
547 TableOut.outword(S.Size); // sh_size - The section size.
548 TableOut.outword(S.Link); // sh_link - Section header table index link.
549 TableOut.outword(S.Info); // sh_info - Auxillary information.
550 TableOut.outword(S.Align); // sh_addralign - Alignment of section.
551 TableOut.outword(S.EntSize); // sh_entsize - Size of entries in the section
553 SectionList.pop_front();
556 // Align output for the section table.
557 for (size_t NewFileOff = (FileOff+TableAlign-1) & ~(TableAlign-1);
558 FileOff != NewFileOff; ++FileOff)
561 // Emit the section table itself.
562 O.write((char*)&Table[0], Table.size());