nixos/nix
1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-14 22:42:41 +01:00
Code Activity

getUri should be const and on Store::Config not Store

Browse source 
It is a side-effect property of the configuration alone, not the rest of
the store.
This commit is contained in:
John Ericson 2025-08-11 17:28:01 -04:00
parent f93d25c0e7
commit 0ef6f72c9c
33 changed files with 123 additions and 122 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/libstore/binary-cache-store.cc
View file

@ -58,7 +58,10 @@ void BinaryCacheStore::init()
if (name == "StoreDir") {
if (value != storeDir)
throw Error(
"binary cache '%s' is for Nix stores with prefix '%s', not '%s'", getUri(), value, storeDir);
"binary cache '%s' is for Nix stores with prefix '%s', not '%s'",
config.getUri(),
value,
storeDir);
} else if (name == "WantMassQuery") {
config.wantMassQuery.setDefault(value == "1");
} else if (name == "Priority") {
@ -129,7 +132,8 @@ void BinaryCacheStore::writeNarInfo(ref<NarInfo> narInfo)
}
if (diskCache)
diskCache->upsertNarInfo(getUri(), std::string(narInfo->path.hashPart()), std::shared_ptr<NarInfo>(narInfo));
diskCache->upsertNarInfo(
config.getUri(), std::string(narInfo->path.hashPart()), std::shared_ptr<NarInfo>(narInfo));
}
ref<const ValidPathInfo> BinaryCacheStore::addToStoreCommon(
@ -427,7 +431,7 @@ void BinaryCacheStore::narFromPath(const StorePath & storePath, Sink & sink)
void BinaryCacheStore::queryPathInfoUncached(
const StorePath & storePath, Callback<std::shared_ptr<const ValidPathInfo>> callback) noexcept
{
auto uri = getUri();
auto uri = config.getUri();
auto storePathS = printStorePath(storePath);
auto act = std::make_shared<Activity>(
*logger,
@ -527,7 +531,7 @@ void BinaryCacheStore::queryRealisationUncached(
void BinaryCacheStore::registerDrvOutput(const Realisation & info)
{
if (diskCache)
diskCache->upsertRealisation(getUri(), info);
diskCache->upsertRealisation(config.getUri(), info);
auto filePath = realisationsPrefix + "/" + info.id.to_string() + ".doi";
upsertFile(filePath, info.toJSON().dump(), "application/json");
}
@ -555,7 +559,7 @@ std::optional<std::string> BinaryCacheStore::getBuildLogExact(const StorePath &
{
auto logPath = "log/" + std::string(baseNameOf(printStorePath(path)));
debug("fetching build log from binary cache '%s/%s'", getUri(), logPath);
debug("fetching build log from binary cache '%s/%s'", config.getUri(), logPath);
return getFile(logPath);
}

2
src/libstore/build/drv-output-substitution-goal.cc
View file

@ -98,7 +98,7 @@ Goal::Co DrvOutputSubstitutionGoal::init()
"substituter '%s' has an incompatible realisation for '%s', ignoring.\n"
"Local: %s\n"
"Remote: %s",
sub->getUri(),
sub->config.getUri(),
depId.to_string(),
worker.store.printStorePath(localOutputInfo->outPath),
worker.store.printStorePath(depPath));

7
src/libstore/build/substitution-goal.cc
View file

@ -101,7 +101,7 @@ Goal::Co PathSubstitutionGoal::init()
} else {
printError(
"asked '%s' for '%s' but got '%s'",
sub->getUri(),
sub->config.getUri(),
worker.store.printStorePath(storePath),
sub->printStorePath(info->path));
continue;
@ -127,7 +127,7 @@ Goal::Co PathSubstitutionGoal::init()
warn(
"ignoring substitute for '%s' from '%s', as it's not signed by any of the keys in 'trusted-public-keys'",
worker.store.printStorePath(storePath),
sub->getUri());
sub->config.getUri());
continue;
}
@ -217,7 +217,8 @@ Goal::Co PathSubstitutionGoal::tryToRun(
/* Wake up the worker loop when we're done. */
Finally updateStats([this]() { outPipe.writeSide.close(); });
Activity act(*logger, actSubstitute, Logger::Fields{worker.store.printStorePath(storePath), sub->getUri()});
Activity act(
*logger, actSubstitute, Logger::Fields{worker.store.printStorePath(storePath), sub->config.getUri()});
PushActivity pact(act.id);
copyStorePath(*sub, worker.store, subPath, repair, sub->config.isTrusted ? NoCheckSigs : CheckSigs);

10
src/libstore/dummy-store.cc
View file

@ -32,6 +32,11 @@ struct DummyStoreConfig : public std::enable_shared_from_this<DummyStoreConfig>,
}
ref<Store> openStore() const override;
std::string getUri() const override
{
return *uriSchemes().begin();
}
};
struct DummyStore : virtual Store
@ -46,11 +51,6 @@ struct DummyStore : virtual Store
{
}
std::string getUri() override
{
return *Config::uriSchemes().begin();
}
void queryPathInfoUncached(
const StorePath & path, Callback<std::shared_ptr<const ValidPathInfo>> callback) noexcept override
{

13
src/libstore/http-binary-cache-store.cc
View file

@ -62,11 +62,6 @@ public:
diskCache = getNarInfoDiskCache();
}
std::string getUri() override
{
return config->cacheUri;
}
void init() override
{
// FIXME: do this lazily?
@ -90,7 +85,7 @@ protected:
auto state(_state.lock());
if (state->enabled && settings.tryFallback) {
int t = 60;
printError("disabling binary cache '%s' for %s seconds", getUri(), t);
printError("disabling binary cache '%s' for %s seconds", config->getUri(), t);
state->enabled = false;
state->disabledUntil = std::chrono::steady_clock::now() + std::chrono::seconds(t);
}
@ -103,10 +98,10 @@ protected:
return;
if (std::chrono::steady_clock::now() > state->disabledUntil) {
state->enabled = true;
debug("re-enabling binary cache '%s'", getUri());
debug("re-enabling binary cache '%s'", config->getUri());
return;
}
throw SubstituterDisabled("substituter '%s' is disabled", getUri());
throw SubstituterDisabled("substituter '%s' is disabled", config->getUri());
}
bool fileExists(const std::string & path) override
@ -159,7 +154,7 @@ protected:
getFileTransfer()->download(std::move(request), sink);
} catch (FileTransferError & e) {
if (e.error == FileTransfer::NotFound || e.error == FileTransfer::Forbidden)
throw NoSuchBinaryCacheFile("file '%s' does not exist in binary cache '%s'", path, getUri());
throw NoSuchBinaryCacheFile("file '%s' does not exist in binary cache '%s'", path, config->getUri());
maybeDisable();
throw;
}

