Nix 2.93.3
Lix: A modern, delicious implementation of the Nix package manager; unstable internal interfaces
Loading...
Searching...
No Matches
nix::RemoteStore Class Referenceabstract

#include <remote-store.hh>

Inheritance diagram for nix::RemoteStore:
nix::Store nix::GcStore nix::LogStore nix::Store nix::Store nix::SSHStore nix::UDSRemoteStore

Classes

struct  Connection
struct  ConnectionHandle

Public Member Functions

 RemoteStore (const RemoteStoreConfig &config)
RemoteStoreConfigconfig () override=0
const RemoteStoreConfigconfig () const override=0
kj::Promise< Result< bool > > isValidPathUncached (const StorePath &path) override
kj::Promise< Result< StorePathSet > > queryValidPaths (const StorePathSet &paths, SubstituteFlag maybeSubstitute=NoSubstitute) override
kj::Promise< Result< StorePathSet > > queryAllValidPaths () override
kj::Promise< Result< std::shared_ptr< const ValidPathInfo > > > queryPathInfoUncached (const StorePath &path) override
kj::Promise< Result< void > > queryReferrers (const StorePath &path, StorePathSet &referrers) override
kj::Promise< Result< StorePathSet > > queryValidDerivers (const StorePath &path) override
kj::Promise< Result< StorePathSet > > queryDerivationOutputs (const StorePath &path) override
kj::Promise< Result< std::map< std::string, std::optional< StorePath > > > > queryPartialDerivationOutputMap (const StorePath &path, Store *evalStore=nullptr) override
kj::Promise< Result< std::optional< StorePath > > > queryPathFromHashPart (const std::string &hashPart) override
kj::Promise< Result< StorePathSet > > querySubstitutablePaths (const StorePathSet &paths) override
kj::Promise< Result< void > > querySubstitutablePathInfos (const StorePathCAMap &paths, SubstitutablePathInfos &infos) override
kj::Promise< Result< ref< const ValidPathInfo > > > addCAToStore (AsyncInputStream &dump, std::string_view name, ContentAddressMethod caMethod, HashType hashType, const StorePathSet &references, RepairFlag repair)
kj::Promise< Result< StorePath > > addToStoreFromDump (AsyncInputStream &dump, std::string_view name, FileIngestionMethod method=FileIngestionMethod::Recursive, HashType hashAlgo=HashType::SHA256, RepairFlag repair=NoRepair, const StorePathSet &references=StorePathSet()) override
kj::Promise< Result< void > > addToStore (const ValidPathInfo &info, AsyncInputStream &nar, RepairFlag repair, CheckSigsFlag checkSigs) override
kj::Promise< Result< void > > addMultipleToStore (PathsSource &pathsToCopy, Activity &act, RepairFlag repair, CheckSigsFlag checkSigs) override
kj::Promise< Result< StorePath > > addTextToStore (std::string_view name, std::string_view s, const StorePathSet &references, RepairFlag repair) override
kj::Promise< Result< void > > registerDrvOutput (const Realisation &info) override
kj::Promise< Result< std::shared_ptr< const Realisation > > > queryRealisationUncached (const DrvOutput &) override
kj ::Promise< Result< void > > buildPaths (const std::vector< DerivedPath > &paths, BuildMode buildMode, std::shared_ptr< Store > evalStore) override
kj::Promise< Result< std::vector< KeyedBuildResult > > > buildPathsWithResults (const std::vector< DerivedPath > &paths, BuildMode buildMode, std::shared_ptr< Store > evalStore) override
kj ::Promise< Result< BuildResult > > buildDerivation (const StorePath &drvPath, const BasicDerivation &drv, BuildMode buildMode) override
kj::Promise< Result< void > > ensurePath (const StorePath &path) override
kj::Promise< Result< void > > addTempRoot (const StorePath &path) override
kj::Promise< Result< Roots > > findRoots (bool censor) override
kj::Promise< Result< void > > collectGarbage (const GCOptions &options, GCResults &results) override
kj::Promise< Result< void > > optimiseStore () override
kj::Promise< Result< bool > > verifyStore (bool checkContents, RepairFlag repair) override
kj::Promise< Result< void > > repairPath (const StorePath &path) override
kj::Promise< Result< void > > addSignatures (const StorePath &storePath, const StringSet &sigs) override
kj::Promise< Result< void > > queryMissing (const std::vector< DerivedPath > &targets, StorePathSet &willBuild, StorePathSet &willSubstitute, StorePathSet &unknown, uint64_t &downloadSize, uint64_t &narSize) override
kj::Promise< Result< void > > addBuildLog (const StorePath &drvPath, std::string_view log) override
kj::Promise< Result< std::optional< std::string > > > getVersion () override
kj::Promise< Result< void > > connect () override
kj::Promise< Result< unsigned int > > getProtocol () override
kj::Promise< Result< std::optional< TrustedFlag > > > isTrustedClient () override
ref< ConnectionopenConnectionWrapper ()
Public Member Functions inherited from nix::Store
virtual std::optional< AssociatedCredentialsassociatedCredentials () const
virtual kj::Promise< Result< void > > init ()
virtual std::string getUri ()=0
StorePath parseStorePath (std::string_view path) const
std::optional< StorePathmaybeParseStorePath (std::string_view path) const
std::string printStorePath (const StorePath &path) const
StorePathSet parseStorePathSet (const PathSet &paths) const
PathSet printStorePathSet (const StorePathSet &path) const
std::string showPaths (const StorePathSet &paths)
bool isInStore (PathView path) const
bool isStorePath (std::string_view path) const
std::pair< StorePath, PathtoStorePath (PathView path) const
Path followLinksToStore (std::string_view path) const
StorePath followLinksToStorePath (std::string_view path) const
StorePath makeStorePath (std::string_view type, std::string_view hash, std::string_view name) const
StorePath makeStorePath (std::string_view type, const Hash &hash, std::string_view name) const
StorePath makeOutputPath (std::string_view id, const Hash &hash, std::string_view name) const
StorePath makeFixedOutputPath (std::string_view name, const FixedOutputInfo &info) const
StorePath makeTextPath (std::string_view name, const TextInfo &info) const
StorePath makeFixedOutputPathFromCA (std::string_view name, const ContentAddressWithReferences &ca) const
StorePath computeStorePathForPathRecursive (std::string_view name, const PreparedDump &source) const
StorePath computeStorePathForPathFlat (std::string_view name, const Path &srcPath) const
StorePath computeStorePathForText (std::string_view name, std::string_view s, const StorePathSet &references) const
kj::Promise< Result< bool > > isValidPath (const StorePath &path)
kj::Promise< Result< void > > substitutePaths (const StorePathSet &paths)
kj::Promise< Result< ref< const ValidPathInfo > > > queryPathInfo (const StorePath &path)
kj::Promise< Result< std::shared_ptr< const Realisation > > > queryRealisation (const DrvOutput &)
virtual bool pathInfoIsUntrusted (const ValidPathInfo &)
virtual bool realisationIsUntrusted (const Realisation &)
virtual kj::Promise< Result< std::map< std::string, std::optional< StorePath > > > > queryStaticPartialDerivationOutputMap (const StorePath &path)
kj::Promise< Result< OutputPathMap > > queryDerivationOutputMap (const StorePath &path, Store *evalStore=nullptr)
virtual kj::Promise< Result< StorePath > > addToStoreRecursive (std::string_view name, const PreparedDump &source, HashType hashAlgo=HashType::SHA256, RepairFlag repair=NoRepair)
virtual kj::Promise< Result< StorePath > > addToStoreFlat (std::string_view name, const Path &srcPath, HashType hashAlgo=HashType::SHA256, RepairFlag repair=NoRepair)
kj::Promise< Result< ValidPathInfo > > addToStoreSlow (std::string_view name, const Path &srcPath, FileIngestionMethod method=FileIngestionMethod::Recursive, HashType hashAlgo=HashType::SHA256, std::optional< Hash > expectedCAHash={})
virtual kj::Promise< Result< void > > registerDrvOutput (const Realisation &output, CheckSigsFlag checkSigs)
kj::Promise< Result< std::string > > makeValidityRegistration (const StorePathSet &paths, bool showDerivers, bool showHash)
kj::Promise< Result< JSON > > pathInfoToJSON (const StorePathSet &storePaths, bool includeImpureInfo, bool showClosureSize, Base hashBase=Base::Base32, AllowInvalidFlag allowInvalid=DisallowInvalid)
kj::Promise< Result< std::pair< uint64_t, uint64_t > > > getClosureSize (const StorePath &storePath)
kj::Promise< Result< Derivation > > derivationFromPath (const StorePath &drvPath)
kj::Promise< Result< Derivation > > readDerivation (const StorePath &drvPath)
kj::Promise< Result< Derivation > > readInvalidDerivation (const StorePath &drvPath)
virtual kj::Promise< Result< void > > computeFSClosure (const StorePathSet &paths, StorePathSet &out, bool flipDirection=false, bool includeOutputs=false, bool includeDerivers=false)
kj::Promise< Result< void > > computeFSClosure (const StorePath &path, StorePathSet &out, bool flipDirection=false, bool includeOutputs=false, bool includeDerivers=false)
kj::Promise< Result< StorePaths > > topoSortPaths (const StorePathSet &paths)
kj::Promise< Result< void > > exportPaths (const StorePathSet &paths, Sink &sink)
kj::Promise< Result< void > > exportPath (const StorePath &path, Sink &sink)
kj::Promise< Result< StorePaths > > importPaths (Source &source, CheckSigsFlag checkSigs=CheckSigs)
kj::Promise< Result< Stats<> > > getStats ()
kj::Promise< Result< StorePathSet > > exportReferences (const StorePathSet &storePaths, const StorePathSet &inputPaths)
kj::Promise< Result< std::optional< StorePath > > > getBuildDerivationPath (const StorePath &)
kj::Promise< void > clearPathInfoCache ()
virtual Path toRealPath (const Path &storePath)
Path toRealPath (const StorePath &storePath)
Public Member Functions inherited from nix::LogStore
kj::Promise< Result< std::optional< std::string > > > getBuildLog (const StorePath &path)
virtual kj::Promise< Result< std::optional< std::string > > > getBuildLogExact (const StorePath &path)=0

