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