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 October 30; Version 4.3.1
26 ------------------------------
28 Changes to address code analyser scans and two bug fixes
29 identified while addressing the analysis data. (RIC-673)
33 2020 October 2; Version 4.3.0
34 -----------------------------
36 Add message types for traffic steering anomaly messages
40 2020 September 15; Version 4.2.4
41 --------------------------------
43 Add man page for the rmr_set_low_latency() function (RIC-631)
47 2020 September 15; Version 4.2.3
48 --------------------------------
50 Correct arg processing bug in rmr_rpobe (RIC-645)
54 2020 August 4; Version 4.2.2
55 ----------------------------
57 Correct bug in the rmr_probe support utility when -r option
58 is used on the command line (RIC-644)
62 2020 August 4; Version 4.2.1
63 ----------------------------
65 Add additional environment variable dump if RMR_LOG_VLEVEL
70 2020 August 3; Version 4.2.0
71 ----------------------------
73 Add support for the RMR_RTREQ_FREQ environment variable to
74 control the request frequency for a new route table (default
75 5s if not supplied). (RIC-630)
79 2020 July 21; Version 4.1.4
80 ---------------------------
82 Fix bug in SI95 -- possible use of pointer after free
87 2020 July 9; version 4.1.3
88 --------------------------
90 Allow RTS messages to be sent before the arrival of the
91 initial route table. Calls to RTS (heart beat responses)
92 prior to the initial route table load could cause a crash if
93 a framework blindly assumes that RTS is valid. (RIC-589)
97 2020 June 22; version 4.1.2
98 ---------------------------
100 Fix typo in RIC Message header file.
102 Add document for message type constants and the scripts which
107 2020 June 22; version 4.1.1
108 ---------------------------
110 Add new message types to RIC header file for
112 RIC_ALARM_QUERY (111)
114 RAN_E2_RESET_REQ (12008)
115 RAN_E2_RESET_RESP (12009)
119 2020 June 18; version 4.1.0
120 ---------------------------
122 Bump version minor to move away from 4.0.* which will bump
123 for any patches applied back to bronze.
125 Add magic C++ goo to symtab header file allowing C++ xAPPs to
126 use the symbol table directly.
135 2020 May 06; version 4.0.5
136 --------------------------
138 Fix the bug in SI95 receive message management semaphore
139 count issue. (RIC-355)
143 2020 April 29; version 4.0.4
144 ----------------------------
146 Fix the traffic steering message type constants (again)
151 2020 April 28; version 4.0.3
152 ----------------------------
154 Fix sonar flagged bugs (RIC-78)
158 2020 April 24; version 4.0.2
159 ----------------------------
161 Correct bug in SI95 transport header length validation
166 2020 April 22; version 4.0.1
167 ----------------------------
169 Correct message type constant for Traffic Steering
170 predication (RIC-342)
174 2020 April 21; version 4.0.0
175 ----------------------------
177 The NNG based libraries are no longer included in the RMR
178 packages. This is considered a breaking change as NNG will
179 not be supported by default. It is still possible to build
180 with RMR-NNG libraries, but that is the exception. The API
181 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
182 means that the underlying transport mechanism is limited only
185 The rmr_rcv_specific() function has been deprecated as it was
186 necessary only for NNG and Nanomsg support. Its use should be
191 2020 April 20; version 3.8.2
192 ----------------------------
194 Fix bug which was preventing an instance receiving dynamic
195 route table updates. (RIC-336)
199 2020 April 20; version 3.8.1
200 ----------------------------
202 Add user guide which replaces the concatenation of man pages
207 2020 April 17; version 3.8.0
208 ----------------------------
210 Add safe connect to avoid potential connect bug on Linux
213 Change debugging in route table collector to avoid possible
214 segment fault when in level 2 debug (RIC-335)
218 2020 April 15; version 3.7.4
219 ----------------------------
221 Add missing message type to header file (RIC-334)
225 2020 April 14; version 3.7.3
226 ----------------------------
228 Fix bug in rmr_call() when using SI95 (RIC-333)
232 2020 April 10; version 3.7.2
233 ----------------------------
235 Fix bug related to static route table only mode (RIC-331)
239 2020 April 9; version 3.7.1
240 ---------------------------
242 The max length restriction for receiving messages when using
243 SI95 has been removed. The length supplied during
244 initialisation is used as the "normal maximum" and default
245 buffer allocation size, but messages arriving which are
246 larger are accepted. (RIC-309)
250 2020 April 7; version 3.7.0
251 ---------------------------
253 The health check support programme was renamed to rmr_probe
258 2020 April 6; version 3.6.6
259 ---------------------------
261 Correct bug in SI95 address conversion module (RIC-327)
262 Correct bug in SI initialisation module
266 2020 April 2; version 3.6.5
267 ---------------------------
269 Correct potential nil pointer use when examining interfaces
270 for use as a listen target (RIC-307)
274 2020 April 1; version 3.6.4
275 ---------------------------
277 Correct potential nil pointer use in the NNG interface
278 (RIC-303) Correct issue preventing CI build without a
283 2020 March 30; version 3.6.3
284 ----------------------------
286 Correct the max receive message size constant in rmr.h
291 2020 March 23; version 3.6.2
292 ----------------------------
294 Fix message initialisation bug when pulling a message from
299 2020 March 19; version 3.6.1
300 ----------------------------
302 Fix problem with RPM package install
306 2020 March 18; version 3.6.0
307 ----------------------------
309 Add message types to support traffic steering
313 2020 March 16; version 3.5.2
314 ----------------------------
316 Correct bug in the meid table parser that prevented the
317 ack/nack of meid tables (RIC-273)
321 2020 March 10; version 3.5.1
322 ----------------------------
324 Add missing health check message types.
328 2020 March 9; version 3.5.0
329 ---------------------------
331 Added new wormhole send function: rmr_wh_call().
335 2020 March 6; version 3.4.0
336 ---------------------------
338 Add new wormhole state function: rmr_wh_state().
342 2020 March 5; Version 3.3.1
343 ---------------------------
345 Correct several "bugs" identified by automatic code analysis.
349 2020 March 4; Version 3.3.0
350 ---------------------------
352 Add SI95 based unit testing Health check support binary added
353 (reason for minor bump)
357 2020 February 26; version 3.2.5
358 -------------------------------
360 Fix source address bug in SI95 receive/send funcitons. Fix
361 threading issues involving session disconnection in SI95
362 Remove unused SI95 status variable.
366 2020 February 24; version 3.2.4
367 -------------------------------
369 Fix meid bug (RIC-220) causing core dump.
373 2020 February 21; version 3.2.3
374 -------------------------------
376 Add meid routing support to the SI95 interface.
380 2020 February 20; version 3.2.2
381 -------------------------------
383 Fix receive thread related core dump (ring early unlock).
387 2020 February 19; version 3.2.1
388 -------------------------------
390 Added missing message types (E2-Setup)
394 2020 February 18; version 3.2.0
395 -------------------------------
397 Added support for new Route Manager and it's ability to
398 accept a request for table update.
402 2020 February 14; version 3.1.3
403 -------------------------------
405 Fix bug in SIsend which was causing a core dump in some cases
406 where the application attempted to send on a connection that
407 had disconnected. (RIC-207).
411 2020 February 6; version 3.1.2
412 ------------------------------
414 Fix disconnection detection bug in interface to SI95.
418 2020 January 31; verison 3.1.1
419 ------------------------------
421 Allow route table thread logging to be completely disabled
422 when logging is turned off.
426 2020 January 26; verison 3.1.0
427 ------------------------------
429 First step to allowing the user programme to control messages
430 written to standard error. Introduces the rmr_set_vlevel()
431 function, and related environment variable.
435 2020 January 24; verison 3.0.5
436 ------------------------------
438 Fix bug in SI95 with receive buffer allocation.
442 2020 January 23; verison 3.0.4
443 ------------------------------
445 Fix bug in SI95 causing excessive CPU usage on poll.
449 2020 January 22; verison 3.0.3
450 ------------------------------
452 Enable thread support for multiple receive threads.
456 2020 January 21; verison 3.0.2
457 ------------------------------
459 Fix bug in SI95 (missing reallocate payload function).
463 2020 January 20; verison 3.0.1
464 ------------------------------
466 Enable support for dynamic route table updates via RMR
471 2020 January 16; version 3.0.0
472 ------------------------------
474 Introduce support for SI95 transport library to replace NNG.
475 (RMR library versions will use leading odd numbers to avoid
476 tag collisions with the wrapper tags which will use even
481 2019 December 9; version 1.13.1
482 -------------------------------
484 Correct documentation and missing rel-notes update for RTD.
488 2019 December 6; version 1.13.0
489 -------------------------------
491 Add ability to route messages based on the MEID in a message
492 combined with the message type/subscription-ID.
501 2019 November 14; version 1.11.1
502 --------------------------------
504 Fix bug in payload reallocation function; correct length of
505 payload was not always copied.
509 2019 November 13; version 1.12.1
510 --------------------------------
512 New message type constants added to support A1.
516 2019 November 4; version 1.11.0
517 -------------------------------
519 Version bump to move away from the 1.10.* to distinguish
520 between release A and the trial.
524 2019 November 7; version 1.12.0
525 -------------------------------
527 Version cut to support continued development for next release
528 preserving the 1.11.* versions for release 1 (Amber) and
533 2019 October 31; version 1.10.2
534 -------------------------------
536 Provide the means to increase the payload size of a received
537 message without losing the data needed to use the
538 rmr_rts_msg() funciton.
542 2019 October 21; version 1.10.1
543 -------------------------------
545 Fix to prevent null message buffer from being returned by the
546 timeout receive function if the function is passed one to
551 2019 October 21; version 1.10.1
552 -------------------------------
554 Add periodic dump of send count info to stderr.
558 2019 September 27; version 1.9.0
559 --------------------------------
561 Python bindings added receive all queued function and
562 corrected a unit test
566 2019 September 25; version 1.8.3
567 --------------------------------
569 Correct application level test issue causing timing problems
570 during jenkins verification testing at command and merge
572 Handle the NNG connection shutdown status which may now be
573 generated when a connection throug a proxy is reset.
577 2019 September 25; version 1.8.2
578 --------------------------------
580 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
584 2019 September 19; version 1.8.1
585 --------------------------------
587 Correct missing constant for wrappers.
591 2019 September 19; version 1.8.0
592 --------------------------------
594 New message types added:
595 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
599 2019 September 17; version 1.7.0
600 --------------------------------
602 Initial connection mode now defaults to asynchronous. Set
603 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
604 invoked to revert to synchronous first TCP connections.
605 (Recovery connection attempts have always been asynchronous).
609 2019 September 3; version 1.6.0
610 -------------------------------
612 Fix bug in the rmr_rts_msg() function. If a return to sender
613 message failed, the source IP address was not correctly
614 adjusted and could cause the message to be "reflected" back
615 to the sender on a retry.
617 Added the ability to set the source "ID" via an environment
618 var (RMR_SRC_ID). When present in the environment, the string
619 will be placed in to the message header as the source and
620 thus be used by an application calling rmr_rts_smg() to
621 return a response to the sender. If this environment variable
622 is not present, the host name (original behaviour) is used.
626 2019 August 26; version 1.4.0
627 -----------------------------
629 New message types were added.
633 2019 August 16; version 1.3.0
634 -----------------------------
636 New mesage types added.
640 2019 August 13; version 1.2.0 (API change, non-breaking)
641 --------------------------------------------------------
643 The function rmr_get_xact() was added to proide a convenient
644 way to extract the transaction field from a message.
648 2019 August 8; version 1.1.0 (API change)
649 -----------------------------------------
651 This change should be backward compatable/non-breaking A new
652 field has been added to the message buffer (rmr_mbuf_t). This
653 field (tp_state) is used to communicate the errno value that
654 the transport mechanism might set during send and/or receive
655 operations. C programmes should continue to use errno
656 directly, but in some environments wrappers may not be able
657 to access errno and this provides the value to them. See the
658 rmr_alloc_msg manual page for more details.
662 2019 August 6; version 1.0.45 (build changes)
663 ---------------------------------------------
665 Support for the Nanomsg transport library has been dropped.
666 The library librmr.* will no longer be included in packages.
668 Packages will install RMR libraries into the system preferred
669 target directory. On some systems this is /usr/local/lib
670 and on others it is /usr/local/lib64. The diretory is
671 determined by the sytem on which the package is built and
672 NOT by the system installing the package, so it's possible
673 that the RMR libraries end up in a strange location if the
674 .deb or .rpm file was generated on a Linux flavour that
675 has a different preference than the one where the package
680 2019 August 6; version 1.0.44 (API change)
681 ------------------------------------------
683 Added a new message type constant.
687 2019 July 15; Version 1.0.39 (bug fix)
688 --------------------------------------
690 Prevent unnecessary usleep in retry loop.
694 2019 July 12; Version 1.0.38 (API change)
695 -----------------------------------------
697 Added new message types to RIC_message_types.h.
701 2019 July 11; Version 1.0.37
702 ----------------------------
705 librmr and librmr_nng
706 - Add message buffer API function rmr_trace_ref()
707 (see rmr_trace_ref.3 manual page in dev package).
711 2020 April 8; Version n/a
712 -------------------------
714 RMR Python moved to Python Xapp Framework
715 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
719 2020 February 29; Version 2.4.0
720 -------------------------------
722 Add consolidated testing under CMake Add support binary for
723 health check (SI95 only)
727 2020 February 28; Version 2.3.6
728 -------------------------------
730 Fix bug in Rt. Mgr comm which prevented table ID from being
731 sent on ack message (RIC-232).