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