[flang][driver] Use `-O{0|1|2|3}` to define LLVM backend pass pipeline

[awarzynski]

Summary

Support for optimisation flags in LLVM Flang was originally added in
https://reviews.llvm.org/D128043. That patch focused on LLVM
middle-end/optimisation pipelines. With this patch, Flang will
additionally configure LLVM backend pass pipelines accordingly. This
behavior is consistent with Clang.

New hook is added to translate compiler optimisation flags (e.g. -O3)
into backend optimisation level: getCGOptLevel. Identical hooks are
available in Clang and LLVM. In other words, the meaning of these
optimisation flags remains consistent with other sub-projects that use
LLVM backends.

Depends on D128043

[rovka]

Seems fine, thanks.

flang/lib/Frontend/FrontendActions.cpp

554–559

555

flang/test/Driver/default-backend-pipelines.f90

2

[awarzynski]

Rebase + address Diana's comments

[awarzynski]

Rebase

flang/lib/Frontend/FrontendActions.cpp

void CodeGenAction::generateLLVMIR() {
   if (!llvmModule) {
     unsigned diagID = ci.getDiagnostics().getCustomDiagID(
         clang::DiagnosticsEngine::Error, "failed to create the LLVM module");
     ci.getDiagnostics().Report(diagID);
     return;
   }
 }
 
+static llvm::CodeGenOpt::Level
+getCGOptLevel(const Fortran::frontend::CodeGenOptions &opts) {
+  switch (opts.OptimizationLevel) {
+  default:
+    llvm_unreachable("Invalid optimization level!");
+  case 0:
+    return llvm::CodeGenOpt::None;
+  case 1:
+    return llvm::CodeGenOpt::Less;
+  case 2:
+    return llvm::CodeGenOpt::Default;
+  case 3:
+    return llvm::CodeGenOpt::Aggressive;
+  }
+}
+
 void CodeGenAction::setUpTargetMachine() {
   CompilerInstance &ci = this->getInstance();
 
   // Set the triple based on the CompilerInvocation set-up
   const std::string &theTriple = ci.getInvocation().getTargetOpts().triple;
   if (llvmModule->getTargetTriple() != theTriple) {
     ci.getDiagnostics().Report(clang::diag::warn_fe_override_module)
         << theTriple;
     llvmModule->setTargetTriple(theTriple);
   }
 
   // Create `Target`
   std::string error;
   const llvm::Target *theTarget =
       llvm::TargetRegistry::lookupTarget(theTriple, error);
   assert(theTarget && "Failed to create Target");
 
   // Create `TargetMachine`
-  tm.reset(theTarget->createTargetMachine(theTriple, /*CPU=*/"",
-                                          /*Features=*/"",
-                                          llvm::TargetOptions(), llvm::None));
+  llvm::CodeGenOpt::Level OptLevel =
+      getCGOptLevel(ci.getInvocation().getCodeGenOpts());
+  tm.reset(theTarget->createTargetMachine(
+      theTriple, /*CPU=*/"",
+      /*Features=*/"", llvm::TargetOptions(), /*Reloc::Model=*/llvm::None,
+      /*CodeModel::Model=*/llvm::None, OptLevel));
   assert(tm && "Failed to create TargetMachine");
 }
 
 static std::unique_ptr<llvm::raw_pwrite_stream>
 getOutputStream(CompilerInstance &ci, llvm::StringRef inFile,
                 BackendActionTy action) {
   switch (action) {
   case BackendActionTy::Backend_EmitAssembly:

flang/test/Driver/default-backend-pipelines.f90

+! Verify that`-O{n}` is indeed taken into account when definining the LLVM backend pass pipeline.
+
+! REQUIRES: aarch64-registered-target
+
+!-----------
+! RUN LINES
+!-----------
+! RUN: %flang_fc1 -S -O2 %s -triple aarch64-unknown-linux-gnu -mllvm -debug-pass=Structure -o /dev/null 2>&1 | FileCheck %s --check-prefix=CHECK-O2
+! RUN: %flang_fc1 -S -O3 %s -triple aarch64-unknown-linux-gnu -mllvm -debug-pass=Structure -o /dev/null 2>&1 | FileCheck %s --check-prefix=CHECK-O3
+
+!-----------------------
+! EXPECTED OUTPUT
+!-----------------------
+! CHECK-O2-NOT: SVE intrinsics optimizations
+
+! CHECK-O3: SVE intrinsics optimizations
+
+!-------
+! INPUT
+!-------
+subroutine simple_loop
+  integer :: i
+  do i=1,5
+  end do
+end subroutine