tvl-depot/tvix
Florian Klink 091de12a9a refactor(tvix/glue): move Fetch[er] into its own types, fetch lazily
We actually want to delay fetching until we actually need the file. A
simple evaluation asking for `.outPath` or `.drvPath` should work even
in a pure offline environment.

Before this CL, the fetching logic was quite distributed between
tvix_store_io, and builtins/fetchers.rs.

Rather than having various functions and conversions between structs,
describe a Fetch as an enum type, with the fields describing the fetch.

Define a store_path() function on top of `Fetch` which can be used to
ask for the calculated store path (if the digest has been provided
upfront).

Have a `Fetcher` struct, and give it a `fetch_and_persist` function,
taking a `Fetch` as well as a desired name, and have it deal with all
the logic of persisting the PathInfos. It also returns a StorePathRef,
similar to the `.store_path()` method on a `Fetch` struct.

In a followup CL, we can extend KnownPaths to track fetches AND
derivations, and then use `Fetcher` when we need to do IO into that
store path.

Change-Id: Ib39a96baeb661750a8706b461f8ba4abb342e777
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11500
Reviewed-by: raitobezarius <tvl@lahfa.xyz>
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
2024-04-23 12:30:48 +00:00
..
.vscode chore(tvix): fix vscode rust-analyzer recommendation 2022-10-15 16:54:28 +00:00
boot feat(tvix/boot): default CH_NUM_CPUS=2, and set num_queues= to it 2024-04-22 21:15:49 +00:00
build chore(tvix/build): migrate from test_case to rstest 2024-04-19 19:22:10 +00:00
build-go chore(3p/sources): Bump channels & overlays 2024-03-17 10:56:07 +00:00
castore refactor(tvix/castore): ingest filesystem entries in parallel 2024-04-20 18:54:28 +00:00
castore-go chore(3p/sources): Bump channels & overlays 2024-03-17 10:56:07 +00:00
cli refactor(tvix/cli/default.nix): make eval tests and benches derivations 2024-04-22 13:15:22 +00:00
docs docs(tvix): remove differences-drv-paths.md 2024-03-03 16:53:41 +00:00
eval fix(tvix/eval): don't impl From<NixString> for String 2024-04-22 20:28:55 +00:00
glue refactor(tvix/glue): move Fetch[er] into its own types, fetch lazily 2024-04-23 12:30:48 +00:00
nar-bridge feat(tvix/nar-bridge): support listening on unix sockets 2024-03-18 14:57:30 +00:00
nix-compat chore(nix-compat): remove unused test-case and test-generator 2024-04-19 19:22:10 +00:00
nix-lang-test-suite docs(tvix): initial notes on a possible generic Nix lang test suite 2024-01-22 14:21:19 +00:00
scripts chore(tvix): Run criterion benchmarks for the whole workspace 2023-12-20 18:04:43 +00:00
serde feat(tvix/eval): contextful JSON operations 2024-04-13 10:11:18 +00:00
store feat(tvix/store/bin): upload paths concurrently in copy 2024-04-20 18:54:28 +00:00
store-go chore(3p/sources): Bump channels & overlays 2024-03-17 10:56:07 +00:00
tools fix(tvix/tools/weave): handle sliced arrays correctly 2024-03-03 16:45:19 +00:00
verify-lang-tests fix(tvix/eval): don't force lambda arg in map, mapAttrs & genList 2024-03-19 06:20:17 +00:00
website chore: update links to tvixbolt 2024-02-24 10:17:56 +00:00
.gitignore chore(tvix): add /*.sled to .gitignore 2023-09-24 17:05:48 +00:00
buildkite.yml feat(tvix/buildkite): apply a 10 minutes timeout 2024-04-13 11:44:37 +00:00
Cargo.lock refactor(tvix/glue): move Fetch[er] into its own types, fetch lazily 2024-04-23 12:30:48 +00:00
Cargo.nix refactor(tvix/glue): move Fetch[er] into its own types, fetch lazily 2024-04-23 12:30:48 +00:00
Cargo.toml chore(tvix): switch to upstream futures 0.3.30 2023-12-24 21:45:04 +00:00
clippy.toml chore(tvix): add missing clippy attributes & config 2023-11-05 20:28:38 +00:00
crate-hashes.json chore(nix-compat): remove unused test-case and test-generator 2024-04-19 19:22:10 +00:00
default.nix chore(nix-compat): remove unused test-case and test-generator 2024-04-19 19:22:10 +00:00
LICENSE chore(tvix): Bootstrap Tvix folder 2021-03-27 00:09:49 +00:00
logo.webp refactor(tvix): move logo to //tvix:logo 2023-09-10 13:13:14 +00:00
OWNERS chore(depot): update OWNERS files for aspen 2023-12-20 18:35:58 +00:00
README.md docs(tvix/README): update IRC channels 2024-03-10 17:14:41 +00:00
shell.nix fix(tvix): apply cbtemulator patch in tvix view 2024-04-13 12:09:47 +00:00


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 in our dedicated IRC channel, #tvix-dev on hackint, which is also reachable via XMPP at #tvix-dev@irc.hackint.org (sic!) and via Matrix at #tvix-dev:hackint.org.

There's also the IRC channel of the wider TVL community, less on-topic, or 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/castore - subtree storage/transfer in a content-addressed fashion
  • //tvix/cli - preliminary REPL & CLI implementation for Tvix
  • //tvix/eval - an implementation of the Nix programming language
  • //tvix/nar-bridge
    • nar-bridge-http: A HTTP webserver providing a Nix HTTP Binary Cache interface in front of a tvix-store
  • //tvix/nix-compat - a Rust library for compatibility with C++ Nix, features like encodings and hashing schemes and formats
  • //tvix/serde - a Rust library for using the Nix language for app configuration
  • //tvix/store - a "filesystem" linking Nix store paths and metadata with the content-addressed layer

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 //tools:crate2nix-generate 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.