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