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