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