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