Previous Next  

Element: Settings

Document type

PartitionDescription

Document XPath

/PartitionDescription/Settings

Schema XPath

/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings

Description

The Settings element defines the run-time behavior of the partition.

The following example shows some of the optional settings:

<PartitionDescription ... >
 <Settings
  RequiredMemorySize="0x00200000"/>
  PartitionHMTable="my-partition-HM"
  syscallPermissions="0xFFFFFFFF"
  numFiles="0xFFFFFFFF"
  maxGlobalFDs="10"
  numDrivers="0xFFFFFFFF"
  numLogMsgs="0xFFFFFFFF"
  watchDogDuration="0"
  allocDisable="0"
  numStackGuardPages="0xFFFFFFFF"
  numWorkerTasks="0"
  isrStackSize="0xFFFFFFFF"
  selSvrQSize="0xFFFFFFFF"
  maxEventQStallDuration="INFINITE_TIME"
  fpExcEnable="1"/>
</PartitionDescription>
			

The complete list of settings is described below.

Use

Required

Children

None

Attributes

PartitionHMTable

RequiredMemorySize

allocDisable

appsIdleRelinquishEnabled

appsPriority

fpExcEnable

isrStackSize

maxEventQStallDuration

maxGlobalFDs

numDrivers

numFiles

numLogMsgs

numStackGuardPages

numWorkerTasks

selSvrQSize

syscallPermissions

user1

user2

watchDogDuration

Restrictions

None

Attribute: PartitionHMTable

Document XPath
/PartitionDescription/Settings/@PartitionHMTable
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@PartitionHMTable
Description

The name of the partition health monitor table that is used to configure health monitoring for the application in the partition.

Use

Required

Target location

ConfigRecord

XML data type

xs:string

Destination data type

String

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

Attribute: RequiredMemorySize

Document XPath
/PartitionDescription/Settings/@RequiredMemorySize
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@RequiredMemorySize
Description

The size (in bytes) of the partition’s region pool. This memory is part of the user memory region defined in /CoreOSDescription/HardwareConfiguration/PhysicalMemory/userMemoryRegion in the CoreOSDescription document for the core OS.

The partition's memory region must be large enough to contain the following:

To minimize the impact of change on the configuration and certification on the partition and the module as a whole, you should size the partition to accommodate the largest reasonably foreseeable size of the partition, rather than setting it to the minimum size required to accommodate the current partition.

If you increase the size of the partition memory, you may also have to change the values of the following settings to accommodate the increased size of the partition:

Use

Required

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

N/A

Values with special meanings

None

Restrictions

Attribute: allocDisable

Document XPath
/PartitionDescription/Settings/@allocDisable
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@allocDisable
Description

Determines whether dynamic memory allocation is enabled or disabled after the partition reaches normal mode.

Use

Optional

Target location

ConfigRecord

XML data type

xs:boolean

Destination data type

Boolean

Behavior if not specified

Dynamic memory allocation is enabled.

Values with special meanings

false: Dynamic memory allocation is enabled.

true: Dynamic memory allocation is disabled.

Restrictions

None

Attribute: appsIdleRelinquishEnabled

Document XPath
/PartitionDescription/Settings/@appsIdleRelinquishEnabled
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@appsIdleRelinquishEnabled
Description

If the value is true, the partition will be relinquish its remaining partition window when the partition is determined to be idle or when the application forces the idle condition. The time is then available for PPS scheduling of other partitions.

Use

Optional

Target location

ConfigRecord

XML data type

xs:boolean

Destination data type

Boolean

Behavior if not specified

A value of false is used.

Values with special meanings

None

Restrictions

None

Attribute: appsPriority

Document XPath
/PartitionDescription/Settings/@appsPriority
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@appsPriority
Description

The priority for the partition when using APPS scheduling.

Use

Optional

Target location

ConfigRecord

XML data type

xs:integer

Destination data type

Signed 32 bit integer

Behavior if not specified

PPS is disabled.

Values with special meanings

-1: PPS is disabled.

Restrictions

Attribute: fpExcEnable

Document XPath
/PartitionDescription/Settings/@fpExcEnable
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@fpExcEnable
Description

Determines whether floating-point exceptions are enabled for the partition.

Use

Optional

Target location

ConfigRecord

XML data type

xs:boolean

Destination data type

Boolean

Behavior if not specified

Floating-point exceptions are enabled.

Values with special meanings

false: Floating-point exceptions are disabled.

true: Floating-point exceptions are enabled.

Restrictions

None

Attribute: isrStackSize

Document XPath
/PartitionDescription/Settings/@isrStackSize
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@isrStackSize
Description

The size (in bytes) of the ISR stack. Unless you define your own interrupt handling routines, the default value of the ISR_STACK_SIZE parameter (8192) is sufficient. If you do provide your own interrupt handling routines, you should increase this value by the appropriate amount to meet the requirements of your own code.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The value of the ISR_STACK_SIZE parameter is used.

Values with special meanings

0xFFFFFFFF: The value of the ISR_STACK_SIZE parameter is used.

Restrictions

None

Attribute: maxEventQStallDuration

Document XPath
/PartitionDescription/Settings/@maxEventQStallDuration
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@maxEventQStallDuration
Description

The maximum time (in SYSTEM_TIME_TYPE units as defined in apexTypes.h) that an event can remain in the event queue. The value is used to detect stalled partitions.

Use

Optional

Target location

ConfigRecord

XML data type

DurationType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

A value of 0 is used. A value of 0 is invalid and will result in an error.

