Get settings info out of headers, out of libutil

maintainers/flake-module.nix

@@ -126,8 +126,14 @@
  ''^src/libflake/flake/lockfile\.cc$''
  ''^src/libflake/flake/lockfile\.hh$''
  ''^src/libflake/flake/url-name\.cc$''
+ ''^src/libmain/args/root\.hh$''
+ ''^src/libmain/args\.cc$''
+ ''^src/libmain/args\.hh$''
  ''^src/libmain/common-args\.cc$''
  ''^src/libmain/common-args\.hh$''
+ ''^src/libmain/config-impl\.hh$''
+ ''^src/libmain/config\.cc$''
+ ''^src/libmain/config\.hh$''
  ''^src/libmain/loggers\.cc$''
  ''^src/libmain/loggers\.hh$''
  ''^src/libmain/progress-bar\.cc$''
@@ -258,19 +264,13 @@
  ''^src/libutil-c/nix_api_util_internal\.h$''
  ''^src/libutil/archive\.cc$''
  ''^src/libutil/archive\.hh$''
- ''^src/libutil/args\.cc$''
- ''^src/libutil/args\.hh$''
- ''^src/libutil/args/root\.hh$''
  ''^src/libutil/callback\.hh$''
  ''^src/libutil/canon-path\.cc$''
  ''^src/libutil/canon-path\.hh$''
  ''^src/libutil/chunked-vector\.hh$''
  ''^src/libutil/closure\.hh$''
  ''^src/libutil/comparator\.hh$''
  ''^src/libutil/compute-levels\.cc$''
- ''^src/libutil/config-impl\.hh$''
- ''^src/libutil/config\.cc$''
- ''^src/libutil/config\.hh$''
  ''^src/libutil/current-process\.cc$''
  ''^src/libutil/current-process\.hh$''
  ''^src/libutil/english\.cc$''

src/build-remote/build-remote.cc

@@ -16,7 +16,7 @@
 #include "globals.hh"
 #include "serialise.hh"
 #include "build-result.hh"
-#include "store-api.hh"
+#include "store-open.hh"
 #include "strings.hh"
 #include "derivations.hh"
 #include "local-store.hh"

src/libcmd/command.cc

@@ -2,7 +2,7 @@
 
 #include "command.hh"
 #include "markdown.hh"
-#include "store-api.hh"
+#include "store-open.hh"
 #include "local-fs-store.hh"
 #include "derivations.hh"
 #include "nixexpr.hh"

src/libcmd/common-eval-args.cc

@@ -9,7 +9,7 @@
 #include "registry.hh"
 #include "flake/flakeref.hh"
 #include "flake/settings.hh"
-#include "store-api.hh"
+#include "store-open.hh"
 #include "command.hh"
 #include "tarball.hh"
 #include "fetch-to-store.hh"

src/libcmd/repl.cc

@@ -12,7 +12,7 @@
 #include "eval-settings.hh"
 #include "attr-path.hh"
 #include "signals.hh"
-#include "store-api.hh"
+#include "store-open.hh"
 #include "log-store.hh"
 #include "common-eval-args.hh"
 #include "get-drvs.hh"
@@ -635,7 +635,7 @@ ProcessLineResult NixRepl::processLine(std::string line)
  // When missing, trigger the normal exception
  // e.g. :doc builtins.foo
  // behaves like
- // nix-repl> builtins.foo 
+ // nix-repl> builtins.foo
  // error: attribute 'foo' missing
  evalString(arg, v);
  assert(false);

src/libexpr/primops/fetchClosure.cc

@@ -1,5 +1,5 @@
 #include "primops.hh"
-#include "store-api.hh"
+#include "store-open.hh"
 #include "realisation.hh"
 #include "make-content-addressed.hh"
 #include "url.hh"

src/libmain/config-upstream.cc

@@ -0,0 +1,44 @@
+namespace nix {
+
+#include "fs-sink.hh"
+#include "logging.hh"
+
+struct LoggerSettings : Config
+{
+ Setting<bool> showTrace{
+ this,
+ false,
+ "show-trace",
+ R"(
+ Whether Nix should print out a stack trace in case of Nix
+ expression evaluation errors.
+ )"};
+};
+
+static GlobalConfig::Register r1(&restoreSinkSettings);
+
+struct RestoreSinkSettings : Config
+{
+ Setting<bool> preallocateContents{
+ this, false, "preallocate-contents", "Whether to preallocate files when writing objects with known size."};
+};
+
+static GlobalConfig::Register rLoggerSettings(&loggerSettings);
+
+struct ArchiveSettings : Config
+{
+ Setting<bool> useCaseHack
+ {
+ this,
+#if __APPLE__
+ true,
+#else
+ false,
+#endif
+ "use-case-hack", "Whether to enable a Darwin-specific hack for dealing with file name collisions."
+ };
+};
+
+static GlobalConfig::Register rArchiveSettings(&archiveSettings);
+
+}

