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