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