Merge pull request #114 from frasercrmck/clear-up-multi-llvm

[compiler] Reduce uses of multi_llvm

Author: frasercrmck

doc/overview/tutorials/creating-a-new-mux-target/adapting-target-pass-pipeline.rst

@@ -90,7 +90,6 @@ This will need the following includes and settings:
     #include <compiler/utils/metadata.h>
     #include <compiler/utils/pass_functions.h>
     #include <llvm/IR/IRBuilder.h>
-    #include <multi_llvm/opaque_pointers.h>
     #include <compiler/utils/scheduling.h>
     using namespace llvm;
 

examples/refsi/refsi_g1_wi/compiler/refsi_g1_wi/source/refsi_pass_machinery.cpp

@@ -31,7 +31,6 @@
 #include <llvm/Passes/PassBuilder.h>
 #include <llvm/Transforms/Utils/Cloning.h>
 #include <metadata/handler/vectorize_info_metadata.h>
-#include <multi_llvm/optional_helper.h>
 #include <refsi_g1_wi/refsi_pass_machinery.h>
 #include <refsi_g1_wi/refsi_wg_loop_pass.h>
 #include <riscv/ir_to_builtins_pass.h>

examples/refsi/refsi_m1/compiler/refsi_m1/source/refsi_mux_builtin_info.cpp

@@ -18,7 +18,6 @@
 #include <llvm/ADT/StringSwitch.h>
 #include <llvm/IR/Operator.h>
 #include <multi_llvm/llvm_version.h>
-#include <multi_llvm/opaque_pointers.h>
 #include <refsi_m1/refsi_mux_builtin_info.h>
 
 #include <cstdint>
