Use a better name for the label relocations while emitting them for Jump Tables
[oota-llvm.git] / lib / CodeGen / ELFCodeEmitter.cpp
1 //===-- lib/CodeGen/ELFCodeEmitter.cpp ------------------------------------===//
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 #define DEBUG_TYPE "elfce"
11
12 #include "ELF.h"
13 #include "ELFWriter.h"
14 #include "ELFCodeEmitter.h"
15 #include "llvm/Constants.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Function.h"
18 #include "llvm/CodeGen/BinaryObject.h"
19 #include "llvm/CodeGen/MachineConstantPool.h"
20 #include "llvm/CodeGen/MachineJumpTableInfo.h"
21 #include "llvm/CodeGen/MachineRelocation.h"
22 #include "llvm/Target/TargetData.h"
23 #include "llvm/Target/TargetELFWriterInfo.h"
24 #include "llvm/Target/TargetMachine.h"
25 #include "llvm/Target/TargetAsmInfo.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/ErrorHandling.h"
28
29 //===----------------------------------------------------------------------===//
30 //                       ELFCodeEmitter Implementation
31 //===----------------------------------------------------------------------===//
32
33 namespace llvm {
34
35 /// startFunction - This callback is invoked when a new machine function is
36 /// about to be emitted.
37 void ELFCodeEmitter::startFunction(MachineFunction &MF) {
38   DOUT << "processing function: " << MF.getFunction()->getName() << "\n";
39
40   // Get the ELF Section that this function belongs in.
41   ES = &EW.getTextSection();
42
43   // Set the desired binary object to be used by the code emitters
44   setBinaryObject(ES);
45
46   // Get the function alignment in bytes
47   unsigned Align = (1 << MF.getAlignment());
48
49   // The function must start on its required alignment
50   ES->emitAlignment(Align);
51
52   // Update the section alignment if needed.
53   if (ES->Align < Align) ES->Align = Align;
54
55   // Record the function start offset
56   FnStartOff = ES->getCurrentPCOffset();
57 }
58
59 /// finishFunction - This callback is invoked after the function is completely
60 /// finished.
61 bool ELFCodeEmitter::finishFunction(MachineFunction &MF) {
62   // Add a symbol to represent the function.
63   const Function *F = MF.getFunction();
64   ELFSym *FnSym = new ELFSym(F);
65   FnSym->setType(ELFSym::STT_FUNC);
66   FnSym->setBind(EW.getGlobalELFBinding(F));
67   FnSym->setVisibility(EW.getGlobalELFVisibility(F));
68   FnSym->SectionIdx = ES->SectionIdx;
69   FnSym->Size = ES->getCurrentPCOffset()-FnStartOff;
70
71   // Offset from start of Section
72   FnSym->Value = FnStartOff;
73
74   if (!F->hasPrivateLinkage())
75     EW.SymbolList.push_back(FnSym);
76
77   // Emit constant pool to appropriate section(s)
78   emitConstantPool(MF.getConstantPool());
79
80   // Emit jump tables to appropriate section
81   emitJumpTables(MF.getJumpTableInfo());
82
83   // Relocations
84   // -----------
85   // If we have emitted any relocations to function-specific objects such as
86   // basic blocks, constant pools entries, or jump tables, record their
87   // addresses now so that we can rewrite them with the correct addresses
88   // later.
89   for (unsigned i = 0, e = Relocations.size(); i != e; ++i) {
90     MachineRelocation &MR = Relocations[i];
91     intptr_t Addr;
92     if (MR.isGlobalValue()) {
93       EW.PendingGlobals.insert(MR.getGlobalValue());
94     } else if (MR.isBasicBlock()) {
95       Addr = getMachineBasicBlockAddress(MR.getBasicBlock());
96       MR.setConstantVal(ES->SectionIdx);
97       MR.setResultPointer((void*)Addr);
98     } else if (MR.isConstantPoolIndex()) {
99       Addr = getConstantPoolEntryAddress(MR.getConstantPoolIndex());
100       MR.setConstantVal(CPSections[MR.getConstantPoolIndex()]);
101       MR.setResultPointer((void*)Addr);
102     } else if (MR.isJumpTableIndex()) {
103       Addr = getJumpTableEntryAddress(MR.getJumpTableIndex());
104       MR.setResultPointer((void*)Addr);
105       MR.setConstantVal(JumpTableSectionIdx);
106     } else {
107       llvm_unreachable("Unhandled relocation type");
108     }
109     ES->addRelocation(MR);
110   }
111
112   // Clear per-function data structures.
113   Relocations.clear();
114   CPLocations.clear();
115   CPSections.clear();
116   JTLocations.clear();
117   MBBLocations.clear();
118   return false;
119 }
120
121 /// emitConstantPool - For each constant pool entry, figure out which section
122 /// the constant should live in and emit the constant
123 void ELFCodeEmitter::emitConstantPool(MachineConstantPool *MCP) {
124   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
125   if (CP.empty()) return;
126
127   // TODO: handle PIC codegen
128   assert(TM.getRelocationModel() != Reloc::PIC_ &&
129          "PIC codegen not yet handled for elf constant pools!");
130
131   const TargetAsmInfo *TAI = TM.getTargetAsmInfo();
132   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
133     MachineConstantPoolEntry CPE = CP[i];
134
135     // Get the right ELF Section for this constant pool entry
136     std::string CstPoolName =
137       TAI->SelectSectionForMachineConst(CPE.getType())->getName();
138     ELFSection &CstPoolSection =
139       EW.getConstantPoolSection(CstPoolName, CPE.getAlignment());
140
141     // Record the constant pool location and the section index
142     CPLocations.push_back(CstPoolSection.size());
143     CPSections.push_back(CstPoolSection.SectionIdx);
144
145     if (CPE.isMachineConstantPoolEntry())
146       assert("CPE.isMachineConstantPoolEntry not supported yet");
147
148     // Emit the constant to constant pool section
149     EW.EmitGlobalConstant(CPE.Val.ConstVal, CstPoolSection);
150   }
151 }
152
153 /// emitJumpTables - Emit all the jump tables for a given jump table info
154 /// record to the appropriate section.
155 void ELFCodeEmitter::emitJumpTables(MachineJumpTableInfo *MJTI) {
156   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
157   if (JT.empty()) return;
158
159   // FIXME: handle PIC codegen
160   assert(TM.getRelocationModel() != Reloc::PIC_ &&
161          "PIC codegen not yet handled for elf jump tables!");
162
163   const TargetAsmInfo *TAI = TM.getTargetAsmInfo();
164   const TargetELFWriterInfo *TEW = TM.getELFWriterInfo();
165
166   // Get the ELF Section to emit the jump table
167   unsigned Align = TM.getTargetData()->getPointerABIAlignment();
168   std::string JTName(TAI->getJumpTableDataSection());
169   ELFSection &JTSection = EW.getJumpTableSection(JTName, Align);
170   JumpTableSectionIdx = JTSection.SectionIdx;
171
172   // Entries in the JT Section are relocated against the text section
173   ELFSection &TextSection = EW.getTextSection();
174
175   // For each JT, record its offset from the start of the section
176   for (unsigned i = 0, e = JT.size(); i != e; ++i) {
177     const std::vector<MachineBasicBlock*> &MBBs = JT[i].MBBs;
178
179     DOUT << "JTSection.size(): " << JTSection.size() << "\n";
180     DOUT << "JTLocations.size: " << JTLocations.size() << "\n";
181
182     // Record JT 'i' offset in the JT section
183     JTLocations.push_back(JTSection.size());
184
185     // Each MBB entry in the Jump table section has a relocation entry
186     // against the current text section.
187     for (unsigned mi = 0, me = MBBs.size(); mi != me; ++mi) {
188       unsigned MachineRelTy = TEW->getAbsoluteLabelMachineRelTy();
189       MachineRelocation MR =
190         MachineRelocation::getBB(JTSection.size(),
191                                  MachineRelTy,
192                                  MBBs[mi]);
193
194       // Offset of JT 'i' in JT section
195       MR.setResultPointer((void*)getMachineBasicBlockAddress(MBBs[mi]));
196       MR.setConstantVal(TextSection.SectionIdx);
197
198       // Add the relocation to the Jump Table section
199       JTSection.addRelocation(MR);
200
201       // Output placeholder for MBB in the JT section
202       JTSection.emitWord(0);
203     }
204   }
205 }
206
207 } // end namespace llvm