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