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 January 8; Version 4.5.0
26 -----------------------------
28 Version bump for next release tracking. Corrected a potential
29 locking issue in message allocation. (RIC-732)
38 2020 December 4; Version 4.4.6
39 ------------------------------
41 Correct a range check bug when cloning a route table in prep
42 to load a new one. (RIC-720)
46 2020 November 17; Version 4.4.5
47 -------------------------------
49 Correct bug in round robin group allocation that could lead
50 to an empty group. (RIC-695)
54 2020 November 13; Version 4.4.4
55 -------------------------------
57 Correct address memory leak in the RTE cleanup. (RIC-674)
61 2020 November 4; Version 4.4.3
62 ------------------------------
64 Correct bug introduced with race fix (4.4.0) (RIC-674)
68 2020 November 4; Version 4.4.2
69 ------------------------------
71 Changes to correct more complaints generated by a code scan.
72 (RIC-673) Also addressed some sonar coverage issues with unit
77 2020 November 4; Version 4.4.1
78 ------------------------------
80 Changes to correct complaints generated by a code scan.
85 2020 November 4; Version 4.4.0
86 ------------------------------
88 Changes to address a potential race condition when route
89 tables arrive in quick succession. (RIC-674)
93 2020 October 30; Version 4.3.1
94 ------------------------------
96 Changes to address code analyser scans and two bug fixes
97 identified while addressing the analysis data. (RIC-673)
101 2020 October 2; Version 4.3.0
102 -----------------------------
104 Add message types for traffic steering anomaly messages
108 2020 September 15; Version 4.2.4
109 --------------------------------
111 Add man page for the rmr_set_low_latency() function (RIC-631)
115 2020 September 15; Version 4.2.3
116 --------------------------------
118 Correct arg processing bug in rmr_rpobe (RIC-645)
122 2020 August 4; Version 4.2.2
123 ----------------------------
125 Correct bug in the rmr_probe support utility when -r option
126 is used on the command line (RIC-644)
130 2020 August 4; Version 4.2.1
131 ----------------------------
133 Add additional environment variable dump if RMR_LOG_VLEVEL
138 2020 August 3; Version 4.2.0
139 ----------------------------
141 Add support for the RMR_RTREQ_FREQ environment variable to
142 control the request frequency for a new route table (default
143 5s if not supplied). (RIC-630)
147 2020 July 21; Version 4.1.4
148 ---------------------------
150 Fix bug in SI95 -- possible use of pointer after free
155 2020 July 9; version 4.1.3
156 --------------------------
158 Allow RTS messages to be sent before the arrival of the
159 initial route table. Calls to RTS (heart beat responses)
160 prior to the initial route table load could cause a crash if
161 a framework blindly assumes that RTS is valid. (RIC-589)
165 2020 June 22; version 4.1.2
166 ---------------------------
168 Fix typo in RIC Message header file.
170 Add document for message type constants and the scripts which
175 2020 June 22; version 4.1.1
176 ---------------------------
178 Add new message types to RIC header file for
180 RIC_ALARM_QUERY (111)
182 RAN_E2_RESET_REQ (12008)
183 RAN_E2_RESET_RESP (12009)
187 2020 June 18; version 4.1.0
188 ---------------------------
190 Bump version minor to move away from 4.0.* which will bump
191 for any patches applied back to bronze.
193 Add magic C++ goo to symtab header file allowing C++ xAPPs to
194 use the symbol table directly.
203 2020 May 06; version 4.0.5
204 --------------------------
206 Fix the bug in SI95 receive message management semaphore
207 count issue. (RIC-355)
211 2020 April 29; version 4.0.4
212 ----------------------------
214 Fix the traffic steering message type constants (again)
219 2020 April 28; version 4.0.3
220 ----------------------------
222 Fix sonar flagged bugs (RIC-78)
226 2020 April 24; version 4.0.2
227 ----------------------------
229 Correct bug in SI95 transport header length validation
234 2020 April 22; version 4.0.1
235 ----------------------------
237 Correct message type constant for Traffic Steering
238 predication (RIC-342)
242 2020 April 21; version 4.0.0
243 ----------------------------
245 The NNG based libraries are no longer included in the RMR
246 packages. This is considered a breaking change as NNG will
247 not be supported by default. It is still possible to build
248 with RMR-NNG libraries, but that is the exception. The API
249 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
250 means that the underlying transport mechanism is limited only
253 The rmr_rcv_specific() function has been deprecated as it was
254 necessary only for NNG and Nanomsg support. Its use should be
259 2020 April 20; version 3.8.2
260 ----------------------------
262 Fix bug which was preventing an instance receiving dynamic
263 route table updates. (RIC-336)
267 2020 April 20; version 3.8.1
268 ----------------------------
270 Add user guide which replaces the concatenation of man pages
275 2020 April 17; version 3.8.0
276 ----------------------------
278 Add safe connect to avoid potential connect bug on Linux
281 Change debugging in route table collector to avoid possible
282 segment fault when in level 2 debug (RIC-335)
286 2020 April 15; version 3.7.4
287 ----------------------------
289 Add missing message type to header file (RIC-334)
293 2020 April 14; version 3.7.3
294 ----------------------------
296 Fix bug in rmr_call() when using SI95 (RIC-333)
300 2020 April 10; version 3.7.2
301 ----------------------------
303 Fix bug related to static route table only mode (RIC-331)
307 2020 April 9; version 3.7.1
308 ---------------------------
310 The max length restriction for receiving messages when using
311 SI95 has been removed. The length supplied during
312 initialisation is used as the "normal maximum" and default
313 buffer allocation size, but messages arriving which are
314 larger are accepted. (RIC-309)
318 2020 April 7; version 3.7.0
319 ---------------------------
321 The health check support programme was renamed to rmr_probe
326 2020 April 6; version 3.6.6
327 ---------------------------
329 Correct bug in SI95 address conversion module (RIC-327)
330 Correct bug in SI initialisation module
334 2020 April 2; version 3.6.5
335 ---------------------------
337 Correct potential nil pointer use when examining interfaces
338 for use as a listen target (RIC-307)
342 2020 April 1; version 3.6.4
343 ---------------------------
345 Correct potential nil pointer use in the NNG interface
346 (RIC-303) Correct issue preventing CI build without a
351 2020 March 30; version 3.6.3
352 ----------------------------
354 Correct the max receive message size constant in rmr.h
359 2020 March 23; version 3.6.2
360 ----------------------------
362 Fix message initialisation bug when pulling a message from
367 2020 March 19; version 3.6.1
368 ----------------------------
370 Fix problem with RPM package install
374 2020 March 18; version 3.6.0
375 ----------------------------
377 Add message types to support traffic steering
381 2020 March 16; version 3.5.2
382 ----------------------------
384 Correct bug in the meid table parser that prevented the
385 ack/nack of meid tables (RIC-273)
389 2020 March 10; version 3.5.1
390 ----------------------------
392 Add missing health check message types.
396 2020 March 9; version 3.5.0
397 ---------------------------
399 Added new wormhole send function: rmr_wh_call().
403 2020 March 6; version 3.4.0
404 ---------------------------
406 Add new wormhole state function: rmr_wh_state().
410 2020 March 5; Version 3.3.1
411 ---------------------------
413 Correct several "bugs" identified by automatic code analysis.
417 2020 March 4; Version 3.3.0
418 ---------------------------
420 Add SI95 based unit testing Health check support binary added
421 (reason for minor bump)
425 2020 February 26; version 3.2.5
426 -------------------------------
428 Fix source address bug in SI95 receive/send funcitons. Fix
429 threading issues involving session disconnection in SI95
430 Remove unused SI95 status variable.
434 2020 February 24; version 3.2.4
435 -------------------------------
437 Fix meid bug (RIC-220) causing core dump.
441 2020 February 21; version 3.2.3
442 -------------------------------
444 Add meid routing support to the SI95 interface.
448 2020 February 20; version 3.2.2
449 -------------------------------
451 Fix receive thread related core dump (ring early unlock).
455 2020 February 19; version 3.2.1
456 -------------------------------
458 Added missing message types (E2-Setup)
462 2020 February 18; version 3.2.0
463 -------------------------------
465 Added support for new Route Manager and it's ability to
466 accept a request for table update.
470 2020 February 14; version 3.1.3
471 -------------------------------
473 Fix bug in SIsend which was causing a core dump in some cases
474 where the application attempted to send on a connection that
475 had disconnected. (RIC-207).
479 2020 February 6; version 3.1.2
480 ------------------------------
482 Fix disconnection detection bug in interface to SI95.
486 2020 January 31; verison 3.1.1
487 ------------------------------
489 Allow route table thread logging to be completely disabled
490 when logging is turned off.
494 2020 January 26; verison 3.1.0
495 ------------------------------
497 First step to allowing the user programme to control messages
498 written to standard error. Introduces the rmr_set_vlevel()
499 function, and related environment variable.
503 2020 January 24; verison 3.0.5
504 ------------------------------
506 Fix bug in SI95 with receive buffer allocation.
510 2020 January 23; verison 3.0.4
511 ------------------------------
513 Fix bug in SI95 causing excessive CPU usage on poll.
517 2020 January 22; verison 3.0.3
518 ------------------------------
520 Enable thread support for multiple receive threads.
524 2020 January 21; verison 3.0.2
525 ------------------------------
527 Fix bug in SI95 (missing reallocate payload function).
531 2020 January 20; verison 3.0.1
532 ------------------------------
534 Enable support for dynamic route table updates via RMR
539 2020 January 16; version 3.0.0
540 ------------------------------
542 Introduce support for SI95 transport library to replace NNG.
543 (RMR library versions will use leading odd numbers to avoid
544 tag collisions with the wrapper tags which will use even
549 2019 December 9; version 1.13.1
550 -------------------------------
552 Correct documentation and missing rel-notes update for RTD.
556 2019 December 6; version 1.13.0
557 -------------------------------
559 Add ability to route messages based on the MEID in a message
560 combined with the message type/subscription-ID.
569 2019 November 14; version 1.11.1
570 --------------------------------
572 Fix bug in payload reallocation function; correct length of
573 payload was not always copied.
577 2019 November 13; version 1.12.1
578 --------------------------------
580 New message type constants added to support A1.
584 2019 November 4; version 1.11.0
585 -------------------------------
587 Version bump to move away from the 1.10.* to distinguish
588 between release A and the trial.
592 2019 November 7; version 1.12.0
593 -------------------------------
595 Version cut to support continued development for next release
596 preserving the 1.11.* versions for release 1 (Amber) and
601 2019 October 31; version 1.10.2
602 -------------------------------
604 Provide the means to increase the payload size of a received
605 message without losing the data needed to use the
606 rmr_rts_msg() funciton.
610 2019 October 21; version 1.10.1
611 -------------------------------
613 Fix to prevent null message buffer from being returned by the
614 timeout receive function if the function is passed one to
619 2019 October 21; version 1.10.1
620 -------------------------------
622 Add periodic dump of send count info to stderr.
626 2019 September 27; version 1.9.0
627 --------------------------------
629 Python bindings added receive all queued function and
630 corrected a unit test
634 2019 September 25; version 1.8.3
635 --------------------------------
637 Correct application level test issue causing timing problems
638 during jenkins verification testing at command and merge
640 Handle the NNG connection shutdown status which may now be
641 generated when a connection throug a proxy is reset.
645 2019 September 25; version 1.8.2
646 --------------------------------
648 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
652 2019 September 19; version 1.8.1
653 --------------------------------
655 Correct missing constant for wrappers.
659 2019 September 19; version 1.8.0
660 --------------------------------
662 New message types added:
663 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
667 2019 September 17; version 1.7.0
668 --------------------------------
670 Initial connection mode now defaults to asynchronous. Set
671 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
672 invoked to revert to synchronous first TCP connections.
673 (Recovery connection attempts have always been asynchronous).
677 2019 September 3; version 1.6.0
678 -------------------------------
680 Fix bug in the rmr_rts_msg() function. If a return to sender
681 message failed, the source IP address was not correctly
682 adjusted and could cause the message to be "reflected" back
683 to the sender on a retry.
685 Added the ability to set the source "ID" via an environment
686 var (RMR_SRC_ID). When present in the environment, the string
687 will be placed in to the message header as the source and
688 thus be used by an application calling rmr_rts_smg() to
689 return a response to the sender. If this environment variable
690 is not present, the host name (original behaviour) is used.
694 2019 August 26; version 1.4.0
695 -----------------------------
697 New message types were added.
701 2019 August 16; version 1.3.0
702 -----------------------------
704 New mesage types added.
708 2019 August 13; version 1.2.0 (API change, non-breaking)
709 --------------------------------------------------------
711 The function rmr_get_xact() was added to proide a convenient
712 way to extract the transaction field from a message.
716 2019 August 8; version 1.1.0 (API change)
717 -----------------------------------------
719 This change should be backward compatable/non-breaking A new
720 field has been added to the message buffer (rmr_mbuf_t). This
721 field (tp_state) is used to communicate the errno value that
722 the transport mechanism might set during send and/or receive
723 operations. C programmes should continue to use errno
724 directly, but in some environments wrappers may not be able
725 to access errno and this provides the value to them. See the
726 rmr_alloc_msg manual page for more details.
730 2019 August 6; version 1.0.45 (build changes)
731 ---------------------------------------------
733 Support for the Nanomsg transport library has been dropped.
734 The library librmr.* will no longer be included in packages.
736 Packages will install RMR libraries into the system preferred
737 target directory. On some systems this is /usr/local/lib
738 and on others it is /usr/local/lib64. The diretory is
739 determined by the sytem on which the package is built and
740 NOT by the system installing the package, so it's possible
741 that the RMR libraries end up in a strange location if the
742 .deb or .rpm file was generated on a Linux flavour that
743 has a different preference than the one where the package
748 2019 August 6; version 1.0.44 (API change)
749 ------------------------------------------
751 Added a new message type constant.
755 2019 July 15; Version 1.0.39 (bug fix)
756 --------------------------------------
758 Prevent unnecessary usleep in retry loop.
762 2019 July 12; Version 1.0.38 (API change)
763 -----------------------------------------
765 Added new message types to RIC_message_types.h.
769 2019 July 11; Version 1.0.37
770 ----------------------------
773 librmr and librmr_nng
774 - Add message buffer API function rmr_trace_ref()
775 (see rmr_trace_ref.3 manual page in dev package).
779 2020 April 8; Version n/a
780 -------------------------
782 RMR Python moved to Python Xapp Framework
783 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
787 2020 February 29; Version 2.4.0
788 -------------------------------
790 Add consolidated testing under CMake Add support binary for
791 health check (SI95 only)
795 2020 February 28; Version 2.3.6
796 -------------------------------
798 Fix bug in Rt. Mgr comm which prevented table ID from being
799 sent on ack message (RIC-232).