5
src/libstore/include/nix/store/http-binary-cache-store.hh
View file

@ -23,6 +23,11 @@ struct HttpBinaryCacheStoreConfig : std::enable_shared_from_this<HttpBinaryCache
static std::string doc();
ref<Store> openStore() const override;
std::string getUri() const override
{
return cacheUri;
}
};
} // namespace nix

4
src/libstore/include/nix/store/legacy-ssh-store.hh
View file

@ -53,6 +53,8 @@ struct LegacySSHStoreConfig : std::enable_shared_from_this<LegacySSHStoreConfig>
static std::string doc();
ref<Store> openStore() const override;
std::string getUri() const override;
};
struct LegacySSHStore : public virtual Store
@ -71,8 +73,6 @@ struct LegacySSHStore : public virtual Store
ref<Connection> openConnection();
std::string getUri() override;
void queryPathInfoUncached(
const StorePath & path, Callback<std::shared_ptr<const ValidPathInfo>> callback) noexcept override;

2
src/libstore/include/nix/store/local-binary-cache-store.hh
View file

@ -26,6 +26,8 @@ struct LocalBinaryCacheStoreConfig : std::enable_shared_from_this<LocalBinaryCac
static std::string doc();
ref<Store> openStore() const override;
std::string getUri() const override;
};
} // namespace nix

