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