tycho-util 0.3.7

Shared utilities for node components.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use std::num::NonZeroUsize;

use anyhow::Result;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
#[serde(default)]
pub struct ThreadPoolConfig {
    rayon_threads: NonZeroUsize,
    tokio_workers: NonZeroUsize,
    // How many threads to use for dropping heavy objects in the background Default is 4.
    reclaimer_threads: NonZeroUsize,
    // How many objects to keep in the reclaimer queue before blocking the main thread. Default is 10.
    reclaimer_queue_depth: NonZeroUsize,
}

impl ThreadPoolConfig {
    // don't assign unique names to threads, for example using indexes:
    // that way they'll be merged into a pretty-looking single one in flame graphs

    /// Initializes all required threadpools and runs the future until completion.
    ///
    /// NOTE: Don't mix with other initializations.
    pub fn init_all_and_run<T, F: Future<Output = Result<T>>>(self, future: F) -> Result<T> {
        // NOTE: Don't forget to add all strange threadpool inits when needed here.
        self.init_reclaimer()?;
        self.init_global_rayon_pool()?;
        self.build_tokio_runtime()?.block_on(future)
    }

    pub fn init_global_rayon_pool(&self) -> Result<(), rayon::ThreadPoolBuildError> {
        rayon::ThreadPoolBuilder::new()
            .stack_size(8 * 1024 * 1024)
            .thread_name(|_| "rayon_worker".to_string())
            .num_threads(self.rayon_threads.get())
            .build_global()
    }

    pub fn build_tokio_runtime(&self) -> std::io::Result<tokio::runtime::Runtime> {
        tokio::runtime::Builder::new_multi_thread()
            .enable_all()
            .worker_threads(self.tokio_workers.get())
            .build()
    }

    pub fn init_reclaimer(&self) -> Result<(), crate::mem::ReclaimerError> {
        crate::mem::Reclaimer::init(self.reclaimer_queue_depth, self.reclaimer_threads)
    }
}

impl Default for ThreadPoolConfig {
    fn default() -> Self {
        let total_threads =
            std::thread::available_parallelism().expect("failed to get total threads");
        Self {
            rayon_threads: total_threads,
            tokio_workers: total_threads,
            reclaimer_threads: NonZeroUsize::new(4).unwrap(),
            reclaimer_queue_depth: NonZeroUsize::new(10).unwrap(),
        }
    }
}