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