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