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