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 2023 Feb 14; version 4.9.0
9 Added new message type for RIC subscription delete required
11 2022 Nov 10; version 4.8.5
12 Fixes for errors detected by source code scanning
14 2022 May 11; version 4.8.3
15 Added config transfer related message types (RIC-638)
17 2022 January 17; version 4.8.2
18 Fixes routing statistics printout crash (RIC-872).
20 2022 January 7; version 4.8.1
21 Re-enables RMR libary's module tests (RIC-861).
22 Creates a new unit test for the debugging rmr rx queue API.
23 Fixes some bugs and possible memory likeage in SI95 code.
25 2021 December 2; version 4.8.0
26 Fixing memory leak in python support function (RIC-858).
27 New API added for debugging rmr rx queue (RIC-838).
29 2021 April 22; version 4.7.4
30 Beef up unit testing in SI package and fix a few static analysis
33 2021 April 19; version 4.7.3
34 Correct flag check bug in route table functions (RIC-777).
36 2021 April 9; version 4.7.2
37 Ensure that route table update received from route generator is not
38 applied before a full route table is received.
40 2021 April 2; version 4.7.1
41 Correct issues found during static code analysis.
43 2021 March 31; version 4.7.0
44 The route table collector thread will capture the current "offering"
45 from the Route Manager (table generator) if the RMR_SEED_RT environment
48 2021 March 10; version 4.6.1
49 Corrected unit test "framework" to make manual testing easier, and to
50 add the ability to set the code optimisation level via the CMake
51 command line parameter OPT_LEVEL=n.
53 2021 February 22; Version 4.6.0
54 Enhanced to use millisecond based timestamps when writing log messages.
57 Enhanced to eliminate the reqirement that the file specified by the
58 RMR_VCTL_FILE environment variable exist when RMR is initialised. RMR
59 will correctly find this file if it is created after initialisation.
60 Further, if the environment variable is not given, the user may create
61 and populate /tmp/rmr.v at any time and the contents of this file will
62 be used as if it were supplied via the environment variable. This should
63 make debugging in existing containers easier.
65 Enhanced to send an alarm manager when the user application is not
66 receiving messages fast enough. The original messages written to
67 the standard error are still generated. (RIC-204)
69 2021 January 21; Version 4.5.2
70 Fixes the excessive TCP session bug when sending to a slow receiver
71 and a related segment fault because of too many open file descriptors.
74 2021 January 19; Version 4.5.1
75 Version bump to work round a CI job bug preventing push of the 4.5.0
76 packages from staging to release in package cloud. (RIC-732)
78 2021 January 8; Version 4.5.0
79 Version bump for next release tracking.
80 Corrected a potential locking issue in message allocation. (RIC-732)
82 2020 December 4; Version 4.4.6
83 Correct a range check bug when cloning a route table in prep
84 to load a new one. (RIC-720)
86 2020 November 17; Version 4.4.5
87 Correct bug in round robin group allocation that could lead to
88 an empty group. (RIC-695)
90 2020 November 13; Version 4.4.4
91 Correct address memory leak in the RTE cleanup. (RIC-674)
93 2020 November 4; Version 4.4.3
94 Correct bug introduced with race fix (4.4.0) (RIC-674)
96 2020 November 4; Version 4.4.2
97 Changes to correct more complaints generated by a code scan. (RIC-673)
98 Also addressed some sonar coverage issues with unit test changes.
100 2020 November 4; Version 4.4.1
101 Changes to correct complaints generated by a code scan. (RIC-673)
103 2020 November 4; Version 4.4.0
104 Changes to address a potential race condition when route tables
105 arrive in quick succession. (RIC-674)
107 2020 October 30; Version 4.3.1
108 Changes to address code analyser scans and two bug fixes identified
109 while addressing the analysis data. (RIC-673)
111 2020 October 2; Version 4.3.0
112 Add message types for traffic steering anomaly messages
114 2020 September 15; Version 4.2.4
115 Add man page for the rmr_set_low_latency() function (RIC-631)
117 2020 September 15; Version 4.2.3
118 Correct arg processing bug in rmr_rpobe (RIC-645)
120 2020 August 4; Version 4.2.2
121 Correct bug in the rmr_probe support utility when -r option is used
122 on the command line (RIC-644)
124 2020 August 4; Version 4.2.1
125 Add additional environment variable dump if RMR_LOG_VLEVEL set to
128 2020 August 3; Version 4.2.0
129 Add support for the RMR_RTREQ_FREQ environment variable to control
130 the request frequency for a new route table (default 5s if not
133 2020 July 21; Version 4.1.4
134 Fix bug in SI95 -- possible use of pointer after free (RIC-626).
136 2020 July 9; version 4.1.3
137 Allow RTS messages to be sent before the arrival of the initial
138 route table. Calls to RTS (heart beat responses) prior to the
139 initial route table load could cause a crash if a framework
140 blindly assumes that RTS is valid. (RIC-589)
142 2020 June 22; version 4.1.2
143 Fix typo in RIC Message header file.
145 Add document for message type constants and the scripts
148 2020 June 22; version 4.1.1
149 Add new message types to RIC header file for
151 RIC_ALARM_QUERY (111)
153 RAN_E2_RESET_REQ (12008)
154 RAN_E2_RESET_RESP (12009)
156 2020 June 18; version 4.1.0
157 Bump version minor to move away from 4.0.* which will bump for any
158 patches applied back to bronze.
160 Add magic C++ goo to symtab header file allowing C++ xAPPs to use
161 the symbol table directly.
163 2020 May 06; version 4.0.5
164 Fix the bug in SI95 receive message management semaphore count
167 2020 April 29; version 4.0.4
168 Fix the traffic steering message type constants (again) (RIC-342)
170 2020 April 28; version 4.0.3
171 Fix sonar flagged bugs (RIC-78)
173 2020 April 24; version 4.0.2
174 Correct bug in SI95 transport header length validation (RIC-341)
176 2020 April 22; version 4.0.1
177 Correct message type constant for Traffic Steering predication (RIC-342)
179 2020 April 21; version 4.0.0
180 The NNG based libraries are no longer included in the RMR packages.
181 This is considered a breaking change as NNG will not be supported by
182 default. It is still possible to build with RMR-NNG libraries, but
183 that is the exception. The API between 3.8.2 and 4.0.0 is the SAME.
184 Upgrading to 4.0.0 only means that the underlying transport mechanism
185 is limited only to SI95.
187 The rmr_rcv_specific() function has been deprecated as it was necessary
188 only for NNG and Nanomsg support. Its use should be discontinued.
190 2020 April 20; version 3.8.2
191 Fix bug which was preventing an instance receiving dynamic route
192 table updates. (RIC-336)
194 2020 April 20; version 3.8.1
195 Add user guide which replaces the concatenation of man pages (RIC-328)
197 2020 April 17; version 3.8.0
198 Add safe connect to avoid potential connect bug on Linux (RIC-332)
200 Change debugging in route table collector to avoid possible
201 segment fault when in level 2 debug (RIC-335)
203 2020 April 15; version 3.7.4
204 Add missing message type to header file (RIC-334)
206 2020 April 14; version 3.7.3
207 Fix bug in rmr_call() when using SI95 (RIC-333)
209 2020 April 10; version 3.7.2
210 Fix bug related to static route table only mode (RIC-331)
212 2020 April 9; version 3.7.1
213 The max length restriction for receiving messages when using SI95 has
214 been removed. The length supplied during initialisation is used as
215 the "normal maximum" and default buffer allocation size, but messages
216 arriving which are larger are accepted. (RIC-309)
218 2020 April 7; version 3.7.0
219 The health check support programme was renamed to rmr_probe (RIC-308).
221 2020 April 6; version 3.6.6
222 Correct bug in SI95 address conversion module (RIC-327)
223 Correct bug in SI initialisation module
225 2020 April 2; version 3.6.5
226 Correct potential nil pointer use when examining interfaces for
227 use as a listen target (RIC-307)
229 2020 April 1; version 3.6.4
230 Correct potential nil pointer use in the NNG interface (RIC-303)
231 Correct issue preventing CI build without a container
233 2020 March 30; version 3.6.3
234 Correct the max receive message size constant in rmr.h (RIC-301)
236 2020 March 23; version 3.6.2
237 Fix message initialisation bug when pulling a message from
240 2020 March 19; version 3.6.1
241 Fix problem with RPM package install
243 2020 March 18; version 3.6.0
244 Add message types to support traffic steering
246 2020 March 16; version 3.5.2
247 Correct bug in the meid table parser that prevented the
248 ack/nack of meid tables (RIC-273)
250 2020 March 10; version 3.5.1
251 Add missing health check message types.
253 2020 March 9; version 3.5.0
254 Added new wormhole send function: rmr_wh_call().
256 2020 March 6; version 3.4.0
257 Add new wormhole state function: rmr_wh_state().
259 2020 March 5; Version 3.3.1
260 Correct several "bugs" identified by automatic code analysis.
262 2020 March 4; Version 3.3.0
263 Add SI95 based unit testing
264 Health check support binary added (reason for minor bump)
266 2020 February 26; version 3.2.5
267 Fix source address bug in SI95 receive/send funcitons.
268 Fix threading issues involving session disconnection in SI95
269 Remove unused SI95 status variable.
271 2020 February 24; version 3.2.4
272 Fix meid bug (RIC-220) causing core dump.
274 2020 February 21; version 3.2.3
275 Add meid routing support to the SI95 interface.
277 2020 February 20; version 3.2.2
278 Fix receive thread related core dump (ring early unlock).
280 2020 February 19; version 3.2.1
281 Added missing message types (E2-Setup)
283 2020 February 18; version 3.2.0
284 Added support for new Route Manager and it's ability to accept
285 a request for table update.
287 2020 February 14; version 3.1.3
288 Fix bug in SIsend which was causing a core dump in some cases
289 where the application attempted to send on a connection that
290 had disconnected. (RIC-207).
292 2020 February 6; version 3.1.2
293 Fix disconnection detection bug in interface to SI95.
295 2020 January 31; verison 3.1.1
296 Allow route table thread logging to be completely disabled
297 when logging is turned off.
299 2020 January 26; verison 3.1.0
300 First step to allowing the user programme to control messages
301 written to standard error. Introduces the rmr_set_vlevel()
302 function, and related environment variable.
304 2020 January 24; verison 3.0.5
305 Fix bug in SI95 with receive buffer allocation.
307 2020 January 23; verison 3.0.4
308 Fix bug in SI95 causing excessive CPU usage on poll.
310 2020 January 22; verison 3.0.3
311 Enable thread support for multiple receive threads.
313 2020 January 21; verison 3.0.2
314 Fix bug in SI95 (missing reallocate payload function).
316 2020 January 20; verison 3.0.1
317 Enable support for dynamic route table updates via RMR session.
319 2020 January 16; version 3.0.0
320 Introduce support for SI95 transport library to replace NNG.
321 (RMR library versions will use leading odd numbers to avoid tag collisions
322 with the wrapper tags which will use even numbers.)
324 2019 December 9; version 1.13.1
325 Correct documentation and missing rel-notes update for RTD.
327 2019 December 6; version 1.13.0
328 Add ability to route messages based on the MEID in a message combined
329 with the message type/subscription-ID.
331 2019 November 14; version 1.11.1
332 Fix bug in payload reallocation function; correct length of payload
333 was not always copied.
335 2019 November 13; version 1.12.1
336 New message type constants added to support A1.
338 2019 November 4; version 1.11.0
339 Version bump to move away from the 1.10.* to distinguish between
340 release A and the trial.
342 2019 November 7; version 1.12.0
343 Version cut to support continued development for next release
344 preserving the 1.11.* versions for release 1 (Amber) and
347 2019 October 31; version 1.10.2
348 Provide the means to increase the payload size of a received message
349 without losing the data needed to use the rmr_rts_msg() funciton.
351 2019 October 21; version 1.10.1
352 Fix to prevent null message buffer from being returned by the timeout
353 receive function if the function is passed one to reuse.
355 2019 October 21; version 1.10.1
356 Add periodic dump of send count info to stderr.
358 2019 September 27; version 1.9.0
359 Python bindings added receive all queued function and corrected a unit test
361 2019 September 25; version 1.8.3
362 Correct application level test issue causing timing problems during
363 jenkins verification testing at command and merge
365 Handle the NNG connection shutdown status which may now be
366 generated when a connection throug a proxy is reset.
368 2019 September 25; version 1.8.2
369 Correct bug in rmr_torcv_msg() when timeout set to zero (0).
371 2019 September 19; version 1.8.1
372 Correct missing constant for wrappers.
374 2019 September 19; version 1.8.0
375 New message types added:
376 RAN_CONNECTED, RAN_RESTARTED, RAN_RECONFIGURED
378 2019 September 17; version 1.7.0
379 Initial connection mode now defaults to asynchronous. Set RMR_ASYNC_CONN=0
380 in the environment before rmr_init() is invoked to revert to
381 synchronous first TCP connections. (Recovery connection attempts
382 have always been asynchronous).
384 2019 September 3; version 1.6.0
385 Fix bug in the rmr_rts_msg() function. If a return to sender message
386 failed, the source IP address was not correctly adjusted and could
387 cause the message to be "reflected" back to the sender on a retry.
389 Added the ability to set the source "ID" via an environment var
390 (RMR_SRC_ID). When present in the environment, the string will
391 be placed in to the message header as the source and thus be used
392 by an application calling rmr_rts_smg() to return a response to
393 the sender. If this environment variable is not present, the host
394 name (original behaviour) is used.
396 2019 August 26; version 1.4.0
397 New message types were added.
399 2019 August 16; version 1.3.0
400 New mesage types added.
402 2019 August 13; version 1.2.0 (API change, non-breaking)
403 The function rmr_get_xact() was added to proide a convenient
404 way to extract the transaction field from a message.
406 2019 August 8; version 1.1.0 (API change)
407 This change should be backward compatable/non-breaking
408 A new field has been added to the message buffer (rmr_mbuf_t).
409 This field (tp_state) is used to communicate the errno value
410 that the transport mechanism might set during send and/or
411 receive operations. C programmes should continue to use
412 errno directly, but in some environments wrappers may not be
413 able to access errno and this provides the value to them.
414 See the rmr_alloc_msg manual page for more details.
416 2019 August 6; version 1.0.45 (build changes)
417 Support for the Nanomsg transport library has been dropped.
418 The library librmr.* will no longer be included in packages.
420 Packages will install RMR libraries into the system preferred
421 target directory. On some systems this is /usr/local/lib
422 and on others it is /usr/local/lib64. The diretory is
423 determined by the sytem on which the package is built and
424 NOT by the system installing the package, so it's possible
425 that the RMR libraries end up in a strange location if the
426 .deb or .rpm file was generated on a Linux flavour that
427 has a different preference than the one where the package
430 2019 August 6; version 1.0.44 (API change)
431 Added a new message type constant.
433 2019 July 15; Version 1.0.39 (bug fix)
434 Prevent unnecessary usleep in retry loop.
436 2019 July 12; Version 1.0.38 (API change)
437 Added new message types to RIC_message_types.h.
439 2019 July 11; Version 1.0.37
441 librmr and librmr_nng
442 - Add message buffer API function rmr_trace_ref()
443 (see rmr_trace_ref.3 manual page in dev package).