lib/Target/WebAssembly/WebAssemblyISelLowering.cpp

   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 /// \brief 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 "WebAssemblyTargetObjectFile.h"
  21 #include "llvm/CodeGen/Analysis.h"
  22 #include "llvm/CodeGen/CallingConvLower.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/CommandLine.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/ErrorHandling.h"
  33 #include "llvm/Support/raw_ostream.h"
  34 #include "llvm/Target/TargetOptions.h"
  35 using namespace llvm;
  36
  37 #define DEBUG_TYPE "wasm-lower"
  38
  39 namespace {
  40 // Diagnostic information for unimplemented or unsupported feature reporting.
  41 // TODO: This code is copied from BPF and AMDGPU; consider factoring it out
  42 // and sharing code.
  43 class DiagnosticInfoUnsupported final : public DiagnosticInfo {
  44 private:
  45   // Debug location where this diagnostic is triggered.
  46   DebugLoc DLoc;
  47   const Twine &Description;
  48   const Function &Fn;
  49   SDValue Value;
  50
  51   static int KindID;
  52
  53   static int getKindID() {
  54     if (KindID == 0)
  55       KindID = llvm::getNextAvailablePluginDiagnosticKind();
  56     return KindID;
  57   }
  58
  59 public:
  60   DiagnosticInfoUnsupported(SDLoc DLoc, const Function &Fn, const Twine &Desc,
  61                             SDValue Value)
  62       : DiagnosticInfo(getKindID(), DS_Error), DLoc(DLoc.getDebugLoc()),
  63         Description(Desc), Fn(Fn), Value(Value) {}
  64
  65   void print(DiagnosticPrinter &DP) const override {
  66     std::string Str;
  67     raw_string_ostream OS(Str);
  68
  69     if (DLoc) {
  70       auto DIL = DLoc.get();
  71       StringRef Filename = DIL->getFilename();
  72       unsigned Line = DIL->getLine();
  73       unsigned Column = DIL->getColumn();
  74       OS << Filename << ':' << Line << ':' << Column << ' ';
  75     }
  76
  77     OS << "in function " << Fn.getName() << ' ' << *Fn.getFunctionType() << '\n'
  78        << Description;
  79     if (Value)
  80       Value->print(OS);
  81     OS << '\n';
  82     OS.flush();
  83     DP << Str;
  84   }
  85
  86   static bool classof(const DiagnosticInfo *DI) {
  87     return DI->getKind() == getKindID();
  88   }
  89 };
  90
  91 int DiagnosticInfoUnsupported::KindID = 0;
  92 } // end anonymous namespace
  93
  94 WebAssemblyTargetLowering::WebAssemblyTargetLowering(
  95     const TargetMachine &TM, const WebAssemblySubtarget &STI)
  96     : TargetLowering(TM), Subtarget(&STI) {
  97   auto MVTPtr = Subtarget->hasAddr64() ? MVT::i64 : MVT::i32;
  98
  99   // Booleans always contain 0 or 1.
 100   setBooleanContents(ZeroOrOneBooleanContent);
 101   // WebAssembly does not produce floating-point exceptions on normal floating
 102   // point operations.
 103   setHasFloatingPointExceptions(false);
 104   // We don't know the microarchitecture here, so just reduce register pressure.
 105   setSchedulingPreference(Sched::RegPressure);
 106   // Tell ISel that we have a stack pointer.
 107   setStackPointerRegisterToSaveRestore(
 108       Subtarget->hasAddr64() ? WebAssembly::SP64 : WebAssembly::SP32);
 109   // Set up the register classes.
 110   addRegisterClass(MVT::i32, &WebAssembly::I32RegClass);
 111   addRegisterClass(MVT::i64, &WebAssembly::I64RegClass);
 112   addRegisterClass(MVT::f32, &WebAssembly::F32RegClass);
 113   addRegisterClass(MVT::f64, &WebAssembly::F64RegClass);
 114   // Compute derived properties from the register classes.
 115   computeRegisterProperties(Subtarget->getRegisterInfo());
 116
 117   setOperationAction(ISD::GlobalAddress, MVTPtr, Custom);
 118   setOperationAction(ISD::ExternalSymbol, MVTPtr, Custom);
 119   setOperationAction(ISD::JumpTable, MVTPtr, Custom);
 120
 121   for (auto T : {MVT::f32, MVT::f64}) {
 122     // Don't expand the floating-point types to constant pools.
 123     setOperationAction(ISD::ConstantFP, T, Legal);
 124     // Expand floating-point comparisons.
 125     for (auto CC : {ISD::SETO, ISD::SETUO, ISD::SETUEQ, ISD::SETONE,
 126                     ISD::SETULT, ISD::SETULE, ISD::SETUGT, ISD::SETUGE})
 127       setCondCodeAction(CC, T, Expand);
 128     // Expand floating-point library function operators.
 129     for (auto Op : {ISD::FSIN, ISD::FCOS, ISD::FSINCOS, ISD::FPOWI, ISD::FPOW})
 130       setOperationAction(Op, T, Expand);
 131     // Note supported floating-point library function operators that otherwise
 132     // default to expand.
 133     for (auto Op : {ISD::FCEIL, ISD::FFLOOR, ISD::FTRUNC, ISD::FNEARBYINT,
 134                     ISD::FRINT})
 135       setOperationAction(Op, T, Legal);
 136     // Support minnan and maxnan, which otherwise default to expand.
 137     setOperationAction(ISD::FMINNAN, T, Legal);
 138     setOperationAction(ISD::FMAXNAN, T, Legal);
 139   }
 140
 141   for (auto T : {MVT::i32, MVT::i64}) {
 142     // Expand unavailable integer operations.
 143     for (auto Op : {ISD::BSWAP, ISD::ROTL, ISD::ROTR,
 144                     ISD::SMUL_LOHI, ISD::UMUL_LOHI,
 145                     ISD::MULHS, ISD::MULHU, ISD::SDIVREM, ISD::UDIVREM,
 146                     ISD::SHL_PARTS, ISD::SRA_PARTS, ISD::SRL_PARTS,
 147                     ISD::ADDC, ISD::ADDE, ISD::SUBC, ISD::SUBE}) {
 148       setOperationAction(Op, T, Expand);
 149     }
 150   }
 151
 152   // As a special case, these operators use the type to mean the type to
 153   // sign-extend from.
 154   for (auto T : {MVT::i1, MVT::i8, MVT::i16})
 155     setOperationAction(ISD::SIGN_EXTEND_INREG, T, Expand);
 156
 157   // Dynamic stack allocation: use the default expansion.
 158   setOperationAction(ISD::STACKSAVE, MVT::Other, Expand);
 159   setOperationAction(ISD::STACKRESTORE, MVT::Other, Expand);
 160   setOperationAction(ISD::DYNAMIC_STACKALLOC, MVTPtr, Expand);
 161
 162   // Expand these forms; we pattern-match the forms that we can handle in isel.
 163   for (auto T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64})
 164     for (auto Op : {ISD::BR_CC, ISD::SELECT_CC})
 165       setOperationAction(Op, T, Expand);
 166
 167   // We have custom switch handling.
 168   setOperationAction(ISD::BR_JT, MVT::Other, Custom);
 169
 170   // WebAssembly doesn't have:
 171   //  - Floating-point extending loads.
 172   //  - Floating-point truncating stores.
 173   //  - i1 extending loads.
 174   setLoadExtAction(ISD::EXTLOAD, MVT::f32, MVT::f64, Expand);
 175   setTruncStoreAction(MVT::f64, MVT::f32, Expand);
 176   for (auto T : MVT::integer_valuetypes())
 177     for (auto Ext : {ISD::EXTLOAD, ISD::ZEXTLOAD, ISD::SEXTLOAD})
 178       setLoadExtAction(Ext, T, MVT::i1, Promote);
 179
 180   // Trap lowers to wasm unreachable
 181   setOperationAction(ISD::TRAP, MVT::Other, Legal);
 182 }
 183
 184 FastISel *WebAssemblyTargetLowering::createFastISel(
 185     FunctionLoweringInfo &FuncInfo, const TargetLibraryInfo *LibInfo) const {
 186   return WebAssembly::createFastISel(FuncInfo, LibInfo);
 187 }
 188
 189 bool WebAssemblyTargetLowering::isOffsetFoldingLegal(
 190     const GlobalAddressSDNode *GA) const {
 191   // The WebAssembly target doesn't support folding offsets into global
 192   // addresses.
 193   return false;
 194 }
 195
 196 MVT WebAssemblyTargetLowering::getScalarShiftAmountTy(const DataLayout &DL,
 197                                                       EVT VT) const {
 198   return VT.getSimpleVT();
 199 }
 200
 201 const char *
 202 WebAssemblyTargetLowering::getTargetNodeName(unsigned Opcode) const {
 203   switch (static_cast<WebAssemblyISD::NodeType>(Opcode)) {
 204   case WebAssemblyISD::FIRST_NUMBER:
 205     break;
 206 #define HANDLE_NODETYPE(NODE)                                                  \
 207   case WebAssemblyISD::NODE:                                                   \
 208     return "WebAssemblyISD::" #NODE;
 209 #include "WebAssemblyISD.def"
 210 #undef HANDLE_NODETYPE
 211   }
 212   return nullptr;
 213 }
 214
 215 std::pair<unsigned, const TargetRegisterClass *>
 216 WebAssemblyTargetLowering::getRegForInlineAsmConstraint(
 217     const TargetRegisterInfo *TRI, StringRef Constraint, MVT VT) const {
 218   // First, see if this is a constraint that directly corresponds to a
 219   // WebAssembly register class.
 220   if (Constraint.size() == 1) {
 221     switch (Constraint[0]) {
 222     case 'r':
 223       return std::make_pair(0U, &WebAssembly::I32RegClass);
 224     default:
 225       break;
 226     }
 227   }
 228
 229   return TargetLowering::getRegForInlineAsmConstraint(TRI, Constraint, VT);
 230 }
 231
 232 bool WebAssemblyTargetLowering::isCheapToSpeculateCttz() const {
 233   // Assume ctz is a relatively cheap operation.
 234   return true;
 235 }
 236
 237 bool WebAssemblyTargetLowering::isCheapToSpeculateCtlz() const {
 238   // Assume clz is a relatively cheap operation.
 239   return true;
 240 }
 241
 242 //===----------------------------------------------------------------------===//
 243 // WebAssembly Lowering private implementation.
 244 //===----------------------------------------------------------------------===//
 245
 246 //===----------------------------------------------------------------------===//
 247 // Lowering Code
 248 //===----------------------------------------------------------------------===//
 249
 250 static void fail(SDLoc DL, SelectionDAG &DAG, const char *msg) {
 251   MachineFunction &MF = DAG.getMachineFunction();
 252   DAG.getContext()->diagnose(
 253       DiagnosticInfoUnsupported(DL, *MF.getFunction(), msg, SDValue()));
 254 }
 255
 256 SDValue
 257 WebAssemblyTargetLowering::LowerCall(CallLoweringInfo &CLI,
 258                                      SmallVectorImpl<SDValue> &InVals) const {
 259   SelectionDAG &DAG = CLI.DAG;
 260   SDLoc DL = CLI.DL;
 261   SDValue Chain = CLI.Chain;
 262   SDValue Callee = CLI.Callee;
 263   MachineFunction &MF = DAG.getMachineFunction();
 264
 265   CallingConv::ID CallConv = CLI.CallConv;
 266   if (CallConv != CallingConv::C &&
 267       CallConv != CallingConv::Fast &&
 268       CallConv != CallingConv::Cold)
 269     fail(DL, DAG,
 270          "WebAssembly doesn't support language-specific or target-specific "
 271          "calling conventions yet");
 272   if (CLI.IsPatchPoint)
 273     fail(DL, DAG, "WebAssembly doesn't support patch point yet");
 274
 275   // WebAssembly doesn't currently support explicit tail calls. If they are
 276   // required, fail. Otherwise, just disable them.
 277   if ((CallConv == CallingConv::Fast && CLI.IsTailCall &&
 278        MF.getTarget().Options.GuaranteedTailCallOpt) ||
 279       (CLI.CS && CLI.CS->isMustTailCall()))
 280     fail(DL, DAG, "WebAssembly doesn't support tail call yet");
 281   CLI.IsTailCall = false;
 282
 283   SmallVectorImpl<SDValue> &OutVals = CLI.OutVals;
 284
 285   SmallVectorImpl<ISD::InputArg> &Ins = CLI.Ins;
 286   if (Ins.size() > 1)
 287     fail(DL, DAG, "WebAssembly doesn't support more than 1 returned value yet");
 288
 289   bool IsVarArg = CLI.IsVarArg;
 290   if (IsVarArg)
 291     fail(DL, DAG, "WebAssembly doesn't support varargs yet");
 292
 293   // Analyze operands of the call, assigning locations to each operand.
 294   SmallVector<CCValAssign, 16> ArgLocs;
 295   CCState CCInfo(CallConv, IsVarArg, MF, ArgLocs, *DAG.getContext());
 296   unsigned NumBytes = CCInfo.getNextStackOffset();
 297
 298   auto PtrVT = getPointerTy(MF.getDataLayout());
 299   auto Zero = DAG.getConstant(0, DL, PtrVT, true);
 300   auto NB = DAG.getConstant(NumBytes, DL, PtrVT, true);
 301   Chain = DAG.getCALLSEQ_START(Chain, NB, DL);
 302
 303   SmallVector<SDValue, 16> Ops;
 304   Ops.push_back(Chain);
 305   Ops.push_back(Callee);
 306   Ops.append(OutVals.begin(), OutVals.end());
 307
 308   SmallVector<EVT, 8> Tys;
 309   for (const auto &In : Ins)
 310     Tys.push_back(In.VT);
 311   Tys.push_back(MVT::Other);
 312   SDVTList TyList = DAG.getVTList(Tys);
 313   SDValue Res =
 314       DAG.getNode(Ins.empty() ? WebAssemblyISD::CALL0 : WebAssemblyISD::CALL1,
 315                   DL, TyList, Ops);
 316   if (Ins.empty()) {
 317     Chain = Res;
 318   } else {
 319     InVals.push_back(Res);
 320     Chain = Res.getValue(1);
 321   }
 322
 323   Chain = DAG.getCALLSEQ_END(Chain, NB, Zero, SDValue(), DL);
 324
 325   return Chain;
 326 }
 327
 328 bool WebAssemblyTargetLowering::CanLowerReturn(
 329     CallingConv::ID CallConv, MachineFunction &MF, bool IsVarArg,
 330     const SmallVectorImpl<ISD::OutputArg> &Outs, LLVMContext &Context) const {
 331   // WebAssembly can't currently handle returning tuples.
 332   return Outs.size() <= 1;
 333 }
 334
 335 SDValue WebAssemblyTargetLowering::LowerReturn(
 336     SDValue Chain, CallingConv::ID CallConv, bool IsVarArg,
 337     const SmallVectorImpl<ISD::OutputArg> &Outs,
 338     const SmallVectorImpl<SDValue> &OutVals, SDLoc DL,
 339     SelectionDAG &DAG) const {
 340   assert(Outs.size() <= 1 && "WebAssembly can only return up to one value");
 341   if (CallConv != CallingConv::C)
 342     fail(DL, DAG, "WebAssembly doesn't support non-C calling conventions");
 343   if (IsVarArg)
 344     fail(DL, DAG, "WebAssembly doesn't support varargs yet");
 345
 346   SmallVector<SDValue, 4> RetOps(1, Chain);
 347   RetOps.append(OutVals.begin(), OutVals.end());
 348   Chain = DAG.getNode(WebAssemblyISD::RETURN, DL, MVT::Other, RetOps);
 349
 350   // Record the number and types of the return values.
 351   for (const ISD::OutputArg &Out : Outs) {
 352     if (Out.Flags.isByVal())
 353       fail(DL, DAG, "WebAssembly hasn't implemented byval results");
 354     if (Out.Flags.isInAlloca())
 355       fail(DL, DAG, "WebAssembly hasn't implemented inalloca results");
 356     if (Out.Flags.isNest())
 357       fail(DL, DAG, "WebAssembly hasn't implemented nest results");
 358     if (Out.Flags.isInConsecutiveRegs())
 359       fail(DL, DAG, "WebAssembly hasn't implemented cons regs results");
 360     if (Out.Flags.isInConsecutiveRegsLast())
 361       fail(DL, DAG, "WebAssembly hasn't implemented cons regs last results");
 362     if (!Out.IsFixed)
 363       fail(DL, DAG, "WebAssembly doesn't support non-fixed results yet");
 364   }
 365
 366   return Chain;
 367 }
 368
 369 SDValue WebAssemblyTargetLowering::LowerFormalArguments(
 370     SDValue Chain, CallingConv::ID CallConv, bool IsVarArg,
 371     const SmallVectorImpl<ISD::InputArg> &Ins, SDLoc DL, SelectionDAG &DAG,
 372     SmallVectorImpl<SDValue> &InVals) const {
 373   MachineFunction &MF = DAG.getMachineFunction();
 374
 375   if (CallConv != CallingConv::C)
 376     fail(DL, DAG, "WebAssembly doesn't support non-C calling conventions");
 377   if (IsVarArg)
 378     fail(DL, DAG, "WebAssembly doesn't support varargs yet");
 379
 380   for (const ISD::InputArg &In : Ins) {
 381     if (In.Flags.isByVal())
 382       fail(DL, DAG, "WebAssembly hasn't implemented byval arguments");
 383     if (In.Flags.isInAlloca())
 384       fail(DL, DAG, "WebAssembly hasn't implemented inalloca arguments");
 385     if (In.Flags.isNest())
 386       fail(DL, DAG, "WebAssembly hasn't implemented nest arguments");
 387     if (In.Flags.isInConsecutiveRegs())
 388       fail(DL, DAG, "WebAssembly hasn't implemented cons regs arguments");
 389     if (In.Flags.isInConsecutiveRegsLast())
 390       fail(DL, DAG, "WebAssembly hasn't implemented cons regs last arguments");
 391     // Ignore In.getOrigAlign() because all our arguments are passed in
 392     // registers.
 393     InVals.push_back(
 394         In.Used
 395             ? DAG.getNode(WebAssemblyISD::ARGUMENT, DL, In.VT,
 396                           DAG.getTargetConstant(InVals.size(), DL, MVT::i32))
 397             : DAG.getNode(ISD::UNDEF, DL, In.VT));
 398
 399     // Record the number and types of arguments.
 400     MF.getInfo<WebAssemblyFunctionInfo>()->addParam(In.VT);
 401   }
 402
 403   return Chain;
 404 }
 405
 406 //===----------------------------------------------------------------------===//
 407 //  Custom lowering hooks.
 408 //===----------------------------------------------------------------------===//
 409
 410 SDValue WebAssemblyTargetLowering::LowerOperation(SDValue Op,
 411                                                   SelectionDAG &DAG) const {
 412   switch (Op.getOpcode()) {
 413   default:
 414     llvm_unreachable("unimplemented operation lowering");
 415     return SDValue();
 416   case ISD::GlobalAddress:
 417     return LowerGlobalAddress(Op, DAG);
 418   case ISD::ExternalSymbol:
 419     return LowerExternalSymbol(Op, DAG);
 420   case ISD::JumpTable:
 421     return LowerJumpTable(Op, DAG);
 422   case ISD::BR_JT:
 423     return LowerBR_JT(Op, DAG);
 424   }
 425 }
 426
 427 SDValue WebAssemblyTargetLowering::LowerGlobalAddress(SDValue Op,
 428                                                       SelectionDAG &DAG) const {
 429   SDLoc DL(Op);
 430   const auto *GA = cast<GlobalAddressSDNode>(Op);
 431   EVT VT = Op.getValueType();
 432   assert(GA->getOffset() == 0 &&
 433          "offsets on global addresses are forbidden by isOffsetFoldingLegal");
 434   assert(GA->getTargetFlags() == 0 && "WebAssembly doesn't set target flags");
 435   if (GA->getAddressSpace() != 0)
 436     fail(DL, DAG, "WebAssembly only expects the 0 address space");
 437   return DAG.getNode(WebAssemblyISD::Wrapper, DL, VT,
 438                      DAG.getTargetGlobalAddress(GA->getGlobal(), DL, VT));
 439 }
 440
 441 SDValue WebAssemblyTargetLowering::LowerExternalSymbol(SDValue Op,
 442                                                        SelectionDAG &DAG) const {
 443   SDLoc DL(Op);
 444   const auto *ES = cast<ExternalSymbolSDNode>(Op);
 445   EVT VT = Op.getValueType();
 446   assert(ES->getTargetFlags() == 0 && "WebAssembly doesn't set target flags");
 447   return DAG.getNode(WebAssemblyISD::Wrapper, DL, VT,
 448                      DAG.getTargetExternalSymbol(ES->getSymbol(), VT));
 449 }
 450
 451 SDValue WebAssemblyTargetLowering::LowerJumpTable(SDValue Op,
 452                                                   SelectionDAG &DAG) const {
 453   // There's no need for a Wrapper node because we always incorporate a jump
 454   // table operand into a TABLESWITCH instruction, rather than ever
 455   // materializing it in a register.
 456   const JumpTableSDNode *JT = cast<JumpTableSDNode>(Op);
 457   return DAG.getTargetJumpTable(JT->getIndex(), Op.getValueType(),
 458                                 JT->getTargetFlags());
 459 }
 460
 461 SDValue WebAssemblyTargetLowering::LowerBR_JT(SDValue Op,
 462                                               SelectionDAG &DAG) const {
 463   SDLoc DL(Op);
 464   SDValue Chain = Op.getOperand(0);
 465   const auto *JT = cast<JumpTableSDNode>(Op.getOperand(1));
 466   SDValue Index = Op.getOperand(2);
 467   assert(JT->getTargetFlags() == 0 && "WebAssembly doesn't set target flags");
 468
 469   SmallVector<SDValue, 8> Ops;
 470   Ops.push_back(Chain);
 471   Ops.push_back(Index);
 472
 473   MachineJumpTableInfo *MJTI = DAG.getMachineFunction().getJumpTableInfo();
 474   const auto &MBBs = MJTI->getJumpTables()[JT->getIndex()].MBBs;
 475
 476   // TODO: For now, we just pick something arbitrary for a default case for now.
 477   // We really want to sniff out the guard and put in the real default case (and
 478   // delete the guard).
 479   Ops.push_back(DAG.getBasicBlock(MBBs[0]));
 480
 481   // Add an operand for each case.
 482   for (auto MBB : MBBs)
 483     Ops.push_back(DAG.getBasicBlock(MBB));
 484
 485   return DAG.getNode(WebAssemblyISD::TABLESWITCH, DL, MVT::Other, Ops);
 486 }
 487
 488 //===----------------------------------------------------------------------===//
 489 //                          WebAssembly Optimization Hooks
 490 //===----------------------------------------------------------------------===//
 491
 492 MCSection *WebAssemblyTargetObjectFile::SelectSectionForGlobal(
 493     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 494     const TargetMachine &TM) const {
 495   // TODO: Be more sophisticated than this.
 496   return isa<Function>(GV) ? getTextSection() : getDataSection();
 497 }