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