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