1 //=- WebAssemblyISelLowering.cpp - WebAssembly DAG Lowering Implementation -==//
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 /// \file
11 /// This file implements the WebAssemblyTargetLowering class.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #include "WebAssemblyISelLowering.h"
16 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
17 #include "WebAssemblyMachineFunctionInfo.h"
18 #include "WebAssemblySubtarget.h"
19 #include "WebAssemblyTargetMachine.h"
20 #include "llvm/CodeGen/Analysis.h"
21 #include "llvm/CodeGen/CallingConvLower.h"
22 #include "llvm/CodeGen/MachineInstrBuilder.h"
23 #include "llvm/CodeGen/MachineJumpTableInfo.h"
24 #include "llvm/CodeGen/MachineRegisterInfo.h"
25 #include "llvm/CodeGen/SelectionDAG.h"
26 #include "llvm/IR/DiagnosticInfo.h"
27 #include "llvm/IR/DiagnosticPrinter.h"
28 #include "llvm/IR/Function.h"
29 #include "llvm/IR/Intrinsics.h"
30 #include "llvm/Support/Debug.h"
31 #include "llvm/Support/ErrorHandling.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include "llvm/Target/TargetOptions.h"
34 using namespace llvm;
35 
36 #define DEBUG_TYPE "wasm-lower"
37 
38 WebAssemblyTargetLowering::WebAssemblyTargetLowering(
39     const TargetMachine &TM, const WebAssemblySubtarget &STI)
40     : TargetLowering(TM), Subtarget(&STI) {
41   auto MVTPtr = Subtarget->hasAddr64() ? MVT::i64 : MVT::i32;
42 
43   // Booleans always contain 0 or 1.
44   setBooleanContents(ZeroOrOneBooleanContent);
45   // WebAssembly does not produce floating-point exceptions on normal floating
46   // point operations.
47   setHasFloatingPointExceptions(false);
48   // We don't know the microarchitecture here, so just reduce register pressure.
49   setSchedulingPreference(Sched::RegPressure);
50   // Tell ISel that we have a stack pointer.
51   setStackPointerRegisterToSaveRestore(
52       Subtarget->hasAddr64() ? WebAssembly::SP64 : WebAssembly::SP32);
53   // Set up the register classes.
54   addRegisterClass(MVT::i32, &WebAssembly::I32RegClass);
55   addRegisterClass(MVT::i64, &WebAssembly::I64RegClass);
56   addRegisterClass(MVT::f32, &WebAssembly::F32RegClass);
57   addRegisterClass(MVT::f64, &WebAssembly::F64RegClass);
58   if (Subtarget->hasSIMD128()) {
59     addRegisterClass(MVT::v16i8, &WebAssembly::V128RegClass);
60     addRegisterClass(MVT::v8i16, &WebAssembly::V128RegClass);
61     addRegisterClass(MVT::v4i32, &WebAssembly::V128RegClass);
62     addRegisterClass(MVT::v4f32, &WebAssembly::V128RegClass);
63   }
64   // Compute derived properties from the register classes.
65   computeRegisterProperties(Subtarget->getRegisterInfo());
66 
67   setOperationAction(ISD::GlobalAddress, MVTPtr, Custom);
68   setOperationAction(ISD::ExternalSymbol, MVTPtr, Custom);
69   setOperationAction(ISD::JumpTable, MVTPtr, Custom);
70   setOperationAction(ISD::BlockAddress, MVTPtr, Custom);
71   setOperationAction(ISD::BRIND, MVT::Other, Custom);
72 
73   // Take the default expansion for va_arg, va_copy, and va_end. There is no
74   // default action for va_start, so we do that custom.
75   setOperationAction(ISD::VASTART, MVT::Other, Custom);
76   setOperationAction(ISD::VAARG, MVT::Other, Expand);
77   setOperationAction(ISD::VACOPY, MVT::Other, Expand);
78   setOperationAction(ISD::VAEND, MVT::Other, Expand);
79 
80   for (auto T : {MVT::f32, MVT::f64}) {
81     // Don't expand the floating-point types to constant pools.
82     setOperationAction(ISD::ConstantFP, T, Legal);
83     // Expand floating-point comparisons.
84     for (auto CC : {ISD::SETO, ISD::SETUO, ISD::SETUEQ, ISD::SETONE,
85                     ISD::SETULT, ISD::SETULE, ISD::SETUGT, ISD::SETUGE})
86       setCondCodeAction(CC, T, Expand);
87     // Expand floating-point library function operators.
88     for (auto Op : {ISD::FSIN, ISD::FCOS, ISD::FSINCOS, ISD::FPOW, ISD::FREM,
89                     ISD::FMA})
90       setOperationAction(Op, T, Expand);
91     // Note supported floating-point library function operators that otherwise
92     // default to expand.
93     for (auto Op :
94          {ISD::FCEIL, ISD::FFLOOR, ISD::FTRUNC, ISD::FNEARBYINT, ISD::FRINT})
95       setOperationAction(Op, T, Legal);
96     // Support minnan and maxnan, which otherwise default to expand.
97     setOperationAction(ISD::FMINNAN, T, Legal);
98     setOperationAction(ISD::FMAXNAN, T, Legal);
99     // WebAssembly currently has no builtin f16 support.
100     setOperationAction(ISD::FP16_TO_FP, T, Expand);
101     setOperationAction(ISD::FP_TO_FP16, T, Expand);
102     setLoadExtAction(ISD::EXTLOAD, T, MVT::f16, Expand);
103     setTruncStoreAction(T, MVT::f16, Expand);
104   }
105 
106   for (auto T : {MVT::i32, MVT::i64}) {
107     // Expand unavailable integer operations.
108     for (auto Op :
109          {ISD::BSWAP, ISD::SMUL_LOHI, ISD::UMUL_LOHI,
110           ISD::MULHS, ISD::MULHU, ISD::SDIVREM, ISD::UDIVREM, ISD::SHL_PARTS,
111           ISD::SRA_PARTS, ISD::SRL_PARTS, ISD::ADDC, ISD::ADDE, ISD::SUBC,
112           ISD::SUBE}) {
113       setOperationAction(Op, T, Expand);
114     }
115   }
116 
117   // As a special case, these operators use the type to mean the type to
118   // sign-extend from.
119   setOperationAction(ISD::SIGN_EXTEND_INREG, MVT::i1, Expand);
120   if (!Subtarget->hasSignExt()) {
121     for (auto T : {MVT::i8, MVT::i16, MVT::i32})
122       setOperationAction(ISD::SIGN_EXTEND_INREG, T, Expand);
123   }
124 
125   // Dynamic stack allocation: use the default expansion.
126   setOperationAction(ISD::STACKSAVE, MVT::Other, Expand);
127   setOperationAction(ISD::STACKRESTORE, MVT::Other, Expand);
128   setOperationAction(ISD::DYNAMIC_STACKALLOC, MVTPtr, Expand);
129 
130   setOperationAction(ISD::FrameIndex, MVT::i32, Custom);
131   setOperationAction(ISD::CopyToReg, MVT::Other, Custom);
132 
133   // Expand these forms; we pattern-match the forms that we can handle in isel.
134   for (auto T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64})
135     for (auto Op : {ISD::BR_CC, ISD::SELECT_CC})
136       setOperationAction(Op, T, Expand);
137 
138   // We have custom switch handling.
139   setOperationAction(ISD::BR_JT, MVT::Other, Custom);
140 
141   // WebAssembly doesn't have:
142   //  - Floating-point extending loads.
143   //  - Floating-point truncating stores.
144   //  - i1 extending loads.
145   setLoadExtAction(ISD::EXTLOAD, MVT::f64, MVT::f32, Expand);
146   setTruncStoreAction(MVT::f64, MVT::f32, Expand);
147   for (auto T : MVT::integer_valuetypes())
148     for (auto Ext : {ISD::EXTLOAD, ISD::ZEXTLOAD, ISD::SEXTLOAD})
149       setLoadExtAction(Ext, T, MVT::i1, Promote);
150 
151   // Trap lowers to wasm unreachable
152   setOperationAction(ISD::TRAP, MVT::Other, Legal);
153 
154   // Exception handling intrinsics
155   setOperationAction(ISD::INTRINSIC_WO_CHAIN, MVT::Other, Custom);
156 
157   setMaxAtomicSizeInBitsSupported(64);
158 }
159 
160 TargetLowering::AtomicExpansionKind
161 WebAssemblyTargetLowering::shouldExpandAtomicRMWInIR(AtomicRMWInst *AI) const {
162   // We have wasm instructions for these
163   switch (AI->getOperation()) {
164   case AtomicRMWInst::Add:
165   case AtomicRMWInst::Sub:
166   case AtomicRMWInst::And:
167   case AtomicRMWInst::Or:
168   case AtomicRMWInst::Xor:
169   case AtomicRMWInst::Xchg:
170     return AtomicExpansionKind::None;
171   default:
172     break;
173   }
174   return AtomicExpansionKind::CmpXChg;
175 }
176 
177 FastISel *WebAssemblyTargetLowering::createFastISel(
178     FunctionLoweringInfo &FuncInfo, const TargetLibraryInfo *LibInfo) const {
179   return WebAssembly::createFastISel(FuncInfo, LibInfo);
180 }
181 
182 bool WebAssemblyTargetLowering::isOffsetFoldingLegal(
183     const GlobalAddressSDNode * /*GA*/) const {
184   // All offsets can be folded.
185   return true;
186 }
187 
188 MVT WebAssemblyTargetLowering::getScalarShiftAmountTy(const DataLayout & /*DL*/,
189                                                       EVT VT) const {
190   unsigned BitWidth = NextPowerOf2(VT.getSizeInBits() - 1);
191   if (BitWidth > 1 && BitWidth < 8) BitWidth = 8;
192 
193   if (BitWidth > 64) {
194     // The shift will be lowered to a libcall, and compiler-rt libcalls expect
195     // the count to be an i32.
196     BitWidth = 32;
197     assert(BitWidth >= Log2_32_Ceil(VT.getSizeInBits()) &&
198            "32-bit shift counts ought to be enough for anyone");
199   }
200 
201   MVT Result = MVT::getIntegerVT(BitWidth);
202   assert(Result != MVT::INVALID_SIMPLE_VALUE_TYPE &&
203          "Unable to represent scalar shift amount type");
204   return Result;
205 }
206 
207 // Lower an fp-to-int conversion operator from the LLVM opcode, which has an
208 // undefined result on invalid/overflow, to the WebAssembly opcode, which
209 // traps on invalid/overflow.
210 static MachineBasicBlock *
211 LowerFPToInt(
212     MachineInstr &MI,
213     DebugLoc DL,
214     MachineBasicBlock *BB,
215     const TargetInstrInfo &TII,
216     bool IsUnsigned,
217     bool Int64,
218     bool Float64,
219     unsigned LoweredOpcode
220 ) {
221   MachineRegisterInfo &MRI = BB->getParent()->getRegInfo();
222 
223   unsigned OutReg = MI.getOperand(0).getReg();
224   unsigned InReg = MI.getOperand(1).getReg();
225 
226   unsigned Abs = Float64 ? WebAssembly::ABS_F64 : WebAssembly::ABS_F32;
227   unsigned FConst = Float64 ? WebAssembly::CONST_F64 : WebAssembly::CONST_F32;
228   unsigned LT = Float64 ? WebAssembly::LT_F64 : WebAssembly::LT_F32;
229   unsigned GE = Float64 ? WebAssembly::GE_F64 : WebAssembly::GE_F32;
230   unsigned IConst = Int64 ? WebAssembly::CONST_I64 : WebAssembly::CONST_I32;
231   unsigned Eqz = WebAssembly::EQZ_I32;
232   unsigned And = WebAssembly::AND_I32;
233   int64_t Limit = Int64 ? INT64_MIN : INT32_MIN;
234   int64_t Substitute = IsUnsigned ? 0 : Limit;
235   double CmpVal = IsUnsigned ? -(double)Limit * 2.0 : -(double)Limit;
236   auto &Context = BB->getParent()->getFunction().getContext();
237   Type *Ty = Float64 ? Type::getDoubleTy(Context) : Type::getFloatTy(Context);
238 
239   const BasicBlock *LLVM_BB = BB->getBasicBlock();
240   MachineFunction *F = BB->getParent();
241   MachineBasicBlock *TrueMBB = F->CreateMachineBasicBlock(LLVM_BB);
242   MachineBasicBlock *FalseMBB = F->CreateMachineBasicBlock(LLVM_BB);
243   MachineBasicBlock *DoneMBB = F->CreateMachineBasicBlock(LLVM_BB);
244 
245   MachineFunction::iterator It = ++BB->getIterator();
246   F->insert(It, FalseMBB);
247   F->insert(It, TrueMBB);
248   F->insert(It, DoneMBB);
249 
250   // Transfer the remainder of BB and its successor edges to DoneMBB.
251   DoneMBB->splice(DoneMBB->begin(), BB,
252                   std::next(MachineBasicBlock::iterator(MI)),
253                   BB->end());
254   DoneMBB->transferSuccessorsAndUpdatePHIs(BB);
255 
256   BB->addSuccessor(TrueMBB);
257   BB->addSuccessor(FalseMBB);
258   TrueMBB->addSuccessor(DoneMBB);
259   FalseMBB->addSuccessor(DoneMBB);
260 
261   unsigned Tmp0, Tmp1, CmpReg, EqzReg, FalseReg, TrueReg;
262   Tmp0 = MRI.createVirtualRegister(MRI.getRegClass(InReg));
263   Tmp1 = MRI.createVirtualRegister(MRI.getRegClass(InReg));
264   CmpReg = MRI.createVirtualRegister(&WebAssembly::I32RegClass);
265   EqzReg = MRI.createVirtualRegister(&WebAssembly::I32RegClass);
266   FalseReg = MRI.createVirtualRegister(MRI.getRegClass(OutReg));
267   TrueReg = MRI.createVirtualRegister(MRI.getRegClass(OutReg));
268 
269   MI.eraseFromParent();
270   // For signed numbers, we can do a single comparison to determine whether
271   // fabs(x) is within range.
272   if (IsUnsigned) {
273     Tmp0 = InReg;
274   } else {
275     BuildMI(BB, DL, TII.get(Abs), Tmp0)
276         .addReg(InReg);
277   }
278   BuildMI(BB, DL, TII.get(FConst), Tmp1)
279       .addFPImm(cast<ConstantFP>(ConstantFP::get(Ty, CmpVal)));
280   BuildMI(BB, DL, TII.get(LT), CmpReg)
281       .addReg(Tmp0)
282       .addReg(Tmp1);
283 
284   // For unsigned numbers, we have to do a separate comparison with zero.
285   if (IsUnsigned) {
286     Tmp1 = MRI.createVirtualRegister(MRI.getRegClass(InReg));
287     unsigned SecondCmpReg = MRI.createVirtualRegister(&WebAssembly::I32RegClass);
288     unsigned AndReg = MRI.createVirtualRegister(&WebAssembly::I32RegClass);
289     BuildMI(BB, DL, TII.get(FConst), Tmp1)
290         .addFPImm(cast<ConstantFP>(ConstantFP::get(Ty, 0.0)));
291     BuildMI(BB, DL, TII.get(GE), SecondCmpReg)
292         .addReg(Tmp0)
293         .addReg(Tmp1);
294     BuildMI(BB, DL, TII.get(And), AndReg)
295         .addReg(CmpReg)
296         .addReg(SecondCmpReg);
297     CmpReg = AndReg;
298   }
299 
300   BuildMI(BB, DL, TII.get(Eqz), EqzReg)
301       .addReg(CmpReg);
302 
303   // Create the CFG diamond to select between doing the conversion or using
304   // the substitute value.
305   BuildMI(BB, DL, TII.get(WebAssembly::BR_IF))
306       .addMBB(TrueMBB)
307       .addReg(EqzReg);
308   BuildMI(FalseMBB, DL, TII.get(LoweredOpcode), FalseReg)
309       .addReg(InReg);
310   BuildMI(FalseMBB, DL, TII.get(WebAssembly::BR))
311       .addMBB(DoneMBB);
312   BuildMI(TrueMBB, DL, TII.get(IConst), TrueReg)
313       .addImm(Substitute);
314   BuildMI(*DoneMBB, DoneMBB->begin(), DL, TII.get(TargetOpcode::PHI), OutReg)
315       .addReg(FalseReg)
316       .addMBB(FalseMBB)
317       .addReg(TrueReg)
318       .addMBB(TrueMBB);
319 
320   return DoneMBB;
321 }
322 
323 MachineBasicBlock *
324 WebAssemblyTargetLowering::EmitInstrWithCustomInserter(
325     MachineInstr &MI,
326     MachineBasicBlock *BB
327 ) const {
328   const TargetInstrInfo &TII = *Subtarget->getInstrInfo();
329   DebugLoc DL = MI.getDebugLoc();
330 
331   switch (MI.getOpcode()) {
332   default: llvm_unreachable("Unexpected instr type to insert");
333   case WebAssembly::FP_TO_SINT_I32_F32:
334     return LowerFPToInt(MI, DL, BB, TII, false, false, false,
335                         WebAssembly::I32_TRUNC_S_F32);
336   case WebAssembly::FP_TO_UINT_I32_F32:
337     return LowerFPToInt(MI, DL, BB, TII, true, false, false,
338                         WebAssembly::I32_TRUNC_U_F32);
339   case WebAssembly::FP_TO_SINT_I64_F32:
340     return LowerFPToInt(MI, DL, BB, TII, false, true, false,
341                         WebAssembly::I64_TRUNC_S_F32);
342   case WebAssembly::FP_TO_UINT_I64_F32:
343     return LowerFPToInt(MI, DL, BB, TII, true, true, false,
344                         WebAssembly::I64_TRUNC_U_F32);
345   case WebAssembly::FP_TO_SINT_I32_F64:
346     return LowerFPToInt(MI, DL, BB, TII, false, false, true,
347                         WebAssembly::I32_TRUNC_S_F64);
348   case WebAssembly::FP_TO_UINT_I32_F64:
349     return LowerFPToInt(MI, DL, BB, TII, true, false, true,
350                         WebAssembly::I32_TRUNC_U_F64);
351   case WebAssembly::FP_TO_SINT_I64_F64:
352     return LowerFPToInt(MI, DL, BB, TII, false, true, true,
353                         WebAssembly::I64_TRUNC_S_F64);
354   case WebAssembly::FP_TO_UINT_I64_F64:
355     return LowerFPToInt(MI, DL, BB, TII, true, true, true,
356                         WebAssembly::I64_TRUNC_U_F64);
357   llvm_unreachable("Unexpected instruction to emit with custom inserter");
358   }
359 }
360 
361 const char *WebAssemblyTargetLowering::getTargetNodeName(
362     unsigned Opcode) const {
363   switch (static_cast<WebAssemblyISD::NodeType>(Opcode)) {
364     case WebAssemblyISD::FIRST_NUMBER:
365       break;
366 #define HANDLE_NODETYPE(NODE) \
367   case WebAssemblyISD::NODE:  \
368     return "WebAssemblyISD::" #NODE;
369 #include "WebAssemblyISD.def"
370 #undef HANDLE_NODETYPE
371   }
372   return nullptr;
373 }
374 
375 std::pair<unsigned, const TargetRegisterClass *>
376 WebAssemblyTargetLowering::getRegForInlineAsmConstraint(
377     const TargetRegisterInfo *TRI, StringRef Constraint, MVT VT) const {
378   // First, see if this is a constraint that directly corresponds to a
379   // WebAssembly register class.
380   if (Constraint.size() == 1) {
381     switch (Constraint[0]) {
382       case 'r':
383         assert(VT != MVT::iPTR && "Pointer MVT not expected here");
384         if (Subtarget->hasSIMD128() && VT.isVector()) {
385           if (VT.getSizeInBits() == 128)
386             return std::make_pair(0U, &WebAssembly::V128RegClass);
387         }
388         if (VT.isInteger() && !VT.isVector()) {
389           if (VT.getSizeInBits() <= 32)
390             return std::make_pair(0U, &WebAssembly::I32RegClass);
391           if (VT.getSizeInBits() <= 64)
392             return std::make_pair(0U, &WebAssembly::I64RegClass);
393         }
394         break;
395       default:
396         break;
397     }
398   }
399 
400   return TargetLowering::getRegForInlineAsmConstraint(TRI, Constraint, VT);
401 }
402 
403 bool WebAssemblyTargetLowering::isCheapToSpeculateCttz() const {
404   // Assume ctz is a relatively cheap operation.
405   return true;
406 }
407 
408 bool WebAssemblyTargetLowering::isCheapToSpeculateCtlz() const {
409   // Assume clz is a relatively cheap operation.
410   return true;
411 }
412 
413 bool WebAssemblyTargetLowering::isLegalAddressingMode(const DataLayout &DL,
414                                                       const AddrMode &AM,
415                                                       Type *Ty,
416                                                       unsigned AS,
417                                                       Instruction *I) const {
418   // WebAssembly offsets are added as unsigned without wrapping. The
419   // isLegalAddressingMode gives us no way to determine if wrapping could be
420   // happening, so we approximate this by accepting only non-negative offsets.
421   if (AM.BaseOffs < 0) return false;
422 
423   // WebAssembly has no scale register operands.
424   if (AM.Scale != 0) return false;
425 
426   // Everything else is legal.
427   return true;
428 }
429 
430 bool WebAssemblyTargetLowering::allowsMisalignedMemoryAccesses(
431     EVT /*VT*/, unsigned /*AddrSpace*/, unsigned /*Align*/, bool *Fast) const {
432   // WebAssembly supports unaligned accesses, though it should be declared
433   // with the p2align attribute on loads and stores which do so, and there
434   // may be a performance impact. We tell LLVM they're "fast" because
435   // for the kinds of things that LLVM uses this for (merging adjacent stores
436   // of constants, etc.), WebAssembly implementations will either want the
437   // unaligned access or they'll split anyway.
438   if (Fast) *Fast = true;
439   return true;
440 }
441 
442 bool WebAssemblyTargetLowering::isIntDivCheap(EVT VT,
443                                               AttributeList Attr) const {
444   // The current thinking is that wasm engines will perform this optimization,
445   // so we can save on code size.
446   return true;
447 }
448 
449 EVT WebAssemblyTargetLowering::getSetCCResultType(const DataLayout &DL,
450                                                   LLVMContext &C,
451                                                   EVT VT) const {
452   if (VT.isVector())
453     return VT.changeVectorElementTypeToInteger();
454 
455   return TargetLowering::getSetCCResultType(DL, C, VT);
456 }
457 
458 bool WebAssemblyTargetLowering::getTgtMemIntrinsic(IntrinsicInfo &Info,
459                                                    const CallInst &I,
460                                                    MachineFunction &MF,
461                                                    unsigned Intrinsic) const {
462   switch (Intrinsic) {
463   case Intrinsic::wasm_atomic_notify:
464     Info.opc = ISD::INTRINSIC_W_CHAIN;
465     Info.memVT = MVT::i32;
466     Info.ptrVal = I.getArgOperand(0);
467     Info.offset = 0;
468     Info.align = 4;
469     // atomic.notify instruction does not really load the memory specified with
470     // this argument, but MachineMemOperand should either be load or store, so
471     // we set this to a load.
472     // FIXME Volatile isn't really correct, but currently all LLVM atomic
473     // instructions are treated as volatiles in the backend, so we should be
474     // consistent. The same applies for wasm_atomic_wait intrinsics too.
475     Info.flags = MachineMemOperand::MOVolatile | MachineMemOperand::MOLoad;
476     return true;
477   case Intrinsic::wasm_atomic_wait_i32:
478     Info.opc = ISD::INTRINSIC_W_CHAIN;
479     Info.memVT = MVT::i32;
480     Info.ptrVal = I.getArgOperand(0);
481     Info.offset = 0;
482     Info.align = 4;
483     Info.flags = MachineMemOperand::MOVolatile | MachineMemOperand::MOLoad;
484     return true;
485   case Intrinsic::wasm_atomic_wait_i64:
486     Info.opc = ISD::INTRINSIC_W_CHAIN;
487     Info.memVT = MVT::i64;
488     Info.ptrVal = I.getArgOperand(0);
489     Info.offset = 0;
490     Info.align = 8;
491     Info.flags = MachineMemOperand::MOVolatile | MachineMemOperand::MOLoad;
492     return true;
493   default:
494     return false;
495   }
496 }
497 
498 //===----------------------------------------------------------------------===//
499 // WebAssembly Lowering private implementation.
500 //===----------------------------------------------------------------------===//
501 
502 //===----------------------------------------------------------------------===//
503 // Lowering Code
504 //===----------------------------------------------------------------------===//
505 
506 static void fail(const SDLoc &DL, SelectionDAG &DAG, const char *msg) {
507   MachineFunction &MF = DAG.getMachineFunction();
508   DAG.getContext()->diagnose(
509       DiagnosticInfoUnsupported(MF.getFunction(), msg, DL.getDebugLoc()));
510 }
511 
512 // Test whether the given calling convention is supported.
513 static bool CallingConvSupported(CallingConv::ID CallConv) {
514   // We currently support the language-independent target-independent
515   // conventions. We don't yet have a way to annotate calls with properties like
516   // "cold", and we don't have any call-clobbered registers, so these are mostly
517   // all handled the same.
518   return CallConv == CallingConv::C || CallConv == CallingConv::Fast ||
519          CallConv == CallingConv::Cold ||
520          CallConv == CallingConv::PreserveMost ||
521          CallConv == CallingConv::PreserveAll ||
522          CallConv == CallingConv::CXX_FAST_TLS;
523 }
524 
525 SDValue WebAssemblyTargetLowering::LowerCall(
526     CallLoweringInfo &CLI, SmallVectorImpl<SDValue> &InVals) const {
527   SelectionDAG &DAG = CLI.DAG;
528   SDLoc DL = CLI.DL;
529   SDValue Chain = CLI.Chain;
530   SDValue Callee = CLI.Callee;
531   MachineFunction &MF = DAG.getMachineFunction();
532   auto Layout = MF.getDataLayout();
533 
534   CallingConv::ID CallConv = CLI.CallConv;
535   if (!CallingConvSupported(CallConv))
536     fail(DL, DAG,
537          "WebAssembly doesn't support language-specific or target-specific "
538          "calling conventions yet");
539   if (CLI.IsPatchPoint)
540     fail(DL, DAG, "WebAssembly doesn't support patch point yet");
541 
542   // WebAssembly doesn't currently support explicit tail calls. If they are
543   // required, fail. Otherwise, just disable them.
544   if ((CallConv == CallingConv::Fast && CLI.IsTailCall &&
545        MF.getTarget().Options.GuaranteedTailCallOpt) ||
546       (CLI.CS && CLI.CS.isMustTailCall()))
547     fail(DL, DAG, "WebAssembly doesn't support tail call yet");
548   CLI.IsTailCall = false;
549 
550   SmallVectorImpl<ISD::InputArg> &Ins = CLI.Ins;
551   if (Ins.size() > 1)
552     fail(DL, DAG, "WebAssembly doesn't support more than 1 returned value yet");
553 
554   SmallVectorImpl<ISD::OutputArg> &Outs = CLI.Outs;
555   SmallVectorImpl<SDValue> &OutVals = CLI.OutVals;
556   unsigned NumFixedArgs = 0;
557   for (unsigned i = 0; i < Outs.size(); ++i) {
558     const ISD::OutputArg &Out = Outs[i];
559     SDValue &OutVal = OutVals[i];
560     if (Out.Flags.isNest())
561       fail(DL, DAG, "WebAssembly hasn't implemented nest arguments");
562     if (Out.Flags.isInAlloca())
563       fail(DL, DAG, "WebAssembly hasn't implemented inalloca arguments");
564     if (Out.Flags.isInConsecutiveRegs())
565       fail(DL, DAG, "WebAssembly hasn't implemented cons regs arguments");
566     if (Out.Flags.isInConsecutiveRegsLast())
567       fail(DL, DAG, "WebAssembly hasn't implemented cons regs last arguments");
568     if (Out.Flags.isByVal() && Out.Flags.getByValSize() != 0) {
569       auto &MFI = MF.getFrameInfo();
570       int FI = MFI.CreateStackObject(Out.Flags.getByValSize(),
571                                      Out.Flags.getByValAlign(),
572                                      /*isSS=*/false);
573       SDValue SizeNode =
574           DAG.getConstant(Out.Flags.getByValSize(), DL, MVT::i32);
575       SDValue FINode = DAG.getFrameIndex(FI, getPointerTy(Layout));
576       Chain = DAG.getMemcpy(
577           Chain, DL, FINode, OutVal, SizeNode, Out.Flags.getByValAlign(),
578           /*isVolatile*/ false, /*AlwaysInline=*/false,
579           /*isTailCall*/ false, MachinePointerInfo(), MachinePointerInfo());
580       OutVal = FINode;
581     }
582     // Count the number of fixed args *after* legalization.
583     NumFixedArgs += Out.IsFixed;
584   }
585 
586   bool IsVarArg = CLI.IsVarArg;
587   auto PtrVT = getPointerTy(Layout);
588 
589   // Analyze operands of the call, assigning locations to each operand.
590   SmallVector<CCValAssign, 16> ArgLocs;
591   CCState CCInfo(CallConv, IsVarArg, MF, ArgLocs, *DAG.getContext());
592 
593   if (IsVarArg) {
594     // Outgoing non-fixed arguments are placed in a buffer. First
595     // compute their offsets and the total amount of buffer space needed.
596     for (SDValue Arg :
597          make_range(OutVals.begin() + NumFixedArgs, OutVals.end())) {
598       EVT VT = Arg.getValueType();
599       assert(VT != MVT::iPTR && "Legalized args should be concrete");
600       Type *Ty = VT.getTypeForEVT(*DAG.getContext());
601       unsigned Offset = CCInfo.AllocateStack(Layout.getTypeAllocSize(Ty),
602                                              Layout.getABITypeAlignment(Ty));
603       CCInfo.addLoc(CCValAssign::getMem(ArgLocs.size(), VT.getSimpleVT(),
604                                         Offset, VT.getSimpleVT(),
605                                         CCValAssign::Full));
606     }
607   }
608 
609   unsigned NumBytes = CCInfo.getAlignedCallFrameSize();
610 
611   SDValue FINode;
612   if (IsVarArg && NumBytes) {
613     // For non-fixed arguments, next emit stores to store the argument values
614     // to the stack buffer at the offsets computed above.
615     int FI = MF.getFrameInfo().CreateStackObject(NumBytes,
616                                                  Layout.getStackAlignment(),
617                                                  /*isSS=*/false);
618     unsigned ValNo = 0;
619     SmallVector<SDValue, 8> Chains;
620     for (SDValue Arg :
621          make_range(OutVals.begin() + NumFixedArgs, OutVals.end())) {
622       assert(ArgLocs[ValNo].getValNo() == ValNo &&
623              "ArgLocs should remain in order and only hold varargs args");
624       unsigned Offset = ArgLocs[ValNo++].getLocMemOffset();
625       FINode = DAG.getFrameIndex(FI, getPointerTy(Layout));
626       SDValue Add = DAG.getNode(ISD::ADD, DL, PtrVT, FINode,
627                                 DAG.getConstant(Offset, DL, PtrVT));
628       Chains.push_back(DAG.getStore(
629           Chain, DL, Arg, Add,
630           MachinePointerInfo::getFixedStack(MF, FI, Offset), 0));
631     }
632     if (!Chains.empty())
633       Chain = DAG.getNode(ISD::TokenFactor, DL, MVT::Other, Chains);
634   } else if (IsVarArg) {
635     FINode = DAG.getIntPtrConstant(0, DL);
636   }
637 
638   // Compute the operands for the CALLn node.
639   SmallVector<SDValue, 16> Ops;
640   Ops.push_back(Chain);
641   Ops.push_back(Callee);
642 
643   // Add all fixed arguments. Note that for non-varargs calls, NumFixedArgs
644   // isn't reliable.
645   Ops.append(OutVals.begin(),
646              IsVarArg ? OutVals.begin() + NumFixedArgs : OutVals.end());
647   // Add a pointer to the vararg buffer.
648   if (IsVarArg) Ops.push_back(FINode);
649 
650   SmallVector<EVT, 8> InTys;
651   for (const auto &In : Ins) {
652     assert(!In.Flags.isByVal() && "byval is not valid for return values");
653     assert(!In.Flags.isNest() && "nest is not valid for return values");
654     if (In.Flags.isInAlloca())
655       fail(DL, DAG, "WebAssembly hasn't implemented inalloca return values");
656     if (In.Flags.isInConsecutiveRegs())
657       fail(DL, DAG, "WebAssembly hasn't implemented cons regs return values");
658     if (In.Flags.isInConsecutiveRegsLast())
659       fail(DL, DAG,
660            "WebAssembly hasn't implemented cons regs last return values");
661     // Ignore In.getOrigAlign() because all our arguments are passed in
662     // registers.
663     InTys.push_back(In.VT);
664   }
665   InTys.push_back(MVT::Other);
666   SDVTList InTyList = DAG.getVTList(InTys);
667   SDValue Res =
668       DAG.getNode(Ins.empty() ? WebAssemblyISD::CALL0 : WebAssemblyISD::CALL1,
669                   DL, InTyList, Ops);
670   if (Ins.empty()) {
671     Chain = Res;
672   } else {
673     InVals.push_back(Res);
674     Chain = Res.getValue(1);
675   }
676 
677   return Chain;
678 }
679 
680 bool WebAssemblyTargetLowering::CanLowerReturn(
681     CallingConv::ID /*CallConv*/, MachineFunction & /*MF*/, bool /*IsVarArg*/,
682     const SmallVectorImpl<ISD::OutputArg> &Outs,
683     LLVMContext & /*Context*/) const {
684   // WebAssembly can't currently handle returning tuples.
685   return Outs.size() <= 1;
686 }
687 
688 SDValue WebAssemblyTargetLowering::LowerReturn(
689     SDValue Chain, CallingConv::ID CallConv, bool /*IsVarArg*/,
690     const SmallVectorImpl<ISD::OutputArg> &Outs,
691     const SmallVectorImpl<SDValue> &OutVals, const SDLoc &DL,
692     SelectionDAG &DAG) const {
693   assert(Outs.size() <= 1 && "WebAssembly can only return up to one value");
694   if (!CallingConvSupported(CallConv))
695     fail(DL, DAG, "WebAssembly doesn't support non-C calling conventions");
696 
697   SmallVector<SDValue, 4> RetOps(1, Chain);
698   RetOps.append(OutVals.begin(), OutVals.end());
699   Chain = DAG.getNode(WebAssemblyISD::RETURN, DL, MVT::Other, RetOps);
700 
701   // Record the number and types of the return values.
702   for (const ISD::OutputArg &Out : Outs) {
703     assert(!Out.Flags.isByVal() && "byval is not valid for return values");
704     assert(!Out.Flags.isNest() && "nest is not valid for return values");
705     assert(Out.IsFixed && "non-fixed return value is not valid");
706     if (Out.Flags.isInAlloca())
707       fail(DL, DAG, "WebAssembly hasn't implemented inalloca results");
708     if (Out.Flags.isInConsecutiveRegs())
709       fail(DL, DAG, "WebAssembly hasn't implemented cons regs results");
710     if (Out.Flags.isInConsecutiveRegsLast())
711       fail(DL, DAG, "WebAssembly hasn't implemented cons regs last results");
712   }
713 
714   return Chain;
715 }
716 
717 SDValue WebAssemblyTargetLowering::LowerFormalArguments(
718     SDValue Chain, CallingConv::ID CallConv, bool IsVarArg,
719     const SmallVectorImpl<ISD::InputArg> &Ins, const SDLoc &DL,
720     SelectionDAG &DAG, SmallVectorImpl<SDValue> &InVals) const {
721   if (!CallingConvSupported(CallConv))
722     fail(DL, DAG, "WebAssembly doesn't support non-C calling conventions");
723 
724   MachineFunction &MF = DAG.getMachineFunction();
725   auto *MFI = MF.getInfo<WebAssemblyFunctionInfo>();
726 
727   // Set up the incoming ARGUMENTS value, which serves to represent the liveness
728   // of the incoming values before they're represented by virtual registers.
729   MF.getRegInfo().addLiveIn(WebAssembly::ARGUMENTS);
730 
731   for (const ISD::InputArg &In : Ins) {
732     if (In.Flags.isInAlloca())
733       fail(DL, DAG, "WebAssembly hasn't implemented inalloca arguments");
734     if (In.Flags.isNest())
735       fail(DL, DAG, "WebAssembly hasn't implemented nest arguments");
736     if (In.Flags.isInConsecutiveRegs())
737       fail(DL, DAG, "WebAssembly hasn't implemented cons regs arguments");
738     if (In.Flags.isInConsecutiveRegsLast())
739       fail(DL, DAG, "WebAssembly hasn't implemented cons regs last arguments");
740     // Ignore In.getOrigAlign() because all our arguments are passed in
741     // registers.
742     InVals.push_back(
743         In.Used
744             ? DAG.getNode(WebAssemblyISD::ARGUMENT, DL, In.VT,
745                           DAG.getTargetConstant(InVals.size(), DL, MVT::i32))
746             : DAG.getUNDEF(In.VT));
747 
748     // Record the number and types of arguments.
749     MFI->addParam(In.VT);
750   }
751 
752   // Varargs are copied into a buffer allocated by the caller, and a pointer to
753   // the buffer is passed as an argument.
754   if (IsVarArg) {
755     MVT PtrVT = getPointerTy(MF.getDataLayout());
756     unsigned VarargVreg =
757         MF.getRegInfo().createVirtualRegister(getRegClassFor(PtrVT));
758     MFI->setVarargBufferVreg(VarargVreg);
759     Chain = DAG.getCopyToReg(
760         Chain, DL, VarargVreg,
761         DAG.getNode(WebAssemblyISD::ARGUMENT, DL, PtrVT,
762                     DAG.getTargetConstant(Ins.size(), DL, MVT::i32)));
763     MFI->addParam(PtrVT);
764   }
765 
766   // Record the number and types of results.
767   SmallVector<MVT, 4> Params;
768   SmallVector<MVT, 4> Results;
769   ComputeSignatureVTs(MF.getFunction(), DAG.getTarget(), Params, Results);
770   for (MVT VT : Results)
771     MFI->addResult(VT);
772 
773   return Chain;
774 }
775 
776 //===----------------------------------------------------------------------===//
777 //  Custom lowering hooks.
778 //===----------------------------------------------------------------------===//
779 
780 SDValue WebAssemblyTargetLowering::LowerOperation(SDValue Op,
781                                                   SelectionDAG &DAG) const {
782   SDLoc DL(Op);
783   switch (Op.getOpcode()) {
784     default:
785       llvm_unreachable("unimplemented operation lowering");
786       return SDValue();
787     case ISD::FrameIndex:
788       return LowerFrameIndex(Op, DAG);
789     case ISD::GlobalAddress:
790       return LowerGlobalAddress(Op, DAG);
791     case ISD::ExternalSymbol:
792       return LowerExternalSymbol(Op, DAG);
793     case ISD::JumpTable:
794       return LowerJumpTable(Op, DAG);
795     case ISD::BR_JT:
796       return LowerBR_JT(Op, DAG);
797     case ISD::VASTART:
798       return LowerVASTART(Op, DAG);
799     case ISD::BlockAddress:
800     case ISD::BRIND:
801       fail(DL, DAG, "WebAssembly hasn't implemented computed gotos");
802       return SDValue();
803     case ISD::RETURNADDR: // Probably nothing meaningful can be returned here.
804       fail(DL, DAG, "WebAssembly hasn't implemented __builtin_return_address");
805       return SDValue();
806     case ISD::FRAMEADDR:
807       return LowerFRAMEADDR(Op, DAG);
808     case ISD::CopyToReg:
809       return LowerCopyToReg(Op, DAG);
810     case ISD::INTRINSIC_WO_CHAIN:
811       return LowerINTRINSIC_WO_CHAIN(Op, DAG);
812   }
813 }
814 
815 SDValue WebAssemblyTargetLowering::LowerCopyToReg(SDValue Op,
816                                                   SelectionDAG &DAG) const {
817   SDValue Src = Op.getOperand(2);
818   if (isa<FrameIndexSDNode>(Src.getNode())) {
819     // CopyToReg nodes don't support FrameIndex operands. Other targets select
820     // the FI to some LEA-like instruction, but since we don't have that, we
821     // need to insert some kind of instruction that can take an FI operand and
822     // produces a value usable by CopyToReg (i.e. in a vreg). So insert a dummy
823     // copy_local between Op and its FI operand.
824     SDValue Chain = Op.getOperand(0);
825     SDLoc DL(Op);
826     unsigned Reg = cast<RegisterSDNode>(Op.getOperand(1))->getReg();
827     EVT VT = Src.getValueType();
828     SDValue Copy(
829         DAG.getMachineNode(VT == MVT::i32 ? WebAssembly::COPY_I32
830                                           : WebAssembly::COPY_I64,
831                            DL, VT, Src),
832         0);
833     return Op.getNode()->getNumValues() == 1
834                ? DAG.getCopyToReg(Chain, DL, Reg, Copy)
835                : DAG.getCopyToReg(Chain, DL, Reg, Copy, Op.getNumOperands() == 4
836                                                             ? Op.getOperand(3)
837                                                             : SDValue());
838   }
839   return SDValue();
840 }
841 
842 SDValue WebAssemblyTargetLowering::LowerFrameIndex(SDValue Op,
843                                                    SelectionDAG &DAG) const {
844   int FI = cast<FrameIndexSDNode>(Op)->getIndex();
845   return DAG.getTargetFrameIndex(FI, Op.getValueType());
846 }
847 
848 SDValue WebAssemblyTargetLowering::LowerFRAMEADDR(SDValue Op,
849                                                   SelectionDAG &DAG) const {
850   // Non-zero depths are not supported by WebAssembly currently. Use the
851   // legalizer's default expansion, which is to return 0 (what this function is
852   // documented to do).
853   if (Op.getConstantOperandVal(0) > 0)
854     return SDValue();
855 
856   DAG.getMachineFunction().getFrameInfo().setFrameAddressIsTaken(true);
857   EVT VT = Op.getValueType();
858   unsigned FP =
859       Subtarget->getRegisterInfo()->getFrameRegister(DAG.getMachineFunction());
860   return DAG.getCopyFromReg(DAG.getEntryNode(), SDLoc(Op), FP, VT);
861 }
862 
863 SDValue WebAssemblyTargetLowering::LowerGlobalAddress(SDValue Op,
864                                                       SelectionDAG &DAG) const {
865   SDLoc DL(Op);
866   const auto *GA = cast<GlobalAddressSDNode>(Op);
867   EVT VT = Op.getValueType();
868   assert(GA->getTargetFlags() == 0 &&
869          "Unexpected target flags on generic GlobalAddressSDNode");
870   if (GA->getAddressSpace() != 0)
871     fail(DL, DAG, "WebAssembly only expects the 0 address space");
872   return DAG.getNode(
873       WebAssemblyISD::Wrapper, DL, VT,
874       DAG.getTargetGlobalAddress(GA->getGlobal(), DL, VT, GA->getOffset()));
875 }
876 
877 SDValue WebAssemblyTargetLowering::LowerExternalSymbol(
878     SDValue Op, SelectionDAG &DAG) const {
879   SDLoc DL(Op);
880   const auto *ES = cast<ExternalSymbolSDNode>(Op);
881   EVT VT = Op.getValueType();
882   assert(ES->getTargetFlags() == 0 &&
883          "Unexpected target flags on generic ExternalSymbolSDNode");
884   // Set the TargetFlags to 0x1 which indicates that this is a "function"
885   // symbol rather than a data symbol. We do this unconditionally even though
886   // we don't know anything about the symbol other than its name, because all
887   // external symbols used in target-independent SelectionDAG code are for
888   // functions.
889   return DAG.getNode(WebAssemblyISD::Wrapper, DL, VT,
890                      DAG.getTargetExternalSymbol(ES->getSymbol(), VT,
891                                                  WebAssemblyII::MO_SYMBOL_FUNCTION));
892 }
893 
894 SDValue WebAssemblyTargetLowering::LowerJumpTable(SDValue Op,
895                                                   SelectionDAG &DAG) const {
896   // There's no need for a Wrapper node because we always incorporate a jump
897   // table operand into a BR_TABLE instruction, rather than ever
898   // materializing it in a register.
899   const JumpTableSDNode *JT = cast<JumpTableSDNode>(Op);
900   return DAG.getTargetJumpTable(JT->getIndex(), Op.getValueType(),
901                                 JT->getTargetFlags());
902 }
903 
904 SDValue WebAssemblyTargetLowering::LowerBR_JT(SDValue Op,
905                                               SelectionDAG &DAG) const {
906   SDLoc DL(Op);
907   SDValue Chain = Op.getOperand(0);
908   const auto *JT = cast<JumpTableSDNode>(Op.getOperand(1));
909   SDValue Index = Op.getOperand(2);
910   assert(JT->getTargetFlags() == 0 && "WebAssembly doesn't set target flags");
911 
912   SmallVector<SDValue, 8> Ops;
913   Ops.push_back(Chain);
914   Ops.push_back(Index);
915 
916   MachineJumpTableInfo *MJTI = DAG.getMachineFunction().getJumpTableInfo();
917   const auto &MBBs = MJTI->getJumpTables()[JT->getIndex()].MBBs;
918 
919   // Add an operand for each case.
920   for (auto MBB : MBBs) Ops.push_back(DAG.getBasicBlock(MBB));
921 
922   // TODO: For now, we just pick something arbitrary for a default case for now.
923   // We really want to sniff out the guard and put in the real default case (and
924   // delete the guard).
925   Ops.push_back(DAG.getBasicBlock(MBBs[0]));
926 
927   return DAG.getNode(WebAssemblyISD::BR_TABLE, DL, MVT::Other, Ops);
928 }
929 
930 SDValue WebAssemblyTargetLowering::LowerVASTART(SDValue Op,
931                                                 SelectionDAG &DAG) const {
932   SDLoc DL(Op);
933   EVT PtrVT = getPointerTy(DAG.getMachineFunction().getDataLayout());
934 
935   auto *MFI = DAG.getMachineFunction().getInfo<WebAssemblyFunctionInfo>();
936   const Value *SV = cast<SrcValueSDNode>(Op.getOperand(2))->getValue();
937 
938   SDValue ArgN = DAG.getCopyFromReg(DAG.getEntryNode(), DL,
939                                     MFI->getVarargBufferVreg(), PtrVT);
940   return DAG.getStore(Op.getOperand(0), DL, ArgN, Op.getOperand(1),
941                       MachinePointerInfo(SV), 0);
942 }
943 
944 SDValue
945 WebAssemblyTargetLowering::LowerINTRINSIC_WO_CHAIN(SDValue Op,
946                                                    SelectionDAG &DAG) const {
947   unsigned IntNo = cast<ConstantSDNode>(Op.getOperand(0))->getZExtValue();
948   SDLoc DL(Op);
949   switch (IntNo) {
950   default:
951     return {}; // Don't custom lower most intrinsics.
952 
953   case Intrinsic::wasm_lsda:
954     // TODO For now, just return 0 not to crash
955     return DAG.getConstant(0, DL, Op.getValueType());
956   }
957 }
958 
959 //===----------------------------------------------------------------------===//
960 //                          WebAssembly Optimization Hooks
961 //===----------------------------------------------------------------------===//
962