API Changes Between RTX64 3.x and RTX64 4.x

Renamed the parameter:

• pTarget to pDestination

Renamed the parameter:

• pTarget to pDestination

Added support for these members:

• ReceiveLinkSpeedspecifies the current speed in bits per second of the receive link for the adapter.
• TransmitLinkSpeedspecifies the current speed in bits per second of the transmit link for the adapter.

Added a new member:

• RTIN_MSIX_MULTI_VECTOR represents MSI-X Multi Vector interrupts.

Added a new member:

• SpeedDuplex specifies the method used to establish the Ethernet link.

Added a new member:

• MSIX_MULTI_VECTOR represents MSI-X Multi Vector interrupts.

Added a new sub-class:

• RTX64Win32Exception

Added new constructors:

• RTX64Win32Exception (String, Int)
• RTX64Win32Exception (String, Int, Exception)

Added new properties:

• message gets the message in the exception.
• win32ErrorCode gets the Windows or RTSS error code retrieved from the Native API.
• innerException gets the exception that triggered this exception.

Added new method:

• GetNetworkInterfacesStatus queries the status of each enabled network interface.

Added a new property to method CreateNetworkInterface:

• speedDuplex specifies the method used to establish the Ethernet link.

Added new properties:

• MSpaceInitialSizegets/sets the size, in kilobytes, by which to allocate Non-Paged memory from Windows into the Local Pool of the MSpace at process startup.
• MSpaceExpandSizegets/sets the size, in kilobytes, by which to expand an RTSS processes' internal/external MSpaces.

Added new local memory configuration properties:

• EnableLocalMemoryaccesses the configuration parameter that specifies whether the RTX64 Subsystem uses Local memory (MSpaces) or Windows memory. If true, the real-time Subsystem memory allocation uses Local memory MSpaces. If false, the Subsystem allocates memory by requesting it from Windows.
• NALExtMSpacePoolMinimumSizeaccesses the configuration parameter that specifies the minimum size, in kilobytes, of the local pool within the Network Abstraction Layer (NAL) external MSpace.
• NALMSpacesPoolExpandableaccesses the configuration parameter that specifies whether the local pool within the Network Abstraction Layer (NAL) MSpaces is expandable. If true, the local pool within the NAL MSpace is expandable by the amount specified by NALMSpacesPoolExpandSize when depleted.
• NALMSpacesPoolExpandSizeaccesses the configuration parameter that specifies the size, in kilobytes, by which to expand the local pool within the Network Abstraction Layer (NAL) MSpaces when NALMSpacesPoolExpandable is set to true.
• ProcessExtMSpacePoolMinimumSizeaccesses the configuration parameter that specifies the minimum size, in kilobytes, of the local pool within the RTSS process external MSpace.
• ProcessMSpacesPoolExpandableaccesses the configuration parameter that specifies whether the local pool within the RTSS process MSpace is expandable. If true, the local pool within the RTSS process MSpace is expandable by the amount specified byProcessMSpacesPoolExpandSizewhen depleted.
• ProcessMSpacesPoolExpandSizeaccesses the configuration parameter that specifies the size, in kilobytes, by which to expand the local pool within the RTSS process MSpace whenProcessMSpacesPoolExpandableis set to true.
• ProcessMSpacesPoolShrinkableaccesses the configuration parameter that specifies whether the local pool within the RTSS process MSpace is shrinkable.
• SystemExtMSpacePoolMinimumSizeaccesses the configuration parameter that specifies the minimum size, in kilobytes, of the local pool within the system process external MSpace.
• SystemExtMSpacePoolCommitaccesses the configuration parameter that specifies whether the local pool within the system process external MSpace is committed at startup.
• SystemMSpacesPoolExpandableaccesses the configuration parameter that specifies whether the local pool within the system process MSpace is expandable by the amount specified bySystemMSpacePoolExpandSizewhen depleted.
• SystemMSpacesPoolExpandSizeaccesses the configuration parameter that specifies the size, in kilobytes, by which to expand the local pool within the system process MSpace whenSystemMSpacePoolExpandableis set to true.
• SystemMSpacesPoolShrinkableaccesses the configuration parameter that specifies whether the local pool within the system process MSpace is shrinkable.
• TCPIPExtMSpacePoolMinimumSizeaccesses the configuration parameter that specifies the minimum size, in kilobytes, of the local pool within the RT-TCP-IP Stack external MSpace.
• TCPIPMSpacesPoolExpandableaccesses the configuration parameter that specifies whether the local pool within the RT-TCP/IP Stack MSpace is expandable. If true, the local pool within the RT-TCP/IP Stack MSpace is expandable by the amount specified by TCPIPMSpacesPoolExpandSize when depleted.
• TCPIPMSpacesPoolExpandSizeaccesses the configuration parameter that specifies the size, in kilobytes, by which to expand the local pool within the RT-TCP/IP Stack MSpace when TCPIPMSpacesPoolExpandable is set to true.
• ZeroMemoryAtAllocationaccesses the configuration parameter that specifies whether the memory allocated by malloc or similar C-Runtime functions is initialized to zero (according to the C99 specification).

