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