tvl-depot/tvix
Vincent Ambo bf286a54bc refactor(tvix/eval): add a LightSpan type for lighter span tracking
This type carries the information required for calculating a
span (i.e. the chunk and offset), instead of the span itself. The span
is then only calculated in cases where it is required (when throwing
errors).

This reduces the eval time for
`builtins.length (builtins.attrNames (import <nixpkgs> {}))` by *one
third*!

The data structure in chunks that carries span information reduces
in-memory size by trading off the speed of retrieving span
information. This is because the span information is only actually
required when throwing errors (or emitting warnings).

However, somewhere along the way we grew a dependency on carrying span
information in thunks (for correctly reporting error chains). Hitting
the code paths for span retrieval was expensive, and carrying the
spans in a different way would still be less cache-efficient. This
change is the best tradeoff I could come up with.

Refs: b/229.
Change-Id: I27d4c4b5c5f9be90ac47f2db61941e123a78a77b
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7558
Reviewed-by: grfn <grfn@gws.fyi>
Tested-by: BuildkiteCI
2022-12-21 22:21:25 +00:00
..
.vscode chore(tvix): fix vscode rust-analyzer recommendation 2022-10-15 16:54:28 +00:00
cli chore(tvix/cli): rename binary to just 'tvix' 2022-12-21 21:48:08 +00:00
docs docs(tvix): document pointer equality in (C++) Nix 2022-11-25 10:27:08 +00:00
eval refactor(tvix/eval): add a LightSpan type for lighter span tracking 2022-12-21 22:21:25 +00:00
nar docs(tvix/nar): document how to use NAR writer 2022-12-21 14:31:54 +00:00
nix_cli chore(tvix): upgrade to clap 4.0 2022-12-21 13:23:38 +00:00
proto chore(tvix/store): move castore.proto 2022-12-04 10:41:39 +00:00
store feat(tvix/proto): add rpc_blobstore 2022-12-15 19:10:26 +00:00
verify-lang-tests test(tvix/eval): verify pointer equality in list comparisons 2022-12-02 14:06:22 +00:00
.gitignore feat(tvix/): .gitignore target folders 2022-11-11 19:55:12 +00:00
Cargo.lock chore(tvix/nar): add CI build target 2022-12-21 14:08:30 +00:00
Cargo.nix chore(tvix/cli): rename binary to just 'tvix' 2022-12-21 21:48:08 +00:00
Cargo.toml chore(tvix/nar): add CI build target 2022-12-21 14:08:30 +00:00
crate-hashes.json fix(tvix/eval): use test-generator fork that supports workspaces 2022-12-21 13:23:38 +00:00
default.nix refactor(tvix): provide a combined //tvix:shell mkShell target 2022-12-15 17:26:45 +00:00
LICENSE chore(tvix): Bootstrap Tvix folder 2021-03-27 00:09:49 +00:00
OWNERS chore(gerrit): migrate OWNERS files to code-owners style 2022-09-19 11:13:28 +00:00
README.md refactor(tvix): build Rust projects using crate2nix 2022-12-15 17:26:45 +00:00

Tvix

For more information about Tvix, contact one of the project owners. We are interested in people who would like to help us review designs, brainstorm and describe requirements that we may not yet have considered.

Rust projects

Some parts of Tvix are written in Rust. To simplify the dependency management on the Nix side of these builds, we use crate2nix in a single Rust workspace in //tvix to maintain the Nix build configuration.

When making changes to Cargo dependency configuration in any of the Rust projects under //tvix, be sure to run crate2nix generate in //tvix itself and commit the changes to the generated Cargo.nix file.

crate2nix is available via direnv inside of depot, or can be built from the third_party.nixpkgs.crate2nix attribute of depot. Make sure to build it from depot to avoid generating files with a different version that might have different output.

License structure

All code implemented for Tvix is licensed under the GPL-3.0, with the exception of the protocol buffer definitions used for communication between services which are available under a more permissive license (MIT).

The idea behind this structure is that any direct usage of our code (e.g. linking to it, embedding the evaluator, etc.) will fall under the terms of the GPL3, but users are free to implement their own components speaking these protocols under the terms of the MIT license.