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