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