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