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