Protected Member Functions

virtual ref< ConnectionopenConnection ()=0
void initConnection (Connection &conn)
virtual void setOptions (Connection &conn)
kj::Promise< Result< void > > setOptions () override
kj::Promise< Result< ConnectionHandle > > getConnection ()
virtual ref< FSAccessorgetFSAccessor () override
virtual kj::Promise< Result< box_ptr< Source > > > narFromPath (const StorePath &path) override
Protected Member Functions inherited from nix::Store
 Store (const StoreConfig &config)
void unsupported (const std::string &op)

Protected Attributes

ref< Pool< Connection > > connections
Protected Attributes inherited from nix::Store
Sync< State, AsyncMutex > state
std::shared_ptr< NarInfoDiskCachediskCache
Stats< std::atomic > stats

Friends

struct ConnectionHandle

Additional Inherited Members

Public Types inherited from nix::Store
using PathsSource
Static Public Member Functions inherited from nix::LogStore
static LogStorerequire (Store &store)
Static Public Attributes inherited from nix::Store
static constexpr const char * MissingName = "x"
Static Public Attributes inherited from nix::GcStore
static std::string operationName = "Garbage collection"
Static Public Attributes inherited from nix::LogStore
static std::string operationName = "Build log storage and retrieval"

Detailed Description

