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