The Fiber API.

These methods relate to the Fiber interface. More...

Functions
virtual	Fiber::~Fiber ()
void	Fiber::run ()
	Start executing the fiber represented by this object. More...
bool	Fiber::finished () const
	Returns whether the "main" function of this fiber has finished. More...
bool	Fiber::started () const
	Returns whether the "main" function of this fiber has started. More...
static Fiber *	Fiber::currentFiber ()
	Get a pointer to the current running Fiber. More...
static Fiber *	Fiber::primaryFiber ()
	Get a pointer to the primary Fiber. More...

Variables
const static size_t	Fiber::DefaultStackSize = 0x50000
	Fiber::Fiber (size_t stack_size=DefaultStackSize)
	Fiber::Fiber (Fiber *link, size_t stack_size=DefaultStackSize)

Detailed Description

These methods relate to the Fiber interface.

Function Documentation

currentFiber()

Fiber * Fiber::currentFiber ( )

static

Get a pointer to the current running Fiber.

Definition at line 181 of file fiber.cc.

Referenced by m5::Coroutine< Arg, Ret >::call().

Fiber() [1/2]

Fiber::Fiber	(	Fiber *	link,
		size_t	stack_size = DefaultStackSize
	)

Definition at line 87 of file fiber.cc.

References fatal, Fiber::guardPage, Fiber::guardPageSize, and Fiber::stack.

Fiber() [2/2]

Fiber::Fiber

(

size_t

stack_size = DefaultStackSize

)

Parameters

Link	points to another fiber which will start executing when this fiber's main function returns.
stack_size	is the size of the stack available to this fiber.

Definition at line 84 of file fiber.cc.

Referenced by TEST().

finished()

bool Fiber::finished ( ) const

inline

Returns whether the "main" function of this fiber has finished.

Definition at line 100 of file fiber.hh.

References Fiber::_finished.

Referenced by sc_gem5::Kernel::init(), m5::Coroutine< Arg, Ret >::operator bool(), sc_gem5::Scheduler::pause(), sc_gem5::Kernel::regStats(), sc_gem5::Kernel::startup(), sc_gem5::Scheduler::stop(), TEST(), and sc_gem5::Scheduler::throwUp().

primaryFiber()

Fiber * Fiber::primaryFiber ( )

static

Get a pointer to the primary Fiber.

This Fiber represents the thread of execution started by the OS, and which has a Fiber attached to it after the fact.

Definition at line 182 of file fiber.cc.

Referenced by sc_gem5::Process::fiber(), sc_gem5::Scheduler::start(), TEST(), and sc_gem5::Scheduler::yield().

run()

void Fiber::run

(

)

Start executing the fiber represented by this object.

This function will "return" when the current fiber is switched back to later on.

Definition at line 163 of file fiber.cc.

References Fiber::_finished, Fiber::_started, Fiber::createContext(), Fiber::ctx, and panic_if.

Referenced by m5::Coroutine< Arg, Ret >::call(), m5::Coroutine< Arg, Ret >::CallerType::get(), m5::Coroutine< Arg, Ret >::CallerType::operator()(), sc_gem5::Scheduler::pause(), Fiber::start(), sc_gem5::Scheduler::start(), sc_gem5::Scheduler::stop(), TEST(), sc_gem5::Scheduler::throwUp(), and sc_gem5::Scheduler::yield().

started()

bool Fiber::started ( ) const

inline

Returns whether the "main" function of this fiber has started.

Definition at line 107 of file fiber.hh.

References Fiber::_started.

Referenced by TEST().

~Fiber()

Fiber::~Fiber ( )

virtual

Definition at line 111 of file fiber.cc.

References Fiber::guardPage, Fiber::guardPageSize, panic_if, Fiber::stack, and Fiber::stackSize.

Variable Documentation

DefaultStackSize

const static size_t Fiber::DefaultStackSize = 0x50000

static

Definition at line 68 of file fiber.hh.