2016-02-24 13:48:16 +00:00
|
|
|
#pragma once
|
2023-04-01 03:18:41 +00:00
|
|
|
///@file
|
2016-02-24 13:48:16 +00:00
|
|
|
|
|
|
|
#include "crypto.hh"
|
|
|
|
#include "store-api.hh"
|
2022-03-08 18:20:39 +00:00
|
|
|
#include "log-store.hh"
|
2016-02-24 13:48:16 +00:00
|
|
|
|
|
|
|
#include "pool.hh"
|
|
|
|
|
|
|
|
#include <atomic>
|
|
|
|
|
|
|
|
namespace nix {
|
|
|
|
|
|
|
|
struct NarInfo;
|
|
|
|
|
2020-09-10 08:55:51 +00:00
|
|
|
struct BinaryCacheStoreConfig : virtual StoreConfig
|
2016-02-24 13:48:16 +00:00
|
|
|
{
|
2020-09-10 08:55:51 +00:00
|
|
|
using StoreConfig::StoreConfig;
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2024-03-04 04:24:33 +00:00
|
|
|
const Setting<std::string> compression{this, "xz", "compression",
|
2023-03-22 13:23:36 +00:00
|
|
|
"NAR compression method (`xz`, `bzip2`, `gzip`, `zstd`, or `none`)."};
|
|
|
|
|
2024-03-04 04:24:33 +00:00
|
|
|
const Setting<bool> writeNARListing{this, false, "write-nar-listing",
|
2023-03-22 13:23:36 +00:00
|
|
|
"Whether to write a JSON file that lists the files in each NAR."};
|
|
|
|
|
2024-03-04 04:24:33 +00:00
|
|
|
const Setting<bool> writeDebugInfo{this, false, "index-debug-info",
|
2023-03-22 13:23:36 +00:00
|
|
|
R"(
|
|
|
|
Whether to index DWARF debug info files by build ID. This allows [`dwarffs`](https://github.com/edolstra/dwarffs) to
|
|
|
|
fetch debug info on demand
|
|
|
|
)"};
|
|
|
|
|
2024-03-04 04:24:33 +00:00
|
|
|
const Setting<Path> secretKeyFile{this, "", "secret-key",
|
2023-03-22 13:23:36 +00:00
|
|
|
"Path to the secret key used to sign the binary cache."};
|
|
|
|
|
2024-03-04 04:24:33 +00:00
|
|
|
const Setting<Path> localNarCache{this, "", "local-nar-cache",
|
2023-03-22 13:23:36 +00:00
|
|
|
"Path to a local cache of NARs fetched from this binary cache, used by commands such as `nix store cat`."};
|
|
|
|
|
2024-03-04 04:24:33 +00:00
|
|
|
const Setting<bool> parallelCompression{this, false, "parallel-compression",
|
2023-03-22 13:23:36 +00:00
|
|
|
"Enable multi-threaded compression of NARs. This is currently only available for `xz` and `zstd`."};
|
|
|
|
|
2024-03-04 04:24:33 +00:00
|
|
|
const Setting<int> compressionLevel{this, -1, "compression-level",
|
2023-03-22 13:23:36 +00:00
|
|
|
R"(
|
|
|
|
The *preset level* to be used when compressing NARs.
|
|
|
|
The meaning and accepted values depend on the compression method selected.
|
|
|
|
`-1` specifies that the default compression level should be used.
|
|
|
|
)"};
|
2020-09-10 08:55:51 +00:00
|
|
|
};
|
|
|
|
|
2023-04-07 13:55:28 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @note subclasses must implement at least one of the two
|
|
|
|
* virtual getFile() methods.
|
|
|
|
*/
|
2022-03-08 18:20:39 +00:00
|
|
|
class BinaryCacheStore : public virtual BinaryCacheStoreConfig,
|
|
|
|
public virtual Store,
|
|
|
|
public virtual LogStore
|
2020-09-10 08:55:51 +00:00
|
|
|
{
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2017-04-13 13:55:38 +00:00
|
|
|
private:
|
2016-04-29 15:02:57 +00:00
|
|
|
|
2017-04-13 13:55:38 +00:00
|
|
|
std::unique_ptr<SecretKey> secretKey;
|
2016-10-21 14:50:28 +00:00
|
|
|
|
2016-02-24 13:48:16 +00:00
|
|
|
protected:
|
|
|
|
|
2020-10-08 15:36:51 +00:00
|
|
|
// The prefix under which realisation infos will be stored
|
2021-05-04 08:35:34 +00:00
|
|
|
const std::string realisationsPrefix = "realisations";
|
2020-10-08 15:36:51 +00:00
|
|
|
|
2016-06-01 12:49:12 +00:00
|
|
|
BinaryCacheStore(const Params & params);
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2016-10-21 14:50:28 +00:00
|
|
|
public:
|
|
|
|
|
2016-02-24 13:48:16 +00:00
|
|
|
virtual bool fileExists(const std::string & path) = 0;
|
|
|
|
|
2017-03-14 14:26:01 +00:00
|
|
|
virtual void upsertFile(const std::string & path,
|
2020-07-13 18:07:19 +00:00
|
|
|
std::shared_ptr<std::basic_iostream<char>> istream,
|
2017-03-14 14:26:01 +00:00
|
|
|
const std::string & mimeType) = 0;
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2020-07-10 18:58:02 +00:00
|
|
|
void upsertFile(const std::string & path,
|
2022-01-18 15:14:01 +00:00
|
|
|
// FIXME: use std::string_view
|
2020-07-13 18:07:19 +00:00
|
|
|
std::string && data,
|
2020-07-10 18:58:02 +00:00
|
|
|
const std::string & mimeType);
|
|
|
|
|
2023-04-07 13:55:28 +00:00
|
|
|
/**
|
|
|
|
* Dump the contents of the specified file to a sink.
|
|
|
|
*/
|
2018-03-27 21:12:31 +00:00
|
|
|
virtual void getFile(const std::string & path, Sink & sink);
|
|
|
|
|
2024-04-27 17:55:54 +00:00
|
|
|
virtual std::optional<std::string> getFile(const std::string & path);
|
2016-02-24 13:48:16 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
|
2020-09-09 09:29:17 +00:00
|
|
|
virtual void init() override;
|
2016-02-24 13:48:16 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
|
2016-02-24 15:52:28 +00:00
|
|
|
std::string narMagic;
|
|
|
|
|
2019-12-05 18:11:09 +00:00
|
|
|
std::string narInfoFileFor(const StorePath & storePath);
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2017-11-14 17:44:05 +00:00
|
|
|
void writeNarInfo(ref<NarInfo> narInfo);
|
|
|
|
|
2020-09-23 14:40:41 +00:00
|
|
|
ref<const ValidPathInfo> addToStoreCommon(
|
2020-08-15 16:41:28 +00:00
|
|
|
Source & narSource, RepairFlag repair, CheckSigsFlag checkSigs,
|
|
|
|
std::function<ValidPathInfo(HashResult)> mkInfo);
|
|
|
|
|
2016-02-24 13:48:16 +00:00
|
|
|
public:
|
|
|
|
|
2019-12-05 18:11:09 +00:00
|
|
|
bool isValidPathUncached(const StorePath & path) override;
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2024-04-27 19:24:36 +00:00
|
|
|
std::shared_ptr<const ValidPathInfo> queryPathInfoUncached(const StorePath & path) override;
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2022-10-18 15:48:09 +00:00
|
|
|
std::optional<StorePath> queryPathFromHashPart(const std::string & hashPart) override;
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2020-05-29 20:19:48 +00:00
|
|
|
void addToStore(const ValidPathInfo & info, Source & narSource,
|
2020-07-13 15:37:44 +00:00
|
|
|
RepairFlag repair, CheckSigsFlag checkSigs) override;
|
2016-05-04 11:36:54 +00:00
|
|
|
|
2022-02-15 14:08:06 +00:00
|
|
|
StorePath addToStoreFromDump(Source & dump, std::string_view name,
|
|
|
|
FileIngestionMethod method, HashType hashAlgo, RepairFlag repair, const StorePathSet & references) override;
|
2020-08-15 16:41:28 +00:00
|
|
|
|
2022-02-25 15:00:00 +00:00
|
|
|
StorePath addToStore(
|
|
|
|
std::string_view name,
|
|
|
|
const Path & srcPath,
|
|
|
|
FileIngestionMethod method,
|
|
|
|
HashType hashAlgo,
|
|
|
|
PathFilter & filter,
|
|
|
|
RepairFlag repair,
|
|
|
|
const StorePathSet & references) override;
|
|
|
|
|
|
|
|
StorePath addTextToStore(
|
|
|
|
std::string_view name,
|
|
|
|
std::string_view s,
|
|
|
|
const StorePathSet & references,
|
|
|
|
RepairFlag repair) override;
|
2016-02-24 13:48:16 +00:00
|
|
|
|
2020-10-08 15:36:51 +00:00
|
|
|
void registerDrvOutput(const Realisation & info) override;
|
|
|
|
|
2024-04-27 21:44:12 +00:00
|
|
|
std::shared_ptr<const Realisation> queryRealisationUncached(const DrvOutput &) override;
|
2020-10-08 15:36:51 +00:00
|
|
|
|
2019-12-05 18:11:09 +00:00
|
|
|
void narFromPath(const StorePath & path, Sink & sink) override;
|
2016-03-21 16:55:57 +00:00
|
|
|
|
2016-02-25 16:43:19 +00:00
|
|
|
ref<FSAccessor> getFSAccessor() override;
|
|
|
|
|
2019-12-05 18:11:09 +00:00
|
|
|
void addSignatures(const StorePath & storePath, const StringSet & sigs) override;
|
2016-04-05 13:30:22 +00:00
|
|
|
|
2022-12-15 20:58:54 +00:00
|
|
|
std::optional<std::string> getBuildLogExact(const StorePath & path) override;
|
2017-03-13 13:07:58 +00:00
|
|
|
|
2022-01-18 15:14:01 +00:00
|
|
|
void addBuildLog(const StorePath & drvPath, std::string_view log) override;
|
|
|
|
|
2016-02-24 13:48:16 +00:00
|
|
|
};
|
|
|
|
|
2018-03-27 21:12:31 +00:00
|
|
|
MakeError(NoSuchBinaryCacheFile, Error);
|
|
|
|
|
2016-02-24 13:48:16 +00:00
|
|
|
}
|