Values with special meanings

INFINITE_TIME: If the partition stalls, it will not be detected.

Restrictions

Attribute: maxGlobalFDs

Document XPath
/PartitionDescription/Settings/@maxGlobalFDs
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@maxGlobalFDs
Description

The maximum number of global file descriptors that can be opened by the application that resides in the partition.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The application that resides in the partition cannot open any global file descriptors.

Values with special meanings

0: The application that resides in the partition cannot open any global file descriptors.

Restrictions

Attribute: numDrivers

Document XPath
/PartitionDescription/Settings/@numDrivers
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@numDrivers
Description

The maximum number of I/O device drivers allowed in the partition.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The value of the NUM_DRIVERS parameter is used.

Values with special meanings

0xFFFFFFFF: The value of the NUM_DRIVERS parameter is used.

Restrictions

Attribute: numFiles

Document XPath
/PartitionDescription/Settings/@numFiles
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@numFiles
Description

The maximum number of open files allowed in the application that resides in the partition, including the number of global file descriptors as specified in maxGlobalFDs.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The value of the NUM_FILES parameter is used.

Values with special meanings

0xFFFFFFFF: The value of the NUM_FILES parameter is used.

Restrictions

Attribute: numLogMsgs

Document XPath
/PartitionDescription/Settings/@numLogMsgs
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@numLogMsgs
Description

The maximum number of messages allowed in the partition’s logging queue.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The value of the MAX_LOG_MSGS parameter is used.

Values with special meanings

0xFFFFFFFF: The value of the MAX_LOG_MSGS parameter is used.

Restrictions

Attribute: numStackGuardPages

Document XPath
/PartitionDescription/Settings/@numStackGuardPages
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@numStackGuardPages
Description

The number of stack guard pages at the end of each vThreads task’s stack. vThreads uses guard pages to detect interrupt stack overflow and task stack overflow.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The value of the NUM_STACK_GUARD_PAGES parameter is used.

Values with special meanings

0xFFFFFFFF: The value of the NUM_STACK_GUARD_PAGES parameter is used.

Restrictions

Attribute: numWorkerTasks

Document XPath
/PartitionDescription/Settings/@numWorkerTasks
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@numWorkerTasks
Description

The maximum number of worker tasks for the partition. Worker tasks are used when a partition makes a blocking call to the core OS (for instance, an I/O call). The worker task blocks until the system call is complete, allowing the partition to continue. If no worker tasks are defined, the entire partition blocks until the system call completes.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

There are no worker tasks for the partition.

Values with special meanings

None

Restrictions

Attribute: selSvrQSize

Document XPath
/PartitionDescription/Settings/@selSvrQSize
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@selSvrQSize
Description

The maximum number of concurrent vThreads tasks allowed to do a select operation on global file descriptors. This should be greater than or equal to the number of vThreads tasks that could potentially be waiting on “select” system calls at the same time.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The value of the SELECT_SERVER_QSIZE parameter is used.

Values with special meanings

0xFFFFFFFF: The value of the SELECT_SERVER_QSIZE parameter is used.

Restrictions

Attribute: syscallPermissions

Document XPath
/PartitionDescription/Settings/@syscallPermissions
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@syscallPermissions
Description

The bitmask that determines the set of system calls that the application that resides in the partition is allowed to perform. Calculate the value as follows: (1 << x - SYSCALL_MASKABLE), where x is the logical OR of the values of allowable system calls. These values and SYSCALL_MASKABLE are defined in val.h.

Use

Optional

Target location

ConfigRecord

XML data type

DecOrHexValueType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The application that resides in the partition can make any system call.

Values with special meanings

0xFFFFFFFF: The application that resides in the partition can make any system call.

Restrictions

None

Attribute: user1

Document XPath
/PartitionDescription/Settings/@user1
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@user1
Description

This attribute specifies the value of the user1 field in the PARTITION_CFG_RECORD structure in the system configuration record. You can access this value at runtime by calling:

configRecordFieldGet (pCfg, PARTITION_USER1, 0, &value)
					
Use

Optional

Target location

configRecord

XML data type

DecOrHexValueType

Destination data type

Signed 32 bit integer

Behavior if not specified

A value of 0 is used.

Values with special meanings

None

Restrictions

None

Attribute: user2

Document XPath
/PartitionDescription/Settings/@user2
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@user2
Description

This attribute specifies the value of the user2 field in the PARTITION_CFG_RECORD structure in the system configuration record. You can access this value at runtime by calling:

configRecordFieldGet (pCfg, PARTITION_USER2, 0, &value)
					
Use

Optional

Target location

configRecord

XML data type

DecOrHexValueType

Destination data type

Signed 32 bit integer

Behavior if not specified

A value of 0 is used.

Values with special meanings

None

Restrictions

None

Attribute: watchDogDuration

Document XPath
/PartitionDescription/Settings/@watchDogDuration
Schema XPath
/ConfigRecord/Module/Partitions/Partition/PartitionDescription/Settings/@watchDogDuration
Description

The maximum partition time (in seconds) that an application can lock preemption while protecting critical sections.

Use

Optional

Target location

ConfigRecord

XML data type

DurationType

Destination data type

Unsigned 32 bit integer

Behavior if not specified

The application with task lock will be preempted immediately if need arises.

Values with special meanings

0: The application with task lock will be preempted immediately if need arises.

INFINITE_TIME: The application can lock preemption indefinitely.

Restrictions



Generated on 2007-10-15 17:17:22.