The Pedigree Project 0.1
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
IoEvent Class Reference

#include <IoEvent.h>

+ Inheritance diagram for IoEvent:
+ Collaboration diagram for IoEvent:

Public Member Functions

 IoEvent ()
 
 IoEvent (PosixSubsystem *subsystem, File *file)
 
void fire ()
 
PosixSubsystem * getSubsystem ()
 
virtual size_t serialize (uint8_t *pBuffer)
 
virtual size_t getNumber ()
 
- Public Member Functions inherited from Event
 Event (uintptr_t handlerAddress, bool isDeletable, size_t specificNestingLevel=~0UL, HandlerPrivilege handlerPrivilege=HandlerPrivilege::Kernel)
 
virtual bool isDeletable ()
 
uintptr_t getHandlerAddress ()
 
HandlerPrivilege getHandlerPrivilege () const
 
bool isValidHandlerMapping (size_t mappingFlags) const
 
virtual bool isSignalEvent () const
 
virtual bool prefersAlternateUserStack () const
 
virtual bool requiresExactUserReturnState () const
 
virtual UserReturnDelivery deliverAtUserReturn (InterruptState &)
 
virtual UserReturnDelivery deliverAtUserReturn (SyscallState &)
 
virtual bool isDeliverableWhileProcessSuspended () const
 
virtual Event * cloneForDelivery ()
 
size_t getSpecificNestingLevel ()
 
 Event (const Event &other)
 
Event & operator= (const Event &other)
 
size_t pendingCount ()
 
bool tryAcquireRegistration (SendLease &registration)
 
virtual void waitForDeliveries ()
 
void retire ()
 
void beginRetirement (Retirement &retirement)
 

Static Public Member Functions

static bool unserialize (uint8_t *pBuffer, IoEvent &event)
 
- Static Public Member Functions inherited from Event
static uintptr_t getTrampoline ()
 
static uintptr_t getSecondaryTrampoline ()
 
static uintptr_t getHandlerBuffer ()
 
static size_t getHandlerBufferSize ()
 
static uintptr_t getLastHandlerBuffer ()
 
static bool unserialize (uint8_t *pBuffer, Event &event)
 
static size_t getEventType (uint8_t *pBuffer)
 

Private Attributes

PosixSubsystem * m_pSubsystem
 
File * m_pFile
 
IoEvent * m_pRetriggerInstance
 

Additional Inherited Members

- Public Types inherited from Event
enum class  HandlerPrivilege { Kernel , User }
 
enum class  UserReturnDelivery { NotApplicable , Delivered , Failed }
 
- Protected Attributes inherited from Event
uintptr_t m_HandlerAddress
 
HandlerPrivilege m_HandlerPrivilege
 
bool m_bIsDeletable
 
size_t m_NestingLevel
 
uint64_t m_Magic
 
List< Thread * > m_Threads
 
Spinlock m_Lock
 

Detailed Description

Event class for passing to File::monitor.

Definition at line 27 of file IoEvent.h.

Constructor & Destructor Documentation

◆ IoEvent() [1/2]

IoEvent::IoEvent ( )

Pass in a subsystem which is used to forward on the event. This allows the correct event handler in userspace to change without having to re-create the IoEvent.

Definition at line 29 of file IoEvent.cc.

◆ IoEvent() [2/2]

IoEvent::IoEvent ( PosixSubsystem *  subsystem,
File *  file 
)

Definition at line 31 of file IoEvent.cc.

Member Function Documentation

◆ fire()

void IoEvent::fire ( )

Definition at line 39 of file IoEvent.cc.

◆ getNumber()

virtual size_t IoEvent::getNumber ( )
inlinevirtual

Returns the event number / ID.

Implements Event.

Definition at line 48 of file IoEvent.h.

◆ getSubsystem()

PosixSubsystem * IoEvent::getSubsystem ( )
inline

Definition at line 39 of file IoEvent.h.

◆ serialize()

size_t IoEvent::serialize ( uint8_t *  pBuffer)
virtual

Given a buffer EVENT_LIMIT bytes long, take the variables present in this object and convert them to a binary form.

It can be assumed that this function will only be called when the Event is about to be dispatched, and so the inhibited mask of the current Thread is available to be changed to what the event handler requires. This change will be undone when the handler completes.

Parameters
pBufferThe buffer to serialize to.
Returns
The number of bytes serialized.

Implements Event.

Definition at line 53 of file IoEvent.cc.

◆ unserialize()

bool IoEvent::unserialize ( uint8_t *  pBuffer,
IoEvent &  event 
)
static

Definition at line 64 of file IoEvent.cc.

Member Data Documentation

◆ m_pFile

File* IoEvent::m_pFile
private

Definition at line 54 of file IoEvent.h.

◆ m_pRetriggerInstance

IoEvent* IoEvent::m_pRetriggerInstance
private

Definition at line 55 of file IoEvent.h.

◆ m_pSubsystem

PosixSubsystem* IoEvent::m_pSubsystem
private

Definition at line 53 of file IoEvent.h.


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