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