dxd - dynax driver framework 3.0.2
cross platform open source driver development framework
Loading...
Searching...
No Matches
dxd::stream Class Referenceabstract

generic kernel stream More...

#include <dxd_stream.h>

Inheritance diagram for dxd::stream:
Collaboration diagram for dxd::stream:

Classes

class  mappings
 a client's mappings of the rings it opened, each by the id its memory type carries More...
struct  opened
 generic streaming interface description More...
class  umap
 stream user mapping More...

Public Types

enum  direction
 direction of memory operation More...
enum  direction
 direction of memory operation More...

Public Member Functions

bool claim(dx::stream::direction::direction directiondirection)
 taken while there is none
::IOMemoryDescriptor* copy()
 the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on
::IOMemoryDescriptor* copy()
 the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on
void free()
void free()
 DriverKit map free.
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor)
 DriverKit memory initializer.
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor)
 DriverKit memory initializer.
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, directiondirection directiondirection)
 DriverKit memory initializer.
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, directiondirection directiondirection)
 DriverKit memory initializer.
os_result initialize(const ::MDL* mdl)
os_result initialize(const ::MDL* mdl)
os_result initialize(const ::MDL* mdl, size_t offset, size_t size)
 a part of a locked MDL's pages, whatever allocated them: a partial MDL, its system mapping IoFreeMdl()'s
os_result initialize(const ::MDL* mdl, size_t offset, size_t size)
 a part of a locked MDL's pages, whatever allocated them: a partial MDL, its system mapping IoFreeMdl()'s
os_result initialize(const void* data, size_t size)
os_result initialize(const void* data, size_t size)
os_result initialize(size_t size, unsigned int limit= 64)
os_result initialize(size_t size, unsigned int= 64)
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset= 0, size_t size= 0, uint64_t alignment= 0, void* address= {})
 DriverKit map initializer.
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, directiondirection directiondirection)
 DriverKit memory initializer.
os_result initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, directiondirection directiondirection)
 DriverKit memory initializer.
 operator const ::IOMemoryDescriptor*() const
 DriverKit IOMemoryDescriptor* implicit cast.
 operator const ::IOMemoryDescriptor*() const
 DriverKit IOMemoryDescriptor* implicit cast.
 operator const ::IOMemoryMap*() const
 operator const dx::circular*() const
 operator dx::circular*() const
 operator void*() const
 the allocation's kernel address
const dx::circular* operator ->() const
 operator to use mapping like pointer
 operator ::IOMemoryDescriptor*()
 operator ::IOMemoryDescriptor*()
 operator ::IOMemoryMap*()
 operator ::MDL*() const
 operator ::MDL*() const
void pop(abstract::event& event)
 a participant's event leaves: no tick signals it once this returns
void push(abstract::event& event)
 a participant's event joins the ring's signal
template<typename reference_t>
int release(reference_t& reference)
void retain()
void signal()
uint64_t size() const
 DriverKit memory size.
uint64_t size() const
 DriverKit memory size.
size_t size() const
 DriverKit mapping size.
virtual os_result start(bool force= false)= 0
virtual os_result stop(bool force= false)= 0
 stream(size_t size, unsigned int limit= 64)

Public Attributes

atomic<int> references{}
os_result status
 DriverKit memory status.
os_result status
 DriverKit memory status.
os_result status
 status of mapping object
volatile int64_t transport{dx::stream::direction::none}
spinlock writer
 the ring's client writers one at a time: a stream's pins write one ring, each on its own port

Protected Member Functions

 stream()= default
virtual ~stream()= default

Protected Attributes

dx::circular* _vm
 DriverKit virtual address mapping.
::IOMemoryMap* io_memory_map
::MDL* mdl
::MDL* mdl

Detailed Description

generic kernel stream

Member Enumeration Documentation

◆ direction [1/2]

enum dxd::memory::direction : uint64_t
inherited

direction of memory operation

◆ direction [2/2]

enum dxd::memory::direction : uint64_t
inherited

direction of memory operation

Constructor & Destructor Documentation

◆ ~stream()

virtual dxd::stream::~stream()
protectedvirtualdefault

◆ stream() [1/2]

dxd::stream::stream()
protecteddefault
Here is the caller graph for this function:

◆ stream() [2/2]

dxd::stream::stream(size_t size, unsigned int limit= 64)
inline
Here is the call graph for this function:

Member Function Documentation

◆ claim()

bool dxd::stream::claim(dx::stream::direction::direction direction)
inline

taken while there is none

Here is the call graph for this function:

◆ copy() [1/2]

::IOMemoryDescriptor* dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::copy()
inlineinherited

