110e730a2SDan Gohman //===- WebAssemblyTargetMachine.cpp - Define TargetMachine for WebAssembly -==// 210e730a2SDan Gohman // 32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 610e730a2SDan Gohman // 710e730a2SDan Gohman //===----------------------------------------------------------------------===// 810e730a2SDan Gohman /// 910e730a2SDan Gohman /// \file 105f8f34e4SAdrian Prantl /// This file defines the WebAssembly-specific subclass of TargetMachine. 1110e730a2SDan Gohman /// 1210e730a2SDan Gohman //===----------------------------------------------------------------------===// 1310e730a2SDan Gohman 1410e730a2SDan Gohman #include "WebAssemblyTargetMachine.h" 156bda14b3SChandler Carruth #include "MCTargetDesc/WebAssemblyMCTargetDesc.h" 16c6c42137SRichard Trieu #include "TargetInfo/WebAssemblyTargetInfo.h" 174625b848SHeejin Ahn #include "Utils/WebAssemblyUtilities.h" 186bda14b3SChandler Carruth #include "WebAssembly.h" 1952221d56SHeejin Ahn #include "WebAssemblyMachineFunctionInfo.h" 205bf22fc8SDan Gohman #include "WebAssemblyTargetObjectFile.h" 2110e730a2SDan Gohman #include "WebAssemblyTargetTransformInfo.h" 2252221d56SHeejin Ahn #include "llvm/CodeGen/MIRParser/MIParser.h" 2310e730a2SDan Gohman #include "llvm/CodeGen/MachineFunctionPass.h" 2410e730a2SDan Gohman #include "llvm/CodeGen/Passes.h" 2510e730a2SDan Gohman #include "llvm/CodeGen/RegAllocRegistry.h" 2631d19d43SMatthias Braun #include "llvm/CodeGen/TargetPassConfig.h" 2710e730a2SDan Gohman #include "llvm/IR/Function.h" 284625b848SHeejin Ahn #include "llvm/MC/MCAsmInfo.h" 2989b57061SReid Kleckner #include "llvm/MC/TargetRegistry.h" 3010e730a2SDan Gohman #include "llvm/Target/TargetOptions.h" 3103855df1SJF Bastien #include "llvm/Transforms/Scalar.h" 323f34e1b8SThomas Lively #include "llvm/Transforms/Scalar/LowerAtomic.h" 33a373d18eSDavid Blaikie #include "llvm/Transforms/Utils.h" 3410e730a2SDan Gohman using namespace llvm; 3510e730a2SDan Gohman 3610e730a2SDan Gohman #define DEBUG_TYPE "wasm" 3710e730a2SDan Gohman 382b7fe086SWouter van Oortmerssen // A command-line option to keep implicit locals 392b7fe086SWouter van Oortmerssen // for the purpose of testing with lit/llc ONLY. 402b7fe086SWouter van Oortmerssen // This produces output which is not valid WebAssembly, and is not supported 412b7fe086SWouter van Oortmerssen // by assemblers/disassemblers and other MC based tools. 422b7fe086SWouter van Oortmerssen static cl::opt<bool> WasmDisableExplicitLocals( 432b7fe086SWouter van Oortmerssen "wasm-disable-explicit-locals", cl::Hidden, 442b7fe086SWouter van Oortmerssen cl::desc("WebAssembly: output implicit locals in" 452b7fe086SWouter van Oortmerssen " instruction output for test purposes only."), 462b7fe086SWouter van Oortmerssen cl::init(false)); 472b7fe086SWouter van Oortmerssen 480dbcb363STom Stellard extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeWebAssemblyTarget() { 4910e730a2SDan Gohman // Register the target. 50f42454b9SMehdi Amini RegisterTargetMachine<WebAssemblyTargetMachine> X( 51f42454b9SMehdi Amini getTheWebAssemblyTarget32()); 52f42454b9SMehdi Amini RegisterTargetMachine<WebAssemblyTargetMachine> Y( 53f42454b9SMehdi Amini getTheWebAssemblyTarget64()); 54f41f67d3SDerek Schuff 5540926451SJacob Gravelle // Register backend passes 5640926451SJacob Gravelle auto &PR = *PassRegistry::getPassRegistry(); 5792617559SSam Clegg initializeWebAssemblyAddMissingPrototypesPass(PR); 5840926451SJacob Gravelle initializeWebAssemblyLowerEmscriptenEHSjLjPass(PR); 5940926451SJacob Gravelle initializeLowerGlobalDtorsPass(PR); 6040926451SJacob Gravelle initializeFixFunctionBitcastsPass(PR); 6140926451SJacob Gravelle initializeOptimizeReturnedPass(PR); 6240926451SJacob Gravelle initializeWebAssemblyArgumentMovePass(PR); 6340926451SJacob Gravelle initializeWebAssemblySetP2AlignOperandsPass(PR); 6440926451SJacob Gravelle initializeWebAssemblyReplacePhysRegsPass(PR); 6540926451SJacob Gravelle initializeWebAssemblyPrepareForLiveIntervalsPass(PR); 6640926451SJacob Gravelle initializeWebAssemblyOptimizeLiveIntervalsPass(PR); 67321d5220SHeejin Ahn initializeWebAssemblyMemIntrinsicResultsPass(PR); 6840926451SJacob Gravelle initializeWebAssemblyRegStackifyPass(PR); 6940926451SJacob Gravelle initializeWebAssemblyRegColoringPass(PR); 70a64ebb86SHeejin Ahn initializeWebAssemblyNullifyDebugValueListsPass(PR); 7140926451SJacob Gravelle initializeWebAssemblyFixIrreducibleControlFlowPass(PR); 724934f76bSHeejin Ahn initializeWebAssemblyLateEHPreparePass(PR); 7304c48949SHeejin Ahn initializeWebAssemblyExceptionInfoPass(PR); 7440926451SJacob Gravelle initializeWebAssemblyCFGSortPass(PR); 7540926451SJacob Gravelle initializeWebAssemblyCFGStackifyPass(PR); 76e9fd9073SHeejin Ahn initializeWebAssemblyExplicitLocalsPass(PR); 7740926451SJacob Gravelle initializeWebAssemblyLowerBrUnlessPass(PR); 7840926451SJacob Gravelle initializeWebAssemblyRegNumberingPass(PR); 792b7fe086SWouter van Oortmerssen initializeWebAssemblyDebugFixupPass(PR); 8040926451SJacob Gravelle initializeWebAssemblyPeepholePass(PR); 819647a6f7SWouter van Oortmerssen initializeWebAssemblyMCLowerPrePassPass(PR); 8210e730a2SDan Gohman } 8310e730a2SDan Gohman 8410e730a2SDan Gohman //===----------------------------------------------------------------------===// 8510e730a2SDan Gohman // WebAssembly Lowering public interface. 8610e730a2SDan Gohman //===----------------------------------------------------------------------===// 8710e730a2SDan Gohman 8853572d04SDan Gohman static Reloc::Model getEffectiveRelocModel(Optional<Reloc::Model> RM, 8953572d04SDan Gohman const Triple &TT) { 9074f5fd4eSSam Clegg if (!RM.hasValue()) { 9174f5fd4eSSam Clegg // Default to static relocation model. This should always be more optimial 9274f5fd4eSSam Clegg // than PIC since the static linker can determine all global addresses and 9374f5fd4eSSam Clegg // assume direct function calls. 9474f5fd4eSSam Clegg return Reloc::Static; 9574f5fd4eSSam Clegg } 9653572d04SDan Gohman 9753572d04SDan Gohman if (!TT.isOSEmscripten()) { 9853572d04SDan Gohman // Relocation modes other than static are currently implemented in a way 9953572d04SDan Gohman // that only works for Emscripten, so disable them if we aren't targeting 10053572d04SDan Gohman // Emscripten. 10153572d04SDan Gohman return Reloc::Static; 10253572d04SDan Gohman } 10353572d04SDan Gohman 10441133a3eSDan Gohman return *RM; 10541133a3eSDan Gohman } 10641133a3eSDan Gohman 10710e730a2SDan Gohman /// Create an WebAssembly architecture model. 10810e730a2SDan Gohman /// 10910e730a2SDan Gohman WebAssemblyTargetMachine::WebAssemblyTargetMachine( 11010e730a2SDan Gohman const Target &T, const Triple &TT, StringRef CPU, StringRef FS, 11141133a3eSDan Gohman const TargetOptions &Options, Optional<Reloc::Model> RM, 112314ed201SDaniel Jasper Optional<CodeModel::Model> CM, CodeGenOpt::Level OL, bool JIT) 113ac02baabSDerek Schuff : LLVMTargetMachine( 114ac02baabSDerek Schuff T, 115d7086af2SPaulo Matos TT.isArch64Bit() 1166d0c7bc1SPaulo Matos ? (TT.isOSEmscripten() ? "e-m:e-p:64:64-p10:8:8-p20:8:8-i64:64-" 1176d0c7bc1SPaulo Matos "f128:64-n32:64-S128-ni:1:10:20" 1186d0c7bc1SPaulo Matos : "e-m:e-p:64:64-p10:8:8-p20:8:8-i64:64-" 1196d0c7bc1SPaulo Matos "n32:64-S128-ni:1:10:20") 1206d0c7bc1SPaulo Matos : (TT.isOSEmscripten() ? "e-m:e-p:32:32-p10:8:8-p20:8:8-i64:64-" 1216d0c7bc1SPaulo Matos "f128:64-n32:64-S128-ni:1:10:20" 1226d0c7bc1SPaulo Matos : "e-m:e-p:32:32-p10:8:8-p20:8:8-i64:64-" 1236d0c7bc1SPaulo Matos "n32:64-S128-ni:1:10:20"), 12453572d04SDan Gohman TT, CPU, FS, Options, getEffectiveRelocModel(RM, TT), 125ca29c271SDavid Green getEffectiveCodeModel(CM, CodeModel::Large), OL), 126cf2a9e28SSam Clegg TLOF(new WebAssemblyTargetObjectFile()) { 127e040533eSDan Gohman // WebAssembly type-checks instructions, but a noreturn function with a return 128ffa143ceSDerek Schuff // type that doesn't match the context will cause a check failure. So we lower 129ffa143ceSDerek Schuff // LLVM 'unreachable' to ISD::TRAP and then lower that to WebAssembly's 130e040533eSDan Gohman // 'unreachable' instructions which is meant for that case. 131ffa143ceSDerek Schuff this->Options.TrapUnreachable = true; 132ffa143ceSDerek Schuff 133d934cb88SDan Gohman // WebAssembly treats each function as an independent unit. Force 134d934cb88SDan Gohman // -ffunction-sections, effectively, so that we can emit them independently. 135d934cb88SDan Gohman this->Options.FunctionSections = true; 136d934cb88SDan Gohman this->Options.DataSections = true; 137d934cb88SDan Gohman this->Options.UniqueSectionNames = true; 138d934cb88SDan Gohman 13910e730a2SDan Gohman initAsmInfo(); 14010e730a2SDan Gohman 141d85ab7fcSDan Gohman // Note that we don't use setRequiresStructuredCFG(true). It disables 142d85ab7fcSDan Gohman // optimizations than we're ok with, and want, such as critical edge 143d85ab7fcSDan Gohman // splitting and tail merging. 14410e730a2SDan Gohman } 14510e730a2SDan Gohman 14618c56a07SHeejin Ahn WebAssemblyTargetMachine::~WebAssemblyTargetMachine() = default; // anchor. 14710e730a2SDan Gohman 14889fe083cSThomas Lively const WebAssemblySubtarget *WebAssemblyTargetMachine::getSubtargetImpl() const { 14989fe083cSThomas Lively return getSubtargetImpl(std::string(getTargetCPU()), 15089fe083cSThomas Lively std::string(getTargetFeatureString())); 15189fe083cSThomas Lively } 15289fe083cSThomas Lively 15310e730a2SDan Gohman const WebAssemblySubtarget * 154f3b4f990SThomas Lively WebAssemblyTargetMachine::getSubtargetImpl(std::string CPU, 155f3b4f990SThomas Lively std::string FS) const { 156f3b4f990SThomas Lively auto &I = SubtargetMap[CPU + FS]; 157f3b4f990SThomas Lively if (!I) { 1580eaee545SJonas Devlieghere I = std::make_unique<WebAssemblySubtarget>(TargetTriple, CPU, FS, *this); 159f3b4f990SThomas Lively } 160f3b4f990SThomas Lively return I.get(); 161f3b4f990SThomas Lively } 162f3b4f990SThomas Lively 163f3b4f990SThomas Lively const WebAssemblySubtarget * 16410e730a2SDan Gohman WebAssemblyTargetMachine::getSubtargetImpl(const Function &F) const { 16510e730a2SDan Gohman Attribute CPUAttr = F.getFnAttribute("target-cpu"); 16610e730a2SDan Gohman Attribute FSAttr = F.getFnAttribute("target-features"); 16710e730a2SDan Gohman 168aab90384SCraig Topper std::string CPU = 169aab90384SCraig Topper CPUAttr.isValid() ? CPUAttr.getValueAsString().str() : TargetCPU; 170aab90384SCraig Topper std::string FS = 171aab90384SCraig Topper FSAttr.isValid() ? FSAttr.getValueAsString().str() : TargetFS; 17210e730a2SDan Gohman 17310e730a2SDan Gohman // This needs to be done before we create a new subtarget since any 17410e730a2SDan Gohman // creation will depend on the TM and the code generation flags on the 17510e730a2SDan Gohman // function that reside in TargetOptions. 17610e730a2SDan Gohman resetTargetOptions(F); 177f3b4f990SThomas Lively 178f3b4f990SThomas Lively return getSubtargetImpl(CPU, FS); 17910e730a2SDan Gohman } 18010e730a2SDan Gohman 18110e730a2SDan Gohman namespace { 1823f34e1b8SThomas Lively 1833f34e1b8SThomas Lively class CoalesceFeaturesAndStripAtomics final : public ModulePass { 1843f34e1b8SThomas Lively // Take the union of all features used in the module and use it for each 1853f34e1b8SThomas Lively // function individually, since having multiple feature sets in one module 1863f34e1b8SThomas Lively // currently does not make sense for WebAssembly. If atomics are not enabled, 1873f34e1b8SThomas Lively // also strip atomic operations and thread local storage. 18839b5367cSDerek Schuff static char ID; 1893f34e1b8SThomas Lively WebAssemblyTargetMachine *WasmTM; 19039b5367cSDerek Schuff 19139b5367cSDerek Schuff public: 1923f34e1b8SThomas Lively CoalesceFeaturesAndStripAtomics(WebAssemblyTargetMachine *WasmTM) 1933f34e1b8SThomas Lively : ModulePass(ID), WasmTM(WasmTM) {} 1943f34e1b8SThomas Lively 19539b5367cSDerek Schuff bool runOnModule(Module &M) override { 1963f34e1b8SThomas Lively FeatureBitset Features = coalesceFeatures(M); 1973f34e1b8SThomas Lively 1983f34e1b8SThomas Lively std::string FeatureStr = getFeatureString(Features); 19989fe083cSThomas Lively WasmTM->setTargetFeatureString(FeatureStr); 2003f34e1b8SThomas Lively for (auto &F : M) 2013f34e1b8SThomas Lively replaceFeatures(F, FeatureStr); 2023f34e1b8SThomas Lively 20342bba4b8SGuanzhong Chen bool StrippedAtomics = false; 20442bba4b8SGuanzhong Chen bool StrippedTLS = false; 2053f34e1b8SThomas Lively 20642bba4b8SGuanzhong Chen if (!Features[WebAssembly::FeatureAtomics]) 20742bba4b8SGuanzhong Chen StrippedAtomics = stripAtomics(M); 20842bba4b8SGuanzhong Chen 20942bba4b8SGuanzhong Chen if (!Features[WebAssembly::FeatureBulkMemory]) 21042bba4b8SGuanzhong Chen StrippedTLS = stripThreadLocals(M); 21142bba4b8SGuanzhong Chen 21242bba4b8SGuanzhong Chen if (StrippedAtomics && !StrippedTLS) 21342bba4b8SGuanzhong Chen stripThreadLocals(M); 21442bba4b8SGuanzhong Chen else if (StrippedTLS && !StrippedAtomics) 21542bba4b8SGuanzhong Chen stripAtomics(M); 21642bba4b8SGuanzhong Chen 21742bba4b8SGuanzhong Chen recordFeatures(M, Features, StrippedAtomics || StrippedTLS); 2183f34e1b8SThomas Lively 2193f34e1b8SThomas Lively // Conservatively assume we have made some change 22039b5367cSDerek Schuff return true; 22139b5367cSDerek Schuff } 2223f34e1b8SThomas Lively 2233f34e1b8SThomas Lively private: 2243f34e1b8SThomas Lively FeatureBitset coalesceFeatures(const Module &M) { 2253f34e1b8SThomas Lively FeatureBitset Features = 2263f34e1b8SThomas Lively WasmTM 227adcd0268SBenjamin Kramer ->getSubtargetImpl(std::string(WasmTM->getTargetCPU()), 228adcd0268SBenjamin Kramer std::string(WasmTM->getTargetFeatureString())) 2293f34e1b8SThomas Lively ->getFeatureBits(); 2303f34e1b8SThomas Lively for (auto &F : M) 2313f34e1b8SThomas Lively Features |= WasmTM->getSubtargetImpl(F)->getFeatureBits(); 2323f34e1b8SThomas Lively return Features; 2333f34e1b8SThomas Lively } 2343f34e1b8SThomas Lively 2353f34e1b8SThomas Lively std::string getFeatureString(const FeatureBitset &Features) { 2363f34e1b8SThomas Lively std::string Ret; 2373f34e1b8SThomas Lively for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) { 2383f34e1b8SThomas Lively if (Features[KV.Value]) 2393f34e1b8SThomas Lively Ret += (StringRef("+") + KV.Key + ",").str(); 2403f34e1b8SThomas Lively } 2413f34e1b8SThomas Lively return Ret; 2423f34e1b8SThomas Lively } 2433f34e1b8SThomas Lively 2443f34e1b8SThomas Lively void replaceFeatures(Function &F, const std::string &Features) { 2453f34e1b8SThomas Lively F.removeFnAttr("target-features"); 2463f34e1b8SThomas Lively F.removeFnAttr("target-cpu"); 2473f34e1b8SThomas Lively F.addFnAttr("target-features", Features); 2483f34e1b8SThomas Lively } 2493f34e1b8SThomas Lively 2503f34e1b8SThomas Lively bool stripAtomics(Module &M) { 2513f34e1b8SThomas Lively // Detect whether any atomics will be lowered, since there is no way to tell 2523f34e1b8SThomas Lively // whether the LowerAtomic pass lowers e.g. stores. 2533f34e1b8SThomas Lively bool Stripped = false; 2543f34e1b8SThomas Lively for (auto &F : M) { 2553f34e1b8SThomas Lively for (auto &B : F) { 2563f34e1b8SThomas Lively for (auto &I : B) { 2573f34e1b8SThomas Lively if (I.isAtomic()) { 2583f34e1b8SThomas Lively Stripped = true; 2593f34e1b8SThomas Lively goto done; 2603f34e1b8SThomas Lively } 2613f34e1b8SThomas Lively } 2623f34e1b8SThomas Lively } 2633f34e1b8SThomas Lively } 2643f34e1b8SThomas Lively 2653f34e1b8SThomas Lively done: 2663f34e1b8SThomas Lively if (!Stripped) 2673f34e1b8SThomas Lively return false; 2683f34e1b8SThomas Lively 2693f34e1b8SThomas Lively LowerAtomicPass Lowerer; 2703f34e1b8SThomas Lively FunctionAnalysisManager FAM; 2713f34e1b8SThomas Lively for (auto &F : M) 2723f34e1b8SThomas Lively Lowerer.run(F, FAM); 2733f34e1b8SThomas Lively 2743f34e1b8SThomas Lively return true; 2753f34e1b8SThomas Lively } 2763f34e1b8SThomas Lively 2773f34e1b8SThomas Lively bool stripThreadLocals(Module &M) { 2783f34e1b8SThomas Lively bool Stripped = false; 2793f34e1b8SThomas Lively for (auto &GV : M.globals()) { 280a28a4662SSam Clegg if (GV.isThreadLocal()) { 2813f34e1b8SThomas Lively Stripped = true; 282a28a4662SSam Clegg GV.setThreadLocal(false); 2833f34e1b8SThomas Lively } 2843f34e1b8SThomas Lively } 2853f34e1b8SThomas Lively return Stripped; 2863f34e1b8SThomas Lively } 2873f34e1b8SThomas Lively 2883f34e1b8SThomas Lively void recordFeatures(Module &M, const FeatureBitset &Features, bool Stripped) { 2893f34e1b8SThomas Lively for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) { 290a1ae9566SThomas Lively if (Features[KV.Value]) { 291a1ae9566SThomas Lively // Mark features as used 2923f34e1b8SThomas Lively std::string MDKey = (StringRef("wasm-feature-") + KV.Key).str(); 2933f34e1b8SThomas Lively M.addModuleFlag(Module::ModFlagBehavior::Error, MDKey, 2943f34e1b8SThomas Lively wasm::WASM_FEATURE_PREFIX_USED); 2953f34e1b8SThomas Lively } 2963f34e1b8SThomas Lively } 297a1ae9566SThomas Lively // Code compiled without atomics or bulk-memory may have had its atomics or 298a1ae9566SThomas Lively // thread-local data lowered to nonatomic operations or non-thread-local 299a1ae9566SThomas Lively // data. In that case, we mark the pseudo-feature "shared-mem" as disallowed 300a1ae9566SThomas Lively // to tell the linker that it would be unsafe to allow this code ot be used 301a1ae9566SThomas Lively // in a module with shared memory. 302a1ae9566SThomas Lively if (Stripped) { 303a1ae9566SThomas Lively M.addModuleFlag(Module::ModFlagBehavior::Error, "wasm-feature-shared-mem", 304a1ae9566SThomas Lively wasm::WASM_FEATURE_PREFIX_DISALLOWED); 305a1ae9566SThomas Lively } 3063f34e1b8SThomas Lively } 30739b5367cSDerek Schuff }; 3083f34e1b8SThomas Lively char CoalesceFeaturesAndStripAtomics::ID = 0; 30939b5367cSDerek Schuff 31010e730a2SDan Gohman /// WebAssembly Code Generator Pass Configuration Options. 31110e730a2SDan Gohman class WebAssemblyPassConfig final : public TargetPassConfig { 31210e730a2SDan Gohman public: 3135e394c3dSMatthias Braun WebAssemblyPassConfig(WebAssemblyTargetMachine &TM, PassManagerBase &PM) 31410e730a2SDan Gohman : TargetPassConfig(TM, PM) {} 31510e730a2SDan Gohman 31610e730a2SDan Gohman WebAssemblyTargetMachine &getWebAssemblyTargetMachine() const { 31710e730a2SDan Gohman return getTM<WebAssemblyTargetMachine>(); 31810e730a2SDan Gohman } 31910e730a2SDan Gohman 32010e730a2SDan Gohman FunctionPass *createTargetRegisterAllocator(bool) override; 32110e730a2SDan Gohman 32210e730a2SDan Gohman void addIRPasses() override; 323*4f9b8397SHeejin Ahn void addISelPrepare() override; 32410e730a2SDan Gohman bool addInstSelector() override; 32510e730a2SDan Gohman void addPostRegAlloc() override; 326ad154c83SDerek Schuff bool addGCPasses() override { return false; } 32710e730a2SDan Gohman void addPreEmitPass() override; 328d3a0a65bSPaulo Matos bool addPreISel() override; 329cf55a657SMatt Arsenault 330cf55a657SMatt Arsenault // No reg alloc 331c9122ddeSMatt Arsenault bool addRegAssignAndRewriteFast() override { return false; } 332cf55a657SMatt Arsenault 333cf55a657SMatt Arsenault // No reg alloc 334c9122ddeSMatt Arsenault bool addRegAssignAndRewriteOptimized() override { return false; } 33510e730a2SDan Gohman }; 33610e730a2SDan Gohman } // end anonymous namespace 33710e730a2SDan Gohman 33826d11ca4SSanjoy Das TargetTransformInfo 33926d11ca4SSanjoy Das WebAssemblyTargetMachine::getTargetTransformInfo(const Function &F) { 34010e730a2SDan Gohman return TargetTransformInfo(WebAssemblyTTIImpl(this, F)); 34110e730a2SDan Gohman } 34210e730a2SDan Gohman 34310e730a2SDan Gohman TargetPassConfig * 34410e730a2SDan Gohman WebAssemblyTargetMachine::createPassConfig(PassManagerBase &PM) { 3455e394c3dSMatthias Braun return new WebAssemblyPassConfig(*this, PM); 34610e730a2SDan Gohman } 34710e730a2SDan Gohman 34810e730a2SDan Gohman FunctionPass *WebAssemblyPassConfig::createTargetRegisterAllocator(bool) { 34910e730a2SDan Gohman return nullptr; // No reg alloc 35010e730a2SDan Gohman } 35110e730a2SDan Gohman 3524625b848SHeejin Ahn using WebAssembly::WasmEnableEH; 3534625b848SHeejin Ahn using WebAssembly::WasmEnableEmEH; 3544625b848SHeejin Ahn using WebAssembly::WasmEnableEmSjLj; 3554625b848SHeejin Ahn using WebAssembly::WasmEnableSjLj; 3564625b848SHeejin Ahn 3574625b848SHeejin Ahn static void basicCheckForEHAndSjLj(TargetMachine *TM) { 3584625b848SHeejin Ahn // Before checking, we make sure TargetOptions.ExceptionModel is the same as 3594625b848SHeejin Ahn // MCAsmInfo.ExceptionsType. Normally these have to be the same, because clang 3604625b848SHeejin Ahn // stores the exception model info in LangOptions, which is later transferred 3614625b848SHeejin Ahn // to TargetOptions and MCAsmInfo. But when clang compiles bitcode directly, 3624625b848SHeejin Ahn // clang's LangOptions is not used and thus the exception model info is not 3634625b848SHeejin Ahn // correctly transferred to TargetOptions and MCAsmInfo, so we make sure we 3644625b848SHeejin Ahn // have the correct exception model in in WebAssemblyMCAsmInfo constructor. 3654625b848SHeejin Ahn // But in this case TargetOptions is still not updated, so we make sure they 3664625b848SHeejin Ahn // are the same. 3674625b848SHeejin Ahn TM->Options.ExceptionModel = TM->getMCAsmInfo()->getExceptionHandlingType(); 3684625b848SHeejin Ahn 36995875d24SZarko Todorovski // Basic Correctness checking related to -exception-model 37077b921b8SHeejin Ahn if (TM->Options.ExceptionModel != ExceptionHandling::None && 37177b921b8SHeejin Ahn TM->Options.ExceptionModel != ExceptionHandling::Wasm) 37277b921b8SHeejin Ahn report_fatal_error("-exception-model should be either 'none' or 'wasm'"); 37377b921b8SHeejin Ahn if (WasmEnableEmEH && TM->Options.ExceptionModel == ExceptionHandling::Wasm) 37477b921b8SHeejin Ahn report_fatal_error("-exception-model=wasm not allowed with " 37577b921b8SHeejin Ahn "-enable-emscripten-cxx-exceptions"); 37677b921b8SHeejin Ahn if (WasmEnableEH && TM->Options.ExceptionModel != ExceptionHandling::Wasm) 37777b921b8SHeejin Ahn report_fatal_error( 37877b921b8SHeejin Ahn "-wasm-enable-eh only allowed with -exception-model=wasm"); 37977b921b8SHeejin Ahn if (WasmEnableSjLj && TM->Options.ExceptionModel != ExceptionHandling::Wasm) 38077b921b8SHeejin Ahn report_fatal_error( 38177b921b8SHeejin Ahn "-wasm-enable-sjlj only allowed with -exception-model=wasm"); 38277b921b8SHeejin Ahn if ((!WasmEnableEH && !WasmEnableSjLj) && 38377b921b8SHeejin Ahn TM->Options.ExceptionModel == ExceptionHandling::Wasm) 38477b921b8SHeejin Ahn report_fatal_error( 38577b921b8SHeejin Ahn "-exception-model=wasm only allowed with at least one of " 38677b921b8SHeejin Ahn "-wasm-enable-eh or -wasm-enable-sjj"); 38777b921b8SHeejin Ahn 38877b921b8SHeejin Ahn // You can't enable two modes of EH at the same time 38977b921b8SHeejin Ahn if (WasmEnableEmEH && WasmEnableEH) 39077b921b8SHeejin Ahn report_fatal_error( 39177b921b8SHeejin Ahn "-enable-emscripten-cxx-exceptions not allowed with -wasm-enable-eh"); 39277b921b8SHeejin Ahn // You can't enable two modes of SjLj at the same time 39377b921b8SHeejin Ahn if (WasmEnableEmSjLj && WasmEnableSjLj) 39477b921b8SHeejin Ahn report_fatal_error( 39577b921b8SHeejin Ahn "-enable-emscripten-sjlj not allowed with -wasm-enable-sjlj"); 39677b921b8SHeejin Ahn // You can't mix Emscripten EH with Wasm SjLj. 39777b921b8SHeejin Ahn if (WasmEnableEmEH && WasmEnableSjLj) 39877b921b8SHeejin Ahn report_fatal_error( 39977b921b8SHeejin Ahn "-enable-emscripten-cxx-exceptions not allowed with -wasm-enable-sjlj"); 40077b921b8SHeejin Ahn // Currently it is allowed to mix Wasm EH with Emscripten SjLj as an interim 40177b921b8SHeejin Ahn // measure, but some code will error out at compile time in this combination. 40277b921b8SHeejin Ahn // See WebAssemblyLowerEmscriptenEHSjLj pass for details. 40377b921b8SHeejin Ahn } 40477b921b8SHeejin Ahn 40510e730a2SDan Gohman //===----------------------------------------------------------------------===// 40610e730a2SDan Gohman // The following functions are called from lib/CodeGen/Passes.cpp to modify 40710e730a2SDan Gohman // the CodeGen pass sequence. 40810e730a2SDan Gohman //===----------------------------------------------------------------------===// 40910e730a2SDan Gohman 41010e730a2SDan Gohman void WebAssemblyPassConfig::addIRPasses() { 41192617559SSam Clegg // Add signatures to prototype-less function declarations 41292617559SSam Clegg addPass(createWebAssemblyAddMissingPrototypes()); 41392617559SSam Clegg 414bafe6902SSam Clegg // Lower .llvm.global_dtors into .llvm_global_ctors with __cxa_atexit calls. 415bafe6902SSam Clegg addPass(createWebAssemblyLowerGlobalDtors()); 416bafe6902SSam Clegg 4171b637458SDan Gohman // Fix function bitcasts, as WebAssembly requires caller and callee signatures 4181b637458SDan Gohman // to match. 4191b637458SDan Gohman addPass(createWebAssemblyFixFunctionBitcasts()); 4201b637458SDan Gohman 42181719f85SDan Gohman // Optimize "returned" function attributes. 422b13c91f1SDan Gohman if (getOptLevel() != CodeGenOpt::None) 42381719f85SDan Gohman addPass(createWebAssemblyOptimizeReturned()); 42481719f85SDan Gohman 42595875d24SZarko Todorovski basicCheckForEHAndSjLj(TM); 42677b921b8SHeejin Ahn 427c0f18172SHeejin Ahn // If exception handling is not enabled and setjmp/longjmp handling is 428c0f18172SHeejin Ahn // enabled, we lower invokes into calls and delete unreachable landingpad 429c0f18172SHeejin Ahn // blocks. Lowering invokes when there is no EH support is done in 43077b921b8SHeejin Ahn // TargetPassConfig::addPassesToHandleExceptions, but that runs after these IR 43177b921b8SHeejin Ahn // passes and Emscripten SjLj handling expects all invokes to be lowered 43277b921b8SHeejin Ahn // before. 43377b921b8SHeejin Ahn if (!WasmEnableEmEH && !WasmEnableEH) { 434c0f18172SHeejin Ahn addPass(createLowerInvokePass()); 435c0f18172SHeejin Ahn // The lower invoke pass may create unreachable code. Remove it in order not 436c0f18172SHeejin Ahn // to process dead blocks in setjmp/longjmp handling. 437c0f18172SHeejin Ahn addPass(createUnreachableBlockEliminationPass()); 438c0f18172SHeejin Ahn } 439c0f18172SHeejin Ahn 44077b921b8SHeejin Ahn // Handle exceptions and setjmp/longjmp if enabled. Unlike Wasm EH preparation 44177b921b8SHeejin Ahn // done in WasmEHPrepare pass, Wasm SjLj preparation shares libraries and 44277b921b8SHeejin Ahn // transformation algorithms with Emscripten SjLj, so we run 44377b921b8SHeejin Ahn // LowerEmscriptenEHSjLj pass also when Wasm SjLj is enabled. 44477b921b8SHeejin Ahn if (WasmEnableEmEH || WasmEnableEmSjLj || WasmEnableSjLj) 44577b921b8SHeejin Ahn addPass(createWebAssemblyLowerEmscriptenEHSjLj()); 446f41f67d3SDerek Schuff 447ec4be576SDerek Schuff // Expand indirectbr instructions to switches. 448ec4be576SDerek Schuff addPass(createIndirectBrExpandPass()); 449ec4be576SDerek Schuff 45010e730a2SDan Gohman TargetPassConfig::addIRPasses(); 45110e730a2SDan Gohman } 45210e730a2SDan Gohman 453*4f9b8397SHeejin Ahn void WebAssemblyPassConfig::addISelPrepare() { 454*4f9b8397SHeejin Ahn // Lower atomics and TLS if necessary 455*4f9b8397SHeejin Ahn addPass(new CoalesceFeaturesAndStripAtomics(&getWebAssemblyTargetMachine())); 456*4f9b8397SHeejin Ahn 457*4f9b8397SHeejin Ahn // This is a no-op if atomics are not used in the module 458*4f9b8397SHeejin Ahn addPass(createAtomicExpandPass()); 459*4f9b8397SHeejin Ahn 460*4f9b8397SHeejin Ahn TargetPassConfig::addISelPrepare(); 461*4f9b8397SHeejin Ahn } 462*4f9b8397SHeejin Ahn 46310e730a2SDan Gohman bool WebAssemblyPassConfig::addInstSelector() { 464b0921ca9SDan Gohman (void)TargetPassConfig::addInstSelector(); 46510e730a2SDan Gohman addPass( 46610e730a2SDan Gohman createWebAssemblyISelDag(getWebAssemblyTargetMachine(), getOptLevel())); 4671cf96c0cSDan Gohman // Run the argument-move pass immediately after the ScheduleDAG scheduler 4681cf96c0cSDan Gohman // so that we can fix up the ARGUMENT instructions before anything else 4691cf96c0cSDan Gohman // sees them in the wrong place. 4701cf96c0cSDan Gohman addPass(createWebAssemblyArgumentMove()); 471bb372243SDan Gohman // Set the p2align operands. This information is present during ISel, however 472bb372243SDan Gohman // it's inconvenient to collect. Collect it now, and update the immediate 473bb372243SDan Gohman // operands. 474bb372243SDan Gohman addPass(createWebAssemblySetP2AlignOperands()); 4757f50c15bSThomas Lively 4767f50c15bSThomas Lively // Eliminate range checks and add default targets to br_table instructions. 4777f50c15bSThomas Lively addPass(createWebAssemblyFixBrTableDefaults()); 4787f50c15bSThomas Lively 47910e730a2SDan Gohman return false; 48010e730a2SDan Gohman } 48110e730a2SDan Gohman 482600aee98SJF Bastien void WebAssemblyPassConfig::addPostRegAlloc() { 4839c54d3b4SDan Gohman // TODO: The following CodeGen passes don't currently support code containing 4849c54d3b4SDan Gohman // virtual registers. Consider removing their restrictions and re-enabling 4859c54d3b4SDan Gohman // them. 486ad154c83SDerek Schuff 4871eb47368SMatthias Braun // These functions all require the NoVRegs property. 488600aee98SJF Bastien disablePass(&MachineCopyPropagationID); 4897ab1b32bSJun Bum Lim disablePass(&PostRAMachineSinkingID); 490ecabac62SDerek Schuff disablePass(&PostRASchedulerID); 491ecabac62SDerek Schuff disablePass(&FuncletLayoutID); 492ecabac62SDerek Schuff disablePass(&StackMapLivenessID); 493ecabac62SDerek Schuff disablePass(&LiveDebugValuesID); 494fe71ec77SSanjoy Das disablePass(&PatchableFunctionID); 4957ab1b32bSJun Bum Lim disablePass(&ShrinkWrapID); 496950a13cfSDan Gohman 497ef9d6aeaSHeejin Ahn // This pass hurts code size for wasm because it can generate irreducible 498ef9d6aeaSHeejin Ahn // control flow. 499ef9d6aeaSHeejin Ahn disablePass(&MachineBlockPlacementID); 500ef9d6aeaSHeejin Ahn 501b0921ca9SDan Gohman TargetPassConfig::addPostRegAlloc(); 502600aee98SJF Bastien } 50310e730a2SDan Gohman 504950a13cfSDan Gohman void WebAssemblyPassConfig::addPreEmitPass() { 505b0921ca9SDan Gohman TargetPassConfig::addPreEmitPass(); 506b0921ca9SDan Gohman 507a64ebb86SHeejin Ahn // Nullify DBG_VALUE_LISTs that we cannot handle. 508a64ebb86SHeejin Ahn addPass(createWebAssemblyNullifyDebugValueLists()); 509a64ebb86SHeejin Ahn 510e95056d6SHeejin Ahn // Eliminate multiple-entry loops. 511e95056d6SHeejin Ahn addPass(createWebAssemblyFixIrreducibleControlFlow()); 512e95056d6SHeejin Ahn 513e95056d6SHeejin Ahn // Do various transformations for exception handling. 514d6f48786SHeejin Ahn // Every CFG-changing optimizations should come before this. 5159e4eadebSHeejin Ahn if (TM->Options.ExceptionModel == ExceptionHandling::Wasm) 516e95056d6SHeejin Ahn addPass(createWebAssemblyLateEHPrepare()); 517e95056d6SHeejin Ahn 5180bb98650SHeejin Ahn // Now that we have a prologue and epilogue and all frame indices are 5190bb98650SHeejin Ahn // rewritten, eliminate SP and FP. This allows them to be stackified, 5200bb98650SHeejin Ahn // colored, and numbered with the rest of the registers. 5210bb98650SHeejin Ahn addPass(createWebAssemblyReplacePhysRegs()); 5220bb98650SHeejin Ahn 523d6f48786SHeejin Ahn // Preparations and optimizations related to register stackification. 5240cfb5f85SDan Gohman if (getOptLevel() != CodeGenOpt::None) { 5250cfb5f85SDan Gohman // LiveIntervals isn't commonly run this late. Re-establish preconditions. 5260cfb5f85SDan Gohman addPass(createWebAssemblyPrepareForLiveIntervals()); 5270cfb5f85SDan Gohman 5280cfb5f85SDan Gohman // Depend on LiveIntervals and perform some optimizations on it. 5290cfb5f85SDan Gohman addPass(createWebAssemblyOptimizeLiveIntervals()); 5300cfb5f85SDan Gohman 531321d5220SHeejin Ahn // Prepare memory intrinsic calls for register stackifying. 532321d5220SHeejin Ahn addPass(createWebAssemblyMemIntrinsicResults()); 5330cfb5f85SDan Gohman 534e040533eSDan Gohman // Mark registers as representing wasm's value stack. This is a key 5350cfb5f85SDan Gohman // code-compression technique in WebAssembly. We run this pass (and 536321d5220SHeejin Ahn // MemIntrinsicResults above) very late, so that it sees as much code as 537321d5220SHeejin Ahn // possible, including code emitted by PEI and expanded by late tail 538321d5220SHeejin Ahn // duplication. 5390cfb5f85SDan Gohman addPass(createWebAssemblyRegStackify()); 5400cfb5f85SDan Gohman 5410cfb5f85SDan Gohman // Run the register coloring pass to reduce the total number of registers. 5420cfb5f85SDan Gohman // This runs after stackification so that it doesn't consider registers 5430cfb5f85SDan Gohman // that become stackified. 5440cfb5f85SDan Gohman addPass(createWebAssemblyRegColoring()); 5450cfb5f85SDan Gohman } 5460cfb5f85SDan Gohman 547f52ee17aSDan Gohman // Sort the blocks of the CFG into topological order, a prerequisite for 548f52ee17aSDan Gohman // BLOCK and LOOP markers. 549f52ee17aSDan Gohman addPass(createWebAssemblyCFGSort()); 550f52ee17aSDan Gohman 551f52ee17aSDan Gohman // Insert BLOCK and LOOP markers. 552950a13cfSDan Gohman addPass(createWebAssemblyCFGStackify()); 5535941bde0SDan Gohman 554e9fd9073SHeejin Ahn // Insert explicit local.get and local.set operators. 5552b7fe086SWouter van Oortmerssen if (!WasmDisableExplicitLocals) 556e9fd9073SHeejin Ahn addPass(createWebAssemblyExplicitLocals()); 557e9fd9073SHeejin Ahn 558f0b165a7SDan Gohman // Lower br_unless into br_if. 559f0b165a7SDan Gohman addPass(createWebAssemblyLowerBrUnless()); 560f0b165a7SDan Gohman 5615941bde0SDan Gohman // Perform the very last peephole optimizations on the code. 562b13c91f1SDan Gohman if (getOptLevel() != CodeGenOpt::None) 56381719f85SDan Gohman addPass(createWebAssemblyPeephole()); 564b7c2400fSDan Gohman 565b7c2400fSDan Gohman // Create a mapping from LLVM CodeGen virtual registers to wasm registers. 566b7c2400fSDan Gohman addPass(createWebAssemblyRegNumbering()); 5672b7fe086SWouter van Oortmerssen 5682b7fe086SWouter van Oortmerssen // Fix debug_values whose defs have been stackified. 5692b7fe086SWouter van Oortmerssen if (!WasmDisableExplicitLocals) 5702b7fe086SWouter van Oortmerssen addPass(createWebAssemblyDebugFixup()); 5719647a6f7SWouter van Oortmerssen 5729647a6f7SWouter van Oortmerssen // Collect information to prepare for MC lowering / asm printing. 5739647a6f7SWouter van Oortmerssen addPass(createWebAssemblyMCLowerPrePass()); 574950a13cfSDan Gohman } 57552221d56SHeejin Ahn 576d3a0a65bSPaulo Matos bool WebAssemblyPassConfig::addPreISel() { 577d3a0a65bSPaulo Matos TargetPassConfig::addPreISel(); 578d3a0a65bSPaulo Matos addPass(createWebAssemblyLowerRefTypesIntPtrConv()); 579d3a0a65bSPaulo Matos return false; 580d3a0a65bSPaulo Matos } 581d3a0a65bSPaulo Matos 58252221d56SHeejin Ahn yaml::MachineFunctionInfo * 58352221d56SHeejin Ahn WebAssemblyTargetMachine::createDefaultFuncInfoYAML() const { 58452221d56SHeejin Ahn return new yaml::WebAssemblyFunctionInfo(); 58552221d56SHeejin Ahn } 58652221d56SHeejin Ahn 58752221d56SHeejin Ahn yaml::MachineFunctionInfo *WebAssemblyTargetMachine::convertFuncInfoToYAML( 58852221d56SHeejin Ahn const MachineFunction &MF) const { 58952221d56SHeejin Ahn const auto *MFI = MF.getInfo<WebAssemblyFunctionInfo>(); 59052221d56SHeejin Ahn return new yaml::WebAssemblyFunctionInfo(*MFI); 59152221d56SHeejin Ahn } 59252221d56SHeejin Ahn 59352221d56SHeejin Ahn bool WebAssemblyTargetMachine::parseMachineFunctionInfo( 59452221d56SHeejin Ahn const yaml::MachineFunctionInfo &MFI, PerFunctionMIParsingState &PFS, 59552221d56SHeejin Ahn SMDiagnostic &Error, SMRange &SourceRange) const { 59652221d56SHeejin Ahn const auto &YamlMFI = 59752221d56SHeejin Ahn reinterpret_cast<const yaml::WebAssemblyFunctionInfo &>(MFI); 59852221d56SHeejin Ahn MachineFunction &MF = PFS.MF; 59952221d56SHeejin Ahn MF.getInfo<WebAssemblyFunctionInfo>()->initializeBaseYamlFields(YamlMFI); 60052221d56SHeejin Ahn return false; 60152221d56SHeejin Ahn } 602