2023-03-14 23:41:00 +01:00
|
|
|
<div align="center">
|
2023-09-07 16:51:34 +02:00
|
|
|
<img src="https://tvix.dev/logo.webp">
|
2023-03-14 23:41:00 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
-----------------
|
2021-03-26 23:49:32 +01:00
|
|
|
|
2023-02-02 16:01:46 +01:00
|
|
|
Tvix is a new implementation of the Nix language and package manager. See the
|
|
|
|
|
[announcement post][post-1] for information about the background of this
|
|
|
|
|
project.
|
2023-01-21 12:46:29 +01:00
|
|
|
|
2023-02-02 16:01:46 +01:00
|
|
|
Tvix is developed by [TVL][tvl] in our monorepo, the `depot`, at
|
|
|
|
|
[//tvix][tvix-src]. Code reviews take place on [Gerrit][tvix-gerrit], bugs are
|
|
|
|
|
filed in [our issue tracker][b].
|
2023-01-21 12:46:29 +01:00
|
|
|
|
2023-02-02 16:01:46 +01:00
|
|
|
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][getting-in-touch], or on our
|
|
|
|
|
[mailing list][].
|
|
|
|
|
|
|
|
|
|
Contributions to Tvix follow the TVL [review flow][review-docs] and
|
|
|
|
|
[contribution guidelines][contributing].
|
|
|
|
|
|
|
|
|
|
[post-1]: https://tvl.fyi/blog/rewriting-nix
|
|
|
|
|
[tvl]: https://tvl.fyi
|
|
|
|
|
[tvix-src]: https://cs.tvl.fyi/depot/-/tree/tvix/
|
|
|
|
|
[tvix-gerrit]: https://cl.tvl.fyi/q/path:%255Etvix.*
|
|
|
|
|
[b]: https://b.tvl.fyi
|
|
|
|
|
[getting-in-touch]: https://tvl.fyi/#getting-in-touch
|
|
|
|
|
[mailing list]: https://inbox.tvl.su
|
|
|
|
|
[review-docs]: https://code.tvl.fyi/about/docs/REVIEWS.md
|
|
|
|
|
[contributing]: https://code.tvl.fyi/about/docs/CONTRIBUTING.md
|
|
|
|
|
|
|
|
|
|
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][josh]. We do not accept code contributions or issues outside of
|
|
|
|
|
the tooling and communication methods outlined above.
|
|
|
|
|
|
|
|
|
|
[josh]: https://github.com/josh-project/josh
|
|
|
|
|
|
|
|
|
|
## Components
|
|
|
|
|
|
|
|
|
|
This folder contains the following components:
|
|
|
|
|
|
2023-09-24 21:28:09 +02:00
|
|
|
* `//tvix/castore` - subtree storage/transfer in a content-addressed fashion
|
2023-02-02 16:01:46 +01:00
|
|
|
* `//tvix/cli` - preliminary REPL & CLI implementation for Tvix
|
2023-09-24 21:28:09 +02:00
|
|
|
* `//tvix/eval` - an implementation of the Nix programming language
|
feat(tvix/nar-bridge): add nar-bridge-pathinfo command
This adds an additional nar-bridge-pathinfo command.
It exposes a PathInfoService for a HTTP Binary Cache, ingesting data
into a BlobService/DirectoryService as it goes through the NAR file.
It does this whenever it receives a Get request for a specific output
path, and waits returning with the PathInfo response until it ingested
the data.
It does not do any sort of caching - this means it re-downloads NAR
files again whenever the PathInfo is requested again, so you most likely
do not want to use this currently.
It's one building component as soon as we have store composition (which
we currently don't, so don't use this).
It can be used as an alternative mechanism to ingest data (Blobs and
Directories) of a given store path from a binary cache into tvix-store.
```
❯ nix-build -A third_party.nixpkgs.hello
/nix/store/mdi7lvrn2mx7rfzv3fdq3v5yw8swiks6-hello-2.12.1
❯ nix hash to-sri --type sha1 mdi7lvrn2mx7rfzv3fdq3v5yw8swiks6
sha1-Rs/INeK+7IGbG/u7fHoVNm96Yqs=
❯ out=$(mg build //tvix/nar-bridge)
$out/bin/nar-bridge-pathinfo --log-level debug &
INFO[0000] Starting nar-bridge-pathinfosvc at [::]:8001
❯ mg run //tvix:store -- daemon &
[mg] building target //tvix:store
[mg] running target //tvix:store
2023-10-03T16:21:57.433739Z INFO tvix_store: tvix-store listening on [::]:8000
at src/bin/tvix-store.rs:229
❯ evans --host localhost --port 8001 -r repl
[…]
tvix.store.v1.PathInfoService@localhost:8001> call Get
✔ by_output_hash
by_output_hash (TYPE_BYTES) => Rs/INeK+7IGbG/u7fHoVNm96Yqs=
{
"narinfo": {
"narSha256": "sXrPtjqhSoc2u0YfM1HVZThknkSYuRuHdtKCB6wkDFo=",
"narSize": "226552",
"referenceNames": [
"aw2fw9ag10wr9pf0qk4nk5sxi0q0bn56-glibc-2.37-8",
"mdi7lvrn2mx7rfzv3fdq3v5yw8swiks6-hello-2.12.1"
],
"signatures": [
{
"data": "7guDbfaF2Q29HY0c5axhtuacfxN6uxuEqeUfncDiSvMSAWvfHVMppB89ILqV8FE58pEQ04tSbMnRhR3FGPV0AA==",
"name": "cache.nixos.org-1"
}
]
},
"node": {
"directory": {
"digest": "xvo6BYbYaDw76IibLu5sr+VZoj9iM0ET2RUuYSYLwKE=",
"name": "bWRpN2x2cm4ybXg3cmZ6djNmZHEzdjV5dzhzd2lrczYtaGVsbG8tMi4xMi4x",
"size": 141
}
},
"references": [
"ptgFMIhdl2nJxMDdlDkITyXuBFc=",
"Rs/INeK+7IGbG/u7fHoVNm96Yqs="
]
}
```
Change-Id: I50167d0ac081c91adf5cf2733bbc4dc0993bd46e
Reviewed-on: https://cl.tvl.fyi/c/depot/+/9539
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: Connor Brewster <cbrewster@hey.com>
Reviewed-by: Brian Olsen <me@griff.name>
2023-10-03 18:08:34 +02:00
|
|
|
* `//tvix/nar-bridge`
|
|
|
|
|
* `nar-bridge-http`: A HTTP webserver providing a Nix HTTP Binary Cache interface in front of a tvix-store
|
2023-09-24 21:28:09 +02:00
|
|
|
* `//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
|
2023-02-02 16:01:46 +01:00
|
|
|
|
|
|
|
|
Some additional folders with auxiliary things exist and can be explored at your
|
|
|
|
|
leisure.
|
2021-03-26 23:49:32 +01:00
|
|
|
|
2023-01-21 12:37:54 +01:00
|
|
|
## Building the CLI
|
|
|
|
|
|
2023-02-01 14:38:43 +01:00
|
|
|
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.
|
|
|
|
|
|
2023-02-03 13:03:59 +01:00
|
|
|
- If you cloned the full monorepo, it can be provided by
|
|
|
|
|
`mg shell //tvix:shell`.
|
2023-02-01 14:38:43 +01:00
|
|
|
- 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.
|
2023-01-21 12:37:54 +01:00
|
|
|
|
2023-02-01 14:38:43 +01:00
|
|
|
Please follow the depot-wide instructions on how to get `mg` and use the depot
|
|
|
|
|
tooling.
|
|
|
|
|
|
|
|
|
|
### Compatibility
|
2023-01-21 12:37:54 +01:00
|
|
|
**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
|
2022-12-07 12:05:02 +01:00
|
|
|
|
|
|
|
|
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
|
2022-12-22 15:44:32 +01:00
|
|
|
Rust projects under `//tvix`, be sure to run
|
2023-12-09 17:13:04 +01:00
|
|
|
`mg run //tvix:crate2nix-generate` in `//tvix` itself and commit the changes
|
2023-02-01 14:38:43 +01:00
|
|
|
to the generated `Cargo.nix` file. This only applies to the full TVL checkout.
|
2022-12-07 12:05:02 +01:00
|
|
|
|
2021-03-26 23:49:32 +01:00
|
|
|
## 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.
|
