xref: /DragonOS/kernel/src/time/timekeeping.rs (revision 45626c859f95054b76d8b59afcbd24c6b235026f)
1 use alloc::sync::Arc;
2 use core::sync::atomic::{compiler_fence, AtomicBool, AtomicI64, Ordering};
3 
4 use crate::{
5     arch::CurrentIrqArch,
6     exception::InterruptArch,
7     kdebug, kinfo,
8     libs::rwlock::RwLock,
9     time::{jiffies::clocksource_default_clock, timekeep::ktime_get_real_ns, TimeSpec},
10 };
11 
12 use super::{
13     clocksource::{clocksource_cyc2ns, Clocksource, CycleNum, HZ},
14     syscall::PosixTimeval,
15     NSEC_PER_SEC, USEC_PER_SEC,
16 };
17 /// NTP周期频率
18 pub const NTP_INTERVAL_FREQ: u64 = HZ;
19 /// NTP周期长度
20 pub const NTP_INTERVAL_LENGTH: u64 = NSEC_PER_SEC as u64 / NTP_INTERVAL_FREQ;
21 /// NTP转换比例
22 pub const NTP_SCALE_SHIFT: u32 = 32;
23 
24 /// timekeeping休眠标志,false为未休眠
25 pub static TIMEKEEPING_SUSPENDED: AtomicBool = AtomicBool::new(false);
26 /// 已经递增的微秒数
27 static __ADDED_USEC: AtomicI64 = AtomicI64::new(0);
28 /// 已经递增的秒数
29 static __ADDED_SEC: AtomicI64 = AtomicI64::new(0);
30 /// timekeeper全局变量,用于管理timekeeper模块
31 static mut __TIMEKEEPER: Option<Timekeeper> = None;
32 
33 #[derive(Debug)]
34 pub struct Timekeeper(RwLock<TimekeeperData>);
35 
36 #[allow(dead_code)]
37 #[derive(Debug)]
38 pub struct TimekeeperData {
39     /// 用于计时的当前时钟源。
40     clock: Option<Arc<dyn Clocksource>>,
41     /// 当前时钟源的移位值。
42     shift: i32,
43     /// 一个NTP间隔中的时钟周期数。
44     cycle_interval: CycleNum,
45     /// 一个NTP间隔中时钟移位的纳秒数。
46     xtime_interval: u64,
47     ///
48     xtime_remainder: i64,
49     /// 每个NTP间隔累积的原始纳米秒
50     raw_interval: i64,
51     /// 时钟移位纳米秒余数
52     xtime_nsec: u64,
53     /// 积累时间和ntp时间在ntp位移纳秒量上的差距
54     ntp_error: i64,
55     /// 用于转换时钟偏移纳秒和ntp偏移纳秒的偏移量
56     ntp_error_shift: i32,
57     /// NTP调整时钟乘法器
58     mult: u32,
59     raw_time: TimeSpec,
60     wall_to_monotonic: TimeSpec,
61     total_sleep_time: TimeSpec,
62     xtime: TimeSpec,
63 }
64 impl TimekeeperData {
65     pub fn new() -> Self {
66         Self {
67             clock: None,
68             shift: Default::default(),
69             cycle_interval: CycleNum(0),
70             xtime_interval: Default::default(),
71             xtime_remainder: Default::default(),
72             raw_interval: Default::default(),
73             xtime_nsec: Default::default(),
74             ntp_error: Default::default(),
75             ntp_error_shift: Default::default(),
76             mult: Default::default(),
77             xtime: TimeSpec {
78                 tv_nsec: 0,
79                 tv_sec: 0,
80             },
81             wall_to_monotonic: TimeSpec {
82                 tv_nsec: 0,
83                 tv_sec: 0,
84             },
85             total_sleep_time: TimeSpec {
86                 tv_nsec: 0,
87                 tv_sec: 0,
88             },
89             raw_time: TimeSpec {
90                 tv_nsec: 0,
91                 tv_sec: 0,
92             },
93         }
94     }
95 }
96 impl Timekeeper {
97     /// # 设置timekeeper的参数
98     ///
99     /// ## 参数
100     ///
101     /// * 'clock' - 指定的时钟实际类型。初始为ClocksourceJiffies
102     pub fn timekeeper_setup_internals(&self, clock: Arc<dyn Clocksource>) {
103         let mut timekeeper = self.0.write_irqsave();
104         // 更新clock
105         let mut clock_data = clock.clocksource_data();
106         clock_data.watchdog_last = clock.read();
107         if clock.update_clocksource_data(clock_data).is_err() {
108             kdebug!("timekeeper_setup_internals:update_clocksource_data run failed");
109         }
110         timekeeper.clock.replace(clock.clone());
111 
112         let clock_data = clock.clocksource_data();
113         let mut temp = NTP_INTERVAL_LENGTH << clock_data.shift;
114         let ntpinterval = temp;
115         temp += (clock_data.mult / 2) as u64;
116         // do div
117 
118         timekeeper.cycle_interval = CycleNum(temp);
119         timekeeper.xtime_interval = temp * clock_data.mult as u64;
120         // 这里可能存在下界溢出问题,debug模式下会报错panic
121         timekeeper.xtime_remainder = (ntpinterval - timekeeper.xtime_interval) as i64;
122         timekeeper.raw_interval = (timekeeper.xtime_interval >> clock_data.shift) as i64;
123         timekeeper.xtime_nsec = 0;
124         timekeeper.shift = clock_data.shift as i32;
125 
126         timekeeper.ntp_error = 0;
127         timekeeper.ntp_error_shift = (NTP_SCALE_SHIFT - clock_data.shift) as i32;
128 
129         timekeeper.mult = clock_data.mult;
130     }
131 
132     /// # 获取当前时钟源距离上次检测走过的纳秒数
133     #[allow(dead_code)]
134     pub fn tk_get_ns(&self) -> u64 {
135         let timekeeper = self.0.read_irqsave();
136         let clock = timekeeper.clock.clone().unwrap();
137         drop(timekeeper);
138         let clock_now = clock.read();
139         let clcok_data = clock.clocksource_data();
140         let clock_delta = clock_now.div(clcok_data.watchdog_last).data() & clcok_data.mask.bits();
141         return clocksource_cyc2ns(CycleNum(clock_delta), clcok_data.mult, clcok_data.shift);
142     }
143 }
144 pub fn timekeeper() -> &'static Timekeeper {
145     let r = unsafe { __TIMEKEEPER.as_ref().unwrap() };
146 
147     return r;
148 }
149 
150 pub fn timekeeper_init() {
151     unsafe { __TIMEKEEPER = Some(Timekeeper(RwLock::new(TimekeeperData::new()))) };
152 }
153 
154 /// # 获取1970.1.1至今的UTC时间戳(最小单位:nsec)
155 ///
156 /// ## 返回值
157 ///
158 /// * 'TimeSpec' - 时间戳
159 pub fn getnstimeofday() -> TimeSpec {
160     // kdebug!("enter getnstimeofday");
161 
162     // let mut nsecs: u64 = 0;0
163     let mut _xtime = TimeSpec {
164         tv_nsec: 0,
165         tv_sec: 0,
166     };
167     loop {
168         match timekeeper().0.try_read_irqsave() {
169             None => continue,
170             Some(tk) => {
171                 _xtime = tk.xtime;
172                 drop(tk);
173                 // nsecs = timekeeper().tk_get_ns();
174                 // TODO 不同架构可能需要加上不同的偏移量
175                 break;
176             }
177         }
178     }
179     // xtime.tv_nsec += nsecs as i64;
180     let sec = __ADDED_SEC.load(Ordering::SeqCst);
181     _xtime.tv_sec += sec;
182     while _xtime.tv_nsec >= NSEC_PER_SEC.into() {
183         _xtime.tv_nsec -= NSEC_PER_SEC as i64;
184         _xtime.tv_sec += 1;
185     }
186 
187     // TODO 将xtime和当前时间源的时间相加
188 
189     return _xtime;
190 }
191 
192 /// # 获取1970.1.1至今的UTC时间戳(最小单位:usec)
193 ///
194 /// ## 返回值
195 ///
196 /// * 'PosixTimeval' - 时间戳
197 pub fn do_gettimeofday() -> PosixTimeval {
198     let tp = getnstimeofday();
199     return PosixTimeval {
200         tv_sec: tp.tv_sec,
201         tv_usec: (tp.tv_nsec / 1000) as i32,
202     };
203 }
204 
205 /// # 初始化timekeeping模块
206 pub fn timekeeping_init() {
207     kinfo!("Initializing timekeeping module...");
208     let irq_guard = unsafe { CurrentIrqArch::save_and_disable_irq() };
209     timekeeper_init();
210 
211     // TODO 有ntp模块后 在此初始化ntp模块
212 
213     let clock = clocksource_default_clock();
214     clock
215         .enable()
216         .expect("clocksource_default_clock enable failed");
217     timekeeper().timekeeper_setup_internals(clock);
218     // 暂时不支持其他架构平台对时间的设置 所以使用x86平台对应值初始化
219     let mut timekeeper = timekeeper().0.write_irqsave();
220     timekeeper.xtime.tv_nsec = ktime_get_real_ns();
221 
222     // 初始化wall time到monotonic的时间
223     let mut nsec = -timekeeper.xtime.tv_nsec;
224     let mut sec = -timekeeper.xtime.tv_sec;
225     // FIXME: 这里有个奇怪的奇怪的bug
226     let num = nsec % NSEC_PER_SEC as i64;
227     nsec += num * NSEC_PER_SEC as i64;
228     sec -= num;
229     timekeeper.wall_to_monotonic.tv_nsec = nsec;
230     timekeeper.wall_to_monotonic.tv_sec = sec;
231 
232     __ADDED_USEC.store(0, Ordering::SeqCst);
233     __ADDED_SEC.store(0, Ordering::SeqCst);
234 
235     drop(irq_guard);
236     kinfo!("timekeeping_init successfully");
237 }
238 
239 /// # 使用当前时钟源增加wall time
240 pub fn update_wall_time(delta_us: i64) {
241     // kdebug!("enter update_wall_time, stack_use = {:}",stack_use);
242     compiler_fence(Ordering::SeqCst);
243     let irq_guard = unsafe { CurrentIrqArch::save_and_disable_irq() };
244     // 如果在休眠那就不更新
245     if TIMEKEEPING_SUSPENDED.load(Ordering::SeqCst) {
246         return;
247     }
248 
249     // ===== 请不要删除这些注释 =====
250     // let clock = timekeeper.clock.clone().unwrap();
251     // let clock_data = clock.clocksource_data();
252     // let offset = (clock.read().div(clock_data.watchdog_last).data()) & clock_data.mask.bits();
253 
254     // timekeeper.xtime_nsec = (timekeeper.xtime.tv_nsec as u64) << timekeeper.shift;
255     // // TODO 当有ntp模块之后 需要将timekeep与ntp进行同步并检查
256     // timekeeper.xtime.tv_nsec = ((timekeeper.xtime_nsec as i64) >> timekeeper.shift) + 1;
257     // timekeeper.xtime_nsec -= (timekeeper.xtime.tv_nsec as u64) << timekeeper.shift;
258 
259     // timekeeper.xtime.tv_nsec += offset as i64;
260     // while unlikely(timekeeper.xtime.tv_nsec >= NSEC_PER_SEC.into()) {
261     //     timekeeper.xtime.tv_nsec -= NSEC_PER_SEC as i64;
262     //     timekeeper.xtime.tv_sec += 1;
263     //     // TODO 需要处理闰秒
264     // }
265     // ================
266     compiler_fence(Ordering::SeqCst);
267 
268     __ADDED_USEC.fetch_add(delta_us, Ordering::SeqCst);
269     compiler_fence(Ordering::SeqCst);
270     let mut retry = 10;
271 
272     let usec = __ADDED_USEC.load(Ordering::SeqCst);
273     if usec % USEC_PER_SEC as i64 == 0 {
274         compiler_fence(Ordering::SeqCst);
275 
276         __ADDED_SEC.fetch_add(1, Ordering::SeqCst);
277         compiler_fence(Ordering::SeqCst);
278     }
279     // 一分钟同步一次
280     loop {
281         if (usec & !((1 << 26) - 1)) != 0 {
282             if __ADDED_USEC
283                 .compare_exchange(usec, 0, Ordering::SeqCst, Ordering::SeqCst)
284                 .is_ok()
285                 || retry == 0
286             {
287                 // 同步时间
288                 // 我感觉这里会出问题:多个读者不退出的话,写者就无法写入
289                 // 然后这里会超时,导致在中断返回之后,会不断的进入这个中断,最终爆栈。
290                 let mut timekeeper = timekeeper().0.write_irqsave();
291                 timekeeper.xtime.tv_nsec = ktime_get_real_ns();
292                 timekeeper.xtime.tv_sec = 0;
293                 __ADDED_SEC.store(0, Ordering::SeqCst);
294                 drop(timekeeper);
295                 break;
296             }
297             retry -= 1;
298         } else {
299             break;
300         }
301     }
302     // TODO 需要检查是否更新时间源
303     compiler_fence(Ordering::SeqCst);
304     drop(irq_guard);
305     compiler_fence(Ordering::SeqCst);
306 }
307 // TODO timekeeping_adjust
308 // TODO wall_to_monotic
309 
310 // ========= 以下为对C的接口 =========
311 #[no_mangle]
312 pub extern "C" fn rs_timekeeping_init() {
313     timekeeping_init();
314 }
315