History

Vincent Ambo f16b0f24e2 refactor(tvix/eval): wrap `Builtin` type in a Box This reduces the size of `Builtin` from 88 (!) bytes to 8, and as the largest variant of `Value`, the size of that type from 96 to 64. The next largest type is NixList, clocking in at 64 bytes. This has noticeable performance impact. In an implementation without disk I/O, evaluating nixpkgs.stdenv looks like this: Benchmark 1: tvix -E '(import <nixpkgs> {}).stdenv.drvPath' Time (mean ± σ): 1.151 s ± 0.003 s [User: 1.041 s, System: 0.109 s] Range (min … max): 1.147 s … 1.155 s 10 runs After this change, it looks like this: Benchmark 1: tvix -E '(import <nixpkgs> {}).stdenv.drvPath' Time (mean ± σ): 1.046 s ± 0.004 s [User: 0.954 s, System: 0.092 s] Range (min … max): 1.041 s … 1.053 s 10 runs Change-Id: I5ab7cc02a9a450c0227daf1f1f72966358311ebb Reviewed-on: https://cl.tvl.fyi/c/depot/+/8027 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>		2023-02-03 18:47:33 +00:00
..
.vscode	chore(tvix): fix vscode rust-analyzer recommendation	2022-10-15 16:54:28 +00:00
cli	test(tvix/cli): eval nixpkgs.stdenv in CI and assert that it matches	2023-02-03 10:47:18 +00:00
docs	docs(tvix): fix minor spelling problems in pointer equality document	2023-01-25 14:30:50 +00:00
eval	refactor(tvix/eval): wrap `Builtin` type in a Box	2023-02-03 18:47:33 +00:00
nix-compat	feat(tvix/nix-compat/derivation): Display -> to_aterm_string()	2023-02-01 16:31:56 +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	refactor(tvix/serde): allow dead_code in struct	2023-01-31 15:35:46 +00:00
store	feat(tvix/store): add write_nar function	2023-01-31 15:28:22 +00:00
verify-lang-tests	test(tvix/eval): add test for builtins parity	2023-01-06 12:00:38 +00:00
.gitignore	feat(tvix/): .gitignore target folders	2022-11-11 19:55:12 +00:00
Cargo.lock	refactor(tvix/cli): use Wu-Manber string scanning for drv references	2023-02-02 17:50:44 +00:00
Cargo.nix	refactor(tvix/cli): use Wu-Manber string scanning for drv references	2023-02-02 17:50:44 +00:00
Cargo.toml	refactor(tvix/nix-compat): absorb nar writer	2023-01-31 15:18:39 +00:00
crate-hashes.json	refactor(tvix/cli): use Wu-Manber string scanning for drv references	2023-02-02 17:50:44 +00:00
default.nix	fix(tvix): add dummy target to attach extra-step to	2023-02-01 17:34:08 +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	docs(tvix): move mg shell command into one line	2023-02-03 12:07:07 +00:00

README.md

Tvix

Tvix is a new implementation of the Nix language and package manager. See the announcement post for information about the background of this project.

Tvix is developed by TVL in our monorepo, the depot, at //tvix. Code reviews take place on Gerrit, bugs are filed in our issue tracker.

For more information about Tvix, feel free to reach out. We are interested in people who would like to help us review designs, brainstorm and describe requirements that we may not yet have considered.

Most of the discussion around development happens on our IRC channel, which you can join in several ways documented on tvl.fyi, or on our mailing list.

Contributions to Tvix follow the TVL review flow and contribution guidelines.

WARNING: Tvix is not ready for use in production. None of our current APIs should be considered stable in any way.

WARNING: Any other instances of this project or repository are josh-mirrors. We do not accept code contributions or issues outside of the tooling and communication methods outlined above.

Components

This folder contains the following components:

//tvix/eval - an implementation of the Nix programming language
//tvix/nix-compat - library functions for compatibility with C++ Nix
//tvix/cli - preliminary REPL & CLI implementation for Tvix
//tvix/serde - Rust library for using the Nix language for app configuration
//tvix/store - implementation of a file store for Tvix

Some additional folders with auxiliary things exist and can be explored at your leisure.

Building the CLI

The CLI can also be built with standard Rust tooling (i.e. cargo build), as long as you are in a shell with the right dependencies.

If you cloned the full monorepo, it can be provided by mg shell //tvix:shell.
If you cloned the tvix workspace only (git clone https://code.tvl.fyi/depot.git:workspace=views/tvix.git), nix-shell provides it.

If you're in the TVL monorepo, you can also run mg build //tvix/cli (or mg build from inside that folder) for a more incremental build.

Please follow the depot-wide instructions on how to get mg and use the depot tooling.

Compatibility

Important note: We only use and test Nix builds of our software against Nix 2.3. There are a variety of bugs and subtle problems in newer Nix versions which we do not have the bandwidth to address, builds in newer Nix versions may or may not work.

Rust projects, crate2nix

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. This only applies to the full TVL checkout.

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.