the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on

◆ copy() [2/2]

::IOMemoryDescriptor* dxd::memory<scope_t, io_memory_descriptor_t>::copy()
inlineinherited

the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on

◆ free() [1/2]

void dxd::buffer<scope_t, 64>::free()
inlineinherited
Here is the caller graph for this function:

◆ free() [2/2]

void dxd::map<scope_t, dx::circular>::free()
inlineinherited

DriverKit map free.

Checks if DriverKit mapping already exists and

does not call unmap(): IOMemoryMap instances will unmap themselves upon free, ie. when the last client with a reference calls release. unmap() forces the IOMemoryMap to destroy the mapping it represents, regardless of the number of clients. releases the map object.

◆ initialize() [1/15]

os_result dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::initialize(::IOMemoryDescriptor* io_memory_descriptor)
inlineinherited

DriverKit memory initializer.

◆ initialize() [2/15]

os_result dxd::memory<scope_t, io_memory_descriptor_t>::initialize(::IOMemoryDescriptor* io_memory_descriptor)
inlineinherited

DriverKit memory initializer.

◆ initialize() [3/15]

os_result dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, direction direction)
inlineinherited

DriverKit memory initializer.

◆ initialize() [4/15]

os_result dxd::memory<scope_t, io_memory_descriptor_t>::initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, direction direction)
inlineinherited

DriverKit memory initializer.

◆ initialize() [5/15]

os_result dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::initialize(const ::MDL* mdl)
inlineinherited

in contrast to an IOKit MemoryDescriptor MDLs do not support reference counting. take care when creating a dxd::memory from a dxd::buffer: although the dxd::memory holds an MDL to the buffer the buffer itself is not retained after the dxd::buffer is released!

◆ initialize() [6/15]

os_result dxd::memory<scope_t, io_memory_descriptor_t>::initialize(const ::MDL* mdl)
inlineinherited

in contrast to an IOKit MemoryDescriptor MDLs do not support reference counting. take care when creating a dxd::memory from a dxd::buffer: although the dxd::memory holds an MDL to the buffer the buffer itself is not retained after the dxd::buffer is released!

◆ initialize() [7/15]

os_result dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::initialize(const ::MDL* mdl, size_t offset, size_t size)
inlineinherited

a part of a locked MDL's pages, whatever allocated them: a partial MDL, its system mapping IoFreeMdl()'s

◆ initialize() [8/15]

os_result dxd::memory<scope_t, io_memory_descriptor_t>::initialize(const ::MDL* mdl, size_t offset, size_t size)
inlineinherited

a part of a locked MDL's pages, whatever allocated them: a partial MDL, its system mapping IoFreeMdl()'s

◆ initialize() [9/15]

os_result dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::initialize(const void* data, size_t size)
inherited

◆ initialize() [10/15]

os_result dxd::memory<scope_t, io_memory_descriptor_t>::initialize(const void* data, size_t size)
inherited

◆ initialize() [11/15]

os_result dxd::buffer<scope_t, 64>::initialize(size_t size, unsigned int limit= limit_t)
inlineinherited
Here is the call graph for this function:

◆ initialize() [12/15]

os_result dxd::buffer<scope_t, 64>::initialize(size_t size, unsigned int= limit_t)
inlineinherited
Here is the call graph for this function:
Here is the caller graph for this function:

◆ initialize() [13/15]

os_result dxd::map<scope_t, dx::circular>::initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset= 0, size_t size= 0, uint64_t alignment= 0, void* address= {})
inlineinherited

DriverKit map initializer.

map<kernel> maps an IOMemoryDescriptor (typically cast of a dxd::memory or buffer class) into the DriverKit address space.

            kIOMemoryMapFixedAddress map at the address requested
            kIOMemoryMapReadOnly create a read only mapping
            kIOMemoryMapCacheModeDefault default cache mode
            kIOMemoryMapCacheModeInhibit inhibited cache mode
            kIOMemoryMapCacheModeCopyback copyback cache mode
            kIOMemoryMapCacheModeWriteThrough write through cache mode

Allows re-initialization.

Checks buffer object,

maps the buffer into the DriverKit (will fail if offset is given)

and obtains a DriverKit virtual address (apply offset here instead).

Parameters
io_memory_descriptorIOMemoryDescriptor to be mapped into the DriverKit address space
offsetoffset into memory descriptor to create mapping
sizesize of mapping

◆ initialize() [14/15]

template<dx::scope scope_t= dx::kernel, typename io_memory_descriptor_t= ::IOMemoryDescriptor>
os_result dxd::memory<scope_t, io_memory_descriptor_t>::initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, direction direction)
inlineinherited

