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