tvl-depot/tvix/eval/src
Vincent Ambo d6c57eb957 refactor(tvix/eval): ensure VM operations fit in a single byte
This replaces the OpCode enum with a new Op enum which is guaranteed to fit in a
single byte. Instead of carrying enum variants with data, every variant that has
runtime data encodes it into the `Vec<u8>` that a `Chunk` now carries.

This has several advantages:

* Less stack space is required at runtime, and fewer allocations are required
  while compiling.
* The OpCode doesn't need to carry "weird" special-cased data variants anymore.
* It is faster (albeit, not by much). On my laptop, results consistently look
  approximately like this:

  Benchmark 1: ./before -E '(import <nixpkgs> {}).firefox.outPath' --log-level ERROR --no-warnings
  Time (mean ± σ):      8.224 s ±  0.272 s    [User: 7.149 s, System: 0.688 s]
  Range (min … max):    7.759 s …  8.583 s    10 runs

  Benchmark 2: ./after -E '(import <nixpkgs> {}).firefox.outPath' --log-level ERROR --no-warnings
  Time (mean ± σ):      8.000 s ±  0.198 s    [User: 7.036 s, System: 0.633 s]
  Range (min … max):    7.718 s …  8.334 s    10 runs

  See notes below for why the performance impact might be less than expected.
* It is faster while at the same time dropping some optimisations we previously
  performed.

This has several disadvantages:

* The code is closer to how one would write it in C or Go.
* Bit shifting!
* There is (for now) slightly more code than before.

On performance I have the following thoughts at the moment:

In order to prepare for adding GC, there's a couple of places in Tvix where I'd
like to fence off certain kinds of complexity (such as mutating bytecode, which,
for various reaons, also has to be part of data that is subject to GC). With
this change, we can drop optimisations like retroactively modifying existing
bytecode and *still* achieve better performance than before.

I believe that this is currently worth it to pave the way for changes that are
more significant for performance.

In general this also opens other avenues of optimisation: For example, we can
profile which argument sizes actually exist and remove the copy overhead of
varint decoding (which does show up in profiles) by using more adequately sized
types for, e.g., constant indices.

Known regressions:

* Op::Constant is no longer printing its values in disassembly (this can be
  fixed, I just didn't get around to it, will do separately).

Change-Id: Id9b3a4254623a45de03069dbdb70b8349e976743
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12191
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
2024-08-19 11:02:50 +00:00
..
builtins feat(tvix/eval): Implement builtins.readFileType 2024-08-09 14:35:57 +00:00
compiler refactor(tvix/eval): ensure VM operations fit in a single byte 2024-08-19 11:02:50 +00:00
tests feat(tvix/eval): Re-enable testing for eval-okay-readDir 2024-08-09 14:56:57 +00:00
value refactor(tvix/eval): ensure VM operations fit in a single byte 2024-08-19 11:02:50 +00:00
vm refactor(tvix/eval): ensure VM operations fit in a single byte 2024-08-19 11:02:50 +00:00
chunk.rs refactor(tvix/eval): ensure VM operations fit in a single byte 2024-08-19 11:02:50 +00:00
errors.rs feat(tvix/eval): Allow passing in an env to evaluation 2024-07-05 16:39:34 +00:00
io.rs feat(tvix/eval): Implement builtins.readFileType 2024-08-09 14:35:57 +00:00
lib.rs feat(tvix/eval): Forbid Hash{Map,Set}, use Fx instead 2024-08-07 12:38:40 +00:00
nix_search_path.rs fix(tvix/eval/nix_search_path): gate tests on impure feature 2024-05-26 19:53:51 +00:00
observer.rs refactor(tvix/eval): ensure VM operations fit in a single byte 2024-08-19 11:02:50 +00:00
opcode.rs refactor(tvix/eval): ensure VM operations fit in a single byte 2024-08-19 11:02:50 +00:00
pretty_ast.rs fix(tvix/eval): fix current clippy warnings 2022-12-25 18:25:06 +00:00
properties.rs refactor(tvix/eval): Don't (ab)use PartialEq for Nix equality 2022-09-18 22:03:41 +00:00
source.rs refactor(tvix/eval): impl Default for SourceCode 2023-08-20 21:52:21 +00:00
spans.rs feat(tvix/eval): Allow passing in an env to evaluation 2024-07-05 16:39:34 +00:00
systems.rs fix(tvix/eval): fix current clippy warnings 2022-12-25 18:25:06 +00:00
test_utils.rs test(tvix/eval): Add proof-of-concept test for Chunk 2022-09-18 17:55:06 +00:00
upvalues.rs fix(tvix/eval): remove impl PartialEq for Value 2022-11-04 00:30:13 +00:00
warnings.rs feat(tvix/glue): emit a warning in case of bad SRI hashes 2024-01-03 13:01:02 +00:00