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