src/libutil/config.cc → src/libmain/config.cc

@@ -452,26 +452,4 @@ void OptionalPathSetting::operator =(const std::optional<Path> & v)
  this->assign(v);
 }
 
-bool ExperimentalFeatureSettings::isEnabled(const ExperimentalFeature & feature) const
-{
- auto & f = experimentalFeatures.get();
- return std::find(f.begin(), f.end(), feature) != f.end();
-}
-
-void ExperimentalFeatureSettings::require(const ExperimentalFeature & feature) const
-{
- if (!isEnabled(feature))
- throw MissingExperimentalFeature(feature);
-}
-
-bool ExperimentalFeatureSettings::isEnabled(const std::optional<ExperimentalFeature> & feature) const
-{
- return !feature || isEnabled(*feature);
-}
-
-void ExperimentalFeatureSettings::require(const std::optional<ExperimentalFeature> & feature) const
-{
- if (feature) require(*feature);
-}
-
 }

src/libutil/config.hh → src/libmain/config.hh

@@ -257,9 +257,6 @@ public:
  , documentDefault(documentDefault)
  { }
 
- operator const T &() const { return value; }
- operator T &() { return value; }
- const T & get() const { return value; }
  template<typename U>
  bool operator ==(const U & v2) const { return value == v2; }
  template<typename U>

src/libstore-c/nix_api_store.cc

@@ -5,6 +5,7 @@
 
 #include "path.hh"
 #include "store-api.hh"
+#include "store-open.hh"
 #include "build-result.hh"
 
 #include "globals.hh"
