xref: /llvm-project/llvm/lib/Target/WebAssembly/WebAssemblyTargetMachine.cpp (revision 8506a63bf7cbe593c0707f995fbd0b8f820d0d62)
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   initializeWebAssemblyDAGToDAGISelPass(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   // WebAssembly type-checks instructions, but a noreturn function with a return
133   // type that doesn't match the context will cause a check failure. So we lower
134   // LLVM 'unreachable' to ISD::TRAP and then lower that to WebAssembly's
135   // 'unreachable' instructions which is meant for that case.
136   this->Options.TrapUnreachable = true;
137   this->Options.NoTrapAfterNoreturn = false;
138 
139   // WebAssembly treats each function as an independent unit. Force
140   // -ffunction-sections, effectively, so that we can emit them independently.
141   this->Options.FunctionSections = true;
142   this->Options.DataSections = true;
143   this->Options.UniqueSectionNames = true;
144 
145   initAsmInfo();
146 
147   // Note that we don't use setRequiresStructuredCFG(true). It disables
148   // optimizations than we're ok with, and want, such as critical edge
149   // splitting and tail merging.
150 }
151 
152 WebAssemblyTargetMachine::~WebAssemblyTargetMachine() = default; // anchor.
153 
154 const WebAssemblySubtarget *WebAssemblyTargetMachine::getSubtargetImpl() const {
155   return getSubtargetImpl(std::string(getTargetCPU()),
156                           std::string(getTargetFeatureString()));
157 }
158 
159 const WebAssemblySubtarget *
160 WebAssemblyTargetMachine::getSubtargetImpl(std::string CPU,
161                                            std::string FS) const {
162   auto &I = SubtargetMap[CPU + FS];
163   if (!I) {
164     I = std::make_unique<WebAssemblySubtarget>(TargetTriple, CPU, FS, *this);
165   }
166   return I.get();
167 }
168 
169 const WebAssemblySubtarget *
170 WebAssemblyTargetMachine::getSubtargetImpl(const Function &F) const {
171   Attribute CPUAttr = F.getFnAttribute("target-cpu");
172   Attribute FSAttr = F.getFnAttribute("target-features");
173 
174   std::string CPU =
175       CPUAttr.isValid() ? CPUAttr.getValueAsString().str() : TargetCPU;
176   std::string FS =
177       FSAttr.isValid() ? FSAttr.getValueAsString().str() : TargetFS;
178 
179   // This needs to be done before we create a new subtarget since any
180   // creation will depend on the TM and the code generation flags on the
181   // function that reside in TargetOptions.
182   resetTargetOptions(F);
183 
184   return getSubtargetImpl(CPU, FS);
185 }
186 
187 namespace {
188 
189 class CoalesceFeaturesAndStripAtomics final : public ModulePass {
190   // Take the union of all features used in the module and use it for each
191   // function individually, since having multiple feature sets in one module
192   // currently does not make sense for WebAssembly. If atomics are not enabled,
193   // also strip atomic operations and thread local storage.
194   static char ID;
195   WebAssemblyTargetMachine *WasmTM;
196 
197 public:
198   CoalesceFeaturesAndStripAtomics(WebAssemblyTargetMachine *WasmTM)
199       : ModulePass(ID), WasmTM(WasmTM) {}
200 
201   bool runOnModule(Module &M) override {
202     FeatureBitset Features = coalesceFeatures(M);
203 
204     std::string FeatureStr =
205         getFeatureString(Features, WasmTM->getTargetFeatureString());
206     WasmTM->setTargetFeatureString(FeatureStr);
207     for (auto &F : M)
208       replaceFeatures(F, FeatureStr);
209 
210     bool StrippedAtomics = false;
211     bool StrippedTLS = false;
212 
213     if (!Features[WebAssembly::FeatureAtomics]) {
214       StrippedAtomics = stripAtomics(M);
215       StrippedTLS = stripThreadLocals(M);
216     } else if (!Features[WebAssembly::FeatureBulkMemory]) {
217       StrippedTLS |= stripThreadLocals(M);
218     }
219 
220     if (StrippedAtomics && !StrippedTLS)
221       stripThreadLocals(M);
222     else if (StrippedTLS && !StrippedAtomics)
223       stripAtomics(M);
224 
225     recordFeatures(M, Features, StrippedAtomics || StrippedTLS);
226 
227     // Conservatively assume we have made some change
228     return true;
229   }
230 
231 private:
232   FeatureBitset coalesceFeatures(const Module &M) {
233     FeatureBitset Features =
234         WasmTM
235             ->getSubtargetImpl(std::string(WasmTM->getTargetCPU()),
236                                std::string(WasmTM->getTargetFeatureString()))
237             ->getFeatureBits();
238     for (auto &F : M)
239       Features |= WasmTM->getSubtargetImpl(F)->getFeatureBits();
240     return Features;
241   }
242 
243   static std::string getFeatureString(const FeatureBitset &Features,
244                                       StringRef TargetFS) {
245     std::string Ret;
246     for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
247       if (Features[KV.Value])
248         Ret += (StringRef("+") + KV.Key + ",").str();
249     }
250     SubtargetFeatures TF{TargetFS};
251     for (std::string const &F : TF.getFeatures())
252       if (!SubtargetFeatures::isEnabled(F))
253         Ret += F + ",";
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         Stripped = true;
295         GV.setThreadLocal(false);
296       }
297     }
298     return Stripped;
299   }
300 
301   void recordFeatures(Module &M, const FeatureBitset &Features, bool Stripped) {
302     for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
303       if (Features[KV.Value]) {
304         // Mark features as used
305         std::string MDKey = (StringRef("wasm-feature-") + KV.Key).str();
306         M.addModuleFlag(Module::ModFlagBehavior::Error, MDKey,
307                         wasm::WASM_FEATURE_PREFIX_USED);
308       }
309     }
310     // Code compiled without atomics or bulk-memory may have had its atomics or
311     // thread-local data lowered to nonatomic operations or non-thread-local
312     // data. In that case, we mark the pseudo-feature "shared-mem" as disallowed
313     // to tell the linker that it would be unsafe to allow this code ot be used
314     // in a module with shared memory.
315     if (Stripped) {
316       M.addModuleFlag(Module::ModFlagBehavior::Error, "wasm-feature-shared-mem",
317                       wasm::WASM_FEATURE_PREFIX_DISALLOWED);
318     }
319   }
320 };
321 char CoalesceFeaturesAndStripAtomics::ID = 0;
322 
323 /// WebAssembly Code Generator Pass Configuration Options.
324 class WebAssemblyPassConfig final : public TargetPassConfig {
325 public:
326   WebAssemblyPassConfig(WebAssemblyTargetMachine &TM, PassManagerBase &PM)
327       : TargetPassConfig(TM, PM) {}
328 
329   WebAssemblyTargetMachine &getWebAssemblyTargetMachine() const {
330     return getTM<WebAssemblyTargetMachine>();
331   }
332 
333   FunctionPass *createTargetRegisterAllocator(bool) override;
334 
335   void addIRPasses() override;
336   void addISelPrepare() override;
337   bool addInstSelector() override;
338   void addOptimizedRegAlloc() override;
339   void addPostRegAlloc() override;
340   bool addGCPasses() override { return false; }
341   void addPreEmitPass() override;
342   bool addPreISel() override;
343 
344   // No reg alloc
345   bool addRegAssignAndRewriteFast() override { return false; }
346 
347   // No reg alloc
348   bool addRegAssignAndRewriteOptimized() override { return false; }
349 };
350 } // end anonymous namespace
351 
352 MachineFunctionInfo *WebAssemblyTargetMachine::createMachineFunctionInfo(
353     BumpPtrAllocator &Allocator, const Function &F,
354     const TargetSubtargetInfo *STI) const {
355   return WebAssemblyFunctionInfo::create<WebAssemblyFunctionInfo>(Allocator, F,
356                                                                   STI);
357 }
358 
359 TargetTransformInfo
360 WebAssemblyTargetMachine::getTargetTransformInfo(const Function &F) const {
361   return TargetTransformInfo(WebAssemblyTTIImpl(this, F));
362 }
363 
364 TargetPassConfig *
365 WebAssemblyTargetMachine::createPassConfig(PassManagerBase &PM) {
366   return new WebAssemblyPassConfig(*this, PM);
367 }
368 
369 FunctionPass *WebAssemblyPassConfig::createTargetRegisterAllocator(bool) {
370   return nullptr; // No reg alloc
371 }
372 
373 using WebAssembly::WasmEnableEH;
374 using WebAssembly::WasmEnableEmEH;
375 using WebAssembly::WasmEnableEmSjLj;
376 using WebAssembly::WasmEnableSjLj;
377 
378 static void basicCheckForEHAndSjLj(TargetMachine *TM) {
379   // Before checking, we make sure TargetOptions.ExceptionModel is the same as
380   // MCAsmInfo.ExceptionsType. Normally these have to be the same, because clang
381   // stores the exception model info in LangOptions, which is later transferred
382   // to TargetOptions and MCAsmInfo. But when clang compiles bitcode directly,
383   // clang's LangOptions is not used and thus the exception model info is not
384   // correctly transferred to TargetOptions and MCAsmInfo, so we make sure we
385   // have the correct exception model in WebAssemblyMCAsmInfo constructor.
386   // But in this case TargetOptions is still not updated, so we make sure they
387   // are the same.
388   TM->Options.ExceptionModel = TM->getMCAsmInfo()->getExceptionHandlingType();
389 
390   // Basic Correctness checking related to -exception-model
391   if (TM->Options.ExceptionModel != ExceptionHandling::None &&
392       TM->Options.ExceptionModel != ExceptionHandling::Wasm)
393     report_fatal_error("-exception-model should be either 'none' or 'wasm'");
394   if (WasmEnableEmEH && TM->Options.ExceptionModel == ExceptionHandling::Wasm)
395     report_fatal_error("-exception-model=wasm not allowed with "
396                        "-enable-emscripten-cxx-exceptions");
397   if (WasmEnableEH && TM->Options.ExceptionModel != ExceptionHandling::Wasm)
398     report_fatal_error(
399         "-wasm-enable-eh only allowed with -exception-model=wasm");
400   if (WasmEnableSjLj && TM->Options.ExceptionModel != ExceptionHandling::Wasm)
401     report_fatal_error(
402         "-wasm-enable-sjlj only allowed with -exception-model=wasm");
403   if ((!WasmEnableEH && !WasmEnableSjLj) &&
404       TM->Options.ExceptionModel == ExceptionHandling::Wasm)
405     report_fatal_error(
406         "-exception-model=wasm only allowed with at least one of "
407         "-wasm-enable-eh or -wasm-enable-sjlj");
408 
409   // You can't enable two modes of EH at the same time
410   if (WasmEnableEmEH && WasmEnableEH)
411     report_fatal_error(
412         "-enable-emscripten-cxx-exceptions not allowed with -wasm-enable-eh");
413   // You can't enable two modes of SjLj at the same time
414   if (WasmEnableEmSjLj && WasmEnableSjLj)
415     report_fatal_error(
416         "-enable-emscripten-sjlj not allowed with -wasm-enable-sjlj");
417   // You can't mix Emscripten EH with Wasm SjLj.
418   if (WasmEnableEmEH && WasmEnableSjLj)
419     report_fatal_error(
420         "-enable-emscripten-cxx-exceptions not allowed with -wasm-enable-sjlj");
421   // Currently it is allowed to mix Wasm EH with Emscripten SjLj as an interim
422   // measure, but some code will error out at compile time in this combination.
423   // See WebAssemblyLowerEmscriptenEHSjLj pass for details.
424 }
425 
426 //===----------------------------------------------------------------------===//
427 // The following functions are called from lib/CodeGen/Passes.cpp to modify
428 // the CodeGen pass sequence.
429 //===----------------------------------------------------------------------===//
430 
431 void WebAssemblyPassConfig::addIRPasses() {
432   // Add signatures to prototype-less function declarations
433   addPass(createWebAssemblyAddMissingPrototypes());
434 
435   // Lower .llvm.global_dtors into .llvm.global_ctors with __cxa_atexit calls.
436   addPass(createLowerGlobalDtorsLegacyPass());
437 
438   // Fix function bitcasts, as WebAssembly requires caller and callee signatures
439   // to match.
440   addPass(createWebAssemblyFixFunctionBitcasts());
441 
442   // Optimize "returned" function attributes.
443   if (getOptLevel() != CodeGenOptLevel::None)
444     addPass(createWebAssemblyOptimizeReturned());
445 
446   basicCheckForEHAndSjLj(TM);
447 
448   // If exception handling is not enabled and setjmp/longjmp handling is
449   // enabled, we lower invokes into calls and delete unreachable landingpad
450   // blocks. Lowering invokes when there is no EH support is done in
451   // TargetPassConfig::addPassesToHandleExceptions, but that runs after these IR
452   // passes and Emscripten SjLj handling expects all invokes to be lowered
453   // before.
454   if (!WasmEnableEmEH && !WasmEnableEH) {
455     addPass(createLowerInvokePass());
456     // The lower invoke pass may create unreachable code. Remove it in order not
457     // to process dead blocks in setjmp/longjmp handling.
458     addPass(createUnreachableBlockEliminationPass());
459   }
460 
461   // Handle exceptions and setjmp/longjmp if enabled. Unlike Wasm EH preparation
462   // done in WasmEHPrepare pass, Wasm SjLj preparation shares libraries and
463   // transformation algorithms with Emscripten SjLj, so we run
464   // LowerEmscriptenEHSjLj pass also when Wasm SjLj is enabled.
465   if (WasmEnableEmEH || WasmEnableEmSjLj || WasmEnableSjLj)
466     addPass(createWebAssemblyLowerEmscriptenEHSjLj());
467 
468   // Expand indirectbr instructions to switches.
469   addPass(createIndirectBrExpandPass());
470 
471   TargetPassConfig::addIRPasses();
472 }
473 
474 void WebAssemblyPassConfig::addISelPrepare() {
475   WebAssemblyTargetMachine *WasmTM =
476       static_cast<WebAssemblyTargetMachine *>(TM);
477   const WebAssemblySubtarget *Subtarget =
478       WasmTM->getSubtargetImpl(std::string(WasmTM->getTargetCPU()),
479                                std::string(WasmTM->getTargetFeatureString()));
480   if (Subtarget->hasReferenceTypes()) {
481     // We need to remove allocas for reference types
482     addPass(createPromoteMemoryToRegisterPass(true));
483   }
484   // Lower atomics and TLS if necessary
485   addPass(new CoalesceFeaturesAndStripAtomics(&getWebAssemblyTargetMachine()));
486 
487   // This is a no-op if atomics are not used in the module
488   addPass(createAtomicExpandLegacyPass());
489 
490   TargetPassConfig::addISelPrepare();
491 }
492 
493 bool WebAssemblyPassConfig::addInstSelector() {
494   (void)TargetPassConfig::addInstSelector();
495   addPass(
496       createWebAssemblyISelDag(getWebAssemblyTargetMachine(), getOptLevel()));
497   // Run the argument-move pass immediately after the ScheduleDAG scheduler
498   // so that we can fix up the ARGUMENT instructions before anything else
499   // sees them in the wrong place.
500   addPass(createWebAssemblyArgumentMove());
501   // Set the p2align operands. This information is present during ISel, however
502   // it's inconvenient to collect. Collect it now, and update the immediate
503   // operands.
504   addPass(createWebAssemblySetP2AlignOperands());
505 
506   // Eliminate range checks and add default targets to br_table instructions.
507   addPass(createWebAssemblyFixBrTableDefaults());
508 
509   return false;
510 }
511 
512 void WebAssemblyPassConfig::addOptimizedRegAlloc() {
513   // Currently RegisterCoalesce degrades wasm debug info quality by a
514   // significant margin. As a quick fix, disable this for -O1, which is often
515   // used for debugging large applications. Disabling this increases code size
516   // of Emscripten core benchmarks by ~5%, which is acceptable for -O1, which is
517   // usually not used for production builds.
518   // TODO Investigate why RegisterCoalesce degrades debug info quality and fix
519   // it properly
520   if (getOptLevel() == CodeGenOptLevel::Less)
521     disablePass(&RegisterCoalescerID);
522   TargetPassConfig::addOptimizedRegAlloc();
523 }
524 
525 void WebAssemblyPassConfig::addPostRegAlloc() {
526   // TODO: The following CodeGen passes don't currently support code containing
527   // virtual registers. Consider removing their restrictions and re-enabling
528   // them.
529 
530   // These functions all require the NoVRegs property.
531   disablePass(&MachineLateInstrsCleanupID);
532   disablePass(&MachineCopyPropagationID);
533   disablePass(&PostRAMachineSinkingID);
534   disablePass(&PostRASchedulerID);
535   disablePass(&FuncletLayoutID);
536   disablePass(&StackMapLivenessID);
537   disablePass(&PatchableFunctionID);
538   disablePass(&ShrinkWrapID);
539 
540   // This pass hurts code size for wasm because it can generate irreducible
541   // control flow.
542   disablePass(&MachineBlockPlacementID);
543 
544   TargetPassConfig::addPostRegAlloc();
545 }
546 
547 void WebAssemblyPassConfig::addPreEmitPass() {
548   TargetPassConfig::addPreEmitPass();
549 
550   // Nullify DBG_VALUE_LISTs that we cannot handle.
551   addPass(createWebAssemblyNullifyDebugValueLists());
552 
553   // Eliminate multiple-entry loops.
554   if (!WasmDisableFixIrreducibleControlFlowPass)
555     addPass(createWebAssemblyFixIrreducibleControlFlow());
556 
557   // Do various transformations for exception handling.
558   // Every CFG-changing optimizations should come before this.
559   if (TM->Options.ExceptionModel == ExceptionHandling::Wasm)
560     addPass(createWebAssemblyLateEHPrepare());
561 
562   // Now that we have a prologue and epilogue and all frame indices are
563   // rewritten, eliminate SP and FP. This allows them to be stackified,
564   // colored, and numbered with the rest of the registers.
565   addPass(createWebAssemblyReplacePhysRegs());
566 
567   // Preparations and optimizations related to register stackification.
568   if (getOptLevel() != CodeGenOptLevel::None) {
569     // Depend on LiveIntervals and perform some optimizations on it.
570     addPass(createWebAssemblyOptimizeLiveIntervals());
571 
572     // Prepare memory intrinsic calls for register stackifying.
573     addPass(createWebAssemblyMemIntrinsicResults());
574 
575     // Mark registers as representing wasm's value stack. This is a key
576     // code-compression technique in WebAssembly. We run this pass (and
577     // MemIntrinsicResults above) very late, so that it sees as much code as
578     // possible, including code emitted by PEI and expanded by late tail
579     // duplication.
580     addPass(createWebAssemblyRegStackify());
581 
582     // Run the register coloring pass to reduce the total number of registers.
583     // This runs after stackification so that it doesn't consider registers
584     // that become stackified.
585     addPass(createWebAssemblyRegColoring());
586   }
587 
588   // Sort the blocks of the CFG into topological order, a prerequisite for
589   // BLOCK and LOOP markers.
590   addPass(createWebAssemblyCFGSort());
591 
592   // Insert BLOCK and LOOP markers.
593   addPass(createWebAssemblyCFGStackify());
594 
595   // Insert explicit local.get and local.set operators.
596   if (!WasmDisableExplicitLocals)
597     addPass(createWebAssemblyExplicitLocals());
598 
599   // Lower br_unless into br_if.
600   addPass(createWebAssemblyLowerBrUnless());
601 
602   // Perform the very last peephole optimizations on the code.
603   if (getOptLevel() != CodeGenOptLevel::None)
604     addPass(createWebAssemblyPeephole());
605 
606   // Create a mapping from LLVM CodeGen virtual registers to wasm registers.
607   addPass(createWebAssemblyRegNumbering());
608 
609   // Fix debug_values whose defs have been stackified.
610   if (!WasmDisableExplicitLocals)
611     addPass(createWebAssemblyDebugFixup());
612 
613   // Collect information to prepare for MC lowering / asm printing.
614   addPass(createWebAssemblyMCLowerPrePass());
615 }
616 
617 bool WebAssemblyPassConfig::addPreISel() {
618   TargetPassConfig::addPreISel();
619   addPass(createWebAssemblyLowerRefTypesIntPtrConv());
620   return false;
621 }
622 
623 yaml::MachineFunctionInfo *
624 WebAssemblyTargetMachine::createDefaultFuncInfoYAML() const {
625   return new yaml::WebAssemblyFunctionInfo();
626 }
627 
628 yaml::MachineFunctionInfo *WebAssemblyTargetMachine::convertFuncInfoToYAML(
629     const MachineFunction &MF) const {
630   const auto *MFI = MF.getInfo<WebAssemblyFunctionInfo>();
631   return new yaml::WebAssemblyFunctionInfo(MF, *MFI);
632 }
633 
634 bool WebAssemblyTargetMachine::parseMachineFunctionInfo(
635     const yaml::MachineFunctionInfo &MFI, PerFunctionMIParsingState &PFS,
636     SMDiagnostic &Error, SMRange &SourceRange) const {
637   const auto &YamlMFI = static_cast<const yaml::WebAssemblyFunctionInfo &>(MFI);
638   MachineFunction &MF = PFS.MF;
639   MF.getInfo<WebAssemblyFunctionInfo>()->initializeBaseYamlFields(MF, YamlMFI);
640   return false;
641 }
642