Samuka007/asterinas
1
0
Fork 0
mirror of https://github.com/asterinas/asterinas.git synced 2025-06-23 17:33:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Homogenize arguments for clone() and clone3()

Browse Source 
The arguments for both syscalls follow different formats. Rewrite the
CloneArgs struct to homogenize both formats into one.
This commit is contained in:
Carlos López
2024-09-24 21:16:04 +02:00
committed by Tate, Hongliang Tian
parent fad39fdf7a
commit 130a0f7030
2 changed files with 125 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
kernel/src/process/clone.rs
View File

@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0 // SPDX-License-Identifier: MPL-2.0
use core::sync::atomic::Ordering; use core::{num::NonZeroU64, sync::atomic::Ordering};
use ostd::{ use ostd::{
cpu::UserContext, cpu::UserContext,
@ -12,7 +12,7 @@ use super::{
posix_thread::{thread_table, PosixThread, PosixThreadBuilder, PosixThreadExt, ThreadName}, posix_thread::{thread_table, PosixThread, PosixThreadBuilder, PosixThreadExt, ThreadName},
process_table, process_table,
process_vm::ProcessVm, process_vm::ProcessVm,
signal::sig_disposition::SigDispositions, signal::{constants::SIGCHLD, sig_disposition::SigDispositions, sig_num::SigNum},
Credentials, Process, ProcessBuilder, Credentials, Process, ProcessBuilder,
}; };
use crate::{ use crate::{
@ -25,6 +25,7 @@ use crate::{
}; };
bitflags! { bitflags! {
#[derive(Default)]
pub struct CloneFlags: u32 { pub struct CloneFlags: u32 {
const CLONE_VM = 0x00000100; /* Set if VM shared between processes. */ const CLONE_VM = 0x00000100; /* Set if VM shared between processes. */
const CLONE_FS = 0x00000200; /* Set if fs info shared between processes. */ const CLONE_FS = 0x00000200; /* Set if fs info shared between processes. */
@ -53,45 +54,91 @@ bitflags! {
} }
} }
#[derive(Debug, Clone, Copy)] /// An internal structure to homogenize the arguments for `clone` and
/// `clone3`.
///
/// From the clone(2) man page:
///
/// ```
/// The following table shows the equivalence between the arguments
/// of clone() and the fields in the clone_args argument supplied to
/// clone3():
/// clone() clone3() Notes
/// cl_args field
/// flags & ~0xff flags For most flags; details
/// below
/// parent_tid pidfd See CLONE_PIDFD
/// child_tid child_tid See CLONE_CHILD_SETTID
/// parent_tid parent_tid See CLONE_PARENT_SETTID
/// flags & 0xff exit_signal
/// stack stack
/// --- stack_size
/// tls tls See CLONE_SETTLS
/// --- set_tid See below for details
/// --- set_tid_size
/// --- cgroup See CLONE_INTO_CGROUP
/// ```
#[derive(Debug, Clone, Copy, Default)]
pub struct CloneArgs { pub struct CloneArgs {
new_sp: u64, pub flags: CloneFlags,
stack_size: usize, pub _pidfd: Option<u64>,
parent_tidptr: Vaddr, pub child_tid: Vaddr,
child_tidptr: Vaddr, pub parent_tid: Option<Vaddr>,
tls: u64, pub exit_signal: Option<SigNum>,
clone_flags: CloneFlags, pub stack: u64,
pub stack_size: Option<NonZeroU64>,
pub tls: u64,
pub _set_tid: Option<u64>,
pub _set_tid_size: Option<u64>,
pub _cgroup: Option<u64>,
} }
impl CloneArgs { impl CloneArgs {
/// Clone Args for syscall fork. /// Prepares a new [`CloneArgs`] based on the arguments for clone(2).
/// TODO: set the correct values pub fn for_clone(
pub const fn for_fork() -> Self { raw_flags: u64,
CloneArgs { parent_tid: Vaddr,
new_sp: 0, child_tid: Vaddr,
stack_size: 0, tls: u64,
parent_tidptr: 0, stack: u64,
child_tidptr: 0, ) -> Result<Self> {
tls: 0, const FLAG_MASK: u64 = 0xff;
clone_flags: CloneFlags::empty(), let flags = CloneFlags::from(raw_flags & !FLAG_MASK);
let exit_signal = raw_flags & FLAG_MASK;
// Disambiguate the `parent_tid` parameter. The field is used
// both for `CLONE_PIDFD` and `CLONE_PARENT_SETTID`, so at
// most only one can be specified.
let (pidfd, parent_tid) = match (
flags.contains(CloneFlags::CLONE_PIDFD),
flags.contains(CloneFlags::CLONE_PARENT_SETTID),
) {
(false, false) => (None, None),
(true, false) => (Some(parent_tid as u64), None),
(false, true) => (None, Some(parent_tid)),
(true, true) => {
return_errno_with_message!(
Errno::EINVAL,
"CLONE_PIDFD was specified with CLONE_PARENT_SETTID"
);
} }
};
Ok(Self {
flags,
_pidfd: pidfd,
child_tid,
parent_tid,
exit_signal: (exit_signal != 0).then(|| SigNum::from_u8(exit_signal as u8)),
stack,
tls,
..Default::default()
})
} }
pub const fn new( pub fn for_fork() -> Self {
new_sp: u64, Self {
stack_size: usize, exit_signal: Some(SIGCHLD),
parent_tidptr: Vaddr, ..Default::default()
child_tidptr: Vaddr,
tls: u64,
clone_flags: CloneFlags,
) -> Self {
CloneArgs {
new_sp,
stack_size,
parent_tidptr,
child_tidptr,
tls,
clone_flags,
} }
} }
} }
@ -133,8 +180,8 @@ pub fn clone_child(
parent_context: &UserContext, parent_context: &UserContext,
clone_args: CloneArgs, clone_args: CloneArgs,
) -> Result<Tid> { ) -> Result<Tid> {
clone_args.clone_flags.check_unsupported_flags()?; clone_args.flags.check_unsupported_flags()?;
if clone_args.clone_flags.contains(CloneFlags::CLONE_THREAD) { if clone_args.flags.contains(CloneFlags::CLONE_THREAD) {
let child_task = clone_child_task(ctx, parent_context, clone_args)?; let child_task = clone_child_task(ctx, parent_context, clone_args)?;
let child_thread = Thread::borrow_from_task(&child_task); let child_thread = Thread::borrow_from_task(&child_task);
child_thread.run(); child_thread.run();
@ -162,7 +209,7 @@ fn clone_child_task(
task: _, task: _,
} = ctx; } = ctx;
let clone_flags = clone_args.clone_flags; let clone_flags = clone_args.flags;
debug_assert!(clone_flags.contains(CloneFlags::CLONE_VM)); debug_assert!(clone_flags.contains(CloneFlags::CLONE_VM));
debug_assert!(clone_flags.contains(CloneFlags::CLONE_FILES)); debug_assert!(clone_flags.contains(CloneFlags::CLONE_FILES));
debug_assert!(clone_flags.contains(CloneFlags::CLONE_SIGHAND)); debug_assert!(clone_flags.contains(CloneFlags::CLONE_SIGHAND));
@ -172,7 +219,7 @@ fn clone_child_task(
let child_vm_space = child_root_vmar.vm_space().clone(); let child_vm_space = child_root_vmar.vm_space().clone();
let child_cpu_context = clone_cpu_context( let child_cpu_context = clone_cpu_context(
parent_context, parent_context,
clone_args.new_sp, clone_args.stack,
clone_args.stack_size, clone_args.stack_size,
clone_args.tls, clone_args.tls,
clone_flags, clone_flags,
@ -200,9 +247,9 @@ fn clone_child_task(
process.tasks().lock().push(child_task.clone()); process.tasks().lock().push(child_task.clone());
let child_posix_thread = child_task.as_posix_thread().unwrap(); let child_posix_thread = child_task.as_posix_thread().unwrap();
clone_parent_settid(child_tid, clone_args.parent_tidptr, clone_flags)?; clone_parent_settid(child_tid, clone_args.parent_tid, clone_flags)?;
clone_child_cleartid(child_posix_thread, clone_args.child_tidptr, clone_flags)?; clone_child_cleartid(child_posix_thread, clone_args.child_tid, clone_flags)?;
clone_child_settid(child_posix_thread, clone_args.child_tidptr, clone_flags)?; clone_child_settid(child_posix_thread, clone_args.child_tid, clone_flags)?;
Ok(child_task) Ok(child_task)
} }
@ -218,7 +265,7 @@ fn clone_child_process(
task: _, task: _,
} = ctx; } = ctx;
let clone_flags = clone_args.clone_flags; let clone_flags = clone_args.flags;
// clone vm // clone vm
let child_process_vm = { let child_process_vm = {
@ -230,7 +277,7 @@ fn clone_child_process(
let child_user_space = { let child_user_space = {
let child_cpu_context = clone_cpu_context( let child_cpu_context = clone_cpu_context(
parent_context, parent_context,
clone_args.new_sp, clone_args.stack,
clone_args.stack_size, clone_args.stack_size,
clone_args.tls, clone_args.tls,
clone_flags, clone_flags,
@ -301,9 +348,9 @@ fn clone_child_process(
// Deals with clone flags // Deals with clone flags
let child_thread = thread_table::get_thread(child_tid).unwrap(); let child_thread = thread_table::get_thread(child_tid).unwrap();
let child_posix_thread = child_thread.as_posix_thread().unwrap(); let child_posix_thread = child_thread.as_posix_thread().unwrap();
clone_parent_settid(child_tid, clone_args.parent_tidptr, clone_flags)?; clone_parent_settid(child_tid, clone_args.parent_tid, clone_flags)?;
clone_child_cleartid(child_posix_thread, clone_args.child_tidptr, clone_flags)?; clone_child_cleartid(child_posix_thread, clone_args.child_tid, clone_flags)?;
clone_child_settid(child_posix_thread, clone_args.child_tidptr, clone_flags)?; clone_child_settid(child_posix_thread, clone_args.child_tid, clone_flags)?;
// Sets parent process and group for child process. // Sets parent process and group for child process.
set_parent_and_group(process, &child); set_parent_and_group(process, &child);
@ -335,11 +382,13 @@ fn clone_child_settid(
fn clone_parent_settid( fn clone_parent_settid(
child_tid: Tid, child_tid: Tid,
parent_tidptr: Vaddr, parent_tidptr: Option<Vaddr>,
clone_flags: CloneFlags, clone_flags: CloneFlags,
) -> Result<()> { ) -> Result<()> {
if clone_flags.contains(CloneFlags::CLONE_PARENT_SETTID) { if let Some(addr) =
get_current_userspace!().write_val(parent_tidptr, &child_tid)?; parent_tidptr.filter(|_| clone_flags.contains(CloneFlags::CLONE_PARENT_SETTID))
{
get_current_userspace!().write_val(addr, &child_tid)?;
} }
Ok(()) Ok(())
} }
@ -357,7 +406,7 @@ fn clone_vm(parent_process_vm: &ProcessVm, clone_flags: CloneFlags) -> Result<Pr
fn clone_cpu_context( fn clone_cpu_context(
parent_context: &UserContext, parent_context: &UserContext,
new_sp: u64, new_sp: u64,
stack_size: usize, stack_size: Option<NonZeroU64>,
tls: u64, tls: u64,
clone_flags: CloneFlags, clone_flags: CloneFlags,
) -> UserContext { ) -> UserContext {
@ -371,8 +420,8 @@ fn clone_cpu_context(
} }
if new_sp != 0 { if new_sp != 0 {
// If stack size is not 0, the `new_sp` points to the BOTTOMMOST byte of stack. // If stack size is not 0, the `new_sp` points to the BOTTOMMOST byte of stack.
if stack_size != 0 { if let Some(size) = stack_size {
child_context.set_stack_pointer(new_sp as usize + stack_size); child_context.set_stack_pointer((new_sp + size.get()) as usize)
} }
// If stack size is 0, the new_sp points to the TOPMOST byte of stack. // If stack size is 0, the new_sp points to the TOPMOST byte of stack.
else { else {

40
kernel/src/syscall/clone.rs
View File

@ -1,11 +1,17 @@
// SPDX-License-Identifier: MPL-2.0 // SPDX-License-Identifier: MPL-2.0
use core::num::NonZeroU64;
use ostd::cpu::UserContext; use ostd::cpu::UserContext;
use super::SyscallReturn; use super::SyscallReturn;
use crate::{ use crate::{
prelude::*, prelude::*,
process::{clone_child, signal::constants::SIGCHLD, CloneArgs, CloneFlags}, process::{
clone_child,
signal::{constants::SIGCHLD, sig_num::SigNum},
CloneArgs, CloneFlags,
},
}; };
// The order of arguments for clone differs in different architecture. // The order of arguments for clone differs in different architecture.
@ -19,10 +25,9 @@ pub fn sys_clone(
ctx: &Context, ctx: &Context,
parent_context: &UserContext, parent_context: &UserContext,
) -> Result<SyscallReturn> { ) -> Result<SyscallReturn> {
let clone_flags = CloneFlags::from(clone_flags); let args = CloneArgs::for_clone(clone_flags, parent_tidptr, child_tidptr, tls, new_sp)?;
debug!("flags = {:?}, child_stack_ptr = 0x{:x}, parent_tid_ptr = 0x{:x}, child tid ptr = 0x{:x}, tls = 0x{:x}", clone_flags, new_sp, parent_tidptr, child_tidptr, tls); debug!("flags = {:?}, child_stack_ptr = 0x{:x}, parent_tid_ptr = 0x{:x?}, child tid ptr = 0x{:x}, tls = 0x{:x}", args.flags, args.stack, args.parent_tid, args.child_tid, args.tls);
let clone_args = CloneArgs::new(new_sp, 0, parent_tidptr, child_tidptr, tls, clone_flags); let child_pid = clone_child(ctx, parent_context, args).unwrap();
let child_pid = clone_child(ctx, parent_context, clone_args).unwrap();
Ok(SyscallReturn::Return(child_pid as _)) Ok(SyscallReturn::Return(child_pid as _))
} }
@ -82,10 +87,6 @@ struct Clone3Args {
impl From<Clone3Args> for CloneArgs { impl From<Clone3Args> for CloneArgs {
fn from(value: Clone3Args) -> Self { fn from(value: Clone3Args) -> Self {
const FLAGS_MASK: u64 = 0xff;
let clone_flags =
CloneFlags::from(value.exit_signal & FLAGS_MASK | value.flags & !FLAGS_MASK);
// TODO: deal with pidfd, exit_signal, set_tid, set_tid_size, cgroup // TODO: deal with pidfd, exit_signal, set_tid, set_tid_size, cgroup
if value.exit_signal != 0 || value.exit_signal as u8 != SIGCHLD.as_u8() { if value.exit_signal != 0 || value.exit_signal as u8 != SIGCHLD.as_u8() {
warn!("exit signal is not supported"); warn!("exit signal is not supported");
@ -103,13 +104,18 @@ impl From<Clone3Args> for CloneArgs {
warn!("cgroup is not supported"); warn!("cgroup is not supported");
} }
CloneArgs::new( Self {
value.stack, flags: CloneFlags::from_bits_truncate(value.flags as u32),
value.stack_size as _, _pidfd: Some(value.pidfd),
value.parent_tid as _, child_tid: value.child_tid as _,
value.child_tid as _, parent_tid: Some(value.parent_tid as _),
value.tls, exit_signal: (value.exit_signal != 0).then(|| SigNum::from_u8(value.exit_signal as u8)),
clone_flags, stack: value.stack,
) stack_size: NonZeroU64::new(value.stack_size),
tls: value.tls,
_set_tid: Some(value.set_tid),
_set_tid_size: Some(value.set_tid_size),
_cgroup: Some(value.cgroup),
}
} }
} }