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