10
src/libstore/include/nix/store/local-overlay-store.hh
View file

@ -88,6 +88,11 @@ struct LocalOverlayStoreConfig : virtual LocalStoreConfig
ref<Store> openStore() const override;
std::string getUri() const override
{
return "local-overlay://";
}
protected:
/**
* @return The host OS path corresponding to the store path for the
@ -116,11 +121,6 @@ struct LocalOverlayStore : virtual LocalStore
LocalOverlayStore(ref<const Config>);
std::string getUri() override
{
return "local-overlay://";
}
private:
/**
* The store beneath us.

4
src/libstore/include/nix/store/local-store.hh
View file

@ -111,6 +111,8 @@ struct LocalStoreConfig : std::enable_shared_from_this<LocalStoreConfig>,
static std::string doc();
ref<Store> openStore() const override;
std::string getUri() const override;
};
class LocalStore : public virtual IndirectRootStore, public virtual GcStore
@ -196,8 +198,6 @@ public:
* Implementations of abstract store API methods.
*/
std::string getUri() override;
bool isValidPathUncached(const StorePath & path) override;
StorePathSet queryValidPaths(const StorePathSet & paths, SubstituteFlag maybeSubstitute = NoSubstitute) override;

2
src/libstore/include/nix/store/s3-binary-cache-store.hh
View file

@ -106,6 +106,8 @@ public:
static std::string doc();
ref<Store> openStore() const override;
std::string getUri() const override;
};
struct S3BinaryCacheStore : virtual BinaryCacheStore

2
src/libstore/include/nix/store/ssh-store.hh
View file

@ -33,6 +33,8 @@ struct SSHStoreConfig : std::enable_shared_from_this<SSHStoreConfig>,
static std::string doc();
ref<Store> openStore() const override;
std::string getUri() const override;
};
struct MountedSSHStoreConfig : virtual SSHStoreConfig, virtual LocalFSStoreConfig

15
src/libstore/include/nix/store/store-api.hh
View file

@ -197,6 +197,13 @@ struct StoreConfig : public StoreDirConfig
* type.
*/
virtual ref<Store> openStore() const = 0;
/**
* Render the config back to a "store URL". It should round-trip
* with `resolveStoreConfig` (for stores configs that are
* registered).
*/
virtual std::string getUri() const;
};
/**
@ -277,12 +284,6 @@ public:
virtual ~Store() {}
/**
* @todo move to `StoreConfig` one we store enough information in
* those to recover the scheme and authority in all cases.
*/
virtual std::string getUri() = 0;
/**
* Follow symlinks until we end up with a path in the Nix store.
*/
@ -872,7 +873,7 @@ protected:
*/
[[noreturn]] void unsupported(const std::string & op)
{
throw Unsupported("operation '%s' is not supported by store '%s'", op, getUri());
throw Unsupported("operation '%s' is not supported by store '%s'", op, config.getUri());
}
};

2
src/libstore/include/nix/store/store-cast.hh
View file

@ -17,7 +17,7 @@ T & require(Store & store)
{
auto * castedStore = dynamic_cast<T *>(&store);
if (!castedStore)
throw UsageError("%s not supported by store '%s'", T::operationName, store.getUri());
throw UsageError("%s not supported by store '%s'", T::operationName, store.config.getUri());
return *castedStore;
}

4
src/libstore/include/nix/store/uds-remote-store.hh
View file

