[kernel 3c/n] Decouple validation cache initialization from `ArgsManager` #25527

  60 | @@ -61,8 +61,8 @@ int main(int argc, char* argv[])
  61 |      // Necessary for CheckInputScripts (eventually called by ProcessNewBlock),
  62 |      // which will try the script cache first and fall back to actually
  63 |      // performing the check with the signature cache.
  64 | -    InitSignatureCache();
  65 | -    InitScriptExecutionCache();
  66 | +    assert(InitSignatureCache());

---

  99 |      // setup_bytes creates the minimum possible cache (2 elements).
 100 | -    size_t nMaxCacheSize = std::min(std::max((int64_t)0, gArgs.GetIntArg("-maxsigcachesize", DEFAULT_MAX_SIG_CACHE_SIZE) / 2), MAX_MAX_SIG_CACHE_SIZE) * ((size_t) 1 << 20);
 101 | -    size_t nElems = signatureCache.setup_bytes(nMaxCacheSize);
 102 | -    LogPrintf("Using %zu MiB out of %zu/2 requested for signature cache, able to store %zu elements\n",
 103 | -            (nElems*sizeof(uint256)) >>20, (nMaxCacheSize*2)>>20, nElems);
 104 | +    size_t nMaxCacheSize = std::max((int64_t)0, gArgs.GetIntArg("-maxsigcachesize", DEFAULT_MAX_SIG_CACHE_SIZE) / 2) * ((size_t) 1 << 20);

---

 374 |       */
 375 |      std::optional<std::pair<uint32_t, size_t>> setup_bytes(size_t bytes)
 376 |      {
 377 | -        auto num_elems = setup(bytes/sizeof(Element));
 378 | +        size_t requested_num_elems = bytes / sizeof(Element);
 379 | +        if (std::numeric_limits<uint32_t>::max() < requested_num_elems) {

---

 109 | +using node::ApplyArgsManOptions;
 110 |  using node::CacheSizes;
 111 |  using node::CalculateCacheSizes;
 112 | -using node::ChainstateLoadVerifyError;
 113 |  using node::ChainstateLoadingError;
 114 | +using node::ChainstateLoadVerifyError;

---

  20 | @@ -18,9 +21,10 @@ namespace node {
  21 |  void ApplyArgsManOptions(const ArgsManager& argsman, ValidationCacheSizes& cache_sizes)
  22 |  {
  23 |      if (auto max_size = argsman.GetIntArg("-maxsigcachesize")) {
  24 | +        size_t clamped_size_each = std::max<int64_t>(*max_size, 0) / 2 * (1 << 20);

---

 135 | @@ -136,8 +136,8 @@ BasicTestingSetup::BasicTestingSetup(const std::string& chainName, const std::ve
 136 |      m_node.kernel = std::make_unique<kernel::Context>();
 137 |      SetupEnvironment();
 138 |      SetupNetworking();
 139 | -    InitSignatureCache();
 140 | -    InitScriptExecutionCache();
 141 | +    assert(InitSignatureCache());
 142 | +    assert(InitScriptExecutionCache());

---

  91 | @@ -92,11 +92,11 @@ static CSignatureCache signatureCache;
  92 |  
  93 |  // To be called once in AppInitMain/BasicTestingSetup to initialize the
  94 |  // signatureCache.
  95 | -bool InitSignatureCache()
  96 | +bool InitSignatureCache(int64_t max_size)

---

 350 | +        try {
 351 | +            table.reserve(size);
 352 | +            table.resize(size);
 353 | +        } catch (std::bad_alloc const&) {
 354 | +            return std::nullopt;
 355 | +        }

---

 106 | +    auto setup_results = signatureCache.setup_bytes(nMaxCacheSize);
 107 | +    if (!setup_results) return false;
 108 | +
 109 | +    const auto [num_elems, approx_size_bytes] = *setup_results;
 110 | +    LogPrintf("Using %zu MiB out of %zu requested for signature cache, able to store %zu elements\n",
 111 | +              approx_size_bytes, nMaxCacheSize, num_elems);

---

1671 | +
1672 | +    auto setup_results = g_scriptExecutionCache.setup_bytes(nMaxCacheSize);
1673 | +    if (!setup_results) return false;
1674 | +
1675 | +    const auto [num_elems, approx_size_bytes] = *setup_results;
1676 | +    LogPrintf("Using %zu MiB out of %zu requested for script execution cache, able to store %zu elements\n",

---

   0 | @@ -0,0 +1,8 @@
   1 | +Updated settings
   2 | +----------------
   3 | +
   4 | +- Specifying a `-maxsigcachesize` MiB value which is too large will now result

---

  98 |      // nMaxCacheSize is unsigned. If -maxsigcachesize is set to zero,
  99 |      // setup_bytes creates the minimum possible cache (2 elements).
 100 |      size_t nMaxCacheSize = std::min(std::max((int64_t)0, gArgs.GetIntArg("-maxsigcachesize", DEFAULT_MAX_SIG_CACHE_SIZE) / 2), MAX_MAX_SIG_CACHE_SIZE) * ((size_t) 1 << 20);
 101 | -    size_t nElems = signatureCache.setup_bytes(nMaxCacheSize);
 102 | +
 103 | +    auto setup_results = signatureCache.setup_bytes(nMaxCacheSize);

---

1170 | @@ -1171,8 +1171,9 @@ bool AppInitMain(NodeContext& node, interfaces::BlockAndHeaderTipInfo* tip_info)
1171 |                    args.GetArg("-datadir", ""), fs::PathToString(fs::current_path()));
1172 |      }
1173 |  
1174 | -    InitSignatureCache();
1175 | -    InitScriptExecutionCache();
1176 | +    if (!InitSignatureCache() || !InitScriptExecutionCache()) {
1177 | +        return InitError(strprintf(_("Unable to allocate memory for -maxsigcachesize: '%s' MiB"), args.GetIntArg("-maxsigcachesize", DEFAULT_MAX_SIG_CACHE_SIZE)));

---

 553 | @@ -550,7 +554,7 @@ void SetupServerArgs(ArgsManager& argsman)
 554 |      argsman.AddArg("-addrmantest", "Allows to test address relay on localhost", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
 555 |      argsman.AddArg("-capturemessages", "Capture all P2P messages to disk", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
 556 |      argsman.AddArg("-mocktime=<n>", "Replace actual time with " + UNIX_EPOCH_TIME + " (default: 0)", ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
 557 | -    argsman.AddArg("-maxsigcachesize=<n>", strprintf("Limit sum of signature cache and script execution cache sizes to <n> MiB (default: %u)", DEFAULT_MAX_SIG_CACHE_SIZE), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
 558 | +    argsman.AddArg("-maxsigcachesize=<n>", strprintf("Limit sum of signature cache and script execution cache sizes to <n> MiB (default: %u)", DEFAULT_MAX_SIG_CACHE_SIZE_BYTES >> 20), ArgsManager::ALLOW_ANY | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);

---

  16 | +namespace node {
  17 | +void ApplyArgsManOptions(const ArgsManager& argsman, ValidationCacheSizes& cache_sizes)
  18 | +{
  19 | +    if (auto max_size = argsman.GetIntArg("-maxsigcachesize")) {
  20 | +        cache_sizes = {
  21 | +            .signature_cache_bytes = *max_size / 2 * (1 << 20),

---

1663 | @@ -1664,9 +1664,13 @@ void InitScriptExecutionCache() {
1664 |      // nMaxCacheSize is unsigned. If -maxsigcachesize is set to zero,
1665 |      // setup_bytes creates the minimum possible cache (2 elements).
1666 |      size_t nMaxCacheSize = std::min(std::max((int64_t)0, gArgs.GetIntArg("-maxsigcachesize", DEFAULT_MAX_SIG_CACHE_SIZE) / 2), MAX_MAX_SIG_CACHE_SIZE) * ((size_t) 1 << 20);
1667 | -    size_t nElems = g_scriptExecutionCache.setup_bytes(nMaxCacheSize);
1668 | +
1669 | +    auto setup_results = g_scriptExecutionCache.setup_bytes(nMaxCacheSize);
1670 | +
1671 | +    const auto [num_elems, approx_size_bytes] = setup_results;

---

  15 |  
  16 |  // DoS prevention: limit cache size to 32MB (over 1000000 entries on 64-bit
  17 |  // systems). Due to how we count cache size, actual memory usage is slightly
  18 |  // more (~32.25 MB)
  19 | -static const unsigned int DEFAULT_MAX_SIG_CACHE_SIZE = 32;
  20 | +static constexpr size_t DEFAULT_MAX_SIG_CACHE_BYTES{32 << 20};

---