@@ -42,7 +43,7 @@ Store * nix_store_open(nix_c_context * context, const char * uri, const char ***
  if (!params)
  return new Store{nix::openStore(uri_str)};
 
- nix::Store::Params params_map;
+ nix::StoreReference::Params params_map;
  for (size_t i = 0; params[i] != nullptr; i++) {
  params_map[params[i][0]] = params[i][1];
  }

src/libstore/binary-cache-store.cc

@@ -13,6 +13,7 @@
 #include "callback.hh"
 #include "signals.hh"
 #include "archive.hh"
+#include "config-parse-impl.hh"
 
 #include <chrono>
 #include <future>
@@ -24,9 +25,74 @@
 
 namespace nix {
 
-BinaryCacheStore::BinaryCacheStore(const Params & params)
- : BinaryCacheStoreConfig(params)
- , Store(params)
+BinaryCacheStore::Config::Descriptions::Descriptions()
+ : Store::Config::Descriptions{Store::Config::descriptions}
+ , BinaryCacheStoreConfigT<config::SettingInfo>{
+ .compression = {
+ .name = "compression",
+ .description = "NAR compression method (`xz`, `bzip2`, `gzip`, `zstd`, or `none`).",
+ },
+ .writeNARListing = {
+ .name = "write-nar-listing",
+ .description = "Whether to write a JSON file that lists the files in each NAR.",
+ },
+ .writeDebugInfo = {
+ .name = "index-debug-info",
+ .description = 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
+ )",
+ },
+ .secretKeyFile{
+ .name = "secret-key",
+ .description = "Path to the secret key used to sign the binary cache.",
+ },
+ .localNarCache{
+ .name = "local-nar-cache",
+ .description = "Path to a local cache of NARs fetched from this binary cache, used by commands such as `nix store cat`.",
+ },
+ .parallelCompression{
+ .name = "parallel-compression",
+ .description = "Enable multi-threaded compression of NARs. This is currently only available for `xz` and `zstd`.",
+ },
+ .compressionLevel{
+ .name = "compression-level",
+ .description = 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.
+ )",
+ },
+ }
+{}
+
+const BinaryCacheStore::Config::Descriptions BinaryCacheStore::Config::descriptions{};
+
+decltype(BinaryCacheStore::Config::defaults) BinaryCacheStore::Config::defaults = {
+ .compression = {"xz"},
+ .writeNARListing{false},
+ .writeDebugInfo{false},
+ .secretKeyFile{""},
+ .localNarCache{""},
+ .parallelCompression{false},
+ .compressionLevel{-1},
+};
+
+BinaryCacheStore::Config::BinaryCacheStoreConfig(const StoreReference::Params & params)
+ : StoreConfig{params}
+ , BinaryCacheStoreConfigT<config::JustValue>{
+ CONFIG_ROW(compression),
+ CONFIG_ROW(secretKeyFile),
+ CONFIG_ROW(localNarCache),
+ CONFIG_ROW(parallelCompression),
+ CONFIG_ROW(compressionLevel),
+ }
+{
+}
+
+BinaryCacheStore::BinaryCacheStore(const Config & config)
+ : Config{config}
+ , Store{static_cast<const Store::Config &>(*this)}
 {
  if (secretKeyFile != "")
  signer = std::make_unique<LocalSigner>(

src/libstore/binary-cache-store.hh

@@ -13,48 +13,46 @@ namespace nix {
 
 struct NarInfo;
 
-struct BinaryCacheStoreConfig : virtual StoreConfig
+template<template<typename> class F>
+struct BinaryCacheStoreConfigT
 {
- using StoreConfig::StoreConfig;
-
- const Setting<std::string> compression{this, "xz", "compression",
- "NAR compression method (`xz`, `bzip2`, `gzip`, `zstd`, or `none`)."};
-
- const Setting<bool> writeNARListing{this, false, "write-nar-listing",
- "Whether to write a JSON file that lists the files in each NAR."};
-
- const Setting<bool> writeDebugInfo{this, false, "index-debug-info",
- 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
- )"};
+ const F<std::string> compression;
+ const F<bool> writeNARListing;
+ const F<bool> writeDebugInfo;
+ const F<Path> secretKeyFile;
+ const F<Path> localNarCache;
+ const F<bool> parallelCompression;
+ const F<int> compressionLevel;
+};
 
- const Setting<Path> secretKeyFile{this, "", "secret-key",
- "Path to the secret key used to sign the binary cache."};
+struct BinaryCacheStoreConfig :
+ virtual Store::Config,
+ BinaryCacheStoreConfigT<config::JustValue>
+{
+ struct Descriptions :
+ virtual Store::Config::Descriptions,
+ BinaryCacheStoreConfigT<config::SettingInfo>
+ {
+ Descriptions();
+ };
 
- const Setting<Path> localNarCache{this, "", "local-nar-cache",
- "Path to a local cache of NARs fetched from this binary cache, used by commands such as `nix store cat`."};
+ static const Descriptions descriptions;
 
- const Setting<bool> parallelCompression{this, false, "parallel-compression",
- "Enable multi-threaded compression of NARs. This is currently only available for `xz` and `zstd`."};
+ static BinaryCacheStoreConfigT<config::JustValue> defaults;
 
- const Setting<int> compressionLevel{this, -1, "compression-level",
- 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.
- )"};
+ BinaryCacheStoreConfig(const StoreReference::Params &);
 };
 
-
 /**
  * @note subclasses must implement at least one of the two
  * virtual getFile() methods.
  */
-class BinaryCacheStore : public virtual BinaryCacheStoreConfig,
- public virtual Store,
- public virtual LogStore
+struct BinaryCacheStore :
+ virtual BinaryCacheStoreConfig,
+ virtual Store,
+ virtual LogStore
 {
+ using Config = BinaryCacheStoreConfig;
 
 private:
  std::unique_ptr<Signer> signer;
@@ -64,7 +62,7 @@ protected:
  // The prefix under which realisation infos will be stored
  const std::string realisationsPrefix = "realisations";
 
- BinaryCacheStore(const Params & params);
+ BinaryCacheStore(const Config &);
 
 public:
 
@@ -96,7 +94,11 @@ public:
 
 public:
 
- virtual void init() override;
+ /**
+ * Perform any necessary effectful operation to make the store up and
+ * running
+ */
+ virtual void init();
 
 private:
 

src/libstore/build/drv-output-substitution-goal.cc

@@ -3,6 +3,7 @@
 #include "worker.hh"
 #include "substitution-goal.hh"
 #include "callback.hh"
+#include "store-open.hh"
 
 namespace nix {
 

src/libstore/build/substitution-goal.cc

@@ -1,4 +1,5 @@
 #include "worker.hh"
+#include "store-open.hh"
 #include "substitution-goal.hh"
 #include "nar-info.hh"
 #include "finally.hh"