tvl-depot/tvix
Vincent Ambo 3d238c350b refactor(tvix/eval): streamline construction of globals/builtins
Previously the construction of globals (a compiler-only concept) and
builtins (a (now) user-facing API) was intermingled between multiple
different modules, and kind of difficult to understand.

The complexity of this had grown in large part due to the
implementation of `builtins.import`, which required the notorious
"knot-tying" trick using Rc::new_cyclic (see cl/7097) for constructing
the set of globals.

As part of the new `Evaluation` API users should have the ability to
bring their own builtins, and control explicitly whether or not impure
builtins are available (regardless of whether they're compiled in or
not).

To streamline the construction and allow the new API features to work,
this commit restructures things by making these changes:

1. The `tvix_eval::builtins` module is now only responsible for
   exporting sets of builtins. It no longer has any knowledge of
   whether or not certain sets (e.g. only pure, or pure+impure) are
   enabled, and it has no control over which builtins are globally
   available (this is now handled in the compiler).

2. The compiler module is now responsible for both constructing the
   final attribute set of builtins from the set of builtins supplied
   by a user, as well as for populating its globals (that is
   identifiers which are available at the top-level scope).

3. The `Evaluation` API now carries a `builtins` field which is
   populated with the pure builtins by default, and can be extended by
   users.

4. The `import` feature has been moved into the compiler, as a
   special case. In general, builtins no longer have the ability to
   reference the "fix point" of the globals set.

This should not change any functionality, and in fact preserves minor
differences between Tvix/Nix that we already had (such as
`builtins.builtins` not existing).

Change-Id: Icdf5dd50eb81eb9260d89269d6e08b1e67811a2c
Reviewed-on: https://cl.tvl.fyi/c/depot/+/7738
Reviewed-by: sterni <sternenseemann@systemli.org>
Autosubmit: tazjin <tazjin@tvl.su>
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
2023-01-04 12:28:43 +00:00
..
.vscode chore(tvix): fix vscode rust-analyzer recommendation 2022-10-15 16:54:28 +00:00
cli refactor(tvix/eval): streamline construction of globals/builtins 2023-01-04 12:28:43 +00:00
derivation feat(tvix/derivation): add nix drv path generation to Derivation 2023-01-04 12:24:00 +00:00
docs docs(tvix): document pointer equality in (C++) Nix 2022-11-25 10:27:08 +00:00
eval refactor(tvix/eval): streamline construction of globals/builtins 2023-01-04 12:28:43 +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
serde test(tvix/serde): add initial set of deserialisation tests 2023-01-03 13:37:12 +00:00
store feat(tvix/store/nixpath): DIGEST_SIZE public, use more consts 2023-01-03 13:03:07 +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 feat(tvix/derivation): add nix drv path generation to Derivation 2023-01-04 12:24:00 +00:00
Cargo.nix test(tvix/serde): add initial set of deserialisation tests 2023-01-03 13:37:12 +00:00
Cargo.toml feat(tvix/serde): initial Nix->serde::Deserialize impl 2023-01-02 22:24:43 +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 feat(tvix): add evans to shell 2022-12-28 13:55:18 +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 feat(tvix): add crate2nixGenerate target 2022-12-22 15:26:41 +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 mg run //tvix:crate2nixGenerate -- in //tvix itself and commit the changes to the generated Cargo.nix file.

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.