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