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