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