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