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