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