Previous Release Notes¶
Release Notes 3.2¶
What's New in 3.2¶
Support for RTI Connext DDS Professional user data compression feature ¶
RTI Perftest now supports (in the Traditional C++ API implementation) testing performance scenarios that enable the new compression feature introduced in Connext DDS Professional 6.1.0.
The configuration can be done by using three new command-line options:
-compressionThreshold. See the
Command-Line Parameters section for details about the parameters
and the 1-to-1, FlatData, SharedMemory, Unicast, Reliable, Latency test, Large Data section for some examples of the usage of
This feature is intended to be used in conjunction with the
-loadDataFromFile option to simulate accurate scenarios where the
compression rate can be similar to a real case.
RTI Perftest Modern C++ API now compiles with C++11 ¶
The RTI Perftest Modern C++ API has been updated to require a C++11 compiler. The
command-line option for the language passed to the
rtiddsgen script is now
C++11 instead of
C++03. The name of the folder with the code for this API
has been updated to
srcCpp11 and the generated executable is now named
perftest_cpp11 instead of
Support for Connext DDS Professional's network capture feature ¶
RTI Perftest added support in this version for the network capture capability, introduced in Connext DDS Professional 6.1.0. This support is exclusive to the Traditional C++ API implementation.
In order to control the use of this new option, two new command-line parameters
-networkCapture, to enable the use of the feature, and
-doNotDropNetworkCapture, to control if the output file produced by the
network capture feature is retained or deleted after the run (due to the nature of RTI
Perftest, the size of the file might be huge). See Command-Line Parameters for
more information about the parameters.
Support for new WAN transport ¶
RTI Perftest now supports testing the new WAN transport in the Tradditional C++
API implementation. It can be accessed as a new -transport command-line option
argument. See Use-Cases and Examples for an example of its
usage. To use this option, the
-transportPublicAddress command-line option
is required on one side, either the Publisher or Subscriber side.
See Command-Line Parameters for more information.
What's Fixed in 3.2¶
Warning message when using security and a custom governance file was sent to
When using RTI Security Plugins and providing a custom governance
file (using the
-secureGovernanceFile command-line option), a warning message
would appear to make explicit that every security configuration option would be
overridden by the content of the governance file. That message was sent in previous
stdout instead of
stderr. Only data should be sent to
stdout, not messages. Sending only data to
stdout allows the option
of doing a pipe of the RTI Perftest output to a file, obtaining a pure
This issue has been corrected; the message is now sent to
Fix incorrect schema location in the Governance files used by security ¶
All the Governance files pointed to a non-existent location for the xsd file. The reference has been updated and it now points to the right url.
Release Notes 3.1¶
What's New in 3.1¶
New tutorial section in the documentation ¶
A new tutorial section in the documentation shows how to properly use RTI Perftest in real-life scenarios to gather the limits for throughput and latency. It also shows the impact of using RTI Connext DDS features.
Send data from a file as payload for Perftest messages (#210) ¶
A new command-line option has been added to the Traditional C++ API implementation that allows you to load a file into memory and send the data of the file instead of using an empty buffer as the payload for the RTI Perftest messages.
Easily view DataWriter and DataReader queue stats (#251) ¶
By using the -cacheStats command-line parameter, RTI Perftest now displays the Send Queue sample_count and sample_count_peak on the publisher side. For the Subscriber side, RTI Perftest displays the Receive Queue sample_count and sample_count_peak.
Measure latency in nanoseconds (#253) ¶
RTI Perftest can now be compiled using POSIX calls to measure latency in nanoseconds, instead of using the Connext DDS Professional calls, which return the time in microseconds.
This option can be enabled at compilation time by using --ns-resolution. This option is only implemented for Linux/macOS/QNX Systems.
Decloupled Asynchronous Publishing and switching to unbounded sequences ¶
RTI Perftest uses by default bounded sequences, this is in certain cases more efficient, but it involves allocating more memory. In order to avoid reserving too much memory, in previous releases RTI Perftest would switch to unbounded sequences when the packet size was close to the maximum size of an UDPv4 packet. That was a hardcoded value (63000 Bytes). At that same point RTI Perftest would also enable asynchronous publishing (needed when using Reliable reliability and setting a packet size larger than the UDPv4 maximum size).
Starting in this release the use of unbounded sequences has been decoupled from the switch between synchronous to asynchronous publishing: While the max bounded size has been set to a fixed value (that can be found and modified in the IDL file). Enabling asynchronous publishing is now done based on the maximum packet size for all the enabled transports. This means that if only Shared Memory is enabled, asynchronous publishing will not be enabled when crossing the maximum message size for UDPv4.
See Large Samples section for more information.
Behavior for SHMEM and asynchronous publishing dynamically determined ¶
The value to switch to asynchronous publishing is no longer a fixed value, but calculated according to the minimum message_size_max accross all the enabled transports.
In the case of using SHMEM, the value of message_size_max is not set, but calculated to fit samples of the size specified by the -datalen command-line parameter.
Find more information about this in Large Samples.
New Security governance files added for Sign and Encrypt with original auth for RTPS (#253) ¶
This release adds two new governance profiles to the list of generated governance files in resource/secure/input/governances/:
It also adds their respective signed versions (signed_...).
CSV and JSON added to the list of output formats available to display data (#280) ¶
The RTI Perftest default output format has been improved. This format should now be compatible with the CSV format standard, simplifying opening the results with spreadsheet editors and parsing them via scripting. The output retains its readability, by correctly aligning rows and columns and by printing headers for each column.
RTI Perftest also provides the option of changing or customizing the output format by using the -outputFormat <format>. Currently, the supported values are csv (default), json, or legacy (which refers to the previous output used by RTI Perftest).
Another flag has been added, -noOutputHeaders, to skip printing the header rows (for the summaries and interval information).
Use of Thread Priorities now supported in QNX platforms ¶
The use of the -threadPriorities command is now supported on QNX platforms. You can specify either three numeric values representing the priority of each of the threads or three characters representing the priorities: h,n,l.
Know the exact size of RTI Perftest's type being used (#265) ¶
The overhead size resulting from the serialized sample of the Perftest type is now calculated programmatically. This change accurately gives the exact number of bytes that are sent when CustomTypes or FlatData types are used.
Notification when a test ends without any packets received (#303) ¶
When performing certain tests, especially with very few samples, or with very large ones, the probability of not receiving any samples on the Publisher or Subscriber side is higher. In this release, we now notify you when the application receives the message that the test has ended, as well as some suggestions on how to fix the problem.
Easily see the serialization/deserialization times (#304) ¶
When the feature to show the serialization/deserialization times was added, it was set to show the data at the end of the test, on the Publisher side, as a new line after the latency results.
This was not convenient, since this line could conflict when parsing the latency lines. This problem has been resolved by adding a new parameter -showSerializationTime, which enables calculating and showing the serialization/deserialization times.
Control the size of the initial burst of intialization samples (#310) ¶
A new command-line parameter, -initialBurstSize, has been added to the Traditional and Modern C++ API implementations to control the number of samples sent in the initial burst of samples that RTI Perftest uses to initialize the buffers in the sending and receiving paths.
In most cases, this number should not cause trouble (as long as it is big enough), but in certain cases a low number is required due to OS restrictions.
Perftest internal effiency improved by generating the qos_string file only once and in srcCppCommon (#334) ¶
Previously, the qos_string.h file containing the strings from perftest_qos_profiles.xml was generated twice and copied to the srcCpp and srcCpp03 folders. This process has been simplified, generating qos_string.h only once and into srcCppCommon.
Control the compiler used, and add flags without modifying the build script (PERF-194) ¶
RTI Perftest now enables you to add specific command-line arguments to the cmake executable (which is used when compiling against RTI Connext DDS Micro). This feature allows control of the compiler used, as well as the ability to add specific flags, without modifying the build script. This feature may be needed when crosscompiling.
Display error if the -allowInterface parameter is an IP when using RTI Connext DDS Micro (PERF-212) ¶
RTI Connext DDS Pro supports for the Allow Interfaces List the use of the interface name or the IP, however RTI Connext DDS Micro does not support the use of an IP address, and it would consider the IP as the name of the interface, therefore failing to find an interface and not being able to communicate.
Although this is an expected behavior, customers switching in RTI Perftest between RTI Connext DDS Pro and Micro may encounter this behavior frequently, if they use the -allowInterfaces (formerly -nic) command line option. This error is silent and cannot be catched by RTI Perftest.
To avoid this confusion, RTI Perftest compiled against RTI Connext DDS Micro will report an error if an IP is provided when setting the -allowInterfaces/-nic parameter.
What's Fixed in 3.1¶
Improved message when NDDSHOME/RTIMEHOME paths are not reachable (#222) ¶
RTI Perftest has improved the error message when the path provided to NDDSHOME or RTIMEHOME is incorrect. Previously, the message was misleading because it claimed that the path was not provided.
Wrong version in Dockerfile for Perftest 3.1.0 (#227) ¶
RTI Perftest's Dockerfile was outdated. It has now been updated to use the latest release.
Participant properties always propagated in C++03 (#228) ¶
QoS properties for DataReaders and DataWriters were being propagated in C++03 implementations. This behaviour is not needed, so it has been removed. Now the behavior is the same as the Traditional C++ implementation.
Wrong capitalization for command-line option --customTypeFlatData (#232) ¶
In build.sh and build.bat, the command-line parameter used to specify that a custom type for FlatData was provided was misspelled.
Error finalizing the application when using SHMEM for RTI Connext DDS Micro (#234) ¶
When using RTI Connext DDS Micro and setting the transport to SHMEM, an error appeared at the end of the test for both Publisher and Subscriber by the time the finalize_instance() function was called. This error has been resolved.
rtiddsgen version not properly compared to identify support of certain features (#237) ¶
Previously, the rtiddsgen version number was not correctly obtained by RTI Perftest compilation scripts. This problem caused the inclusion of the wrong compilation flags in some cases.
Incorrect governance file values for RTI Security Plugins (#239) ¶
The PerftestGovernance_RTPSEncryptWithOrigAuthEncryptData.xml and PerftestGovernance_RTPSSignWithOrigAuthEncryptData.xml governance files were not correctly writen. They would not set the right flags to encrypt the data. This issue has been fixed.
ContentFilteredTopics (-cft) range option not working properly (#240) ¶
The -cft option for the Perftest Subscriber side was not working correctly when specifying a range of values to filter (e.g., -cft 3:5). This behavior has been corrected.
Issue displaying Connext DDS Micro release number (#243) ¶
RTI Perftest would display the RTIME_DDS_VERSION_REVISION instead of the RTIME_DDS_VERSION_RELEASE when compiling against RTI Connext DDS Micro. This problem has been fixed.
Incorrect number of max_instances in DataReader when using Connext DDS Micro (#244) ¶
The max_instances value assigned to the resouce limits on the DataReader side in RTI Perftest when compiling against Connext DDS Micro was not set correctly. It would not account for the extra sample used to skip the ContentFilteredTopics.
Asynchronous publishing incorrectly set to true when using Zero Copy and Large Data (#246) ¶
RTI Perftest presented in the summary on the Publisher side that asynchronous publishing was set to true regardless of whether the test was using Zero Copy transfer over shared memory.
When using Zero Copy transfer over shared memory, the size of the message being sent will always be constant, independent of the size of the sample being sent, since it is just a reference to where the sample is stored in memory. This means that aynchronous publishing is not needed in any case.
Incorrect documentation examples for FlatData and Zero-Copy (#249) ¶
In the documentation examples for FlatData and Zero Copy transfer over shared memory, the data sizes used for the Publisher and Subscriber did not match. Also, in the Best Effort case, the command lines did not include the -bestEffort option. These issues have been fixed.
Discovery process not robust enough (#261) ¶
RTI Perftest was not checking that all the entities of the three Topics (AnnouncementTopic, ThroughputTopic, and LatencyTopic) were discovering each other, only the ones for the ThroughputTopic. In corner cases, this led to the test not working correctly. This problem has been corrected.
LatencyTopic endpoints not discovered in some cases (#261) ¶
The combination of the previous issue and a bug in Connext DDS Micro (MICRO-2191) caused the LatencyTopic endpoints to not be correctly discovered in certain cases, making it impossible to gather latency numbers.
IDL used both old and new prefix annotations (#270) ¶
RTI Perftest IDL files used a combination of the new prefix annotations and the old ones. This inconsistency has been fixed.
This fix imposes a restriction (already existing) on the minimum version for which RTI Perftest can be compiled (Connext DDS Professional 5.3.1).
DTLS transport did not work in Traditional/Modern C++ by default (#281) ¶
By default, the RTI Perftest Subscriber would fail when the transport was set to DTLS due to an incorrect private key on the Subscriber side. This issue has been resolved.
Incorrect port calculation in RawTransport with multiples Subscribers (#283) ¶
The RawTransport port calculation has been fixed when there are multiples Subscribers.
Segmentation fault when finishing tests in Traditional/Modern C++ (#288) ¶
The use of -useReadThread (which internally would imply using waitsets) caused a segmentation fault at the end of the test (when RTI Perftest deleted the entities). This problem affected Traditional and Modern C++ implementations. This problem has been fixed.
-sleep option not working correctly with values larger than 1 second (#299) ¶
The calculation of the seconds and nanoseconds to sleep between sending samples when using the -sleep command-line option was not correct for both the Traditional and the Modern C++ implementations. This issue has been resolved.
Error in Modern C++ when using FlatData (#306) ¶
An error was found when testing FlatData in the Modern C++ API implementation. The write() call would fail to find the right instance handle. This issue would show up in any of the three topics and would cause an exception. This problem has been fixed.
-sendQueueSize not correctly applied to Subscriber side (#309) ¶
Even though the use of -sendQueueSize was modified to be allowed on the Subscriber side for the pong Datawriter, the values for the maximum and minimum send queue size where not correctly set in the code. This issue has been fixed.
Error using Zero-Copy and checking sample consistency with waitsets (#316 and #317) ¶
In the Traditional and Modern C++ API implemetations, when using -zeroCopy + -useReadThread + -checkConsistency, Connext DDS would show:
DDS_SampleInfoSeq_get_reference:!assert index out of bounds TestDataLarge_ZeroCopy_w_FlatData_tSeq_get_reference:!assert index out of bounds DDS_DataReader_is_metp_data_consistent:ERROR: Bad parameter: sample
In the case of the Modern C++ API implementation, this problem also caused a crash. This issue has been fixed.
Code generation failure on Windows when FlatData is disabled (#319) ¶
On Windows®, a failure occurred when trying to compile an architecture without support for FlatData. This may have occurred if the RTI Connext DDS Professional version was before the inclusion of the feature or if RTI Perftest intentionally disabled FlatData in the build.bat code. The problem might also have occurred for certain embedded Windows architectures.
This issue has been resolved.
RTI_LANGUAGE_CPP_MODERN flag not propagated correctly when using build.sh script (#322) ¶
An issue has been resolved in the build.sh script that caused the RTI_LANGUAGE_CPP_MODERN define flag to not be propagated correctly when compiling. This issue did not cause a bug or wrong behavior.
-batchSize parameter not correctly written in Traditional and Modern C++ API implementations (#324) ¶
This release fixes an issue for the Traditional and Modern C++ API implementations where the parameter manager would expect -batchsize instead of -batchSize. This issue was only a problem for VxWorks® systems, where the parsing of the parameters is case-sensitive.
Performance degradation in Modern C++ when using Dynamic Data (#332) ¶
When using Dynamic Data, the Send() path always tried to clear the content of the sample prior to starting repopulating it. This should only be necesary if the sequence size changes. This issue has been fixed.
Perftest Traditional C++ API implementation did not initialize sequence (#348) ¶
In the RTI Perftest implementation of the Traditional C++ API, the sequence sent by the middleware was not being initialized. This issue has been resolved. Now the sequence is initialized to zeros.
Incorrect extenal libraries passed to cmake when compiling against Connext DDS Micro in QNX (PERF-194) ¶
When building RTI Perftest for Connext DDS Micro in QNX, the wrong external libraries
were passed to
cmake. This problem has been fixed.
Previous Release Notes¶
Release Notes 3.0.1¶
What's Fixed in 3.0.1¶
Fix Custom Types failure due to the use of Flat Data (#221)¶
Custom Types implementation was incomplete for FlatData types causing compilation errors when trying to use the feature.
This issue has been fixed and FlatData custom types can be used along with
regular custom types by using the new
--customTypeFlatData build option.
The only known limitation is that these FlatData types must be declared as mutable.
Improve message when NDDSHOME/RTIMEHOME paths are not reachable (#222)¶
RTI Perftest has improved the error message when the path provided to the NDDSHOME or RTIMEHOME are incorrect. In previous releases this could be misleading since it would claim that the path was not provided.
Release Notes 3.0¶
What's New in 3.0¶
Ability to use your own type in RTI Perftest (#33)¶
RTI Perftest now supports the ability to use your own custom type. It is possible to measure the performance of your own type.
The Custom Types feature allows you to use your own customized types instead of the one provided by RTI Perftest. It is designed in such a way that the number of changes in the code and configuration files is minimal.
RTI Perftest thread priorities can be configured via command-line parameter (#65)¶
For the Traditional and Modern C++ API Implementations, a new parameter, -threadPriorities, has been added to RTI Perftest. This parameter allows you to set the priorities on the different threads created by RTI Connext DDS and by the application itself.
This parameter accepts either three numeric values (whichever numeric values you choose) representing the priority of each of the threads or, instead, three characters representing the priorities. These characters are h (high), n (normal) and l (low). These parameters can be used as follows:
X is for the priority of the Main Thread that manages all the communication. X is also used for the Asynchronous Thread when using large data.
Y is the priority for all the receive threads. This value will be used for the Receive Thread created by RTI Connext DDS. If
-useReadThread(use waitsets) is used, Y is for the thread in charge of receiving the data.
Z is the priority for the Event and DataBase Threads created at the RTI Connext DDS level.
This feature will only work for RTI Connext DDS Professional. To see what values should be used for the different threads see the following information in the RTI Connext DDS Core Libraries Platform Notes:
The "Thread-Priority Definitions for Linux Platforms" table
The "Thread-Priority Definitions for OS X Platforms" table
The "Thread-Priority Definitions for Windows Platforms" table
Raw Transport Support (#77)¶
RTI Perftest now supports raw transport communications. This allows the application to conduct performance tests skipping the DDS protocol. The purpose of this feature is to allow the calculation of protocol overhead and time differences.
To run a test with this feature, the
-rawTransport command line option is
The Raw Transport feature is only aviable for C++ and supports two kinds of transport protocols, UDPv4 and Shared Memory.
The Raw Transport feature allows the following configurations:
Multicast (only for UDPv4)
One-to-many communication (Pub -> Sub)
Latency Test / Throughput Test
Some of the command-line parameters that exist for DDS are not supported if
-rawTransport is used.
For the command
-peer, the behavior has been modified. You can use
-peer to set a
peer address and a new optional ID:
Syntax: -peer <x.x.x.x>|<x.x.x.x:id>
If no ID is provided, it's set as zero.
You can set multiple peers; the maximum value of accepted peers is RTIPERFTEST_MAX_PEERS, which corresponds to 1024.
perftest_cpp -pub -rawTransport -peer 127.0.0.1:5 -peer 127.0.0.1:6
A new command-line parameter, -noBlockingSockets, has been added:
This parameter changes the blocking behavior of send sockets to never block.
It is only available when
-rawTransportis set with UDPv4 as the protocol.
This parameter can reduce the lost packets.
CHANGING THIS PARAMETER FROM THE DEFAULT CAN CAUSE SIGNIFICANT PERFORMANCE VARIATIONS.
Support for RTI Connext DDS Micro 3.0.0 (#78)¶
Starting with this release, RTI Perftest will have support for RTI Connext DDS Micro 3.0.0 and above.
By using the
--micro and the
--RTIMEHOME path command-line options at
compile time, RTI Perftest will generate code for RTI Connext DDS Micro and
try to compile using
cmake (the path for which can also be configured by
a command-line parameter in the build script). In this case, the
RTI Perftest executable will be placed similarly to RTI Connext DDS Professional's
executable; however, it will be named
Most RTI Perftest features are available when using RTI Connext Micro; however, some command-line parameters and options are available only for RTI Connext DDS Professional. More information about the supported parameters can be found in the Command-Line Parameters examples section.
Build HTML and PDF documentation (#94)¶
RTI Perftest's build script for Linux now offers the option to generate the HTML and PDF documentation from the .rst files in srcDoc.
Allow 3 differents addresses for -multicastAddr feature (#97)¶
In previous versions of RTI Perftest, the -multicastAddr command-line parameter only supported a single address as input. This behavior has been improved. In addition to providing only one address, this parameter also allows you to provide three different addresses for each of the three topics used by RTI Perftest (Throughput, Latency, and Announcement).
Both IPv4 and IPv6 addresses are supported and can be set together on the same input command. All the input addresses must be in multicast range.
If you specify only one address, RTI Perftest will use that one and the two consecutive ones: for example, if you give 22.214.171.124, RTI Perftest will use 126.96.36.199 + 188.8.131.52 + 184.108.40.206. The higher values supported are 220.127.116.11 for IPv4 and FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFC for IPv6.
Display in RTI Perftest's subscriber side if the type expected is large data (#123)¶
RTI Perftest requires you to specify on the subscriber side the Data Length parameter if the data to be received is larger than the MAX_SYNCHRONOUS_SIZE constant. This parameter is used to change from the regular TestData_t type to TestDataLarge_t (used for large data). However, this was not displayed anywhere in the summary shown by the subscriber.
This issue has been fixed. Now the subscriber will show a short message stating that it is expecting the large data type.
Ease the execution of RTI Perftest in VxWorks (#167)¶
In previous releases, it was not clear how to run RTI Perftest in VxWorks: each command-line parameter had to be appended to the argv array inside publisher_main and subscriber_main in perftest_publisher.cxx. This required recompiling each time the parameters changed.
This behavior has been simplified: in order to run in VxWorks, you can call the perftest_cpp_main function and receive a simple string containing all the command-line parameters.
Support RTI Perftest on Android platforms (#186)¶
Although the code for RTI Perftest is supposed to be platform-independent, it might not work out-of-the-box for mobile operating systems, since it expects to be used in a terminal.
Starting in version 3.0.0, RTI Perftest can also be compiled and used for Android platforms, using the basic graphical interface generated by rtiddsgen to print the output of the application.
Support RTI Connext DDS 6.0.0 FlatData and Zero-Copy features (#211)¶
RTI Connext DDS 6.0.0 introduces RTI FlatData language binding and Zero-Copy transfer mode over Shared Memory.
RTI FlatData reduces the number of copies made when sending a sample from a DataWriter to a DataReader from four to just two by building samples where the in-memory representation matches the wire representation.
Zero-Copy transfer mode accomplishes zero copies by using the shared memory (SHMEM) built-in transport to send 16-byte references to samples within a SHMEM segment owned by the DataWriter. This does not only reduces the latency but also makes the latency independent of the sample size.
Starting in version 3.0.0, RTI Perftest supports RTI FlatData language binding and Zero Copy transfer over Shared Memory.
This feature is not available when compiling for RTI Connext DDS Micro.
Increase send_socket_buffer_size for the UDPv4 transport¶
In order to achieve better performance with dealing with Large Data, the send_socket_buffer_size property has been modified from 500KB to 1MB in the QoS file.
What's Fixed in 3.0¶
Remove duplicate code on RTIDDSImpl when the topic name is checked (#99)¶
Each time a DataReader or DataWriter was created, the topic name was compared with all the default topic names (Throughput, Latency, Announcement), in order to get the proper QoS Profile Name. This led to a lot of duplicated code on the createWriter and createReader functions.
This behavior has been fixed by creating a new function getQoSProfileName that accesses a new map, _qoSProfileNameMap, which contains the three topic names and their corresponding profile names.
Fix incorrect parsing of the -executionTime command-line parameter (#102)¶
In previous releases, for the Traditional and Modern C++ API implementations, the -executionTime <sec> command-line parameter would ignore any invalid value for the <sec> parameter without any notification to the user.
This behavior has been fixed and unified for all the API implementations, which now show an error when finding a wrong value for the <sec> option.
Ensure compatibility for the Traditional and Modern C++ Implementation (#114)¶
Some of the changes added for #55 broke compatibility when compiling certain platforms with no support for C++11. This issue has been fixed.
Wait for all perftest executions to finish before finalizing participants factory (#120)¶
In VxWorks kernel mode, static objects are shared across different runs of the same RTI Perftest libraries/executables, and changes in one run would cause changes in the other. When finalizing the Participant Factory after deleting the participant of an RTI Perftest execution, an error about outstanding participants in the domain was printed. This error occurred because the Participant Factory was shared accross runs in the same machine; therefore, participants from other executions prevented the factory from being properly finalized.
This issue has been fixed by checking that the factory is empty of participants before finalizing it.
Fix incorrect behavior for the -unbounded command-line option when not using large data (#125)¶
In the 2.4 release, a regression was introduced: the use of -unbounded caused a failure when using datasizes from 28 to 63000 bytes. This issue has been resolved.
Update maximum sample size accepted by RTI Perftest (#136)¶
The maximum size of a sample accepted by RTI Perftest has been updated to be compatible with RTI Connext DDS 6.0.0. This new value is 2147482620 bytes.
Add option to enable latency measurements in machines with low resolution clocks (#162)¶
If the machine where RTI Perftest is being executed has a low resolution clock, the regular logic might not report accurate latency numbers. Therefore, the application now implements a simple solution to get a rough estimate of the latency.
Before sending the first sample, RTI Perftest records the time; right after receiving the last pong, the time is recorded again. Under the assumption that the processing time is negligible, the average latency is calculated as half the time taken divided by the number of samples sent.
This calculation only makes sense if latencyCount = 1 (Latency Test), since it assumes that every single ping is answered.
Stop using alarm function to schedule functions since it is deprecated (#164)¶
When using -executionTime <seconds> parameter, internally, RTI Perftest was scheduling a function call by using it as a handler when an ALARM signal was received. This ALARM signal was set to be signaled in the amount of seconds specified by the executionTime parameter using the alarm() function available in POSIX systems; however, this alarm function has been deprecated or is even missing in some of RTI's supported platforms.
This issue has been fixed by using a thread that sleeps for the amount of seconds specified, after which the thread calls the desired function.
Remove the use of certain static variables that caused issues in VxWorks kernel mode (#166)¶
When running two or more instances of RTI Perftest within the same machine in VxWorks kernel mode, some parameters were shared between instances. This sharing happened because static variables are shared across different runs of the same RTI Perftest libraries/executables, and changes in one run would cause changes in the other. This issue has ben fixed.
Use Connext DDS implementation for the milliSleep method in C++ (#180)¶
PerftestClock::milliSleep() method has been modified in the Traditional and Modern C++ implementations
to always use the RTI Connext DDS sleep functionality.
This change makes the sleep functionality independent of the operating system.
At the same time, the code has been improved to avoid overflowing the time of the sleeping period.
Fix Bottleneck due to low SHMEM QoS resources settings¶
The QoS setting dds.transport.shmem.builtin.received_message_count_max was set based on the OS default receive buffer size for SHMEM and the size of the payload sent on a sample.
The resulting allocated space was too small and therefore the throughput was being limited.
The dds.transport.shmem.builtin.received_message_count_max and dds.transport.shmem.builtin.receive_buffer_size QoS settings have been increased to avoid this bottleneck.
Release Notes 2.4¶
What's New in 2.4¶
Summary of test parameters printed before RTI Perftest runs (#46)(#67)¶
RTI Perftest provides a great number of command-line parameters, plus the option of using the xml configuration file for modifying the RTI Connext DDS QoS. This could lead to some confusion with regards to the test that will run when executing the application.
In order to make this clear, RTI Perftest now shows a summary at the beginning of the test with most of the relevant parameters being used for thetest. The summary is done for both Publisher and Subscriber sides.
Added command-line parameters to simplify single API build (#50)¶
RTI Perftest Build scripts now support building a single API using the following command-line parameters:
--java-build --cpp03-build --cpp-build --cs-build
Added RTI Perftest and RTI Connext DDS information at beginning of test (#54)¶
RTI Perftest now prints at the beginning of the test its version and the version of RTI Connext DDS against which RTI Perftest is compiled.
Automatically regenerate qos_string.h file if perftest_qos_profiles.xml is modified (#63)¶
RTI Perftest now udpates the qos_string.h file with the content of perftest_qos_profiles.xml every time RTI Perftest is built for C++ and C++ New PSM.
Enable batching for Throughput-Test mode with 8kB value (#76)(#67)¶
As part of the enhanced out-of-the-box experience for RTI Perftest, batching is now enabled by default for throughput tests where the datalen is equal or smaller to 4kB. In such case, the Batch size value will be set to 8kB.
Batching will be disabled automatically if LatencyTest mode is set or if the -batchSize is lower than two times the -dataLen.
Show percentage of packets lost in subscriber side output (#81)¶
RTI Perftest now displays the percentage of lost packets in addition to the total number of packets lost. This percentage is displayed once per second with the rest of the statistics in the Subscriber side, as well as at the end of the test.
What's Fixed in 2.4¶
Improved Dynamic Data Send() and Receive() operations (#55)¶
The Dynamic Data Send() and Received() functions have been optimized reducing the time spent setting and getting the samples.
As a result of these optimizations RTI Perftest now minimizes the time employed in application-related tasks, therefore maximizing the time spent sending and receiving calls. This allows a fair comparison between Dynamic Data results and Generated Type-Code Data results.
Corrected Latency maximum calculation in certain scenarios with low resolution clocks (#58)¶
In previous releases, if the clock provided by the system had low resolution, many of the Latency times calculated by sending and receiving back samples would end up being 0us. RTI Perftest would assume in those cases that this value was an initialization value and it would reset the maximum latency.
This problem has been fixed. RTI Perftest now correctly supports the case where the latency reported is 0us by not using it as a control/reset value.
Improved behavior when using the -scan command-line option and Best Effort (#59)¶
In previous releases, the use of -scan in combination with Best Effort would result in sending too many times certain packets used to signal the change of sizes and the initialization and finalization of the test.
In certain scenarios -- mostly local tests where RTI Perftest Publishers and Subscribers were in the same machine and that machine had limitations with respect to the CPU -- this problem would cause the Scan test to not work properly, since the Publisher would make use of the CPU and network intensively, potentially starving the Subscriber side and making the test hang.
This problem has been fixed.
Reduced memory consumption on Subscriber side (#74)¶
The initial_samples value for the ThroughputQoS QoS profile has been updated to a lower number. This profile is used by the Subscriber side to create a DDS DataWriter.
This value has been updated in order to decrease memory consumption on the RTI Perftest Subscriber side.
In order to ensure that this change does not affect the overall performance of the application, the initial burst of samples sent by the Publisher side has been also reviewed. The Publisher side now always send a burst big enough to ensure that the allocations in both Publisher and Subscriber sides are done before the test starts.
Fixed compilation in Certain VxWorks platforms (#93)¶
In previous releases the Traditional and Modern C++ implementations were tried to include sys/time.h, but this file might not exist in certain operating systems including certain VxWorks platforms.
This issue has been fixed, since this library is not needed in the VxWorks platforms, RTI Perftest excludes sys/time.h when compiling for VxWorks.
Migrate RTI Routing Service XML configuration to 6.0.0¶
The RTI Routing Service configuration file has been updated and it is now supported in the version 6.0.0.
Issues compiling in certain Platforms due to static variable transportConfigMap (#161)¶
In certain architectures the use of the static variable: static std::map<std::string, TransportConfig> transportConfigMap would cause some issues when referencing it from a static context.
In order to avoid this issue, the variable is not static anymore and it will be initialized in the constructor of the PerftestTransport class.
This issue affected both the Traditional and Modern C++ implementations.
Release Notes 2.3.2¶
Release Notes 2.3.1¶
What's Fixed in 2.3.1¶
Keep Duration not configurable when using -noPositiveAcks (#39)¶
In previous versions, if the -noPositiveAcks command line parameter was provided the Disable Positive Acks Keep Duration QoS setting would be ignored both when provided via XML configuration or via command line parameter (deprecated option), instead, RTI Perftest would always use the default value set up via code.
This behavior has been fixed. We also took the oportunity to simplify and clarify the XML configurations when disabling positive Acks.
Show message in sumary when -multicast is present but it wont be used (#44)¶
In previous versions, if the -multicast command-line parameter was provided but the transport didn't allow the use of multicast, it would fail silently and no indication would be shown by RTI Perftest.
Starting from this release, the use of multicast will be shown in the transport summary at the beginning of the test, and a message will be printed stating if multicast could not be applied for the transport.
The -multicast parameter has been divided into 2: -multicast which enables multicast for a given transport using a set of default multicast addresses and -multicastAddr <address> which enables multicast and sets the multicast IPs to be the one provided.
Update Security Certificates and Governance files (#49)¶
The Security Certificates and Governance files used when enabling security options in RTI Perftest have been regenerated and signed again, since they had expired.
The script used for updating the files has been improved to generate certificates valid for a longer period of time (from one year to ten years).
Segmentation fault when using multiple publishers¶
In previous versions, in scenarios with multiple publishers, every RTI Perftest publisher application with -pidMultiPubTest different than 0 would crash in the process of printing the latency statistics. This behavior has been fixed.
Release Notes 2.3¶
What's New in 2.3¶
Added Support for DTLS¶
RTI Perftest now supports the use of the DTLS plugin. The out of the
box configuration allows the application to work using DTLS by just specifying
-transport DTLS, however we also included command-line parameters to specify:
The Certificates and the public/private keys.
See the Test Parameters section for more information about how to configure DTLS.
Added Support for TLS¶
RTI Perftest now supports the use of TLS on top of the TCP plugin.
The out-of-the-box configuration allows the application to work using TLS
by just specifying
-transport TLS, however we also included command-line
parameters to specify:
The Certificates and the public/private keys.
The Server Bind Port.
The use of WAN mode.
The use of a Public Address.
See the Test Parameters section for more information about how to configure TLS.
Enhanced TCP Functionalities¶
As part of the changes for adding support for TLS, more functionalities have been included for TCP, including options to specify:
The Server Bind Port.
The use of WAN mode.
The use of a Public Address.
See the Test Parameters section for more information about how to configure TCP.
Added Support for WAN¶
RTI Perftest now supports the use of the WAN transport plugin.
In order to use this transport the command-line option
-transport WAN needs
to be specified, we also included command-line parameters to specify:
The WAN Server Address and Port
The WAN ID.
The Certificates and the public/private keys in case of using Secure WAN.
The Server Bind Port.
See the Test Parameters section for more information about how to configure WAN.
Default Values for
Transport can be Modified via XML¶
Starting with this release, the Reliability and Transport settings are not set via code for the different languages, but are set in the XML profile. This allows you to easily modify these settings without needing to recompile.
These settings can still be modified via command-line parameters.
Added Command-Line Parameter
Starting with this release, the QoS Library can be selected using the new
This command-line option, combined with
-qosFile, allows you to use custom
QoS profiles that inherit from the default one (
A simple example is provided here:
Changed Name for Command-Line Option from
Starting with this release, the
-qosProfile command-line parameter has been
-qosFile to better reflect its use.
-scan Command-line Parameter Functionality¶
In the previous release, using
-scan caused RTI Perftest to execute with
a predefined set of values for -dataLen, and with execution durations related to
the number of latency pings. This behavior has been changed. Now
you to specify a set of -datalen sizes to be used (or you can use the default set).
In addition, the value specified for the '-executionTime' parameter is now used
for each execution during the scan, regardless of the number of latency pings.
-batchSize at the same time as
-scan and not using large
data, the same batch size will be applied to all the data sizes being used by
Deprecated Some Command-Line Parameters¶
To simplify the number of parameters RTI Perftest accepts, we reviewed and deprecated some parameters. These parameters will still work for this release, but they will be deleted or altered for future ones.
The associated value will be the same as the number of instances.
The value will be set in the QoS in the case of using -noPositiveAcks.
The resulting command can be used as
-multicast keeping its original behavior
-multicast <address>, which will enable multicast and use <address> as
the multicast receive address.
The default behavior is to not use multicast, so this command-line option was redundant.
allocator_threshold, since it better reflects
the use of the value. The new default is
2 * dataLen up to
The associated documentation has also been improved.
These parameters can still be changed via XML.
This option made no sense after the -sleep and -pubRate alternatives were implemented.
What's Fixed in 2.3¶
Failure when Using
-peer Command-Line Parameter for C#¶
-peer option in the C# implementation caused
RTI Perftest to fail due to an issue reserving memory. This behavior
has been fixed.
-nic Command-Line Parameter not Working when Using UDPv6 Transport¶
-nic command-line parameter was not taken into account when
using the UDPv6 transport. This behavior has been fixed.
Failure when Using -batchSize or -enableTurboMode if -dataLen Exceeded Async Publishing Threshold¶
-batchSize along with a
-dataLen value greater than the asynchronous
publishing threshold caused the application to show an error and exit.
Starting with this release, the
-batchSize option will be ignored in this scenario
(and a warning message displayed).
This change (ignoring
-batchSize) won't be applied if you explicitly set
in this case, the behavior will remain the same as before (it will show an error and exit).
This change also applies to the use of
Issues when Finishing Performance Test or Changing Sample Size¶
In order to make the mechanism to finish the performance test or change sample sizes
more robust, we now use the
Announcement topic on the Subscriber side to notify
the Publisher side of the arrival of special samples sent to signal a change of sample
size or to signal that the test is finishing. In previous releases, this process was
not reliable and may have caused hangs in certain scenarios.
Unreliable Behavior Finishing Tests when Using ContentFilteredTopic (CFT)¶
In previous releases when using CFTs, in order to finish a test, the Publisher needed to send as many samples signaling that the test is finishing as the number of instances that were being used by the test (1 sample per instance). This could result in a very long process, and in scenarios where the reliability was set to BEST_EFFORT, in a higher chance of losing one of those samples, making the test hang.
This behavior has been modified by using a specific key for the signaling messages, so they are not filtered by the CFTs.
Release Notes v2.2¶
What's New in 2.2¶
Added command-line parameters "-asynchronous" and "-flowController
In previous releases Asynchronous Publishing was only enabled for the DataWriters when the samples were greater than 63000 bytes and in such case, RTI Perftest would only use a custom flow controller defined for 1Gbps networks.
This behavior has been modified: Starting with this release,
Asynchronous Publishing will be activated if the samples to send are
bigger than 63000 bytes or if the
parameter is used. In that case, RTI Perftest will use the
flow controller. However, now you can change this behavior by specifying
-flowController option, which allows you to specify if you want
to use the default flow controller, a 1Gbps flow controller, or a 10Gbps
Improved "-pubRate" command-line parameter capabilities¶
In previous releases the "-pubRate" command-line option would only use
spin function to control the publication rate, which could have
negative effects related with high CPU consumption for certain
scenarios. Starting with this release, a new modifier has been added to
this option so it is possible to use the both "spin" and "sleep" as a
way to control the publication rate.
Added command-line parameter to get the CPU consumption of the process¶
Starting with this release, it is possible to display the CPU
consumption of the RTI Perftest process by adding the Command-Line
Better support for large data samples¶
Prior to this release, the maximum sample size allowed by RTI Perftest
was set to 131072 bytes. The use of bigger sizes would imply changes in
perftest.idl file and source code files. Starting with this
release, the maximum data length that RTI Perftest allows has
increased to 2,147,483,135 bytes, which corresponds to 2 Gbytes - 512
bytes - 8 bytes, the maximum data length that RTI Connext DDS can
The sample size can be set via the
-dataLen <bytes> command-line
parameter. If this value is larger than 63,000 bytes RTI Perftest will
enable the use of Asynchronous Publishing and Unbounded Sequences.
It is also possible to enable the use of Unbounded Sequences or
Asynchronous Publishing independently of the sample size by specifying
the command-line parameters
unbounded <allocation_threshold> and
Added command-line parameter "-peer" to specify the discovery peers¶
In previous releases the only way to provide the Initial Peers was
either adding them to the QoS XML file or by using the environment
NDDS_DISCOVERY_PEERS. Now it is possible to use a new
-peer <address> with the peer address.
Now providing RTI Routing Service configuration files to test performance along with RTI Perftest¶
A new configuration file and wrapper script have been added for testing RTI Perftest using one or several RTI Routing Service applications in between Publisher and Subscriber. A new section has been added to the documentation with all the configuration parameters: Using RTI Perftest with RTI Routing-Service.
Changed Announcement QoS profile to use "Transient local" Durability settings¶
In previous releases, the announcement topic DataWriters and DataReaders
were set to have a
Volatile Durability QoS. In certain complex
scenarios, that could result in incorrect communication, which could
cause the RTI Perftest Publisher and Subscribers to get stuck and not
transmit data. By changing this topic to use Transient Local Durability,
these scenarios are avoided.
This should not have any effect on the latency of throughput reported by RTI Perftest (as the main Throughput and Latency topics still have the same configuration).
Added new functionality: Content Filtered Topic.¶
In previous releases the only way to provide scalability was by using
multicast and unicast. Now you can also choose which subscriber will
receive the samples by using the parameter
-cft. You can also
determine which sample will be sent by the publisher with the parameter
"-nic" command-line parameter not working when using TCP transport¶
In previous releases the
-nic command-line parameter was not taken
into account when using the TCP transport. This behavior has been fixed.
Batching disabled when sample size was greater than or equal to batch size¶
In previous releases the Batching Parameters were set unconditionally, now the Batching QoS will be only applied if the Batch size is strictly greater than the sample size.
Changed name of the "-enableTcp" option¶
In previous releases, the command-line option to use TCP for
communication was named
-enableTcpOnly. This is was inconsistent
with other transport options, so the name of the command has been
Dynamic Data not working properly when using large samples¶
In previous releases the following error could happen when using the
-dynamicData command-line parameter in conjunction with
greater than 63000 bytes:
DDS_DynamicDataStream_assert_array_or_seq_member:!sparsely stored member exceeds 65535 bytes DDS_DynamicData_set_octet_array:field bin_data (id=0) not found Failed to set uint8_t array
This error has been fixed starting in this release by resetting the members of the Dynamic Data object before repopulating it.
Release Notes v2.1¶
What's New in 2.1¶
Multicast Periodic Heartbeats when the
-multicast command-line parameter is present¶
In previous releases, the Writer side sent heartbeats via unicast even
if the command-line parameter
-multicast was present. Now heartbeats
will be sent via multicast when
-multicast is used. This change
should not affect one-to-one scenarios, but it will reduce the number of
heartbeats the Publisher side has to send in scenarios with multiple
Added command-line parameter to get the Pulled Sample Count in the Publisher side¶
-writerStats command-line parameter now enables the some extra
debug log messages shown in the Publisher side of RTI Perftest.
These messages will contain the total number of samples being "pulled"
by the Subscriber side.
Added extra logic to be able to support RTI Connext DDS 5.2.7 on Windows Systems¶
The names of the solutions generated by rtiddsgen for Windows
architectures changed in Code Generator 3.2.6 (included with RTI
Connext DDS 5.2.7). The solution name now includes the rtiddsgen
version number. Therefore the RTIPerftest's
build.bat script now
must query the rtiddsgen version and adjust the name of the generated
solutions it needs to call to compile.
This change should not be noticed by the user, as the script will automatically handle the task of determining the version of rtiddsgen.
Added command-line parameter to avoid loading QoS from xml in C++.¶
-noXmlQos option is provided to RTI Perftest it will not
try to load the QoS from the
xml file, instead it will load the QoS
from a string provided in the code. This string contains the same values
xml file provides.
This option is only present for the Modern and Traditional C++ PSM API code.
Note that changes in the
xml will be ignored if this option is
Updated Secure Certificates, Governance and Permission Files¶
Governance and Permission files have been updated to be compatible with the latest release for RTI Connext DDS, and are compatible with RTI Connext DDS 5.2.7 and greater.
If you are compiling RTI Perftest against 5.2.5, you will need to get
the certificates from the
release/2.0 branch. You can do that by
using the following git command from the top-level directory of your
git checkout release/2.0 -- resource/secure
What's Fixed 2.1¶
"--nddshome" Command-Line Option did not Work in
build.bat Script -- Windows Systems Only¶
There was an error in the
build.sh script logic when checking for
the existence of the compiler executable files. This problem has been
build.sh script did not make sure executable existed before starting compilation¶
Part of the
build.sh script logic to check the existence of the
compiler executable files was not being called properly. This issue is
high_watermark value when
sendQueueSize is set to 1¶
Setting the command-line parameter
-sendQueueSize to 1 caused RTI
Perftest to fail, since it mistakenly set the
equal to the
low_watermark. This problem has been resolved. Now the
high_watermark is always greater than the
Batching settings not correctly set in the
Settings related to batching in the XML configuration
perftest_qos_profiles.xml) were not being used. This problem has
dds.transport.shmem.builtin.received_message_count_max incorrectly set in Java code¶
was incorrectly set to 1 in every case. This erroneous behavior, which
was introduced in RTI Perftest 2.0, has been resolved.
Command-line parameter for setting the RTI Connext DDS verbosity¶
In previous releases of RTI Perftest, the RTI Connext DDS verbosity
could only be modified by using the command-line parameter
This parameter would set the verbosity to
STATUS_ALL, with no option
to select an intermediate verbosity.
This behavior has been modified. The command-line parameter
has been changed to
-verbosity, which can be followed by one of the
verbosity levels (Silent, Error, Warning, or All).
The default verbosity is Error.
Release Notes v2.0¶
What's New in 2.0¶
Platform support and build system¶
RTI Perftest 2.0 makes use of the RTI Connext DDS rtiddsgen tool in order to generate part of its code and also the makefile/project files used to compile that code.
Therefore, all the already generated makefiles and Visual Studio
solutions have been removed and now the build system depends on 2
build.sh for Linux/MacOS/QNX/VxWorks/Android systems and
build.bat for Windows systems.
RTI Perftest scripts works for every platform for which rtiddsgen can generate an example, except for those in which rtiddsgen doesn't generate regular makefiles or Visual Studio Solutions but specific project files. That is the case of Android platforms as well as the iOS ones.
Certain platforms will compile with the out of-the-box code and configurations, but further tuning could be needed in order to make the application run in the specific platform. The reason is usually the memory consumption of the application or the lack of support of the platform for certain features (like a file system).
Improved directory structure¶
RTI Perftest 2.0 directory structure has been cleaned up, having now a much more compact and consistent schema.
RTI Perftest development has been moved to a GitHub project. This will allow more frequently updates and code contributions.
The URL of the project is the following: github.com/rticommunity/rtiperftest.
RTI Perftest development and releases are now decoupled from RTI Connext DDS ones, therefore, and to avoid future numeration conflicts, RTI Perftest moved to a different numeration schema.
The compatibility between RTI Perftest versions and RTI Connext DDS
ones will be clearly stated in the release notes of every RTI Perftest
release, as well as in the top-level
Documentation is no longer provided as a PDF document, but as markdown files as well as in html format. You will be able to access to the documentation from the RTI Community page, as well as from the GitHub project.
Support for UDPv6¶
Added command-line parameter to force communication via UDPv6. By
-enableUdpv6 you will only communicate data by using the
The use of this feature will imply setting the
environment variable to (at least) one valid IPv6 address.
Support for Dynamic data¶
Added command-line parameter to specify the use of the Dynamic Data API instead of the regular rtiddsgen generated code use.
Simplified execution in VxWorks kernel mode¶
The execution in VxWorks OS kernel mode has been simplified for the
user. Now the user can make use of
publisher_main() and modify its content with all the parameters
required for the tests.
Decreased Memory Requirements for Latency Performance Test¶
The default number of iterations (samples sent by the performance test
publisher side) when performing a latency test has been updated. Before,
the default value was
100,000,000. This value was used to internally
allocate certain buffers, which imposed large memory requirements. The
new value is
10,000,000 (10 times less).
What's Fixed 2.0¶
RTI Perftest behavior when using multiple publishers¶
The previous behavior specified that an RTI Perftest Subscriber in a
scenario with multiple RTI Perftest Publishers would stop receiving
samples and exit after receiving the last sample from the RTI Perftest
pid=0. This behavior could lead into an hang state if
some RTI Perftest Publishers with different
pid were still missing
to send new samples.
The new behavior makes the RTI Perftest Subscriber wait until all the Perftest Publishers finish sending all their samples and then exit.
std::bad_alloc and Segmentation Fault in Latency Test in case of insufficient memory¶
When performing a latency performance test with traditional or modern
C++, the test tries to allocate certain arrays of unsigned longs. These
arrays can be quite large. On certain embedded platforms, due to memory
limitations, this caused a
std::bad_alloc error that was not
properly captured, and a segmentation fault. This problem has been
resolved. Now the performance test will inform you of the memory
allocation issue and exit properly.
Default Max Number of Instances on Subscriber Side Changed to
In the previous release, if you did not set the maximum number of instances on the subscriber side, it would default to one instance. Therefore the samples for all instances except the first one were lost.
The new default maximum number of instances on the subscriber side has
been changed from one to
DDS_LENGTH_UNLIMITED. You can change this
limit manually by setting the Parameter