Struct solana_core::ledger_cleanup_service::LedgerCleanupService

pub struct LedgerCleanupService { /* private fields */ }

Implementations

impl LedgerCleanupService

pub fn new(
    new_root_receiver: Receiver<Slot>,
    blockstore: Arc<Blockstore>,
    max_ledger_shreds: u64,
    exit: &Arc<AtomicBool>,
    compaction_interval: Option<u64>,
    max_compaction_jitter: Option<u64>
) -> Self

pub fn cleanup_ledger(
    new_root_receiver: &Receiver<Slot>,
    blockstore: &Arc<Blockstore>,
    max_ledger_shreds: u64,
    last_purge_slot: &mut u64,
    purge_interval: u64,
    last_compact_slot: &Arc<AtomicU64>
) -> Result<(), RecvTimeoutError>

Checks for new roots and initiates a cleanup if the last cleanup was at least purge_interval slots ago. A cleanup will no-op if the ledger already has fewer than max_ledger_shreds; otherwise, the cleanup will purge enough slots to get the ledger size below max_ledger_shreds.

[new_root_receiver]: signal receiver which contains the information about what Slot is the current root. [max_ledger_shreds]: the number of shreds to keep since the new root. [last_purge_slot]: an both an input and output parameter indicating the id of the last purged slot. As an input parameter, it works together with purge_interval on whether it is too early to perform ledger cleanup. As an output parameter, it will be updated if this function actually performs the ledger cleanup. [purge_interval]: the minimum slot interval between two ledger cleanup. When the root derived from new_root_receiver minus last_purge_slot is fewer than purge_interval, the function will simply return Ok without actually running the ledger cleanup. In this case, purge_interval will remain unchanged. [last_compact_slot]: an output value which indicates the most recent slot which has been cleaned up after this call. If this parameter is updated after this function call, it means the ledger cleanup has been performed.

Also see blockstore::purge_slot.

pub fn compact_ledger(
    blockstore: &Arc<Blockstore>,
    last_compaction_slot: &mut u64,
    compaction_interval: u64,
    highest_compact_slot: &Arc<AtomicU64>,
    compaction_jitter: &mut u64,
    max_jitter: Option<u64>
)

pub fn join(self) -> Result<()>