datamover

Documentation

Overview

Package datamover implements a streaming data mover

Index

• type Builder
  • func MakeBuilder() Builder
  • func (sdmBuilder Builder) Build(name string) *Comp
  • func (sdmBuilder Builder) WithBufferSize(inputBufferSize uint64) Builder
  • func (sdmBuilder Builder) WithEngine(inputEngine sim.Engine) Builder
  • func (sdmBuilder Builder) WithInsideByteGranularity(inputInsideByteGranularity uint64) Builder
  • func (sdmBuilder Builder) WithInsidePortMapper(inputInsidePortMapper mem.AddressToPortMapper) Builder
  • func (sdmBuilder Builder) WithOutsideByteGranularity(inputOutsideByteGranularity uint64) Builder
  • func (sdmBuilder Builder) WithOutsidePortMapper(inputOutsidePortMapper mem.AddressToPortMapper) Builder
• type Comp
  • func (c *Comp) Tick() bool
• type DataMoveRequest
  • func (req *DataMoveRequest) Clone() sim.Msg
  • func (req *DataMoveRequest) GenerateRsp() sim.Msg
  • func (req *DataMoveRequest) Meta() *sim.MsgMeta
• type DataMoveRequestBuilder
  • func MakeDataMoveRequestBuilder() DataMoveRequestBuilder
  • func (b DataMoveRequestBuilder) Build() *DataMoveRequest
  • func (b DataMoveRequestBuilder) WithByteSize(inputByteSize uint64) DataMoveRequestBuilder
  • func (b DataMoveRequestBuilder) WithDst(inputDst sim.RemotePort) DataMoveRequestBuilder
  • func (b DataMoveRequestBuilder) WithDstAddress(inputDstAddress uint64) DataMoveRequestBuilder
  • func (b DataMoveRequestBuilder) WithDstSide(side DateMovePort) DataMoveRequestBuilder
  • func (b DataMoveRequestBuilder) WithSrc(inputSrc sim.RemotePort) DataMoveRequestBuilder
  • func (b DataMoveRequestBuilder) WithSrcAddress(inputSrcAddress uint64) DataMoveRequestBuilder
  • func (b DataMoveRequestBuilder) WithSrcSide(side DateMovePort) DataMoveRequestBuilder
• type DateMovePort

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

A Builder for StreamingDataMover

func MakeBuilder

func MakeBuilder() Builder

MakeBuilder creates a new Builder

func (Builder) Build

func (sdmBuilder Builder) Build(name string) *Comp

Build a new StreamingDataMover

func (Builder) WithBufferSize

func (sdmBuilder Builder) WithBufferSize(
	inputBufferSize uint64,
) Builder

WithBufferSize sets the buffer size of StreamingDataMover

func (Builder) WithEngine

func (sdmBuilder Builder) WithEngine(
	inputEngine sim.Engine,
) Builder

WithEngine sets StreamingDataMover's engine

func (Builder) WithInsideByteGranularity

func (sdmBuilder Builder) WithInsideByteGranularity(
	inputInsideByteGranularity uint64,
) Builder

WithInsideByteGranularity sets the inside byte granularity of StreamingDataMover

func (Builder) WithInsidePortMapper

func (sdmBuilder Builder) WithInsidePortMapper(
	inputInsidePortMapper mem.AddressToPortMapper,
) Builder

WithInsidePortMapper sets the inside port mapper of StreamingDataMover

func (Builder) WithOutsideByteGranularity

func (sdmBuilder Builder) WithOutsideByteGranularity(
	inputOutsideByteGranularity uint64,
) Builder

WithOutsideByteGranularity sets the outside byte granularity of StreamingDataMover

func (Builder) WithOutsidePortMapper

func (sdmBuilder Builder) WithOutsidePortMapper(
	inputOutsidePortMapper mem.AddressToPortMapper,
) Builder

WithOutsidePortMapper sets the outside port mapper of StreamingDataMover

type Comp

type Comp struct {
	*sim.TickingComponent
	// contains filtered or unexported fields
}

Comp helps moving data from designated source and destination following the given move direction

func (*Comp) Tick

func (c *Comp) Tick() bool

Tick ticks

type DataMoveRequest

type DataMoveRequest struct {
	sim.MsgMeta
	SrcAddress uint64
	DstAddress uint64
	ByteSize   uint64
	SrcSide    DateMovePort
	DstSide    DateMovePort
}

A DataMoveRequest asks DataMover to transfer data

func (*DataMoveRequest) Clone

func (req *DataMoveRequest) Clone() sim.Msg

Clone creates a deep copy of the DataMoveRequest with a new ID

func (*DataMoveRequest) GenerateRsp

func (req *DataMoveRequest) GenerateRsp() sim.Msg

GenerateRsp creates a response message for the request.

func (*DataMoveRequest) Meta

func (req *DataMoveRequest) Meta() *sim.MsgMeta

Meta returns the metadata of the message

type DataMoveRequestBuilder

type DataMoveRequestBuilder struct {
	// contains filtered or unexported fields
}

DataMoveRequestBuilder can build new data move requests

func MakeDataMoveRequestBuilder

func MakeDataMoveRequestBuilder() DataMoveRequestBuilder

MakeDataMoveRequestBuilder creates a new DataMoveRequestBuilder

func (DataMoveRequestBuilder) Build

func (b DataMoveRequestBuilder) Build() *DataMoveRequest

Build creates a new DataMoveRequest.

func (DataMoveRequestBuilder) WithByteSize

func (b DataMoveRequestBuilder) WithByteSize(
	inputByteSize uint64,
) DataMoveRequestBuilder

WithByteSize sets the byte size of the data to be moved.

func (DataMoveRequestBuilder) WithDst

func (b DataMoveRequestBuilder) WithDst(
	inputDst sim.RemotePort,
) DataMoveRequestBuilder

WithDst sets the destination port of the message. It should be the CtrlPort of the DataMover.

func (DataMoveRequestBuilder) WithDstAddress

func (b DataMoveRequestBuilder) WithDstAddress(
	inputDstAddress uint64,
) DataMoveRequestBuilder

WithDstAddress sets the destination address of the data to be moved.

func (DataMoveRequestBuilder) WithDstSide

func (b DataMoveRequestBuilder) WithDstSide(
	side DateMovePort,
) DataMoveRequestBuilder

WithDstSide sets the destination side of the data to be moved.

func (DataMoveRequestBuilder) WithSrc

func (b DataMoveRequestBuilder) WithSrc(
	inputSrc sim.RemotePort,
) DataMoveRequestBuilder

WithSrc sets the source port of the message.

func (DataMoveRequestBuilder) WithSrcAddress

func (b DataMoveRequestBuilder) WithSrcAddress(
	inputSrcAddress uint64,
) DataMoveRequestBuilder

WithSrcAddress sets the source address of the data to be moved.

func (DataMoveRequestBuilder) WithSrcSide

func (b DataMoveRequestBuilder) WithSrcSide(
	side DateMovePort,
) DataMoveRequestBuilder

WithSrcSide sets the source side of the data to be moved.

type DateMovePort

type DateMovePort string

DateMovePort is the port name that either serves as a source or destination. It can be either inside or outside.

const (
	InsidePort  DateMovePort = "inside"
	OutsidePort DateMovePort = "outside"
)