CHANGES_CORE.txt

   1 # this file should contain ONLY the changes related to the
   2 # core RMR code and doc.  Other change files exist for other
   3 # things.
   4
   5 # API and build change  and fix summaries. Doc corrections
   6 # and/or changes are not mentioned here; see the commit messages.
   7
   8 2023 Oct 4; version 4.9.2
   9     Fixes some stability issues seen during route table update.
  10     Dont allow clean old_rtable until it's reference count is really 0.
  11     Added more faster recognition for connect failure so route table
  12     update will not stuck so long in preparing new rtable.
  13         rtgate lock is not needed to init and destroy continouosly.
  14
  15 2023 May 28; version 4.9.1
  16         Fixes IPv6 support for binding to IPv6 interfaces (RIC-985)
  17
  18 2023 Feb 14; version 4.9.0
  19         Added new message type for RIC subscription delete required
  20
  21 2022 Nov 10; version 4.8.5
  22         Fixes for errors detected by source code scanning
  23
  24 2022 May 11; version 4.8.3
  25         Added config transfer related message types (RIC-638)
  26
  27 2022 January 17; version 4.8.2
  28         Fixes routing statistics printout crash (RIC-872).
  29
  30 2022 January 7; version 4.8.1
  31         Re-enables RMR libary's module tests (RIC-861).
  32         Creates a new unit test for the debugging rmr rx queue API.
  33         Fixes some bugs and possible memory likeage in SI95 code.
  34
  35 2021 December 2; version 4.8.0
  36         Fixing memory leak in python support function (RIC-858).
  37         New API added for debugging rmr rx queue (RIC-838).
  38
  39 2021 April 22; version 4.7.4
  40         Beef up unit testing in SI package and fix a few static analysis
  41         bugs. (RIC-777)
  42
  43 2021 April 19; version 4.7.3
  44         Correct flag check bug in route table functions (RIC-777).
  45
  46 2021 April 9; version 4.7.2
  47         Ensure that route table update received from route generator is not
  48         applied before a full route table is received.
  49
  50 2021 April 2; version 4.7.1
  51         Correct issues found during static code analysis.
  52
  53 2021 March 31; version 4.7.0
  54         The route table collector thread will capture the current "offering"
  55         from the Route Manager (table generator) if the RMR_SEED_RT environment
  56         variable is set.
  57
  58 2021 March 10; version 4.6.1
  59         Corrected unit test "framework" to make manual testing easier, and to
  60         add the ability to set the code optimisation level via the CMake
  61         command line parameter OPT_LEVEL=n.
  62
  63 2021 February 22; Version 4.6.0
  64         Enhanced to use millisecond based timestamps when writing log messages.
  65         (RIC-627)
  66
  67         Enhanced to eliminate the  reqirement that the file specified by the
  68         RMR_VCTL_FILE environment variable exist when RMR is initialised. RMR
  69         will correctly find this file if it is created after initialisation.
  70         Further, if the environment variable is not given, the user may create
  71         and populate /tmp/rmr.v at any time and the contents of this file will
  72         be used as if it were supplied via the environment variable. This should
  73         make debugging in existing containers easier.
  74
  75         Enhanced to send an alarm manager when the user application is not
  76         receiving messages fast enough.  The original messages written to
  77         the standard error are still generated. (RIC-204)
  78
  79 2021 January 21; Version 4.5.2
  80         Fixes the excessive TCP session bug when sending to a slow receiver
  81         and a related segment fault because of too many open file descriptors.
  82         (RIC-735)
  83
  84 2021 January 19; Version 4.5.1
  85         Version bump to work round a CI job bug preventing push of the 4.5.0
  86         packages from staging to release in package cloud.  (RIC-732)
  87
  88 2021 January 8; Version 4.5.0
  89         Version bump for next release tracking.
  90         Corrected a potential locking issue in message allocation. (RIC-732)
  91
  92 2020 December 4; Version 4.4.6
  93         Correct a range check bug when cloning a route table in prep
  94         to load a new one. (RIC-720)
  95
  96 2020 November 17; Version 4.4.5
  97         Correct bug in round robin group allocation that could lead to
  98         an empty group. (RIC-695)
  99
 100 2020 November 13; Version 4.4.4
 101         Correct address memory leak in the RTE cleanup. (RIC-674)
 102
 103 2020 November 4; Version 4.4.3
 104         Correct bug introduced with race fix (4.4.0) (RIC-674)
 105
 106 2020 November 4; Version 4.4.2
 107         Changes to correct more complaints generated by a code scan. (RIC-673)
 108         Also addressed some sonar coverage issues with unit test changes.
 109
 110 2020 November 4; Version 4.4.1
 111         Changes to correct complaints generated by a code scan. (RIC-673)
 112
 113 2020 November 4; Version 4.4.0
 114         Changes to address a potential race condition when route tables
 115         arrive in quick succession.  (RIC-674)
 116
 117 2020 October 30; Version 4.3.1
 118         Changes to address code analyser scans and two bug fixes identified
 119         while addressing the analysis data. (RIC-673)
 120
 121 2020 October 2; Version 4.3.0
 122         Add message types for traffic steering anomaly messages
 123
 124 2020 September 15; Version 4.2.4
 125         Add man page for the rmr_set_low_latency() function (RIC-631)
 126
 127 2020 September 15; Version 4.2.3
 128         Correct arg processing bug in rmr_rpobe (RIC-645)
 129
 130 2020 August 4; Version 4.2.2
 131         Correct bug in the rmr_probe support utility when -r option is used
 132         on the command line (RIC-644)
 133
 134 2020 August 4; Version 4.2.1
 135         Add additional environment variable dump if RMR_LOG_VLEVEL set to
 136         4 at start.
 137
 138 2020 August 3; Version 4.2.0
 139         Add support for the RMR_RTREQ_FREQ environment variable to control
 140         the request frequency for a new route table (default 5s if not
 141         supplied).  (RIC-630)
 142
 143 2020 July 21; Version 4.1.4
 144         Fix bug in SI95 -- possible use of pointer after free (RIC-626).
 145
 146 2020 July 9; version 4.1.3
 147         Allow RTS messages to be sent before the arrival of the initial
 148         route table. Calls to RTS (heart beat responses) prior to the
 149         initial route table load could cause a crash if a framework
 150         blindly assumes that RTS is valid. (RIC-589)
 151
 152 2020 June 22; version 4.1.2
 153         Fix typo in RIC Message header file.
 154
 155         Add document for message type constants and the scripts
 156         which generate them.
 157
 158 2020 June 22; version 4.1.1
 159         Add new message types to RIC header file for
 160                 RIC_ALARM           (110)
 161                 RIC_ALARM_QUERY     (111)
 162                 RIC_METRICS         (120)
 163                 RAN_E2_RESET_REQ    (12008)
 164                 RAN_E2_RESET_RESP   (12009)
 165
 166 2020 June 18; version 4.1.0
 167         Bump version minor to move away from 4.0.* which will bump for any
 168         patches applied back to bronze.
 169
 170         Add magic C++ goo to symtab header file allowing C++ xAPPs to use
 171         the symbol table directly.
 172
 173 2020 May 06; version 4.0.5
 174         Fix the bug in SI95 receive message management semaphore count
 175         issue. (RIC-355)
 176
 177 2020 April 29; version 4.0.4
 178         Fix the traffic steering message type constants (again) (RIC-342)
 179
 180 2020 April 28; version 4.0.3
 181         Fix sonar flagged bugs (RIC-78)
 182
 183 2020 April 24; version 4.0.2
 184         Correct bug in SI95 transport header length validation (RIC-341)
 185
 186 2020 April 22; version 4.0.1
 187         Correct message type constant for Traffic Steering predication (RIC-342)
 188
 189 2020 April 21; version 4.0.0
 190         The NNG based libraries are no longer included in the RMR packages.
 191         This is considered a breaking change as NNG will not be supported by
 192         default.  It is still possible to build with RMR-NNG libraries, but
 193         that is the exception.  The API between 3.8.2 and 4.0.0 is the SAME.
 194         Upgrading to 4.0.0 only means that the underlying transport mechanism
 195         is limited only to SI95.
 196
 197         The rmr_rcv_specific() function has been deprecated as it was necessary
 198         only for NNG and Nanomsg support.  Its use should be discontinued.
 199
 200 2020 April 20; version 3.8.2
 201         Fix bug which was preventing an instance receiving dynamic route
 202         table updates. (RIC-336)
 203
 204 2020 April 20; version 3.8.1
 205         Add user guide which replaces the concatenation of man pages (RIC-328)
 206
 207 2020 April 17; version 3.8.0
 208         Add safe connect to avoid potential connect bug on Linux (RIC-332)
 209
 210         Change debugging in route table collector to avoid possible
 211         segment fault when in level 2 debug (RIC-335)
 212
 213 2020 April 15; version 3.7.4
 214         Add missing message type to header file (RIC-334)
 215
 216 2020 April 14; version 3.7.3
 217         Fix bug in rmr_call() when using SI95  (RIC-333)
 218
 219 2020 April 10; version 3.7.2
 220         Fix bug related to static route table only mode (RIC-331)
 221
 222 2020 April 9; version 3.7.1
 223         The max length restriction for receiving messages when using SI95 has
 224         been removed.  The length supplied during initialisation is used as
 225         the "normal maximum" and default buffer allocation size, but messages
 226         arriving which are larger are accepted. (RIC-309)
 227
 228 2020 April 7; version 3.7.0
 229         The health check support programme was renamed to rmr_probe (RIC-308).
 230
 231 2020 April 6; version 3.6.6
 232         Correct bug in SI95 address conversion module (RIC-327)
 233         Correct bug in SI initialisation module
 234
 235 2020 April 2; version 3.6.5
 236         Correct potential nil pointer use when examining interfaces for
 237         use as a listen target (RIC-307)
 238
 239 2020 April 1; version 3.6.4
 240         Correct potential nil pointer use in the NNG interface (RIC-303)
 241         Correct issue preventing CI build without a container
 242
 243 2020 March 30; version 3.6.3
 244         Correct the max receive message size constant in rmr.h (RIC-301)
 245
 246 2020 March 23; version 3.6.2
 247         Fix message initialisation bug when pulling a message from
 248         the pool (RIC-295)
 249
 250 2020 March 19; version 3.6.1
 251         Fix problem with RPM package install
 252
 253 2020 March 18; version 3.6.0
 254         Add message types to support traffic steering
 255
 256 2020 March 16; version 3.5.2
 257         Correct bug in the meid table parser that prevented the
 258         ack/nack of meid tables (RIC-273)
 259
 260 2020 March 10; version 3.5.1
 261         Add missing health check message types.
 262
 263 2020 March 9; version 3.5.0
 264         Added new wormhole send function: rmr_wh_call().
 265
 266 2020 March 6; version 3.4.0
 267         Add new wormhole state function: rmr_wh_state().
 268
 269 2020 March 5; Version 3.3.1
 270         Correct several "bugs" identified by automatic code analysis.
 271
 272 2020 March 4; Version 3.3.0
 273         Add SI95 based unit testing
 274         Health check support binary added (reason for minor bump)
 275
 276 2020 February 26; version 3.2.5
 277         Fix source address bug in SI95 receive/send funcitons.
 278         Fix threading issues involving session disconnection in SI95
 279         Remove unused SI95 status variable.
 280
 281 2020 February 24; version 3.2.4
 282         Fix meid bug (RIC-220) causing core dump.
 283
 284 2020 February 21; version 3.2.3
 285         Add meid routing support to the SI95 interface.
 286
 287 2020 February 20; version 3.2.2
 288         Fix receive thread related core dump (ring early unlock).
 289
 290 2020 February 19; version 3.2.1
 291         Added missing message types (E2-Setup)
 292
 293 2020 February 18; version 3.2.0
 294         Added support for new Route Manager and it's ability to accept
 295         a request for table update.
 296
 297 2020 February 14; version 3.1.3
 298         Fix bug in SIsend which was causing a core dump in some cases
 299         where the application attempted to send on a connection that
 300         had disconnected. (RIC-207).
 301
 302 2020 February 6; version 3.1.2
 303         Fix disconnection detection bug in interface to SI95.
 304
 305 2020 January 31; verison 3.1.1
 306         Allow route table thread logging to be completely disabled
 307         when logging is turned off.
 308
 309 2020 January 26; verison 3.1.0
 310         First step to allowing the user programme to control messages
 311         written to standard error. Introduces the rmr_set_vlevel()
 312         function, and related environment variable.
 313
 314 2020 January 24; verison 3.0.5
 315         Fix bug in SI95 with receive buffer allocation.
 316
 317 2020 January 23; verison 3.0.4
 318         Fix bug in SI95 causing excessive CPU usage on poll.
 319
 320 2020 January 22; verison 3.0.3
 321         Enable thread support for multiple receive threads.
 322
 323 2020 January 21; verison 3.0.2
 324         Fix bug in SI95 (missing reallocate payload function).
 325
 326 2020 January 20; verison 3.0.1
 327         Enable support for dynamic route table updates via RMR session.
 328
 329 2020 January 16; version 3.0.0
 330         Introduce support for SI95 transport library to replace NNG.
 331         (RMR library versions will use leading odd numbers to avoid tag collisions
 332          with the wrapper tags which will use even numbers.)
 333
 334 2019 December 9; version 1.13.1
 335         Correct documentation and missing rel-notes update for RTD.
 336
 337 2019 December 6; version 1.13.0
 338         Add ability to route messages based on the MEID in a message combined
 339         with the message type/subscription-ID.
 340
 341 2019 November 14; version 1.11.1
 342         Fix bug in payload reallocation function; correct length of payload
 343         was not always copied.
 344
 345 2019 November 13; version 1.12.1
 346         New message type constants added to support A1.
 347
 348 2019 November 4; version 1.11.0
 349         Version bump to move away from the 1.10.* to distinguish between
 350         release A and the trial.
 351
 352 2019 November 7; version 1.12.0
 353         Version cut to support continued development for next release
 354         preserving the 1.11.* versions for release 1 (Amber) and
 355         related fixes.
 356
 357 2019 October 31; version 1.10.2
 358         Provide the means to increase the payload size of a received message
 359         without losing the data needed to use the rmr_rts_msg() funciton.
 360
 361 2019 October 21; version 1.10.1
 362         Fix to prevent null message buffer from being returned by the timeout
 363         receive function if the function is passed one to reuse.
 364
 365 2019 October 21; version 1.10.1
 366         Add periodic dump of send count info to stderr.
 367
 368 2019 September 27; version 1.9.0
 369         Python bindings added receive all queued function and corrected a unit test
 370
 371 2019 September 25; version 1.8.3
 372         Correct application level test issue causing timing problems during
 373         jenkins verification testing at command and merge
 374
 375         Handle the NNG connection shutdown status which may now be
 376         generated when a connection throug a proxy is reset.
 377
 378 2019 September 25; version 1.8.2
 379         Correct bug in rmr_torcv_msg() when timeout set to zero (0).
 380
 381 2019 September 19; version 1.8.1
 382         Correct missing constant for wrappers.
 383
 384 2019 September 19; version 1.8.0
 385         New message types added:
 386                 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
 387
 388 2019 September 17; version 1.7.0
 389         Initial connection mode now defaults to asynchronous. Set RMR_ASYNC_CONN=0
 390         in the environment before rmr_init() is invoked to revert to
 391         synchronous first TCP connections. (Recovery connection attempts
 392         have always been asynchronous).
 393
 394 2019 September 3; version 1.6.0
 395         Fix bug in the rmr_rts_msg() function. If a return to sender message
 396         failed, the source IP address was not correctly adjusted and could
 397         cause the message to be "reflected" back to the sender on a retry.
 398
 399         Added the ability to set the source "ID" via an environment var
 400         (RMR_SRC_ID).  When present in the environment, the string will
 401         be placed in to the message header as the source and thus be used
 402         by an application calling rmr_rts_smg() to return a response to
 403         the sender.  If this environment variable is not present, the host
 404         name (original behaviour) is used.
 405
 406 2019 August 26; version 1.4.0
 407         New message types were added.
 408
 409 2019 August 16; version 1.3.0
 410         New mesage types added.
 411
 412 2019 August 13; version 1.2.0 (API change, non-breaking)
 413         The function rmr_get_xact() was added to proide a convenient
 414         way to extract the transaction field from a message.
 415
 416 2019 August 8; version 1.1.0 (API change)
 417         This change should be backward compatable/non-breaking
 418         A new field has been added to the message buffer (rmr_mbuf_t).
 419         This field (tp_state) is used to communicate the errno value
 420         that the transport mechanism might set during send and/or
 421         receive operations.  C programmes should continue to use
 422         errno directly, but in some environments wrappers may not be
 423         able to access errno and this provides the value to them.
 424         See the rmr_alloc_msg manual page for more details.
 425
 426 2019 August 6; version 1.0.45 (build changes)
 427         Support for the Nanomsg transport library has been dropped.
 428                 The library librmr.* will no longer be included in packages.
 429
 430         Packages will install RMR libraries into the system preferred
 431                 target directory. On some systems this is /usr/local/lib
 432                 and on others it is /usr/local/lib64.  The diretory is
 433                 determined by the sytem on which the package is built and
 434                 NOT by the system installing the package, so it's possible
 435                 that the RMR libraries end up in a strange location if the
 436                 .deb or .rpm file was generated on a Linux flavour that
 437                 has a different preference than the one where the package
 438                 is installed.
 439
 440 2019 August 6; version 1.0.44 (API change)
 441         Added a new message type constant.
 442
 443 2019 July 15; Version 1.0.39 (bug fix)
 444         Prevent unnecessary usleep in retry loop.
 445
 446 2019 July 12; Version 1.0.38 (API change)
 447         Added new message types to RIC_message_types.h.
 448
 449 2019 July 11; Version 1.0.37
 450
 451         librmr and librmr_nng
 452                 - Add message buffer API function rmr_trace_ref()
 453                   (see rmr_trace_ref.3 manual page in dev package).
 454