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