lib/Target/WebAssembly/WebAssemblyCFGStackify.cpp

   1 //===-- WebAssemblyCFGStackify.cpp - CFG Stackification -------------------===//
   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 a CFG stacking pass.
  12 ///
  13 /// This pass reorders the blocks in a function to put them into a reverse
  14 /// post-order [0], with special care to keep the order as similar as possible
  15 /// to the original order, and to keep loops contiguous even in the case of
  16 /// split backedges.
  17 ///
  18 /// Then, it inserts BLOCK and LOOP markers to mark the start of scopes, since
  19 /// scope boundaries serve as the labels for WebAssembly's control transfers.
  20 ///
  21 /// This is sufficient to convert arbitrary CFGs into a form that works on
  22 /// WebAssembly, provided that all loops are single-entry.
  23 ///
  24 /// [0] https://en.wikipedia.org/wiki/Depth-first_search#Vertex_orderings
  25 ///
  26 //===----------------------------------------------------------------------===//
  27
  28 #include "WebAssembly.h"
  29 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
  30 #include "WebAssemblySubtarget.h"
  31 #include "llvm/ADT/SCCIterator.h"
  32 #include "llvm/ADT/SetVector.h"
  33 #include "llvm/CodeGen/MachineDominators.h"
  34 #include "llvm/CodeGen/MachineFunction.h"
  35 #include "llvm/CodeGen/MachineInstrBuilder.h"
  36 #include "llvm/CodeGen/MachineLoopInfo.h"
  37 #include "llvm/CodeGen/Passes.h"
  38 #include "llvm/Support/Debug.h"
  39 #include "llvm/Support/raw_ostream.h"
  40 using namespace llvm;
  41
  42 #define DEBUG_TYPE "wasm-cfg-stackify"
  43
  44 namespace {
  45 class WebAssemblyCFGStackify final : public MachineFunctionPass {
  46   const char *getPassName() const override {
  47     return "WebAssembly CFG Stackify";
  48   }
  49
  50   void getAnalysisUsage(AnalysisUsage &AU) const override {
  51     AU.setPreservesCFG();
  52     AU.addRequired<MachineDominatorTree>();
  53     AU.addPreserved<MachineDominatorTree>();
  54     AU.addRequired<MachineLoopInfo>();
  55     AU.addPreserved<MachineLoopInfo>();
  56     MachineFunctionPass::getAnalysisUsage(AU);
  57   }
  58
  59   bool runOnMachineFunction(MachineFunction &MF) override;
  60
  61 public:
  62   static char ID; // Pass identification, replacement for typeid
  63   WebAssemblyCFGStackify() : MachineFunctionPass(ID) {}
  64 };
  65 } // end anonymous namespace
  66
  67 char WebAssemblyCFGStackify::ID = 0;
  68 FunctionPass *llvm::createWebAssemblyCFGStackify() {
  69   return new WebAssemblyCFGStackify();
  70 }
  71
  72 static void EliminateMultipleEntryLoops(MachineFunction &MF,
  73                                         const MachineLoopInfo &MLI) {
  74   SmallPtrSet<MachineBasicBlock *, 8> InSet;
  75   for (scc_iterator<MachineFunction *> I = scc_begin(&MF), E = scc_end(&MF);
  76        I != E; ++I) {
  77     const std::vector<MachineBasicBlock *> &CurrentSCC = *I;
  78
  79     // Skip trivial SCCs.
  80     if (CurrentSCC.size() == 1)
  81       continue;
  82
  83     InSet.insert(CurrentSCC.begin(), CurrentSCC.end());
  84     MachineBasicBlock *Header = nullptr;
  85     for (MachineBasicBlock *MBB : CurrentSCC) {
  86       for (MachineBasicBlock *Pred : MBB->predecessors()) {
  87         if (InSet.count(Pred))
  88           continue;
  89         if (!Header) {
  90           Header = MBB;
  91           break;
  92         }
  93         // TODO: Implement multiple-entry loops.
  94         report_fatal_error("multiple-entry loops are not supported yet");
  95       }
  96     }
  97     assert(MLI.isLoopHeader(Header));
  98
  99     InSet.clear();
 100   }
 101 }
 102
 103 namespace {
 104 /// Post-order traversal stack entry.
 105 struct POStackEntry {
 106   MachineBasicBlock *MBB;
 107   SmallVector<MachineBasicBlock *, 0> Succs;
 108
 109   POStackEntry(MachineBasicBlock *MBB, MachineFunction &MF,
 110                const MachineLoopInfo &MLI);
 111 };
 112 } // end anonymous namespace
 113
 114 static bool LoopContains(const MachineLoop *Loop,
 115                          const MachineBasicBlock *MBB) {
 116   return Loop ? Loop->contains(MBB) : true;
 117 }
 118
 119 POStackEntry::POStackEntry(MachineBasicBlock *MBB, MachineFunction &MF,
 120                            const MachineLoopInfo &MLI)
 121     : MBB(MBB), Succs(MBB->successors()) {
 122   // RPO is not a unique form, since at every basic block with multiple
 123   // successors, the DFS has to pick which order to visit the successors in.
 124   // Sort them strategically (see below).
 125   MachineLoop *Loop = MLI.getLoopFor(MBB);
 126   MachineFunction::iterator Next = next(MachineFunction::iterator(MBB));
 127   MachineBasicBlock *LayoutSucc = Next == MF.end() ? nullptr : &*Next;
 128   std::stable_sort(
 129       Succs.begin(), Succs.end(),
 130       [=, &MLI](const MachineBasicBlock *A, const MachineBasicBlock *B) {
 131         if (A == B)
 132           return false;
 133
 134         // Keep loops contiguous by preferring the block that's in the same
 135         // loop.
 136         bool LoopContainsA = LoopContains(Loop, A);
 137         bool LoopContainsB = LoopContains(Loop, B);
 138         if (LoopContainsA && !LoopContainsB)
 139           return true;
 140         if (!LoopContainsA && LoopContainsB)
 141           return false;
 142
 143         // Minimize perturbation by preferring the block which is the immediate
 144         // layout successor.
 145         if (A == LayoutSucc)
 146           return true;
 147         if (B == LayoutSucc)
 148           return false;
 149
 150         // TODO: More sophisticated orderings may be profitable here.
 151
 152         return false;
 153       });
 154 }
 155
 156 /// Return the "bottom" block of a loop. This differs from
 157 /// MachineLoop::getBottomBlock in that it works even if the loop is
 158 /// discontiguous.
 159 static MachineBasicBlock *LoopBottom(const MachineLoop *Loop) {
 160   MachineBasicBlock *Bottom = Loop->getHeader();
 161   for (MachineBasicBlock *MBB : Loop->blocks())
 162     if (MBB->getNumber() > Bottom->getNumber())
 163       Bottom = MBB;
 164   return Bottom;
 165 }
 166
 167 /// Sort the blocks in RPO, taking special care to make sure that loops are
 168 /// contiguous even in the case of split backedges.
 169 ///
 170 /// TODO: Determine whether RPO is actually worthwhile, or whether we should
 171 /// move to just a stable-topological-sort-based approach that would preserve
 172 /// more of the original order.
 173 static void SortBlocks(MachineFunction &MF, const MachineLoopInfo &MLI) {
 174   // Note that we do our own RPO rather than using
 175   // "llvm/ADT/PostOrderIterator.h" because we want control over the order that
 176   // successors are visited in (see above). Also, we can sort the blocks in the
 177   // MachineFunction as we go.
 178   SmallPtrSet<MachineBasicBlock *, 16> Visited;
 179   SmallVector<POStackEntry, 16> Stack;
 180
 181   MachineBasicBlock *EntryBlock = &*MF.begin();
 182   Visited.insert(EntryBlock);
 183   Stack.push_back(POStackEntry(EntryBlock, MF, MLI));
 184
 185   for (;;) {
 186     POStackEntry &Entry = Stack.back();
 187     SmallVectorImpl<MachineBasicBlock *> &Succs = Entry.Succs;
 188     if (!Succs.empty()) {
 189       MachineBasicBlock *Succ = Succs.pop_back_val();
 190       if (Visited.insert(Succ).second)
 191         Stack.push_back(POStackEntry(Succ, MF, MLI));
 192       continue;
 193     }
 194
 195     // Put the block in its position in the MachineFunction.
 196     MachineBasicBlock &MBB = *Entry.MBB;
 197     MBB.moveBefore(&*MF.begin());
 198
 199     // Branch instructions may utilize a fallthrough, so update them if a
 200     // fallthrough has been added or removed.
 201     if (!MBB.empty() && MBB.back().isTerminator() && !MBB.back().isBranch() &&
 202         !MBB.back().isBarrier())
 203       report_fatal_error(
 204           "Non-branch terminator with fallthrough cannot yet be rewritten");
 205     if (MBB.empty() || !MBB.back().isTerminator() || MBB.back().isBranch())
 206       MBB.updateTerminator();
 207
 208     Stack.pop_back();
 209     if (Stack.empty())
 210       break;
 211   }
 212
 213   // Now that we've sorted the blocks in RPO, renumber them.
 214   MF.RenumberBlocks();
 215
 216 #ifndef NDEBUG
 217   SmallSetVector<MachineLoop *, 8> OnStack;
 218
 219   // Insert a sentinel representing the degenerate loop that starts at the
 220   // function entry block and includes the entire function as a "loop" that
 221   // executes once.
 222   OnStack.insert(nullptr);
 223
 224   for (auto &MBB : MF) {
 225     assert(MBB.getNumber() >= 0 && "Renumbered blocks should be non-negative.");
 226
 227     MachineLoop *Loop = MLI.getLoopFor(&MBB);
 228     if (Loop && &MBB == Loop->getHeader()) {
 229       // Loop header. The loop predecessor should be sorted above, and the other
 230       // predecessors should be backedges below.
 231       for (auto Pred : MBB.predecessors())
 232         assert(
 233             (Pred->getNumber() < MBB.getNumber() || Loop->contains(Pred)) &&
 234             "Loop header predecessors must be loop predecessors or backedges");
 235       assert(OnStack.insert(Loop) && "Loops should be declared at most once.");
 236     } else {
 237       // Not a loop header. All predecessors should be sorted above.
 238       for (auto Pred : MBB.predecessors())
 239         assert(Pred->getNumber() < MBB.getNumber() &&
 240                "Non-loop-header predecessors should be topologically sorted");
 241       assert(OnStack.count(MLI.getLoopFor(&MBB)) &&
 242              "Blocks must be nested in their loops");
 243     }
 244     while (OnStack.size() > 1 && &MBB == LoopBottom(OnStack.back()))
 245       OnStack.pop_back();
 246   }
 247   assert(OnStack.pop_back_val() == nullptr &&
 248          "The function entry block shouldn't actually be a loop header");
 249   assert(OnStack.empty() &&
 250          "Control flow stack pushes and pops should be balanced.");
 251 #endif
 252 }
 253
 254 /// Test whether Pred has any terminators explicitly branching to MBB, as
 255 /// opposed to falling through. Note that it's possible (eg. in unoptimized
 256 /// code) for a branch instruction to both branch to a block and fallthrough
 257 /// to it, so we check the actual branch operands to see if there are any
 258 /// explicit mentions.
 259 static bool ExplicitlyBranchesTo(MachineBasicBlock *Pred, MachineBasicBlock *MBB) {
 260   for (MachineInstr &MI : Pred->terminators())
 261     for (MachineOperand &MO : MI.explicit_operands())
 262       if (MO.isMBB() && MO.getMBB() == MBB)
 263         return true;
 264   return false;
 265 }
 266
 267 /// Insert a BLOCK marker for branches to MBB (if needed).
 268 static void PlaceBlockMarker(MachineBasicBlock &MBB, MachineFunction &MF,
 269                              SmallVectorImpl<MachineBasicBlock *> &ScopeTops,
 270                              const WebAssemblyInstrInfo &TII,
 271                              const MachineLoopInfo &MLI,
 272                              MachineDominatorTree &MDT) {
 273   // First compute the nearest common dominator of all forward non-fallthrough
 274   // predecessors so that we minimize the time that the BLOCK is on the stack,
 275   // which reduces overall stack height.
 276   MachineBasicBlock *Header = nullptr;
 277   bool IsBranchedTo = false;
 278   int MBBNumber = MBB.getNumber();
 279   for (MachineBasicBlock *Pred : MBB.predecessors())
 280     if (Pred->getNumber() < MBBNumber) {
 281       Header = Header ? MDT.findNearestCommonDominator(Header, Pred) : Pred;
 282       if (ExplicitlyBranchesTo(Pred, &MBB))
 283         IsBranchedTo = true;
 284     }
 285   if (!Header)
 286     return;
 287   if (!IsBranchedTo)
 288     return;
 289
 290   assert(&MBB != &MF.front() && "Header blocks shouldn't have predecessors");
 291   MachineBasicBlock *LayoutPred = &*prev(MachineFunction::iterator(&MBB));
 292
 293   // If the nearest common dominator is inside a more deeply nested context,
 294   // walk out to the nearest scope which isn't more deeply nested.
 295   for (MachineFunction::iterator I(LayoutPred), E(Header); I != E; --I) {
 296     if (MachineBasicBlock *ScopeTop = ScopeTops[I->getNumber()]) {
 297       if (ScopeTop->getNumber() > Header->getNumber()) {
 298         // Skip over an intervening scope.
 299         I = next(MachineFunction::iterator(ScopeTop));
 300       } else {
 301         // We found a scope level at an appropriate depth.
 302         Header = ScopeTop;
 303         break;
 304       }
 305     }
 306   }
 307
 308   // If there's a loop which ends just before MBB which contains Header, we can
 309   // reuse its label instead of inserting a new BLOCK.
 310   for (MachineLoop *Loop = MLI.getLoopFor(LayoutPred);
 311        Loop && Loop->contains(LayoutPred); Loop = Loop->getParentLoop())
 312     if (Loop && LoopBottom(Loop) == LayoutPred && Loop->contains(Header))
 313       return;
 314
 315   // Decide where in Header to put the BLOCK.
 316   MachineBasicBlock::iterator InsertPos;
 317   MachineLoop *HeaderLoop = MLI.getLoopFor(Header);
 318   if (HeaderLoop && MBB.getNumber() > LoopBottom(HeaderLoop)->getNumber()) {
 319     // Header is the header of a loop that does not lexically contain MBB, so
 320     // the BLOCK needs to be above the LOOP.
 321     InsertPos = Header->begin();
 322   } else {
 323     // Otherwise, insert the BLOCK as late in Header as we can, but before the
 324     // beginning of the local expression tree and any nested BLOCKs.
 325     InsertPos = Header->getFirstTerminator();
 326     while (InsertPos != Header->begin() &&
 327            prev(InsertPos)->definesRegister(WebAssembly::EXPR_STACK) &&
 328            prev(InsertPos)->getOpcode() != WebAssembly::LOOP)
 329       --InsertPos;
 330   }
 331
 332   // Add the BLOCK.
 333   BuildMI(*Header, InsertPos, DebugLoc(), TII.get(WebAssembly::BLOCK))
 334       .addMBB(&MBB);
 335
 336   // Track the farthest-spanning scope that ends at this point.
 337   int Number = MBB.getNumber();
 338   if (!ScopeTops[Number] ||
 339       ScopeTops[Number]->getNumber() > Header->getNumber())
 340     ScopeTops[Number] = Header;
 341 }
 342
 343 /// Insert a LOOP marker for a loop starting at MBB (if it's a loop header).
 344 static void PlaceLoopMarker(MachineBasicBlock &MBB, MachineFunction &MF,
 345                             SmallVectorImpl<MachineBasicBlock *> &ScopeTops,
 346                             const WebAssemblyInstrInfo &TII,
 347                             const MachineLoopInfo &MLI) {
 348   MachineLoop *Loop = MLI.getLoopFor(&MBB);
 349   if (!Loop || Loop->getHeader() != &MBB)
 350     return;
 351
 352   // The operand of a LOOP is the first block after the loop. If the loop is the
 353   // bottom of the function, insert a dummy block at the end.
 354   MachineBasicBlock *Bottom = LoopBottom(Loop);
 355   auto Iter = next(MachineFunction::iterator(Bottom));
 356   if (Iter == MF.end()) {
 357     MachineBasicBlock *Label = MF.CreateMachineBasicBlock();
 358     // Give it a fake predecessor so that AsmPrinter prints its label.
 359     Label->addSuccessor(Label);
 360     MF.push_back(Label);
 361     Iter = next(MachineFunction::iterator(Bottom));
 362   }
 363   MachineBasicBlock *AfterLoop = &*Iter;
 364   BuildMI(MBB, MBB.begin(), DebugLoc(), TII.get(WebAssembly::LOOP))
 365       .addMBB(AfterLoop);
 366
 367   // Emit a special no-op telling the asm printer that we need a label to close
 368   // the loop scope, even though the destination is only reachable by
 369   // fallthrough.
 370   if (!Bottom->back().isBarrier())
 371     BuildMI(*Bottom, Bottom->end(), DebugLoc(), TII.get(WebAssembly::LOOP_END));
 372
 373   assert((!ScopeTops[AfterLoop->getNumber()] ||
 374           ScopeTops[AfterLoop->getNumber()]->getNumber() < MBB.getNumber()) &&
 375          "With RPO we should visit the outer-most loop for a block first.");
 376   if (!ScopeTops[AfterLoop->getNumber()])
 377     ScopeTops[AfterLoop->getNumber()] = &MBB;
 378 }
 379
 380 /// Insert LOOP and BLOCK markers at appropriate places.
 381 static void PlaceMarkers(MachineFunction &MF, const MachineLoopInfo &MLI,
 382                          const WebAssemblyInstrInfo &TII,
 383                          MachineDominatorTree &MDT) {
 384   // For each block whose label represents the end of a scope, record the block
 385   // which holds the beginning of the scope. This will allow us to quickly skip
 386   // over scoped regions when walking blocks. We allocate one more than the
 387   // number of blocks in the function to accommodate for the possible fake block
 388   // we may insert at the end.
 389   SmallVector<MachineBasicBlock *, 8> ScopeTops(MF.getNumBlockIDs() + 1);
 390
 391   for (auto &MBB : MF) {
 392     // Place the LOOP for MBB if MBB is the header of a loop.
 393     PlaceLoopMarker(MBB, MF, ScopeTops, TII, MLI);
 394
 395     // Place the BLOCK for MBB if MBB is branched to from above.
 396     PlaceBlockMarker(MBB, MF, ScopeTops, TII, MLI, MDT);
 397   }
 398 }
 399
 400 #ifndef NDEBUG
 401 static bool
 402 IsOnStack(const SmallVectorImpl<std::pair<MachineBasicBlock *, bool>> &Stack,
 403           const MachineBasicBlock *MBB) {
 404   for (const auto &Pair : Stack)
 405     if (Pair.first == MBB)
 406       return true;
 407   return false;
 408 }
 409 #endif
 410
 411 bool WebAssemblyCFGStackify::runOnMachineFunction(MachineFunction &MF) {
 412   DEBUG(dbgs() << "********** CFG Stackifying **********\n"
 413                   "********** Function: "
 414                << MF.getName() << '\n');
 415
 416   const auto &MLI = getAnalysis<MachineLoopInfo>();
 417   auto &MDT = getAnalysis<MachineDominatorTree>();
 418   const auto &TII = *MF.getSubtarget<WebAssemblySubtarget>().getInstrInfo();
 419
 420   // RPO sorting needs all loops to be single-entry.
 421   EliminateMultipleEntryLoops(MF, MLI);
 422
 423   // Sort the blocks in RPO, with contiguous loops.
 424   SortBlocks(MF, MLI);
 425
 426   // Place the BLOCK and LOOP markers to indicate the beginnings of scopes.
 427   PlaceMarkers(MF, MLI, TII, MDT);
 428
 429 #ifndef NDEBUG
 430   // Verify that block and loop beginnings and endings are in LIFO order, and
 431   // that all references to blocks are to blocks on the stack at the point of
 432   // the reference.
 433   SmallVector<std::pair<MachineBasicBlock *, bool>, 0> Stack;
 434   for (auto &MBB : MF) {
 435     while (!Stack.empty() && Stack.back().first == &MBB)
 436       if (Stack.back().second) {
 437         assert(Stack.size() >= 2);
 438         Stack.pop_back();
 439         Stack.pop_back();
 440       } else {
 441         assert(Stack.size() >= 1);
 442         Stack.pop_back();
 443       }
 444     for (auto &MI : MBB)
 445       switch (MI.getOpcode()) {
 446       case WebAssembly::LOOP:
 447         Stack.push_back(std::make_pair(&MBB, false));
 448         Stack.push_back(std::make_pair(MI.getOperand(0).getMBB(), true));
 449         break;
 450       case WebAssembly::BLOCK:
 451         Stack.push_back(std::make_pair(MI.getOperand(0).getMBB(), false));
 452         break;
 453       default:
 454         // Verify that all referenced blocks are in scope. A reference to a
 455         // block with a negative number is invalid, but can happen with inline
 456         // asm, so we shouldn't assert on it, but instead let CodeGen properly
 457         // fail on it.
 458         for (const MachineOperand &MO : MI.explicit_operands())
 459           if (MO.isMBB() && MO.getMBB()->getNumber() >= 0)
 460             assert(IsOnStack(Stack, MO.getMBB()));
 461         break;
 462       }
 463   }
 464   assert(Stack.empty());
 465 #endif
 466
 467   return true;
 468 }