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