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