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 2020 December 4; Version 4.4.6
26 ------------------------------
28 Correct a range check bug when cloning a route table in prep
29 to load a new one. (RIC-720)
33 2020 November 17; Version 4.4.5
34 -------------------------------
36 Correct bug in round robin group allocation that could lead
37 to an empty group. (RIC-695)
41 2020 November 13; Version 4.4.4
42 -------------------------------
44 Correct address memory leak in the RTE cleanup. (RIC-674)
48 2020 November 4; Version 4.4.3
49 ------------------------------
51 Correct bug introduced with race fix (4.4.0) (RIC-674)
55 2020 November 4; Version 4.4.2
56 ------------------------------
58 Changes to correct more complaints generated by a code scan.
59 (RIC-673) Also addressed some sonar coverage issues with unit
64 2020 November 4; Version 4.4.1
65 ------------------------------
67 Changes to correct complaints generated by a code scan.
72 2020 November 4; Version 4.4.0
73 ------------------------------
75 Changes to address a potential race condition when route
76 tables arrive in quick succession. (RIC-674)
80 2020 October 30; Version 4.3.1
81 ------------------------------
83 Changes to address code analyser scans and two bug fixes
84 identified while addressing the analysis data. (RIC-673)
88 2020 October 2; Version 4.3.0
89 -----------------------------
91 Add message types for traffic steering anomaly messages
95 2020 September 15; Version 4.2.4
96 --------------------------------
98 Add man page for the rmr_set_low_latency() function (RIC-631)
102 2020 September 15; Version 4.2.3
103 --------------------------------
105 Correct arg processing bug in rmr_rpobe (RIC-645)
109 2020 August 4; Version 4.2.2
110 ----------------------------
112 Correct bug in the rmr_probe support utility when -r option
113 is used on the command line (RIC-644)
117 2020 August 4; Version 4.2.1
118 ----------------------------
120 Add additional environment variable dump if RMR_LOG_VLEVEL
125 2020 August 3; Version 4.2.0
126 ----------------------------
128 Add support for the RMR_RTREQ_FREQ environment variable to
129 control the request frequency for a new route table (default
130 5s if not supplied). (RIC-630)
134 2020 July 21; Version 4.1.4
135 ---------------------------
137 Fix bug in SI95 -- possible use of pointer after free
142 2020 July 9; version 4.1.3
143 --------------------------
145 Allow RTS messages to be sent before the arrival of the
146 initial route table. Calls to RTS (heart beat responses)
147 prior to the initial route table load could cause a crash if
148 a framework blindly assumes that RTS is valid. (RIC-589)
152 2020 June 22; version 4.1.2
153 ---------------------------
155 Fix typo in RIC Message header file.
157 Add document for message type constants and the scripts which
162 2020 June 22; version 4.1.1
163 ---------------------------
165 Add new message types to RIC header file for
167 RIC_ALARM_QUERY (111)
169 RAN_E2_RESET_REQ (12008)
170 RAN_E2_RESET_RESP (12009)
174 2020 June 18; version 4.1.0
175 ---------------------------
177 Bump version minor to move away from 4.0.* which will bump
178 for any patches applied back to bronze.
180 Add magic C++ goo to symtab header file allowing C++ xAPPs to
181 use the symbol table directly.
190 2020 May 06; version 4.0.5
191 --------------------------
193 Fix the bug in SI95 receive message management semaphore
194 count issue. (RIC-355)
198 2020 April 29; version 4.0.4
199 ----------------------------
201 Fix the traffic steering message type constants (again)
206 2020 April 28; version 4.0.3
207 ----------------------------
209 Fix sonar flagged bugs (RIC-78)
213 2020 April 24; version 4.0.2
214 ----------------------------
216 Correct bug in SI95 transport header length validation
221 2020 April 22; version 4.0.1
222 ----------------------------
224 Correct message type constant for Traffic Steering
225 predication (RIC-342)
229 2020 April 21; version 4.0.0
230 ----------------------------
232 The NNG based libraries are no longer included in the RMR
233 packages. This is considered a breaking change as NNG will
234 not be supported by default. It is still possible to build
235 with RMR-NNG libraries, but that is the exception. The API
236 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
237 means that the underlying transport mechanism is limited only
240 The rmr_rcv_specific() function has been deprecated as it was
241 necessary only for NNG and Nanomsg support. Its use should be
246 2020 April 20; version 3.8.2
247 ----------------------------
249 Fix bug which was preventing an instance receiving dynamic
250 route table updates. (RIC-336)
254 2020 April 20; version 3.8.1
255 ----------------------------
257 Add user guide which replaces the concatenation of man pages
262 2020 April 17; version 3.8.0
263 ----------------------------
265 Add safe connect to avoid potential connect bug on Linux
268 Change debugging in route table collector to avoid possible
269 segment fault when in level 2 debug (RIC-335)
273 2020 April 15; version 3.7.4
274 ----------------------------
276 Add missing message type to header file (RIC-334)
280 2020 April 14; version 3.7.3
281 ----------------------------
283 Fix bug in rmr_call() when using SI95 (RIC-333)
287 2020 April 10; version 3.7.2
288 ----------------------------
290 Fix bug related to static route table only mode (RIC-331)
294 2020 April 9; version 3.7.1
295 ---------------------------
297 The max length restriction for receiving messages when using
298 SI95 has been removed. The length supplied during
299 initialisation is used as the "normal maximum" and default
300 buffer allocation size, but messages arriving which are
301 larger are accepted. (RIC-309)
305 2020 April 7; version 3.7.0
306 ---------------------------
308 The health check support programme was renamed to rmr_probe
313 2020 April 6; version 3.6.6
314 ---------------------------
316 Correct bug in SI95 address conversion module (RIC-327)
317 Correct bug in SI initialisation module
321 2020 April 2; version 3.6.5
322 ---------------------------
324 Correct potential nil pointer use when examining interfaces
325 for use as a listen target (RIC-307)
329 2020 April 1; version 3.6.4
330 ---------------------------
332 Correct potential nil pointer use in the NNG interface
333 (RIC-303) Correct issue preventing CI build without a
338 2020 March 30; version 3.6.3
339 ----------------------------
341 Correct the max receive message size constant in rmr.h
346 2020 March 23; version 3.6.2
347 ----------------------------
349 Fix message initialisation bug when pulling a message from
354 2020 March 19; version 3.6.1
355 ----------------------------
357 Fix problem with RPM package install
361 2020 March 18; version 3.6.0
362 ----------------------------
364 Add message types to support traffic steering
368 2020 March 16; version 3.5.2
369 ----------------------------
371 Correct bug in the meid table parser that prevented the
372 ack/nack of meid tables (RIC-273)
376 2020 March 10; version 3.5.1
377 ----------------------------
379 Add missing health check message types.
383 2020 March 9; version 3.5.0
384 ---------------------------
386 Added new wormhole send function: rmr_wh_call().
390 2020 March 6; version 3.4.0
391 ---------------------------
393 Add new wormhole state function: rmr_wh_state().
397 2020 March 5; Version 3.3.1
398 ---------------------------
400 Correct several "bugs" identified by automatic code analysis.
404 2020 March 4; Version 3.3.0
405 ---------------------------
407 Add SI95 based unit testing Health check support binary added
408 (reason for minor bump)
412 2020 February 26; version 3.2.5
413 -------------------------------
415 Fix source address bug in SI95 receive/send funcitons. Fix
416 threading issues involving session disconnection in SI95
417 Remove unused SI95 status variable.
421 2020 February 24; version 3.2.4
422 -------------------------------
424 Fix meid bug (RIC-220) causing core dump.
428 2020 February 21; version 3.2.3
429 -------------------------------
431 Add meid routing support to the SI95 interface.
435 2020 February 20; version 3.2.2
436 -------------------------------
438 Fix receive thread related core dump (ring early unlock).
442 2020 February 19; version 3.2.1
443 -------------------------------
445 Added missing message types (E2-Setup)
449 2020 February 18; version 3.2.0
450 -------------------------------
452 Added support for new Route Manager and it's ability to
453 accept a request for table update.
457 2020 February 14; version 3.1.3
458 -------------------------------
460 Fix bug in SIsend which was causing a core dump in some cases
461 where the application attempted to send on a connection that
462 had disconnected. (RIC-207).
466 2020 February 6; version 3.1.2
467 ------------------------------
469 Fix disconnection detection bug in interface to SI95.
473 2020 January 31; verison 3.1.1
474 ------------------------------
476 Allow route table thread logging to be completely disabled
477 when logging is turned off.
481 2020 January 26; verison 3.1.0
482 ------------------------------
484 First step to allowing the user programme to control messages
485 written to standard error. Introduces the rmr_set_vlevel()
486 function, and related environment variable.
490 2020 January 24; verison 3.0.5
491 ------------------------------
493 Fix bug in SI95 with receive buffer allocation.
497 2020 January 23; verison 3.0.4
498 ------------------------------
500 Fix bug in SI95 causing excessive CPU usage on poll.
504 2020 January 22; verison 3.0.3
505 ------------------------------
507 Enable thread support for multiple receive threads.
511 2020 January 21; verison 3.0.2
512 ------------------------------
514 Fix bug in SI95 (missing reallocate payload function).
518 2020 January 20; verison 3.0.1
519 ------------------------------
521 Enable support for dynamic route table updates via RMR
526 2020 January 16; version 3.0.0
527 ------------------------------
529 Introduce support for SI95 transport library to replace NNG.
530 (RMR library versions will use leading odd numbers to avoid
531 tag collisions with the wrapper tags which will use even
536 2019 December 9; version 1.13.1
537 -------------------------------
539 Correct documentation and missing rel-notes update for RTD.
543 2019 December 6; version 1.13.0
544 -------------------------------
546 Add ability to route messages based on the MEID in a message
547 combined with the message type/subscription-ID.
556 2019 November 14; version 1.11.1
557 --------------------------------
559 Fix bug in payload reallocation function; correct length of
560 payload was not always copied.
564 2019 November 13; version 1.12.1
565 --------------------------------
567 New message type constants added to support A1.
571 2019 November 4; version 1.11.0
572 -------------------------------
574 Version bump to move away from the 1.10.* to distinguish
575 between release A and the trial.
579 2019 November 7; version 1.12.0
580 -------------------------------
582 Version cut to support continued development for next release
583 preserving the 1.11.* versions for release 1 (Amber) and
588 2019 October 31; version 1.10.2
589 -------------------------------
591 Provide the means to increase the payload size of a received
592 message without losing the data needed to use the
593 rmr_rts_msg() funciton.
597 2019 October 21; version 1.10.1
598 -------------------------------
600 Fix to prevent null message buffer from being returned by the
601 timeout receive function if the function is passed one to
606 2019 October 21; version 1.10.1
607 -------------------------------
609 Add periodic dump of send count info to stderr.
613 2019 September 27; version 1.9.0
614 --------------------------------
616 Python bindings added receive all queued function and
617 corrected a unit test
621 2019 September 25; version 1.8.3
622 --------------------------------
624 Correct application level test issue causing timing problems
625 during jenkins verification testing at command and merge
627 Handle the NNG connection shutdown status which may now be
628 generated when a connection throug a proxy is reset.
632 2019 September 25; version 1.8.2
633 --------------------------------
635 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
639 2019 September 19; version 1.8.1
640 --------------------------------
642 Correct missing constant for wrappers.
646 2019 September 19; version 1.8.0
647 --------------------------------
649 New message types added:
650 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
654 2019 September 17; version 1.7.0
655 --------------------------------
657 Initial connection mode now defaults to asynchronous. Set
658 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
659 invoked to revert to synchronous first TCP connections.
660 (Recovery connection attempts have always been asynchronous).
664 2019 September 3; version 1.6.0
665 -------------------------------
667 Fix bug in the rmr_rts_msg() function. If a return to sender
668 message failed, the source IP address was not correctly
669 adjusted and could cause the message to be "reflected" back
670 to the sender on a retry.
672 Added the ability to set the source "ID" via an environment
673 var (RMR_SRC_ID). When present in the environment, the string
674 will be placed in to the message header as the source and
675 thus be used by an application calling rmr_rts_smg() to
676 return a response to the sender. If this environment variable
677 is not present, the host name (original behaviour) is used.
681 2019 August 26; version 1.4.0
682 -----------------------------
684 New message types were added.
688 2019 August 16; version 1.3.0
689 -----------------------------
691 New mesage types added.
695 2019 August 13; version 1.2.0 (API change, non-breaking)
696 --------------------------------------------------------
698 The function rmr_get_xact() was added to proide a convenient
699 way to extract the transaction field from a message.
703 2019 August 8; version 1.1.0 (API change)
704 -----------------------------------------
706 This change should be backward compatable/non-breaking A new
707 field has been added to the message buffer (rmr_mbuf_t). This
708 field (tp_state) is used to communicate the errno value that
709 the transport mechanism might set during send and/or receive
710 operations. C programmes should continue to use errno
711 directly, but in some environments wrappers may not be able
712 to access errno and this provides the value to them. See the
713 rmr_alloc_msg manual page for more details.
717 2019 August 6; version 1.0.45 (build changes)
718 ---------------------------------------------
720 Support for the Nanomsg transport library has been dropped.
721 The library librmr.* will no longer be included in packages.
723 Packages will install RMR libraries into the system preferred
724 target directory. On some systems this is /usr/local/lib
725 and on others it is /usr/local/lib64. The diretory is
726 determined by the sytem on which the package is built and
727 NOT by the system installing the package, so it's possible
728 that the RMR libraries end up in a strange location if the
729 .deb or .rpm file was generated on a Linux flavour that
730 has a different preference than the one where the package
735 2019 August 6; version 1.0.44 (API change)
736 ------------------------------------------
738 Added a new message type constant.
742 2019 July 15; Version 1.0.39 (bug fix)
743 --------------------------------------
745 Prevent unnecessary usleep in retry loop.
749 2019 July 12; Version 1.0.38 (API change)
750 -----------------------------------------
752 Added new message types to RIC_message_types.h.
756 2019 July 11; Version 1.0.37
757 ----------------------------
760 librmr and librmr_nng
761 - Add message buffer API function rmr_trace_ref()
762 (see rmr_trace_ref.3 manual page in dev package).
766 2020 April 8; Version n/a
767 -------------------------
769 RMR Python moved to Python Xapp Framework
770 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
774 2020 February 29; Version 2.4.0
775 -------------------------------
777 Add consolidated testing under CMake Add support binary for
778 health check (SI95 only)
782 2020 February 28; Version 2.3.6
783 -------------------------------
785 Fix bug in Rt. Mgr comm which prevented table ID from being
786 sent on ack message (RIC-232).