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