mirror of
https://github.com/NixOS/nix.git
synced 2025-12-13 12:31:04 +01:00
bbe97dff8b
Most functions now take a StorePath argument rather than a Path (which is just an alias for std::string). The StorePath constructor ensures that the path is syntactically correct (i.e. it looks like <store-dir>/<base32-hash>-<name>). Similarly, functions like buildPaths() now take a StorePathWithOutputs, rather than abusing Path by adding a '!<outputs>' suffix. Note that the StorePath type is implemented in Rust. This involves some hackery to allow Rust values to be used directly in C++, via a helper type whose destructor calls the Rust type's drop() function. The main issue is the dynamic nature of C++ move semantics: after we have moved a Rust value, we should not call the drop function on the original value. So when we move a value, we set the original value to bitwise zero, and the destructor only calls drop() if the value is not bitwise zero. This should be sufficient for most types. Also lots of minor cleanups to the C++ API to make it more modern (e.g. using std::optional and std::string_view in some places).
116 lines
3.5 KiB
C++
116 lines
3.5 KiB
C++
#pragma once
|
|
|
|
#include "crypto.hh"
|
|
#include "store-api.hh"
|
|
|
|
#include "pool.hh"
|
|
|
|
#include <atomic>
|
|
|
|
namespace nix {
|
|
|
|
struct NarInfo;
|
|
|
|
class BinaryCacheStore : public Store
|
|
{
|
|
public:
|
|
|
|
const Setting<std::string> compression{this, "xz", "compression", "NAR compression method ('xz', 'bzip2', or 'none')"};
|
|
const Setting<bool> writeNARListing{this, false, "write-nar-listing", "whether to write a JSON file listing the files in each NAR"};
|
|
const Setting<bool> writeDebugInfo{this, false, "index-debug-info", "whether to index DWARF debug info files by build ID"};
|
|
const Setting<Path> secretKeyFile{this, "", "secret-key", "path to secret key used to sign the binary cache"};
|
|
const Setting<Path> localNarCache{this, "", "local-nar-cache", "path to a local cache of NARs"};
|
|
const Setting<bool> parallelCompression{this, false, "parallel-compression",
|
|
"enable multi-threading compression, available for xz only currently"};
|
|
|
|
private:
|
|
|
|
std::unique_ptr<SecretKey> secretKey;
|
|
|
|
protected:
|
|
|
|
BinaryCacheStore(const Params & params);
|
|
|
|
public:
|
|
|
|
virtual bool fileExists(const std::string & path) = 0;
|
|
|
|
virtual void upsertFile(const std::string & path,
|
|
const std::string & data,
|
|
const std::string & mimeType) = 0;
|
|
|
|
/* Note: subclasses must implement at least one of the two
|
|
following getFile() methods. */
|
|
|
|
/* Dump the contents of the specified file to a sink. */
|
|
virtual void getFile(const std::string & path, Sink & sink);
|
|
|
|
/* Fetch the specified file and call the specified callback with
|
|
the result. A subclass may implement this asynchronously. */
|
|
virtual void getFile(const std::string & path,
|
|
Callback<std::shared_ptr<std::string>> callback) noexcept;
|
|
|
|
std::shared_ptr<std::string> getFile(const std::string & path);
|
|
|
|
protected:
|
|
|
|
bool wantMassQuery_ = false;
|
|
int priority = 50;
|
|
|
|
public:
|
|
|
|
virtual void init();
|
|
|
|
private:
|
|
|
|
std::string narMagic;
|
|
|
|
std::string narInfoFileFor(const StorePath & storePath);
|
|
|
|
void writeNarInfo(ref<NarInfo> narInfo);
|
|
|
|
public:
|
|
|
|
bool isValidPathUncached(const StorePath & path) override;
|
|
|
|
void queryPathInfoUncached(const StorePath & path,
|
|
Callback<std::shared_ptr<const ValidPathInfo>> callback) noexcept override;
|
|
|
|
std::optional<StorePath> queryPathFromHashPart(const std::string & hashPart) override
|
|
{ unsupported("queryPathFromHashPart"); }
|
|
|
|
bool wantMassQuery() override { return wantMassQuery_; }
|
|
|
|
void addToStore(const ValidPathInfo & info, const ref<std::string> & nar,
|
|
RepairFlag repair, CheckSigsFlag checkSigs,
|
|
std::shared_ptr<FSAccessor> accessor) override;
|
|
|
|
StorePath addToStore(const string & name, const Path & srcPath,
|
|
bool recursive, HashType hashAlgo,
|
|
PathFilter & filter, RepairFlag repair) override;
|
|
|
|
StorePath addTextToStore(const string & name, const string & s,
|
|
const StorePathSet & references, RepairFlag repair) override;
|
|
|
|
void narFromPath(const StorePath & path, Sink & sink) override;
|
|
|
|
BuildResult buildDerivation(const StorePath & drvPath, const BasicDerivation & drv,
|
|
BuildMode buildMode) override
|
|
{ unsupported("buildDerivation"); }
|
|
|
|
void ensurePath(const StorePath & path) override
|
|
{ unsupported("ensurePath"); }
|
|
|
|
ref<FSAccessor> getFSAccessor() override;
|
|
|
|
void addSignatures(const StorePath & storePath, const StringSet & sigs) override;
|
|
|
|
std::shared_ptr<std::string> getBuildLog(const StorePath & path) override;
|
|
|
|
int getPriority() override { return priority; }
|
|
|
|
};
|
|
|
|
MakeError(NoSuchBinaryCacheFile, Error);
|
|
|
|
}
|