10456c15cSDaniel Sanders //===---- MipsCCState.cpp - CCState with Mips specific extensions ---------===//
20456c15cSDaniel Sanders //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60456c15cSDaniel Sanders //
70456c15cSDaniel Sanders //===----------------------------------------------------------------------===//
80456c15cSDaniel Sanders 
90456c15cSDaniel Sanders #include "MipsCCState.h"
100456c15cSDaniel Sanders #include "MipsSubtarget.h"
110456c15cSDaniel Sanders #include "llvm/IR/Module.h"
120456c15cSDaniel Sanders 
130456c15cSDaniel Sanders using namespace llvm;
140456c15cSDaniel Sanders 
isF128SoftLibCall(const char * CallSym)15*121541fdSMatt Arsenault bool MipsCCState::isF128SoftLibCall(const char *CallSym) {
160456c15cSDaniel Sanders   const char *const LibCalls[] = {
170456c15cSDaniel Sanders       "__addtf3",      "__divtf3",     "__eqtf2",       "__extenddftf2",
180456c15cSDaniel Sanders       "__extendsftf2", "__fixtfdi",    "__fixtfsi",     "__fixtfti",
190456c15cSDaniel Sanders       "__fixunstfdi",  "__fixunstfsi", "__fixunstfti",  "__floatditf",
200456c15cSDaniel Sanders       "__floatsitf",   "__floattitf",  "__floatunditf", "__floatunsitf",
210456c15cSDaniel Sanders       "__floatuntitf", "__getf2",      "__gttf2",       "__letf2",
220456c15cSDaniel Sanders       "__lttf2",       "__multf3",     "__netf2",       "__powitf2",
230456c15cSDaniel Sanders       "__subtf3",      "__trunctfdf2", "__trunctfsf2",  "__unordtf2",
240456c15cSDaniel Sanders       "ceill",         "copysignl",    "cosl",          "exp2l",
25285c0f4fSStefan Maksimovic       "expl",          "floorl",       "fmal",          "fmaxl",
26285c0f4fSStefan Maksimovic       "fmodl",         "log10l",       "log2l",         "logl",
27285c0f4fSStefan Maksimovic       "nearbyintl",    "powl",         "rintl",         "roundl",
28285c0f4fSStefan Maksimovic       "sinl",          "sqrtl",        "truncl"};
290456c15cSDaniel Sanders 
300456c15cSDaniel Sanders   // Check that LibCalls is sorted alphabetically.
31a8334511SCraig Topper   auto Comp = [](const char *S1, const char *S2) { return strcmp(S1, S2) < 0; };
321647ff6eSGeorgii Rymar   assert(llvm::is_sorted(LibCalls, Comp));
331647ff6eSGeorgii Rymar   return std::binary_search(std::begin(LibCalls), std::end(LibCalls), CallSym,
341647ff6eSGeorgii Rymar                             Comp);
350456c15cSDaniel Sanders }
360456c15cSDaniel Sanders 
370456c15cSDaniel Sanders /// This function returns true if Ty is fp128, {f128} or i128 which was
380456c15cSDaniel Sanders /// originally a fp128.
originalTypeIsF128(const Type * Ty,const char * Func)39*121541fdSMatt Arsenault bool MipsCCState::originalTypeIsF128(const Type *Ty, const char *Func) {
400456c15cSDaniel Sanders   if (Ty->isFP128Ty())
410456c15cSDaniel Sanders     return true;
420456c15cSDaniel Sanders 
430456c15cSDaniel Sanders   if (Ty->isStructTy() && Ty->getStructNumElements() == 1 &&
440456c15cSDaniel Sanders       Ty->getStructElementType(0)->isFP128Ty())
450456c15cSDaniel Sanders     return true;
460456c15cSDaniel Sanders 
470456c15cSDaniel Sanders   // If the Ty is i128 and the function being called is a long double emulation
480456c15cSDaniel Sanders   // routine, then the original type is f128.
49*121541fdSMatt Arsenault   // FIXME: This is unsound because these functions could be indirectly called
5070f79251SSimon Dardis   return (Func && Ty->isIntegerTy(128) && isF128SoftLibCall(Func));
510456c15cSDaniel Sanders }
520456c15cSDaniel Sanders 
53212cccb2SSimon Dardis /// Return true if the original type was vXfXX.
originalEVTTypeIsVectorFloat(EVT Ty)54*121541fdSMatt Arsenault bool MipsCCState::originalEVTTypeIsVectorFloat(EVT Ty) {
55212cccb2SSimon Dardis   if (Ty.isVector() && Ty.getVectorElementType().isFloatingPoint())
56212cccb2SSimon Dardis     return true;
57212cccb2SSimon Dardis 
58212cccb2SSimon Dardis   return false;
59212cccb2SSimon Dardis }
60212cccb2SSimon Dardis 
61212cccb2SSimon Dardis /// Return true if the original type was vXfXX / vXfXX.
originalTypeIsVectorFloat(const Type * Ty)62*121541fdSMatt Arsenault bool MipsCCState::originalTypeIsVectorFloat(const Type *Ty) {
63212cccb2SSimon Dardis   if (Ty->isVectorTy() && Ty->isFPOrFPVectorTy())
64212cccb2SSimon Dardis     return true;
65212cccb2SSimon Dardis 
66212cccb2SSimon Dardis   return false;
67212cccb2SSimon Dardis }
68212cccb2SSimon Dardis 
690456c15cSDaniel Sanders MipsCCState::SpecialCallingConvType
getSpecialCallingConvForCallee(const SDNode * Callee,const MipsSubtarget & Subtarget)700456c15cSDaniel Sanders MipsCCState::getSpecialCallingConvForCallee(const SDNode *Callee,
710456c15cSDaniel Sanders                                             const MipsSubtarget &Subtarget) {
720456c15cSDaniel Sanders   MipsCCState::SpecialCallingConvType SpecialCallingConv = NoSpecialCallingConv;
730456c15cSDaniel Sanders   if (Subtarget.inMips16HardFloat()) {
740456c15cSDaniel Sanders     if (const GlobalAddressSDNode *G =
750456c15cSDaniel Sanders             dyn_cast<const GlobalAddressSDNode>(Callee)) {
760456c15cSDaniel Sanders       llvm::StringRef Sym = G->getGlobal()->getName();
770456c15cSDaniel Sanders       Function *F = G->getGlobal()->getParent()->getFunction(Sym);
780456c15cSDaniel Sanders       if (F && F->hasFnAttribute("__Mips16RetHelper")) {
790456c15cSDaniel Sanders         SpecialCallingConv = Mips16RetHelperConv;
800456c15cSDaniel Sanders       }
810456c15cSDaniel Sanders     }
820456c15cSDaniel Sanders   }
830456c15cSDaniel Sanders   return SpecialCallingConv;
840456c15cSDaniel Sanders }
850456c15cSDaniel Sanders 
PreAnalyzeCallResultForF128(const SmallVectorImpl<ISD::InputArg> & Ins,const Type * RetTy,const char * Call)860456c15cSDaniel Sanders void MipsCCState::PreAnalyzeCallResultForF128(
870456c15cSDaniel Sanders     const SmallVectorImpl<ISD::InputArg> &Ins,
8870f79251SSimon Dardis     const Type *RetTy, const char *Call) {
89c43cda84SDaniel Sanders   for (unsigned i = 0; i < Ins.size(); ++i) {
900456c15cSDaniel Sanders     OriginalArgWasF128.push_back(
9170f79251SSimon Dardis         originalTypeIsF128(RetTy, Call));
9270f79251SSimon Dardis     OriginalArgWasFloat.push_back(RetTy->isFloatingPointTy());
93c43cda84SDaniel Sanders   }
940456c15cSDaniel Sanders }
950456c15cSDaniel Sanders 
96212cccb2SSimon Dardis /// Identify lowered values that originated from f128 or float arguments and
97212cccb2SSimon Dardis /// record this for use by RetCC_MipsN.
PreAnalyzeReturnForF128(const SmallVectorImpl<ISD::OutputArg> & Outs)980456c15cSDaniel Sanders void MipsCCState::PreAnalyzeReturnForF128(
990456c15cSDaniel Sanders     const SmallVectorImpl<ISD::OutputArg> &Outs) {
1000456c15cSDaniel Sanders   const MachineFunction &MF = getMachineFunction();
101c43cda84SDaniel Sanders   for (unsigned i = 0; i < Outs.size(); ++i) {
1020456c15cSDaniel Sanders     OriginalArgWasF128.push_back(
103f1caa283SMatthias Braun         originalTypeIsF128(MF.getFunction().getReturnType(), nullptr));
104c43cda84SDaniel Sanders     OriginalArgWasFloat.push_back(
105f1caa283SMatthias Braun         MF.getFunction().getReturnType()->isFloatingPointTy());
106c43cda84SDaniel Sanders   }
1070456c15cSDaniel Sanders }
1080456c15cSDaniel Sanders 
109212cccb2SSimon Dardis /// Identify lower values that originated from vXfXX and record
1100456c15cSDaniel Sanders /// this.
PreAnalyzeCallResultForVectorFloat(const SmallVectorImpl<ISD::InputArg> & Ins,const Type * RetTy)111212cccb2SSimon Dardis void MipsCCState::PreAnalyzeCallResultForVectorFloat(
112212cccb2SSimon Dardis     const SmallVectorImpl<ISD::InputArg> &Ins, const Type *RetTy) {
113212cccb2SSimon Dardis   for (unsigned i = 0; i < Ins.size(); ++i) {
114212cccb2SSimon Dardis     OriginalRetWasFloatVector.push_back(originalTypeIsVectorFloat(RetTy));
115212cccb2SSimon Dardis   }
116212cccb2SSimon Dardis }
117212cccb2SSimon Dardis 
118212cccb2SSimon Dardis /// Identify lowered values that originated from vXfXX arguments and record
119212cccb2SSimon Dardis /// this.
PreAnalyzeReturnForVectorFloat(const SmallVectorImpl<ISD::OutputArg> & Outs)120212cccb2SSimon Dardis void MipsCCState::PreAnalyzeReturnForVectorFloat(
121212cccb2SSimon Dardis     const SmallVectorImpl<ISD::OutputArg> &Outs) {
122212cccb2SSimon Dardis   for (unsigned i = 0; i < Outs.size(); ++i) {
123212cccb2SSimon Dardis     ISD::OutputArg Out = Outs[i];
124212cccb2SSimon Dardis     OriginalRetWasFloatVector.push_back(
125212cccb2SSimon Dardis         originalEVTTypeIsVectorFloat(Out.ArgVT));
126212cccb2SSimon Dardis   }
127212cccb2SSimon Dardis }
128212cccb2SSimon Dardis 
PreAnalyzeReturnValue(EVT ArgVT)129*121541fdSMatt Arsenault void MipsCCState::PreAnalyzeReturnValue(EVT ArgVT) {
130*121541fdSMatt Arsenault   OriginalRetWasFloatVector.push_back(originalEVTTypeIsVectorFloat(ArgVT));
131*121541fdSMatt Arsenault }
132*121541fdSMatt Arsenault 
PreAnalyzeCallOperand(const Type * ArgTy,bool IsFixed,const char * Func)133*121541fdSMatt Arsenault void MipsCCState::PreAnalyzeCallOperand(const Type *ArgTy, bool IsFixed,
134*121541fdSMatt Arsenault                                         const char *Func) {
135*121541fdSMatt Arsenault   OriginalArgWasF128.push_back(originalTypeIsF128(ArgTy, Func));
136*121541fdSMatt Arsenault   OriginalArgWasFloat.push_back(ArgTy->isFloatingPointTy());
137*121541fdSMatt Arsenault   OriginalArgWasFloatVector.push_back(ArgTy->isVectorTy());
138*121541fdSMatt Arsenault   CallOperandIsFixed.push_back(IsFixed);
139*121541fdSMatt Arsenault }
140*121541fdSMatt Arsenault 
141212cccb2SSimon Dardis /// Identify lowered values that originated from f128, float and sret to vXfXX
142212cccb2SSimon Dardis /// arguments and record this.
PreAnalyzeCallOperands(const SmallVectorImpl<ISD::OutputArg> & Outs,std::vector<TargetLowering::ArgListEntry> & FuncArgs,const char * Func)1430456c15cSDaniel Sanders void MipsCCState::PreAnalyzeCallOperands(
1440456c15cSDaniel Sanders     const SmallVectorImpl<ISD::OutputArg> &Outs,
1450456c15cSDaniel Sanders     std::vector<TargetLowering::ArgListEntry> &FuncArgs,
14670f79251SSimon Dardis     const char *Func) {
1470456c15cSDaniel Sanders   for (unsigned i = 0; i < Outs.size(); ++i) {
148212cccb2SSimon Dardis     TargetLowering::ArgListEntry FuncArg = FuncArgs[Outs[i].OrigArgIndex];
149212cccb2SSimon Dardis 
150212cccb2SSimon Dardis     OriginalArgWasF128.push_back(originalTypeIsF128(FuncArg.Ty, Func));
151212cccb2SSimon Dardis     OriginalArgWasFloat.push_back(FuncArg.Ty->isFloatingPointTy());
152212cccb2SSimon Dardis     OriginalArgWasFloatVector.push_back(FuncArg.Ty->isVectorTy());
1530456c15cSDaniel Sanders     CallOperandIsFixed.push_back(Outs[i].IsFixed);
1540456c15cSDaniel Sanders   }
1550456c15cSDaniel Sanders }
1560456c15cSDaniel Sanders 
PreAnalyzeFormalArgument(const Type * ArgTy,ISD::ArgFlagsTy Flags)157*121541fdSMatt Arsenault void MipsCCState::PreAnalyzeFormalArgument(const Type *ArgTy,
158*121541fdSMatt Arsenault                                            ISD::ArgFlagsTy Flags) {
159*121541fdSMatt Arsenault   // SRet arguments cannot originate from f128 or {f128} returns so we just
160*121541fdSMatt Arsenault   // push false. We have to handle this specially since SRet arguments
161*121541fdSMatt Arsenault   // aren't mapped to an original argument.
162*121541fdSMatt Arsenault   if (Flags.isSRet()) {
163*121541fdSMatt Arsenault     OriginalArgWasF128.push_back(false);
164*121541fdSMatt Arsenault     OriginalArgWasFloat.push_back(false);
165*121541fdSMatt Arsenault     OriginalArgWasFloatVector.push_back(false);
166*121541fdSMatt Arsenault     return;
167*121541fdSMatt Arsenault   }
168*121541fdSMatt Arsenault 
169*121541fdSMatt Arsenault   OriginalArgWasF128.push_back(originalTypeIsF128(ArgTy, nullptr));
170*121541fdSMatt Arsenault   OriginalArgWasFloat.push_back(ArgTy->isFloatingPointTy());
171*121541fdSMatt Arsenault 
172*121541fdSMatt Arsenault   // The MIPS vector ABI exhibits a corner case of sorts or quirk; if the
173*121541fdSMatt Arsenault   // first argument is actually an SRet pointer to a vector, then the next
174*121541fdSMatt Arsenault   // argument slot is $a2.
175*121541fdSMatt Arsenault   OriginalArgWasFloatVector.push_back(ArgTy->isVectorTy());
176*121541fdSMatt Arsenault }
177*121541fdSMatt Arsenault 
178212cccb2SSimon Dardis /// Identify lowered values that originated from f128, float and vXfXX arguments
179212cccb2SSimon Dardis /// and record this.
PreAnalyzeFormalArgumentsForF128(const SmallVectorImpl<ISD::InputArg> & Ins)1800456c15cSDaniel Sanders void MipsCCState::PreAnalyzeFormalArgumentsForF128(
1810456c15cSDaniel Sanders     const SmallVectorImpl<ISD::InputArg> &Ins) {
1820456c15cSDaniel Sanders   const MachineFunction &MF = getMachineFunction();
1830456c15cSDaniel Sanders   for (unsigned i = 0; i < Ins.size(); ++i) {
184f1caa283SMatthias Braun     Function::const_arg_iterator FuncArg = MF.getFunction().arg_begin();
1850456c15cSDaniel Sanders 
1860456c15cSDaniel Sanders     // SRet arguments cannot originate from f128 or {f128} returns so we just
1870456c15cSDaniel Sanders     // push false. We have to handle this specially since SRet arguments
1880456c15cSDaniel Sanders     // aren't mapped to an original argument.
1890456c15cSDaniel Sanders     if (Ins[i].Flags.isSRet()) {
1900456c15cSDaniel Sanders       OriginalArgWasF128.push_back(false);
19187f9b88bSDaniel Sanders       OriginalArgWasFloat.push_back(false);
192212cccb2SSimon Dardis       OriginalArgWasFloatVector.push_back(false);
1930456c15cSDaniel Sanders       continue;
1940456c15cSDaniel Sanders     }
1950456c15cSDaniel Sanders 
196f1caa283SMatthias Braun     assert(Ins[i].getOrigArgIndex() < MF.getFunction().arg_size());
19705938a54SAndrew Trick     std::advance(FuncArg, Ins[i].getOrigArgIndex());
1980456c15cSDaniel Sanders 
1990456c15cSDaniel Sanders     OriginalArgWasF128.push_back(
2000456c15cSDaniel Sanders         originalTypeIsF128(FuncArg->getType(), nullptr));
201c43cda84SDaniel Sanders     OriginalArgWasFloat.push_back(FuncArg->getType()->isFloatingPointTy());
202212cccb2SSimon Dardis 
203212cccb2SSimon Dardis     // The MIPS vector ABI exhibits a corner case of sorts or quirk; if the
204212cccb2SSimon Dardis     // first argument is actually an SRet pointer to a vector, then the next
205212cccb2SSimon Dardis     // argument slot is $a2.
206212cccb2SSimon Dardis     OriginalArgWasFloatVector.push_back(FuncArg->getType()->isVectorTy());
2070456c15cSDaniel Sanders   }
2080456c15cSDaniel Sanders }
209