xref: /DragonOS/kernel/src/ipc/signal.rs (revision 86ee1395de7c614865236ee15071c3603b794e44)
1 use core::sync::atomic::compiler_fence;
2 
3 use alloc::sync::Arc;
4 use log::warn;
5 use system_error::SystemError;
6 
7 use crate::{
8     arch::ipc::signal::{SigCode, SigFlags, SigSet, Signal},
9     ipc::signal_types::SigactionType,
10     libs::spinlock::SpinLockGuard,
11     process::{pid::PidType, Pid, ProcessControlBlock, ProcessFlags, ProcessManager},
12 };
13 
14 use super::signal_types::{
15     SaHandlerType, SigInfo, SigType, Sigaction, SignalStruct, SIG_KERNEL_STOP_MASK,
16 };
17 
18 impl Signal {
19     /// 向目标进程发送信号
20     ///
21     /// ## 参数
22     ///
23     /// - `sig` 要发送的信号
24     /// - `info` 要发送的信息
25     /// -  `pid` 进程id(目前只支持pid>0)
26     pub fn send_signal_info(
27         &self,
28         info: Option<&mut SigInfo>,
29         pid: Pid,
30     ) -> Result<i32, SystemError> {
31         // TODO:暂时不支持特殊的信号操作,待引入进程组后补充
32         // 如果 pid 大于 0,那么会发送信号给 pid 指定的进程
33         // 如果 pid 等于 0,那么会发送信号给与调用进程同组的每个进程,包括调用进程自身
34         // 如果 pid 小于 -1,那么会向组 ID 等于该 pid 绝对值的进程组内所有下属进程发送信号。向一个进程组的所有进程发送信号在 shell 作业控制中有特殊有途
35         // 如果 pid 等于 -1,那么信号的发送范围是:调用进程有权将信号发往的每个目标进程,除去 init(进程 ID 为 1)和调用进程自身。如果特权级进程发起这一调用,那么会发送信号给系统中的所有进程,上述两个进程除外。显而易见,有时也将这种信号发送方式称之为广播信号
36         // 如果并无进程与指定的 pid 相匹配,那么 kill() 调用失败,同时将 errno 置为 ESRCH(“查无此进程”)
37         if pid.lt(&Pid::from(0)) {
38             warn!("Kill operation not support: pid={:?}", pid);
39             return Err(SystemError::ENOSYS);
40         }
41         compiler_fence(core::sync::atomic::Ordering::SeqCst);
42         // 检查sig是否符合要求,如果不符合要求,则退出。
43         if !self.is_valid() {
44             return Err(SystemError::EINVAL);
45         }
46         let mut retval = Err(SystemError::ESRCH);
47         let pcb = ProcessManager::find(pid);
48 
49         if pcb.is_none() {
50             warn!("No such process.");
51             return retval;
52         }
53 
54         let pcb = pcb.unwrap();
55         // println!("Target pcb = {:?}", pcb.as_ref().unwrap());
56         compiler_fence(core::sync::atomic::Ordering::SeqCst);
57         // 发送信号
58         retval = self.send_signal(info, pcb.clone(), PidType::PID);
59 
60         compiler_fence(core::sync::atomic::Ordering::SeqCst);
61         return retval;
62     }
63 
64     /// @brief 判断是否需要强制发送信号,然后发送信号
65     /// 进入函数后加锁
66     ///
67     /// @return SystemError 错误码
68     fn send_signal(
69         &self,
70         info: Option<&mut SigInfo>,
71         pcb: Arc<ProcessControlBlock>,
72         pt: PidType,
73     ) -> Result<i32, SystemError> {
74         // 是否强制发送信号
75         let mut force_send = false;
76         // signal的信息为空
77 
78         if let Some(ref siginfo) = info {
79             force_send = matches!(siginfo.sig_code(), SigCode::Kernel);
80         } else {
81             // todo: 判断signal是否来自于一个祖先进程的namespace,如果是,则强制发送信号
82             //详见 https://code.dragonos.org.cn/xref/linux-6.1.9/kernel/signal.c?r=&mo=32170&fi=1220#1226
83         }
84 
85         if !self.prepare_sianal(pcb.clone(), force_send) {
86             return Err(SystemError::EINVAL);
87         }
88         // debug!("force send={}", force_send);
89         let pcb_info = pcb.sig_info_irqsave();
90         let pending = if matches!(pt, PidType::PID) {
91             pcb_info.sig_shared_pending()
92         } else {
93             pcb_info.sig_pending()
94         };
95         compiler_fence(core::sync::atomic::Ordering::SeqCst);
96         // 如果是kill或者目标pcb是内核线程,则无需获取sigqueue,直接发送信号即可
97         if matches!(self, Signal::SIGKILL) || pcb.flags().contains(ProcessFlags::KTHREAD) {
98             //避免死锁
99             drop(pcb_info);
100             self.complete_signal(pcb.clone(), pt);
101         }
102         // 如果不是实时信号的话,同一时刻信号队列里只会有一个待处理的信号,如果重复接收就不做处理
103         else if !self.is_rt_signal() && pending.queue().find(*self).0.is_some() {
104             return Ok(0);
105         } else {
106             // TODO signalfd_notify 完善 signalfd 机制
107             // 如果是其他信号,则加入到sigqueue内,然后complete_signal
108             let new_sig_info = match info {
109                 Some(siginfo) => {
110                     // 已经显式指定了siginfo,则直接使用它。
111                     *siginfo
112                 }
113                 None => {
114                     // 不需要显示指定siginfo,因此设置为默认值
115                     SigInfo::new(
116                         *self,
117                         0,
118                         SigCode::User,
119                         SigType::Kill(ProcessManager::current_pcb().pid()),
120                     )
121                 }
122             };
123             drop(pcb_info);
124             pcb.sig_info_mut()
125                 .sig_pending_mut()
126                 .queue_mut()
127                 .q
128                 .push(new_sig_info);
129 
130             // if pt == PidType::PGID || pt == PidType::SID {}
131             self.complete_signal(pcb.clone(), pt);
132         }
133         compiler_fence(core::sync::atomic::Ordering::SeqCst);
134         return Ok(0);
135     }
136 
137     /// @brief 将信号添加到目标进程的sig_pending。在引入进程组后,本函数还将负责把信号传递给整个进程组。
138     ///
139     /// @param sig 信号
140     /// @param pcb 目标pcb
141     /// @param pt siginfo结构体中,pid字段代表的含义
142     #[allow(clippy::if_same_then_else)]
143     fn complete_signal(&self, pcb: Arc<ProcessControlBlock>, pt: PidType) {
144         // debug!("complete_signal");
145 
146         compiler_fence(core::sync::atomic::Ordering::SeqCst);
147         // ===== 寻找需要wakeup的目标进程 =====
148         // 备注:由于当前没有进程组的概念,每个进程只有1个对应的线程,因此不需要通知进程组内的每个进程。
149         //      todo: 当引入进程组的概念后,需要完善这里,使得它能寻找一个目标进程来唤醒,接着执行信号处理的操作。
150 
151         // let _signal = pcb.sig_struct();
152 
153         let target_pcb: Option<Arc<ProcessControlBlock>>;
154 
155         // 判断目标进程是否想接收这个信号
156         if self.wants_signal(pcb.clone()) {
157             // todo: 将信号产生的消息通知到正在监听这个信号的进程(引入signalfd之后,在这里调用signalfd_notify)
158             // 将这个信号加到目标进程的sig_pending中
159             pcb.sig_info_mut()
160                 .sig_pending_mut()
161                 .signal_mut()
162                 .insert((*self).into());
163             target_pcb = Some(pcb.clone());
164         } else if pt == PidType::PID {
165             /*
166              * There is just one thread and it does not need to be woken.
167              * It will dequeue unblocked signals before it runs again.
168              */
169             return;
170         } else {
171             /*
172              * Otherwise try to find a suitable thread.
173              * 由于目前每个进程只有1个线程,因此当前情况可以返回。信号队列的dequeue操作不需要考虑同步阻塞的问题。
174              */
175             return;
176         }
177 
178         // TODO:引入进程组后,在这里挑选一个进程来唤醒,让它执行相应的操作。
179         compiler_fence(core::sync::atomic::Ordering::SeqCst);
180         // TODO: 到这里,信号已经被放置在共享的pending队列中,我们在这里把目标进程唤醒。
181         if let Some(target_pcb) = target_pcb {
182             let guard = target_pcb.sig_struct();
183             signal_wake_up(target_pcb.clone(), guard, *self == Signal::SIGKILL);
184         }
185     }
186 
187     /// @brief 本函数用于检测指定的进程是否想要接收SIG这个信号。
188     /// 当我们对于进程组中的所有进程都运行了这个检查之后,我们将可以找到组内愿意接收信号的进程。
189     /// 这么做是为了防止我们把信号发送给了一个正在或已经退出的进程,或者是不响应该信号的进程。
190     #[inline]
191     fn wants_signal(&self, pcb: Arc<ProcessControlBlock>) -> bool {
192         // 如果改进程屏蔽了这个signal,则不能接收
193         if pcb.sig_info_irqsave().sig_block().contains((*self).into()) {
194             return false;
195         }
196 
197         // 如果进程正在退出,则不能接收信号
198         if pcb.flags().contains(ProcessFlags::EXITING) {
199             return false;
200         }
201 
202         if *self == Signal::SIGKILL {
203             return true;
204         }
205         let state = pcb.sched_info().inner_lock_read_irqsave().state();
206         if state.is_blocked() && (!state.is_blocked_interruptable()) {
207             return false;
208         }
209 
210         // todo: 检查目标进程是否正在一个cpu上执行,如果是,则返回true,否则继续检查下一项
211 
212         // 检查目标进程是否有信号正在等待处理,如果是,则返回false,否则返回true
213         return pcb.sig_info_irqsave().sig_pending().signal().bits() == 0;
214     }
215 
216     /// @brief 判断signal的处理是否可能使得整个进程组退出
217     /// @return true 可能会导致退出(不一定)
218     #[allow(dead_code)]
219     #[inline]
220     fn sig_fatal(&self, pcb: Arc<ProcessControlBlock>) -> bool {
221         let action = pcb.sig_struct().handlers[*self as usize - 1].action();
222         // 如果handler是空,采用默认函数,signal处理可能会导致进程退出。
223         match action {
224             SigactionType::SaHandler(handler) => handler.is_sig_default(),
225             SigactionType::SaSigaction(sigaction) => sigaction.is_none(),
226         }
227         // todo: 参照linux的sig_fatal实现完整功能
228     }
229 
230     /// 检查信号是否能被发送,并且而且要处理 SIGCONT 和 STOP 信号
231     ///
232     /// ## 参数
233     ///
234     /// - `pcb` 要发送信号的目标pcb
235     ///
236     /// - `force` 是否强制发送(指走 fast path , 不加入 sigpending按顺序处理,直接进入 complete_signal)
237     ///
238     /// ## 返回值
239     ///
240     /// - `true` 能够发送信号
241     ///
242     /// - `false` 不能发送信号
243     fn prepare_sianal(&self, pcb: Arc<ProcessControlBlock>, _force: bool) -> bool {
244         let flush: SigSet;
245         if !(self.into_sigset() & SIG_KERNEL_STOP_MASK).is_empty() {
246             flush = Signal::SIGCONT.into_sigset();
247             pcb.sig_info_mut()
248                 .sig_shared_pending_mut()
249                 .flush_by_mask(&flush);
250             // TODO 对每个子线程 flush mask
251         } else if *self == Signal::SIGCONT {
252             flush = SIG_KERNEL_STOP_MASK;
253             assert!(!flush.is_empty());
254             pcb.sig_info_mut()
255                 .sig_shared_pending_mut()
256                 .flush_by_mask(&flush);
257             let _r = ProcessManager::wakeup_stop(&pcb);
258             // TODO 对每个子线程 flush mask
259             // 这里需要补充一段逻辑,详见https://code.dragonos.org.cn/xref/linux-6.1.9/kernel/signal.c#952
260         }
261 
262         // 一个被阻塞了的信号肯定是要被处理的
263         if pcb
264             .sig_info_irqsave()
265             .sig_block()
266             .contains(self.into_sigset())
267         {
268             return true;
269         }
270         return !pcb.sig_struct().handlers[*self as usize - 1].is_ignore();
271 
272         //TODO 仿照 linux 中的prepare signal完善逻辑,linux 中还会根据例如当前进程状态(Existing)进行判断,现在的信号能否发出就只是根据 ignored 来判断
273     }
274 }
275 
276 /// 因收到信号而唤醒进程
277 ///
278 /// ## 参数
279 ///
280 /// - `pcb` 要唤醒的进程pcb
281 /// - `_guard` 信号结构体锁守卫,来保证信号结构体已上锁
282 /// - `fatal` 表明这个信号是不是致命的(会导致进程退出)
283 #[inline]
284 fn signal_wake_up(pcb: Arc<ProcessControlBlock>, _guard: SpinLockGuard<SignalStruct>, fatal: bool) {
285     // 如果是 fatal 的话就唤醒 stop 和 block 的进程来响应,因为唤醒后就会终止
286     // 如果不是 fatal 的就只唤醒 stop 的进程来响应
287     // debug!("signal_wake_up");
288     // 如果目标进程已经在运行,则发起一个ipi,使得它陷入内核
289     let state = pcb.sched_info().inner_lock_read_irqsave().state();
290     let mut wakeup_ok = true;
291     if state.is_blocked_interruptable() {
292         ProcessManager::wakeup(&pcb).unwrap_or_else(|e| {
293             wakeup_ok = false;
294             warn!(
295                 "Current pid: {:?}, signal_wake_up target {:?} error: {:?}",
296                 ProcessManager::current_pcb().pid(),
297                 pcb.pid(),
298                 e
299             );
300         });
301     } else if state.is_stopped() {
302         ProcessManager::wakeup_stop(&pcb).unwrap_or_else(|e| {
303             wakeup_ok = false;
304             warn!(
305                 "Current pid: {:?}, signal_wake_up target {:?} error: {:?}",
306                 ProcessManager::current_pcb().pid(),
307                 pcb.pid(),
308                 e
309             );
310         });
311     } else {
312         wakeup_ok = false;
313     }
314 
315     if wakeup_ok {
316         ProcessManager::kick(&pcb);
317     } else if fatal {
318         let _r = ProcessManager::wakeup(&pcb).map(|_| {
319             ProcessManager::kick(&pcb);
320         });
321     }
322 }
323 
324 /// @brief 当一个进程具有多个线程之后,在这里需要重新计算线程的flag中的TIF_SIGPENDING位
325 fn recalc_sigpending() {
326     // todo:
327 }
328 
329 /// @brief 刷新指定进程的sighand的sigaction,将满足条件的sigaction恢复为Default
330 ///     除非某个信号被设置为ignore且force_default为false,否则都不会将其恢复
331 ///
332 /// @param pcb 要被刷新的pcb
333 /// @param force_default 是否强制将sigaction恢复成默认状态
334 pub fn flush_signal_handlers(pcb: Arc<ProcessControlBlock>, force_default: bool) {
335     compiler_fence(core::sync::atomic::Ordering::SeqCst);
336     // debug!("hand=0x{:018x}", hand as *const sighand_struct as usize);
337     let actions = &mut pcb.sig_struct_irqsave().handlers;
338 
339     for sigaction in actions.iter_mut() {
340         if force_default || !sigaction.is_ignore() {
341             sigaction.set_action(SigactionType::SaHandler(SaHandlerType::Default));
342         }
343         // 清除flags中,除了DFL和IGN以外的所有标志
344         sigaction.set_restorer(None);
345         sigaction.mask_mut().remove(SigSet::all());
346         compiler_fence(core::sync::atomic::Ordering::SeqCst);
347     }
348     compiler_fence(core::sync::atomic::Ordering::SeqCst);
349 }
350 
351 pub(super) fn do_sigaction(
352     sig: Signal,
353     act: Option<&mut Sigaction>,
354     old_act: Option<&mut Sigaction>,
355 ) -> Result<(), SystemError> {
356     if sig == Signal::INVALID {
357         return Err(SystemError::EINVAL);
358     }
359     let pcb = ProcessManager::current_pcb();
360     // 指向当前信号的action的引用
361     let action: &mut Sigaction = &mut pcb.sig_struct().handlers[sig as usize - 1];
362 
363     // 对比 MUSL 和 relibc , 暂时不设置这个标志位
364     // if action.flags().contains(SigFlags::SA_FLAG_IMMUTABLE) {
365     //     return Err(SystemError::EINVAL);
366     // }
367 
368     // 保存原有的 sigaction
369     let old_act: Option<&mut Sigaction> = {
370         if let Some(oa) = old_act {
371             *(oa) = *action;
372             Some(oa)
373         } else {
374             None
375         }
376     };
377     // 清除所有的脏的sa_flags位(也就是清除那些未使用的)
378     let act = {
379         if let Some(ac) = act {
380             *ac.flags_mut() &= SigFlags::SA_ALL;
381             Some(ac)
382         } else {
383             None
384         }
385     };
386 
387     if let Some(act) = old_act {
388         *act.flags_mut() &= SigFlags::SA_ALL;
389     }
390 
391     if let Some(ac) = act {
392         // 将act.sa_mask的SIGKILL SIGSTOP的屏蔽清除
393         ac.mask_mut()
394             .remove(<Signal as Into<SigSet>>::into(Signal::SIGKILL) | Signal::SIGSTOP.into());
395 
396         // 将新的sigaction拷贝到进程的action中
397         *action = *ac;
398         /*
399         * 根据POSIX 3.3.1.3规定:
400         * 1.不管一个信号是否被阻塞,只要将其设置SIG_IGN,如果当前已经存在了正在pending的信号,那么就把这个信号忽略。
401         *
402         * 2.不管一个信号是否被阻塞,只要将其设置SIG_DFL,如果当前已经存在了正在pending的信号,
403               并且对这个信号的默认处理方式是忽略它,那么就会把pending的信号忽略。
404         */
405         if action.is_ignore() {
406             let mut mask: SigSet = SigSet::from_bits_truncate(0);
407             mask.insert(sig.into());
408             pcb.sig_info_mut().sig_pending_mut().flush_by_mask(&mask);
409             // todo: 当有了多个线程后,在这里进行操作,把每个线程的sigqueue都进行刷新
410         }
411     }
412     return Ok(());
413 }
414 
415 /// 设置当前进程的屏蔽信号 (sig_block),待引入 [sigprocmask](https://man7.org/linux/man-pages/man2/sigprocmask.2.html) 系统调用后要删除这个散装函数
416 ///
417 /// ## 参数
418 ///
419 /// - `new_set` 新的屏蔽信号bitmap的值
420 pub fn set_current_sig_blocked(new_set: &mut SigSet) {
421     let to_remove: SigSet =
422         <Signal as Into<SigSet>>::into(Signal::SIGKILL) | Signal::SIGSTOP.into();
423     new_set.remove(to_remove);
424     //TODO 把这个散装函数用 sigsetops 替换掉
425     let pcb = ProcessManager::current_pcb();
426 
427     /*
428         如果当前pcb的sig_blocked和新的相等,那么就不用改变它。
429         请注意,一个进程的sig_blocked字段不能被其他进程修改!
430     */
431     if pcb.sig_info_irqsave().sig_block().eq(new_set) {
432         return;
433     }
434 
435     let guard = pcb.sig_struct_irqsave();
436     // todo: 当一个进程有多个线程后,在这里需要设置每个线程的block字段,并且 retarget_shared_pending(虽然我还没搞明白linux这部分是干啥的)
437 
438     // 设置当前进程的sig blocked
439     *pcb.sig_info_mut().sig_block_mut() = *new_set;
440     recalc_sigpending();
441     drop(guard);
442 }
443