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 August 3; Version 4.2.0
26 ----------------------------
28 Add support for the RMR_RTREQ_FREQ environment variable to
29 control the request frequency for a new route table (default
30 5s if not supplied). (RIC-630)
34 2020 July 21; Version 4.1.4
35 ---------------------------
37 Fix bug in SI95 -- possible use of pointer after free
42 2020 July 9; version 4.1.3
43 --------------------------
45 Allow RTS messages to be sent before the arrival of the
46 initial route table. Calls to RTS (heart beat responses)
47 prior to the initial route table load could cause a crash if
48 a framework blindly assumes that RTS is valid. (RIC-589)
52 2020 June 22; version 4.1.2
53 ---------------------------
55 Fix typo in RIC Message header file.
57 Add document for message type constants and the scripts which
62 2020 June 22; version 4.1.1
63 ---------------------------
65 Add new message types to RIC header file for
69 RAN_E2_RESET_REQ (12008)
70 RAN_E2_RESET_RESP (12009)
74 2020 June 18; version 4.1.0
75 ---------------------------
77 Bump version minor to move away from 4.0.* which will bump
78 for any patches applied back to bronze.
80 Add magic C++ goo to symtab header file allowing C++ xAPPs to
81 use the symbol table directly.
90 2020 May 06; version 4.0.5
91 --------------------------
93 Fix the bug in SI95 receive message management semaphore
94 count issue. (RIC-355)
98 2020 April 29; version 4.0.4
99 ----------------------------
101 Fix the traffic steering message type constants (again)
106 2020 April 28; version 4.0.3
107 ----------------------------
109 Fix sonar flagged bugs (RIC-78)
113 2020 April 24; version 4.0.2
114 ----------------------------
116 Correct bug in SI95 transport header length validation
121 2020 April 22; version 4.0.1
122 ----------------------------
124 Correct message type constant for Traffic Steering
125 predication (RIC-342)
129 2020 April 21; version 4.0.0
130 ----------------------------
132 The NNG based libraries are no longer included in the RMR
133 packages. This is considered a breaking change as NNG will
134 not be supported by default. It is still possible to build
135 with RMR-NNG libraries, but that is the exception. The API
136 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
137 means that the underlying transport mechanism is limited only
140 The rmr_rcv_specific() function has been deprecated as it was
141 necessary only for NNG and Nanomsg support. Its use should be
146 2020 April 20; version 3.8.2
147 ----------------------------
149 Fix bug which was preventing an instance receiving dynamic
150 route table updates. (RIC-336)
154 2020 April 20; version 3.8.1
155 ----------------------------
157 Add user guide which replaces the concatenation of man pages
162 2020 April 17; version 3.8.0
163 ----------------------------
165 Add safe connect to avoid potential connect bug on Linux
168 Change debugging in route table collector to avoid possible
169 segment fault when in level 2 debug (RIC-335)
173 2020 April 15; version 3.7.4
174 ----------------------------
176 Add missing message type to header file (RIC-334)
180 2020 April 14; version 3.7.3
181 ----------------------------
183 Fix bug in rmr_call() when using SI95 (RIC-333)
187 2020 April 10; version 3.7.2
188 ----------------------------
190 Fix bug related to static route table only mode (RIC-331)
194 2020 April 9; version 3.7.1
195 ---------------------------
197 The max length restriction for receiving messages when using
198 SI95 has been removed. The length supplied during
199 initialisation is used as the "normal maximum" and default
200 buffer allocation size, but messages arriving which are
201 larger are accepted. (RIC-309)
205 2020 April 7; version 3.7.0
206 ---------------------------
208 The health check support programme was renamed to rmr_probe
213 2020 April 6; version 3.6.6
214 ---------------------------
216 Correct bug in SI95 address conversion module (RIC-327)
217 Correct bug in SI initialisation module
221 2020 April 2; version 3.6.5
222 ---------------------------
224 Correct potential nil pointer use when examining interfaces
225 for use as a listen target (RIC-307)
229 2020 April 1; version 3.6.4
230 ---------------------------
232 Correct potential nil pointer use in the NNG interface
233 (RIC-303) Correct issue preventing CI build without a
238 2020 March 30; version 3.6.3
239 ----------------------------
241 Correct the max receive message size constant in rmr.h
246 2020 March 23; version 3.6.2
247 ----------------------------
249 Fix message initialisation bug when pulling a message from
254 2020 March 19; version 3.6.1
255 ----------------------------
257 Fix problem with RPM package install
261 2020 March 18; version 3.6.0
262 ----------------------------
264 Add message types to support traffic steering
268 2020 March 16; version 3.5.2
269 ----------------------------
271 Correct bug in the meid table parser that prevented the
272 ack/nack of meid tables (RIC-273)
276 2020 March 10; version 3.5.1
277 ----------------------------
279 Add missing health check message types.
283 2020 March 9; version 3.5.0
284 ---------------------------
286 Added new wormhole send function: rmr_wh_call().
290 2020 March 6; version 3.4.0
291 ---------------------------
293 Add new wormhole state function: rmr_wh_state().
297 2020 March 5; Version 3.3.1
298 ---------------------------
300 Correct several "bugs" identified by automatic code analysis.
304 2020 March 4; Version 3.3.0
305 ---------------------------
307 Add SI95 based unit testing Health check support binary added
308 (reason for minor bump)
312 2020 February 26; version 3.2.5
313 -------------------------------
315 Fix source address bug in SI95 receive/send funcitons. Fix
316 threading issues involving session disconnection in SI95
317 Remove unused SI95 status variable.
321 2020 February 24; version 3.2.4
322 -------------------------------
324 Fix meid bug (RIC-220) causing core dump.
328 2020 February 21; version 3.2.3
329 -------------------------------
331 Add meid routing support to the SI95 interface.
335 2020 February 20; version 3.2.2
336 -------------------------------
338 Fix receive thread related core dump (ring early unlock).
342 2020 February 19; version 3.2.1
343 -------------------------------
345 Added missing message types (E2-Setup)
349 2020 February 18; version 3.2.0
350 -------------------------------
352 Added support for new Route Manager and it's ability to
353 accept a request for table update.
357 2020 February 14; version 3.1.3
358 -------------------------------
360 Fix bug in SIsend which was causing a core dump in some cases
361 where the application attempted to send on a connection that
362 had disconnected. (RIC-207).
366 2020 February 6; version 3.1.2
367 ------------------------------
369 Fix disconnection detection bug in interface to SI95.
373 2020 January 31; verison 3.1.1
374 ------------------------------
376 Allow route table thread logging to be completely disabled
377 when logging is turned off.
381 2020 January 26; verison 3.1.0
382 ------------------------------
384 First step to allowing the user programme to control messages
385 written to standard error. Introduces the rmr_set_vlevel()
386 function, and related environment variable.
390 2020 January 24; verison 3.0.5
391 ------------------------------
393 Fix bug in SI95 with receive buffer allocation.
397 2020 January 23; verison 3.0.4
398 ------------------------------
400 Fix bug in SI95 causing excessive CPU usage on poll.
404 2020 January 22; verison 3.0.3
405 ------------------------------
407 Enable thread support for multiple receive threads.
411 2020 January 21; verison 3.0.2
412 ------------------------------
414 Fix bug in SI95 (missing reallocate payload function).
418 2020 January 20; verison 3.0.1
419 ------------------------------
421 Enable support for dynamic route table updates via RMR
426 2020 January 16; version 3.0.0
427 ------------------------------
429 Introduce support for SI95 transport library to replace NNG.
430 (RMR library versions will use leading odd numbers to avoid
431 tag collisions with the wrapper tags which will use even
436 2019 December 9; version 1.13.1
437 -------------------------------
439 Correct documentation and missing rel-notes update for RTD.
443 2019 December 6; version 1.13.0
444 -------------------------------
446 Add ability to route messages based on the MEID in a message
447 combined with the message type/subscription-ID.
456 2019 November 14; version 1.11.1
457 --------------------------------
459 Fix bug in payload reallocation function; correct length of
460 payload was not always copied.
464 2019 November 13; version 1.12.1
465 --------------------------------
467 New message type constants added to support A1.
471 2019 November 4; version 1.11.0
472 -------------------------------
474 Version bump to move away from the 1.10.* to distinguish
475 between release A and the trial.
479 2019 November 7; version 1.12.0
480 -------------------------------
482 Version cut to support continued development for next release
483 preserving the 1.11.* versions for release 1 (Amber) and
488 2019 October 31; version 1.10.2
489 -------------------------------
491 Provide the means to increase the payload size of a received
492 message without losing the data needed to use the
493 rmr_rts_msg() funciton.
497 2019 October 21; version 1.10.1
498 -------------------------------
500 Fix to prevent null message buffer from being returned by the
501 timeout receive function if the function is passed one to
506 2019 October 21; version 1.10.1
507 -------------------------------
509 Add periodic dump of send count info to stderr.
513 2019 September 27; version 1.9.0
514 --------------------------------
516 Python bindings added receive all queued function and
517 corrected a unit test
521 2019 September 25; version 1.8.3
522 --------------------------------
524 Correct application level test issue causing timing problems
525 during jenkins verification testing at command and merge
527 Handle the NNG connection shutdown status which may now be
528 generated when a connection throug a proxy is reset.
532 2019 September 25; version 1.8.2
533 --------------------------------
535 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
539 2019 September 19; version 1.8.1
540 --------------------------------
542 Correct missing constant for wrappers.
546 2019 September 19; version 1.8.0
547 --------------------------------
549 New message types added:
550 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
554 2019 September 17; version 1.7.0
555 --------------------------------
557 Initial connection mode now defaults to asynchronous. Set
558 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
559 invoked to revert to synchronous first TCP connections.
560 (Recovery connection attempts have always been asynchronous).
564 2019 September 3; version 1.6.0
565 -------------------------------
567 Fix bug in the rmr_rts_msg() function. If a return to sender
568 message failed, the source IP address was not correctly
569 adjusted and could cause the message to be "reflected" back
570 to the sender on a retry.
572 Added the ability to set the source "ID" via an environment
573 var (RMR_SRC_ID). When present in the environment, the string
574 will be placed in to the message header as the source and
575 thus be used by an application calling rmr_rts_smg() to
576 return a response to the sender. If this environment variable
577 is not present, the host name (original behaviour) is used.
581 2019 August 26; version 1.4.0
582 -----------------------------
584 New message types were added.
588 2019 August 16; version 1.3.0
589 -----------------------------
591 New mesage types added.
595 2019 August 13; version 1.2.0 (API change, non-breaking)
596 --------------------------------------------------------
598 The function rmr_get_xact() was added to proide a convenient
599 way to extract the transaction field from a message.
603 2019 August 8; version 1.1.0 (API change)
604 -----------------------------------------
606 This change should be backward compatable/non-breaking A new
607 field has been added to the message buffer (rmr_mbuf_t). This
608 field (tp_state) is used to communicate the errno value that
609 the transport mechanism might set during send and/or receive
610 operations. C programmes should continue to use errno
611 directly, but in some environments wrappers may not be able
612 to access errno and this provides the value to them. See the
613 rmr_alloc_msg manual page for more details.
617 2019 August 6; version 1.0.45 (build changes)
618 ---------------------------------------------
620 Support for the Nanomsg transport library has been dropped.
621 The library librmr.* will no longer be included in packages.
623 Packages will install RMR libraries into the system preferred
624 target directory. On some systems this is /usr/local/lib
625 and on others it is /usr/local/lib64. The diretory is
626 determined by the sytem on which the package is built and
627 NOT by the system installing the package, so it's possible
628 that the RMR libraries end up in a strange location if the
629 .deb or .rpm file was generated on a Linux flavour that
630 has a different preference than the one where the package
635 2019 August 6; version 1.0.44 (API change)
636 ------------------------------------------
638 Added a new message type constant.
642 2019 July 15; Version 1.0.39 (bug fix)
643 --------------------------------------
645 Prevent unnecessary usleep in retry loop.
649 2019 July 12; Version 1.0.38 (API change)
650 -----------------------------------------
652 Added new message types to RIC_message_types.h.
656 2019 July 11; Version 1.0.37
657 ----------------------------
660 librmr and librmr_nng
661 - Add message buffer API function rmr_trace_ref()
662 (see rmr_trace_ref.3 manual page in dev package).
666 2020 April 8; Version n/a
667 -------------------------
669 RMR Python moved to Python Xapp Framework
670 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
674 2020 February 29; Version 2.4.0
675 -------------------------------
677 Add consolidated testing under CMake Add support binary for
678 health check (SI95 only)
682 2020 February 28; Version 2.3.6
683 -------------------------------
685 Fix bug in Rt. Mgr comm which prevented table ID from being
686 sent on ack message (RIC-232).