1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
// SPDX-FileCopyrightText: 2023 embr <git@liclac.eu>
//
// SPDX-License-Identifier: EUPL-1.2
//! nix-daemon
//! ==========
//!
//! This library exposes an interface for directly talking to a [Nix](https://nixos.org/)
//! daemon.
//!
//! - To connect to a `nix-daemon`, use [`nix::DaemonStore`] (through the [`Store`] trait).
//! - To build your own store, and make it compatible with existing tools (eg. `nix-build`),
//! implement the [`Store`] trait and use [`nix::DaemonProtocolAdapter`].
//!
//! The [`Store`] protocol mirrors the interface of the latest protocol we support, and
//! may receive breaking changes to keep up.
//!
//! However, as the Nix Daemon protocol is forward compatible, and will negotiate the
//! highest protocol version supported by both ends at connection time, there's no
//! pressure to upgrade; unless compatibility is broken upstream, an old version of this
//! crate should in theory be able to talk to newer Nix until the end of time.
//!
//! The [`nix`] module currently supports Protocol 1.35, and Nix 2.15+. Support for older
//! versions will be added in the future (in particular, Protocol 1.21, used by Nix 2.3).
pub mod nix;
use chrono::{DateTime, Utc};
use num_enum::{IntoPrimitive, TryFromPrimitive, TryFromPrimitiveError};
use std::fmt::Debug;
use std::{collections::HashMap, future::Future};
use thiserror::Error;
use tokio::io::AsyncReadExt;
pub type Result<T, E = Error> = std::result::Result<T, E>;
trait ResultExt<T, E> {
fn with_field(self, f: &'static str) -> Result<T>;
}
impl<T, E: Into<Error>> ResultExt<T, E> for Result<T, E> {
fn with_field(self, f: &'static str) -> Result<T> {
self.map_err(|err| Error::Field(f, Box::new(err.into())))
}
}
/// Error enum for the library.
#[derive(Debug, Error)]
pub enum Error {
/// This error was encountered while reading/writing a specific field.
#[error("`{0}`: {1}")]
Field(&'static str, #[source] Box<Error>),
/// An invalid value of some sort was encountered.
#[error("invalid value: {0}")]
Invalid(String),
/// Error returned from the nix daemon.
#[error("{0}")]
NixError(NixError),
/// IO error.
#[error(transparent)]
IO(#[from] std::io::Error),
}
/// A thrown exception from the daemon.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NixError {
pub level: Verbosity,
pub msg: String,
pub traces: Vec<String>,
}
impl std::fmt::Display for NixError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "[{:?}] {}", self.level, self.msg)?;
for trace in self.traces.iter() {
write!(f, "\n\t{}", trace)?;
}
Ok(())
}
}
/// Real-time logging data returned from a [`Progress`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Stderr {
/// A plain line of stderr output.
Next(String),
/// An error propagated from Nix.
Error(NixError),
/// An activity (such as a build) was started.
StartActivity(StderrStartActivity),
/// An activity (such as a build) finished.
StopActivity { act_id: u64 },
/// A progress update from an activity.
Result(StderrResult),
}
/// Type of a [`Stderr::StartActivity`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
#[repr(u64)]
pub enum StderrActivityType {
Unknown = 0,
CopyPath = 100,
FileTransfer = 101,
Realise = 102,
CopyPaths = 103,
Builds = 104,
Build = 105,
OptimiseStore = 106,
VerifyPaths = 107,
Substitute = 108,
QueryPathInfo = 109,
PostBuildHook = 110,
BuildWaiting = 111,
}
impl From<TryFromPrimitiveError<StderrActivityType>> for Error {
fn from(value: TryFromPrimitiveError<StderrActivityType>) -> Self {
Self::Invalid(format!("StderrActivityType({:x})", value.number))
}
}
/// Notification that an Activity (such as a build) has started.
///
/// TODO: Users should not have to fish data out of the .kind-specific .fields.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct StderrStartActivity {
/// Activity ID. The same act_id is passed in [`Stderr::StopActivity`] and [`Stderr::Result`].
pub act_id: u64,
/// Log level of this activity.
pub level: Verbosity,
/// Type of the activity.
pub kind: StderrActivityType,
/// Log message.
pub s: String,
/// Additional fields. The meaning of these depend on the value of .kind.
/// TODO: This will be replaced with something more user-friendly in the future.
pub fields: Vec<StderrField>,
/// Parent activity, or 0 if this is the top-level one
pub parent_id: u64,
}
/// Type of a [`StderrResult`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
#[repr(u64)]
pub enum StderrResultType {
FileLinked = 100,
BuildLogLine = 101,
UntrustedPath = 102,
CorruptedPath = 103,
SetPhase = 104,
Progress = 105,
SetExpected = 106,
PostBuildLogLine = 107,
}
impl From<TryFromPrimitiveError<StderrResultType>> for Error {
fn from(value: TryFromPrimitiveError<StderrResultType>) -> Self {
Self::Invalid(format!("StderrResultType({:x})", value.number))
}
}
/// Notification that a result of some kind (see [`StderrResultType`]) has been produced.
///
/// TODO: Users should not have to fish data out of the .kind-specific .fields.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct StderrResult {
/// Activity ID. The same act_id is passed in [`Stderr::StartActivity`] and [`Stderr::StopActivity`].
pub act_id: u64,
/// Type of the activity.
pub kind: StderrResultType,
/// Additional fields. The meaning of these depend on the value of .kind.
/// TODO: This will be replaced with something more user-friendly in the future.
pub fields: Vec<StderrField>,
}
/// A raw field used in [`StderrStartActivity`] and [`StderrResult`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum StderrField {
Int(u64),
String(String),
}
impl StderrField {
/// If this is a Self::Int, return the value, else None.
pub fn as_int(&self) -> Option<&u64> {
if let Self::Int(v) = self {
Some(v)
} else {
None
}
}
pub fn as_activity_type(&self) -> Option<StderrActivityType> {
self.as_int().and_then(|v| (*v).try_into().ok())
}
/// If this is a Self::String, return the value, else None.
pub fn as_string(&self) -> Option<&String> {
if let Self::String(v) = self {
Some(v)
} else {
None
}
}
}
/// Verbosity of a [`Stderr`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
#[repr(u64)]
pub enum Verbosity {
Error = 0,
Warn,
Notice,
Info,
Talkative,
Chatty,
Debug,
Vomit,
}
impl From<TryFromPrimitiveError<Verbosity>> for Error {
fn from(value: TryFromPrimitiveError<Verbosity>) -> Self {
Self::Invalid(format!("Verbosity({:x})", value.number))
}
}
/// Passed to [`Store::build_paths()`] and [`Store::build_paths_with_results()`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
#[repr(u64)]
pub enum BuildMode {
Normal,
Repair,
Check,
}
impl From<TryFromPrimitiveError<BuildMode>> for Error {
fn from(value: TryFromPrimitiveError<BuildMode>) -> Self {
Self::Invalid(format!("BuildMode({:x})", value.number))
}
}
/// Status code for a [`BuildResult`], returned from [`Store::build_paths_with_results()`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
#[repr(u64)]
pub enum BuildResultStatus {
Built = 0,
Substituted = 1,
AlreadyValid = 2,
PermanentFailure = 3,
InputRejected = 4,
OutputRejected = 5,
/// "possibly transient", the CppNix source helpfully points out.
TransientFailure = 6,
/// No longer used, according to a comment in CppNix 2.19.3.
/// TODO: Figure out since when.
CachedFailure = 7,
TimedOut = 8,
MiscFailure = 9,
DependencyFailed = 10,
LogLimitExceeded = 11,
NotDeterministic = 12,
ResolvesToAlreadyValid = 13,
NoSubstituters = 14,
}
impl From<TryFromPrimitiveError<BuildResultStatus>> for Error {
fn from(value: TryFromPrimitiveError<BuildResultStatus>) -> Self {
Self::Invalid(format!("BuildResultStatus({:x})", value.number))
}
}
/// Returned from [`Store::build_paths_with_results()`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BuildResult {
/// Status code, see BuildResultStatus.
pub status: BuildResultStatus,
/// Verbatim error message, or "" if none.
pub error_msg: String,
/// How many times this derivation was built. Only present on Proto 1.29+.
pub times_built: u64, // FIXME: Make Option<>.
pub is_non_deterministic: bool, // FIXME: Make Option<>.
pub start_time: DateTime<Utc>, // FIXME: Make Option<>.
pub stop_time: DateTime<Utc>, // FIXME: Make Option<>.
/// Map of (name, path). Only present on Proto 1.28+.
pub built_outputs: HashMap<String, String>,
}
/// Passed to [`Store::set_options()`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ClientSettings {
pub keep_failed: bool,
pub keep_going: bool,
pub try_fallback: bool,
pub verbosity: Verbosity,
pub max_build_jobs: u64,
pub max_silent_time: u64,
pub verbose_build: bool,
pub build_cores: u64,
pub use_substitutes: bool,
pub overrides: HashMap<String, String>,
}
/// PathInfo, like `nix path-info` would return.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct PathInfo {
/// The first derivation that produced this path.
///
/// Note that if a second derivation produces the same output, eg. because an input
/// changed, but not in a way which affects the contents of the output, this will
/// still point to the first derivation, which may not be in your store (anymore).
///
/// If you want to know which derivations actually in your store can produce a path,
/// use [`Store::query_valid_derivers()`] instead.
pub deriver: Option<String>,
/// Other paths referenced by this path.
pub references: Vec<String>,
/// NAR hash, in the form: "(algo)-(hash)".
pub nar_hash: String,
/// NAR size.
pub nar_size: u64,
/// Is this path "ultimately trusted", eg. built locally?
pub ultimate: bool,
/// Optional signatures, eg. from a binary cache.
pub signatures: Vec<String>,
/// An assertion that this path is content-addressed, eg. for fixed-output derivations.
pub ca: Option<String>,
/// When the path was registered, eg. placed into the local store.
pub registration_time: DateTime<Utc>,
}
/// An in-progress operation, which may produces a series of [`Stderr`]s before returning.
///
/// All functions on the Store trait return these wrappers. If you just want the final result, not
/// play-by-play updates on eg. log output or paths built:
///
/// ```no_run
/// use nix_daemon::{Store, Progress, nix::DaemonStore};
/// # async {
/// # let mut store = DaemonStore::builder()
/// # .connect_unix("/nix/var/nix/daemon-socket/socket")
/// # .await?;
/// #
/// let is_valid_path = store.is_valid_path("/nix/store/...").await?.result().await?;
/// # Ok::<_, nix_daemon::Error>(())
/// # };
/// ```
///
/// Otherwise, if you are interested in (some of) the progress updates:
///
/// ```no_run
/// use nix_daemon::{Store, Progress, nix::DaemonStore};
/// # async {
/// # let mut store = DaemonStore::builder()
/// # .connect_unix("/nix/var/nix/daemon-socket/socket")
/// # .await?;
/// #
/// let mut prog = store.is_valid_path("/nix/store/...").await?;
/// while let Some(stderr) = prog.next().await? {
/// match stderr {
/// _ => todo!(),
/// }
/// }
/// let is_valid_path = prog.result().await?;
/// # Ok::<_, nix_daemon::Error>(())
/// # };
/// ```
pub trait Progress: Send {
type T: Send;
type Error: From<Error> + Send + Sync;
/// Returns the next Stderr message, or None after all have been consumed.
/// This must behave like a fused iterator - once None is returned, all further calls
/// must immediately return None, without corrupting the underlying datastream, etc.
fn next(&mut self) -> impl Future<Output = Result<Option<Stderr>, Self::Error>> + Send;
/// Discards any further messages from [`Self::next()`] and proceeds.
fn result(self) -> impl Future<Output = Result<Self::T, Self::Error>> + Send;
}
/// Helper methods for [`Progress`].
pub trait ProgressExt: Progress {
/// Calls `f()` for each message returned from [`Progress::next()`], then [`Progress::result()`].
// FIXME: This is a bad name and conflicts with the tap crate.
fn tap<F: Fn(Stderr) + Send>(
self,
f: F,
) -> impl Future<Output = Result<Self::T, Self::Error>> + Send;
/// Returns a tuple of (stderr, [`Progress::result()`]), where stderr is a `Vec<Stderr>` of all
/// Stderr returned by [`Progress::next()`].
fn split(self) -> impl Future<Output = (Vec<Stderr>, Result<Self::T, Self::Error>)> + Send;
}
impl<P: Progress> ProgressExt for P {
async fn tap<F: Fn(Stderr)>(mut self, f: F) -> Result<Self::T, Self::Error> {
while let Some(stderr) = self.next().await? {
f(stderr)
}
self.result().await
}
async fn split(mut self) -> (Vec<Stderr>, Result<Self::T, Self::Error>) {
let mut stderrs = Vec::new();
loop {
match self.next().await {
Ok(Some(stderr)) => stderrs.push(stderr),
Err(err) => break (stderrs, Err(err)),
Ok(None) => break (stderrs, self.result().await),
}
}
}
}
/// Generic interface to a Nix store.
///
/// See [`nix::DaemonStore`] for an implementation that talks to a CppNix (compatible) daemon.
pub trait Store {
type Error: From<Error> + Send + Sync;
/// Returns whether a store path is valid.
fn is_valid_path<P: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: P,
) -> impl Future<Output = Result<impl Progress<T = bool, Error = Self::Error>, Self::Error>> + Send;
/// Returns whether `Self::query_substitutable_paths()` would return anything.
fn has_substitutes<P: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: P,
) -> impl Future<Output = Result<impl Progress<T = bool, Error = Self::Error>, Self::Error>> + Send;
/// Adds a file to the store.
fn add_to_store<
SN: AsRef<str> + Send + Sync + Debug,
SC: AsRef<str> + Send + Sync + Debug,
Refs,
R,
>(
&mut self,
name: SN,
cam_str: SC,
refs: Refs,
repair: bool,
source: R,
) -> impl Future<
Output = Result<impl Progress<T = (String, PathInfo), Error = Self::Error>, Self::Error>,
> + Send
where
Refs: IntoIterator + Send + Debug,
Refs::IntoIter: ExactSizeIterator + Send,
Refs::Item: AsRef<str> + Send + Sync,
R: AsyncReadExt + Unpin + Send + Debug;
/// Builds the specified paths.
fn build_paths<Paths>(
&mut self,
paths: Paths,
mode: BuildMode,
) -> impl Future<Output = Result<impl Progress<T = (), Error = Self::Error>, Self::Error>> + Send
where
Paths: IntoIterator + Send + Debug,
Paths::IntoIter: ExactSizeIterator + Send,
Paths::Item: AsRef<str> + Send + Sync;
/// Ensure the specified store path exists.
fn ensure_path<Path: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: Path,
) -> impl Future<Output = Result<impl Progress<T = (), Error = Self::Error>, Self::Error>> + Send;
/// Creates a temporary GC root, which persists until the client disconnects.
fn add_temp_root<Path: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: Path,
) -> impl Future<Output = Result<impl Progress<T = (), Error = Self::Error>, Self::Error>> + Send;
/// Creates a persistent GC root. This is what's normally meant by a GC root.
fn add_indirect_root<Path: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: Path,
) -> impl Future<Output = Result<impl Progress<T = (), Error = Self::Error>, Self::Error>> + Send;
/// Returns the `(link, target)` of all known GC roots.
fn find_roots(
&mut self,
) -> impl Future<
Output = Result<
impl Progress<T = HashMap<String, String>, Error = Self::Error>,
Self::Error,
>,
> + Send;
/// Applies client options. This changes the behaviour of future commands.
fn set_options(
&mut self,
opts: ClientSettings,
) -> impl Future<Output = Result<impl Progress<T = (), Error = Self::Error>, Self::Error>> + Send;
/// Returns a [`PathInfo`] struct for the given path.
fn query_pathinfo<S: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: S,
) -> impl Future<
Output = Result<impl Progress<T = Option<PathInfo>, Error = Self::Error>, Self::Error>,
> + Send;
/// Returns which of the passed paths are valid.
fn query_valid_paths<Paths>(
&mut self,
paths: Paths,
use_substituters: bool,
) -> impl Future<Output = Result<impl Progress<T = Vec<String>, Error = Self::Error>, Self::Error>>
+ Send
where
Paths: IntoIterator + Send + Debug,
Paths::IntoIter: ExactSizeIterator + Send,
Paths::Item: AsRef<str> + Send + Sync;
/// Returns paths which can be substituted.
fn query_substitutable_paths<Paths>(
&mut self,
paths: Paths,
) -> impl Future<Output = Result<impl Progress<T = Vec<String>, Error = Self::Error>, Self::Error>>
+ Send
where
Paths: IntoIterator + Send + Debug,
Paths::IntoIter: ExactSizeIterator + Send,
Paths::Item: AsRef<str> + Send + Sync;
/// Returns a list of valid derivers for a path.
/// This is sort of like [`PathInfo::deriver`], but it doesn't lie to you.
fn query_valid_derivers<S: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: S,
) -> impl Future<Output = Result<impl Progress<T = Vec<String>, Error = Self::Error>, Self::Error>>
+ Send;
/// Takes a list of paths and queries which would be built, substituted or unknown,
/// along with an estimate of the cumulative download and NAR sizes.
fn query_missing<Ps>(
&mut self,
paths: Ps,
) -> impl Future<Output = Result<impl Progress<T = Missing, Error = Self::Error>, Self::Error>> + Send
where
Ps: IntoIterator + Send + Debug,
Ps::IntoIter: ExactSizeIterator + Send,
Ps::Item: AsRef<str> + Send + Sync;
/// Returns a map of `(output, store path)` for the given derivation.
fn query_derivation_output_map<P: AsRef<str> + Send + Sync + Debug>(
&mut self,
path: P,
) -> impl Future<
Output = Result<
impl Progress<T = HashMap<String, String>, Error = Self::Error>,
Self::Error,
>,
> + Send;
/// Like `Self::build_paths()`, but returns a [`BuildResult`] for each entry in `paths`.
fn build_paths_with_results<Ps>(
&mut self,
paths: Ps,
mode: BuildMode,
) -> impl Future<
Output = Result<
impl Progress<T = HashMap<String, BuildResult>, Error = Self::Error>,
Self::Error,
>,
> + Send
where
Ps: IntoIterator + Send + Debug,
Ps::IntoIter: ExactSizeIterator + Send,
Ps::Item: AsRef<str> + Send + Sync;
}
/// Returned from [`Store::query_missing()`].
#[derive(Debug, PartialEq, Eq)]
pub struct Missing {
/// Paths that will be built.
pub will_build: Vec<String>,
/// Paths that will be substituted.
pub will_substitute: Vec<String>,
/// Paths we don't know what will happen to.
pub unknown: Vec<String>,
/// Despite the name, the extracted size of all substituted paths.
pub download_size: u64,
/// Total size of all NARs to download from a substituter.
pub nar_size: u64,
}