@@ -356,9 +355,6 @@ void defineRefSiDmaWait(Function &F) {
     auto *CoreDMAEventTy =
         compiler::utils::getOrCreateMuxDMAEventType(*F.getParent());
     auto *EventPtrTy = CoreDMAEventTy->getPointerTo();
-    assert(multi_llvm::isOpaqueOrPointeeTypeMatches(
-               cast<PointerType>(EventList->getType()), EventPtrTy) &&
-           "__mux_dma_wait() parameter expected to be __mux_dma_event_t**");
     auto *EventGep = BodyBuilder.CreateGEP(EventPtrTy, EventList, LoopIVPhi);
     auto *Event = BodyBuilder.CreateLoad(EventPtrTy, EventGep);
     auto *EventID = BodyBuilder.CreatePtrToInt(Event, XferIdTy, "xfer_id");

examples/refsi/refsi_m1/compiler/refsi_m1/source/refsi_pass_machinery.cpp

@@ -32,7 +32,6 @@
 #include <llvm/Passes/PassBuilder.h>
 #include <llvm/Transforms/Utils/Cloning.h>
 #include <metadata/handler/vectorize_info_metadata.h>
-#include <multi_llvm/optional_helper.h>
 #include <refsi_m1/refsi_pass_machinery.h>
 #include <refsi_m1/refsi_wrapper_pass.h>
 #include <riscv/ir_to_builtins_pass.h>

examples/refsi/refsi_m1/compiler/refsi_m1/source/refsi_wrapper_pass.cpp

@@ -18,7 +18,6 @@
 #include <compiler/utils/pass_functions.h>
 #include <compiler/utils/scheduling.h>
 #include <llvm/IR/IRBuilder.h>
-#include <multi_llvm/opaque_pointers.h>
 #include <refsi_m1/refsi_wrapper_pass.h>
 
 using namespace llvm;
@@ -36,9 +35,7 @@ namespace {
 void storeToSchedStruct(IRBuilder<> &Builder, StructType *MuxWorkGroupStructTy,
                         Value *Sched, uint32_t Element, uint32_t Index,
                         Value *Val) {
-  assert(Sched->getType()->isPointerTy() &&
-         multi_llvm::isOpaqueOrPointeeTypeMatches(
-             cast<PointerType>(Sched->getType()), MuxWorkGroupStructTy));
+  assert(Sched->getType()->isPointerTy());
 
   Value *IndicesArray[3] = {Builder.getInt32(0), Builder.getInt32(Element),
                             Builder.getInt32(Index)};
@@ -69,9 +66,7 @@ void storeToSchedStruct(IRBuilder<> &Builder, StructType *MuxWorkGroupStructTy,
 Value *loadFromSchedStruct(IRBuilder<> &Builder,
                            StructType *MuxWorkGroupStructTy, Value *Sched,
                            uint32_t Element, uint32_t Index) {
-  assert(Sched->getType()->isPointerTy() &&
-         multi_llvm::isOpaqueOrPointeeTypeMatches(
-             cast<PointerType>(Sched->getType()), MuxWorkGroupStructTy));
+  assert(Sched->getType()->isPointerTy());
   Value *IndicesArray[3] = {Builder.getInt32(0), Builder.getInt32(Element),
                             Builder.getInt32(Index)};
   // Check if it's an array type

modules/compiler/cookie/{{cookiecutter.target_name}}/source/module.cpp

@@ -32,7 +32,6 @@
 #include <llvm/Support/Process.h>
 #include <llvm/Target/TargetMachine.h>
 #include <multi_llvm/multi_llvm.h>
-#include <multi_llvm/optional_helper.h>
 #include <{{cookiecutter.target_name}}/module.h>
 #include <{{cookiecutter.target_name}}/target.h>
 #include <vecz/pass.h>

modules/compiler/cookie/{{cookiecutter.target_name}}/source/{{cookiecutter.target_name}}_pass_machinery.cpp

@@ -39,7 +39,6 @@
 #include <llvm/Passes/PassBuilder.h>
 #include <llvm/Transforms/Utils/Cloning.h>
 #include <metadata/handler/vectorize_info_metadata.h>
-#include <multi_llvm/optional_helper.h>
 #include <optional>
 #include <vecz/pass.h>
 // Add our pass machinery

modules/compiler/multi_llvm/include/multi_llvm/opaque_pointers.h

@@ -31,7 +31,6 @@
 #include <llvm/Support/Process.h>
 #include <llvm/Target/TargetMachine.h>
 #include <multi_llvm/multi_llvm.h>
-#include <multi_llvm/optional_helper.h>
 #include <riscv/ir_to_builtins_pass.h>
 #include <riscv/module.h>
 #include <riscv/riscv_pass_machinery.h>

modules/compiler/riscv/source/module.cpp

@@ -33,7 +33,6 @@
 #include <llvm/Passes/PassBuilder.h>
 #include <llvm/Transforms/Utils/Cloning.h>
 #include <metadata/handler/vectorize_info_metadata.h>
-#include <multi_llvm/optional_helper.h>
 #include <riscv/ir_to_builtins_pass.h>
 #include <riscv/riscv_pass_machinery.h>
 

modules/compiler/riscv/source/riscv_pass_machinery.cpp

@@ -41,7 +41,7 @@ class BaseModulePassMachinery : public compiler::utils::PassMachinery {
  public:
   BaseModulePassMachinery(
       llvm::LLVMContext &Ctx, llvm::TargetMachine *TM,
-      multi_llvm::Optional<compiler::utils::DeviceInfo> Info,
+      std::optional<compiler::utils::DeviceInfo> Info,
       compiler::utils::BuiltinInfoAnalysis::CallbackFn BICallback,
       bool verifyEach, compiler::utils::DebugLogging debugLogging,
       bool timePasses)
@@ -75,7 +75,7 @@ class BaseModulePassMachinery : public compiler::utils::PassMachinery {
 
   /// @brief Device-specific information about the ComputeMux target being
   /// compiled for.
-  multi_llvm::Optional<compiler::utils::DeviceInfo> Info;
+  std::optional<compiler::utils::DeviceInfo> Info;
 
   /// @brief An optional callback function that provides target-specific
   /// BuiltinInfo information to supply to the BuiltinInfoAnalysis analysis

modules/compiler/source/base/include/base/base_module_pass_machinery.h

@@ -37,10 +37,10 @@
 #include <compiler/module.h>
 #include <compiler/utils/pass_machinery.h>
 #include <llvm/IR/PassManager.h>
-#include <multi_llvm/optional_helper.h>
 #include <mux/mux.hpp>
 
 #include <mutex>
+#include <optional>
 
 namespace compiler {
 
@@ -489,10 +489,8 @@ class BaseModule : public Module {
   /// @param[in] late_passes Module pass manager populated with late passes.
   void runOpenCLFrontendPipeline(
       const clang::CodeGenOptions &codeGenOpts,
-      multi_llvm::Optional<llvm::ModulePassManager> early_passes =
-          multi_llvm::None,
-      multi_llvm::Optional<llvm::ModulePassManager> late_passes =
-          multi_llvm::None);
+      std::optional<llvm::ModulePassManager> early_passes = std::nullopt,
+      std::optional<llvm::ModulePassManager> late_passes = std::nullopt);
 
   /// @brief LLVM module produced by the `Module::finalize` method.
   std::unique_ptr<llvm::Module> finalized_llvm_module;

modules/compiler/source/base/include/base/module.h

@@ -24,7 +24,8 @@
 #include <compiler/module.h>
 #include <llvm/IR/CallingConv.h>
 #include <llvm/IR/PassManager.h>
-#include <multi_llvm/optional_helper.h>
+
+#include <optional>
 
 namespace llvm {
 class Module;
@@ -105,8 +106,7 @@ Result emitCodeGenFile(llvm::Module &M, llvm::TargetMachine *TM,
                        bool create_assembly = false);
 
 void encodeVectorizationMode(llvm::Function &, VectorizationMode);
-multi_llvm::Optional<VectorizationMode> getVectorizationMode(
-    const llvm::Function &);
+std::optional<VectorizationMode> getVectorizationMode(const llvm::Function &);
 
 }  // namespace compiler
 

modules/compiler/source/base/include/base/pass_pipelines.h

@@ -22,6 +22,7 @@
 #include <llvm/IR/IRBuilder.h>
 #include <llvm/IR/Instructions.h>
 #include <llvm/IR/Module.h>
+#include <multi_llvm/llvm_version.h>
 
 #include <map>
 

modules/compiler/source/base/source/image_argument_substitution_pass.cpp

@@ -89,7 +89,6 @@
 #include <llvm/Transforms/Vectorize/SLPVectorizer.h>
 #include <multi_llvm/llvm_version.h>
 #include <multi_llvm/multi_llvm.h>
-#include <multi_llvm/optional_helper.h>
 #include <multi_llvm/triple.h>
 #include <mux/mux.hpp>
 #include <spirv-ll/module.h>
@@ -117,7 +116,7 @@ namespace {
 // changed around; not a big deal, just a few ugly ifdefs
 inline llvm::ModulePassManager buildPerModuleDefaultPipeline(
     llvm::PassBuilder &PB, llvm::OptimizationLevel OL,
-    multi_llvm::Optional<llvm::ModulePassManager> EP) {
+    std::optional<llvm::ModulePassManager> EP) {
   assert(OL != llvm::OptimizationLevel::O0);
   if (EP.has_value()) {
     PB.registerPipelineStartEPCallback(
@@ -134,7 +133,7 @@ inline llvm::ModulePassManager buildPerModuleDefaultPipeline(
 }
 
 inline llvm::ModulePassManager buildO0DefaultPipeline(
-    llvm::PassBuilder &PB, multi_llvm::Optional<llvm::ModulePassManager> EP) {
+    llvm::PassBuilder &PB, std::optional<llvm::ModulePassManager> EP) {
   if (EP.has_value()) {
     PB.registerPipelineStartEPCallback(
         [&EP](llvm::ModulePassManager &MPM, llvm::OptimizationLevel) {
@@ -146,7 +145,7 @@ inline llvm::ModulePassManager buildO0DefaultPipeline(
 
 inline llvm::ModulePassManager buildPipeline(
     llvm::PassBuilder &PB, clang::CodeGenOptions Opts,
-    multi_llvm::Optional<llvm::ModulePassManager> EP) {
+    std::optional<llvm::ModulePassManager> EP) {
   return Opts.OptimizationLevel == 0
              ? buildO0DefaultPipeline(PB, std::move(EP))
              : buildPerModuleDefaultPipeline(PB, llvm::OptimizationLevel::O3,
@@ -166,8 +165,8 @@ inline llvm::ModulePassManager buildPipeline(
 void runFrontendPipeline(
     compiler::BaseModule &base_module, llvm::Module &module,
     const clang::CodeGenOptions &CGO,
-    multi_llvm::Optional<llvm::ModulePassManager> EP = multi_llvm::None,
-    multi_llvm::Optional<llvm::ModulePassManager> LP = multi_llvm::None) {
+    std::optional<llvm::ModulePassManager> EP = std::nullopt,
+    std::optional<llvm::ModulePassManager> LP = std::nullopt) {
   llvm::PipelineTuningOptions PTO;
   PTO.LoopUnrolling = CGO.UnrollLoops;
   auto PassMach = base_module.createPassMachinery();
@@ -1355,8 +1354,8 @@ void BaseModule::loadBuiltinsPCH(clang::CompilerInstance &instance) {
 
 void BaseModule::runOpenCLFrontendPipeline(
     const clang::CodeGenOptions &codeGenOpts,
-    multi_llvm::Optional<llvm::ModulePassManager> early_passes,
-    multi_llvm::Optional<llvm::ModulePassManager> late_passes) {
+    std::optional<llvm::ModulePassManager> early_passes,
+    std::optional<llvm::ModulePassManager> late_passes) {
   if (options.fast_math) {
     if (late_passes.has_value()) {
       late_passes->addPass(FastMathPass());
@@ -2059,7 +2058,7 @@ void BaseModule::populateOpenCLOpts(clang::CompilerInstance &instance,
 std::unique_ptr<compiler::utils::PassMachinery>
 BaseModule::createPassMachinery() {
   return std::make_unique<BaseModulePassMachinery>(
-      llvm_module->getContext(), /*TM*/ nullptr, /*Info*/ multi_llvm::None,
+      llvm_module->getContext(), /*TM*/ nullptr, /*Info*/ std::nullopt,
       /*BICallback*/ nullptr, target.getContext().isLLVMVerifyEachEnabled(),
       target.getContext().getLLVMDebugLoggingLevel(),
       target.getContext().isLLVMTimePassesEnabled());

modules/compiler/source/base/source/module.cpp

@@ -36,7 +36,8 @@
 #include <llvm/Transforms/IPO/GlobalOpt.h>
 #include <llvm/Transforms/IPO/Inliner.h>
 #include <llvm/Transforms/IPO/Internalize.h>
-#include <multi_llvm/optional_helper.h>
+
+#include <optional>
 
 using namespace llvm;
 
@@ -125,8 +126,7 @@ void addLLVMDefaultPerModulePipeline(ModulePassManager &PM, PassBuilder &PB,
 Result emitCodeGenFile(llvm::Module &M, TargetMachine *TM,
                        raw_pwrite_stream &ostream, bool create_assembly) {
   legacy::PassManager PM;
-  CodeGenFileType type =
-      !create_assembly ? llvm::CGFT_ObjectFile : llvm::CGFT_AssemblyFile;
+  CodeGenFileType type = !create_assembly ? CGFT_ObjectFile : CGFT_AssemblyFile;
   if (TM->addPassesToEmitFile(PM, ostream, /*DwoOut*/ nullptr, type,
                               /*DisableVerify*/ false)) {
     return compiler::Result::FAILURE;
@@ -135,7 +135,7 @@ Result emitCodeGenFile(llvm::Module &M, TargetMachine *TM,
   return compiler::Result::SUCCESS;
 }
 
-void encodeVectorizationMode(llvm::Function &F, VectorizationMode mode) {
+void encodeVectorizationMode(Function &F, VectorizationMode mode) {
   switch (mode) {
     case VectorizationMode::AUTO:
       F.addFnAttr("vecz-mode", "auto");
@@ -149,18 +149,17 @@ void encodeVectorizationMode(llvm::Function &F, VectorizationMode mode) {
   }
 }
 
-multi_llvm::Optional<VectorizationMode> getVectorizationMode(
-    const llvm::Function &F) {
-  llvm::Attribute Attr = F.getFnAttribute("vecz-mode");
+std::optional<VectorizationMode> getVectorizationMode(const Function &F) {
+  Attribute Attr = F.getFnAttribute("vecz-mode");
   if (Attr.isValid()) {
-    return StringSwitch<multi_llvm::Optional<VectorizationMode>>(
+    return StringSwitch<std::optional<VectorizationMode>>(
                Attr.getValueAsString())
         .Case("auto", VectorizationMode::AUTO)
         .Case("always", VectorizationMode::ALWAYS)
         .Case("never", VectorizationMode::NEVER)
-        .Default(multi_llvm::None);
+        .Default(std::nullopt);
   }
-  return multi_llvm::None;
+  return std::nullopt;
 }
 
 }  // namespace compiler

modules/compiler/source/base/source/pass_pipelines.cpp

@@ -30,7 +30,6 @@
 #include <llvm/IR/Module.h>
 #include <llvm/IR/Type.h>
 #include <llvm/Support/FormatVariadic.h>
-#include <multi_llvm/opaque_pointers.h>
 #include <multi_llvm/vector_type_helper.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -660,10 +659,7 @@ void compiler::PrintfReplacementPass::rewritePrintfCall(
   auto *buffer_elt_ty = getBufferEltTy(module.getContext());
 
   // Double-check the buffer is the type we expect, unless it's opaque.
-  assert(isa<PointerType>(full_buffer->getType()) &&
-         multi_llvm::isOpaqueOrPointeeTypeMatches(
-             cast<PointerType>(full_buffer->getType()), buffer_elt_ty) &&
-         "Unknown buffer type");
+  assert(full_buffer->getType()->isPointerTy() && "Unknown buffer type");
 
   // entry block
   ir.SetInsertPoint(entry_block);

modules/compiler/source/base/source/printf_replacement_pass.cpp

@@ -28,6 +28,7 @@
 #include <llvm/IR/Metadata.h>
 #include <llvm/IR/Module.h>
 #include <llvm/IR/Type.h>
+#include <multi_llvm/llvm_version.h>
 #include <multi_llvm/vector_type_helper.h>
 
 #include <sstream>