SharedRegion_Entry Struct Reference

Structure defining a region. More...

#include <SharedRegion.h>

Data Fields
Ptr	base
SizeT	len
UInt16	ownerProcId
Bool	isValid
Bool	cacheEnable
SizeT	cacheLineSize
Bool	createHeap
String	name

Detailed Description

Structure defining a region.

Field Documentation

Ptr SharedRegion_Entry::base

The base address of the region

SizeT SharedRegion_Entry::len

The length of the region

Ths length of a region must be the same across all processors in the system.

UInt16 SharedRegion_Entry::ownerProcId

The MultiProc id of the owner of the region

The owner id for a shared region must be the same across all processors in the system.

Bool SharedRegion_Entry::isValid

Whether the region is valid

Bool SharedRegion_Entry::cacheEnable

Whether to perform cache operations for the region

If 'TRUE', a cache invalidate is performed before any read and a cache write back invalidate is performed after any write for the shared region. The cache operations are done for all caches. If 'FALSE', no cache operations are performed.

SizeT SharedRegion_Entry::cacheLineSize

The cache line size of the region

The cache line size for a region must be the same across all processors in the system. It is used for structure alignment and padding.

Bool SharedRegion_Entry::createHeap

Whether a heap is created for the region

If 'TRUE', a HeapMemMP instance is created with the size spanning the length of the shared region minus any memory that is reserved in the region. If 'FALSE', no heap is created in the shared region.

String SharedRegion_Entry::name

The name of the region.

The name must be in persistent memory. It is used for displaying in ROV.

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

SharedRegion.h

SharedRegion_Entry Struct Reference