Todo
RemoteStore is a misnomer - should be something like DaemonStore.

Member Function Documentation

◆ addBuildLog()

kj::Promise< Result< void > > nix::RemoteStore::addBuildLog ( const StorePath & drvPath,
std::string_view log )
overridevirtual

Implements nix::LogStore.

◆ addCAToStore()

kj::Promise< Result< ref< const ValidPathInfo > > > nix::RemoteStore::addCAToStore ( AsyncInputStream & dump,
std::string_view name,
ContentAddressMethod caMethod,
HashType hashType,
const StorePathSet & references,
RepairFlag repair )

Add a content-addressable store path. dump will be drained.

◆ addMultipleToStore()

kj::Promise< Result< void > > nix::RemoteStore::addMultipleToStore ( PathsSource & pathsToCopy,
Activity & act,
RepairFlag repair,
CheckSigsFlag checkSigs )
overridevirtual

Import multiple paths into the store.

Reimplemented from nix::Store.

◆ addSignatures()

kj::Promise< Result< void > > nix::RemoteStore::addSignatures ( const StorePath & storePath,
const StringSet & sigs )
overridevirtual

Add signatures to the specified store path. The signatures are not verified.

Reimplemented from nix::Store.

◆ addTempRoot()

kj::Promise< Result< void > > nix::RemoteStore::addTempRoot ( const StorePath & path)
overridevirtual

