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