ClassDiagram.md

Class Diagram

@startuml interface IHardware { +{abstract} Reset() -> Status +{abstract} GetDataMover(address = 0) -> IDataMover * +{abstract} GetAccelerator(address: uint64) -> IAccelerator * +{virtual} GetExecutionStream(name: string, impl: IExecutionStreamType, config: ExecutionGraphParameters) -> IExecutionGraph * +{virtual} GetClocks() -> float[] +{virtual} SetClocks(clocks: float[]) -> Status +{static} Create(hw: HardwareArchitecture, bitstream: string, xclbin: string) -> IHardware* +{static} Create(hw: HardwareArchitecture, config: string) -> IHardware* }

interface IExecutionGraph { +{abstract} Add(func: std::function<void()>, deps: NodeID[] = {}) -> NodeID +{abstract} Sync(node: NodeID = last) -> Status +{abstract} GetLastError() -> Status +{static} Create(impl: IExecutionStreamType, config: ExecutionGraphParameters) -> IExecutionStream* }

struct IExecutionGraph::Node { id: NodeID, func: std::function<void()> deps: NodeID[] parents: pointer [] children: pointer [] }

struct ExecutionGraphParameters { name: Stream }

interface IMemory { {abstract} #GetHostAddress() -> uint8_t * {abstract} #GetDeviceAddress() -> uint8_t * +HostAddress() -> T * +DeviceAddress() -> T * {abstract} Sync(type: SyncType) -> Status {abstract} Size() -> size_t +{static} Create(impl: IMemoryType, size, hostptr, devptr) -> IMemory* }

enum IMemoryType { XRT CMA ALIGNED }

IMemoryType ..o IMemory

interface IAccelerator { {abstract} Start(mode: StartMode) -> Status {abstract} Stop() -> Status {abstract} Sync() -> Status {abstract} #WriteRegister(address, data: uint8_t*, size: size_t) -> Status {abstract} #ReadRegister(address, data: uint8_t*, size: size_t) -> Status +Write(address, data: T*, elems: size_t) -> Status +Read(address, data: T*, elems: size_t) -> Status +Attach(address, data: T*, elems: size_t) -> Status +Attach(address, mem: std::shared_ptr, elems: size_t) -> Status {abstract} GetStatus() -> DeviceStatus +{static} Create(impl: IAcceleratorType, addr: uint64) -> IAccelerator* +{static} Create(impl: IAcceleratorType, addr: string) -> IAccelerator* }

enum IAcceleratorType { XRT MMIO CHAR } IAcceleratorType ..o IAccelerator

interface IDataMover { {abstract} GetBuffer(size: size_t, type: MemoryType) -> IMemory * {abstract} Upload(mem: IMemory, size: size_t, exetype: ExecutionType) -> Status {abstract} Download(mem: IMemory, size: size_t, exetype: ExecutionType) -> Status {abstract} Sync() -> Status {abstract} GetStatus() -> DeviceStatus +{static} Create(impl: IDataMoverType, addr: uint64) -> IDataMover* }

enum IDataMoverType { XRT DMA XDMA } IDataMoverType ..o IDataMover

enum HardwareArchitecture { UltraScale Zynq XDMA Alveo }

HardwareArchitecture ..o IHardware

enum SyncType { HostToDevice, DeviceToHost, }

enum StartMode { Once, Continuous }

enum MemoryType { Dual, Cacheable, Host, Device }

enum DeviceStatus { Unknown, Done, Idle, Running, Error }

enum ExecutionType { Sync, Async }

enum DataMoverType { Stream, MemoryMapped }

class UltraScale { +Reset() -> Status +GetDataMover(address, type : DataMoverType) -> DMADataMover * +GetAccelerator(address: uint64) -> MMIOAccelerator * +{virtual} GetClocks() -> float[] +{virtual} SetClocks(clocks: float[]) -> Status +UltraScale(hw, bitsteam, xclbin) }

class Alveo { +Reset() -> Status +GetDataMover(address, type : DataMoverType) -> XRTtDataMover * +GetAccelerator(address: string) -> XRTAccelerator * +UltraScale(hw, bitsteam, xclbin) }

class XRTMemory { #GetHostAddress() -> uint8_t * #GetDeviceAddress() -> uint8_t * Sync(type: SyncType) -> Status Size() -> size_t +XRTMemory(hostptr, devptr) }

class MMIOAccelerator { Start(mode: StartMode) -> Status Stop() -> Status Sync() -> Status GetStatus() -> DeviceStatus #WriteRegister(address, data: uint8_t*, size: size_t) -> Status #ReadRegister(address, data: uint8_t*, size: size_t) -> Status +MMIOAccelerator(addr: uint64) }

class XRTAccelerator { Start(mode: StartMode) -> Status Stop() -> Status Sync() -> Status GetStatus() -> DeviceStatus #SetArgument(position, data: T*) -> Status +XRTAccelerator(name: string) }

class DMADataMover { GetBuffer(size: size_t, type: MemoryType) -> XRTMemory * Upload(mem: IMemory, size: size_t, exetype: ExecutionType) -> Status Download(mem: IMemory, size: size_t, exetype: ExecutionType) -> Status Sync() -> Status GetStatus() -> DeviceStatus DMADataMover(addr) }

class XRTDataMover { GetBuffer(size: size_t, type: MemoryType) -> XRTMemory * Upload(mem: IMemory, size: size_t, exetype: ExecutionType) -> Status Download(mem: IMemory, size: size_t, exetype: ExecutionType) -> Status Sync() -> Status GetStatus() -> DeviceStatus XrtDataMover(mem_bank) }

class ExecutionStream { +Add(func: std::function<void()>, deps: NodeID[] = {}) -> NodeID +Sync(node: NodeID = last) -> Status +GetLastError() -> Status }

ExecutionStream ..> IExecutionGraph UltraScale ..> IHardware Alveo ..> IHardware XRTMemory ..> IMemory MMIOAccelerator ..> IAccelerator XRTAccelerator ..> IAccelerator DMADataMover ..> IDataMover XRTDataMover ..> IDataMover @enduml