Add a store path as a temporary root of the garbage collector. The root disappears as soon as we exit.

Reimplemented from nix::Store.

◆ addTextToStore()

kj::Promise< Result< StorePath > > nix::RemoteStore::addTextToStore ( std::string_view name,
std::string_view s,
const StorePathSet & references,
RepairFlag repair )
overridevirtual

Like addToStore, but the contents written to the output path is a regular file containing the given string.

Implements nix::Store.

◆ addToStore()

kj::Promise< Result< void > > nix::RemoteStore::addToStore ( const ValidPathInfo & info,
AsyncInputStream & narSource,
RepairFlag repair,
CheckSigsFlag checkSigs )
overridevirtual

Import a path into the store.

Implements nix::Store.

◆ addToStoreFromDump()

kj::Promise< Result< StorePath > > nix::RemoteStore::addToStoreFromDump ( AsyncInputStream & dump,
std::string_view name,
FileIngestionMethod method = FileIngestionMethod::Recursive,
HashType hashAlgo = HashType::SHA256,
RepairFlag repair = NoRepair,
const StorePathSet & references = StorePathSet() )
overridevirtual

Add a content-addressable store path. Does not support references. dump will be drained.

Reimplemented from nix::Store.

◆ buildDerivation()

kj::Promise< Result< BuildResult > > nix::RemoteStore::buildDerivation ( const StorePath & drvPath,
const BasicDerivation & drv,
BuildMode buildMode )
overridevirtual

Build a single non-materialized derivation (i.e. not from an on-disk .drv file).

Parameters
drvPathThis is used to deduplicate worker goals so it is imperative that is correct. That said, it doesn't literally need to be store path that would be calculated from writing this derivation to the store: it is OK if it instead is that of a Derivation which would resolve to this (by taking the outputs of it's input derivations and adding them as input sources) such that the build time referenceable-paths are the same.

In the input-addressed case, we usually do use an "original" unresolved derivations's path, as that is what will be used in the buildPaths case. Also, the input-addressed output paths are verified only by that contents of that specific unresolved derivation, so it is nice to keep that information around so if the original derivation is ever obtained later, it can be verified whether the trusted user in fact used the proper output path.