Added a new method:

• MethodSetHALTimerPeriodsets the HAL timer period (in microseconds) for the RTX64 Subsystem.

LPVOID HeapAlloc(
    HANDLE hHeap,
    DWORD dwFlags,
    SIZE_T dwBytes
);

HANDLE HeapCreate(
    DWORD flOptions,
    SIZE_T dwInitialSize,
    SIZE_T dwMaximumSize
);

LPVOID HeapReAlloc(
    HANDLE hHeap,
    DWORD Flags,
    LPVOID lpMem,
    SIZE_T dwBytes
);

Allocates memory from the external MSpace of the current process.

Allocates memory from the external memory allocation space (MSpace) of the current process. RtAllocateLocalMemoryEx allows you to allocate memory without zero-initializing the memory region.

Parameter flProtect is still ignored by RTSS but supported under Windows with these values:

Deprecated attribute RT_PROC_THREAD_ATTRIBUTE_USE_LOCAL_MEMORY

BOOL RtGetProcessAffinityMask(
    HANDLE hProcess,
    PUINT64 pProcessAffinityMask,
    PUINT64 pSystemAffinityMask
);

BOOL RtSetProcessAffinityMask(
    HANDLE hProcess,
    UINT64 ProcessAffinityMask
);

BOOL RtGetProcessorInfo(
    PDWORD lpLowestSystemProcessor,
    PDWORD lpHighestSystemProcessor
);

Removed Windows support. This function can now only be called from an RTSS process or RTDLL.

bool RtfwGetSubsystemStatus(
    RTFW_COMPONENT_STATUS * pStatus
);

• ParameterpStatusnow points to a value that is set in new enumerator RTFW_COMPONENT_STATUS

Renamed RtfwStartTCPIPStack

Renamed RtfwStopTCPIPStack

Renamed RTFW_DEFAULT_RTSS_PROCESSOR

When configuring the Network Abstraction Layer (NAL) or RT-TCP/IP stack, this constant represents the RTSS processor on which the NAL or Stack processes are running. When configuring other components of the RTX64 Subsystem, this constant represents the first RTSS processor.

typedef struct _RTFW_LOCAL_MEMORY_CONFIGURATION(
    size_t          Size;
    bool            EnableLocalMemory;
    unsigned int    SystemExtMSpacePoolMinimumSize;
    bool            SystemExtMSpacePoolCommit;
    bool            SystemMSpacesPoolExpandable;
    unsigned int    SystemMSpacesPoolExpandSize;
    bool            SystemMSpacesPoolShrinkable;
    unsigned int    ProcessExtMSpacePoolMinimumSize;
    bool            ProcessMSpacesPoolExpandable;
    unsigned int    ProcessMSpacesPoolExpandSize;
    bool            ProcessMSpacesPoolShrinkable;
    bool            ZeroMemoryAtAllocation; 
    unsigned int    SystemIntMSpacesPoolMinimumSize;
    unsigned int    ProcessIntMSpacesPoolMinimumSize;
} RTFW_LOCAL_MEMORY_CONFIGURATION, * PRTFW_LOCAL_MEMORY_CONFIGURATION;

