docs/rel-notes.rst

   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.
   6
   7 ============================================================================================
   8 RMR Release Notes
   9 ============================================================================================
  10
  11
  12 RMR Release Notes
  13 =================
  14
  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.
  23
  24
  25 2023 May 28; version 4.9.1
  26 ------------------------------
  27
  28 Fixes IPv6 binding in RMR (RIC-985)
  29
  30
  31 2023 Feb 14; version 4.9.0
  32 ------------------------------
  33
  34 Added new message type for subscription delete required
  35
  36
  37 2022 Nov 10; version 4.8.5
  38 ------------------------------
  39
  40 Fixes for errors detected by source code scanning (RIC-939)
  41
  42
  43 2022 May 11; version 4.8.3
  44 ------------------------------
  45
  46 Added header definitions for config transfer messages (RIC-638)
  47
  48
  49 2022 January 17; version 4.8.2
  50 ------------------------------
  51
  52 Fixes routing statistics printout crash (RIC-872).
  53
  54
  55
  56 2022 January 7; version 4.8.1
  57 ------------------------------
  58
  59 Re-enables RMR libary's module tests (RIC-861).
  60 Creates a new unit test for the debugging rmr rx queue API.
  61 Fixes some bugs and possible memory likeage in SI95 code.
  62
  63
  64
  65 2021 December 2; version 4.8.0
  66 ------------------------------
  67
  68 Fixing memory leak in python support function (RIC-858).
  69 New API added for debugging rmr rx queue (RIC-838).
  70
  71
  72
  73 2021 April 22; version 4.7.4
  74 ----------------------------
  75
  76 Beef up unit testing in SI package and fix a few static
  77 analysis bugs. (RIC-777)
  78
  79
  80
  81 2021 April 19; version 4.7.3
  82 ----------------------------
  83
  84 Correct flag check bug in route table functions (RIC-777).
  85
  86
  87
  88 2021 April 9; version 4.7.2
  89 ---------------------------
  90
  91 Ensure that route table update received from route generator
  92 is not applied before a full route table is received.
  93
  94
  95
  96 2021 April 2; version 4.7.1
  97 ---------------------------
  98
  99 Correct issues found during static code analysis.
 100
 101
 102
 103 2021 March 31; version 4.7.0
 104 ----------------------------
 105
 106 The route table collector thread will capture the current
 107 "offering" from the Route Manager (table generator) if the
 108 RMR_SEED_RT environment variable is set.
 109
 110
 111
 112 2021 March 10; version 4.6.1
 113 ----------------------------
 114
 115 Corrected unit test "framework" to make manual testing
 116 easier, and to add the ability to set the code optimisation
 117 level via the CMake command line parameter OPT_LEVEL=n.
 118
 119
 120
 121 2021 February 22; Version 4.6.0
 122 -------------------------------
 123
 124 Enhanced to use millisecond based timestamps when writing log
 125 messages. (RIC-627)
 126
 127 Enhanced to eliminate the reqirement that the file specified
 128 by the RMR_VCTL_FILE environment variable exist when RMR is
 129 initialised. RMR will correctly find this file if it is
 130 created after initialisation. Further, if the environment
 131 variable is not given, the user may create and populate
 132 /tmp/rmr.v at any time and the contents of this file will be
 133 used as if it were supplied via the environment variable.
 134 This should make debugging in existing containers easier.
 135
 136 Enhanced to send an alarm manager when the user application
 137 is not receiving messages fast enough. The original messages
 138 written to the standard error are still generated. (RIC-204)
 139
 140
 141
 142 2021 January 21; Version 4.5.2
 143 ------------------------------
 144
 145 Fixes the excessive TCP session bug when sending to a slow
 146 receiver and a related segment fault because of too many open
 147 file descriptors. (RIC-735)
 148
 149
 150
 151 2021 January 19; Version 4.5.1
 152 ------------------------------
 153
 154 Version bump to work round a CI job bug preventing push of
 155 the 4.5.0 packages from staging to release in package cloud.
 156 (RIC-732)
 157
 158
 159
 160 2021 January 8; Version 4.5.0
 161 -----------------------------
 162
 163 Version bump for next release tracking. Corrected a potential
 164 locking issue in message allocation. (RIC-732)
 165
 166
 167
 168 Cherry Release
 169 ==============
 170
 171
 172
 173 2020 December 4; Version 4.4.6
 174 ------------------------------
 175
 176 Correct a range check bug when cloning a route table in prep
 177 to load a new one. (RIC-720)
 178
 179
 180
 181 2020 November 17; Version 4.4.5
 182 -------------------------------
 183
 184 Correct bug in round robin group allocation that could lead
 185 to an empty group. (RIC-695)
 186
 187
 188
 189 2020 November 13; Version 4.4.4
 190 -------------------------------
 191
 192 Correct address memory leak in the RTE cleanup. (RIC-674)
 193
 194
 195
 196 2020 November 4; Version 4.4.3
 197 ------------------------------
 198
 199 Correct bug introduced with race fix (4.4.0) (RIC-674)
 200
 201
 202
 203 2020 November 4; Version 4.4.2
 204 ------------------------------
 205
 206 Changes to correct more complaints generated by a code scan.
 207 (RIC-673) Also addressed some sonar coverage issues with unit
 208 test changes.
 209
 210
 211
 212 2020 November 4; Version 4.4.1
 213 ------------------------------
 214
 215 Changes to correct complaints generated by a code scan.
 216 (RIC-673)
 217
 218
 219
 220 2020 November 4; Version 4.4.0
 221 ------------------------------
 222
 223 Changes to address a potential race condition when route
 224 tables arrive in quick succession. (RIC-674)
 225
 226
 227
 228 2020 October 30; Version 4.3.1
 229 ------------------------------
 230
 231 Changes to address code analyser scans and two bug fixes
 232 identified while addressing the analysis data. (RIC-673)
 233
 234
 235
 236 2020 October 2; Version 4.3.0
 237 -----------------------------
 238
 239 Add message types for traffic steering anomaly messages
 240
 241
 242
 243 2020 September 15; Version 4.2.4
 244 --------------------------------
 245
 246 Add man page for the rmr_set_low_latency() function (RIC-631)
 247
 248
 249
 250 2020 September 15; Version 4.2.3
 251 --------------------------------
 252
 253 Correct arg processing bug in rmr_rpobe (RIC-645)
 254
 255
 256
 257 2020 August 4; Version 4.2.2
 258 ----------------------------
 259
 260 Correct bug in the rmr_probe support utility when -r option
 261 is used on the command line (RIC-644)
 262
 263
 264
 265 2020 August 4; Version 4.2.1
 266 ----------------------------
 267
 268 Add additional environment variable dump if RMR_LOG_VLEVEL
 269 set to 4 at start.
 270
 271
 272
 273 2020 August 3; Version 4.2.0
 274 ----------------------------
 275
 276 Add support for the RMR_RTREQ_FREQ environment variable to
 277 control the request frequency for a new route table (default
 278 5s if not supplied). (RIC-630)
 279
 280
 281
 282 2020 July 21; Version 4.1.4
 283 ---------------------------
 284
 285 Fix bug in SI95 -- possible use of pointer after free
 286 (RIC-626).
 287
 288
 289
 290 2020 July 9; version 4.1.3
 291 --------------------------
 292
 293 Allow RTS messages to be sent before the arrival of the
 294 initial route table. Calls to RTS (heart beat responses)
 295 prior to the initial route table load could cause a crash if
 296 a framework blindly assumes that RTS is valid. (RIC-589)
 297
 298
 299
 300 2020 June 22; version 4.1.2
 301 ---------------------------
 302
 303 Fix typo in RIC Message header file.
 304
 305 Add document for message type constants and the scripts which
 306 generate them.
 307
 308
 309
 310 2020 June 22; version 4.1.1
 311 ---------------------------
 312
 313 Add new message types to RIC header file for
 314     RIC_ALARM           (110)
 315     RIC_ALARM_QUERY     (111)
 316     RIC_METRICS         (120)
 317     RAN_E2_RESET_REQ    (12008)
 318     RAN_E2_RESET_RESP   (12009)
 319
 320
 321
 322 2020 June 18; version 4.1.0
 323 ---------------------------
 324
 325 Bump version minor to move away from 4.0.* which will bump
 326 for any patches applied back to bronze.
 327
 328 Add magic C++ goo to symtab header file allowing C++ xAPPs to
 329 use the symbol table directly.
 330
 331
 332
 333 Bronze Release
 334 ==============
 335
 336
 337
 338 2020 May 06; version 4.0.5
 339 --------------------------
 340
 341 Fix the bug in SI95 receive message management semaphore
 342 count issue. (RIC-355)
 343
 344
 345
 346 2020 April 29; version 4.0.4
 347 ----------------------------
 348
 349 Fix the traffic steering message type constants (again)
 350 (RIC-342)
 351
 352
 353
 354 2020 April 28; version 4.0.3
 355 ----------------------------
 356
 357 Fix sonar flagged bugs (RIC-78)
 358
 359
 360
 361 2020 April 24; version 4.0.2
 362 ----------------------------
 363
 364 Correct bug in SI95 transport header length validation
 365 (RIC-341)
 366
 367
 368
 369 2020 April 22; version 4.0.1
 370 ----------------------------
 371
 372 Correct message type constant for Traffic Steering
 373 predication (RIC-342)
 374
 375
 376
 377 2020 April 21; version 4.0.0
 378 ----------------------------
 379
 380 The NNG based libraries are no longer included in the RMR
 381 packages. This is considered a breaking change as NNG will
 382 not be supported by default. It is still possible to build
 383 with RMR-NNG libraries, but that is the exception. The API
 384 between 3.8.2 and 4.0.0 is the SAME. Upgrading to 4.0.0 only
 385 means that the underlying transport mechanism is limited only
 386 to SI95.
 387
 388 The rmr_rcv_specific() function has been deprecated as it was
 389 necessary only for NNG and Nanomsg support. Its use should be
 390 discontinued.
 391
 392
 393
 394 2020 April 20; version 3.8.2
 395 ----------------------------
 396
 397 Fix bug which was preventing an instance receiving dynamic
 398 route table updates. (RIC-336)
 399
 400
 401
 402 2020 April 20; version 3.8.1
 403 ----------------------------
 404
 405 Add user guide which replaces the concatenation of man pages
 406 (RIC-328)
 407
 408
 409
 410 2020 April 17; version 3.8.0
 411 ----------------------------
 412
 413 Add safe connect to avoid potential connect bug on Linux
 414 (RIC-332)
 415
 416 Change debugging in route table collector to avoid possible
 417 segment fault when in level 2 debug (RIC-335)
 418
 419
 420
 421 2020 April 15; version 3.7.4
 422 ----------------------------
 423
 424 Add missing message type to header file (RIC-334)
 425
 426
 427
 428 2020 April 14; version 3.7.3
 429 ----------------------------
 430
 431 Fix bug in rmr_call() when using SI95 (RIC-333)
 432
 433
 434
 435 2020 April 10; version 3.7.2
 436 ----------------------------
 437
 438 Fix bug related to static route table only mode (RIC-331)
 439
 440
 441
 442 2020 April 9; version 3.7.1
 443 ---------------------------
 444
 445 The max length restriction for receiving messages when using
 446 SI95 has been removed. The length supplied during
 447 initialisation is used as the "normal maximum" and default
 448 buffer allocation size, but messages arriving which are
 449 larger are accepted. (RIC-309)
 450
 451
 452
 453 2020 April 7; version 3.7.0
 454 ---------------------------
 455
 456 The health check support programme was renamed to rmr_probe
 457 (RIC-308).
 458
 459
 460
 461 2020 April 6; version 3.6.6
 462 ---------------------------
 463
 464 Correct bug in SI95 address conversion module (RIC-327)
 465 Correct bug in SI initialisation module
 466
 467
 468
 469 2020 April 2; version 3.6.5
 470 ---------------------------
 471
 472 Correct potential nil pointer use when examining interfaces
 473 for use as a listen target (RIC-307)
 474
 475
 476
 477 2020 April 1; version 3.6.4
 478 ---------------------------
 479
 480 Correct potential nil pointer use in the NNG interface
 481 (RIC-303) Correct issue preventing CI build without a
 482 container
 483
 484
 485
 486 2020 March 30; version 3.6.3
 487 ----------------------------
 488
 489 Correct the max receive message size constant in rmr.h
 490 (RIC-301)
 491
 492
 493
 494 2020 March 23; version 3.6.2
 495 ----------------------------
 496
 497 Fix message initialisation bug when pulling a message from
 498 the pool (RIC-295)
 499
 500
 501
 502 2020 March 19; version 3.6.1
 503 ----------------------------
 504
 505 Fix problem with RPM package install
 506
 507
 508
 509 2020 March 18; version 3.6.0
 510 ----------------------------
 511
 512 Add message types to support traffic steering
 513
 514
 515
 516 2020 March 16; version 3.5.2
 517 ----------------------------
 518
 519 Correct bug in the meid table parser that prevented the
 520 ack/nack of meid tables (RIC-273)
 521
 522
 523
 524 2020 March 10; version 3.5.1
 525 ----------------------------
 526
 527 Add missing health check message types.
 528
 529
 530
 531 2020 March 9; version 3.5.0
 532 ---------------------------
 533
 534 Added new wormhole send function: rmr_wh_call().
 535
 536
 537
 538 2020 March 6; version 3.4.0
 539 ---------------------------
 540
 541 Add new wormhole state function: rmr_wh_state().
 542
 543
 544
 545 2020 March 5; Version 3.3.1
 546 ---------------------------
 547
 548 Correct several "bugs" identified by automatic code analysis.
 549
 550
 551
 552 2020 March 4; Version 3.3.0
 553 ---------------------------
 554
 555 Add SI95 based unit testing Health check support binary added
 556 (reason for minor bump)
 557
 558
 559
 560 2020 February 26; version 3.2.5
 561 -------------------------------
 562
 563 Fix source address bug in SI95 receive/send funcitons. Fix
 564 threading issues involving session disconnection in SI95
 565 Remove unused SI95 status variable.
 566
 567
 568
 569 2020 February 24; version 3.2.4
 570 -------------------------------
 571
 572 Fix meid bug (RIC-220) causing core dump.
 573
 574
 575
 576 2020 February 21; version 3.2.3
 577 -------------------------------
 578
 579 Add meid routing support to the SI95 interface.
 580
 581
 582
 583 2020 February 20; version 3.2.2
 584 -------------------------------
 585
 586 Fix receive thread related core dump (ring early unlock).
 587
 588
 589
 590 2020 February 19; version 3.2.1
 591 -------------------------------
 592
 593 Added missing message types (E2-Setup)
 594
 595
 596
 597 2020 February 18; version 3.2.0
 598 -------------------------------
 599
 600 Added support for new Route Manager and it's ability to
 601 accept a request for table update.
 602
 603
 604
 605 2020 February 14; version 3.1.3
 606 -------------------------------
 607
 608 Fix bug in SIsend which was causing a core dump in some cases
 609 where the application attempted to send on a connection that
 610 had disconnected. (RIC-207).
 611
 612
 613
 614 2020 February 6; version 3.1.2
 615 ------------------------------
 616
 617 Fix disconnection detection bug in interface to SI95.
 618
 619
 620
 621 2020 January 31; verison 3.1.1
 622 ------------------------------
 623
 624 Allow route table thread logging to be completely disabled
 625 when logging is turned off.
 626
 627
 628
 629 2020 January 26; verison 3.1.0
 630 ------------------------------
 631
 632 First step to allowing the user programme to control messages
 633 written to standard error. Introduces the rmr_set_vlevel()
 634 function, and related environment variable.
 635
 636
 637
 638 2020 January 24; verison 3.0.5
 639 ------------------------------
 640
 641 Fix bug in SI95 with receive buffer allocation.
 642
 643
 644
 645 2020 January 23; verison 3.0.4
 646 ------------------------------
 647
 648 Fix bug in SI95 causing excessive CPU usage on poll.
 649
 650
 651
 652 2020 January 22; verison 3.0.3
 653 ------------------------------
 654
 655 Enable thread support for multiple receive threads.
 656
 657
 658
 659 2020 January 21; verison 3.0.2
 660 ------------------------------
 661
 662 Fix bug in SI95 (missing reallocate payload function).
 663
 664
 665
 666 2020 January 20; verison 3.0.1
 667 ------------------------------
 668
 669 Enable support for dynamic route table updates via RMR
 670 session.
 671
 672
 673
 674 2020 January 16; version 3.0.0
 675 ------------------------------
 676
 677 Introduce support for SI95 transport library to replace NNG.
 678 (RMR library versions will use leading odd numbers to avoid
 679 tag collisions with the wrapper tags which will use even
 680 numbers.)
 681
 682
 683
 684 2019 December 9; version 1.13.1
 685 -------------------------------
 686
 687 Correct documentation and missing rel-notes update for RTD.
 688
 689
 690
 691 2019 December 6; version 1.13.0
 692 -------------------------------
 693
 694 Add ability to route messages based on the MEID in a message
 695 combined with the message type/subscription-ID.
 696
 697
 698
 699 Amber Release
 700 =============
 701
 702
 703
 704 2019 November 14; version 1.11.1
 705 --------------------------------
 706
 707 Fix bug in payload reallocation function; correct length of
 708 payload was not always copied.
 709
 710
 711
 712 2019 November 13; version 1.12.1
 713 --------------------------------
 714
 715 New message type constants added to support A1.
 716
 717
 718
 719 2019 November 4; version 1.11.0
 720 -------------------------------
 721
 722 Version bump to move away from the 1.10.* to distinguish
 723 between release A and the trial.
 724
 725
 726
 727 2019 November 7; version 1.12.0
 728 -------------------------------
 729
 730 Version cut to support continued development for next release
 731 preserving the 1.11.* versions for release 1 (Amber) and
 732 related fixes.
 733
 734
 735
 736 2019 October 31; version 1.10.2
 737 -------------------------------
 738
 739 Provide the means to increase the payload size of a received
 740 message without losing the data needed to use the
 741 rmr_rts_msg() funciton.
 742
 743
 744
 745 2019 October 21; version 1.10.1
 746 -------------------------------
 747
 748 Fix to prevent null message buffer from being returned by the
 749 timeout receive function if the function is passed one to
 750 reuse.
 751
 752
 753
 754 2019 October 21; version 1.10.1
 755 -------------------------------
 756
 757 Add periodic dump of send count info to stderr.
 758
 759
 760
 761 2019 September 27; version 1.9.0
 762 --------------------------------
 763
 764 Python bindings added receive all queued function and
 765 corrected a unit test
 766
 767
 768
 769 2019 September 25; version 1.8.3
 770 --------------------------------
 771
 772 Correct application level test issue causing timing problems
 773 during jenkins verification testing at command and merge
 774
 775 Handle the NNG connection shutdown status which may now be
 776 generated when a connection throug a proxy is reset.
 777
 778
 779
 780 2019 September 25; version 1.8.2
 781 --------------------------------
 782
 783 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
 784
 785
 786
 787 2019 September 19; version 1.8.1
 788 --------------------------------
 789
 790 Correct missing constant for wrappers.
 791
 792
 793
 794 2019 September 19; version 1.8.0
 795 --------------------------------
 796
 797 New message types added:
 798     RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
 799
 800
 801
 802 2019 September 17; version 1.7.0
 803 --------------------------------
 804
 805 Initial connection mode now defaults to asynchronous. Set
 806 RMR_ASYNC_CONN=0 in the environment before rmr_init() is
 807 invoked to revert to synchronous first TCP connections.
 808 (Recovery connection attempts have always been asynchronous).
 809
 810
 811
 812 2019 September 3; version 1.6.0
 813 -------------------------------
 814
 815 Fix bug in the rmr_rts_msg() function. If a return to sender
 816 message failed, the source IP address was not correctly
 817 adjusted and could cause the message to be "reflected" back
 818 to the sender on a retry.
 819
 820 Added the ability to set the source "ID" via an environment
 821 var (RMR_SRC_ID). When present in the environment, the string
 822 will be placed in to the message header as the source and
 823 thus be used by an application calling rmr_rts_smg() to
 824 return a response to the sender. If this environment variable
 825 is not present, the host name (original behaviour) is used.
 826
 827
 828
 829 2019 August 26; version 1.4.0
 830 -----------------------------
 831
 832 New message types were added.
 833
 834
 835
 836 2019 August 16; version 1.3.0
 837 -----------------------------
 838
 839 New mesage types added.
 840
 841
 842
 843 2019 August 13; version 1.2.0 (API change, non-breaking)
 844 --------------------------------------------------------
 845
 846 The function rmr_get_xact() was added to proide a convenient
 847 way to extract the transaction field from a message.
 848
 849
 850
 851 2019 August 8; version 1.1.0 (API change)
 852 -----------------------------------------
 853
 854 This change should be backward compatable/non-breaking A new
 855 field has been added to the message buffer (rmr_mbuf_t). This
 856 field (tp_state) is used to communicate the errno value that
 857 the transport mechanism might set during send and/or receive
 858 operations. C programmes should continue to use errno
 859 directly, but in some environments wrappers may not be able
 860 to access errno and this provides the value to them. See the
 861 rmr_alloc_msg manual page for more details.
 862
 863
 864
 865 2019 August 6; version 1.0.45 (build changes)
 866 ---------------------------------------------
 867
 868 Support for the Nanomsg transport library has been dropped.
 869     The library librmr.* will no longer be included in packages.
 870
 871 Packages will install RMR libraries into the system preferred
 872     target directory. On some systems this is /usr/local/lib
 873     and on others it is /usr/local/lib64.  The diretory is
 874     determined by the sytem on which the package is built and
 875     NOT by the system installing the package, so it's possible
 876     that the RMR libraries end up in a strange location if the
 877     .deb or .rpm file was generated on a Linux flavour that
 878     has a different preference than the one where the package
 879     is installed.
 880
 881
 882
 883 2019 August 6; version 1.0.44 (API change)
 884 ------------------------------------------
 885
 886 Added a new message type constant.
 887
 888
 889
 890 2019 July 15; Version 1.0.39 (bug fix)
 891 --------------------------------------
 892
 893 Prevent unnecessary usleep in retry loop.
 894
 895
 896
 897 2019 July 12; Version 1.0.38 (API change)
 898 -----------------------------------------
 899
 900 Added new message types to RIC_message_types.h.
 901
 902
 903
 904 2019 July 11; Version 1.0.37
 905 ----------------------------
 906
 907
 908 librmr and librmr_nng
 909     - Add message buffer API function rmr_trace_ref()
 910       (see rmr_trace_ref.3 manual page in dev package).
 911
 912
 913
 914 2020 April 8; Version n/a
 915 -------------------------
 916
 917 RMR Python moved to Python Xapp Framework
 918 (https://gerrit.o-ran-sc.org/r/admin/repos/ric-plt/xapp-frame-py)
 919
 920
 921
 922 2020 February 29; Version 2.4.0
 923 -------------------------------
 924
 925 Add consolidated testing under CMake Add support binary for
 926 health check (SI95 only)
 927
 928
 929
 930 2020 February 28; Version 2.3.6
 931 -------------------------------
 932
 933 Fix bug in Rt. Mgr comm which prevented table ID from being
 934 sent on ack message (RIC-232).