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