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