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