xref: /DragonOS/kernel/src/process/fork.rs (revision f9fe30be89e89499aad4ef52b4648986bef5a7d8)
1 use core::{intrinsics::unlikely, sync::atomic::Ordering};
2 
3 use alloc::{string::ToString, sync::Arc};
4 use log::error;
5 use system_error::SystemError;
6 
7 use crate::{
8     arch::{interrupt::TrapFrame, ipc::signal::Signal},
9     filesystem::procfs::procfs_register_pid,
10     ipc::signal::flush_signal_handlers,
11     libs::rwlock::RwLock,
12     mm::VirtAddr,
13     process::ProcessFlags,
14     sched::{sched_cgroup_fork, sched_fork},
15     smp::core::smp_get_processor_id,
16     syscall::user_access::UserBufferWriter,
17 };
18 
19 use super::{
20     kthread::{KernelThreadPcbPrivate, WorkerPrivate},
21     KernelStack, Pid, ProcessControlBlock, ProcessManager,
22 };
23 
24 bitflags! {
25     /// 进程克隆标志
26     pub struct CloneFlags: u64 {
27         /// 在进程间共享虚拟内存空间
28         const CLONE_VM = 0x00000100;
29         /// 在进程间共享文件系统信息
30         const CLONE_FS = 0x00000200;
31         /// 共享打开的文件
32         const CLONE_FILES = 0x00000400;
33         /// 克隆时,与父进程共享信号处理结构体
34         const CLONE_SIGHAND = 0x00000800;
35         /// 返回进程的文件描述符
36         const CLONE_PIDFD = 0x00001000;
37         /// 使克隆对象成为父进程的跟踪对象
38         const CLONE_PTRACE = 0x00002000;
39         /// 在执行 exec() 或 _exit() 之前挂起父进程的执行
40         const CLONE_VFORK = 0x00004000;
41         /// 使克隆对象的父进程为调用进程的父进程
42         const CLONE_PARENT = 0x00008000;
43         /// 拷贝线程
44         const CLONE_THREAD = 0x00010000;
45         /// 创建一个新的命名空间,其中包含独立的文件系统挂载点层次结构。
46         const CLONE_NEWNS =	0x00020000;
47         /// 与父进程共享 System V 信号量。
48         const CLONE_SYSVSEM = 0x00040000;
49         /// 设置其线程本地存储
50         const CLONE_SETTLS = 0x00080000;
51         /// 设置partent_tid地址为子进程线程 ID
52         const CLONE_PARENT_SETTID = 0x00100000;
53         /// 在子进程中设置一个清除线程 ID 的用户空间地址
54         const CLONE_CHILD_CLEARTID = 0x00200000;
55         /// 创建一个新线程,将其设置为分离状态
56         const CLONE_DETACHED = 0x00400000;
57         /// 使其在创建者进程或线程视角下成为无法跟踪的。
58         const CLONE_UNTRACED = 0x00800000;
59         /// 设置其子进程线程 ID
60         const CLONE_CHILD_SETTID = 0x01000000;
61         /// 将其放置在一个新的 cgroup 命名空间中
62         const CLONE_NEWCGROUP = 0x02000000;
63         /// 将其放置在一个新的 UTS 命名空间中
64         const CLONE_NEWUTS = 0x04000000;
65         /// 将其放置在一个新的 IPC 命名空间中
66         const CLONE_NEWIPC = 0x08000000;
67         /// 将其放置在一个新的用户命名空间中
68         const CLONE_NEWUSER = 0x10000000;
69         /// 将其放置在一个新的 PID 命名空间中
70         const CLONE_NEWPID = 0x20000000;
71         /// 将其放置在一个新的网络命名空间中
72         const CLONE_NEWNET = 0x40000000;
73         /// 在新的 I/O 上下文中运行它
74         const CLONE_IO = 0x80000000;
75         /// 克隆时,与父进程共享信号结构体
76         const CLONE_SIGNAL = 0x00010000 | 0x00000800;
77         /// 克隆时,将原本被设置为SIG_IGNORE的信号,设置回SIG_DEFAULT
78         const CLONE_CLEAR_SIGHAND = 0x100000000;
79     }
80 }
81 
82 /// ## clone与clone3系统调用的参数载体
83 ///
84 /// 因为这两个系统调用的参数很多,所以有这样一个载体更灵活
85 ///
86 /// 仅仅作为参数传递
87 #[derive(Debug, Clone, Copy)]
88 #[allow(dead_code)]
89 pub struct KernelCloneArgs {
90     pub flags: CloneFlags,
91 
92     // 下列属性均来自用户空间
93     pub pidfd: VirtAddr,
94     pub child_tid: VirtAddr,
95     pub parent_tid: VirtAddr,
96     pub set_tid: VirtAddr,
97 
98     /// 进程退出时发送的信号
99     pub exit_signal: Signal,
100 
101     pub stack: usize,
102     // clone3用到
103     pub stack_size: usize,
104     pub tls: usize,
105 
106     pub set_tid_size: usize,
107     pub cgroup: i32,
108 
109     pub io_thread: bool,
110     pub kthread: bool,
111     pub idle: bool,
112     pub func: VirtAddr,
113     pub fn_arg: VirtAddr,
114     // cgrp 和 cset?
115 }
116 
117 impl KernelCloneArgs {
118     pub fn new() -> Self {
119         let null_addr = VirtAddr::new(0);
120         Self {
121             flags: unsafe { CloneFlags::from_bits_unchecked(0) },
122             pidfd: null_addr,
123             child_tid: null_addr,
124             parent_tid: null_addr,
125             set_tid: null_addr,
126             exit_signal: Signal::SIGCHLD,
127             stack: 0,
128             stack_size: 0,
129             tls: 0,
130             set_tid_size: 0,
131             cgroup: 0,
132             io_thread: false,
133             kthread: false,
134             idle: false,
135             func: null_addr,
136             fn_arg: null_addr,
137         }
138     }
139 }
140 
141 impl ProcessManager {
142     /// 创建一个新进程
143     ///
144     /// ## 参数
145     ///
146     /// - `current_trapframe`: 当前进程的trapframe
147     /// - `clone_flags`: 进程克隆标志
148     ///
149     /// ## 返回值
150     ///
151     /// - 成功:返回新进程的pid
152     /// - 失败:返回Err(SystemError),fork失败的话,子线程不会执行。
153     ///
154     /// ## Safety
155     ///
156     /// - fork失败的话,子线程不会执行。
157     pub fn fork(
158         current_trapframe: &TrapFrame,
159         clone_flags: CloneFlags,
160     ) -> Result<Pid, SystemError> {
161         let current_pcb = ProcessManager::current_pcb();
162 
163         let new_kstack: KernelStack = KernelStack::new()?;
164 
165         let name = current_pcb.basic().name().to_string();
166 
167         let pcb = ProcessControlBlock::new(name, new_kstack);
168 
169         pcb.sig_info_mut()
170             .set_tty(current_pcb.sig_info_irqsave().tty());
171 
172         let mut args = KernelCloneArgs::new();
173         args.flags = clone_flags;
174         args.exit_signal = Signal::SIGCHLD;
175         Self::copy_process(&current_pcb, &pcb, args, current_trapframe).map_err(|e| {
176             error!(
177                 "fork: Failed to copy process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
178                 current_pcb.pid(),
179                 pcb.pid(),
180                 e
181             );
182             e
183         })?;
184         ProcessManager::add_pcb(pcb.clone());
185 
186         // 向procfs注册进程
187         procfs_register_pid(pcb.pid()).unwrap_or_else(|e| {
188             panic!(
189                 "fork: Failed to register pid to procfs, pid: [{:?}]. Error: {:?}",
190                 pcb.pid(),
191                 e
192             )
193         });
194 
195         pcb.sched_info().set_on_cpu(Some(smp_get_processor_id()));
196 
197         ProcessManager::wakeup(&pcb).unwrap_or_else(|e| {
198             panic!(
199                 "fork: Failed to wakeup new process, pid: [{:?}]. Error: {:?}",
200                 pcb.pid(),
201                 e
202             )
203         });
204 
205         return Ok(pcb.pid());
206     }
207 
208     fn copy_flags(
209         clone_flags: &CloneFlags,
210         new_pcb: &Arc<ProcessControlBlock>,
211     ) -> Result<(), SystemError> {
212         if clone_flags.contains(CloneFlags::CLONE_VM) {
213             new_pcb.flags().insert(ProcessFlags::VFORK);
214         }
215         *new_pcb.flags.get_mut() = *ProcessManager::current_pcb().flags();
216         return Ok(());
217     }
218 
219     /// 拷贝进程的地址空间
220     ///
221     /// ## 参数
222     ///
223     /// - `clone_vm`: 是否与父进程共享地址空间。true表示共享
224     /// - `new_pcb`: 新进程的pcb
225     ///
226     /// ## 返回值
227     ///
228     /// - 成功:返回Ok(())
229     /// - 失败:返回Err(SystemError)
230     ///
231     /// ## Panic
232     ///
233     /// - 如果当前进程没有用户地址空间,则panic
234     #[inline(never)]
235     fn copy_mm(
236         clone_flags: &CloneFlags,
237         current_pcb: &Arc<ProcessControlBlock>,
238         new_pcb: &Arc<ProcessControlBlock>,
239     ) -> Result<(), SystemError> {
240         let old_address_space = current_pcb.basic().user_vm().unwrap_or_else(|| {
241             panic!(
242                 "copy_mm: Failed to get address space of current process, current pid: [{:?}]",
243                 current_pcb.pid()
244             )
245         });
246 
247         if clone_flags.contains(CloneFlags::CLONE_VM) {
248             unsafe { new_pcb.basic_mut().set_user_vm(Some(old_address_space)) };
249             return Ok(());
250         }
251         let new_address_space = old_address_space.write_irqsave().try_clone().unwrap_or_else(|e| {
252             panic!(
253                 "copy_mm: Failed to clone address space of current process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
254                 current_pcb.pid(), new_pcb.pid(), e
255             )
256         });
257         unsafe { new_pcb.basic_mut().set_user_vm(Some(new_address_space)) };
258         return Ok(());
259     }
260 
261     #[inline(never)]
262     fn copy_files(
263         clone_flags: &CloneFlags,
264         current_pcb: &Arc<ProcessControlBlock>,
265         new_pcb: &Arc<ProcessControlBlock>,
266     ) -> Result<(), SystemError> {
267         // 如果不共享文件描述符表,则拷贝文件描述符表
268         if !clone_flags.contains(CloneFlags::CLONE_FILES) {
269             let new_fd_table = current_pcb.basic().fd_table().unwrap().read().clone();
270             let new_fd_table = Arc::new(RwLock::new(new_fd_table));
271             new_pcb.basic_mut().set_fd_table(Some(new_fd_table));
272         } else {
273             // 如果共享文件描述符表,则直接拷贝指针
274             new_pcb
275                 .basic_mut()
276                 .set_fd_table(current_pcb.basic().fd_table().clone());
277         }
278 
279         return Ok(());
280     }
281 
282     #[allow(dead_code)]
283     fn copy_sighand(
284         clone_flags: &CloneFlags,
285         current_pcb: &Arc<ProcessControlBlock>,
286         new_pcb: &Arc<ProcessControlBlock>,
287     ) -> Result<(), SystemError> {
288         // // 将信号的处理函数设置为default(除了那些被手动屏蔽的)
289         if clone_flags.contains(CloneFlags::CLONE_CLEAR_SIGHAND) {
290             flush_signal_handlers(new_pcb.clone(), false);
291         }
292 
293         if clone_flags.contains(CloneFlags::CLONE_SIGHAND) {
294             new_pcb.sig_struct_irqsave().handlers = current_pcb.sig_struct_irqsave().handlers;
295         }
296         return Ok(());
297     }
298 
299     /// 拷贝进程信息
300     ///
301     /// ## panic:
302     /// 某一步拷贝失败时会引发panic
303     /// 例如:copy_mm等失败时会触发panic
304     ///
305     /// ## 参数
306     ///
307     /// - clone_flags 标志位
308     /// - current_pcb 拷贝源pcb
309     /// - pcb 目标pcb
310     ///
311     /// ## return
312     /// - 发生错误时返回Err(SystemError)
313     #[inline(never)]
314     pub fn copy_process(
315         current_pcb: &Arc<ProcessControlBlock>,
316         pcb: &Arc<ProcessControlBlock>,
317         clone_args: KernelCloneArgs,
318         current_trapframe: &TrapFrame,
319     ) -> Result<(), SystemError> {
320         let clone_flags = clone_args.flags;
321         // 不允许与不同namespace的进程共享根目录
322         if (clone_flags == (CloneFlags::CLONE_NEWNS | CloneFlags::CLONE_FS))
323             || clone_flags == (CloneFlags::CLONE_NEWUSER | CloneFlags::CLONE_FS)
324         {
325             return Err(SystemError::EINVAL);
326         }
327 
328         // 线程组必须共享信号,分离线程只能在线程组内启动。
329         if clone_flags.contains(CloneFlags::CLONE_THREAD)
330             && !clone_flags.contains(CloneFlags::CLONE_SIGHAND)
331         {
332             return Err(SystemError::EINVAL);
333         }
334 
335         // 共享信号处理器意味着共享vm。
336         // 线程组也意味着共享vm。阻止这种情况可以简化其他代码。
337         if clone_flags.contains(CloneFlags::CLONE_SIGHAND)
338             && !clone_flags.contains(CloneFlags::CLONE_VM)
339         {
340             return Err(SystemError::EINVAL);
341         }
342 
343         // TODO: 处理CLONE_PARENT 与 SIGNAL_UNKILLABLE的情况
344 
345         // 如果新进程使用不同的 pid 或 namespace,
346         // 则不允许它与分叉任务共享线程组。
347         if clone_flags.contains(CloneFlags::CLONE_THREAD)
348             && clone_flags.contains(CloneFlags::CLONE_NEWUSER | CloneFlags::CLONE_NEWPID)
349         {
350             return Err(SystemError::EINVAL);
351             // TODO: 判断新进程与当前进程namespace是否相同,不同则返回错误
352         }
353 
354         // 如果新进程将处于不同的time namespace,
355         // 则不能让它共享vm或线程组。
356         if clone_flags.contains(CloneFlags::CLONE_THREAD | CloneFlags::CLONE_VM) {
357             // TODO: 判断time namespace,不同则返回错误
358         }
359 
360         if clone_flags.contains(CloneFlags::CLONE_PIDFD)
361             && clone_flags.contains(CloneFlags::CLONE_DETACHED | CloneFlags::CLONE_THREAD)
362         {
363             return Err(SystemError::EINVAL);
364         }
365 
366         // TODO: 克隆前应该锁信号处理,等待克隆完成后再处理
367 
368         // 克隆架构相关
369         let guard = current_pcb.arch_info_irqsave();
370         unsafe { pcb.arch_info().clone_from(&guard) };
371         drop(guard);
372 
373         // 为内核线程设置WorkerPrivate
374         if current_pcb.flags().contains(ProcessFlags::KTHREAD) {
375             *pcb.worker_private() =
376                 Some(WorkerPrivate::KernelThread(KernelThreadPcbPrivate::new()));
377         }
378 
379         // 设置clear_child_tid,在线程结束时将其置0以通知父进程
380         if clone_flags.contains(CloneFlags::CLONE_CHILD_CLEARTID) {
381             pcb.thread.write_irqsave().clear_child_tid = Some(clone_args.child_tid);
382         }
383 
384         // 设置child_tid,意味着子线程能够知道自己的id
385         if clone_flags.contains(CloneFlags::CLONE_CHILD_SETTID) {
386             pcb.thread.write_irqsave().set_child_tid = Some(clone_args.child_tid);
387         }
388 
389         // 将子进程/线程的id存储在用户态传进的地址中
390         if clone_flags.contains(CloneFlags::CLONE_PARENT_SETTID) {
391             let mut writer = UserBufferWriter::new(
392                 clone_args.parent_tid.data() as *mut i32,
393                 core::mem::size_of::<i32>(),
394                 true,
395             )?;
396 
397             writer.copy_one_to_user(&(pcb.pid().0 as i32), 0)?;
398         }
399 
400         sched_fork(pcb).unwrap_or_else(|e| {
401             panic!(
402                 "fork: Failed to set sched info from current process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
403                 current_pcb.pid(), pcb.pid(), e
404             )
405         });
406 
407         // 拷贝标志位
408         Self::copy_flags(&clone_flags, pcb).unwrap_or_else(|e| {
409             panic!(
410                 "fork: Failed to copy flags from current process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
411                 current_pcb.pid(), pcb.pid(), e
412             )
413         });
414 
415         // 拷贝用户地址空间
416         Self::copy_mm(&clone_flags, current_pcb, pcb).unwrap_or_else(|e| {
417             panic!(
418                 "fork: Failed to copy mm from current process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
419                 current_pcb.pid(), pcb.pid(), e
420             )
421         });
422 
423         // 拷贝文件描述符表
424         Self::copy_files(&clone_flags, current_pcb, pcb).unwrap_or_else(|e| {
425             panic!(
426                 "fork: Failed to copy files from current process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
427                 current_pcb.pid(), pcb.pid(), e
428             )
429         });
430 
431         // 拷贝信号相关数据
432         Self::copy_sighand(&clone_flags, current_pcb, pcb).unwrap_or_else(|e| {
433             panic!(
434                 "fork: Failed to copy sighand from current process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
435                 current_pcb.pid(), pcb.pid(), e
436             )
437         });
438 
439         // 拷贝线程
440         Self::copy_thread(current_pcb, pcb, clone_args,current_trapframe).unwrap_or_else(|e| {
441             panic!(
442                 "fork: Failed to copy thread from current process, current pid: [{:?}], new pid: [{:?}]. Error: {:?}",
443                 current_pcb.pid(), pcb.pid(), e
444             )
445         });
446 
447         // 设置线程组id、组长
448         if clone_flags.contains(CloneFlags::CLONE_THREAD) {
449             pcb.thread.write_irqsave().group_leader =
450                 current_pcb.thread.read_irqsave().group_leader.clone();
451             unsafe {
452                 let ptr = pcb.as_ref() as *const ProcessControlBlock as *mut ProcessControlBlock;
453                 (*ptr).tgid = current_pcb.tgid;
454             }
455         } else {
456             pcb.thread.write_irqsave().group_leader = Arc::downgrade(pcb);
457             unsafe {
458                 let ptr = pcb.as_ref() as *const ProcessControlBlock as *mut ProcessControlBlock;
459                 (*ptr).tgid = pcb.tgid;
460             }
461         }
462 
463         // CLONE_PARENT re-uses the old parent
464         if clone_flags.contains(CloneFlags::CLONE_PARENT | CloneFlags::CLONE_THREAD) {
465             *pcb.real_parent_pcb.write_irqsave() =
466                 current_pcb.real_parent_pcb.read_irqsave().clone();
467 
468             if clone_flags.contains(CloneFlags::CLONE_THREAD) {
469                 pcb.exit_signal.store(Signal::INVALID, Ordering::SeqCst);
470             } else {
471                 let leader = current_pcb.thread.read_irqsave().group_leader();
472                 if unlikely(leader.is_none()) {
473                     panic!(
474                         "fork: Failed to get leader of current process, current pid: [{:?}]",
475                         current_pcb.pid()
476                     );
477                 }
478 
479                 pcb.exit_signal.store(
480                     leader.unwrap().exit_signal.load(Ordering::SeqCst),
481                     Ordering::SeqCst,
482                 );
483             }
484         } else {
485             // 新创建的进程,设置其父进程为当前进程
486             *pcb.real_parent_pcb.write_irqsave() = Arc::downgrade(current_pcb);
487             pcb.exit_signal
488                 .store(clone_args.exit_signal, Ordering::SeqCst);
489         }
490 
491         // todo: 增加线程组相关的逻辑。 参考 https://code.dragonos.org.cn/xref/linux-6.1.9/kernel/fork.c#2437
492 
493         sched_cgroup_fork(pcb);
494 
495         Ok(())
496     }
497 }
498