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