|
dxd - dynax driver framework 3.0.2
cross platform open source driver development framework
|
generic kernel stream More...
#include <dxd_stream.h>
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 |
generic kernel stream
|
inherited |
direction of memory operation
|
inherited |
direction of memory operation
|
protectedvirtualdefault |
Reimplemented in dxd::multichannel::stream< channel_t >.
|
protecteddefault |
|
inline |
|
inline |
taken while there is none
|
inlineinherited |
the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on
|
inlineinherited |
the descriptor with a reference for the caller, as IOUserClient::CopyClientMemoryForType hands it on
|
inlineinherited |
|
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.
|
inlineinherited |
DriverKit memory initializer.
|
inlineinherited |
DriverKit memory initializer.
|
inlineinherited |
DriverKit memory initializer.
|
inlineinherited |
DriverKit memory initializer.
|
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!
|
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!
|
inlineinherited |
a part of a locked MDL's pages, whatever allocated them: a partial MDL, its system mapping IoFreeMdl()'s
|
inlineinherited |
a part of a locked MDL's pages, whatever allocated them: a partial MDL, its system mapping IoFreeMdl()'s
|
inherited |
|
inherited |
|
inlineinherited |
|
inlineinherited |
|
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).
| io_memory_descriptor | IOMemoryDescriptor to be mapped into the DriverKit address space |
| offset | offset into memory descriptor to create mapping |
| size | size of mapping |
|
inlineinherited |
DriverKit memory initializer.
|
inlineinherited |
DriverKit memory initializer.
|
inlineinherited |
DriverKit IOMemoryDescriptor* implicit cast.
|
inlineinherited |
DriverKit IOMemoryDescriptor* implicit cast.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
the allocation's kernel address
|
inlineinherited |
operator to use mapping like pointer
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inline |
a participant's event leaves: no tick signals it once this returns
|
inline |
a participant's event joins the ring's signal
|
inlineinherited |
|
inlineinherited |
|
inline |
|
inlineinherited |
DriverKit memory size.
|
inlineinherited |
DriverKit memory size.
|
inlineinherited |
DriverKit mapping size.
|
pure virtual |
|
pure virtual |
|
protectedinherited |
DriverKit virtual address mapping.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
|
inherited |
DriverKit memory status.
status of memory object
|
inherited |
DriverKit memory status.
status of memory object
|
inherited |
status of mapping object
| 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
| 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