1 //===-- Mips/MipsCodeEmitter.cpp - Convert Mips Code to Machine 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 contains the pass that transforms the Mips machine instructions
11 // into relocatable machine code.
13 //===---------------------------------------------------------------------===//
15 #define DEBUG_TYPE "jit"
17 #include "MCTargetDesc/MipsBaseInfo.h"
18 #include "MipsInstrInfo.h"
19 #include "MipsRelocations.h"
20 #include "MipsSubtarget.h"
21 #include "MipsTargetMachine.h"
22 #include "llvm/ADT/Statistic.h"
23 #include "llvm/CodeGen/JITCodeEmitter.h"
24 #include "llvm/CodeGen/MachineConstantPool.h"
25 #include "llvm/CodeGen/MachineFunctionPass.h"
26 #include "llvm/CodeGen/MachineInstr.h"
27 #include "llvm/CodeGen/MachineJumpTableInfo.h"
28 #include "llvm/CodeGen/MachineInstrBuilder.h"
29 #include "llvm/CodeGen/MachineModuleInfo.h"
30 #include "llvm/CodeGen/MachineOperand.h"
31 #include "llvm/CodeGen/Passes.h"
32 #include "llvm/IR/Constants.h"
33 #include "llvm/IR/DerivedTypes.h"
34 #include "llvm/PassManager.h"
35 #include "llvm/Support/Debug.h"
36 #include "llvm/Support/ErrorHandling.h"
37 #include "llvm/Support/raw_ostream.h"
44 STATISTIC(NumEmitted, "Number of machine instructions emitted");
48 class MipsCodeEmitter : public MachineFunctionPass {
50 const MipsInstrInfo *II;
52 const MipsSubtarget *Subtarget;
55 const std::vector<MachineConstantPoolEntry> *MCPEs;
56 const std::vector<MachineJumpTableEntry> *MJTEs;
59 void getAnalysisUsage(AnalysisUsage &AU) const {
60 AU.addRequired<MachineModuleInfo> ();
61 MachineFunctionPass::getAnalysisUsage(AU);
67 MipsCodeEmitter(TargetMachine &tm, JITCodeEmitter &mce)
68 : MachineFunctionPass(ID), JTI(0), II(0), TD(0),
69 TM(tm), MCE(mce), MCPEs(0), MJTEs(0),
70 IsPIC(TM.getRelocationModel() == Reloc::PIC_) {}
72 bool runOnMachineFunction(MachineFunction &MF);
74 virtual const char *getPassName() const {
75 return "Mips Machine Code Emitter";
78 /// getBinaryCodeForInstr - This function, generated by the
79 /// CodeEmitterGenerator using TableGen, produces the binary encoding for
80 /// machine instructions.
81 uint64_t getBinaryCodeForInstr(const MachineInstr &MI) const;
83 void emitInstruction(MachineBasicBlock::instr_iterator MI,
84 MachineBasicBlock &MBB);
88 void emitWord(unsigned Word);
90 /// Routines that handle operands which add machine relocations which are
91 /// fixed up by the relocation stage.
92 void emitGlobalAddress(const GlobalValue *GV, unsigned Reloc,
93 bool MayNeedFarStub) const;
94 void emitExternalSymbolAddress(const char *ES, unsigned Reloc) const;
95 void emitConstPoolAddress(unsigned CPI, unsigned Reloc) const;
96 void emitJumpTableAddress(unsigned JTIndex, unsigned Reloc) const;
97 void emitMachineBasicBlock(MachineBasicBlock *BB, unsigned Reloc) const;
99 /// getMachineOpValue - Return binary encoding of operand. If the machine
100 /// operand requires relocation, record the relocation and return zero.
101 unsigned getMachineOpValue(const MachineInstr &MI,
102 const MachineOperand &MO) const;
104 unsigned getRelocation(const MachineInstr &MI,
105 const MachineOperand &MO) const;
107 unsigned getJumpTargetOpValue(const MachineInstr &MI, unsigned OpNo) const;
109 unsigned getBranchTargetOpValue(const MachineInstr &MI, unsigned OpNo) const;
110 unsigned getMemEncoding(const MachineInstr &MI, unsigned OpNo) const;
111 unsigned getSizeExtEncoding(const MachineInstr &MI, unsigned OpNo) const;
112 unsigned getSizeInsEncoding(const MachineInstr &MI, unsigned OpNo) const;
114 void emitGlobalAddressUnaligned(const GlobalValue *GV, unsigned Reloc,
117 /// Expand pseudo instructions with accumulator register operands.
118 void expandACCInstr(MachineBasicBlock::instr_iterator MI,
119 MachineBasicBlock &MBB, unsigned Opc) const;
121 /// \brief Expand pseudo instruction. Return true if MI was expanded.
122 bool expandPseudos(MachineBasicBlock::instr_iterator &MI,
123 MachineBasicBlock &MBB) const;
127 char MipsCodeEmitter::ID = 0;
129 bool MipsCodeEmitter::runOnMachineFunction(MachineFunction &MF) {
130 MipsTargetMachine &Target = static_cast<MipsTargetMachine &>(
131 const_cast<TargetMachine &>(MF.getTarget()));
133 JTI = Target.getJITInfo();
134 II = Target.getInstrInfo();
135 TD = Target.getDataLayout();
136 Subtarget = &TM.getSubtarget<MipsSubtarget> ();
137 MCPEs = &MF.getConstantPool()->getConstants();
139 if (MF.getJumpTableInfo()) MJTEs = &MF.getJumpTableInfo()->getJumpTables();
140 JTI->Initialize(MF, IsPIC, Subtarget->isLittle());
141 MCE.setModuleInfo(&getAnalysis<MachineModuleInfo> ());
144 DEBUG(errs() << "JITTing function '"
145 << MF.getName() << "'\n");
146 MCE.startFunction(MF);
148 for (MachineFunction::iterator MBB = MF.begin(), E = MF.end();
150 MCE.StartMachineBasicBlock(MBB);
151 for (MachineBasicBlock::instr_iterator I = MBB->instr_begin(),
152 E = MBB->instr_end(); I != E;)
153 emitInstruction(*I++, *MBB);
155 } while (MCE.finishFunction(MF));
160 unsigned MipsCodeEmitter::getRelocation(const MachineInstr &MI,
161 const MachineOperand &MO) const {
162 // NOTE: This relocations are for static.
163 uint64_t TSFlags = MI.getDesc().TSFlags;
164 uint64_t Form = TSFlags & MipsII::FormMask;
165 if (Form == MipsII::FrmJ)
166 return Mips::reloc_mips_26;
167 if ((Form == MipsII::FrmI || Form == MipsII::FrmFI)
169 return Mips::reloc_mips_pc16;
170 if (Form == MipsII::FrmI && MI.getOpcode() == Mips::LUi)
171 return Mips::reloc_mips_hi;
172 return Mips::reloc_mips_lo;
175 unsigned MipsCodeEmitter::getJumpTargetOpValue(const MachineInstr &MI,
176 unsigned OpNo) const {
177 MachineOperand MO = MI.getOperand(OpNo);
179 emitGlobalAddress(MO.getGlobal(), getRelocation(MI, MO), true);
180 else if (MO.isSymbol())
181 emitExternalSymbolAddress(MO.getSymbolName(), getRelocation(MI, MO));
183 emitMachineBasicBlock(MO.getMBB(), getRelocation(MI, MO));
185 llvm_unreachable("Unexpected jump target operand kind.");
189 unsigned MipsCodeEmitter::getBranchTargetOpValue(const MachineInstr &MI,
190 unsigned OpNo) const {
191 MachineOperand MO = MI.getOperand(OpNo);
192 emitMachineBasicBlock(MO.getMBB(), getRelocation(MI, MO));
196 unsigned MipsCodeEmitter::getMemEncoding(const MachineInstr &MI,
197 unsigned OpNo) const {
198 // Base register is encoded in bits 20-16, offset is encoded in bits 15-0.
199 assert(MI.getOperand(OpNo).isReg());
200 unsigned RegBits = getMachineOpValue(MI, MI.getOperand(OpNo)) << 16;
201 return (getMachineOpValue(MI, MI.getOperand(OpNo+1)) & 0xFFFF) | RegBits;
204 unsigned MipsCodeEmitter::getSizeExtEncoding(const MachineInstr &MI,
205 unsigned OpNo) const {
206 // size is encoded as size-1.
207 return getMachineOpValue(MI, MI.getOperand(OpNo)) - 1;
210 unsigned MipsCodeEmitter::getSizeInsEncoding(const MachineInstr &MI,
211 unsigned OpNo) const {
212 // size is encoded as pos+size-1.
213 return getMachineOpValue(MI, MI.getOperand(OpNo-1)) +
214 getMachineOpValue(MI, MI.getOperand(OpNo)) - 1;
217 /// getMachineOpValue - Return binary encoding of operand. If the machine
218 /// operand requires relocation, record the relocation and return zero.
219 unsigned MipsCodeEmitter::getMachineOpValue(const MachineInstr &MI,
220 const MachineOperand &MO) const {
222 return TM.getRegisterInfo()->getEncodingValue(MO.getReg());
224 return static_cast<unsigned>(MO.getImm());
225 else if (MO.isGlobal())
226 emitGlobalAddress(MO.getGlobal(), getRelocation(MI, MO), true);
227 else if (MO.isSymbol())
228 emitExternalSymbolAddress(MO.getSymbolName(), getRelocation(MI, MO));
230 emitConstPoolAddress(MO.getIndex(), getRelocation(MI, MO));
232 emitJumpTableAddress(MO.getIndex(), getRelocation(MI, MO));
234 emitMachineBasicBlock(MO.getMBB(), getRelocation(MI, MO));
236 llvm_unreachable("Unable to encode MachineOperand!");
240 void MipsCodeEmitter::emitGlobalAddress(const GlobalValue *GV, unsigned Reloc,
241 bool MayNeedFarStub) const {
242 MCE.addRelocation(MachineRelocation::getGV(MCE.getCurrentPCOffset(), Reloc,
243 const_cast<GlobalValue *>(GV), 0,
247 void MipsCodeEmitter::emitGlobalAddressUnaligned(const GlobalValue *GV,
248 unsigned Reloc, int Offset) const {
249 MCE.addRelocation(MachineRelocation::getGV(MCE.getCurrentPCOffset(), Reloc,
250 const_cast<GlobalValue *>(GV), 0, false));
251 MCE.addRelocation(MachineRelocation::getGV(MCE.getCurrentPCOffset() + Offset,
252 Reloc, const_cast<GlobalValue *>(GV), 0, false));
255 void MipsCodeEmitter::
256 emitExternalSymbolAddress(const char *ES, unsigned Reloc) const {
257 MCE.addRelocation(MachineRelocation::getExtSym(MCE.getCurrentPCOffset(),
261 void MipsCodeEmitter::emitConstPoolAddress(unsigned CPI, unsigned Reloc) const {
262 MCE.addRelocation(MachineRelocation::getConstPool(MCE.getCurrentPCOffset(),
263 Reloc, CPI, 0, false));
266 void MipsCodeEmitter::
267 emitJumpTableAddress(unsigned JTIndex, unsigned Reloc) const {
268 MCE.addRelocation(MachineRelocation::getJumpTable(MCE.getCurrentPCOffset(),
269 Reloc, JTIndex, 0, false));
272 void MipsCodeEmitter::emitMachineBasicBlock(MachineBasicBlock *BB,
273 unsigned Reloc) const {
274 MCE.addRelocation(MachineRelocation::getBB(MCE.getCurrentPCOffset(),
278 void MipsCodeEmitter::emitInstruction(MachineBasicBlock::instr_iterator MI,
279 MachineBasicBlock &MBB) {
280 DEBUG(errs() << "JIT: " << (void*)MCE.getCurrentPCValue() << ":\t" << *MI);
282 // Expand pseudo instruction. Skip if MI was not expanded.
283 if (((MI->getDesc().TSFlags & MipsII::FormMask) == MipsII::Pseudo) &&
284 !expandPseudos(MI, MBB))
287 MCE.processDebugLoc(MI->getDebugLoc(), true);
289 emitWord(getBinaryCodeForInstr(*MI));
290 ++NumEmitted; // Keep track of the # of mi's emitted
292 MCE.processDebugLoc(MI->getDebugLoc(), false);
295 void MipsCodeEmitter::emitWord(unsigned Word) {
296 DEBUG(errs() << " 0x";
297 errs().write_hex(Word) << "\n");
298 if (Subtarget->isLittle())
299 MCE.emitWordLE(Word);
301 MCE.emitWordBE(Word);
304 void MipsCodeEmitter::expandACCInstr(MachineBasicBlock::instr_iterator MI,
305 MachineBasicBlock &MBB,
306 unsigned Opc) const {
307 // Expand "pseudomult $ac0, $t0, $t1" to "mult $t0, $t1".
308 BuildMI(MBB, &*MI, MI->getDebugLoc(), II->get(Opc))
309 .addReg(MI->getOperand(1).getReg()).addReg(MI->getOperand(2).getReg());
312 bool MipsCodeEmitter::expandPseudos(MachineBasicBlock::instr_iterator &MI,
313 MachineBasicBlock &MBB) const {
314 switch (MI->getOpcode()) {
316 BuildMI(MBB, &*MI, MI->getDebugLoc(), II->get(Mips::SLL), Mips::ZERO)
317 .addReg(Mips::ZERO).addImm(0);
319 case Mips::JALRPseudo:
320 BuildMI(MBB, &*MI, MI->getDebugLoc(), II->get(Mips::JALR), Mips::RA)
321 .addReg(MI->getOperand(0).getReg());
323 case Mips::PseudoMULT:
324 expandACCInstr(MI, MBB, Mips::MULT);
326 case Mips::PseudoMULTu:
327 expandACCInstr(MI, MBB, Mips::MULTu);
329 case Mips::PseudoSDIV:
330 expandACCInstr(MI, MBB, Mips::SDIV);
332 case Mips::PseudoUDIV:
333 expandACCInstr(MI, MBB, Mips::UDIV);
335 case Mips::PseudoMADD:
336 expandACCInstr(MI, MBB, Mips::MADD);
338 case Mips::PseudoMADDU:
339 expandACCInstr(MI, MBB, Mips::MADDU);
341 case Mips::PseudoMSUB:
342 expandACCInstr(MI, MBB, Mips::MSUB);
344 case Mips::PseudoMSUBU:
345 expandACCInstr(MI, MBB, Mips::MSUBU);
351 (MI--)->eraseFromBundle();
355 /// createMipsJITCodeEmitterPass - Return a pass that emits the collected Mips
356 /// code to the specified MCE object.
357 FunctionPass *llvm::createMipsJITCodeEmitterPass(MipsTargetMachine &TM,
358 JITCodeEmitter &JCE) {
359 return new MipsCodeEmitter(TM, JCE);
362 #include "MipsGenCodeEmitter.inc"