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