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