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