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