cosmos::signal::Stack Class Reference

Data structure used for defining an alternate signal stack. More...

#include <signal.hxx>

Public Types
enum class	Flag : int { ON_STACK = SS_ONSTACK , DISABLE = SS_DISABLE , AUTO_DISARM = 1 << 31 }
	Settings for alternate stack setup. More...
using	Flags = BitMask<Flag>

Public Member Functions
	Stack (const no_init_t)
	Leaves underlying data uninitialized.
void	setFlags (const Flags flags)
Flags	getFlags () const
void	setBase (void *base)
	Sets the base pointer for the alternate signal stack.
void *	getBase () const
void	setSize (const size_t size)
	Sets the size of the alternate signal stack found at getBase().
size_t	getSize () const
void	clear ()
auto	raw ()
auto	raw () const

Static Public Attributes
static size_t	MIN_SIZE = MINSIGSTKSZ
	Minimum size an alternate signal stack needs to have.

Protected Attributes
stack_t	m_raw

Detailed Description

Data structure used for defining an alternate signal stack.

Definition at line 314 of file signal.hxx.

Member Typedef Documentation

Flags

using cosmos::signal::Stack::Flags = BitMask<Flag>

Definition at line 325 of file signal.hxx.

Member Enumeration Documentation

Flag

enum class cosmos::signal::Stack::Flag : int

strong

Settings for alternate stack setup.

Enumerator
ON_STACK	the thread is currently executing on the alternate signal stack (output flag only).
DISABLE	the alternate signal stack is currently disabled (output flag only).
AUTO_DISARM	clear the alternate signal stack settings on entry to the signal handler.

Definition at line 318 of file signal.hxx.

                        : int {
                ON_STACK    = SS_ONSTACK, 
                DISABLE     = SS_DISABLE, 
                /* SS_AUTODISARM not yet in userspace headers? */
                AUTO_DISARM = 1 << 31,    
        };

Constructor & Destructor Documentation

Stack() [1/2]

cosmos::signal::Stack::Stack ( )

inline

Definition at line 332 of file signal.hxx.

                {
                clear();
        }

Stack() [2/2]

cosmos::signal::Stack::Stack ( const no_init_t )

inline

Leaves underlying data uninitialized.

Definition at line 337 of file signal.hxx.

{}

Member Function Documentation

clear()

void cosmos::signal::Stack::clear ( )

inline

Definition at line 365 of file signal.hxx.

                     {
                zero_object(m_raw);
        }

getBase()

void * cosmos::signal::Stack::getBase ( ) const

inline

Definition at line 352 of file signal.hxx.

                              {
                return m_raw.ss_sp;
        }

getFlags()

Flags cosmos::signal::Stack::getFlags ( ) const

inline

Definition at line 343 of file signal.hxx.

                               {
                return Flags{m_raw.ss_flags};
        }

getSize()

size_t cosmos::signal::Stack::getSize ( ) const

inline

Definition at line 361 of file signal.hxx.

                               {
                return m_raw.ss_size;
        }

raw() [1/2]

auto cosmos::signal::Stack::raw ( )

inline

Definition at line 369 of file signal.hxx.

                   {
                return &m_raw;
        }

raw() [2/2]

auto cosmos::signal::Stack::raw ( ) const

inline

Definition at line 373 of file signal.hxx.

                         {
                return &m_raw;
        }

setBase()

void cosmos::signal::Stack::setBase ( void * base )

inline

Sets the base pointer for the alternate signal stack.

Definition at line 348 of file signal.hxx.

                                 {
                m_raw.ss_sp = base;
        }

setFlags()

void cosmos::signal::Stack::setFlags ( const Flags flags )

inline

Definition at line 339 of file signal.hxx.

                                         {
                m_raw.ss_flags = flags.raw();
        }

setSize()

void cosmos::signal::Stack::setSize ( const size_t size )

inline

Sets the size of the alternate signal stack found at getBase().

Definition at line 357 of file signal.hxx.

                                        {
                m_raw.ss_size = size;
        }

Member Data Documentation

m_raw

stack_t cosmos::signal::Stack::m_raw

protected

Definition at line 379 of file signal.hxx.

MIN_SIZE

size_t cosmos::signal::Stack::MIN_SIZE = MINSIGSTKSZ

static

Minimum size an alternate signal stack needs to have.

Definition at line 328 of file signal.hxx.

---

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

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