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    let (ledger_db, maybe_pos_handler, maybe_blockgen) =
35        this.take_out_components_for_shutdown();
36    drop(this);
37    if let Some(blockgen) = maybe_blockgen {
38        blockgen.stop();
39        drop(blockgen);
40    }
41    let maybe_pos_db = if let Some(pos_handler) = maybe_pos_handler {
42        let maybe_pos_db = pos_handler.stop();
43        drop(pos_handler);
44        maybe_pos_db
45    } else {
46        None
47    };
48
49    // Make sure ledger_db is properly dropped, so rocksdb can be closed
50    // cleanly
51    let mut graceful = true;
52    graceful &= check_graceful_shutdown(ledger_db);
53    debug!("ledger_db drop: graceful = {}", graceful);
54    if let Some((pos_ledger_db, consensus_db)) = maybe_pos_db {
55        graceful &= check_graceful_shutdown(pos_ledger_db);
56        debug!("pos_ledger_db drop: graceful = {}", graceful);
57        graceful &= check_graceful_shutdown(consensus_db);
58        debug!("consensus_db drop: graceful = {}", graceful);
59    }
60    graceful
61}
62
63/// Most Conflux components references block data manager.
64/// When block data manager is freed, all background threads must have
65/// already stopped.
66fn check_graceful_shutdown<T>(blockdata_manager_weak_ptr: Weak<T>) -> bool {
67    let sleep_duration = Duration::from_secs(1);
68    let warn_timeout = Duration::from_secs(5);
69    let max_timeout = Duration::from_secs(1200);
70    let instant = Instant::now();
71    let mut warned = false;
72    while instant.elapsed() < max_timeout {
73        if blockdata_manager_weak_ptr.upgrade().is_none() {
74            return true;
75        }
76        if !warned && instant.elapsed() > warn_timeout {
77            warned = true;
78            warn!("Shutdown is taking longer than expected.");
79        }
80        thread::sleep(sleep_duration);
81    }
82    eprintln!("Shutdown timeout reached, exiting uncleanly.");
83    false
84}
client/common/shutdown_handler.rs

client/common/
shutdown_handler.rs
