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