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