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