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 2021 April 22; version 4.7.4
26 ----------------------------
28 Beef up unit testing in SI package and fix a few static
29 analysis bugs. (RIC-777)
33 2021 April 19; version 4.7.3
34 ----------------------------
36 Correct flag check bug in route table functions (RIC-777).
40 2021 April 9; version 4.7.2
41 ---------------------------
43 Ensure that route table update received from route generator
44 is not applied before a full route table is received.
48 2021 April 2; version 4.7.1
49 ---------------------------
51 Correct issues found during static code analysis.
55 2021 March 31; version 4.7.0
56 ----------------------------
58 The route table collector thread will capture the current
59 "offering" from the Route Manager (table generator) if the
60 RMR_SEED_RT environment variable is set.
64 2021 March 10; version 4.6.1
65 ----------------------------
67 Corrected unit test "framework" to make manual testing
68 easier, and to add the ability to set the code optimisation
69 level via the CMake command line parameter OPT_LEVEL=n.
73 2021 February 22; Version 4.6.0
74 -------------------------------
76 Enhanced to use millisecond based timestamps when writing log
79 Enhanced to eliminate the reqirement that the file specified
80 by the RMR_VCTL_FILE environment variable exist when RMR is
81 initialised. RMR will correctly find this file if it is
82 created after initialisation. Further, if the environment
83 variable is not given, the user may create and populate
84 /tmp/rmr.v at any time and the contents of this file will be
85 used as if it were supplied via the environment variable.
86 This should make debugging in existing containers easier.
88 Enhanced to send an alarm manager when the user application
89 is not receiving messages fast enough. The original messages
90 written to the standard error are still generated. (RIC-204)
94 2021 January 21; Version 4.5.2
95 ------------------------------
97 Fixes the excessive TCP session bug when sending to a slow
98 receiver and a related segment fault because of too many open
99 file descriptors. (RIC-735)
103 2021 January 19; Version 4.5.1
104 ------------------------------
106 Version bump to work round a CI job bug preventing push of
107 the 4.5.0 packages from staging to release in package cloud.
112 2021 January 8; Version 4.5.0
113 -----------------------------
115 Version bump for next release tracking. Corrected a potential
116 locking issue in message allocation. (RIC-732)
125 2020 December 4; Version 4.4.6
126 ------------------------------
128 Correct a range check bug when cloning a route table in prep
129 to load a new one. (RIC-720)
133 2020 November 17; Version 4.4.5
134 -------------------------------
136 Correct bug in round robin group allocation that could lead
137 to an empty group. (RIC-695)
141 2020 November 13; Version 4.4.4
142 -------------------------------
144 Correct address memory leak in the RTE cleanup. (RIC-674)
148 2020 November 4; Version 4.4.3
149 ------------------------------
151 Correct bug introduced with race fix (4.4.0) (RIC-674)
155 2020 November 4; Version 4.4.2
156 ------------------------------
158 Changes to correct more complaints generated by a code scan.
159 (RIC-673) Also addressed some sonar coverage issues with unit
164 2020 November 4; Version 4.4.1
165 ------------------------------
167 Changes to correct complaints generated by a code scan.
172 2020 November 4; Version 4.4.0
173 ------------------------------
175 Changes to address a potential race condition when route
176 tables arrive in quick succession. (RIC-674)
180 2020 October 30; Version 4.3.1
181 ------------------------------
183 Changes to address code analyser scans and two bug fixes
184 identified while addressing the analysis data. (RIC-673)
188 2020 October 2; Version 4.3.0
189 -----------------------------
191 Add message types for traffic steering anomaly messages
195 2020 September 15; Version 4.2.4
196 --------------------------------
198 Add man page for the rmr_set_low_latency() function (RIC-631)
202 2020 September 15; Version 4.2.3
203 --------------------------------
205 Correct arg processing bug in rmr_rpobe (RIC-645)
209 2020 August 4; Version 4.2.2
210 ----------------------------
212 Correct bug in the rmr_probe support utility when -r option
213 is used on the command line (RIC-644)
217 2020 August 4; Version 4.2.1
218 ----------------------------
220 Add additional environment variable dump if RMR_LOG_VLEVEL
225 2020 August 3; Version 4.2.0
226 ----------------------------
228 Add support for the RMR_RTREQ_FREQ environment variable to
229 control the request frequency for a new route table (default
230 5s if not supplied). (RIC-630)
234 2020 July 21; Version 4.1.4
235 ---------------------------
237 Fix bug in SI95 -- possible use of pointer after free
242 2020 July 9; version 4.1.3
243 --------------------------
245 Allow RTS messages to be sent before the arrival of the
246 initial route table. Calls to RTS (heart beat responses)
247 prior to the initial route table load could cause a crash if
248 a framework blindly assumes that RTS is valid. (RIC-589)
252 2020 June 22; version 4.1.2
253 ---------------------------
255 Fix typo in RIC Message header file.
257 Add document for message type constants and the scripts which
262 2020 June 22; version 4.1.1
263 ---------------------------
265 Add new message types to RIC header file for
267 RIC_ALARM_QUERY (111)
269 RAN_E2_RESET_REQ (12008)
270 RAN_E2_RESET_RESP (12009)
274 2020 June 18; version 4.1.0
275 ---------------------------
277 Bump version minor to move away from 4.0.* which will bump
278 for any patches applied back to bronze.
280 Add magic C++ goo to symtab header file allowing C++ xAPPs to
281 use the symbol table directly.
290 2020 May 06; version 4.0.5
291 --------------------------
293 Fix the bug in SI95 receive message management semaphore
294 count issue. (RIC-355)
298 2020 April 29; version 4.0.4
299 ----------------------------
301 Fix the traffic steering message type constants (again)
306 2020 April 28; version 4.0.3
307 ----------------------------
309 Fix sonar flagged bugs (RIC-78)
313 2020 April 24; version 4.0.2
314 ----------------------------
316 Correct bug in SI95 transport header length validation
321 2020 April 22; version 4.0.1
322 ----------------------------
324 Correct message type constant for Traffic Steering
325 predication (RIC-342)
329 2020 April 21; version 4.0.0
330 ----------------------------
332 The NNG based libraries are no longer included in the RMR
333 packages. This is considered a breaking change as NNG will
334 not be supported by default. It is still possible to build
335 with RMR-NNG libraries, but that is the exception. The API
336 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
337 means that the underlying transport mechanism is limited only
340 The rmr_rcv_specific() function has been deprecated as it was
341 necessary only for NNG and Nanomsg support. Its use should be
346 2020 April 20; version 3.8.2
347 ----------------------------
349 Fix bug which was preventing an instance receiving dynamic
350 route table updates. (RIC-336)
354 2020 April 20; version 3.8.1
355 ----------------------------
357 Add user guide which replaces the concatenation of man pages
362 2020 April 17; version 3.8.0
363 ----------------------------
365 Add safe connect to avoid potential connect bug on Linux
368 Change debugging in route table collector to avoid possible
369 segment fault when in level 2 debug (RIC-335)
373 2020 April 15; version 3.7.4
374 ----------------------------
376 Add missing message type to header file (RIC-334)
380 2020 April 14; version 3.7.3
381 ----------------------------
383 Fix bug in rmr_call() when using SI95 (RIC-333)
387 2020 April 10; version 3.7.2
388 ----------------------------
390 Fix bug related to static route table only mode (RIC-331)
394 2020 April 9; version 3.7.1
395 ---------------------------
397 The max length restriction for receiving messages when using
398 SI95 has been removed. The length supplied during
399 initialisation is used as the "normal maximum" and default
400 buffer allocation size, but messages arriving which are
401 larger are accepted. (RIC-309)
405 2020 April 7; version 3.7.0
406 ---------------------------
408 The health check support programme was renamed to rmr_probe
413 2020 April 6; version 3.6.6
414 ---------------------------
416 Correct bug in SI95 address conversion module (RIC-327)
417 Correct bug in SI initialisation module
421 2020 April 2; version 3.6.5
422 ---------------------------
424 Correct potential nil pointer use when examining interfaces
425 for use as a listen target (RIC-307)
429 2020 April 1; version 3.6.4
430 ---------------------------
432 Correct potential nil pointer use in the NNG interface
433 (RIC-303) Correct issue preventing CI build without a
438 2020 March 30; version 3.6.3
439 ----------------------------
441 Correct the max receive message size constant in rmr.h
446 2020 March 23; version 3.6.2
447 ----------------------------
449 Fix message initialisation bug when pulling a message from
454 2020 March 19; version 3.6.1
455 ----------------------------
457 Fix problem with RPM package install
461 2020 March 18; version 3.6.0
462 ----------------------------
464 Add message types to support traffic steering
468 2020 March 16; version 3.5.2
469 ----------------------------
471 Correct bug in the meid table parser that prevented the
472 ack/nack of meid tables (RIC-273)
476 2020 March 10; version 3.5.1
477 ----------------------------
479 Add missing health check message types.
483 2020 March 9; version 3.5.0
484 ---------------------------
486 Added new wormhole send function: rmr_wh_call().
490 2020 March 6; version 3.4.0
491 ---------------------------
493 Add new wormhole state function: rmr_wh_state().
497 2020 March 5; Version 3.3.1
498 ---------------------------
500 Correct several "bugs" identified by automatic code analysis.
504 2020 March 4; Version 3.3.0
505 ---------------------------
507 Add SI95 based unit testing Health check support binary added
508 (reason for minor bump)
512 2020 February 26; version 3.2.5
513 -------------------------------
515 Fix source address bug in SI95 receive/send funcitons. Fix
516 threading issues involving session disconnection in SI95
517 Remove unused SI95 status variable.
521 2020 February 24; version 3.2.4
522 -------------------------------
524 Fix meid bug (RIC-220) causing core dump.
528 2020 February 21; version 3.2.3
529 -------------------------------
531 Add meid routing support to the SI95 interface.
535 2020 February 20; version 3.2.2
536 -------------------------------
538 Fix receive thread related core dump (ring early unlock).
542 2020 February 19; version 3.2.1
543 -------------------------------
545 Added missing message types (E2-Setup)
549 2020 February 18; version 3.2.0
550 -------------------------------
552 Added support for new Route Manager and it's ability to
553 accept a request for table update.
557 2020 February 14; version 3.1.3
558 -------------------------------
560 Fix bug in SIsend which was causing a core dump in some cases
561 where the application attempted to send on a connection that
562 had disconnected. (RIC-207).
566 2020 February 6; version 3.1.2
567 ------------------------------
569 Fix disconnection detection bug in interface to SI95.
573 2020 January 31; verison 3.1.1
574 ------------------------------
576 Allow route table thread logging to be completely disabled
577 when logging is turned off.
581 2020 January 26; verison 3.1.0
582 ------------------------------
584 First step to allowing the user programme to control messages
585 written to standard error. Introduces the rmr_set_vlevel()
586 function, and related environment variable.
590 2020 January 24; verison 3.0.5
591 ------------------------------
593 Fix bug in SI95 with receive buffer allocation.
597 2020 January 23; verison 3.0.4
598 ------------------------------
600 Fix bug in SI95 causing excessive CPU usage on poll.
604 2020 January 22; verison 3.0.3
605 ------------------------------
607 Enable thread support for multiple receive threads.
611 2020 January 21; verison 3.0.2
612 ------------------------------
614 Fix bug in SI95 (missing reallocate payload function).
618 2020 January 20; verison 3.0.1
619 ------------------------------
621 Enable support for dynamic route table updates via RMR
626 2020 January 16; version 3.0.0
627 ------------------------------
629 Introduce support for SI95 transport library to replace NNG.
630 (RMR library versions will use leading odd numbers to avoid
631 tag collisions with the wrapper tags which will use even
636 2019 December 9; version 1.13.1
637 -------------------------------
639 Correct documentation and missing rel-notes update for RTD.
643 2019 December 6; version 1.13.0
644 -------------------------------
646 Add ability to route messages based on the MEID in a message
647 combined with the message type/subscription-ID.
656 2019 November 14; version 1.11.1
657 --------------------------------
659 Fix bug in payload reallocation function; correct length of
660 payload was not always copied.
664 2019 November 13; version 1.12.1
665 --------------------------------
667 New message type constants added to support A1.
671 2019 November 4; version 1.11.0
672 -------------------------------
674 Version bump to move away from the 1.10.* to distinguish
675 between release A and the trial.
679 2019 November 7; version 1.12.0
680 -------------------------------
682 Version cut to support continued development for next release
683 preserving the 1.11.* versions for release 1 (Amber) and
688 2019 October 31; version 1.10.2
689 -------------------------------
691 Provide the means to increase the payload size of a received
692 message without losing the data needed to use the
693 rmr_rts_msg() funciton.
697 2019 October 21; version 1.10.1
698 -------------------------------
700 Fix to prevent null message buffer from being returned by the
701 timeout receive function if the function is passed one to
706 2019 October 21; version 1.10.1
707 -------------------------------
709 Add periodic dump of send count info to stderr.
713 2019 September 27; version 1.9.0
714 --------------------------------
716 Python bindings added receive all queued function and
717 corrected a unit test
721 2019 September 25; version 1.8.3
722 --------------------------------
724 Correct application level test issue causing timing problems
725 during jenkins verification testing at command and merge
727 Handle the NNG connection shutdown status which may now be
728 generated when a connection throug a proxy is reset.
732 2019 September 25; version 1.8.2
733 --------------------------------
735 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
739 2019 September 19; version 1.8.1
740 --------------------------------
742 Correct missing constant for wrappers.
746 2019 September 19; version 1.8.0
747 --------------------------------
749 New message types added:
750 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
754 2019 September 17; version 1.7.0
755 --------------------------------
757 Initial connection mode now defaults to asynchronous. Set
758 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
759 invoked to revert to synchronous first TCP connections.
760 (Recovery connection attempts have always been asynchronous).
764 2019 September 3; version 1.6.0
765 -------------------------------
767 Fix bug in the rmr_rts_msg() function. If a return to sender
768 message failed, the source IP address was not correctly
769 adjusted and could cause the message to be "reflected" back
770 to the sender on a retry.
772 Added the ability to set the source "ID" via an environment
773 var (RMR_SRC_ID). When present in the environment, the string
774 will be placed in to the message header as the source and
775 thus be used by an application calling rmr_rts_smg() to
776 return a response to the sender. If this environment variable
777 is not present, the host name (original behaviour) is used.
781 2019 August 26; version 1.4.0
782 -----------------------------
784 New message types were added.
788 2019 August 16; version 1.3.0
789 -----------------------------
791 New mesage types added.
795 2019 August 13; version 1.2.0 (API change, non-breaking)
796 --------------------------------------------------------
798 The function rmr_get_xact() was added to proide a convenient
799 way to extract the transaction field from a message.
803 2019 August 8; version 1.1.0 (API change)
804 -----------------------------------------
806 This change should be backward compatable/non-breaking A new
807 field has been added to the message buffer (rmr_mbuf_t). This
808 field (tp_state) is used to communicate the errno value that
809 the transport mechanism might set during send and/or receive
810 operations. C programmes should continue to use errno
811 directly, but in some environments wrappers may not be able
812 to access errno and this provides the value to them. See the
813 rmr_alloc_msg manual page for more details.
817 2019 August 6; version 1.0.45 (build changes)
818 ---------------------------------------------
820 Support for the Nanomsg transport library has been dropped.
821 The library librmr.* will no longer be included in packages.
823 Packages will install RMR libraries into the system preferred
824 target directory. On some systems this is /usr/local/lib
825 and on others it is /usr/local/lib64. The diretory is
826 determined by the sytem on which the package is built and
827 NOT by the system installing the package, so it's possible
828 that the RMR libraries end up in a strange location if the
829 .deb or .rpm file was generated on a Linux flavour that
830 has a different preference than the one where the package
835 2019 August 6; version 1.0.44 (API change)
836 ------------------------------------------
838 Added a new message type constant.
842 2019 July 15; Version 1.0.39 (bug fix)
843 --------------------------------------
845 Prevent unnecessary usleep in retry loop.
849 2019 July 12; Version 1.0.38 (API change)
850 -----------------------------------------
852 Added new message types to RIC_message_types.h.
856 2019 July 11; Version 1.0.37
857 ----------------------------
860 librmr and librmr_nng
861 - Add message buffer API function rmr_trace_ref()
862 (see rmr_trace_ref.3 manual page in dev package).
866 2020 April 8; Version n/a
867 -------------------------
869 RMR Python moved to Python Xapp Framework
870 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
874 2020 February 29; Version 2.4.0
875 -------------------------------
877 Add consolidated testing under CMake Add support binary for
878 health check (SI95 only)
882 2020 February 28; Version 2.3.6
883 -------------------------------
885 Fix bug in Rt. Mgr comm which prevented table ID from being
886 sent on ack message (RIC-232).