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