Branch data     Line data    Source code

       1                 :             : // Copyright (c) 2021-present The Bitcoin Core developers
       2                 :             : // Distributed under the MIT software license, see the accompanying
       3                 :             : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
       4                 :             : 
       5                 :             : #include <node/caches.h>
       6                 :             : 
       7                 :             : #include <common/args.h>
       8                 :             : #include <common/system.h>
       9                 :             : #include <index/txindex.h>
      10                 :             : #include <index/txospenderindex.h>
      11                 :             : #include <kernel/caches.h>
      12                 :             : #include <logging.h>
      13                 :             : #include <node/interface_ui.h>
      14                 :             : #include <tinyformat.h>
      15                 :             : #include <util/byte_units.h>
      16                 :             : 
      17                 :             : #include <algorithm>
      18                 :             : #include <string>
      19                 :             : 
      20                 :             : // Unlike for the UTXO database, for the txindex scenario the leveldb cache make
      21                 :             : // a meaningful difference: https://github.com/bitcoin/bitcoin/pull/8273#issuecomment-229601991
      22                 :             : //! Max memory allocated to tx index DB specific cache in bytes.
      23                 :             : static constexpr size_t MAX_TX_INDEX_CACHE{1024_MiB};
      24                 :             : //! Max memory allocated to all block filter index caches combined in bytes.
      25                 :             : static constexpr size_t MAX_FILTER_INDEX_CACHE{1024_MiB};
      26                 :             : //! Max memory allocated to tx spenderindex DB specific cache in bytes.
      27                 :             : static constexpr size_t MAX_TXOSPENDER_INDEX_CACHE{1024_MiB};
      28                 :             : //! Maximum dbcache size on 32-bit systems.
      29                 :             : static constexpr size_t MAX_32BIT_DBCACHE{1024_MiB};
      30                 :             : 
      31                 :             : namespace node {
      32                 :        2339 : size_t CalculateDbCacheBytes(const ArgsManager& args)
      33                 :             : {
      34         [ -  + ]:        4678 :     if (auto db_cache{args.GetIntArg("-dbcache")}) {
      35         [ #  # ]:           0 :         if (*db_cache < 0) db_cache = 0;
      36         [ #  # ]:           0 :         const uint64_t db_cache_bytes{SaturatingLeftShift<uint64_t>(*db_cache, 20)};
      37                 :           0 :         constexpr auto max_db_cache{sizeof(void*) == 4 ? MAX_32BIT_DBCACHE : std::numeric_limits<size_t>::max()};
      38         [ #  # ]:           0 :         return std::max<size_t>(MIN_DB_CACHE, std::min<uint64_t>(db_cache_bytes, max_db_cache));
      39                 :             :     }
      40                 :             :     return DEFAULT_DB_CACHE;
      41                 :             : }
      42                 :             : 
      43                 :        1262 : CacheSizes CalculateCacheSizes(const ArgsManager& args, size_t n_indexes)
      44                 :             : {
      45                 :        1262 :     size_t total_cache{CalculateDbCacheBytes(args)};
      46                 :             : 
      47                 :        1262 :     IndexCacheSizes index_sizes;
      48   [ +  -  +  +  :        2524 :     index_sizes.tx_index = std::min(total_cache / 8, args.GetBoolArg("-txindex", DEFAULT_TXINDEX) ? MAX_TX_INDEX_CACHE : 0);
                   +  + ]
      49                 :        1262 :     total_cache -= index_sizes.tx_index;
      50   [ +  -  +  +  :        2524 :     index_sizes.txospender_index = std::min(total_cache / 8, args.GetBoolArg("-txospenderindex", DEFAULT_TXOSPENDERINDEX) ? MAX_TXOSPENDER_INDEX_CACHE : 0);
                   +  + ]
      51                 :        1262 :     total_cache -= index_sizes.txospender_index;
      52         [ +  + ]:        1262 :     if (n_indexes > 0) {
      53         [ +  - ]:          61 :         size_t max_cache = std::min(total_cache / 8, MAX_FILTER_INDEX_CACHE);
      54                 :          61 :         index_sizes.filter_index = max_cache / n_indexes;
      55                 :          61 :         total_cache -= index_sizes.filter_index * n_indexes;
      56                 :             :     }
      57                 :        1262 :     return {index_sizes, kernel::CacheSizes{total_cache}};
      58                 :             : }
      59                 :             : 
      60                 :        1077 : void LogOversizedDbCache(const ArgsManager& args) noexcept
      61                 :             : {
      62         [ +  - ]:        1077 :     if (const auto total_ram{GetTotalRAM()}) {
      63                 :        1077 :         const size_t db_cache{CalculateDbCacheBytes(args)};
      64   [ +  -  -  + ]:        2154 :         if (ShouldWarnOversizedDbCache(db_cache, *total_ram)) {
      65                 :           0 :             InitWarning(bilingual_str{tfm::format(_("A %zu MiB dbcache may be too large for a system memory of only %zu MiB."),
      66                 :           0 :                         db_cache >> 20, *total_ram >> 20)});
      67                 :             :         }
      68                 :             :     }
      69                 :        1077 : }
      70                 :             : } // namespace node