@ -44,6 +44,8 @@ struct UDSRemoteStoreConfig : std::enable_shared_from_this<UDSRemoteStoreConfig>
}
ref<Store> openStore() const override;
std::string getUri() const override;
};
struct UDSRemoteStore : virtual IndirectRootStore, virtual RemoteStore
@ -54,8 +56,6 @@ struct UDSRemoteStore : virtual IndirectRootStore, virtual RemoteStore
UDSRemoteStore(ref<const Config>);
std::string getUri() override;
ref<SourceAccessor> getFSAccessor(bool requireValidPath = true) override
{
return LocalFSStore::getFSAccessor(requireValidPath);

6
src/libstore/legacy-ssh-store.cc
View file

@ -88,11 +88,9 @@ ref<LegacySSHStore::Connection> LegacySSHStore::openConnection()
return conn;
};
std::string LegacySSHStore::getUri()
std::string LegacySSHStoreConfig::getUri() const
{
return ParsedURL{
.scheme = *Config::uriSchemes().begin(), .authority = config->authority, .query = config->getQueryParams()}
.to_string();
return ParsedURL{.scheme = *uriSchemes().begin(), .authority = authority, .query = getQueryParams()}.to_string();
}
std::map<StorePath, UnkeyedValidPathInfo> LegacySSHStore::queryPathInfosUncached(const StorePathSet & paths)

10
src/libstore/local-binary-cache-store.cc
View file

@ -23,6 +23,11 @@ std::string LocalBinaryCacheStoreConfig::doc()
;
}
std::string LocalBinaryCacheStoreConfig::getUri() const
{
return "file://" + binaryCacheDir;
}
struct LocalBinaryCacheStore : virtual BinaryCacheStore
{
using Config = LocalBinaryCacheStoreConfig;
@ -38,11 +43,6 @@ struct LocalBinaryCacheStore : virtual BinaryCacheStore
void init() override;
std::string getUri() override
{
return "file://" + config->binaryCacheDir;
}
protected:
bool fileExists(const std::string & path) override;

6
src/libstore/local-store.cc
View file

@ -439,11 +439,11 @@ LocalStore::~LocalStore()
}
}
std::string LocalStore::getUri()
std::string LocalStoreConfig::getUri() const
{
std::ostringstream oss;
oss << *config->uriSchemes().begin();
auto queryParams = config->getQueryParams();
oss << *uriSchemes().begin();
auto queryParams = getQueryParams();
if (!queryParams.empty())
oss << "?";
oss << encodeQuery(queryParams);

4
src/libstore/remote-store.cc
View file

@ -53,7 +53,7 @@ RemoteStore::RemoteStore(const Config & config)
ref<RemoteStore::Connection> RemoteStore::openConnectionWrapper()
{
if (failed)
throw Error("opening a connection to remote store '%s' previously failed", getUri());
throw Error("opening a connection to remote store '%s' previously failed", config.getUri());
try {
return openConnection();
} catch (...) {
@ -95,7 +95,7 @@ void RemoteStore::initConnection(Connection & conn)
if (ex)
std::rethrow_exception(ex);
} catch (Error & e) {
throw Error("cannot open connection to remote store '%s': %s", getUri(), e.what());
throw Error("cannot open connection to remote store '%s': %s", config.getUri(), e.what());
}
setOptions(conn);

5
src/libstore/restricted-store.cc
View file

@ -57,11 +57,6 @@ struct RestrictedStore : public virtual IndirectRootStore, public virtual GcStor
return next->config->realStoreDir;
}
std::string getUri() override
{
return next->getUri();
}
StorePathSet queryAllValidPaths() override;
void queryPathInfoUncached(

16
src/libstore/s3-binary-cache-store.cc
View file

@ -254,6 +254,11 @@ std::string S3BinaryCacheStoreConfig::doc()
;
}
std::string S3BinaryCacheStoreConfig::getUri() const
{
return "s3://" + bucketName;
}
struct S3BinaryCacheStoreImpl : virtual S3BinaryCacheStore
{
Stats stats;
@ -269,19 +274,14 @@ struct S3BinaryCacheStoreImpl : virtual S3BinaryCacheStore
diskCache = getNarInfoDiskCache();
}
std::string getUri() override
{
return "s3://" + config->bucketName;
}
void init() override
{
if (auto cacheInfo = diskCache->upToDateCacheExists(getUri())) {
if (auto cacheInfo = diskCache->upToDateCacheExists(config->getUri())) {
config->wantMassQuery.setDefault(cacheInfo->wantMassQuery);
config->priority.setDefault(cacheInfo->priority);
} else {
BinaryCacheStore::init();
diskCache->createCache(getUri(), config->storeDir, config->wantMassQuery, config->priority);
diskCache->createCache(config->getUri(), config->storeDir, config->wantMassQuery, config->priority);
}
}
@ -519,7 +519,7 @@ struct S3BinaryCacheStoreImpl : virtual S3BinaryCacheStore
sink(*res.data);
} else
throw NoSuchBinaryCacheFile("file '%s' does not exist in binary cache '%s'", path, getUri());
throw NoSuchBinaryCacheFile("file '%s' does not exist in binary cache '%s'", path, config->getUri());
}
StorePathSet queryAllValidPaths() override

