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