RTFW_LOCAL_MEMORY_CONFIGURATION Structure

RTFW_LOCAL_MEMORY_CONFIGURATION represents the configuration of the RTX64 Subsystem and its use of the Local Memory pool.

Syntax

typedef struct _RTFW_LOCAL_MEMORY_CONFIGURATION(
    size_t Size;
    bool UseLocalMemory;
    bool AutoExpandPool;
    bool AutoShrinkPool;
    unsigned int InitialSize;
    unsigned int ExpansionSize;
} RTFW_LOCAL_MEMORY_CONFIGURATION, * PRTFW_LOCAL_MEMORY_CONFIGURATION;

Members

Size

The size of this structure (in bytes). Client code must set this member to sizeof(RTFW_LOCAL_MEMORY_CONFIGURATION) before passing this structure to any function.

UseLocalMemory

If true, the real-time Subsystem memory allocation uses the Local Memory pool by default. If false, the Subsystem allocates memory by requesting it from Windows.

IMPORTANT! Local memory pool allocation is deterministic when the pool has enough memory to complete the request. Windows memory allocation from the nonpaged pool is not deterministic.

This configuration parameter applies to all real-time processes, but it can be overridden for a specific process using RtssRun command-line options and using parameter lpStartupInfo to RtCreateProcess.

AutoExpandPool

If true, the Subsystem automatically expands the Local Memory pool when it is exhausted. If false, the pool does not automatically expand and any requests for memory from the pool when it is exhausted will fail.

IMPORTANT! Expansion of the Local Memory pool is non-deterministic.

AutoShrinkPool

If true, the Subsystem automatically shrinks the Local Memory pool when a real-time process terminates. If false, the pool does not automatically shrink.

IMPORTANT! Shrinking the Local Memory pool is non-deterministic.

InitialSize

The initial size of the Local Memory pool (in bytes). The pool is created during the first memory allocation call.

ExpansionSize

The size (in bytes) by which the Local Memory pool expands if member AutoExpandPool is true.

Requirements

Minimum Required Version	RTX64 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib