client/common/
shutdown_handler.rs

1use std::{
2    sync::{Arc, Weak},
3    thread,
4    time::{Duration, Instant},
5};
6
7use ctrlc::CtrlC;
8use log::{debug, warn};
9use parking_lot::{Condvar, Mutex};
10
11use super::ClientTrait;
12
13pub fn run(
14    this: Box<dyn ClientTrait>, exit_cond_var: Arc<(Mutex<bool>, Condvar)>,
15) -> bool {
16    CtrlC::set_handler({
17        let e = exit_cond_var.clone();
18        move || {
19            *e.0.lock() = true;
20            e.1.notify_all();
21        }
22    });
23
24    let mut lock = exit_cond_var.0.lock();
25    if !*lock {
26        exit_cond_var.1.wait(&mut lock);
27    }
28
29    shutdown(this)
30}
31
32/// Returns whether the shutdown is considered clean.
33pub fn shutdown(this: Box<dyn ClientTrait>) -> bool {
34    // Signal metrics reporter threads to stop before dropping components.
35    metrics::stop();
36
37    let (ledger_db, maybe_pos_handler, maybe_blockgen) =
38        this.take_out_components_for_shutdown();
39    drop(this);
40    if let Some(blockgen) = maybe_blockgen {
41        blockgen.stop();
42        drop(blockgen);
43    }
44    let maybe_pos_db = if let Some(pos_handler) = maybe_pos_handler {
45        let maybe_pos_db = pos_handler.stop();
46        drop(pos_handler);
47        maybe_pos_db
48    } else {
49        None
50    };
51
52    // Make sure ledger_db is properly dropped, so rocksdb can be closed
53    // cleanly
54    let mut graceful = true;
55    graceful &= check_graceful_shutdown(ledger_db);
56    debug!("ledger_db drop: graceful = {}", graceful);
57    if let Some((pos_ledger_db, consensus_db)) = maybe_pos_db {
58        graceful &= check_graceful_shutdown(pos_ledger_db);
59        debug!("pos_ledger_db drop: graceful = {}", graceful);
60        graceful &= check_graceful_shutdown(consensus_db);
61        debug!("consensus_db drop: graceful = {}", graceful);
62    }
63    graceful
64}
65
66/// Most Conflux components references block data manager.
67/// When block data manager is freed, all background threads must have
68/// already stopped.
69fn check_graceful_shutdown<T>(blockdata_manager_weak_ptr: Weak<T>) -> bool {
70    let sleep_duration = Duration::from_secs(1);
71    let warn_timeout = Duration::from_secs(5);
72    let max_timeout = Duration::from_secs(1200);
73    let instant = Instant::now();
74    let mut warned = false;
75    while instant.elapsed() < max_timeout {
76        if blockdata_manager_weak_ptr.upgrade().is_none() {
77            return true;
78        }
79        if !warned && instant.elapsed() > warn_timeout {
80            warned = true;
81            warn!("Shutdown is taking longer than expected.");
82        }
83        thread::sleep(sleep_duration);
84    }
85    eprintln!("Shutdown timeout reached, exiting uncleanly.");
86    false
87}
client/common/shutdown_handler.rs

client/common/
shutdown_handler.rs
