1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. CAUTION: this document is generated from source in doc/src/rtd.
4 .. To make changes edit the source and recompile the document.
5 .. Do NOT make changes directly to .rst or .md files.
7 ============================================================================================
9 ============================================================================================
15 The following is a list of release highlights for the RMR
16 library. At one point in time the RMR repo also housed a
17 wrapper library with a separate version and release cycle.
18 This resulted in *leap frogging* versions for each package;
19 the RMR core library was assigned odd major numbers (e.g.
20 3.1.0). When the wrapper code was moved to a different repo
21 the need to leap frog versions ceased, and beginning with
22 version 4.0.0, the RMR versions should no longer skip.
25 2023 Feb 14; version 4.9.0
26 ------------------------------
28 Added new message type for subscription delete required
30 2022 Nov 10; version 4.8.5
31 ------------------------------
33 Fixes for errors detected by source code scanning (RIC-939)
35 2022 May 11; version 4.8.3
36 ------------------------------
38 Added header definitions for config transfer messages (RIC-638)
40 2022 January 17; version 4.8.2
41 ------------------------------
43 Fixes routing statistics printout crash (RIC-872).
47 2022 January 7; version 4.8.1
48 ------------------------------
50 Re-enables RMR libary's module tests (RIC-861).
51 Creates a new unit test for the debugging rmr rx queue API.
52 Fixes some bugs and possible memory likeage in SI95 code.
56 2021 December 2; version 4.8.0
57 ------------------------------
59 Fixing memory leak in python support function (RIC-858).
60 New API added for debugging rmr rx queue (RIC-838).
64 2021 April 22; version 4.7.4
65 ----------------------------
67 Beef up unit testing in SI package and fix a few static
68 analysis bugs. (RIC-777)
72 2021 April 19; version 4.7.3
73 ----------------------------
75 Correct flag check bug in route table functions (RIC-777).
79 2021 April 9; version 4.7.2
80 ---------------------------
82 Ensure that route table update received from route generator
83 is not applied before a full route table is received.
87 2021 April 2; version 4.7.1
88 ---------------------------
90 Correct issues found during static code analysis.
94 2021 March 31; version 4.7.0
95 ----------------------------
97 The route table collector thread will capture the current
98 "offering" from the Route Manager (table generator) if the
99 RMR_SEED_RT environment variable is set.
103 2021 March 10; version 4.6.1
104 ----------------------------
106 Corrected unit test "framework" to make manual testing
107 easier, and to add the ability to set the code optimisation
108 level via the CMake command line parameter OPT_LEVEL=n.
112 2021 February 22; Version 4.6.0
113 -------------------------------
115 Enhanced to use millisecond based timestamps when writing log
118 Enhanced to eliminate the reqirement that the file specified
119 by the RMR_VCTL_FILE environment variable exist when RMR is
120 initialised. RMR will correctly find this file if it is
121 created after initialisation. Further, if the environment
122 variable is not given, the user may create and populate
123 /tmp/rmr.v at any time and the contents of this file will be
124 used as if it were supplied via the environment variable.
125 This should make debugging in existing containers easier.
127 Enhanced to send an alarm manager when the user application
128 is not receiving messages fast enough. The original messages
129 written to the standard error are still generated. (RIC-204)
133 2021 January 21; Version 4.5.2
134 ------------------------------
136 Fixes the excessive TCP session bug when sending to a slow
137 receiver and a related segment fault because of too many open
138 file descriptors. (RIC-735)
142 2021 January 19; Version 4.5.1
143 ------------------------------
145 Version bump to work round a CI job bug preventing push of
146 the 4.5.0 packages from staging to release in package cloud.
151 2021 January 8; Version 4.5.0
152 -----------------------------
154 Version bump for next release tracking. Corrected a potential
155 locking issue in message allocation. (RIC-732)
164 2020 December 4; Version 4.4.6
165 ------------------------------
167 Correct a range check bug when cloning a route table in prep
168 to load a new one. (RIC-720)
172 2020 November 17; Version 4.4.5
173 -------------------------------
175 Correct bug in round robin group allocation that could lead
176 to an empty group. (RIC-695)
180 2020 November 13; Version 4.4.4
181 -------------------------------
183 Correct address memory leak in the RTE cleanup. (RIC-674)
187 2020 November 4; Version 4.4.3
188 ------------------------------
190 Correct bug introduced with race fix (4.4.0) (RIC-674)
194 2020 November 4; Version 4.4.2
195 ------------------------------
197 Changes to correct more complaints generated by a code scan.
198 (RIC-673) Also addressed some sonar coverage issues with unit
203 2020 November 4; Version 4.4.1
204 ------------------------------
206 Changes to correct complaints generated by a code scan.
211 2020 November 4; Version 4.4.0
212 ------------------------------
214 Changes to address a potential race condition when route
215 tables arrive in quick succession. (RIC-674)
219 2020 October 30; Version 4.3.1
220 ------------------------------
222 Changes to address code analyser scans and two bug fixes
223 identified while addressing the analysis data. (RIC-673)
227 2020 October 2; Version 4.3.0
228 -----------------------------
230 Add message types for traffic steering anomaly messages
234 2020 September 15; Version 4.2.4
235 --------------------------------
237 Add man page for the rmr_set_low_latency() function (RIC-631)
241 2020 September 15; Version 4.2.3
242 --------------------------------
244 Correct arg processing bug in rmr_rpobe (RIC-645)
248 2020 August 4; Version 4.2.2
249 ----------------------------
251 Correct bug in the rmr_probe support utility when -r option
252 is used on the command line (RIC-644)
256 2020 August 4; Version 4.2.1
257 ----------------------------
259 Add additional environment variable dump if RMR_LOG_VLEVEL
264 2020 August 3; Version 4.2.0
265 ----------------------------
267 Add support for the RMR_RTREQ_FREQ environment variable to
268 control the request frequency for a new route table (default
269 5s if not supplied). (RIC-630)
273 2020 July 21; Version 4.1.4
274 ---------------------------
276 Fix bug in SI95 -- possible use of pointer after free
281 2020 July 9; version 4.1.3
282 --------------------------
284 Allow RTS messages to be sent before the arrival of the
285 initial route table. Calls to RTS (heart beat responses)
286 prior to the initial route table load could cause a crash if
287 a framework blindly assumes that RTS is valid. (RIC-589)
291 2020 June 22; version 4.1.2
292 ---------------------------
294 Fix typo in RIC Message header file.
296 Add document for message type constants and the scripts which
301 2020 June 22; version 4.1.1
302 ---------------------------
304 Add new message types to RIC header file for
306 RIC_ALARM_QUERY (111)
308 RAN_E2_RESET_REQ (12008)
309 RAN_E2_RESET_RESP (12009)
313 2020 June 18; version 4.1.0
314 ---------------------------
316 Bump version minor to move away from 4.0.* which will bump
317 for any patches applied back to bronze.
319 Add magic C++ goo to symtab header file allowing C++ xAPPs to
320 use the symbol table directly.
329 2020 May 06; version 4.0.5
330 --------------------------
332 Fix the bug in SI95 receive message management semaphore
333 count issue. (RIC-355)
337 2020 April 29; version 4.0.4
338 ----------------------------
340 Fix the traffic steering message type constants (again)
345 2020 April 28; version 4.0.3
346 ----------------------------
348 Fix sonar flagged bugs (RIC-78)
352 2020 April 24; version 4.0.2
353 ----------------------------
355 Correct bug in SI95 transport header length validation
360 2020 April 22; version 4.0.1
361 ----------------------------
363 Correct message type constant for Traffic Steering
364 predication (RIC-342)
368 2020 April 21; version 4.0.0
369 ----------------------------
371 The NNG based libraries are no longer included in the RMR
372 packages. This is considered a breaking change as NNG will
373 not be supported by default. It is still possible to build
374 with RMR-NNG libraries, but that is the exception. The API
375 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
376 means that the underlying transport mechanism is limited only
379 The rmr_rcv_specific() function has been deprecated as it was
380 necessary only for NNG and Nanomsg support. Its use should be
385 2020 April 20; version 3.8.2
386 ----------------------------
388 Fix bug which was preventing an instance receiving dynamic
389 route table updates. (RIC-336)
393 2020 April 20; version 3.8.1
394 ----------------------------
396 Add user guide which replaces the concatenation of man pages
401 2020 April 17; version 3.8.0
402 ----------------------------
404 Add safe connect to avoid potential connect bug on Linux
407 Change debugging in route table collector to avoid possible
408 segment fault when in level 2 debug (RIC-335)
412 2020 April 15; version 3.7.4
413 ----------------------------
415 Add missing message type to header file (RIC-334)
419 2020 April 14; version 3.7.3
420 ----------------------------
422 Fix bug in rmr_call() when using SI95 (RIC-333)
426 2020 April 10; version 3.7.2
427 ----------------------------
429 Fix bug related to static route table only mode (RIC-331)
433 2020 April 9; version 3.7.1
434 ---------------------------
436 The max length restriction for receiving messages when using
437 SI95 has been removed. The length supplied during
438 initialisation is used as the "normal maximum" and default
439 buffer allocation size, but messages arriving which are
440 larger are accepted. (RIC-309)
444 2020 April 7; version 3.7.0
445 ---------------------------
447 The health check support programme was renamed to rmr_probe
452 2020 April 6; version 3.6.6
453 ---------------------------
455 Correct bug in SI95 address conversion module (RIC-327)
456 Correct bug in SI initialisation module
460 2020 April 2; version 3.6.5
461 ---------------------------
463 Correct potential nil pointer use when examining interfaces
464 for use as a listen target (RIC-307)
468 2020 April 1; version 3.6.4
469 ---------------------------
471 Correct potential nil pointer use in the NNG interface
472 (RIC-303) Correct issue preventing CI build without a
477 2020 March 30; version 3.6.3
478 ----------------------------
480 Correct the max receive message size constant in rmr.h
485 2020 March 23; version 3.6.2
486 ----------------------------
488 Fix message initialisation bug when pulling a message from
493 2020 March 19; version 3.6.1
494 ----------------------------
496 Fix problem with RPM package install
500 2020 March 18; version 3.6.0
501 ----------------------------
503 Add message types to support traffic steering
507 2020 March 16; version 3.5.2
508 ----------------------------
510 Correct bug in the meid table parser that prevented the
511 ack/nack of meid tables (RIC-273)
515 2020 March 10; version 3.5.1
516 ----------------------------
518 Add missing health check message types.
522 2020 March 9; version 3.5.0
523 ---------------------------
525 Added new wormhole send function: rmr_wh_call().
529 2020 March 6; version 3.4.0
530 ---------------------------
532 Add new wormhole state function: rmr_wh_state().
536 2020 March 5; Version 3.3.1
537 ---------------------------
539 Correct several "bugs" identified by automatic code analysis.
543 2020 March 4; Version 3.3.0
544 ---------------------------
546 Add SI95 based unit testing Health check support binary added
547 (reason for minor bump)
551 2020 February 26; version 3.2.5
552 -------------------------------
554 Fix source address bug in SI95 receive/send funcitons. Fix
555 threading issues involving session disconnection in SI95
556 Remove unused SI95 status variable.
560 2020 February 24; version 3.2.4
561 -------------------------------
563 Fix meid bug (RIC-220) causing core dump.
567 2020 February 21; version 3.2.3
568 -------------------------------
570 Add meid routing support to the SI95 interface.
574 2020 February 20; version 3.2.2
575 -------------------------------
577 Fix receive thread related core dump (ring early unlock).
581 2020 February 19; version 3.2.1
582 -------------------------------
584 Added missing message types (E2-Setup)
588 2020 February 18; version 3.2.0
589 -------------------------------
591 Added support for new Route Manager and it's ability to
592 accept a request for table update.
596 2020 February 14; version 3.1.3
597 -------------------------------
599 Fix bug in SIsend which was causing a core dump in some cases
600 where the application attempted to send on a connection that
601 had disconnected. (RIC-207).
605 2020 February 6; version 3.1.2
606 ------------------------------
608 Fix disconnection detection bug in interface to SI95.
612 2020 January 31; verison 3.1.1
613 ------------------------------
615 Allow route table thread logging to be completely disabled
616 when logging is turned off.
620 2020 January 26; verison 3.1.0
621 ------------------------------
623 First step to allowing the user programme to control messages
624 written to standard error. Introduces the rmr_set_vlevel()
625 function, and related environment variable.
629 2020 January 24; verison 3.0.5
630 ------------------------------
632 Fix bug in SI95 with receive buffer allocation.
636 2020 January 23; verison 3.0.4
637 ------------------------------
639 Fix bug in SI95 causing excessive CPU usage on poll.
643 2020 January 22; verison 3.0.3
644 ------------------------------
646 Enable thread support for multiple receive threads.
650 2020 January 21; verison 3.0.2
651 ------------------------------
653 Fix bug in SI95 (missing reallocate payload function).
657 2020 January 20; verison 3.0.1
658 ------------------------------
660 Enable support for dynamic route table updates via RMR
665 2020 January 16; version 3.0.0
666 ------------------------------
668 Introduce support for SI95 transport library to replace NNG.
669 (RMR library versions will use leading odd numbers to avoid
670 tag collisions with the wrapper tags which will use even
675 2019 December 9; version 1.13.1
676 -------------------------------
678 Correct documentation and missing rel-notes update for RTD.
682 2019 December 6; version 1.13.0
683 -------------------------------
685 Add ability to route messages based on the MEID in a message
686 combined with the message type/subscription-ID.
695 2019 November 14; version 1.11.1
696 --------------------------------
698 Fix bug in payload reallocation function; correct length of
699 payload was not always copied.
703 2019 November 13; version 1.12.1
704 --------------------------------
706 New message type constants added to support A1.
710 2019 November 4; version 1.11.0
711 -------------------------------
713 Version bump to move away from the 1.10.* to distinguish
714 between release A and the trial.
718 2019 November 7; version 1.12.0
719 -------------------------------
721 Version cut to support continued development for next release
722 preserving the 1.11.* versions for release 1 (Amber) and
727 2019 October 31; version 1.10.2
728 -------------------------------
730 Provide the means to increase the payload size of a received
731 message without losing the data needed to use the
732 rmr_rts_msg() funciton.
736 2019 October 21; version 1.10.1
737 -------------------------------
739 Fix to prevent null message buffer from being returned by the
740 timeout receive function if the function is passed one to
745 2019 October 21; version 1.10.1
746 -------------------------------
748 Add periodic dump of send count info to stderr.
752 2019 September 27; version 1.9.0
753 --------------------------------
755 Python bindings added receive all queued function and
756 corrected a unit test
760 2019 September 25; version 1.8.3
761 --------------------------------
763 Correct application level test issue causing timing problems
764 during jenkins verification testing at command and merge
766 Handle the NNG connection shutdown status which may now be
767 generated when a connection throug a proxy is reset.
771 2019 September 25; version 1.8.2
772 --------------------------------
774 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
778 2019 September 19; version 1.8.1
779 --------------------------------
781 Correct missing constant for wrappers.
785 2019 September 19; version 1.8.0
786 --------------------------------
788 New message types added:
789 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
793 2019 September 17; version 1.7.0
794 --------------------------------
796 Initial connection mode now defaults to asynchronous. Set
797 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
798 invoked to revert to synchronous first TCP connections.
799 (Recovery connection attempts have always been asynchronous).
803 2019 September 3; version 1.6.0
804 -------------------------------
806 Fix bug in the rmr_rts_msg() function. If a return to sender
807 message failed, the source IP address was not correctly
808 adjusted and could cause the message to be "reflected" back
809 to the sender on a retry.
811 Added the ability to set the source "ID" via an environment
812 var (RMR_SRC_ID). When present in the environment, the string
813 will be placed in to the message header as the source and
814 thus be used by an application calling rmr_rts_smg() to
815 return a response to the sender. If this environment variable
816 is not present, the host name (original behaviour) is used.
820 2019 August 26; version 1.4.0
821 -----------------------------
823 New message types were added.
827 2019 August 16; version 1.3.0
828 -----------------------------
830 New mesage types added.
834 2019 August 13; version 1.2.0 (API change, non-breaking)
835 --------------------------------------------------------
837 The function rmr_get_xact() was added to proide a convenient
838 way to extract the transaction field from a message.
842 2019 August 8; version 1.1.0 (API change)
843 -----------------------------------------
845 This change should be backward compatable/non-breaking A new
846 field has been added to the message buffer (rmr_mbuf_t). This
847 field (tp_state) is used to communicate the errno value that
848 the transport mechanism might set during send and/or receive
849 operations. C programmes should continue to use errno
850 directly, but in some environments wrappers may not be able
851 to access errno and this provides the value to them. See the
852 rmr_alloc_msg manual page for more details.
856 2019 August 6; version 1.0.45 (build changes)
857 ---------------------------------------------
859 Support for the Nanomsg transport library has been dropped.
860 The library librmr.* will no longer be included in packages.
862 Packages will install RMR libraries into the system preferred
863 target directory. On some systems this is /usr/local/lib
864 and on others it is /usr/local/lib64. The diretory is
865 determined by the sytem on which the package is built and
866 NOT by the system installing the package, so it's possible
867 that the RMR libraries end up in a strange location if the
868 .deb or .rpm file was generated on a Linux flavour that
869 has a different preference than the one where the package
874 2019 August 6; version 1.0.44 (API change)
875 ------------------------------------------
877 Added a new message type constant.
881 2019 July 15; Version 1.0.39 (bug fix)
882 --------------------------------------
884 Prevent unnecessary usleep in retry loop.
888 2019 July 12; Version 1.0.38 (API change)
889 -----------------------------------------
891 Added new message types to RIC_message_types.h.
895 2019 July 11; Version 1.0.37
896 ----------------------------
899 librmr and librmr_nng
900 - Add message buffer API function rmr_trace_ref()
901 (see rmr_trace_ref.3 manual page in dev package).
905 2020 April 8; Version n/a
906 -------------------------
908 RMR Python moved to Python Xapp Framework
909 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
913 2020 February 29; Version 2.4.0
914 -------------------------------
916 Add consolidated testing under CMake Add support binary for
917 health check (SI95 only)
921 2020 February 28; Version 2.3.6
922 -------------------------------
924 Fix bug in Rt. Mgr comm which prevented table ID from being
925 sent on ack message (RIC-232).