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