12
src/libstore/ssh-store.cc
View file

@ -25,6 +25,11 @@ std::string SSHStoreConfig::doc()
;
}
std::string SSHStoreConfig::getUri() const
{
return ParsedURL{.scheme = *uriSchemes().begin(), .authority = authority, .query = getQueryParams()}.to_string();
}
struct SSHStore : virtual RemoteStore
{
using Config = SSHStoreConfig;
@ -41,13 +46,6 @@ struct SSHStore : virtual RemoteStore
{
}
std::string getUri() override
{
return ParsedURL{
.scheme = *Config::uriSchemes().begin(), .authority = config->authority, .query = config->getQueryParams()}
.to_string();
}
// FIXME extend daemon protocol, move implementation to RemoteStore
std::optional<std::string> getBuildLogExact(const StorePath & path) override
{

34
src/libstore/store-api.cc
View file

@ -300,7 +300,7 @@ Store::Store(const Store::Config & config)
assertLibStoreInitialized();
}
std::string Store::getUri()
std::string StoreConfig::getUri() const
{
return "";
}
@ -395,11 +395,11 @@ void Store::querySubstitutablePathInfos(const StorePathCAMap & paths, Substituta
"replaced path '%s' with '%s' for substituter '%s'",
printStorePath(path.first),
sub->printStorePath(subPath),
sub->getUri());
sub->config.getUri());
} else if (sub->storeDir != storeDir)
continue;
debug("checking substituter '%s' for path '%s'", sub->getUri(), sub->printStorePath(subPath));
debug("checking substituter '%s' for path '%s'", sub->config.getUri(), sub->printStorePath(subPath));
try {
auto info = sub->queryPathInfo(subPath);
@ -439,7 +439,7 @@ bool Store::isValidPath(const StorePath & storePath)
}
if (diskCache) {
auto res = diskCache->lookupNarInfo(getUri(), std::string(storePath.hashPart()));
auto res = diskCache->lookupNarInfo(config.getUri(), std::string(storePath.hashPart()));
if (res.first != NarInfoDiskCache::oUnknown) {
stats.narInfoReadAverted++;
auto state_(state.lock());
@ -455,7 +455,7 @@ bool Store::isValidPath(const StorePath & storePath)
if (diskCache && !valid)
// FIXME: handle valid = true case.
diskCache->upsertNarInfo(getUri(), std::string(storePath.hashPart()), 0);
diskCache->upsertNarInfo(config.getUri(), std::string(storePath.hashPart()), 0);
return valid;
}
@ -509,7 +509,7 @@ std::optional<std::shared_ptr<const ValidPathInfo>> Store::queryPathInfoFromClie
}
if (diskCache) {
auto res = diskCache->lookupNarInfo(getUri(), hashPart);
auto res = diskCache->lookupNarInfo(config.getUri(), hashPart);
if (res.first != NarInfoDiskCache::oUnknown) {
stats.narInfoReadAverted++;
{
@ -554,7 +554,7 @@ void Store::queryPathInfo(const StorePath & storePath, Callback<ref<const ValidP
auto info = fut.get();
if (diskCache)
diskCache->upsertNarInfo(getUri(), hashPart, info);
diskCache->upsertNarInfo(config.getUri(), hashPart, info);
{
auto state_(state.lock());
@ -578,7 +578,7 @@ void Store::queryRealisation(const DrvOutput & id, Callback<std::shared_ptr<cons
try {
if (diskCache) {
auto [cacheOutcome, maybeCachedRealisation] = diskCache->lookupRealisation(getUri(), id);
auto [cacheOutcome, maybeCachedRealisation] = diskCache->lookupRealisation(config.getUri(), id);
switch (cacheOutcome) {
case NarInfoDiskCache::oValid:
debug("Returning a cached realisation for %s", id.to_string());
@ -604,9 +604,9 @@ void Store::queryRealisation(const DrvOutput & id, Callback<std::shared_ptr<cons
if (diskCache) {
if (info)
diskCache->upsertRealisation(getUri(), *info);
diskCache->upsertRealisation(config.getUri(), *info);
else
diskCache->upsertAbsentRealisation(getUri(), id);
diskCache->upsertAbsentRealisation(config.getUri(), id);
}
(*callbackPtr)(std::shared_ptr<const Realisation>(info));
@ -801,8 +801,8 @@ void copyStorePath(
if (!repair && dstStore.isValidPath(storePath))
return;
auto srcUri = srcStore.getUri();
auto dstUri = dstStore.getUri();
auto srcUri = srcStore.config.getUri();
auto dstUri = dstStore.config.getUri();
auto storePathS = srcStore.printStorePath(storePath);
Activity act(
*logger, lvlInfo, actCopyPath, makeCopyPathMessage(srcUri, dstUri, storePathS), {storePathS, srcUri, dstUri});
@ -839,7 +839,9 @@ void copyStorePath(
},
[&]() {
throw EndOfFile(
"NAR for '%s' fetched from '%s' is incomplete", srcStore.printStorePath(storePath), srcStore.getUri());
"NAR for '%s' fetched from '%s' is incomplete",
srcStore.printStorePath(storePath),
srcStore.config.getUri());
});
dstStore.addToStore(*info, *source, repair, checkSigs);
@ -937,7 +939,7 @@ std::map<StorePath, StorePath> copyPaths(
"replaced path '%s' to '%s' for substituter '%s'",
srcStore.printStorePath(storePathForSrc),
dstStore.printStorePath(storePathForDst),
dstStore.getUri());
dstStore.config.getUri());
}
return storePathForDst;
};
@ -955,8 +957,8 @@ std::map<StorePath, StorePath> copyPaths(
// We can reasonably assume that the copy will happen whenever we
// read the path, so log something about that at that point
uint64_t total = 0;
auto srcUri = srcStore.getUri();
auto dstUri = dstStore.getUri();
auto srcUri = srcStore.config.getUri();
auto dstUri = dstStore.config.getUri();
auto storePathS = srcStore.printStorePath(missingPath);
Activity act(
*logger,

13
src/libstore/uds-remote-store.cc
View file

@ -54,15 +54,14 @@ UDSRemoteStore::UDSRemoteStore(ref<const Config> config)
{
}
std::string UDSRemoteStore::getUri()
std::string UDSRemoteStoreConfig::getUri() const
{
return config->path == settings.nixDaemonSocketFile
? // FIXME: Not clear why we return daemon here and not default
// to settings.nixDaemonSocketFile
//
// unix:// with no path also works. Change what we return?
return path == settings.nixDaemonSocketFile ? // FIXME: Not clear why we return daemon here and not default
// to settings.nixDaemonSocketFile
//
// unix:// with no path also works. Change what we return?
"daemon"
: std::string(*Config::uriSchemes().begin()) + "://" + config->path;
: std::string(*uriSchemes().begin()) + "://" + path;
}
void UDSRemoteStore::Connection::closeWrite()