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