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
  36 using namespace llvm;
  37
  38 #define DEBUG_TYPE "wasm-lower"
  39
  40 namespace {
  41 // Diagnostic information for unimplemented or unsupported feature reporting.
  42 // FIXME copied from BPF and AMDGPU.
  43 class DiagnosticInfoUnsupported : 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::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 //===----------------------------------------------------------------------===//
 215 // WebAssembly Lowering private implementation.
 216 //===----------------------------------------------------------------------===//
 217
 218 //===----------------------------------------------------------------------===//
 219 // Lowering Code
 220 //===----------------------------------------------------------------------===//
 221
 222 static void fail(SDLoc DL, SelectionDAG &DAG, const char *msg) {
 223   MachineFunction &MF = DAG.getMachineFunction();
 224   DAG.getContext()->diagnose(
 225       DiagnosticInfoUnsupported(DL, *MF.getFunction(), msg, SDValue()));
 226 }
 227
 228 SDValue
 229 WebAssemblyTargetLowering::LowerCall(CallLoweringInfo &CLI,
 230                                      SmallVectorImpl<SDValue> &InVals) const {
 231   SelectionDAG &DAG = CLI.DAG;
 232   SDLoc DL = CLI.DL;
 233   SDValue Chain = CLI.Chain;
 234   SDValue Callee = CLI.Callee;
 235   MachineFunction &MF = DAG.getMachineFunction();
 236
 237   CallingConv::ID CallConv = CLI.CallConv;
 238   if (CallConv != CallingConv::C &&
 239       CallConv != CallingConv::Fast &&
 240       CallConv != CallingConv::Cold)
 241     fail(DL, DAG,
 242          "WebAssembly doesn't support language-specific or target-specific "
 243          "calling conventions yet");
 244   if (CLI.IsPatchPoint)
 245     fail(DL, DAG, "WebAssembly doesn't support patch point yet");
 246
 247   // WebAssembly doesn't currently support explicit tail calls. If they are
 248   // required, fail. Otherwise, just disable them.
 249   if ((CallConv == CallingConv::Fast && CLI.IsTailCall &&
 250        MF.getTarget().Options.GuaranteedTailCallOpt) ||
 251       (CLI.CS && CLI.CS->isMustTailCall()))
 252     fail(DL, DAG, "WebAssembly doesn't support tail call yet");
 253   CLI.IsTailCall = false;
 254
 255   SmallVectorImpl<ISD::OutputArg> &Outs = CLI.Outs;
 256   SmallVectorImpl<SDValue> &OutVals = CLI.OutVals;
 257
 258   bool IsStructRet = (Outs.empty()) ? false : Outs[0].Flags.isSRet();
 259   if (IsStructRet)
 260     fail(DL, DAG, "WebAssembly doesn't support struct return yet");
 261
 262   SmallVectorImpl<ISD::InputArg> &Ins = CLI.Ins;
 263   if (Ins.size() > 1)
 264     fail(DL, DAG, "WebAssembly doesn't support more than 1 returned value yet");
 265
 266   bool IsVarArg = CLI.IsVarArg;
 267   if (IsVarArg)
 268     fail(DL, DAG, "WebAssembly doesn't support varargs yet");
 269
 270   // Analyze operands of the call, assigning locations to each operand.
 271   SmallVector<CCValAssign, 16> ArgLocs;
 272   CCState CCInfo(CallConv, IsVarArg, MF, ArgLocs, *DAG.getContext());
 273   unsigned NumBytes = CCInfo.getNextStackOffset();
 274
 275   auto PtrVT = getPointerTy(MF.getDataLayout());
 276   auto Zero = DAG.getConstant(0, DL, PtrVT, true);
 277   auto NB = DAG.getConstant(NumBytes, DL, PtrVT, true);
 278   Chain = DAG.getCALLSEQ_START(Chain, NB, DL);
 279
 280   SmallVector<SDValue, 16> Ops;
 281   Ops.push_back(Chain);
 282   Ops.push_back(Callee);
 283   Ops.append(OutVals.begin(), OutVals.end());
 284
 285   SmallVector<EVT, 8> Tys;
 286   for (const auto &In : Ins)
 287     Tys.push_back(In.VT);
 288   Tys.push_back(MVT::Other);
 289   SDVTList TyList = DAG.getVTList(Tys);
 290   SDValue Res =
 291       DAG.getNode(Ins.empty() ? WebAssemblyISD::CALL0 : WebAssemblyISD::CALL1,
 292                   DL, TyList, Ops);
 293   if (Ins.empty()) {
 294     Chain = Res;
 295   } else {
 296     InVals.push_back(Res);
 297     Chain = Res.getValue(1);
 298   }
 299
 300   // FIXME: handle CLI.RetSExt and CLI.RetZExt?
 301
 302   Chain = DAG.getCALLSEQ_END(Chain, NB, Zero, SDValue(), DL);
 303
 304   return Chain;
 305 }
 306
 307 bool WebAssemblyTargetLowering::CanLowerReturn(
 308     CallingConv::ID CallConv, MachineFunction &MF, bool IsVarArg,
 309     const SmallVectorImpl<ISD::OutputArg> &Outs, LLVMContext &Context) const {
 310   // WebAssembly can't currently handle returning tuples.
 311   return Outs.size() <= 1;
 312 }
 313
 314 SDValue WebAssemblyTargetLowering::LowerReturn(
 315     SDValue Chain, CallingConv::ID CallConv, bool IsVarArg,
 316     const SmallVectorImpl<ISD::OutputArg> &Outs,
 317     const SmallVectorImpl<SDValue> &OutVals, SDLoc DL,
 318     SelectionDAG &DAG) const {
 319
 320   assert(Outs.size() <= 1 && "WebAssembly can only return up to one value");
 321   if (CallConv != CallingConv::C)
 322     fail(DL, DAG, "WebAssembly doesn't support non-C calling conventions");
 323   if (IsVarArg)
 324     fail(DL, DAG, "WebAssembly doesn't support varargs yet");
 325
 326   SmallVector<SDValue, 4> RetOps(1, Chain);
 327   RetOps.append(OutVals.begin(), OutVals.end());
 328   Chain = DAG.getNode(WebAssemblyISD::RETURN, DL, MVT::Other, RetOps);
 329
 330   return Chain;
 331 }
 332
 333 SDValue WebAssemblyTargetLowering::LowerFormalArguments(
 334     SDValue Chain, CallingConv::ID CallConv, bool IsVarArg,
 335     const SmallVectorImpl<ISD::InputArg> &Ins, SDLoc DL, SelectionDAG &DAG,
 336     SmallVectorImpl<SDValue> &InVals) const {
 337   MachineFunction &MF = DAG.getMachineFunction();
 338
 339   if (CallConv != CallingConv::C)
 340     fail(DL, DAG, "WebAssembly doesn't support non-C calling conventions");
 341   if (IsVarArg)
 342     fail(DL, DAG, "WebAssembly doesn't support varargs yet");
 343   if (MF.getFunction()->hasStructRetAttr())
 344     fail(DL, DAG, "WebAssembly doesn't support struct return yet");
 345
 346   unsigned ArgNo = 0;
 347   for (const ISD::InputArg &In : Ins) {
 348     if (In.Flags.isZExt())
 349       fail(DL, DAG, "WebAssembly hasn't implemented zext arguments");
 350     if (In.Flags.isSExt())
 351       fail(DL, DAG, "WebAssembly hasn't implemented sext arguments");
 352     if (In.Flags.isInReg())
 353       fail(DL, DAG, "WebAssembly hasn't implemented inreg arguments");
 354     if (In.Flags.isSRet())
 355       fail(DL, DAG, "WebAssembly hasn't implemented sret arguments");
 356     if (In.Flags.isByVal())
 357       fail(DL, DAG, "WebAssembly hasn't implemented byval arguments");
 358     if (In.Flags.isInAlloca())
 359       fail(DL, DAG, "WebAssembly hasn't implemented inalloca arguments");
 360     if (In.Flags.isNest())
 361       fail(DL, DAG, "WebAssembly hasn't implemented nest arguments");
 362     if (In.Flags.isReturned())
 363       fail(DL, DAG, "WebAssembly hasn't implemented returned arguments");
 364     if (In.Flags.isInConsecutiveRegs())
 365       fail(DL, DAG, "WebAssembly hasn't implemented cons regs arguments");
 366     if (In.Flags.isInConsecutiveRegsLast())
 367       fail(DL, DAG, "WebAssembly hasn't implemented cons regs last arguments");
 368     if (In.Flags.isSplit())
 369       fail(DL, DAG, "WebAssembly hasn't implemented split arguments");
 370     // FIXME Do something with In.getOrigAlign()?
 371     InVals.push_back(
 372         In.Used
 373             ? DAG.getNode(WebAssemblyISD::ARGUMENT, DL, In.VT,
 374                           DAG.getTargetConstant(ArgNo, DL, MVT::i32))
 375             : DAG.getNode(ISD::UNDEF, DL, In.VT));
 376     ++ArgNo;
 377   }
 378
 379   // Record the number of arguments, since argument indices and local variable
 380   // indices are in the same index space.
 381   MF.getInfo<WebAssemblyFunctionInfo>()->setNumArguments(ArgNo);
 382
 383   return Chain;
 384 }
 385
 386 //===----------------------------------------------------------------------===//
 387 //  Custom lowering hooks.
 388 //===----------------------------------------------------------------------===//
 389
 390 SDValue WebAssemblyTargetLowering::LowerOperation(SDValue Op,
 391                                                   SelectionDAG &DAG) const {
 392   switch (Op.getOpcode()) {
 393   default:
 394     llvm_unreachable("unimplemented operation lowering");
 395     return SDValue();
 396   case ISD::GlobalAddress:
 397     return LowerGlobalAddress(Op, DAG);
 398   case ISD::JumpTable:
 399     return LowerJumpTable(Op, DAG);
 400   case ISD::BR_JT:
 401     return LowerBR_JT(Op, DAG);
 402   }
 403 }
 404
 405 SDValue WebAssemblyTargetLowering::LowerGlobalAddress(SDValue Op,
 406                                                       SelectionDAG &DAG) const {
 407   SDLoc DL(Op);
 408   const auto *GA = cast<GlobalAddressSDNode>(Op);
 409   EVT VT = Op.getValueType();
 410   assert(GA->getOffset() == 0 &&
 411          "offsets on global addresses are forbidden by isOffsetFoldingLegal");
 412   assert(GA->getTargetFlags() == 0 && "WebAssembly doesn't set target flags");
 413   if (GA->getAddressSpace() != 0)
 414     fail(DL, DAG, "WebAssembly only expects the 0 address space");
 415   return DAG.getNode(WebAssemblyISD::Wrapper, DL, VT,
 416                      DAG.getTargetGlobalAddress(GA->getGlobal(), DL, VT));
 417 }
 418
 419 SDValue WebAssemblyTargetLowering::LowerJumpTable(SDValue Op,
 420                                                   SelectionDAG &DAG) const {
 421   // There's no need for a Wrapper node because we always incorporate a jump
 422   // table operand into a SWITCH instruction, rather than ever materializing
 423   // it in a register.
 424   const JumpTableSDNode *JT = cast<JumpTableSDNode>(Op);
 425   return DAG.getTargetJumpTable(JT->getIndex(), Op.getValueType(),
 426                                 JT->getTargetFlags());
 427 }
 428
 429 SDValue WebAssemblyTargetLowering::LowerBR_JT(SDValue Op,
 430                                               SelectionDAG &DAG) const {
 431   SDLoc DL(Op);
 432   SDValue Chain = Op.getOperand(0);
 433   const auto *JT = cast<JumpTableSDNode>(Op.getOperand(1));
 434   SDValue Index = Op.getOperand(2);
 435   assert(JT->getTargetFlags() == 0 && "WebAssembly doesn't set target flags");
 436
 437   SmallVector<SDValue, 8> Ops;
 438   Ops.push_back(Chain);
 439   Ops.push_back(Index);
 440
 441   MachineJumpTableInfo *MJTI = DAG.getMachineFunction().getJumpTableInfo();
 442   const auto &MBBs = MJTI->getJumpTables()[JT->getIndex()].MBBs;
 443
 444   // TODO: For now, we just pick something arbitrary for a default case for now.
 445   // We really want to sniff out the guard and put in the real default case (and
 446   // delete the guard).
 447   Ops.push_back(DAG.getBasicBlock(MBBs[0]));
 448
 449   // Add an operand for each case.
 450   for (auto MBB : MBBs)
 451     Ops.push_back(DAG.getBasicBlock(MBB));
 452
 453   return DAG.getNode(WebAssemblyISD::SWITCH, DL, MVT::Other, Ops);
 454 }
 455
 456 //===----------------------------------------------------------------------===//
 457 //                          WebAssembly Optimization Hooks
 458 //===----------------------------------------------------------------------===//
 459
 460 MCSection *WebAssemblyTargetObjectFile::SelectSectionForGlobal(
 461     const GlobalValue *GV, SectionKind Kind, Mangler &Mang,
 462     const TargetMachine &TM) const {
 463   // TODO: Be more sophisticated than this.
 464   return isa<Function>(GV) ? getTextSection() : getDataSection();
 465 }