DriverKit memory initializer.

◆ initialize() [15/15]

os_result dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::initialize(::IOMemoryDescriptor* io_memory_descriptor, size_t offset, size_t size, direction direction)
inlineinherited

DriverKit memory initializer.

Here is the call graph for this function:

◆ operator const ::IOMemoryDescriptor *() [1/2]

dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::operator const ::IOMemoryDescriptor*() const
inlineinherited

DriverKit IOMemoryDescriptor* implicit cast.

◆ operator const ::IOMemoryDescriptor *() [2/2]

dxd::memory<scope_t, io_memory_descriptor_t>::operator const ::IOMemoryDescriptor*() const
inlineinherited

DriverKit IOMemoryDescriptor* implicit cast.

◆ operator const ::IOMemoryMap *()

dxd::map<scope_t, dx::circular>::operator const ::IOMemoryMap*() const
inlineinherited

◆ operator const dx::circular *()

dxd::map<scope_t, dx::circular>::operator const dx::circular*() const
inlineinherited

◆ operator dx::circular *()

dxd::map<scope_t, dx::circular>::operator dx::circular*() const
inlineinherited

◆ operator void *()

dxd::buffer<scope_t, 64>::operator void*() const
inlineinherited

the allocation's kernel address

◆ operator ->()

const dx::circular* dxd::map<scope_t, dx::circular>::operator ->() const
inlineinherited

operator to use mapping like pointer

◆ operator ::IOMemoryDescriptor *() [1/2]

dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::operator ::IOMemoryDescriptor*()
inlineinherited

◆ operator ::IOMemoryDescriptor *() [2/2]

dxd::memory<scope_t, io_memory_descriptor_t>::operator ::IOMemoryDescriptor*()
inlineinherited

◆ operator ::IOMemoryMap *()

dxd::map<scope_t, dx::circular>::operator ::IOMemoryMap*()
inlineinherited

◆ operator ::MDL *() [1/2]

dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::operator ::MDL*() const
inlineinherited

◆ operator ::MDL *() [2/2]

dxd::memory<scope_t, io_memory_descriptor_t>::operator ::MDL*() const
inlineinherited

◆ pop()

void dxd::stream::pop(abstract::event& event)
inline

a participant's event leaves: no tick signals it once this returns

◆ push()

void dxd::stream::push(abstract::event& event)
inline

a participant's event joins the ring's signal

◆ release()

template<typename reference_t>
int dxd::referenced::release(reference_t& reference)
inlineinherited
Here is the caller graph for this function:

◆ retain()

void dxd::referenced::retain()
inlineinherited
Here is the caller graph for this function:

◆ signal()

void dxd::stream::signal()
inline

◆ size() [1/3]

uint64_t dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::size() const
inlineinherited

DriverKit memory size.

Here is the caller graph for this function:

◆ size() [2/3]

uint64_t dxd::memory<scope_t, io_memory_descriptor_t>::size() const
inlineinherited

DriverKit memory size.

◆ size() [3/3]

size_t dxd::map<scope_t, dx::circular>::size() const
inlineinherited

DriverKit mapping size.

Here is the caller graph for this function:

◆ start()

virtual os_result dxd::stream::start(bool force= false)
pure virtual

◆ stop()

virtual os_result dxd::stream::stop(bool force= false)
pure virtual

Member Data Documentation

◆ _vm

dx::circular* dxd::map<scope_t, dx::circular>::_vm
protectedinherited

DriverKit virtual address mapping.

◆ io_memory_map

::IOMemoryMap* dxd::map<scope_t, dx::circular>::io_memory_map
protectedinherited

◆ mdl [1/2]

::MDL* dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::mdl
protectedinherited

◆ mdl [2/2]

::MDL* dxd::memory<scope_t, io_memory_descriptor_t>::mdl
protectedinherited

◆ references

atomic<int> dxd::referenced::references{}
inherited

◆ status [1/3]

os_result dxd::memory<scope_t, ::IOBufferMemoryDescriptor>::status
inherited

DriverKit memory status.

status of memory object

◆ status [2/3]

os_result dxd::memory<scope_t, io_memory_descriptor_t>::status
inherited

DriverKit memory status.

status of memory object

◆ status [3/3]

os_result dxd::map<scope_t, dx::circular>::status
inherited

status of mapping object

◆ transport

volatile int64_t dxd::stream::transport{dx::stream::direction::none}

the ring's one transport, of its stream's direction: the kernel's participants meet here, its holder and the host's session start set it none

◆ writer

spinlock dxd::stream::writer

the ring's client writers one at a time: a stream's pins write one ring, each on its own port


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