xref: /llvm-project/llvm/lib/Target/WebAssembly/WebAssemblyTargetMachine.cpp (revision 5a7b79c93e2e0c71aec016973f5f13d3bb2e7a62)
1 //===- WebAssemblyTargetMachine.cpp - Define TargetMachine for WebAssembly -==//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// This file defines the WebAssembly-specific subclass of TargetMachine.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #include "WebAssemblyTargetMachine.h"
15 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
16 #include "TargetInfo/WebAssemblyTargetInfo.h"
17 #include "WebAssembly.h"
18 #include "WebAssemblyISelLowering.h"
19 #include "WebAssemblyMachineFunctionInfo.h"
20 #include "WebAssemblyTargetObjectFile.h"
21 #include "WebAssemblyTargetTransformInfo.h"
22 #include "WebAssemblyUtilities.h"
23 #include "llvm/CodeGen/MIRParser/MIParser.h"
24 #include "llvm/CodeGen/MachineFunctionPass.h"
25 #include "llvm/CodeGen/Passes.h"
26 #include "llvm/CodeGen/RegAllocRegistry.h"
27 #include "llvm/CodeGen/TargetPassConfig.h"
28 #include "llvm/IR/Function.h"
29 #include "llvm/InitializePasses.h"
30 #include "llvm/MC/MCAsmInfo.h"
31 #include "llvm/MC/TargetRegistry.h"
32 #include "llvm/Target/TargetOptions.h"
33 #include "llvm/Transforms/Scalar.h"
34 #include "llvm/Transforms/Scalar/LowerAtomicPass.h"
35 #include "llvm/Transforms/Utils.h"
36 #include <optional>
37 using namespace llvm;
38 
39 #define DEBUG_TYPE "wasm"
40 
41 // A command-line option to keep implicit locals
42 // for the purpose of testing with lit/llc ONLY.
43 // This produces output which is not valid WebAssembly, and is not supported
44 // by assemblers/disassemblers and other MC based tools.
45 static cl::opt<bool> WasmDisableExplicitLocals(
46     "wasm-disable-explicit-locals", cl::Hidden,
47     cl::desc("WebAssembly: output implicit locals in"
48              " instruction output for test purposes only."),
49     cl::init(false));
50 
51 static cl::opt<bool> WasmDisableFixIrreducibleControlFlowPass(
52     "wasm-disable-fix-irreducible-control-flow-pass", cl::Hidden,
53     cl::desc("webassembly: disables the fix "
54              " irreducible control flow optimization pass"),
55     cl::init(false));
56 
57 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeWebAssemblyTarget() {
58   // Register the target.
59   RegisterTargetMachine<WebAssemblyTargetMachine> X(
60       getTheWebAssemblyTarget32());
61   RegisterTargetMachine<WebAssemblyTargetMachine> Y(
62       getTheWebAssemblyTarget64());
63 
64   // Register backend passes
65   auto &PR = *PassRegistry::getPassRegistry();
66   initializeWebAssemblyAddMissingPrototypesPass(PR);
67   initializeWebAssemblyLowerEmscriptenEHSjLjPass(PR);
68   initializeLowerGlobalDtorsLegacyPassPass(PR);
69   initializeFixFunctionBitcastsPass(PR);
70   initializeOptimizeReturnedPass(PR);
71   initializeWebAssemblyRefTypeMem2LocalPass(PR);
72   initializeWebAssemblyArgumentMovePass(PR);
73   initializeWebAssemblySetP2AlignOperandsPass(PR);
74   initializeWebAssemblyReplacePhysRegsPass(PR);
75   initializeWebAssemblyOptimizeLiveIntervalsPass(PR);
76   initializeWebAssemblyMemIntrinsicResultsPass(PR);
77   initializeWebAssemblyRegStackifyPass(PR);
78   initializeWebAssemblyRegColoringPass(PR);
79   initializeWebAssemblyNullifyDebugValueListsPass(PR);
80   initializeWebAssemblyFixIrreducibleControlFlowPass(PR);
81   initializeWebAssemblyLateEHPreparePass(PR);
82   initializeWebAssemblyExceptionInfoPass(PR);
83   initializeWebAssemblyCFGSortPass(PR);
84   initializeWebAssemblyCFGStackifyPass(PR);
85   initializeWebAssemblyExplicitLocalsPass(PR);
86   initializeWebAssemblyLowerBrUnlessPass(PR);
87   initializeWebAssemblyRegNumberingPass(PR);
88   initializeWebAssemblyDebugFixupPass(PR);
89   initializeWebAssemblyPeepholePass(PR);
90   initializeWebAssemblyMCLowerPrePassPass(PR);
91   initializeWebAssemblyLowerRefTypesIntPtrConvPass(PR);
92   initializeWebAssemblyFixBrTableDefaultsPass(PR);
93   initializeWebAssemblyDAGToDAGISelLegacyPass(PR);
94 }
95 
96 //===----------------------------------------------------------------------===//
97 // WebAssembly Lowering public interface.
98 //===----------------------------------------------------------------------===//
99 
100 static Reloc::Model getEffectiveRelocModel(std::optional<Reloc::Model> RM,
101                                            const Triple &TT) {
102   if (!RM) {
103     // Default to static relocation model.  This should always be more optimial
104     // than PIC since the static linker can determine all global addresses and
105     // assume direct function calls.
106     return Reloc::Static;
107   }
108 
109   return *RM;
110 }
111 
112 /// Create an WebAssembly architecture model.
113 ///
114 WebAssemblyTargetMachine::WebAssemblyTargetMachine(
115     const Target &T, const Triple &TT, StringRef CPU, StringRef FS,
116     const TargetOptions &Options, std::optional<Reloc::Model> RM,
117     std::optional<CodeModel::Model> CM, CodeGenOptLevel OL, bool JIT)
118     : LLVMTargetMachine(
119           T,
120           TT.isArch64Bit()
121               ? (TT.isOSEmscripten() ? "e-m:e-p:64:64-p10:8:8-p20:8:8-i64:64-"
122                                        "f128:64-n32:64-S128-ni:1:10:20"
123                                      : "e-m:e-p:64:64-p10:8:8-p20:8:8-i64:64-"
124                                        "n32:64-S128-ni:1:10:20")
125               : (TT.isOSEmscripten() ? "e-m:e-p:32:32-p10:8:8-p20:8:8-i64:64-"
126                                        "f128:64-n32:64-S128-ni:1:10:20"
127                                      : "e-m:e-p:32:32-p10:8:8-p20:8:8-i64:64-"
128                                        "n32:64-S128-ni:1:10:20"),
129           TT, CPU, FS, Options, getEffectiveRelocModel(RM, TT),
130           getEffectiveCodeModel(CM, CodeModel::Large), OL),
131       TLOF(new WebAssemblyTargetObjectFile()),
132       UsesMultivalueABI(Options.MCOptions.getABIName() == "experimental-mv") {
133   // WebAssembly type-checks instructions, but a noreturn function with a return
134   // type that doesn't match the context will cause a check failure. So we lower
135   // LLVM 'unreachable' to ISD::TRAP and then lower that to WebAssembly's
136   // 'unreachable' instructions which is meant for that case. Formerly, we also
137   // needed to add checks to SP failure emission in the instruction selection
138   // backends, but this has since been tied to TrapUnreachable and is no longer
139   // necessary.
140   this->Options.TrapUnreachable = true;
141   this->Options.NoTrapAfterNoreturn = false;
142 
143   // WebAssembly treats each function as an independent unit. Force
144   // -ffunction-sections, effectively, so that we can emit them independently.
145   this->Options.FunctionSections = true;
146   this->Options.DataSections = true;
147   this->Options.UniqueSectionNames = true;
148 
149   initAsmInfo();
150 
151   // Note that we don't use setRequiresStructuredCFG(true). It disables
152   // optimizations than we're ok with, and want, such as critical edge
153   // splitting and tail merging.
154 }
155 
156 WebAssemblyTargetMachine::~WebAssemblyTargetMachine() = default; // anchor.
157 
158 const WebAssemblySubtarget *WebAssemblyTargetMachine::getSubtargetImpl() const {
159   return getSubtargetImpl(std::string(getTargetCPU()),
160                           std::string(getTargetFeatureString()));
161 }
162 
163 const WebAssemblySubtarget *
164 WebAssemblyTargetMachine::getSubtargetImpl(std::string CPU,
165                                            std::string FS) const {
166   auto &I = SubtargetMap[CPU + FS];
167   if (!I) {
168     I = std::make_unique<WebAssemblySubtarget>(TargetTriple, CPU, FS, *this);
169   }
170   return I.get();
171 }
172 
173 const WebAssemblySubtarget *
174 WebAssemblyTargetMachine::getSubtargetImpl(const Function &F) const {
175   Attribute CPUAttr = F.getFnAttribute("target-cpu");
176   Attribute FSAttr = F.getFnAttribute("target-features");
177 
178   std::string CPU =
179       CPUAttr.isValid() ? CPUAttr.getValueAsString().str() : TargetCPU;
180   std::string FS =
181       FSAttr.isValid() ? FSAttr.getValueAsString().str() : TargetFS;
182 
183   // This needs to be done before we create a new subtarget since any
184   // creation will depend on the TM and the code generation flags on the
185   // function that reside in TargetOptions.
186   resetTargetOptions(F);
187 
188   return getSubtargetImpl(CPU, FS);
189 }
190 
191 namespace {
192 
193 class CoalesceFeaturesAndStripAtomics final : public ModulePass {
194   // Take the union of all features used in the module and use it for each
195   // function individually, since having multiple feature sets in one module
196   // currently does not make sense for WebAssembly. If atomics are not enabled,
197   // also strip atomic operations and thread local storage.
198   static char ID;
199   WebAssemblyTargetMachine *WasmTM;
200 
201 public:
202   CoalesceFeaturesAndStripAtomics(WebAssemblyTargetMachine *WasmTM)
203       : ModulePass(ID), WasmTM(WasmTM) {}
204 
205   bool runOnModule(Module &M) override {
206     FeatureBitset Features = coalesceFeatures(M);
207 
208     std::string FeatureStr = getFeatureString(Features);
209     WasmTM->setTargetFeatureString(FeatureStr);
210     for (auto &F : M)
211       replaceFeatures(F, FeatureStr);
212 
213     bool StrippedAtomics = false;
214     bool StrippedTLS = false;
215 
216     if (!Features[WebAssembly::FeatureAtomics]) {
217       StrippedAtomics = stripAtomics(M);
218       StrippedTLS = stripThreadLocals(M);
219     } else if (!Features[WebAssembly::FeatureBulkMemory]) {
220       StrippedTLS |= stripThreadLocals(M);
221     }
222 
223     if (StrippedAtomics && !StrippedTLS)
224       stripThreadLocals(M);
225     else if (StrippedTLS && !StrippedAtomics)
226       stripAtomics(M);
227 
228     recordFeatures(M, Features, StrippedAtomics || StrippedTLS);
229 
230     // Conservatively assume we have made some change
231     return true;
232   }
233 
234 private:
235   FeatureBitset coalesceFeatures(const Module &M) {
236     FeatureBitset Features =
237         WasmTM
238             ->getSubtargetImpl(std::string(WasmTM->getTargetCPU()),
239                                std::string(WasmTM->getTargetFeatureString()))
240             ->getFeatureBits();
241     for (auto &F : M)
242       Features |= WasmTM->getSubtargetImpl(F)->getFeatureBits();
243     return Features;
244   }
245 
246   static std::string getFeatureString(const FeatureBitset &Features) {
247     std::string Ret;
248     for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
249       if (Features[KV.Value])
250         Ret += (StringRef("+") + KV.Key + ",").str();
251       else
252         Ret += (StringRef("-") + KV.Key + ",").str();
253     }
254     return Ret;
255   }
256 
257   void replaceFeatures(Function &F, const std::string &Features) {
258     F.removeFnAttr("target-features");
259     F.removeFnAttr("target-cpu");
260     F.addFnAttr("target-features", Features);
261   }
262 
263   bool stripAtomics(Module &M) {
264     // Detect whether any atomics will be lowered, since there is no way to tell
265     // whether the LowerAtomic pass lowers e.g. stores.
266     bool Stripped = false;
267     for (auto &F : M) {
268       for (auto &B : F) {
269         for (auto &I : B) {
270           if (I.isAtomic()) {
271             Stripped = true;
272             goto done;
273           }
274         }
275       }
276     }
277 
278   done:
279     if (!Stripped)
280       return false;
281 
282     LowerAtomicPass Lowerer;
283     FunctionAnalysisManager FAM;
284     for (auto &F : M)
285       Lowerer.run(F, FAM);
286 
287     return true;
288   }
289 
290   bool stripThreadLocals(Module &M) {
291     bool Stripped = false;
292     for (auto &GV : M.globals()) {
293       if (GV.isThreadLocal()) {
294         // replace `@llvm.threadlocal.address.pX(GV)` with `GV`.
295         for (Use &U : make_early_inc_range(GV.uses())) {
296           if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(U.getUser())) {
297             if (II->getIntrinsicID() == Intrinsic::threadlocal_address &&
298                 II->getArgOperand(0) == &GV) {
299               II->replaceAllUsesWith(&GV);
300               II->eraseFromParent();
301             }
302           }
303         }
304 
305         Stripped = true;
306         GV.setThreadLocal(false);
307       }
308     }
309     return Stripped;
310   }
311 
312   void recordFeatures(Module &M, const FeatureBitset &Features, bool Stripped) {
313     for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
314       if (Features[KV.Value]) {
315         // Mark features as used
316         std::string MDKey = (StringRef("wasm-feature-") + KV.Key).str();
317         M.addModuleFlag(Module::ModFlagBehavior::Error, MDKey,
318                         wasm::WASM_FEATURE_PREFIX_USED);
319       }
320     }
321     // Code compiled without atomics or bulk-memory may have had its atomics or
322     // thread-local data lowered to nonatomic operations or non-thread-local
323     // data. In that case, we mark the pseudo-feature "shared-mem" as disallowed
324     // to tell the linker that it would be unsafe to allow this code ot be used
325     // in a module with shared memory.
326     if (Stripped) {
327       M.addModuleFlag(Module::ModFlagBehavior::Error, "wasm-feature-shared-mem",
328                       wasm::WASM_FEATURE_PREFIX_DISALLOWED);
329     }
330   }
331 };
332 char CoalesceFeaturesAndStripAtomics::ID = 0;
333 
334 /// WebAssembly Code Generator Pass Configuration Options.
335 class WebAssemblyPassConfig final : public TargetPassConfig {
336 public:
337   WebAssemblyPassConfig(WebAssemblyTargetMachine &TM, PassManagerBase &PM)
338       : TargetPassConfig(TM, PM) {}
339 
340   WebAssemblyTargetMachine &getWebAssemblyTargetMachine() const {
341     return getTM<WebAssemblyTargetMachine>();
342   }
343 
344   FunctionPass *createTargetRegisterAllocator(bool) override;
345 
346   void addIRPasses() override;
347   void addISelPrepare() override;
348   bool addInstSelector() override;
349   void addOptimizedRegAlloc() override;
350   void addPostRegAlloc() override;
351   bool addGCPasses() override { return false; }
352   void addPreEmitPass() override;
353   bool addPreISel() override;
354 
355   // No reg alloc
356   bool addRegAssignAndRewriteFast() override { return false; }
357 
358   // No reg alloc
359   bool addRegAssignAndRewriteOptimized() override { return false; }
360 };
361 } // end anonymous namespace
362 
363 MachineFunctionInfo *WebAssemblyTargetMachine::createMachineFunctionInfo(
364     BumpPtrAllocator &Allocator, const Function &F,
365     const TargetSubtargetInfo *STI) const {
366   return WebAssemblyFunctionInfo::create<WebAssemblyFunctionInfo>(Allocator, F,
367                                                                   STI);
368 }
369 
370 TargetTransformInfo
371 WebAssemblyTargetMachine::getTargetTransformInfo(const Function &F) const {
372   return TargetTransformInfo(WebAssemblyTTIImpl(this, F));
373 }
374 
375 TargetPassConfig *
376 WebAssemblyTargetMachine::createPassConfig(PassManagerBase &PM) {
377   return new WebAssemblyPassConfig(*this, PM);
378 }
379 
380 FunctionPass *WebAssemblyPassConfig::createTargetRegisterAllocator(bool) {
381   return nullptr; // No reg alloc
382 }
383 
384 using WebAssembly::WasmEnableEH;
385 using WebAssembly::WasmEnableEmEH;
386 using WebAssembly::WasmEnableEmSjLj;
387 using WebAssembly::WasmEnableExnref;
388 using WebAssembly::WasmEnableSjLj;
389 
390 static void basicCheckForEHAndSjLj(TargetMachine *TM) {
391 
392   // You can't enable two modes of EH at the same time
393   if (WasmEnableEmEH && WasmEnableEH)
394     report_fatal_error(
395         "-enable-emscripten-cxx-exceptions not allowed with -wasm-enable-eh");
396   // You can't enable two modes of SjLj at the same time
397   if (WasmEnableEmSjLj && WasmEnableSjLj)
398     report_fatal_error(
399         "-enable-emscripten-sjlj not allowed with -wasm-enable-sjlj");
400   // You can't mix Emscripten EH with Wasm SjLj.
401   if (WasmEnableEmEH && WasmEnableSjLj)
402     report_fatal_error(
403         "-enable-emscripten-cxx-exceptions not allowed with -wasm-enable-sjlj");
404   if (WasmEnableExnref && !WasmEnableEH)
405     report_fatal_error(
406         "-wasm-enable-exnref should be used with -wasm-enable-eh");
407 
408   // Here we make sure TargetOptions.ExceptionModel is the same as
409   // MCAsmInfo.ExceptionsType. Normally these have to be the same, because clang
410   // stores the exception model info in LangOptions, which is later transferred
411   // to TargetOptions and MCAsmInfo. But when clang compiles bitcode directly,
412   // clang's LangOptions is not used and thus the exception model info is not
413   // correctly transferred to TargetOptions and MCAsmInfo, so we make sure we
414   // have the correct exception model in WebAssemblyMCAsmInfo constructor. But
415   // in this case TargetOptions is still not updated, so we make sure they are
416   // the same.
417   TM->Options.ExceptionModel = TM->getMCAsmInfo()->getExceptionHandlingType();
418 
419   // Basic Correctness checking related to -exception-model
420   if (TM->Options.ExceptionModel != ExceptionHandling::None &&
421       TM->Options.ExceptionModel != ExceptionHandling::Wasm)
422     report_fatal_error("-exception-model should be either 'none' or 'wasm'");
423   if (WasmEnableEmEH && TM->Options.ExceptionModel == ExceptionHandling::Wasm)
424     report_fatal_error("-exception-model=wasm not allowed with "
425                        "-enable-emscripten-cxx-exceptions");
426   if (WasmEnableEH && TM->Options.ExceptionModel != ExceptionHandling::Wasm)
427     report_fatal_error(
428         "-wasm-enable-eh only allowed with -exception-model=wasm");
429   if (WasmEnableSjLj && TM->Options.ExceptionModel != ExceptionHandling::Wasm)
430     report_fatal_error(
431         "-wasm-enable-sjlj only allowed with -exception-model=wasm");
432   if ((!WasmEnableEH && !WasmEnableSjLj) &&
433       TM->Options.ExceptionModel == ExceptionHandling::Wasm)
434     report_fatal_error(
435         "-exception-model=wasm only allowed with at least one of "
436         "-wasm-enable-eh or -wasm-enable-sjlj");
437 
438   // Currently it is allowed to mix Wasm EH with Emscripten SjLj as an interim
439   // measure, but some code will error out at compile time in this combination.
440   // See WebAssemblyLowerEmscriptenEHSjLj pass for details.
441 }
442 
443 //===----------------------------------------------------------------------===//
444 // The following functions are called from lib/CodeGen/Passes.cpp to modify
445 // the CodeGen pass sequence.
446 //===----------------------------------------------------------------------===//
447 
448 void WebAssemblyPassConfig::addIRPasses() {
449   // Add signatures to prototype-less function declarations
450   addPass(createWebAssemblyAddMissingPrototypes());
451 
452   // Lower .llvm.global_dtors into .llvm.global_ctors with __cxa_atexit calls.
453   addPass(createLowerGlobalDtorsLegacyPass());
454 
455   // Fix function bitcasts, as WebAssembly requires caller and callee signatures
456   // to match.
457   addPass(createWebAssemblyFixFunctionBitcasts());
458 
459   // Optimize "returned" function attributes.
460   if (getOptLevel() != CodeGenOptLevel::None)
461     addPass(createWebAssemblyOptimizeReturned());
462 
463   basicCheckForEHAndSjLj(TM);
464 
465   // If exception handling is not enabled and setjmp/longjmp handling is
466   // enabled, we lower invokes into calls and delete unreachable landingpad
467   // blocks. Lowering invokes when there is no EH support is done in
468   // TargetPassConfig::addPassesToHandleExceptions, but that runs after these IR
469   // passes and Emscripten SjLj handling expects all invokes to be lowered
470   // before.
471   if (!WasmEnableEmEH && !WasmEnableEH) {
472     addPass(createLowerInvokePass());
473     // The lower invoke pass may create unreachable code. Remove it in order not
474     // to process dead blocks in setjmp/longjmp handling.
475     addPass(createUnreachableBlockEliminationPass());
476   }
477 
478   // Handle exceptions and setjmp/longjmp if enabled. Unlike Wasm EH preparation
479   // done in WasmEHPrepare pass, Wasm SjLj preparation shares libraries and
480   // transformation algorithms with Emscripten SjLj, so we run
481   // LowerEmscriptenEHSjLj pass also when Wasm SjLj is enabled.
482   if (WasmEnableEmEH || WasmEnableEmSjLj || WasmEnableSjLj)
483     addPass(createWebAssemblyLowerEmscriptenEHSjLj());
484 
485   // Expand indirectbr instructions to switches.
486   addPass(createIndirectBrExpandPass());
487 
488   TargetPassConfig::addIRPasses();
489 }
490 
491 void WebAssemblyPassConfig::addISelPrepare() {
492   // We need to move reference type allocas to WASM_ADDRESS_SPACE_VAR so that
493   // loads and stores are promoted to local.gets/local.sets.
494   addPass(createWebAssemblyRefTypeMem2Local());
495   // Lower atomics and TLS if necessary
496   addPass(new CoalesceFeaturesAndStripAtomics(&getWebAssemblyTargetMachine()));
497 
498   // This is a no-op if atomics are not used in the module
499   addPass(createAtomicExpandLegacyPass());
500 
501   TargetPassConfig::addISelPrepare();
502 }
503 
504 bool WebAssemblyPassConfig::addInstSelector() {
505   (void)TargetPassConfig::addInstSelector();
506   addPass(
507       createWebAssemblyISelDag(getWebAssemblyTargetMachine(), getOptLevel()));
508   // Run the argument-move pass immediately after the ScheduleDAG scheduler
509   // so that we can fix up the ARGUMENT instructions before anything else
510   // sees them in the wrong place.
511   addPass(createWebAssemblyArgumentMove());
512   // Set the p2align operands. This information is present during ISel, however
513   // it's inconvenient to collect. Collect it now, and update the immediate
514   // operands.
515   addPass(createWebAssemblySetP2AlignOperands());
516 
517   // Eliminate range checks and add default targets to br_table instructions.
518   addPass(createWebAssemblyFixBrTableDefaults());
519 
520   // unreachable is terminator, non-terminator instruction after it is not
521   // allowed.
522   addPass(createWebAssemblyCleanCodeAfterTrap());
523 
524   return false;
525 }
526 
527 void WebAssemblyPassConfig::addOptimizedRegAlloc() {
528   // Currently RegisterCoalesce degrades wasm debug info quality by a
529   // significant margin. As a quick fix, disable this for -O1, which is often
530   // used for debugging large applications. Disabling this increases code size
531   // of Emscripten core benchmarks by ~5%, which is acceptable for -O1, which is
532   // usually not used for production builds.
533   // TODO Investigate why RegisterCoalesce degrades debug info quality and fix
534   // it properly
535   if (getOptLevel() == CodeGenOptLevel::Less)
536     disablePass(&RegisterCoalescerID);
537   TargetPassConfig::addOptimizedRegAlloc();
538 }
539 
540 void WebAssemblyPassConfig::addPostRegAlloc() {
541   // TODO: The following CodeGen passes don't currently support code containing
542   // virtual registers. Consider removing their restrictions and re-enabling
543   // them.
544 
545   // These functions all require the NoVRegs property.
546   disablePass(&MachineLateInstrsCleanupID);
547   disablePass(&MachineCopyPropagationID);
548   disablePass(&PostRAMachineSinkingID);
549   disablePass(&PostRASchedulerID);
550   disablePass(&FuncletLayoutID);
551   disablePass(&StackMapLivenessID);
552   disablePass(&PatchableFunctionID);
553   disablePass(&ShrinkWrapID);
554   disablePass(&RemoveLoadsIntoFakeUsesID);
555 
556   // This pass hurts code size for wasm because it can generate irreducible
557   // control flow.
558   disablePass(&MachineBlockPlacementID);
559 
560   TargetPassConfig::addPostRegAlloc();
561 }
562 
563 void WebAssemblyPassConfig::addPreEmitPass() {
564   TargetPassConfig::addPreEmitPass();
565 
566   // Nullify DBG_VALUE_LISTs that we cannot handle.
567   addPass(createWebAssemblyNullifyDebugValueLists());
568 
569   // Eliminate multiple-entry loops.
570   if (!WasmDisableFixIrreducibleControlFlowPass)
571     addPass(createWebAssemblyFixIrreducibleControlFlow());
572 
573   // Do various transformations for exception handling.
574   // Every CFG-changing optimizations should come before this.
575   if (TM->Options.ExceptionModel == ExceptionHandling::Wasm)
576     addPass(createWebAssemblyLateEHPrepare());
577 
578   // Now that we have a prologue and epilogue and all frame indices are
579   // rewritten, eliminate SP and FP. This allows them to be stackified,
580   // colored, and numbered with the rest of the registers.
581   addPass(createWebAssemblyReplacePhysRegs());
582 
583   // Preparations and optimizations related to register stackification.
584   if (getOptLevel() != CodeGenOptLevel::None) {
585     // Depend on LiveIntervals and perform some optimizations on it.
586     addPass(createWebAssemblyOptimizeLiveIntervals());
587 
588     // Prepare memory intrinsic calls for register stackifying.
589     addPass(createWebAssemblyMemIntrinsicResults());
590 
591     // Mark registers as representing wasm's value stack. This is a key
592     // code-compression technique in WebAssembly. We run this pass (and
593     // MemIntrinsicResults above) very late, so that it sees as much code as
594     // possible, including code emitted by PEI and expanded by late tail
595     // duplication.
596     addPass(createWebAssemblyRegStackify());
597 
598     // Run the register coloring pass to reduce the total number of registers.
599     // This runs after stackification so that it doesn't consider registers
600     // that become stackified.
601     addPass(createWebAssemblyRegColoring());
602   }
603 
604   // Sort the blocks of the CFG into topological order, a prerequisite for
605   // BLOCK and LOOP markers.
606   addPass(createWebAssemblyCFGSort());
607 
608   // Insert BLOCK and LOOP markers.
609   addPass(createWebAssemblyCFGStackify());
610 
611   // Insert explicit local.get and local.set operators.
612   if (!WasmDisableExplicitLocals)
613     addPass(createWebAssemblyExplicitLocals());
614 
615   // Lower br_unless into br_if.
616   addPass(createWebAssemblyLowerBrUnless());
617 
618   // Perform the very last peephole optimizations on the code.
619   if (getOptLevel() != CodeGenOptLevel::None)
620     addPass(createWebAssemblyPeephole());
621 
622   // Create a mapping from LLVM CodeGen virtual registers to wasm registers.
623   addPass(createWebAssemblyRegNumbering());
624 
625   // Fix debug_values whose defs have been stackified.
626   if (!WasmDisableExplicitLocals)
627     addPass(createWebAssemblyDebugFixup());
628 
629   // Collect information to prepare for MC lowering / asm printing.
630   addPass(createWebAssemblyMCLowerPrePass());
631 }
632 
633 bool WebAssemblyPassConfig::addPreISel() {
634   TargetPassConfig::addPreISel();
635   addPass(createWebAssemblyLowerRefTypesIntPtrConv());
636   return false;
637 }
638 
639 yaml::MachineFunctionInfo *
640 WebAssemblyTargetMachine::createDefaultFuncInfoYAML() const {
641   return new yaml::WebAssemblyFunctionInfo();
642 }
643 
644 yaml::MachineFunctionInfo *WebAssemblyTargetMachine::convertFuncInfoToYAML(
645     const MachineFunction &MF) const {
646   const auto *MFI = MF.getInfo<WebAssemblyFunctionInfo>();
647   return new yaml::WebAssemblyFunctionInfo(MF, *MFI);
648 }
649 
650 bool WebAssemblyTargetMachine::parseMachineFunctionInfo(
651     const yaml::MachineFunctionInfo &MFI, PerFunctionMIParsingState &PFS,
652     SMDiagnostic &Error, SMRange &SourceRange) const {
653   const auto &YamlMFI = static_cast<const yaml::WebAssemblyFunctionInfo &>(MFI);
654   MachineFunction &MF = PFS.MF;
655   MF.getInfo<WebAssemblyFunctionInfo>()->initializeBaseYamlFields(MF, YamlMFI);
656   return false;
657 }
658