1 //===---- Mips16HardFloat.cpp for Mips16 Hard Float --------===//
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 defines a pass needed for Mips16 Hard Float
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "mips16-hard-float"
15 #include "Mips16HardFloat.h"
16 #include "llvm/IR/Module.h"
17 #include "llvm/Support/Debug.h"
18 #include "llvm/Support/raw_ostream.h"
21 static void inlineAsmOut
22 (LLVMContext &C, StringRef AsmString, BasicBlock *BB ) {
23 std::vector<llvm::Type *> AsmArgTypes;
24 std::vector<llvm::Value*> AsmArgs;
25 llvm::FunctionType *AsmFTy =
26 llvm::FunctionType::get(Type::getVoidTy(C),
29 llvm::InlineAsm::get(AsmFTy, AsmString, "", true,
30 /* IsAlignStack */ false,
31 llvm::InlineAsm::AD_ATT);
32 CallInst::Create(IA, AsmArgs, "", BB);
37 class InlineAsmHelper {
41 InlineAsmHelper(LLVMContext &C_, BasicBlock *BB_) :
45 void Out(StringRef AsmString) {
46 inlineAsmOut(C, AsmString, BB);
52 // Return types that matter for hard float are:
53 // float, double, complex float, and complex double
55 enum FPReturnVariant {
56 FRet, DRet, CFRet, CDRet, NoFPRet
60 // Determine which FP return type this function has
62 static FPReturnVariant whichFPReturnVariant(Type *T) {
63 switch (T->getTypeID()) {
66 case Type::DoubleTyID:
68 case Type::StructTyID:
69 if (T->getStructNumElements() != 2)
71 if ((T->getContainedType(0)->isFloatTy()) &&
72 (T->getContainedType(1)->isFloatTy()))
74 if ((T->getContainedType(0)->isDoubleTy()) &&
75 (T->getContainedType(1)->isDoubleTy()))
85 // Parameter type that matter are float, (float, float), (float, double),
86 // double, (double, double), (double, float)
90 DSig, DDSig, DFSig, NoSig
93 // which floating point parameter signature variant we are dealing with
95 typedef Type::TypeID TypeID;
96 const Type::TypeID FloatTyID = Type::FloatTyID;
97 const Type::TypeID DoubleTyID = Type::DoubleTyID;
99 static FPParamVariant whichFPParamVariantNeeded(Function &F) {
100 switch (F.arg_size()) {
104 TypeID ArgTypeID = F.getFunctionType()->getParamType(0)->getTypeID();
115 TypeID ArgTypeID0 = F.getFunctionType()->getParamType(0)->getTypeID();
116 TypeID ArgTypeID1 = F.getFunctionType()->getParamType(1)->getTypeID();
119 switch (ArgTypeID1) {
129 switch (ArgTypeID1) {
143 llvm_unreachable("can't get here");
146 // Figure out if we need float point based on the function parameters.
147 // We need to move variables in and/or out of floating point
148 // registers because of the ABI
150 static bool needsFPStubFromParams(Function &F) {
151 if (F.arg_size() >=1) {
152 Type *ArgType = F.getFunctionType()->getParamType(0);
153 switch (ArgType->getTypeID()) {
154 case Type::FloatTyID:
155 case Type::DoubleTyID:
164 static bool needsFPReturnHelper(Function &F) {
165 Type* RetType = F.getReturnType();
166 return whichFPReturnVariant(RetType) != NoFPRet;
169 static bool needsFPHelperFromSig(Function &F) {
170 return needsFPStubFromParams(F) || needsFPReturnHelper(F);
174 // We swap between FP and Integer registers to allow Mips16 and Mips32 to
178 static void swapFPIntParams
179 (FPParamVariant PV, Module *M, InlineAsmHelper &IAH,
180 bool LE, bool ToFP) {
181 //LLVMContext &Context = M->getContext();
182 std::string MI = ToFP? "mtc1 ": "mfc1 ";
185 IAH.Out(MI + "$$4,$$f12");
188 IAH.Out(MI +"$$4,$$f12");
189 IAH.Out(MI + "$$5,$$f14");
192 IAH.Out(MI + "$$4,$$f12");
194 IAH.Out(MI + "$$6,$$f14");
195 IAH.Out(MI + "$$7,$$f15");
197 IAH.Out(MI + "$$7,$$f14");
198 IAH.Out(MI + "$$6,$$f15");
203 IAH.Out(MI + "$$4,$$f12");
204 IAH.Out(MI + "$$5,$$f13");
206 IAH.Out(MI + "$$5,$$f12");
207 IAH.Out(MI + "$$4,$$f13");
212 IAH.Out(MI + "$$4,$$f12");
213 IAH.Out(MI + "$$5,$$f13");
214 IAH.Out(MI + "$$6,$$f14");
215 IAH.Out(MI + "$$7,$$f15");
217 IAH.Out(MI + "$$5,$$f12");
218 IAH.Out(MI + "$$4,$$f13");
219 IAH.Out(MI + "$$7,$$f14");
220 IAH.Out(MI + "$$6,$$f15");
225 IAH.Out(MI + "$$4,$$f12");
226 IAH.Out(MI + "$$5,$$f13");
228 IAH.Out(MI + "$$5,$$f12");
229 IAH.Out(MI + "$$4,$$f13");
231 IAH.Out(MI + "$$6,$$f14");
238 // Make sure that we know we already need a stub for this function.
239 // Having called needsFPHelperFromSig
241 static void assureFPCallStub(Function &F, Module *M,
242 const MipsSubtarget &Subtarget){
243 // for now we only need them for static relocation
244 if (Subtarget.getRelocationModel() == Reloc::PIC_)
246 LLVMContext &Context = M->getContext();
247 bool LE = Subtarget.isLittle();
248 std::string Name = F.getName();
249 std::string SectionName = ".mips16.call.fp." + Name;
250 std::string StubName = "__call_stub_fp_" + Name;
252 // see if we already have the stub
254 Function *FStub = M->getFunction(StubName);
255 if (FStub && !FStub->isDeclaration()) return;
256 FStub = Function::Create(F.getFunctionType(),
257 Function::InternalLinkage, StubName, M);
258 FStub->addFnAttr("mips16_fp_stub");
259 FStub->addFnAttr(llvm::Attribute::Naked);
260 FStub->addFnAttr(llvm::Attribute::NoInline);
261 FStub->addFnAttr(llvm::Attribute::NoUnwind);
262 FStub->addFnAttr("nomips16");
263 FStub->setSection(SectionName);
264 BasicBlock *BB = BasicBlock::Create(Context, "entry", FStub);
265 InlineAsmHelper IAH(Context, BB);
266 IAH.Out(".set reorder");
267 FPReturnVariant RV = whichFPReturnVariant(FStub->getReturnType());
268 FPParamVariant PV = whichFPParamVariantNeeded(F);
269 swapFPIntParams(PV, M, IAH, LE, true);
271 IAH.Out("move $$18, $$31");
272 IAH.Out("jal " + Name);
274 IAH.Out("lui $$25,%hi(" + Name + ")");
275 IAH.Out("addiu $$25,$$25,%lo(" + Name + ")" );
279 IAH.Out("mfc1 $$2,$$f0");
283 IAH.Out("mfc1 $$2,$$f0");
284 IAH.Out("mfc1 $$3,$$f1");
286 IAH.Out("mfc1 $$3,$$f0");
287 IAH.Out("mfc1 $$2,$$f1");
292 IAH.Out("mfc1 $$2,$$f0");
293 IAH.Out("mfc1 $$3,$$f2");
295 IAH.Out("mfc1 $$3,$$f0");
296 IAH.Out("mfc1 $$3,$$f2");
301 IAH.Out("mfc1 $$4,$$f2");
302 IAH.Out("mfc1 $$5,$$f3");
303 IAH.Out("mfc1 $$2,$$f0");
304 IAH.Out("mfc1 $$3,$$f1");
307 IAH.Out("mfc1 $$5,$$f2");
308 IAH.Out("mfc1 $$4,$$f3");
309 IAH.Out("mfc1 $$3,$$f0");
310 IAH.Out("mfc1 $$2,$$f1");
320 new UnreachableInst(Context, BB);
324 // Returns of float, double and complex need to be handled with a helper
327 static bool fixupFPReturnAndCall
328 (Function &F, Module *M, const MipsSubtarget &Subtarget) {
329 bool Modified = false;
330 LLVMContext &C = M->getContext();
331 Type *MyVoid = Type::getVoidTy(C);
332 for (Function::iterator BB = F.begin(), E = F.end(); BB != E; ++BB)
333 for (BasicBlock::iterator I = BB->begin(), E = BB->end();
335 Instruction &Inst = *I;
336 if (const ReturnInst *RI = dyn_cast<ReturnInst>(I)) {
337 Value *RVal = RI->getReturnValue();
340 // If there is a return value and it needs a helper function,
341 // figure out which one and add a call before the actual
342 // return to this helper. The purpose of the helper is to move
343 // floating point values from their soft float return mapping to
344 // where they would have been mapped to in floating point registers.
346 Type *T = RVal->getType();
347 FPReturnVariant RV = whichFPReturnVariant(T);
348 if (RV == NoFPRet) continue;
349 static const char* Helper[NoFPRet] =
350 {"__mips16_ret_sf", "__mips16_ret_df", "__mips16_ret_sc",
352 const char *Name = Helper[RV];
354 Value *Params[] = {RVal};
357 // These helper functions have a different calling ABI so
358 // this __Mips16RetHelper indicates that so that later
359 // during call setup, the proper call lowering to the helper
360 // functions will take place.
362 A = A.addAttribute(C, AttributeSet::FunctionIndex,
363 "__Mips16RetHelper");
364 A = A.addAttribute(C, AttributeSet::FunctionIndex,
365 Attribute::ReadNone);
366 A = A.addAttribute(C, AttributeSet::FunctionIndex,
367 Attribute::NoInline);
368 Value *F = (M->getOrInsertFunction(Name, A, MyVoid, T, NULL));
369 CallInst::Create(F, Params, "", &Inst );
370 } else if (const CallInst *CI = dyn_cast<CallInst>(I)) {
371 // pic mode calls are handled by already defined
373 if (Subtarget.getRelocationModel() != Reloc::PIC_ ) {
374 Function *F_ = CI->getCalledFunction();
375 if (F_ && needsFPHelperFromSig(*F_)) {
376 assureFPCallStub(*F_, M, Subtarget);
385 static void createFPFnStub(Function *F, Module *M, FPParamVariant PV,
386 const MipsSubtarget &Subtarget ) {
387 bool PicMode = Subtarget.getRelocationModel() == Reloc::PIC_;
388 bool LE = Subtarget.isLittle();
389 LLVMContext &Context = M->getContext();
390 std::string Name = F->getName();
391 std::string SectionName = ".mips16.fn." + Name;
392 std::string StubName = "__fn_stub_" + Name;
393 std::string LocalName = "__fn_local_" + Name;
394 Function *FStub = Function::Create
395 (F->getFunctionType(),
396 Function::InternalLinkage, StubName, M);
397 FStub->addFnAttr("mips16_fp_stub");
398 FStub->addFnAttr(llvm::Attribute::Naked);
399 FStub->addFnAttr(llvm::Attribute::NoUnwind);
400 FStub->addFnAttr(llvm::Attribute::NoInline);
401 FStub->addFnAttr("nomips16");
402 FStub->setSection(SectionName);
403 BasicBlock *BB = BasicBlock::Create(Context, "entry", FStub);
404 InlineAsmHelper IAH(Context, BB);
405 IAH.Out(" .set macro");
407 IAH.Out(".set noreorder");
408 IAH.Out(".cpload $$2");
409 IAH.Out(".set reorder");
410 IAH.Out(".reloc 0,R_MIPS_NONE," + Name);
411 IAH.Out("la $$25," + LocalName);
414 IAH.Out("la $$25, " + Name);
415 swapFPIntParams(PV, M, IAH, LE, false);
417 IAH.Out(LocalName + " = " + Name);
418 new UnreachableInst(FStub->getContext(), BB);
424 // This pass only makes sense when the underlying chip has floating point but
425 // we are compiling as mips16.
426 // For all mips16 functions (that are not stubs we have already generated), or
427 // declared via attributes as nomips16, we must:
428 // 1) fixup all returns of float, double, single and double complex
429 // by calling a helper function before the actual return.
430 // 2) generate helper functions (stubs) that can be called by mips32 functions
431 // that will move parameters passed normally passed in floating point
432 // registers the soft float equivalents.
433 // 3) in the case of static relocation, generate helper functions so that
434 // mips16 functions can call extern functions of unknown type (mips16 or
436 // 4) TBD. For pic, calls to extern functions of unknown type are handled by
437 // predefined helper functions in libc but this work is currently done
438 // during call lowering but it should be moved here in the future.
440 bool Mips16HardFloat::runOnModule(Module &M) {
441 DEBUG(errs() << "Run on Module Mips16HardFloat\n");
442 bool Modified = false;
443 for (Module::iterator F = M.begin(), E = M.end(); F != E; ++F) {
444 if (F->isDeclaration() || F->hasFnAttribute("mips16_fp_stub") ||
445 F->hasFnAttribute("nomips16")) continue;
446 Modified |= fixupFPReturnAndCall(*F, &M, Subtarget);
447 FPParamVariant V = whichFPParamVariantNeeded(*F);
450 createFPFnStub(F, &M, V, Subtarget);
456 char Mips16HardFloat::ID = 0;
460 ModulePass *llvm::createMips16HardFloat(MipsTargetMachine &TM) {
461 return new Mips16HardFloat(TM);