javax.realtime.memory

Class PhysicalMemoryFactory

java.lang.Object

javax.realtime.memory.PhysicalMemoryFactory

public class PhysicalMemoryFactory
extends java.lang.Object

A physical memory representation of memory ranges, in the form of PhysicalMemoryRegion instances with physical memory characteristics in the form of PhysicalMemoryCharacteristic instances for creating memory areas in those ranges.

Each physical memory module can have one or more physical memory characteristic. A physical memory characteristic can apply to many physical memory modules. The range of physical addresses of modules shall not overlap. A memory that spans more than one physical memory module may not be created.

The PhysicalMemoryFactory determines the physical addresses from the modules and keeps a relation between instances of PhysicalMemoryRegion and Physical Memory Addresses. The range of physical addresses of modules shall not overlap. A created memory area may not span more than one physical memory module. To find a memory range that supports PMC A and PMC B, it uses set intersection modules(A) ∩ modules(B)

Since:

RTSJ 2.0

Constructor Summary

Constructors

Constructor and Description
PhysicalMemoryFactory() Creates an empty factory, but when only one factory is required, uses getDefault() instead.

Method Summary

Modifier and Type	Method and Description
void	associate(PhysicalMemoryCharacteristic[] names, PhysicalMemoryRegion module) Associates an array of programmer-defined names with a physical address range.
void	associate(PhysicalMemoryCharacteristic name, PhysicalMemoryRegion module) Associates a programmer-defined name with a physical address range.
static void	associate(PhysicalMemoryCharacteristic name, PhysicalMemoryRegion[] modules) Associates a programmer-defined name with an array of physical address ranges.
ImmortalMemory	createImmortalMemory(PhysicalMemorySelector selector, long size, java.lang.Runnable logic) Instantiates a ImmortalMemory object in a PhysicalMemoryRegion, where the memory type matches the PhysicalMemoryCharacteristic instances in selector and the virtual memory parameters of selector are applied.
PinnableMemory	createLTMemory(PhysicalMemorySelector selector, long size, java.lang.Runnable logic) Instantiates a LTMemory object in a PhysicalMemoryRegion, matching the PhysicalMemoryCharacteristic in selector with virtual memory parameters of selector applied.
PinnableMemory	createPinnableMemory(PhysicalMemorySelector selector, long size, java.lang.Runnable logic) Instantiates a PinnableMemory object in a PhysicalMemoryRegion, matching the PhysicalMemoryCharacteristic in selector with virtual memory parameters of selector applied.
StackedMemory	createStackedMemory(PhysicalMemorySelector selector, long scopeSize, long backingSize, java.lang.Runnable logic) Instantiates a StackedMemory object in a PhysicalMemoryRegion, matching the PhysicalMemoryCharacteristic in selector with virtual memory parameters of selector applied.
static PhysicalMemoryFactory	getDefault() Obtains the default physical memory factory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PhysicalMemoryFactory

public PhysicalMemoryFactory()

Creates an empty factory, but when only one factory is required, uses getDefault() instead.

Method Detail

getDefault

public static PhysicalMemoryFactory getDefault()

Obtains the default physical memory factory.

Returns:

the default factory.

associate

public void associate(PhysicalMemoryCharacteristic name,
                      PhysicalMemoryRegion module)
               throws StaticIllegalArgumentException,
                      RangeOutOfBoundsException

Associates a programmer-defined name with a physical address range.

Parameters:

name - The physical memory characteristic. e.g STATIC_RAM.

module - The object representing a range of contiguous physical addresses.

Throws:

StaticIllegalArgumentException - when either name or module is null.

RangeOutOfBoundsException - when module overlaps a previously associated PhysicalMemoryRegion instance or cannot be mapped as Java object storage.

associate

public void associate(PhysicalMemoryCharacteristic[] names,
                      PhysicalMemoryRegion module)
               throws StaticIllegalArgumentException,
                      RangeOutOfBoundsException

Associates an array of programmer-defined names with a physical address range.

Parameters:

names - The array of physical memory characteristics. e.g { STATIC_RAM }.

module - The object representing a range of contiguous physical addresses.

Throws:

StaticIllegalArgumentException - when either names or module is null.

RangeOutOfBoundsException - when module overlaps a previously associated PhysicalMemoryRegion instance or cannot be mapped as Java object storage.

associate

public static void associate(PhysicalMemoryCharacteristic name,
                             PhysicalMemoryRegion[] modules)
                      throws StaticIllegalArgumentException,
                             RangeOutOfBoundsException

Associates a programmer-defined name with an array of physical address ranges.

Parameters:

name - is the physical memory characteristic. e.g STATIC_RAM.

modules - is an array of objects each representing a range of contiguous physical addresses.

Throws:

StaticIllegalArgumentException - when either name or modules is null.

RangeOutOfBoundsException - when module overlaps a previously associated PhysicalMemoryRegion instance or cannot be mapped as Java object storage.

createImmortalMemory

