![]() |
![]() |
![]() |
> Module > SharedDataRegions |
Module
The SharedData element defines the name of an shared data region and includes a SharedDataDescription document that defines the configuration of a shared data region or a SharedIODescription document that defines the configuration of a shared I/O region.
You include the SharedDataDescription or SharedIODescription using an xi:include statement.
<SharedDataRegions> <SharedData Name="my-sdr"> <xi:include href="my-SharedDataDescription.xml"/> </SharedData> <SharedData Name="my-sior"> <xi:include href="my-SharedIODescription.xml"/> </SharedData> ... </SharedDataRegions>
You can also include the SharedDataDescription or SharedIODescription inline:
<SharedDataRegions> <SharedData Name="my-sdr"> <SharedDataDescription> ... </SharedDataDescription> ... </SharedData> <SharedData Name="my-sior"> <SharedIODescription> ... </SharedIODescription> ... </SharedData> ... </SharedDataRegions>
Notice that while the configuration of the shared data region or shared I/O region is included from a SharedDataDescription or SharedIODescription document, the name of the shared region must be supplied in the attribute of the SharedData element itself. This allows you to include the same shared region description in different systems, giving the shared region a different name in each.
Optional, unbounded
None
The name of the shared data region. The shared data region name is used in /PartitionDescription/SharedDataRegion/@NameRef of a PartitionDescription document to give a partition access to a shared data region. You can also use this name in application code to refer to a shared data region using the appropriate APIs.
Applications and the core OS will access the shared data region using its name with the appropriate APIs, or by using its memory pool name, which is its name followed by the string “Pool”. System integrators, platform providers, and application developers must communicate to ensure that the names of all relevant shared data regions are agreed on and used consistently.
Required
ConfigRecord
String
N/A
None
The name of the shared data region must be unique within the module.
The maximum length is 27 characters. (The configuration record allots 32 characters for the shared data region pool name. Four characters for “Pool”, plus one character for the terminating null, leaves 27 characters for the shared data region name.)
For a shared I/O region, this attribute must match the value of a shared I/O pool name as specified in /ConfigRecord/Module/CoreOS/CoreOSDescription/HardwareConfiguration/sharedIO/@PoolName.
The name of the shared data region must not be an empty string.
Generated on 2007-10-15 17:17:22.