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