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