• Renamed parameterUseLocalMemorytoEnableLocalMemory
• Added these members:
• SystemExtMSpacePoolMinimumSize
• SystemExtMSpacePoolCommit
• SystemMSpacesPoolExpandable
• SystemMSpacesPoolExpandSize
• SystemMSpacesPoolShrinkable
• ProcessExtMSpacePoolMinimumSize
• ProcessMSpacesPoolExpandable
• ProcessMSpacesPoolExpandSize
• ProcessMSpacesPoolShrinkable
• ZeroMemoryAtAllocation

• SystemIntMSpacePoolMinimumSize
• ProcessIntMSpacePoolMinimumSize

typedef struct _RTFW_NETWORK_INTERFACE(
    size_t Size;
  
    // These fields are required for TCP/IP and NAL interfaces.
    TCHAR Name[RTFW_MAX_INTERFACE_NAME_CHARS];
    bool Enabled;
    TCHAR Driver[MAX_PATH];
    unsigned int MaxPacketSize;
    bool LinkStatus;
    TCHAR PCIBusLocation[RTFW_MAX_INTERFACE_PCIBUSLOCATION_CHARS];
    RTFW_INTERRUPT_TYPE InterruptType;
    unsigned int TransmitCompletePriority;
    unsigned int TransmitCompleteIdealProcessor;
    unsigned int NumberReceiveBuffers;
    unsigned int NumberTransmitBuffers;
    unsigned int NumberReceiveQueues;
    unsigned int NumberTransmitQueues;
    unsigned int DefaultReceiveQueue;
    DWORD InterruptIdealProcessor;
    unsigned int InterruptPriority;
    TCHAR DeviceInstanceID[RTFW_MAX_INTERFACE_INSTANCEID_CHARS];
    bool SupportTCPIP;
 
    // These fields are required only if SupportTCPIP is set to TRUE.
    unsigned int CountIPv4Configurations;
    RTFW_IPV4_CONFIGURATIONW IPv4Configurations[RTFW_MAX_IPS_PER_INTERFACE];
    TCHAR Gateway[RTFW_IPV4ADDRESS_LENGTH];
    unsigned int MTU;
    bool FilterEnabled;
    TCHAR FilterDriver[MAX_PATH];
    TCHAR IPv6Address[RTFW_MAX_INTERFACE_IPV6ADDRESS_CHARS];
    unsigned int IPv6Prefix;
    unsigned int ReceivePriority;
    DWORD ReceiveIdealProcessor;
} RTFW_NETWORK_INTERFACE, * PRTFW_NETWORK_INTERFACE;

• Renamed parameterFriendlyNametoName
• Renamed parameterCountIPv4AddressestoCountIPv4Configurations
• Removed parameterLinkStatusPriority
• Removed parameterLinkStatusIdealProcessor
• Added these parameters:
• MaxPacketSize
• TransmitCompletePriority
• TransmitCompleteIdealProcessor
• NumberReceiveQueues
• NumberTransmitQueues
• DefaultReceiveQueue
• SupportTCPIP

typedef enum _RTFW_RESTART_TYPE(
    RTRT_NONE,
    RTRT_TCPIP = 5
    RTRT_NETWORK = 7
    RTRT_SUBSYSTEM = 10,
    RTRT_MACHINE = 20,
} RTFW_RESTART_TYPE;

• Changed the meaning of parameterRTRT_NETWORKto refer to the Network Abstraction Layer (NAL)

MonitorEventThreadCreate.AffinedProcessor Property (IntervalZero.RTX64.Monitor Namespace)

void AddScheduledProcess(
	string fileName, 
	string parameters, 
	uint idealProcessor,
	ulong affinityMask,                               
	uint MSpaceInitialSize, 
	uint MSpaceExpandSize, 
	int order = -1
);

• Removed parameteruseLocalPool
• Added these new parameters:
• MSpaceInitialSize
• MSpaceExpandSize

Removed. Use RtExpandMSpace, which expands the specified MSpace by the size specified.

Removed. Use RtGetLicenses, which retrieves information about all licenses available on the system.

Removed. Use RtGetLicenses, which retrieves information about all licenses available on the system.

Removed. Use RtQueryProcessMSpace, which queries memory allocation space information in the specified process MSpace, including various summary statistics of its local pool and pool cache.

