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 January21; Version 4.5.2
26 -----------------------------
28 Fixes the excessive TCP session bug when sending to a slow
29 receiver and a related segment fault because of too many open
30 file descriptors. (RIC-735)
34 2021 January 19; Version 4.5.1
35 ------------------------------
37 Version bump to work round a CI job bug preventing push of
38 the 4.5.0 packages from staging to release in package cloud.
43 2021 January 8; Version 4.5.0
44 -----------------------------
46 Version bump for next release tracking. Corrected a potential
47 locking issue in message allocation. (RIC-732)
56 2020 December 4; Version 4.4.6
57 ------------------------------
59 Correct a range check bug when cloning a route table in prep
60 to load a new one. (RIC-720)
64 2020 November 17; Version 4.4.5
65 -------------------------------
67 Correct bug in round robin group allocation that could lead
68 to an empty group. (RIC-695)
72 2020 November 13; Version 4.4.4
73 -------------------------------
75 Correct address memory leak in the RTE cleanup. (RIC-674)
79 2020 November 4; Version 4.4.3
80 ------------------------------
82 Correct bug introduced with race fix (4.4.0) (RIC-674)
86 2020 November 4; Version 4.4.2
87 ------------------------------
89 Changes to correct more complaints generated by a code scan.
90 (RIC-673) Also addressed some sonar coverage issues with unit
95 2020 November 4; Version 4.4.1
96 ------------------------------
98 Changes to correct complaints generated by a code scan.
103 2020 November 4; Version 4.4.0
104 ------------------------------
106 Changes to address a potential race condition when route
107 tables arrive in quick succession. (RIC-674)
111 2020 October 30; Version 4.3.1
112 ------------------------------
114 Changes to address code analyser scans and two bug fixes
115 identified while addressing the analysis data. (RIC-673)
119 2020 October 2; Version 4.3.0
120 -----------------------------
122 Add message types for traffic steering anomaly messages
126 2020 September 15; Version 4.2.4
127 --------------------------------
129 Add man page for the rmr_set_low_latency() function (RIC-631)
133 2020 September 15; Version 4.2.3
134 --------------------------------
136 Correct arg processing bug in rmr_rpobe (RIC-645)
140 2020 August 4; Version 4.2.2
141 ----------------------------
143 Correct bug in the rmr_probe support utility when -r option
144 is used on the command line (RIC-644)
148 2020 August 4; Version 4.2.1
149 ----------------------------
151 Add additional environment variable dump if RMR_LOG_VLEVEL
156 2020 August 3; Version 4.2.0
157 ----------------------------
159 Add support for the RMR_RTREQ_FREQ environment variable to
160 control the request frequency for a new route table (default
161 5s if not supplied). (RIC-630)
165 2020 July 21; Version 4.1.4
166 ---------------------------
168 Fix bug in SI95 -- possible use of pointer after free
173 2020 July 9; version 4.1.3
174 --------------------------
176 Allow RTS messages to be sent before the arrival of the
177 initial route table. Calls to RTS (heart beat responses)
178 prior to the initial route table load could cause a crash if
179 a framework blindly assumes that RTS is valid. (RIC-589)
183 2020 June 22; version 4.1.2
184 ---------------------------
186 Fix typo in RIC Message header file.
188 Add document for message type constants and the scripts which
193 2020 June 22; version 4.1.1
194 ---------------------------
196 Add new message types to RIC header file for
198 RIC_ALARM_QUERY (111)
200 RAN_E2_RESET_REQ (12008)
201 RAN_E2_RESET_RESP (12009)
205 2020 June 18; version 4.1.0
206 ---------------------------
208 Bump version minor to move away from 4.0.* which will bump
209 for any patches applied back to bronze.
211 Add magic C++ goo to symtab header file allowing C++ xAPPs to
212 use the symbol table directly.
221 2020 May 06; version 4.0.5
222 --------------------------
224 Fix the bug in SI95 receive message management semaphore
225 count issue. (RIC-355)
229 2020 April 29; version 4.0.4
230 ----------------------------
232 Fix the traffic steering message type constants (again)
237 2020 April 28; version 4.0.3
238 ----------------------------
240 Fix sonar flagged bugs (RIC-78)
244 2020 April 24; version 4.0.2
245 ----------------------------
247 Correct bug in SI95 transport header length validation
252 2020 April 22; version 4.0.1
253 ----------------------------
255 Correct message type constant for Traffic Steering
256 predication (RIC-342)
260 2020 April 21; version 4.0.0
261 ----------------------------
263 The NNG based libraries are no longer included in the RMR
264 packages. This is considered a breaking change as NNG will
265 not be supported by default. It is still possible to build
266 with RMR-NNG libraries, but that is the exception. The API
267 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
268 means that the underlying transport mechanism is limited only
271 The rmr_rcv_specific() function has been deprecated as it was
272 necessary only for NNG and Nanomsg support. Its use should be
277 2020 April 20; version 3.8.2
278 ----------------------------
280 Fix bug which was preventing an instance receiving dynamic
281 route table updates. (RIC-336)
285 2020 April 20; version 3.8.1
286 ----------------------------
288 Add user guide which replaces the concatenation of man pages
293 2020 April 17; version 3.8.0
294 ----------------------------
296 Add safe connect to avoid potential connect bug on Linux
299 Change debugging in route table collector to avoid possible
300 segment fault when in level 2 debug (RIC-335)
304 2020 April 15; version 3.7.4
305 ----------------------------
307 Add missing message type to header file (RIC-334)
311 2020 April 14; version 3.7.3
312 ----------------------------
314 Fix bug in rmr_call() when using SI95 (RIC-333)
318 2020 April 10; version 3.7.2
319 ----------------------------
321 Fix bug related to static route table only mode (RIC-331)
325 2020 April 9; version 3.7.1
326 ---------------------------
328 The max length restriction for receiving messages when using
329 SI95 has been removed. The length supplied during
330 initialisation is used as the "normal maximum" and default
331 buffer allocation size, but messages arriving which are
332 larger are accepted. (RIC-309)
336 2020 April 7; version 3.7.0
337 ---------------------------
339 The health check support programme was renamed to rmr_probe
344 2020 April 6; version 3.6.6
345 ---------------------------
347 Correct bug in SI95 address conversion module (RIC-327)
348 Correct bug in SI initialisation module
352 2020 April 2; version 3.6.5
353 ---------------------------
355 Correct potential nil pointer use when examining interfaces
356 for use as a listen target (RIC-307)
360 2020 April 1; version 3.6.4
361 ---------------------------
363 Correct potential nil pointer use in the NNG interface
364 (RIC-303) Correct issue preventing CI build without a
369 2020 March 30; version 3.6.3
370 ----------------------------
372 Correct the max receive message size constant in rmr.h
377 2020 March 23; version 3.6.2
378 ----------------------------
380 Fix message initialisation bug when pulling a message from
385 2020 March 19; version 3.6.1
386 ----------------------------
388 Fix problem with RPM package install
392 2020 March 18; version 3.6.0
393 ----------------------------
395 Add message types to support traffic steering
399 2020 March 16; version 3.5.2
400 ----------------------------
402 Correct bug in the meid table parser that prevented the
403 ack/nack of meid tables (RIC-273)
407 2020 March 10; version 3.5.1
408 ----------------------------
410 Add missing health check message types.
414 2020 March 9; version 3.5.0
415 ---------------------------
417 Added new wormhole send function: rmr_wh_call().
421 2020 March 6; version 3.4.0
422 ---------------------------
424 Add new wormhole state function: rmr_wh_state().
428 2020 March 5; Version 3.3.1
429 ---------------------------
431 Correct several "bugs" identified by automatic code analysis.
435 2020 March 4; Version 3.3.0
436 ---------------------------
438 Add SI95 based unit testing Health check support binary added
439 (reason for minor bump)
443 2020 February 26; version 3.2.5
444 -------------------------------
446 Fix source address bug in SI95 receive/send funcitons. Fix
447 threading issues involving session disconnection in SI95
448 Remove unused SI95 status variable.
452 2020 February 24; version 3.2.4
453 -------------------------------
455 Fix meid bug (RIC-220) causing core dump.
459 2020 February 21; version 3.2.3
460 -------------------------------
462 Add meid routing support to the SI95 interface.
466 2020 February 20; version 3.2.2
467 -------------------------------
469 Fix receive thread related core dump (ring early unlock).
473 2020 February 19; version 3.2.1
474 -------------------------------
476 Added missing message types (E2-Setup)
480 2020 February 18; version 3.2.0
481 -------------------------------
483 Added support for new Route Manager and it's ability to
484 accept a request for table update.
488 2020 February 14; version 3.1.3
489 -------------------------------
491 Fix bug in SIsend which was causing a core dump in some cases
492 where the application attempted to send on a connection that
493 had disconnected. (RIC-207).
497 2020 February 6; version 3.1.2
498 ------------------------------
500 Fix disconnection detection bug in interface to SI95.
504 2020 January 31; verison 3.1.1
505 ------------------------------
507 Allow route table thread logging to be completely disabled
508 when logging is turned off.
512 2020 January 26; verison 3.1.0
513 ------------------------------
515 First step to allowing the user programme to control messages
516 written to standard error. Introduces the rmr_set_vlevel()
517 function, and related environment variable.
521 2020 January 24; verison 3.0.5
522 ------------------------------
524 Fix bug in SI95 with receive buffer allocation.
528 2020 January 23; verison 3.0.4
529 ------------------------------
531 Fix bug in SI95 causing excessive CPU usage on poll.
535 2020 January 22; verison 3.0.3
536 ------------------------------
538 Enable thread support for multiple receive threads.
542 2020 January 21; verison 3.0.2
543 ------------------------------
545 Fix bug in SI95 (missing reallocate payload function).
549 2020 January 20; verison 3.0.1
550 ------------------------------
552 Enable support for dynamic route table updates via RMR
557 2020 January 16; version 3.0.0
558 ------------------------------
560 Introduce support for SI95 transport library to replace NNG.
561 (RMR library versions will use leading odd numbers to avoid
562 tag collisions with the wrapper tags which will use even
567 2019 December 9; version 1.13.1
568 -------------------------------
570 Correct documentation and missing rel-notes update for RTD.
574 2019 December 6; version 1.13.0
575 -------------------------------
577 Add ability to route messages based on the MEID in a message
578 combined with the message type/subscription-ID.
587 2019 November 14; version 1.11.1
588 --------------------------------
590 Fix bug in payload reallocation function; correct length of
591 payload was not always copied.
595 2019 November 13; version 1.12.1
596 --------------------------------
598 New message type constants added to support A1.
602 2019 November 4; version 1.11.0
603 -------------------------------
605 Version bump to move away from the 1.10.* to distinguish
606 between release A and the trial.
610 2019 November 7; version 1.12.0
611 -------------------------------
613 Version cut to support continued development for next release
614 preserving the 1.11.* versions for release 1 (Amber) and
619 2019 October 31; version 1.10.2
620 -------------------------------
622 Provide the means to increase the payload size of a received
623 message without losing the data needed to use the
624 rmr_rts_msg() funciton.
628 2019 October 21; version 1.10.1
629 -------------------------------
631 Fix to prevent null message buffer from being returned by the
632 timeout receive function if the function is passed one to
637 2019 October 21; version 1.10.1
638 -------------------------------
640 Add periodic dump of send count info to stderr.
644 2019 September 27; version 1.9.0
645 --------------------------------
647 Python bindings added receive all queued function and
648 corrected a unit test
652 2019 September 25; version 1.8.3
653 --------------------------------
655 Correct application level test issue causing timing problems
656 during jenkins verification testing at command and merge
658 Handle the NNG connection shutdown status which may now be
659 generated when a connection throug a proxy is reset.
663 2019 September 25; version 1.8.2
664 --------------------------------
666 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
670 2019 September 19; version 1.8.1
671 --------------------------------
673 Correct missing constant for wrappers.
677 2019 September 19; version 1.8.0
678 --------------------------------
680 New message types added:
681 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
685 2019 September 17; version 1.7.0
686 --------------------------------
688 Initial connection mode now defaults to asynchronous. Set
689 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
690 invoked to revert to synchronous first TCP connections.
691 (Recovery connection attempts have always been asynchronous).
695 2019 September 3; version 1.6.0
696 -------------------------------
698 Fix bug in the rmr_rts_msg() function. If a return to sender
699 message failed, the source IP address was not correctly
700 adjusted and could cause the message to be "reflected" back
701 to the sender on a retry.
703 Added the ability to set the source "ID" via an environment
704 var (RMR_SRC_ID). When present in the environment, the string
705 will be placed in to the message header as the source and
706 thus be used by an application calling rmr_rts_smg() to
707 return a response to the sender. If this environment variable
708 is not present, the host name (original behaviour) is used.
712 2019 August 26; version 1.4.0
713 -----------------------------
715 New message types were added.
719 2019 August 16; version 1.3.0
720 -----------------------------
722 New mesage types added.
726 2019 August 13; version 1.2.0 (API change, non-breaking)
727 --------------------------------------------------------
729 The function rmr_get_xact() was added to proide a convenient
730 way to extract the transaction field from a message.
734 2019 August 8; version 1.1.0 (API change)
735 -----------------------------------------
737 This change should be backward compatable/non-breaking A new
738 field has been added to the message buffer (rmr_mbuf_t). This
739 field (tp_state) is used to communicate the errno value that
740 the transport mechanism might set during send and/or receive
741 operations. C programmes should continue to use errno
742 directly, but in some environments wrappers may not be able
743 to access errno and this provides the value to them. See the
744 rmr_alloc_msg manual page for more details.
748 2019 August 6; version 1.0.45 (build changes)
749 ---------------------------------------------
751 Support for the Nanomsg transport library has been dropped.
752 The library librmr.* will no longer be included in packages.
754 Packages will install RMR libraries into the system preferred
755 target directory. On some systems this is /usr/local/lib
756 and on others it is /usr/local/lib64. The diretory is
757 determined by the sytem on which the package is built and
758 NOT by the system installing the package, so it's possible
759 that the RMR libraries end up in a strange location if the
760 .deb or .rpm file was generated on a Linux flavour that
761 has a different preference than the one where the package
766 2019 August 6; version 1.0.44 (API change)
767 ------------------------------------------
769 Added a new message type constant.
773 2019 July 15; Version 1.0.39 (bug fix)
774 --------------------------------------
776 Prevent unnecessary usleep in retry loop.
780 2019 July 12; Version 1.0.38 (API change)
781 -----------------------------------------
783 Added new message types to RIC_message_types.h.
787 2019 July 11; Version 1.0.37
788 ----------------------------
791 librmr and librmr_nng
792 - Add message buffer API function rmr_trace_ref()
793 (see rmr_trace_ref.3 manual page in dev package).
797 2020 April 8; Version n/a
798 -------------------------
800 RMR Python moved to Python Xapp Framework
801 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
805 2020 February 29; Version 2.4.0
806 -------------------------------
808 Add consolidated testing under CMake Add support binary for
809 health check (SI95 only)
813 2020 February 28; Version 2.3.6
814 -------------------------------
816 Fix bug in Rt. Mgr comm which prevented table ID from being
817 sent on ack message (RIC-232).