cosmos::CloneArgs Struct Reference

Argument struct for proc::clone(). More...

#include <clone.hxx>

Inheritance diagram for cosmos::CloneArgs:

Public Member Functions
void	clear ()
	Puts the data structure into a defined default state.
void	setFlags (const CloneFlags p_flags)
void	setPidFD (PidFD &fd)
void	setChildTID (ThreadID *tid)
void	setParentTID (ProcessID *pid)
void	setExitSignal (const Signal sig)
	Sets the signal to be delivered upon child process termination.
void	setStack (void *p_stack)
	Sets the pointer to the lowest byte of the stack area.
void	setTIDs (const ThreadID *tids, size_t num_tids)
	Allows to set an explicit thread ID to use for the child.
void	setCGroup (const FileDescriptor fd)
	Sets the cgroup2 file descriptor of which the child should become a member.

Detailed Description

Argument struct for proc::clone().

Definition at line 60 of file clone.hxx.

Constructor & Destructor Documentation

CloneArgs()

cosmos::CloneArgs::CloneArgs ( )

inline

Definition at line 63 of file clone.hxx.

                    {
                clear();
        }

Member Function Documentation

clear()

void cosmos::CloneArgs::clear

(

)

Puts the data structure into a defined default state.

This resets everything to zero except for the child exit signal (see setExitSignal()), which is set to signal::CHILD, which is the default.

Definition at line 21 of file clone.cxx.

                      {
        zero_object(static_cast<clone_args&>(*this));
 
        // this must not be zero by default or we don't get any child exit
        // signal notification.
        setExitSignal(signal::CHILD);
}

setCGroup()

void cosmos::CloneArgs::setCGroup ( const FileDescriptor fd )

inline

Sets the cgroup2 file descriptor of which the child should become a member.

See also

CloneFlag::INTO_CGROUP.

Definition at line 133 of file clone.hxx.

                                                {
                this->cgroup = static_cast<uint64_t>(fd.raw());
        }

setChildTID()

void cosmos::CloneArgs::setChildTID ( ThreadID * tid )

inline

Definition at line 83 of file clone.hxx.

                                        {
                this->child_tid = reinterpret_cast<uint64_t>(tid);
        }

setExitSignal()

void cosmos::CloneArgs::setExitSignal ( const Signal sig )

inline

Sets the signal to be delivered upon child process termination.

This should be set to signal::CHILD by default. If set to Signal::NONE then no signal at all will be sent. If set to a non-default value then special precautions needs to be taken when performing a proc::wait() on the child.

Definition at line 98 of file clone.hxx.

                                             {
                this->exit_signal = static_cast<uint64_t>(to_integral(sig.raw()));
        }

setFlags()

void cosmos::CloneArgs::setFlags ( const CloneFlags p_flags )

inline

Definition at line 75 of file clone.hxx.

                                                {
                this->flags = p_flags.raw();
        }

setParentTID()

void cosmos::CloneArgs::setParentTID ( ProcessID * pid )

inline

Definition at line 87 of file clone.hxx.

                                          {
                this->parent_tid = reinterpret_cast<uint64_t>(pid);
        }

setPidFD()

void cosmos::CloneArgs::setPidFD ( PidFD & fd )

inline

Definition at line 79 of file clone.hxx.

                                 {
                this->pidfd = reinterpret_cast<uintptr_t>(&fd.m_fd);
        }

setStack()

void cosmos::CloneArgs::setStack ( void * p_stack )

inline

Sets the pointer to the lowest byte of the stack area.

If CloneFlag::SHARE_VM is specified then this value must be provided, otherwise the parent's stack is reused for the child if this is set to 0.

Definition at line 108 of file clone.hxx.

                                     {
                this->stack = reinterpret_cast<uint64_t>(p_stack);
        }

setTIDs()

void cosmos::CloneArgs::setTIDs ( const ThreadID * tids, size_t num_tids )

inline

Allows to set an explicit thread ID to use for the child.

This instructs the kernel to use a specific thread ID for the new child process. If the process should have multiple specific TIDs in multiple PID namespaces then an array of num_tids can be specified. The first entry defines the TID in the most nested PID namespace and so on.

This requires CAP_CHECKPOINT_RESTORE. The feature is meant for reconstructing a certain system state e.g. from a container snapshot.

Definition at line 124 of file clone.hxx.

                                                            {
                this->set_tid = reinterpret_cast<uint64_t>(tids);
                this->set_tid_size = num_tids;
        }

---

The documentation for this struct was generated from the following files:

• include/proc/clone.hxx
• src/proc/clone.cxx