public ImmortalMemory createImmortalMemory(PhysicalMemorySelector selector,
                                           long size,
                                           java.lang.Runnable logic)
                                    throws StaticSecurityException,
                                           SizeOutOfBoundsException,
                                           UnsupportedPhysicalMemoryException,
                                           MemoryTypeConflictException,
                                           StaticIllegalArgumentException

Instantiates a ImmortalMemory object in a PhysicalMemoryRegion, where the memory type matches the PhysicalMemoryCharacteristic instances in selector and the virtual memory parameters of selector are applied.

Parameters:

selector - Used to choose the memory module and set the virtual mapping.

size - The size of memory to be taken out of the selected module.

logic - The default logic to execute on entry (may be null).

Returns:

the new memory area

Throws:

StaticSecurityException - when the application does not have permission to access physical memory or the given range of memory.

SizeOutOfBoundsException - when the implementation detects that size extends beyond a physically addressable memory module.

UnsupportedPhysicalMemoryException - when the underlying hardware does not support the given type, or when no matching PhysicalMemoryCharacteristic has been registered with this PhysicalMemoryFactory.

MemoryTypeConflictException - when the specified base does not point to memory that matches the requested type, or when type specifies incompatible memory attributes.

StaticIllegalArgumentException - when size is less than zero.

createLTMemory

public PinnableMemory createLTMemory(PhysicalMemorySelector selector,
                                     long size,
                                     java.lang.Runnable logic)
                              throws StaticSecurityException,
                                     SizeOutOfBoundsException,
                                     UnsupportedPhysicalMemoryException,
                                     MemoryTypeConflictException,
                                     StaticIllegalArgumentException

Instantiates a LTMemory object in a PhysicalMemoryRegion, matching the PhysicalMemoryCharacteristic in selector with virtual memory parameters of selector applied.

Parameters:

selector - Used to choose the memory module and set the virtual mapping.

size - The size of memory to be taken out of the selected module.

logic - The default logic to execute on entry (may be null).

Returns:

the new memory area

Throws:

StaticSecurityException - when the application does not have permission to access physical memory or the given range of memory.

SizeOutOfBoundsException - when the implementation detects that size extends beyond a physically addressable memory module.

UnsupportedPhysicalMemoryException - when the underlying hardware does not support the given type, or when no matching PhysicalMemoryCharacteristic has been registered with this PhysicalMemoryFactory.

MemoryTypeConflictException - when the specified base does not point to memory that matches the requested type, or when type specifies incompatible memory attributes.

StaticIllegalArgumentException - when size is less than zero.

createPinnableMemory

public PinnableMemory createPinnableMemory(PhysicalMemorySelector selector,
                                           long size,
                                           java.lang.Runnable logic)
                                    throws StaticSecurityException,
                                           SizeOutOfBoundsException,
                                           UnsupportedPhysicalMemoryException,
                                           MemoryTypeConflictException,
                                           StaticIllegalArgumentException

Instantiates a PinnableMemory object in a PhysicalMemoryRegion, matching the PhysicalMemoryCharacteristic in selector with virtual memory parameters of selector applied.

Parameters:

selector - Used to choose the memory module and set the virtual mapping.

size - The size of memory to be taken out of the selected module.

logic - The default logic to execute on entry (may be null).

Returns:

the new memory area

Throws:

StaticSecurityException - when the application does not have permissions to access physical memory or the given range of memory.

SizeOutOfBoundsException - when the implementation detects that size extends beyond a physically addressable memory module.

UnsupportedPhysicalMemoryException - when the underlying hardware does not support the given type, or when no matching PhysicalMemoryCharacteristic has been registered with this PhysicalMemoryFactory.

MemoryTypeConflictException - when the specified base does not point to memory that matches the requested type, or when type specifies incompatible memory attributes.

StaticIllegalArgumentException - when size is less than zero.

createStackedMemory

public StackedMemory createStackedMemory(PhysicalMemorySelector selector,
                                         long scopeSize,
                                         long backingSize,
                                         java.lang.Runnable logic)
                                  throws StaticSecurityException,
                                         SizeOutOfBoundsException,
                                         UnsupportedPhysicalMemoryException,
                                         MemoryTypeConflictException,
                                         StaticIllegalArgumentException

Instantiates a StackedMemory object in a PhysicalMemoryRegion, matching the PhysicalMemoryCharacteristic in selector with virtual memory parameters of selector applied.

Parameters:

selector - Used to choose the memory module and set the virtual mapping.

scopeSize - The size of the scope to be created.

backingSize - The size of the backing store to take out of the selected module.

logic - The default logic to execute on entry (may be null).

Returns:

the new memory area

Throws:

StaticSecurityException - when the application does not have permissions to access physical memory or the given range of memory.

SizeOutOfBoundsException - when the implementation detects that size extends beyond a physically addressable memory module.

UnsupportedPhysicalMemoryException - when the underlying hardware does not support the given type, or when no matching PhysicalMemoryCharacteristic has been registered with this PhysicalMemoryFactory.

MemoryTypeConflictException - when the specified base does not point to memory that matches the requested type, or when type specifies incompatible memory attributes.

StaticIllegalArgumentException - when scopeSize or backingSize is less than zero.