CI: Add silent cmake SonarCloud scan
[ric-plt/lib/rmr.git] / docs / rel-notes.rst
index d244c0c..06f5f58 100644 (file)
@@ -21,6 +21,229 @@ the RMR core library was assigned odd major numbers (e.g.
 the need to leap frog versions ceased, and beginning with
 version 4.0.0, the RMR versions should no longer skip.
 
+2023 Dec 13; version 4.9.4
+------------------------------
+
+same as 4.9.3
+
+2023 Dec 12; version 4.9.3
+------------------------------
+
+Fixes for CVE-2023-40998 (RIC-989) and CVE-2023-40997 (RIC-991)
+related to incorrect parsing of RMR messages
+
+2023 Oct 4; version 4.9.2
+------------------------------
+
+Fixes some stability issues seen during route table update.
+Dont allow clean old_rtable until it's reference count is really 0.
+Added more faster recognition for connect failure so route table
+update will not stuck so long in preparing new rtable.
+rtgate lock is not needed to init and destroy continouosly.
+
+
+2023 May 28; version 4.9.1
+------------------------------
+
+Fixes IPv6 binding in RMR (RIC-985)
+
+
+2023 Feb 14; version 4.9.0
+------------------------------
+
+Added new message type for subscription delete required
+
+
+2022 Nov 10; version 4.8.5
+------------------------------
+
+Fixes for errors detected by source code scanning (RIC-939)
+
+
+2022 May 11; version 4.8.3
+------------------------------
+
+Added header definitions for config transfer messages (RIC-638)
+
+
+2022 January 17; version 4.8.2
+------------------------------
+
+Fixes routing statistics printout crash (RIC-872).
+
+
+
+2022 January 7; version 4.8.1
+------------------------------
+
+Re-enables RMR libary's module tests (RIC-861).
+Creates a new unit test for the debugging rmr rx queue API.
+Fixes some bugs and possible memory likeage in SI95 code.
+
+
+
+2021 December 2; version 4.8.0
+------------------------------
+
+Fixing memory leak in python support function (RIC-858).
+New API added for debugging rmr rx queue (RIC-838).
+
+
+
+2021 April 22; version 4.7.4
+----------------------------
+
+Beef up unit testing in SI package and fix a few static
+analysis bugs. (RIC-777)
+
+
+
+2021 April 19; version 4.7.3
+----------------------------
+
+Correct flag check bug in route table functions (RIC-777).
+
+
+
+2021 April 9; version 4.7.2
+---------------------------
+
+Ensure that route table update received from route generator
+is not applied before a full route table is received.
+
+
+
+2021 April 2; version 4.7.1
+---------------------------
+
+Correct issues found during static code analysis.
+
+
+
+2021 March 31; version 4.7.0
+----------------------------
+
+The route table collector thread will capture the current
+"offering" from the Route Manager (table generator) if the
+RMR_SEED_RT environment variable is set.
+
+
+
+2021 March 10; version 4.6.1
+----------------------------
+
+Corrected unit test "framework" to make manual testing
+easier, and to add the ability to set the code optimisation
+level via the CMake command line parameter OPT_LEVEL=n.
+
+
+
+2021 February 22; Version 4.6.0
+-------------------------------
+
+Enhanced to use millisecond based timestamps when writing log
+messages. (RIC-627)
+
+Enhanced to eliminate the reqirement that the file specified
+by the RMR_VCTL_FILE environment variable exist when RMR is
+initialised. RMR will correctly find this file if it is
+created after initialisation. Further, if the environment
+variable is not given, the user may create and populate
+/tmp/rmr.v at any time and the contents of this file will be
+used as if it were supplied via the environment variable.
+This should make debugging in existing containers easier.
+
+Enhanced to send an alarm manager when the user application
+is not receiving messages fast enough. The original messages
+written to the standard error are still generated. (RIC-204)
+
+
+
+2021 January 21; Version 4.5.2
+------------------------------
+
+Fixes the excessive TCP session bug when sending to a slow
+receiver and a related segment fault because of too many open
+file descriptors. (RIC-735)
+
+
+
+2021 January 19; Version 4.5.1
+------------------------------
+
+Version bump to work round a CI job bug preventing push of
+the 4.5.0 packages from staging to release in package cloud.
+(RIC-732)
+
+
+
+2021 January 8; Version 4.5.0
+-----------------------------
+
+Version bump for next release tracking. Corrected a potential
+locking issue in message allocation. (RIC-732)
+
+
+
+Cherry Release
+==============
+
+
+
+2020 December 4; Version 4.4.6
+------------------------------
+
+Correct a range check bug when cloning a route table in prep
+to load a new one. (RIC-720)
+
+
+
+2020 November 17; Version 4.4.5
+-------------------------------
+
+Correct bug in round robin group allocation that could lead
+to an empty group. (RIC-695)
+
+
+
+2020 November 13; Version 4.4.4
+-------------------------------
+
+Correct address memory leak in the RTE cleanup. (RIC-674)
+
+
+
+2020 November 4; Version 4.4.3
+------------------------------
+
+Correct bug introduced with race fix (4.4.0) (RIC-674)
+
+
+
+2020 November 4; Version 4.4.2
+------------------------------
+
+Changes to correct more complaints generated by a code scan.
+(RIC-673) Also addressed some sonar coverage issues with unit
+test changes.
+
+
+
+2020 November 4; Version 4.4.1
+------------------------------
+
+Changes to correct complaints generated by a code scan.
+(RIC-673)
+
+
+
+2020 November 4; Version 4.4.0
+------------------------------
+
+Changes to address a potential race condition when route
+tables arrive in quick succession. (RIC-674)
+
+
 
 2020 October 30; Version 4.3.1
 ------------------------------