sz_rust_core/runtime/
worker.rs

1//! Worker 数量配置
2//!
3//! ## PHP 对齐
4//!
5//! 对齐 PHP `think-swoole` 的 `worker_num` 配置项：
6//!
7//! ```php
8//! // vendor/topthink/think-swoole/src/config/swoole.php:17
9//! 'options' => [
10//!     'reactor_num'     => swoole_cpu_num(),
11//!     'worker_num'      => swoole_cpu_num(),   // ← 默认 = CPU 核数
12//!     'task_worker_num' => swoole_cpu_num(),
13//! ]
14//! ```
15//!
16//! Rust 端使用 `num_cpus::get()` 获取 CPU 核数，并提供 builder 模式自定义。
17
18use std::fmt;
19
20/// 默认 worker 数（对齐 `swoole_cpu_num()`）
21pub const DEFAULT_WORKER_NUM: usize = 0; // 0 表示使用 num_cpus::get()
22
23/// 最小 worker 数（避免 0 worker 导致 runtime 无法启动）
24pub const MIN_WORKER_NUM: usize = 1;
25
26/// 最大 worker 数（避免过度创建线程导致调度开销过大）
27pub const MAX_WORKER_NUM: usize = 256;
28
29/// Worker 数量配置
30///
31/// 对齐 PHP `swoole.php` 配置中的 `worker_num` / `reactor_num` / `task_worker_num`。
32///
33/// ## 字段
34///
35/// - `worker_num`：业务 worker 数（处理 HTTP 请求等），默认 = CPU 核数
36/// - `reactor_num`：reactor 线程数（对齐 Swoole reactor，Rust 端保留为元数据）
37/// - `task_worker_num`：task worker 数（对齐 Swoole task worker，用于异步任务）
38///
39/// ## 用法
40///
41/// ```rust,ignore
42/// use sz_rust_core::runtime::worker::WorkerConfig;
43///
44/// let config = WorkerConfig::new();
45/// assert_eq!(config.worker_num(), num_cpus::get());
46///
47/// let custom = WorkerConfig::new().with_worker_num(8);
48/// assert_eq!(custom.worker_num(), 8);
49/// ```
50#[derive(Debug, Clone, PartialEq, Eq)]
51pub struct WorkerConfig {
52    /// 业务 worker 数（0 表示使用 CPU 核数）
53    worker_num: usize,
54    /// reactor 线程数（保留字段，对齐 PHP）
55    reactor_num: usize,
56    /// task worker 数（保留字段，对齐 PHP）
57    task_worker_num: usize,
58}
59
60impl WorkerConfig {
61    /// 创建默认配置：所有字段 = `num_cpus::get()`（对齐 `swoole_cpu_num()`）
62    pub fn new() -> Self {
63        let cpu = num_cpus::get();
64        Self {
65            worker_num: cpu,
66            reactor_num: cpu,
67            task_worker_num: cpu,
68        }
69    }
70
71    /// 自定义 worker_num（对齐 `worker_num` 配置项）
72    ///
73    /// - `n = 0` 会被强制为 `num_cpus::get()`
74    /// - `n > MAX_WORKER_NUM` 会被截断为 `MAX_WORKER_NUM`
75    pub fn with_worker_num(mut self, n: usize) -> Self {
76        self.worker_num = if n == 0 {
77            num_cpus::get()
78        } else {
79            n.clamp(MIN_WORKER_NUM, MAX_WORKER_NUM)
80        };
81        self
82    }
83
84    /// 自定义 reactor_num（对齐 `reactor_num` 配置项）
85    pub fn with_reactor_num(mut self, n: usize) -> Self {
86        self.reactor_num = if n == 0 {
87            num_cpus::get()
88        } else {
89            n.clamp(MIN_WORKER_NUM, MAX_WORKER_NUM)
90        };
91        self
92    }
93
94    /// 自定义 task_worker_num（对齐 `task_worker_num` 配置项）
95    pub fn with_task_worker_num(mut self, n: usize) -> Self {
96        self.task_worker_num = if n == 0 {
97            num_cpus::get()
98        } else {
99            n.clamp(MIN_WORKER_NUM, MAX_WORKER_NUM)
100        };
101        self
102    }
103
104    /// 获取 worker_num
105    pub fn worker_num(&self) -> usize {
106        self.worker_num
107    }
108
109    /// 获取 reactor_num
110    pub fn reactor_num(&self) -> usize {
111        self.reactor_num
112    }
113
114    /// 获取 task_worker_num
115    pub fn task_worker_num(&self) -> usize {
116        self.task_worker_num
117    }
118
119    /// 获取 CPU 核数（对齐 `swoole_cpu_num()`）
120    pub fn cpu_num(&self) -> usize {
121        num_cpus::get()
122    }
123
124    /// 验证配置是否有效
125    pub fn validate(&self) -> bool {
126        self.worker_num >= MIN_WORKER_NUM
127            && self.worker_num <= MAX_WORKER_NUM
128            && self.reactor_num >= MIN_WORKER_NUM
129            && self.reactor_num <= MAX_WORKER_NUM
130            && self.task_worker_num >= MIN_WORKER_NUM
131            && self.task_worker_num <= MAX_WORKER_NUM
132    }
133
134    /// 从环境变量读取 worker_num（对齐 PHP `env('SWOOLE_WORKER_NUM')`）
135    ///
136    /// - 环境变量 `SZ_RUST_WORKER_NUM` 优先级最高
137    /// - 未设置或解析失败时使用默认值（CPU 核数）
138    pub fn from_env() -> Self {
139        let mut config = Self::new();
140        if let Ok(val) = std::env::var("SZ_RUST_WORKER_NUM") {
141            if let Ok(n) = val.parse::<usize>() {
142                config = config.with_worker_num(n);
143            }
144        }
145        config
146    }
147}
148
149impl Default for WorkerConfig {
150    fn default() -> Self {
151        Self::new()
152    }
153}
154
155impl fmt::Display for WorkerConfig {
156    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
157        write!(
158            f,
159            "WorkerConfig{{worker_num={}, reactor_num={}, task_worker_num={}, cpu={}}}",
160            self.worker_num,
161            self.reactor_num,
162            self.task_worker_num,
163            self.cpu_num()
164        )
165    }
166}
167
168#[cfg(test)]
169mod tests {
170    use super::*;
171
172    #[test]
173    fn test_new_defaults_to_cpu_count() {
174        let config = WorkerConfig::new();
175        let cpu = num_cpus::get();
176        assert_eq!(config.worker_num(), cpu);
177        assert_eq!(config.reactor_num(), cpu);
178        assert_eq!(config.task_worker_num(), cpu);
179    }
180
181    #[test]
182    fn test_with_worker_num_custom() {
183        let config = WorkerConfig::new().with_worker_num(8);
184        assert_eq!(config.worker_num(), 8);
185    }
186
187    #[test]
188    fn test_with_worker_num_zero_falls_back_to_cpu() {
189        let config = WorkerConfig::new().with_worker_num(0);
190        assert_eq!(config.worker_num(), num_cpus::get());
191    }
192
193    #[test]
194    fn test_with_worker_num_exceeds_max_clamped() {
195        let config = WorkerConfig::new().with_worker_num(1024);
196        assert_eq!(config.worker_num(), MAX_WORKER_NUM);
197    }
198
199    #[test]
200    fn test_with_reactor_num_custom() {
201        let config = WorkerConfig::new().with_reactor_num(4);
202        assert_eq!(config.reactor_num(), 4);
203    }
204
205    #[test]
206    fn test_with_task_worker_num_custom() {
207        let config = WorkerConfig::new().with_task_worker_num(16);
208        assert_eq!(config.task_worker_num(), 16);
209    }
210
211    #[test]
212    fn test_cpu_num_matches_num_cpus() {
213        let config = WorkerConfig::new();
214        assert_eq!(config.cpu_num(), num_cpus::get());
215    }
216
217    #[test]
218    fn test_validate_valid_config() {
219        let config = WorkerConfig::new();
220        assert!(config.validate());
221    }
222
223    #[test]
224    fn test_validate_boundary_values() {
225        let config_min = WorkerConfig::new()
226            .with_worker_num(MIN_WORKER_NUM)
227            .with_reactor_num(MIN_WORKER_NUM)
228            .with_task_worker_num(MIN_WORKER_NUM);
229        assert!(config_min.validate());
230
231        let config_max = WorkerConfig::new()
232            .with_worker_num(MAX_WORKER_NUM)
233            .with_reactor_num(MAX_WORKER_NUM)
234            .with_task_worker_num(MAX_WORKER_NUM);
235        assert!(config_max.validate());
236    }
237
238    #[test]
239    fn test_from_env_default() {
240        // 清除环境变量确保使用默认值
241        std::env::remove_var("SZ_RUST_WORKER_NUM");
242        let config = WorkerConfig::from_env();
243        assert_eq!(config.worker_num(), num_cpus::get());
244    }
245
246    #[test]
247    fn test_from_env_custom() {
248        std::env::set_var("SZ_RUST_WORKER_NUM", "12");
249        let config = WorkerConfig::from_env();
250        assert_eq!(config.worker_num(), 12);
251        std::env::remove_var("SZ_RUST_WORKER_NUM");
252    }
253
254    #[test]
255    fn test_from_env_invalid_falls_back_to_default() {
256        std::env::set_var("SZ_RUST_WORKER_NUM", "not-a-number");
257        let config = WorkerConfig::from_env();
258        assert_eq!(config.worker_num(), num_cpus::get());
259        std::env::remove_var("SZ_RUST_WORKER_NUM");
260    }
261
262    #[test]
263    fn test_display_format() {
264        let config = WorkerConfig::new().with_worker_num(4);
265        let s = format!("{}", config);
266        assert!(s.contains("worker_num=4"));
267        assert!(s.contains("reactor_num="));
268        assert!(s.contains("task_worker_num="));
269    }
270
271    #[test]
272    fn test_default_equals_new() {
273        let config1 = WorkerConfig::default();
274        let config2 = WorkerConfig::new();
275        assert_eq!(config1, config2);
276    }
277
278    #[test]
279    fn test_clone_and_equality() {
280        let config1 = WorkerConfig::new().with_worker_num(4);
281        let config2 = config1.clone();
282        assert_eq!(config1, config2);
283    }
284
285    #[test]
286    fn test_builder_chaining() {
287        let config = WorkerConfig::new()
288            .with_worker_num(4)
289            .with_reactor_num(2)
290            .with_task_worker_num(8);
291        assert_eq!(config.worker_num(), 4);
292        assert_eq!(config.reactor_num(), 2);
293        assert_eq!(config.task_worker_num(), 8);
294        assert!(config.validate());
295    }
296}
sz_rust_core/runtime/worker.rs

sz_rust_core/runtime/
worker.rs
