Files
carbon-lang/toolchain/driver/compile_subcommand.h
T
Sam EstepandJon Ross-Perkins e0e305536e Collect timing data per unit for each phase (#4512)
This PR adds a `--dump-timings` flag to the `compile` subcommand
(similar to the existing `--dump-mem-usage` flag), which collects timing
data per compilation unit for each compilation phase. For example, on my
2020 M1 MacBook:

```
$ bazel build -c opt //toolchain
$ bazel-bin/toolchain/install/run_carbon compile --phase=lower --dump-timings examples/sieve.carbon | tail
...
---
filename:        'examples/sieve.carbon'
nanoseconds:
  lex:             30792
  parse:           25458
  check:           226625
  lower:           1136958
  Total:           1419833
...
```

Most of the changes are pretty straightforward. There were a couple I
wasn't sure about though; let me know if I should change:

- new `Timings` class in its own file, pretty similar to the existing
`MemUsage` class
- added a `timings_` field to the `CompilationUnit` class
- added a `timings` field to the `Check::Unit` struct
- renamed `CheckParseTree` function to `CheckParseTreeInner` for ease of
timing with early `return`

---------

Co-authored-by: Jon Ross-Perkins <jperkins@google.com>
2024-11-12 20:47:08 +00:00

86 lines
2.3 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#ifndef CARBON_TOOLCHAIN_DRIVER_COMPILE_SUBCOMMAND_H_
#define CARBON_TOOLCHAIN_DRIVER_COMPILE_SUBCOMMAND_H_
#include "common/command_line.h"
#include "common/ostream.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "toolchain/driver/codegen_options.h"
#include "toolchain/driver/driver_env.h"
#include "toolchain/driver/driver_subcommand.h"
namespace Carbon {
// Options for the compile subcommand.
//
// See the implementation of `Build` for documentation on members.
struct CompileOptions {
enum class Phase : int8_t {
Lex,
Parse,
Check,
Lower,
CodeGen,
};
friend auto operator<<(llvm::raw_ostream& out, Phase phase)
-> llvm::raw_ostream&;
auto Build(CommandLine::CommandBuilder& b) -> void;
CodegenOptions codegen_options;
Phase phase;
llvm::StringRef output_filename;
llvm::SmallVector<llvm::StringRef> input_filenames;
bool asm_output = false;
bool force_obj_output = false;
bool dump_shared_values = false;
bool dump_tokens = false;
bool omit_file_boundary_tokens = false;
bool dump_parse_tree = false;
bool dump_raw_sem_ir = false;
bool dump_sem_ir = false;
bool dump_llvm_ir = false;
bool dump_asm = false;
bool dump_mem_usage = false;
bool dump_timings = false;
bool include_diagnostic_kind = false;
bool stream_errors = false;
bool preorder_parse_tree = false;
bool builtin_sem_ir = false;
bool prelude_import = false;
bool include_debug_info = true;
llvm::StringRef exclude_dump_file_prefix;
};
// Implements the compile subcommand of the driver.
class CompileSubcommand : public DriverSubcommand {
public:
explicit CompileSubcommand();
auto BuildOptions(CommandLine::CommandBuilder& b) -> void override {
options_.Build(b);
}
auto Run(DriverEnv& driver_env) -> DriverResult override;
private:
// Does custom validation of the compile-subcommand options structure beyond
// what the command line parsing library supports.
auto ValidateOptions(DriverEnv& driver_env) const -> bool;
CompileOptions options_;
};
} // namespace Carbon
#endif // CARBON_TOOLCHAIN_DRIVER_COMPILE_SUBCOMMAND_H_