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