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