367a5e9922
This provides a GRPCDirectoryService struct implementing DirectoryService, allowing a client to Directory objects from a (remote) tvix-store. Remote in this case is anything outside the current process, be it another process, or an endpoint on the network. To keep the sync interface in the `DirectoryService` trait, a handle to some tokio runtime needs to be passed into the constructor, and the two methods use `self.tokio_handle.spawn` to start an async function, and `self.tokio_handle.block_on` to wait for its completion. The client handle, called `grpc_client` itself is easy to clone, and treats concurrent requests internally. This means, even though we keep the `DirectoryService` trait sync, there's nothing preventing it from being used concurrently, let's say from multiple threads. There's still two limitations for now: 1) The trait doesn't make use of the `recursive` request, which currently leads to a N+1 query problem. This can be fixed by `GRPCDirectoryService` having a reference to another `DirectoryService` acting as the local side. I want to wait for general store composition code to pop up before manually coding this here. 2) It's currently only possible to put() leaf directory nodes, as the request normally requires uploading a whole closure. We might want to add another batch function to upload a whole closure, and/or do this batching in certain cases. This still needs some more thinking. Change-Id: I7ffec791610b72c0960cf5307cefbb12ec946dc9 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8336 Tested-by: BuildkiteCI Autosubmit: flokli <flokli@flokli.de> Reviewed-by: tazjin <tazjin@tvl.su> |
||
|---|---|---|
| .. | ||
| .vscode | ||
| cli | ||
| docs | ||
| eval | ||
| nix-compat | ||
| nix_cli | ||
| proto | ||
| serde | ||
| store | ||
| verify-lang-tests | ||
| website | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.nix | ||
| Cargo.toml | ||
| crate-hashes.json | ||
| default.nix | ||
| LICENSE | ||
| OWNERS | ||
| README.md | ||
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
tvixworkspace only (git clone https://code.tvl.fyi/depot.git:workspace=views/tvix.git),nix-shellprovides 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.