xref: /DragonOS/kernel/src/mm/percpu.rs (revision 8cb2e9b344230227fe5f3ab3ebeb2522f1c5e289)
1 use core::sync::atomic::AtomicU32;
2 
3 use alloc::vec::Vec;
4 
5 use crate::{
6     libs::lazy_init::Lazy,
7     smp::{
8         core::smp_get_processor_id,
9         cpu::{smp_cpu_manager, ProcessorId},
10     },
11 };
12 
13 /// 系统中的CPU数量
14 ///
15 /// todo: 待smp模块重构后,从smp模块获取CPU数量。
16 /// 目前由于smp模块初始化时机较晚,导致大部分内核模块无法在早期初始化PerCpu变量。
17 const CPU_NUM: AtomicU32 = AtomicU32::new(PerCpu::MAX_CPU_NUM);
18 
19 #[derive(Debug)]
20 pub struct PerCpu;
21 
22 impl PerCpu {
23     pub const MAX_CPU_NUM: u32 = 128;
24     /// # 初始化PerCpu
25     ///
26     /// 该函数应该在内核初始化时调用一次。
27     ///
28     /// 该函数会调用`smp_get_total_cpu()`获取CPU数量,然后将其存储在`CPU_NUM`中。
29     #[allow(dead_code)]
30     pub fn init() {
31         if CPU_NUM.load(core::sync::atomic::Ordering::SeqCst) != 0 {
32             panic!("PerCpu::init() called twice");
33         }
34         let cpus = smp_cpu_manager().present_cpus_count();
35         assert!(cpus > 0, "PerCpu::init(): present_cpus_count() returned 0");
36 
37         CPU_NUM.store(cpus, core::sync::atomic::Ordering::SeqCst);
38     }
39 }
40 
41 /// PerCpu变量
42 ///
43 /// 该结构体的每个实例都是线程安全的,因为每个CPU都有自己的变量。
44 ///
45 /// 一种简单的使用方法是:使用该结构体提供的`define_lazy`方法定义一个全局变量,
46 /// 然后在内核初始化时调用`init`、`new`方法去初始化它。
47 ///
48 /// 当然,由于Lazy<T>有运行时开销,所以也可以直接全局声明一个Option,
49 /// 然后手动初始化然后赋值到Option中。(这样需要在初始化的时候,手动确保并发安全)
50 #[derive(Debug)]
51 #[allow(dead_code)]
52 pub struct PerCpuVar<T> {
53     inner: Vec<T>,
54 }
55 
56 #[allow(dead_code)]
57 impl<T> PerCpuVar<T> {
58     /// # 初始化PerCpu变量
59     ///
60     /// ## 参数
61     ///
62     /// - `data` - 每个CPU的数据的初始值。 传入的Vec的长度必须等于CPU的数量,否则返回None。
63     pub fn new(data: Vec<T>) -> Option<Self> {
64         let cpu_num = CPU_NUM.load(core::sync::atomic::Ordering::SeqCst);
65         if cpu_num == 0 {
66             panic!("PerCpu::init() not called");
67         }
68 
69         if data.len() != cpu_num.try_into().unwrap() {
70             return None;
71         }
72 
73         return Some(Self { inner: data });
74     }
75 
76     /// 定义一个Lazy的PerCpu变量,稍后再初始化
77     pub const fn define_lazy() -> Lazy<Self> {
78         Lazy::<Self>::new()
79     }
80 
81     pub fn get(&self) -> &T {
82         let cpu_id = smp_get_processor_id();
83         &self.inner[cpu_id.data() as usize]
84     }
85 
86     pub fn get_mut(&self) -> &mut T {
87         let cpu_id = smp_get_processor_id();
88         unsafe {
89             &mut (self as *const Self as *mut Self).as_mut().unwrap().inner[cpu_id.data() as usize]
90         }
91     }
92 
93     pub unsafe fn force_get(&self, cpu_id: ProcessorId) -> &T {
94         &self.inner[cpu_id.data() as usize]
95     }
96 
97     pub unsafe fn force_get_mut(&self, cpu_id: ProcessorId) -> &mut T {
98         &mut (self as *const Self as *mut Self).as_mut().unwrap().inner[cpu_id.data() as usize]
99     }
100 }
101 
102 /// PerCpu变量是线程安全的,因为每个CPU都有自己的变量。
103 unsafe impl<T> Sync for PerCpuVar<T> {}
104 unsafe impl<T> Send for PerCpuVar<T> {}
105