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