bfafd2b07d45d3172a1f1883f61e25e3d15f4be6
[profile/ivi/dlt-daemon.git] / ReleaseNotes.txt
1 Diagnostic Log and Trace  - Release Notes\r
2 =========================================\r
3 Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>\r
4 \r
5 Version\r
6 -------\r
7 2.9.0 RELEASE\r
8 \r
9 Changes\r
10 -------\r
11 \r
12 2.9.0\r
13 \r
14    * Changed documentation and man pages into asciidoc format.\r
15    * Increased buffer sizes for DLT user library and DLT daemon\r
16    * [GDLT-120]: truncated and Segmented network tracing\r
17    * [GDLT-137]: Automatically try resending of user buffer after FIFO full\r
18    * [GSWD-85]:  Added authors file\r
19    \r
20 2.8.0\r
21 \r
22    * [GDLT-115]: Encapsulate user macros\r
23    * Fix register app and register context was not stored in buffer when FIFO is full. Other controll messages still not saved in buffer.\r
24    * Create new fifo only when same application registers with different pid.'\r
25    * Do not register appliction again, if already registered.\r
26    * Fixed filetransfer not checking buffer fill level.\r
27 \r
28 2.7.0\r
29 \r
30    * [GDLT-24] Fixing compiler warnings\r
31    * [GDLT-94] Optional sending periodic software version messages. See man pages for more informations\r
32    * [GENDLT-26] Check for description length sanity\r
33    * [GENDLT-24] Crash on invalid injection message fixed\r
34    * [GDLT-93] Add -Wextra flags for compilation Fixed all the warnings that\r
35    * [GDLT-90] Optional: systemd watchdog concept in dlt-system and dlt-daemon\r
36    * [GDLT-67] Re-implemented dlt-system. Read full commit message for more information\r
37 \r
38 2.6.2\r
39 \r
40    * [GDLT-89] Fixed daemon doesn't sent the persistent log level\r
41    * [GDLT-88] Fixed wrong initalization order using offline trace function\r
42 \r
43 2.6.1\r
44 \r
45    * Add _GNU_SOURCE Definition to be able to use O_CLOEXEC\r
46    * Added important SEM_FREE in the daemon and closing fd in the filetransfer\r
47    * [GDLT-3] Fixed missing semaphore around dlt_buffer_push3\r
48    * [GDLT-86] Fixed dlt_free uses absolute file path /tmp and not DLT_USER_DEFINE define\r
49    * [D4099] Check for duplicate file handles, and clean them up if found\r
50    * [GDLT-85] Pipes opened multiple times for the same application pid fixed\r
51    * [GDLT-82] Child process inherits file descriptors openend by their parent fixed\r
52    * [GDLT-84] Instead of calling the injection callback, store a pointer to it and the required parameter data fixed\r
53    * [GDLT-70] Check for malloc failures and return errors where applicable\r
54    * [GDLT-47] Avoid discarding old contexts if no new memory can be allocate\r
55    * [GDLT-69] Fixed bug in dlt-test-multi-process shares context between threads\r
56    \r
57 2.6.0\r
58    \r
59    * [GDLT-75] Use old style directory check on startup\r
60    * [GENDLT-21] Move mcnt from DltContextData to DltContext\r
61    * [GENDLT-15] Fixes to previous integrations from review\r
62    * [GENDLT-15] Safe re-allocations for databuffer\r
63    * [GENDLT-15] use the correct TEXTBUFSIZE\r
64    * [GENDLT-15] Optimize usege of strlen. Improved log level handling\r
65    * [GENDLT-15] Avoid buffer overrun with snprintf()\r
66    * [GENDLT-15] Check return value of dlt_user_log_write_start(_id) correctly\r
67    * [GENDLT-15] Reduce the number of applications if allocation fails\r
68    * [GENDLT-15] Make dlt_user_log_write_start inline\r
69    * [GENDLT-15] Improve errore checking in dlt_user_log_write_start_id\r
70    * [GENDLT-15] Use databussersize to avoid reallocations\r
71    * [GENDLT-15] Rename buffer size constant to avoid confusion\r
72    * [GENDLT-15] Better error handling when writing to FIFO\r
73    * [GENDLT-15] Remove duplicate msg initialization.\r
74    * [GENDLT-15] Optimize away multiple uses of strlen for one check\r
75    * [GDLT-4] Improve queue handling, allow for other messages while transferring a large file\r
76    * [GDLT-4] Limit maximum file queue to 256 files\r
77    * [GDLT-4] First working version of inotify for file transfer\r
78    * [GDLT-2] First test for filetransfer change\r
79    * [GDLT-2] Change to gzip wrapper format. Change file signature creation to account for file size, as inode number maybe duplicate when deleting and creating new files\r
80    * [GDLT-2] Fix bug while reading the options\r
81    * [GDLT-2] Allow for enabling/disabling compression for the separate directories\r
82    * [GDLT-2] Check if the file is already compressed\r
83    * [GDLT-2] Link with libz, fix a typo\r
84    * [GDLT-2] zlib based compression for dlt-system\r
85    * Cleaned some warnings generated from removing stale old code\r
86 \r
87 2.5.2\r
88 \r
89    * Change to Mozilla Public License Version 2.0\r
90    \r
91 2.5.1\r
92 \r
93    * Fixed bug with comparinson between signed and unsigned integer and protection for a buffer overflow.\r
94    * Modified library for new test cases to corrupt data - related to the bug fix for testing signed and unsigned integer\r
95    * [GENDLT-20] Fixed bug to use old cmake version for copy file\r
96    * Replaced dlt-test-filetransfer-image.png with an own created image\r
97    * [GENDLT-21] Fixed bug: Message Counter (MCNT) should be increased but is always 0\r
98 \r
99 2.5.0\r
100 \r
101    * [GDLT-53] Man pages installation included\r
102    * .cproject and .project file for Eclipse included\r
103    * Update of doxygen documentation and generation\r
104    * Rework of root CMake project file, e.g. structure and compile options\r
105    * [GENDLT-16] Create variable in dlt-system.conf to configure the timeout of the filetransfer\r
106    * [GDLT-37] Extend automated test tools for parallel process/threads tests \r
107    * [GSW-138] API Extension to resend the log messages in the user buffer\r
108    * [GDLT-36] Prefixing of dlt_version.h fixed\r
109    * [GDLT-31] Tracefile content stored different under Ubuntu 64 bit version compared to Ubuntu/Win 32 Bit version fixed \r
110    * [GDLT-35] Compile warnings fixed\r
111    * [GSW-137] Wrong include gives error on compailing against dlt fixed\r
112 \r
113 2.4.2\r
114 \r
115    * Added dynamic increasable ringbuffers to user lib and daemon.\r
116    * dlt-system filetransfer now recovers when file is deleted during filetransfer.\r
117        * Added check of file size when starting and deleting files during filetransfer\r
118        * Added chekc of shm buffer availability when push to shm\r
119    * Create abstraction of shm buffer management.\r
120    * Fixed buffer overflow problem in buffer library.\r
121    * Disabled share memory by default - disabled completely shared memory if not enabled.\r
122 \r
123 2.4.1 \r
124 \r
125     * Added dynamic increasable ringbuffers to user lib and dlt-daemon.\r
126     * Created abstraction of shm buffer management.\r
127     * dlt-system filetransfer now recovers when file is deleted during filetransfer.\r
128     * Added check of file size when starting and deleting files during filetransfer.\r
129     * Added check of shm buffer availability when push to shm.\r
130 \r
131 2.4.1 \r
132 \r
133     * Added internal logging facility to stdout, syslog or local file, configurable in configuration file.\r
134     * Added deamonise and signal handlers to dlt-system.\r
135     * Added manual pages.\r
136     * Added new API dlt_check_library_version() function.\r
137     * Fifo or SHM mode can be changed by compiler switch.\r
138     * Replaced SHM implementation.\r
139     * Fixed shared memory problem in DLT library during startup, if application is started before daemon.\r
140     * Fixed syslog adapter in dlt-system.\r
141     * Reverted API changes in dlt_register_app() function.\r
142     * DLT user library does not set the stack size of the receiver thread anymore.\r
143 \r
144 2.4.0\r
145 \r
146     * New config files /etc/dlt.conf and /etc/dlt-system.conf must be adapted to the needs\r
147     * New DLT user lib API dlt_get_log_state() to get DLT client state\r
148     * New DLT user lib API to manage flow control (needed for bulk data logging)\r
149     * New DLT user lib API dlt_set_log_mode() to enable/disable internal/external trace\r
150     * New application dlt-system (filtransfer, proc file system logger,syslog udp adapter included)\r
151     * [GSW-66] File transfer over DLT.\r
152     * [GSW-43] Performance improvement for bulk data over DLT.\r
153     * [GSW-61] Replace command line parameter by configuration file\r
154     * [GSW-13] Support for keep-alive messages as configuration parameter\r
155     * [GSW-60] Extended offline DLT Trace memory handling.\r
156     * Removed filter implementation \r
157         \r
158 2.3.0\r
159 \r
160     * [GSW-16] Systemd configuration for syslog to DLT dapater\r
161     * [GSW-62] DLT Library version check\r
162     * [GSW-28] Directory where persistent data is stored is not configurable  \r
163     * [GSW-59] Statically allocated large array \r
164     * Added init script for Ubuntu\r
165     * Optional adding of gprof compile flags\r
166     * sprintf with float64 fails on ARM platform; disabled this function on QRM platform.\r
167 \r
168 2.2.0\r
169 \r
170     * Moved build process completely to cmake\r
171     * Added commandline parameter -u to set ring buffer size\r
172     * Reduced cpu consumption needed by applications using DLT library\r
173     * Increased default ringbuffer size to 10024 bytes\r
174     * Changed delay in receiver routine to 100ms \r
175 \r
176 2.1.0\r
177 \r
178  * DLT Viewer (QT)\r
179     * New dlt viewer (QT-based) implementated\r
180     * Moved to seperate project, see extra Release Notes for DLT Viewer (QT)\r
181  * DLT Viewer (WX) - Deprecated\r
182     * Old dlt viewer (WX) is removed now from package generation\r
183     * Moved to seperate project\r
184     * Removed filtering of messages during writing to a file\r
185  * DLT library:\r
186     * Functions dlt_file_read_raw() and dlt_file_read_header_raw() added\r
187     * Added support for raw messages in nonverbose mode\r
188     * Injection tables are now dynamically allocated\r
189     * Contexts are now dynamically allocated\r
190     * Added seperate file for platform float types (dlt_float_types.h)\r
191       and used this types.\r
192       Attention: This file must be adapted to each target platform.\r
193     * Removed signal handlers from dlt_user.c; SIGPIPE signal is ignored; atexit() handler still exists\r
194     * Function dlt_forward_msg() added\r
195  * DLT daemon:\r
196     * Small optimization in get_log_info() for one searched application with one searched context,\r
197       which is existing in the context table of the dlt daemon\r
198     * Optional syncing to serial header added\r
199     * Support for keep-alive messages, realized as seperate thread\r
200  * General:\r
201     * Combined dlt-test-user-multi and dlt-test-many to dlt-test-stress\r
202     * Extended dlt-test-client\r
203     * Added stress test3 to dlt-test-stress\r
204     * Added help to dlt-test-stress, printed if no test was selected\r
205     * Added dlt-test-internal\r
206     * Removed plugin support from dlt_receive and dlt_convert\r
207     * Extended documentation\r
208     * dlt viewer (wx): Fixed minor bug, it's possible now to compile the dlt viewer (wx) again under mingw under Windows\r
209     * DLT test programs: Fixed minor bug in dlt-test-user, test3f: Wrong counter was used\r
210     * Removed DLT_LOG calls in injection functions due to problems (application hangs)\r
211 \r
212 2.0.5\r
213 \r
214  * DLT viewer:\r
215         * The default log level is now shown, if already known\r
216         * Renamed Filter->New.. to Filter->Delete all filter\r
217         * Enhanced performance\r
218  * DLT library:\r
219         * On crash or termination of application using the DLT library,\r
220           the registered context and application IDs are removed properly\r
221           (and are deregistered from DLT daemon)\r
222         * dlt_register_context_ll_ts() and Macro therefore added\r
223         * dlt_message_payload() has now additional type DLT_OUTPUT_ASCII_LIMITED\r
224         * dlt_message_header_flags() added\r
225  * DLT daemon:\r
226         * Support for dlt_register_context_ll_ts() added\r
227         * Enhanced support for get_log_info (all modes, 1 app all contexts, 1 app 1 context, all apps all contexts)\r
228         * Added -r option, for automatic sending context information to dlt client; if no client connection is available, \r
229       this information is stored in history buffer in dlt daemon\r
230         * Several internal performance optimizations:\r
231                 * dlt_daemon_context_find(), dlt_daemon_application_find(): Now O(log n) instead O(n)\r
232                 * Several functions optimized\r
233                 * Unnecessary functions removed\r
234  * General:\r
235         * Moved definition of struct DltUser from dlt_user_private.h to dlt_user.h\r
236         * dlt.h includes now dlt_common.h       \r
237         * Extended dlt-test-user and dlt-test-client applications\r
238  * DLT daemon/DLT library: Fixed bug in Filter Delete\r
239  * DLT daemon: Fixed bug in dlt daemon which leads to a crash, when starting/stoping application, then sending\r
240      new log level to context of this (now not running) application.\r
241  * DLT daemon: Fixed bug in unregister application\r
242  * DLT daemon: Fixed bug in reattach to daemon\r
243  * DLT library: Fixed bug in send function\r
244  * DLT viewer: Fixed bug in set default log level\r
245 \r
246 2.0.4\r
247 \r
248  * License has changed from ADRLPD to ADRLRM\r
249  * DLT viewer:\r
250         * Support for non-verbose mode (as FIBEX plugin)\r
251  * DLT library:\r
252         * Support for non-verbose mode (as FIBEX plugin)\r
253         * dlt_message_print_* functions added\r
254         * Semaphore calls added to enable multi-threading\r
255         * Changed injection interface from direct usage to callback\r
256         * Requested log level and trace status is set immediately \r
257           in dlt_set_application_ll_ts_limit()\r
258         * Implemented receiver thread in DLT library\r
259           (used for setting of log level/trace status and for injection handling)\r
260         * Added signal-handler and atexit-handler for cleanup (calls dlt_free())\r
261  * General:\r
262         * Added implementation of clientlib and testclient for Windows\r
263         * Both adaptors sends now log messages with log level DLT_LOG_INFO\r
264         * Multi-threading example in src/tests/dlt-test-user-multi added\r
265  * DLT viewer: Right mouse button for loading plugin descriptions (MOST-/Fibex-XML File)\r
266      is now working (also in Windows)\r
267  * DLT library: Fixed bug in dlt_print_mixed_string()\r
268  * DLT library: Fixed bug in dlt_daemon_contexts_get_next_con_id()\r
269  * DLT daemon: dlt_daemon_process_user_message_unregister_application() also removes now \r
270      all corresponding contexts\r
271  * DLT daemon: Added security check to dlt_daemon_control_get_log_info() in order to avoid crash\r
272      which occured under special circumstances\r
273  * DLT daemon: Register app now opens the connection to the DLT library, \r
274      unregister app closes the connection (was before in register context)\r
275  * Added -lrt to package config file\r
276  * Resolved dependency from dlt_client.h to dlt_common.h -> dlt_common.h is now public\r
277 \r
278 2.0.3\r
279 \r
280  * DLT viewer:\r
281         * Reduced load if idle\r
282         * Modified behaviour of settings in dlt-viewer\r
283         * Always open tmpfile in dlt-viewer if nothing other is specified\r
284         * File->Clear added\r
285  * DLT daemon:\r
286         * Added several checks within code\r
287  * DLT library:\r
288         * Added several checks within code \r
289         * Enhanced local print modes:\r
290           a environment variable now can be used to control local print mode:\r
291           Variable: DLT_LOCAL_PRINT_MODE\r
292           Values  : "AUTOMATIC"             (local print only, if dlt-daemon connection is not\r
293                                              available at startup of program using DLT library)\r
294                     "FORCE_ON"              (always do local print)\r
295                     "FORCE_OFF"             (never do local print)\r
296         * A client library for writing console client applications (Linux) is now available.\r
297           dlt-receiver and dlt-test-client uses this new library code\r
298  * General:\r
299         * Added seperate file for DltMostMessageHeader type\r
300         * Added seperate file for DLT protocol values\r
301         * Relaxed checks for passing trace messages to plugin handler\r
302         * Tested and improved MOST plugin\r
303         * Support for float (32 Bit) and double (64 Bit) values\r
304         * Code fragments for winclientlib and wintestclient added\r
305  * DLT library: Fixed bug in DLT_IMPORT_CONTEXT\r
306  * DLT library: Fixed bug in dlt_plugin_print() and dlt_most_payload()\r
307  * DLT daemon and library: Fixed bug in handling of description strings\r
308  * DLT viewer: Fixed bug in RMB Click for loading plugin description\r
309  * General: Fixed parsing and printing of MOST messages\r
310  * Several small bugs fixed\r
311 \r
312 2.0.2\r
313 \r
314  * DLT viewer:\r
315         * Showing timestamp\r
316         * Compiles now with MS Visual C++\r
317         * Support for loading multiple descriptions \r
318           of plugins is now possible (*)\r
319         * Plugin description can be loaded individually\r
320           by Right-mouse-button (*) \r
321  * DLT daemon:\r
322         * Overflow message is now stored in history buffer,\r
323           if necessary \r
324  * DLT library:\r
325         * Ring-buffer for injection messages implemented\r
326         * History Buffer for Startup + Overflow implemented\r
327         * Setting of maximum logged log level/trace status for \r
328           application triggered by application is now possible\r
329         * Optional local output of Log message is now possible\r
330  * General:\r
331         * Support for ARTIS Box implemented (all, without GUI)\r
332         * Support for timestamp in standardheader extras added\r
333         * Support for ECU ID in standardheader extras added;\r
334           this value can be overwritten by the DLT daemon\r
335  * DLT viewer:\r
336         * Store and load application and context description fixed\r
337         * Fixed crash on termination of Windows version\r
338  * DLT console utilities:\r
339         * Fixed printing of filter ids\r
340  * General:\r
341         * Big Endian/Little Endian support tested and fixed\r
342         * Fixed writing and reading of locally created dlt files\r
343         * Several smaller bugs fixed\r
344 \r
345 2.0.1\r
346 \r
347  * Full support for serial connection between DLT daemon and DLT Viewer\r
348  * Several small bugs fixed in DLT Viewer\r
349 \r
350 2.0.0\r
351 \r
352  * Initial Release of new DLT daemon Version 2 including the new DLT Client DLT Viewer\r
353  * Initial Release\r
354 \r