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