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