In the content-addressed case, we want to always use the resolved drv path calculated from the provided derivation. This serves two purposes:

  • It keeps the operation trustless, by ruling out a maliciously invalid drv path corresponding to a non-resolution-equivalent derivation.
  • For the floating case in particular, it ensures that the derivation to output mapping respects the resolution equivalence relation, so one cannot choose different resolution-equivalent derivations to subvert dependency coherence (i.e. the property that one doesn't end up with multiple different versions of dependencies without explicitly choosing to allow it).

Reimplemented from nix::Store.

◆ buildPaths()

kj::Promise< Result< void > > nix::RemoteStore::buildPaths ( const std::vector< DerivedPath > & paths,
BuildMode buildMode,
std::shared_ptr< Store > evalStore )
overridevirtual

For each path, if it's a derivation, build it. Building a derivation means ensuring that the output paths are valid. If they are already valid, this is a no-op. Otherwise, validity can be reached in two ways. First, if the output paths is substitutable, then build the path that way. Second, the output paths can be created by running the builder, after recursively building any sub-derivations. For inputs that are not derivations, substitute them.

Reimplemented from nix::Store.

◆ buildPathsWithResults()

kj::Promise< Result< std::vector< KeyedBuildResult > > > nix::RemoteStore::buildPathsWithResults ( const std::vector< DerivedPath > & paths,
BuildMode buildMode,
std::shared_ptr< Store > evalStore )
overridevirtual

Like buildPaths(), but return a vector of BuildResult BuildResults corresponding to each element in paths. Note that in case of a build/substitution error, this function won't throw an exception, but return a BuildResult containing an error message.

Reimplemented from nix::Store.

◆ collectGarbage()

kj::Promise< Result< void > > nix::RemoteStore::collectGarbage ( const GCOptions & options,
GCResults & results )
overridevirtual

Perform a garbage collection.

Implements nix::GcStore.

◆ config() [1/2]

const RemoteStoreConfig & nix::RemoteStore::config ( ) const
overridepure virtual

Implements nix::Store.

◆ config() [2/2]

RemoteStoreConfig & nix::RemoteStore::config ( )
overridepure virtual

Implements nix::Store.

◆ connect()

kj::Promise< Result< void > > nix::RemoteStore::connect ( )
overridevirtual

Establish a connection to the store, for store types that have a notion of connection. Otherwise this is a no-op.

Reimplemented from nix::Store.

◆ ensurePath()

kj::Promise< Result< void > > nix::RemoteStore::ensurePath ( const StorePath & path)
overridevirtual

Ensure that a path is valid. If it is not currently valid, it may be made valid by running a substitute (if defined for the path).

Reimplemented from nix::Store.

◆ findRoots()

kj::Promise< Result< Roots > > nix::RemoteStore::findRoots ( bool censor)
overridevirtual

Find the roots of the garbage collector. Each root is a pair (link, storepath) where link is the path of the symlink outside of the Nix store that point to storePath. If censor is true, privacy-sensitive information about roots found in /proc is censored.

Implements nix::GcStore.

◆ getFSAccessor()

ref< FSAccessor > nix::RemoteStore::getFSAccessor ( )
overrideprotectedvirtual
Returns
An object to access files in the Nix store.

Implements nix::Store.

Reimplemented in nix::UDSRemoteStore.

◆ getProtocol()

kj::Promise< Result< unsigned int > > nix::RemoteStore::getProtocol ( )
overridevirtual

Get the protocol version of this store or it's connection.

Reimplemented from nix::Store.

◆ getVersion()

kj::Promise< Result< std::optional< std::string > > > nix::RemoteStore::getVersion ( )
overridevirtual

Reimplemented from nix::Store.

◆ isTrustedClient()

kj::Promise< Result< std::optional< TrustedFlag > > > nix::RemoteStore::isTrustedClient ( )
overridevirtual
Returns
/ whether store trusts us.

std::nullopt means we do not know.

Note
This is the opposite of the StoreConfig::isTrusted store setting. That is about whether we trust the store.

Implements nix::Store.

◆ isValidPathUncached()

kj::Promise< Result< bool > > nix::RemoteStore::isValidPathUncached ( const StorePath & path)
overridevirtual

Reimplemented from nix::Store.

◆ narFromPath()

kj::Promise< Result< box_ptr< Source > > > nix::RemoteStore::narFromPath ( const StorePath & path)
overrideprotectedvirtual

Generate a NAR dump of a store path.

Implements nix::Store.

Reimplemented in nix::UDSRemoteStore.

◆ optimiseStore()

kj::Promise< Result< void > > nix::RemoteStore::optimiseStore ( )
overridevirtual

Optimise the disk space usage of the Nix store by hard-linking files with the same contents.

Reimplemented from nix::Store.

◆ queryAllValidPaths()

kj::Promise< Result< StorePathSet > > nix::RemoteStore::queryAllValidPaths ( )
overridevirtual

Query the set of all valid paths. Note that for some store backends, the name part of store paths may be replaced by 'x' (i.e. you'll get /nix/store/<hash>-x rather than /nix/store/<hash>-<name>). Use queryPathInfo() to obtain the full store path. FIXME: should return a set of std::variant<StorePath, HashPart> to get rid of this hack.

Reimplemented from nix::Store.

◆ queryDerivationOutputs()

kj::Promise< Result< StorePathSet > > nix::RemoteStore::queryDerivationOutputs ( const StorePath & path)
overridevirtual

Query the outputs of the derivation denoted by path.

Reimplemented from nix::Store.

◆ queryMissing()

kj::Promise< Result< void > > nix::RemoteStore::queryMissing ( const std::vector< DerivedPath > & targets,
StorePathSet & willBuild,
StorePathSet & willSubstitute,
StorePathSet & unknown,
uint64_t & downloadSize,
uint64_t & narSize )
overridevirtual

Given a set of paths that are to be built, return the set of derivations that will be built, and the set of output paths that will be substituted.

Reimplemented from nix::Store.

◆ queryPartialDerivationOutputMap()

kj::Promise< Result< std::map< std::string, std::optional< StorePath > > > > nix::RemoteStore::queryPartialDerivationOutputMap ( const StorePath & path,
Store * evalStore = nullptr )
overridevirtual

Query the mapping outputName => outputPath for the given derivation. All outputs are mentioned so ones mising the mapping are mapped to std::nullopt.

Reimplemented from nix::Store.

◆ queryPathFromHashPart()

kj::Promise< Result< std::optional< StorePath > > > nix::RemoteStore::queryPathFromHashPart ( const std::string & hashPart)
overridevirtual

Query the full store path given the hash part of a valid store path, or empty if the path doesn't exist.

Implements nix::Store.

◆ queryPathInfoUncached()

kj::Promise< Result< std::shared_ptr< const ValidPathInfo > > > nix::RemoteStore::queryPathInfoUncached ( const StorePath & path)
overridevirtual

Queries the path info without caching. Note to implementors: should return nullptr when the path is not found.

Implements nix::Store.

◆ queryRealisationUncached()

kj::Promise< Result< std::shared_ptr< const Realisation > > > nix::RemoteStore::queryRealisationUncached ( const DrvOutput & id)
overridevirtual

Implements nix::Store.

◆ queryReferrers()

kj::Promise< Result< void > > nix::RemoteStore::queryReferrers ( const StorePath & path,
StorePathSet & referrers )
overridevirtual

Queries the set of incoming FS references for a store path. The result is not cleared.

Reimplemented from nix::Store.

◆ querySubstitutablePathInfos()

kj::Promise< Result< void > > nix::RemoteStore::querySubstitutablePathInfos ( const StorePathCAMap & paths,
SubstitutablePathInfos & infos )
overridevirtual

Query substitute info (i.e. references, derivers and download sizes) of a map of paths to their optional ca values. The info of the first succeeding substituter for each path will be returned. If a path does not have substitute info, it's omitted from the resulting ‘infos’ map.

Reimplemented from nix::Store.

◆ querySubstitutablePaths()

kj::Promise< Result< StorePathSet > > nix::RemoteStore::querySubstitutablePaths ( const StorePathSet & paths)
overridevirtual

Query which of the given paths have substitutes.

Reimplemented from nix::Store.

◆ queryValidDerivers()

kj::Promise< Result< StorePathSet > > nix::RemoteStore::queryValidDerivers ( const StorePath & path)
overridevirtual
Returns
all currently valid derivations that have path as an output.

(Note that the result of queryDeriver() is the derivation that was actually used to produce path, which may not exist anymore.)

Reimplemented from nix::Store.

◆ queryValidPaths()

kj::Promise< Result< StorePathSet > > nix::RemoteStore::queryValidPaths ( const StorePathSet & paths,
SubstituteFlag maybeSubstitute = NoSubstitute )
overridevirtual

Query which of the given paths is valid. Optionally, try to substitute missing paths.

Reimplemented from nix::Store.

◆ registerDrvOutput()

kj::Promise< Result< void > > nix::RemoteStore::registerDrvOutput ( const Realisation & output)
overridevirtual

Add a mapping indicating that deriver!outputName maps to the output path output.

This is redundant for known-input-addressed and fixed-output derivations as this information is already present in the drv file, but necessary for floating-ca derivations and their dependencies as there's no way to retrieve this information otherwise.

Reimplemented from nix::Store.

◆ repairPath()

kj::Promise< Result< void > > nix::RemoteStore::repairPath ( const StorePath & path)
inlineoverridevirtual

The default instance would schedule the work on the client side, but for consistency with buildPaths and buildDerivation it should happen on the remote side.

We make this fail for now so we can add implement this properly later without it being a breaking change.

Reimplemented from nix::Store.

◆ setOptions()

kj::Promise< Result< void > > nix::RemoteStore::setOptions ( )
overrideprotectedvirtual

Synchronises the options of the client with those of the daemon (a no-op when there’s no daemon)

Reimplemented from nix::Store.

◆ verifyStore()

kj::Promise< Result< bool > > nix::RemoteStore::verifyStore ( bool checkContents,
RepairFlag repair )
overridevirtual

Check the integrity of the Nix store.

Returns
true if errors remain.

Reimplemented from nix::Store.


The documentation for this class was generated from the following files: