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 March 10; version 4.6.1
26 ----------------------------
28 Corrected unit test "framework" to make manual testing
29 easier, and to add the ability to set the code optimisation
30 level via the CMake command line parameter OPT_LEVEL=n.
34 2021 February 22; Version 4.6.0
35 -------------------------------
37 Enhanced to use millisecond based timestamps when writing log
40 Enhanced to eliminate the reqirement that the file specified
41 by the RMR_VCTL_FILE environment variable exist when RMR is
42 initialised. RMR will correctly find this file if it is
43 created after initialisation. Further, if the environment
44 variable is not given, the user may create and populate
45 /tmp/rmr.v at any time and the contents of this file will be
46 used as if it were supplied via the environment variable.
47 This should make debugging in existing containers easier.
49 Enhanced to send an alarm manager when the user application
50 is not receiving messages fast enough. The original messages
51 written to the standard error are still generated. (RIC-204)
55 2021 January 21; Version 4.5.2
56 ------------------------------
58 Fixes the excessive TCP session bug when sending to a slow
59 receiver and a related segment fault because of too many open
60 file descriptors. (RIC-735)
64 2021 January 19; Version 4.5.1
65 ------------------------------
67 Version bump to work round a CI job bug preventing push of
68 the 4.5.0 packages from staging to release in package cloud.
73 2021 January 8; Version 4.5.0
74 -----------------------------
76 Version bump for next release tracking. Corrected a potential
77 locking issue in message allocation. (RIC-732)
86 2020 December 4; Version 4.4.6
87 ------------------------------
89 Correct a range check bug when cloning a route table in prep
90 to load a new one. (RIC-720)
94 2020 November 17; Version 4.4.5
95 -------------------------------
97 Correct bug in round robin group allocation that could lead
98 to an empty group. (RIC-695)
102 2020 November 13; Version 4.4.4
103 -------------------------------
105 Correct address memory leak in the RTE cleanup. (RIC-674)
109 2020 November 4; Version 4.4.3
110 ------------------------------
112 Correct bug introduced with race fix (4.4.0) (RIC-674)
116 2020 November 4; Version 4.4.2
117 ------------------------------
119 Changes to correct more complaints generated by a code scan.
120 (RIC-673) Also addressed some sonar coverage issues with unit
125 2020 November 4; Version 4.4.1
126 ------------------------------
128 Changes to correct complaints generated by a code scan.
133 2020 November 4; Version 4.4.0
134 ------------------------------
136 Changes to address a potential race condition when route
137 tables arrive in quick succession. (RIC-674)
141 2020 October 30; Version 4.3.1
142 ------------------------------
144 Changes to address code analyser scans and two bug fixes
145 identified while addressing the analysis data. (RIC-673)
149 2020 October 2; Version 4.3.0
150 -----------------------------
152 Add message types for traffic steering anomaly messages
156 2020 September 15; Version 4.2.4
157 --------------------------------
159 Add man page for the rmr_set_low_latency() function (RIC-631)
163 2020 September 15; Version 4.2.3
164 --------------------------------
166 Correct arg processing bug in rmr_rpobe (RIC-645)
170 2020 August 4; Version 4.2.2
171 ----------------------------
173 Correct bug in the rmr_probe support utility when -r option
174 is used on the command line (RIC-644)
178 2020 August 4; Version 4.2.1
179 ----------------------------
181 Add additional environment variable dump if RMR_LOG_VLEVEL
186 2020 August 3; Version 4.2.0
187 ----------------------------
189 Add support for the RMR_RTREQ_FREQ environment variable to
190 control the request frequency for a new route table (default
191 5s if not supplied). (RIC-630)
195 2020 July 21; Version 4.1.4
196 ---------------------------
198 Fix bug in SI95 -- possible use of pointer after free
203 2020 July 9; version 4.1.3
204 --------------------------
206 Allow RTS messages to be sent before the arrival of the
207 initial route table. Calls to RTS (heart beat responses)
208 prior to the initial route table load could cause a crash if
209 a framework blindly assumes that RTS is valid. (RIC-589)
213 2020 June 22; version 4.1.2
214 ---------------------------
216 Fix typo in RIC Message header file.
218 Add document for message type constants and the scripts which
223 2020 June 22; version 4.1.1
224 ---------------------------
226 Add new message types to RIC header file for
228 RIC_ALARM_QUERY (111)
230 RAN_E2_RESET_REQ (12008)
231 RAN_E2_RESET_RESP (12009)
235 2020 June 18; version 4.1.0
236 ---------------------------
238 Bump version minor to move away from 4.0.* which will bump
239 for any patches applied back to bronze.
241 Add magic C++ goo to symtab header file allowing C++ xAPPs to
242 use the symbol table directly.
251 2020 May 06; version 4.0.5
252 --------------------------
254 Fix the bug in SI95 receive message management semaphore
255 count issue. (RIC-355)
259 2020 April 29; version 4.0.4
260 ----------------------------
262 Fix the traffic steering message type constants (again)
267 2020 April 28; version 4.0.3
268 ----------------------------
270 Fix sonar flagged bugs (RIC-78)
274 2020 April 24; version 4.0.2
275 ----------------------------
277 Correct bug in SI95 transport header length validation
282 2020 April 22; version 4.0.1
283 ----------------------------
285 Correct message type constant for Traffic Steering
286 predication (RIC-342)
290 2020 April 21; version 4.0.0
291 ----------------------------
293 The NNG based libraries are no longer included in the RMR
294 packages. This is considered a breaking change as NNG will
295 not be supported by default. It is still possible to build
296 with RMR-NNG libraries, but that is the exception. The API
297 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
298 means that the underlying transport mechanism is limited only
301 The rmr_rcv_specific() function has been deprecated as it was
302 necessary only for NNG and Nanomsg support. Its use should be
307 2020 April 20; version 3.8.2
308 ----------------------------
310 Fix bug which was preventing an instance receiving dynamic
311 route table updates. (RIC-336)
315 2020 April 20; version 3.8.1
316 ----------------------------
318 Add user guide which replaces the concatenation of man pages
323 2020 April 17; version 3.8.0
324 ----------------------------
326 Add safe connect to avoid potential connect bug on Linux
329 Change debugging in route table collector to avoid possible
330 segment fault when in level 2 debug (RIC-335)
334 2020 April 15; version 3.7.4
335 ----------------------------
337 Add missing message type to header file (RIC-334)
341 2020 April 14; version 3.7.3
342 ----------------------------
344 Fix bug in rmr_call() when using SI95 (RIC-333)
348 2020 April 10; version 3.7.2
349 ----------------------------
351 Fix bug related to static route table only mode (RIC-331)
355 2020 April 9; version 3.7.1
356 ---------------------------
358 The max length restriction for receiving messages when using
359 SI95 has been removed. The length supplied during
360 initialisation is used as the "normal maximum" and default
361 buffer allocation size, but messages arriving which are
362 larger are accepted. (RIC-309)
366 2020 April 7; version 3.7.0
367 ---------------------------
369 The health check support programme was renamed to rmr_probe
374 2020 April 6; version 3.6.6
375 ---------------------------
377 Correct bug in SI95 address conversion module (RIC-327)
378 Correct bug in SI initialisation module
382 2020 April 2; version 3.6.5
383 ---------------------------
385 Correct potential nil pointer use when examining interfaces
386 for use as a listen target (RIC-307)
390 2020 April 1; version 3.6.4
391 ---------------------------
393 Correct potential nil pointer use in the NNG interface
394 (RIC-303) Correct issue preventing CI build without a
399 2020 March 30; version 3.6.3
400 ----------------------------
402 Correct the max receive message size constant in rmr.h
407 2020 March 23; version 3.6.2
408 ----------------------------
410 Fix message initialisation bug when pulling a message from
415 2020 March 19; version 3.6.1
416 ----------------------------
418 Fix problem with RPM package install
422 2020 March 18; version 3.6.0
423 ----------------------------
425 Add message types to support traffic steering
429 2020 March 16; version 3.5.2
430 ----------------------------
432 Correct bug in the meid table parser that prevented the
433 ack/nack of meid tables (RIC-273)
437 2020 March 10; version 3.5.1
438 ----------------------------
440 Add missing health check message types.
444 2020 March 9; version 3.5.0
445 ---------------------------
447 Added new wormhole send function: rmr_wh_call().
451 2020 March 6; version 3.4.0
452 ---------------------------
454 Add new wormhole state function: rmr_wh_state().
458 2020 March 5; Version 3.3.1
459 ---------------------------
461 Correct several "bugs" identified by automatic code analysis.
465 2020 March 4; Version 3.3.0
466 ---------------------------
468 Add SI95 based unit testing Health check support binary added
469 (reason for minor bump)
473 2020 February 26; version 3.2.5
474 -------------------------------
476 Fix source address bug in SI95 receive/send funcitons. Fix
477 threading issues involving session disconnection in SI95
478 Remove unused SI95 status variable.
482 2020 February 24; version 3.2.4
483 -------------------------------
485 Fix meid bug (RIC-220) causing core dump.
489 2020 February 21; version 3.2.3
490 -------------------------------
492 Add meid routing support to the SI95 interface.
496 2020 February 20; version 3.2.2
497 -------------------------------
499 Fix receive thread related core dump (ring early unlock).
503 2020 February 19; version 3.2.1
504 -------------------------------
506 Added missing message types (E2-Setup)
510 2020 February 18; version 3.2.0
511 -------------------------------
513 Added support for new Route Manager and it's ability to
514 accept a request for table update.
518 2020 February 14; version 3.1.3
519 -------------------------------
521 Fix bug in SIsend which was causing a core dump in some cases
522 where the application attempted to send on a connection that
523 had disconnected. (RIC-207).
527 2020 February 6; version 3.1.2
528 ------------------------------
530 Fix disconnection detection bug in interface to SI95.
534 2020 January 31; verison 3.1.1
535 ------------------------------
537 Allow route table thread logging to be completely disabled
538 when logging is turned off.
542 2020 January 26; verison 3.1.0
543 ------------------------------
545 First step to allowing the user programme to control messages
546 written to standard error. Introduces the rmr_set_vlevel()
547 function, and related environment variable.
551 2020 January 24; verison 3.0.5
552 ------------------------------
554 Fix bug in SI95 with receive buffer allocation.
558 2020 January 23; verison 3.0.4
559 ------------------------------
561 Fix bug in SI95 causing excessive CPU usage on poll.
565 2020 January 22; verison 3.0.3
566 ------------------------------
568 Enable thread support for multiple receive threads.
572 2020 January 21; verison 3.0.2
573 ------------------------------
575 Fix bug in SI95 (missing reallocate payload function).
579 2020 January 20; verison 3.0.1
580 ------------------------------
582 Enable support for dynamic route table updates via RMR
587 2020 January 16; version 3.0.0
588 ------------------------------
590 Introduce support for SI95 transport library to replace NNG.
591 (RMR library versions will use leading odd numbers to avoid
592 tag collisions with the wrapper tags which will use even
597 2019 December 9; version 1.13.1
598 -------------------------------
600 Correct documentation and missing rel-notes update for RTD.
604 2019 December 6; version 1.13.0
605 -------------------------------
607 Add ability to route messages based on the MEID in a message
608 combined with the message type/subscription-ID.
617 2019 November 14; version 1.11.1
618 --------------------------------
620 Fix bug in payload reallocation function; correct length of
621 payload was not always copied.
625 2019 November 13; version 1.12.1
626 --------------------------------
628 New message type constants added to support A1.
632 2019 November 4; version 1.11.0
633 -------------------------------
635 Version bump to move away from the 1.10.* to distinguish
636 between release A and the trial.
640 2019 November 7; version 1.12.0
641 -------------------------------
643 Version cut to support continued development for next release
644 preserving the 1.11.* versions for release 1 (Amber) and
649 2019 October 31; version 1.10.2
650 -------------------------------
652 Provide the means to increase the payload size of a received
653 message without losing the data needed to use the
654 rmr_rts_msg() funciton.
658 2019 October 21; version 1.10.1
659 -------------------------------
661 Fix to prevent null message buffer from being returned by the
662 timeout receive function if the function is passed one to
667 2019 October 21; version 1.10.1
668 -------------------------------
670 Add periodic dump of send count info to stderr.
674 2019 September 27; version 1.9.0
675 --------------------------------
677 Python bindings added receive all queued function and
678 corrected a unit test
682 2019 September 25; version 1.8.3
683 --------------------------------
685 Correct application level test issue causing timing problems
686 during jenkins verification testing at command and merge
688 Handle the NNG connection shutdown status which may now be
689 generated when a connection throug a proxy is reset.
693 2019 September 25; version 1.8.2
694 --------------------------------
696 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
700 2019 September 19; version 1.8.1
701 --------------------------------
703 Correct missing constant for wrappers.
707 2019 September 19; version 1.8.0
708 --------------------------------
710 New message types added:
711 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
715 2019 September 17; version 1.7.0
716 --------------------------------
718 Initial connection mode now defaults to asynchronous. Set
719 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
720 invoked to revert to synchronous first TCP connections.
721 (Recovery connection attempts have always been asynchronous).
725 2019 September 3; version 1.6.0
726 -------------------------------
728 Fix bug in the rmr_rts_msg() function. If a return to sender
729 message failed, the source IP address was not correctly
730 adjusted and could cause the message to be "reflected" back
731 to the sender on a retry.
733 Added the ability to set the source "ID" via an environment
734 var (RMR_SRC_ID). When present in the environment, the string
735 will be placed in to the message header as the source and
736 thus be used by an application calling rmr_rts_smg() to
737 return a response to the sender. If this environment variable
738 is not present, the host name (original behaviour) is used.
742 2019 August 26; version 1.4.0
743 -----------------------------
745 New message types were added.
749 2019 August 16; version 1.3.0
750 -----------------------------
752 New mesage types added.
756 2019 August 13; version 1.2.0 (API change, non-breaking)
757 --------------------------------------------------------
759 The function rmr_get_xact() was added to proide a convenient
760 way to extract the transaction field from a message.
764 2019 August 8; version 1.1.0 (API change)
765 -----------------------------------------
767 This change should be backward compatable/non-breaking A new
768 field has been added to the message buffer (rmr_mbuf_t). This
769 field (tp_state) is used to communicate the errno value that
770 the transport mechanism might set during send and/or receive
771 operations. C programmes should continue to use errno
772 directly, but in some environments wrappers may not be able
773 to access errno and this provides the value to them. See the
774 rmr_alloc_msg manual page for more details.
778 2019 August 6; version 1.0.45 (build changes)
779 ---------------------------------------------
781 Support for the Nanomsg transport library has been dropped.
782 The library librmr.* will no longer be included in packages.
784 Packages will install RMR libraries into the system preferred
785 target directory. On some systems this is /usr/local/lib
786 and on others it is /usr/local/lib64. The diretory is
787 determined by the sytem on which the package is built and
788 NOT by the system installing the package, so it's possible
789 that the RMR libraries end up in a strange location if the
790 .deb or .rpm file was generated on a Linux flavour that
791 has a different preference than the one where the package
796 2019 August 6; version 1.0.44 (API change)
797 ------------------------------------------
799 Added a new message type constant.
803 2019 July 15; Version 1.0.39 (bug fix)
804 --------------------------------------
806 Prevent unnecessary usleep in retry loop.
810 2019 July 12; Version 1.0.38 (API change)
811 -----------------------------------------
813 Added new message types to RIC_message_types.h.
817 2019 July 11; Version 1.0.37
818 ----------------------------
821 librmr and librmr_nng
822 - Add message buffer API function rmr_trace_ref()
823 (see rmr_trace_ref.3 manual page in dev package).
827 2020 April 8; Version n/a
828 -------------------------
830 RMR Python moved to Python Xapp Framework
831 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
835 2020 February 29; Version 2.4.0
836 -------------------------------
838 Add consolidated testing under CMake Add support binary for
839 health check (SI95 only)
843 2020 February 28; Version 2.3.6
844 -------------------------------
846 Fix bug in Rt. Mgr comm which prevented table ID from being
847 sent on ack message (RIC-232).