Create performance measurement framework

[maxfierrog]

Create an ergonomic framework to benchmark and profile hot modules in the project. See the performance book for direction.

While this is not exactly difficult, it will take a tasteful implementation to make it useful. This includes thinking about module organization and CI integration (e.g., for regression testing).

Example

Below is an example of a benchmark function using an imaginary benchmarking framework module Benchmark:

fn solve_bench() -> Result<()> {
  let _time = Benchmark::record_time();
  solve(game);
  ...
}

Here, _time could implement Drop, and record the time difference between its instantiation and going out of scope and record it in a log file in the /dev directory for the sake of ergonomics.

This might not be the best example (since cargo bench already provides timing output), but there are plenty of useful things to try here.

Recommended Courses (UC Berkeley)

We recommend experience with testing frameworks and a mature taste in developer tooling, which university courses unfortunately do not usually teach. Beyond that:

• CS 61B (minimum)