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