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