Add support for running LLVM optimizer. (#6225)

Adds a flag `--optimize=<mode>` that specifies what to optimize for:

* `--optimize=none` turns off the optimizer as much as possible, but
still respects always_inline.
* `--optimize=debug` aims to be the equivalent of `-Og` / `-O1`, and
provides optimizations that don't affect the ability to debug the
program. This is the default.
* `--optimize=size` optimizes for the size of the produced program, and
aims to be the equivalent of `-Oz`.
* `--optimize=speed` optimizes for the execution time of the produced
program, and aims to be the equivalent of `-O3`.

Following the approach taken by Clang, the optimization level feeds into
both the configuration of the LLVM pass pipeline and the attributes
added to function definitions generated by the frontend.

Optimization is performed in a new phase, `optimize`, which runs between
`lower` and `codegen`.

---------

Co-authored-by: Dana Jansens <[email protected]>
Co-authored-by: Chandler Carruth <[email protected]>

Author: 3 people

toolchain/autoupdate_testdata.py

@@ -51,10 +51,10 @@ def main() -> None:
     args = parser.parse_args()
 
     if args.non_fatal_checks:
-        if build_mode == "opt":
+        if build_mode == "optimize":
             exit(
                 "`--non-fatal-checks` is incompatible with inferred "
-                "`-c opt` build mode"
+                "`-c optimize` build mode"
             )
         configs.append("--config=non-fatal-checks")
 

toolchain/check/testdata/interop/cpp/function/thunk_ast.carbon

@@ -64,7 +64,7 @@ auto foo(short a) -> void;
 // CHECK:STDOUT: | |-ParmVarDecl {{0x[a-f0-9]+}} <<invalid sloc>> <invalid sloc> implicit 'std::align_val_t'
 // CHECK:STDOUT: | `-VisibilityAttr {{0x[a-f0-9]+}} <<invalid sloc>> Implicit Default
 // CHECK:STDOUT: |-FunctionDecl {{0x[a-f0-9]+}} <<carbon-internal>:8:1, line:14:1> line:8:7 operator new 'void *(unsigned long, void *) noexcept'
-// CHECK:STDOUT: | |-ParmVarDecl {{0x[a-f0-9]+}} <<built-in>:173:23, col:37> <carbon-internal>:8:33 'unsigned long'
+// CHECK:STDOUT: | |-ParmVarDecl {{0x[a-f0-9]+}} <<built-in>:174:23, col:37> <carbon-internal>:8:33 'unsigned long'
 // CHECK:STDOUT: | `-ParmVarDecl {{0x[a-f0-9]+}} <col:35, col:39> col:40 'void *'
 // CHECK:STDOUT: `-FunctionDecl {{0x[a-f0-9]+}} <./thunk_required.h:[[@LINE-51]]:6> col:6 foo__carbon_thunk 'void (short * _Nonnull)' extern
 // CHECK:STDOUT:   |-ParmVarDecl {{0x[a-f0-9]+}} <col:6> col:6 used a 'short * _Nonnull':'short *'

toolchain/codegen/codegen.cpp

@@ -17,27 +17,6 @@
 
 namespace Carbon {
 
-auto CodeGen::Make(llvm::Module* module, llvm::StringRef target_triple_str,
-                   Diagnostics::Consumer* consumer) -> std::optional<CodeGen> {
-  llvm::Triple target_triple(target_triple_str);
-  std::string error;
-  const llvm::Target* target =
-      llvm::TargetRegistry::lookupTarget(target_triple, error);
-  CARBON_CHECK(target, "Target should be validated before codegen: {0}", error);
-
-  module->setTargetTriple(target_triple);
-
-  constexpr llvm::StringLiteral CPU = "generic";
-  constexpr llvm::StringLiteral Features = "";
-
-  llvm::TargetOptions target_opts;
-  CodeGen codegen(module,
-                  consumer ? consumer : &Diagnostics::ConsoleConsumer());
-  codegen.target_machine_.reset(target->createTargetMachine(
-      target_triple, CPU, Features, target_opts, llvm::Reloc::PIC_));
-  return codegen;
-}
-
 auto CodeGen::EmitAssembly(llvm::raw_pwrite_stream& out) -> bool {
   return EmitCode(out, llvm::CodeGenFileType::AssemblyFile);
 }

toolchain/codegen/codegen.h

@@ -14,11 +14,10 @@ namespace Carbon {
 
 class CodeGen {
  public:
-  // `module` and `errors` must not be null. `consumer` may be null, in which
-  // case diagnostics go to stderr.
-  static auto Make(llvm::Module* module, llvm::StringRef target_triple_str,
-                   Diagnostics::Consumer* consumer = nullptr)
-      -> std::optional<CodeGen>;
+  // `module`, `target_machine`, and `consumer` must not be null.
+  explicit CodeGen(llvm::Module* module, llvm::TargetMachine* target_machine,
+                   Diagnostics::Consumer* consumer)
+      : module_(module), target_machine_(target_machine), emitter_(consumer) {}
 
   // Generates the object code file.
   // Returns false in case of failure, and any information about the failure is
@@ -35,10 +34,6 @@ class CodeGen {
   auto EmitAssembly(llvm::raw_pwrite_stream& out) -> bool;
 
  private:
-  // `module` and `consumer` must not be null.
-  explicit CodeGen(llvm::Module* module, Diagnostics::Consumer* consumer)
-      : module_(module), emitter_(consumer) {}
-
   // Using the llvm pass emits either assembly or object code to dest.
   // Returns false in case of failure, and any information about the failure is
   // printed to the error stream.
@@ -47,10 +42,10 @@ class CodeGen {
 
   llvm::Module* module_;
 
+  llvm::TargetMachine* target_machine_;
+
   // The emitter for diagnostics.
   Diagnostics::FileEmitter emitter_;
-
-  std::unique_ptr<llvm::TargetMachine> target_machine_;
 };
 
 }  // namespace Carbon

toolchain/driver/BUILD

@@ -155,13 +155,15 @@ cc_library(
         "//toolchain/language_server",
         "//toolchain/lex",
         "//toolchain/lower",
+        "//toolchain/lower:options",
         "//toolchain/parse",
         "//toolchain/parse:tree",
         "//toolchain/sem_ir:file",
         "//toolchain/sem_ir:typed_insts",
         "//toolchain/source:source_buffer",
         "@llvm-project//llvm:Core",
         "@llvm-project//llvm:MC",
+        "@llvm-project//llvm:Passes",
         "@llvm-project//llvm:Support",
         "@llvm-project//llvm:TargetParser",
     ],