Removed. Use RtnFrameAllocate, which can be used by a filter driver, and an RTSS application with RT-TCP/IP support enabled, to allocate a block of memory to store an Ethernet frame.

Removed. Use RtnFrameFree, which returns an allocated frame back to the TCP/IP Stack.

Removed. Use RtnFrameTransmit, which can be called when a filter or RTSS application wants to transmit a frame pointed to by the parameter EthernetFrame.

This function is deprecated and will be removed from a future release.

Use RtfwGetRTX64DevicesEx.

This structure is deprecated and will be removed from a future release.

Use RTFW_DEVICEEX.

This function is deprecated and will be removed from a future release. The function will fail in RTX64 4.1 and later versions.

Use RtfwGetConsoleConfigurationEx.

This function is deprecated and will be removed from a future release. The function will fail in RTX64 4.1 and later versions.

Use RtfwSetConsoleConfigurationEx.

This structure is deprecated and will be removed from a future release. The structure will fail in RTX64 4.1 and later versions.

Use RTFW_CONSOLE_CONFIGURATION_EX.

Removed. Use these new APIs:

• RtfwGetNALConfigurationreturns the configuration of the Network Abstraction Layer (NAL).
• RtfwGetTCPIPConfigurationreturns the configuration of the RT-TCP/IP Stack.

Removed. Use these new APIs:

• RtfwGetNALStatus
• RtfwGetTCPIPStatus

Removed. Use these new APIs:

• RtfwSetNALConfigurationconfigures the Network Abstraction Layer (NAL).
• RtfwSetTCPIPConfigurationconfigures the RT-TCP/IP Stack.

Removed. Use these new APIs:

• RTFW_NAL_CONFIGURATIONrepresents the configuration of the Network Abstraction Layer (NAL).
• RTFW_TCPIP_CONFIGURATIONrepresents the configuration of the RT-TCP/IP Stack.

The following overloads to method RTProcess.Start were deprecated and will be removed from a future release:

• Start
• Start(Boolean)
• Start(ProcessStartInfo)
• Start(String)
• Start(String, String)
• Start(ProcessStartInfo, UInt64, UInt32)
• Start(String, UInt64, UInt32)
• Start(ProcessStartInfo, UInt64, UInt32)
• Start(String, String, UInt64, UInt32)
• Start(String, UInt64, UInt32)
• Start(String, String, UInt64, UInt32)

These properties were deprecated and will be removed from a future release:

• LogFileName
• SuppressWarnings

These methods were deprecated and will be removed from a future release:

• ResetLogFileName
• ResetSuppressWarnings

These properties were removed:

• LinkStatusPriority
• LinkStatusIdealProcessor
• UseLocalMemory

These properties were removed:

• DisableLocalMemoryExpansion(use new propertiesProcessMSpacesPoolExpandableandSystemMSpacePoolExpandable)
• DisableLocalMemoryShrink(use new propertiesProcessMSpacesPoolShrinkableandSystemMSpacePoolShrinkable)
• LocalMemoryPoolExpansionSize(use new propertiesProcessMSpacesPoolExpandSizeandSystemMSpacePoolExpandSize)
• LocalMemoryPoolInitialSize(use new propertySystemExtMSpacePoolCommit)
• UseLocalMemory(use new propertyEnableLocalMemory)

These properties were removed:

• DisableLocalMemoryExpansion(use new propertiesProcessMSpacesPoolExpandableandSystemMSpacePoolExpandable)
• DisableLocalMemoryShrink(use new propertiesProcessMSpacesPoolShrinkableandSystemMSpacePoolShrinkable)
• LocalMemoryPoolExpansionSize(use new propertiesProcessMSpacesPoolExpandSizeandSystemMSpacePoolExpandSize)
• LocalMemoryPoolInitialSize(use new propertySystemExtMSpacePoolCommit)
• UseLocalMemory(use new propertyEnableLocalMemory)

These properties were removed:

• Status
• Error

These properties were removed:

• TotalMemory
• AvailableMemory
• ContiguousMemory

These methods were removed:

• EnableInterrupts
• DisableInterrupts
• AddShutdownHandler
• RemoveShutdownHandler