3 * Copyright (C) 2012 BMW AG
5 * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.
7 * Contributions are licensed to the GENIVI Alliance under one or more
8 * Contribution License Agreements.
11 * This Source Code Form is subject to the terms of the
12 * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
13 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
16 * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012
19 * For further information see http://www.genivi.org/.
24 /*******************************************************************************
26 ** SRC-MODULE: dlt_user.c **
32 ** AUTHOR : Alexander Wenzel Alexander.AW.Wenzel@bmw.de **
39 ** PLATFORM DEPENDANT [yes/no]: yes **
41 ** TO BE CHANGED BY USER [yes/no]: no **
43 *******************************************************************************/
45 /*******************************************************************************
47 ********************************************************************************
49 ** Initials Name Company **
50 ** -------- ------------------------- ---------------------------------- **
51 ** aw Alexander Wenzel BMW **
52 ** mk Markus Klein Fraunhofer ESK **
53 *******************************************************************************/
55 /*******************************************************************************
56 ** Revision Control History **
57 *******************************************************************************/
60 * $LastChangedRevision: 1670 $
61 * $LastChangedDate: 2011-04-08 15:12:06 +0200 (Fr, 08. Apr 2011) $
67 #include <stdlib.h> /* for getenv(), free(), atexit() */
68 #include <string.h> /* for strcmp(), strncmp(), strlen(), memset(), memcpy() */
69 #include <signal.h> /* for signal(), SIGPIPE, SIG_IGN */
71 #if !defined (__WIN32__)
72 #include <syslog.h> /* for LOG_... */
73 #include <semaphore.h>
74 #include <pthread.h> /* POSIX Threads */
81 #include <sys/uio.h> /* writev() */
84 #include "dlt_user_shared.h"
85 #include "dlt_user_shared_cfg.h"
86 #include "dlt_user_cfg.h"
88 static DltUser dlt_user;
89 static int dlt_user_initialised = 0;
91 static char str[DLT_USER_BUFFER_LENGTH];
93 static sem_t dlt_mutex;
94 static pthread_t dlt_receiverthread_handle;
95 static pthread_attr_t dlt_receiverthread_attr;
97 /* Function prototypes for internally used functions */
98 static void dlt_user_receiverthread_function(void *ptr);
99 static void dlt_user_atexit_handler(void);
100 static int dlt_user_log_init(DltContext *handle, DltContextData *log);
101 static int dlt_user_log_send_log(DltContextData *log, int mtype);
102 static int dlt_user_log_send_register_application(void);
103 static int dlt_user_log_send_unregister_application(void);
104 static int dlt_user_log_send_register_context(DltContextData *log);
105 static int dlt_user_log_send_unregister_context(DltContextData *log);
106 static int dlt_send_app_ll_ts_limit(const char *appid, DltLogLevelType loglevel, DltTraceStatusType tracestatus);
107 static int dlt_user_log_send_log_mode(DltUserLogMode mode);
108 static int dlt_user_print_msg(DltMessage *msg, DltContextData *log);
109 static int dlt_user_log_check_user_message(void);
110 static int dlt_user_log_resend_buffer(void);
111 static void dlt_user_log_reattach_to_daemon(void);
112 static int dlt_user_log_send_overflow(void);
114 int dlt_user_check_library_version(const char *user_major_version,const char *user_minor_version){
117 char lib_major_version[DLT_USER_MAX_LIB_VERSION_LENGTH];
118 char lib_minor_version[DLT_USER_MAX_LIB_VERSION_LENGTH];
120 dlt_get_major_version( lib_major_version);
121 dlt_get_minor_version( lib_minor_version);
123 if( (strcmp(lib_major_version,user_major_version)!=0) || (strcmp(lib_minor_version,user_minor_version)!=0))
125 sprintf(str,"DLT Library version check failed! Installed DLT library version is %s.%s - Application using DLT library version %s.%s\n",lib_major_version,lib_minor_version,user_major_version,user_minor_version);
126 dlt_log(LOG_WARNING, str);
134 char filename[DLT_USER_MAX_FILENAME_LENGTH];
137 dlt_user_initialised = 1;
139 /* Initialize common part of dlt_init()/dlt_init_file() */
140 if (dlt_init_common()==-1)
142 dlt_user_initialised = 0;
146 dlt_user.dlt_is_file = 0;
147 dlt_user.overflow = 0;
148 #ifdef DLT_SHM_ENABLE
149 memset(&(dlt_user.dlt_shm),0,sizeof(DltShm));
152 /* create and open DLT user FIFO */
153 sprintf(filename,"%s/dlt%d",DLT_USER_DIR,getpid());
155 /* Try to delete existing pipe, ignore result of unlink */
158 ret=mkfifo(filename, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH );
161 sprintf(str,"Loging disabled, FIFO user %s cannot be created!\n",filename);
162 dlt_log(LOG_WARNING, str);
163 /* return 0; */ /* removed to prevent error, when FIFO already exists */
166 dlt_user.dlt_user_handle = open(filename, O_RDWR);
167 if (dlt_user.dlt_user_handle == -1)
169 sprintf(str,"Loging disabled, FIFO user %s cannot be opened!\n",filename);
170 dlt_log(LOG_WARNING, str);
175 /* open DLT output FIFO */
176 dlt_user.dlt_log_handle = open(DLT_USER_FIFO, O_WRONLY | O_NONBLOCK);
177 if (dlt_user.dlt_log_handle==-1)
179 sprintf(str,"Loging disabled, FIFO %s cannot be opened with open()!\n",DLT_USER_FIFO);
180 dlt_log(LOG_WARNING, str);
185 #ifdef DLT_SHM_ENABLE
186 /* init shared memory */
187 if (dlt_shm_init_client(&(dlt_user.dlt_shm),DLT_SHM_KEY) < 0)
189 sprintf(str,"Loging disabled, Shared memory %d cannot be created!\n",DLT_SHM_KEY);
190 dlt_log(LOG_WARNING, str);
197 if (dlt_receiver_init(&(dlt_user.receiver),dlt_user.dlt_user_handle, DLT_USER_RCVBUF_MAX_SIZE)==-1)
199 dlt_user_initialised = 0;
203 /* Start receiver thread */
204 if (pthread_create(&(dlt_receiverthread_handle),
206 (void *) &dlt_user_receiverthread_function,
209 if (pthread_attr_destroy(&dlt_receiverthread_attr)!=0)
211 dlt_log(LOG_WARNING, "Can't destroy thread attributes!\n");
214 dlt_log(LOG_CRIT, "Can't create receiver thread!\n");
215 dlt_user_initialised = 0;
219 if (pthread_attr_destroy(&dlt_receiverthread_attr)!=0)
221 dlt_log(LOG_WARNING, "Can't destroy thread attributes!\n");
227 int dlt_init_file(const char *name)
229 dlt_user_initialised = 1;
231 /* Initialize common part of dlt_init()/dlt_init_file() */
232 if (dlt_init_common()==-1)
234 dlt_user_initialised = 0;
238 dlt_user.dlt_is_file = 1;
240 /* open DLT output file */
241 dlt_user.dlt_log_handle = open(name,O_WRONLY|O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); /* mode: wb */
242 if (dlt_user.dlt_log_handle == -1)
244 sprintf(str,"Log file %s cannot be opened!\n",name);
245 dlt_log(LOG_ERR, str);
252 int dlt_init_common(void)
254 char *env_local_print;
256 /* Binary semaphore for threads */
257 if (sem_init(&dlt_mutex, 0, 1)==-1)
259 dlt_user_initialised = 0;
263 /* set to unknown state of connected client */
264 dlt_user.log_state = -1;
266 dlt_user.dlt_log_handle=-1;
267 dlt_user.dlt_user_handle=-1;
269 dlt_set_id(dlt_user.ecuID,DLT_USER_DEFAULT_ECU_ID);
270 dlt_set_id(dlt_user.appID,"");
272 dlt_user.application_description = 0;
274 /* Verbose mode is enabled by default */
275 dlt_user.verbose_mode = 1;
277 /* Local print is disabled by default */
278 dlt_user.enable_local_print = 0;
280 dlt_user.local_print_mode = DLT_PM_UNSET;
282 env_local_print = getenv(DLT_USER_ENV_LOCAL_PRINT_MODE);
285 if (strcmp(env_local_print,"AUTOMATIC")==0)
287 dlt_user.local_print_mode = DLT_PM_AUTOMATIC;
289 else if (strcmp(env_local_print,"FORCE_ON")==0)
291 dlt_user.local_print_mode = DLT_PM_FORCE_ON;
293 else if (strcmp(env_local_print,"FORCE_OFF")==0)
295 dlt_user.local_print_mode = DLT_PM_FORCE_OFF;
299 /* Initialize LogLevel/TraceStatus field */
300 dlt_user.dlt_ll_ts = 0;
301 dlt_user.dlt_ll_ts_max_num_entries = 0;
302 dlt_user.dlt_ll_ts_num_entries = 0;
304 if (dlt_buffer_init_dynamic(&(dlt_user.startup_buffer), DLT_USER_RINGBUFFER_MIN_SIZE, DLT_USER_RINGBUFFER_MAX_SIZE, DLT_USER_RINGBUFFER_STEP_SIZE)==-1)
306 dlt_user_initialised = 0;
310 signal(SIGPIPE,SIG_IGN); /* ignore pipe signals */
312 atexit(dlt_user_atexit_handler);
314 #ifdef DLT_TEST_ENABLE
315 dlt_user.corrupt_user_header = 0;
316 dlt_user.corrupt_message_size = 0;
317 dlt_user.corrupt_message_size_size = 0;
323 void dlt_user_atexit_handler(void)
326 /* Try to resend potential log messages in the user buffer */
327 int count = dlt_user_atexit_blow_out_user_buffer();
331 sprintf(tmp,"Lost log messages in user buffer when exiting: %i\n",count);
332 dlt_log(LOG_ERR, tmp);
335 /* Unregister app (this also unregisters all contexts in daemon) */
336 /* Ignore return value */
337 dlt_unregister_app();
340 /* Ignore return value */
344 int dlt_user_atexit_blow_out_user_buffer(void){
348 uint32_t exitTime = dlt_uptime() + DLT_USER_ATEXIT_RESEND_BUFFER_EXIT_TIMEOUT;
350 while(dlt_uptime() < exitTime ){
352 ret = dlt_user_log_resend_buffer();
359 usleep(DLT_USER_ATEXIT_RESEND_BUFFER_SLEEP);
363 count = dlt_buffer_get_message_count(&(dlt_user.startup_buffer));
372 char filename[DLT_USER_MAX_FILENAME_LENGTH];
374 if (dlt_user_initialised==0)
379 if (dlt_receiverthread_handle)
381 /* Ignore return value */
382 pthread_cancel(dlt_receiverthread_handle);
385 if (dlt_user.dlt_user_handle!=-1)
387 sprintf(filename,"/tmp/dlt%d",getpid());
389 close(dlt_user.dlt_user_handle);
390 dlt_user.dlt_user_handle=-1;
395 #ifdef DLT_SHM_ENABLE
396 /* free shared memory */
397 dlt_shm_free_client(&dlt_user.dlt_shm);
400 if (dlt_user.dlt_log_handle!=-1)
402 /* close log file/output fifo to daemon */
403 close(dlt_user.dlt_log_handle);
404 dlt_user.dlt_log_handle = -1;
407 /* Ignore return value */
408 dlt_receiver_free(&(dlt_user.receiver));
410 /* Ignore return value */
411 dlt_buffer_free_dynamic(&(dlt_user.startup_buffer));
413 if (dlt_user.dlt_ll_ts)
415 for (i=0;i<dlt_user.dlt_ll_ts_max_num_entries;i++)
417 if (dlt_user.dlt_ll_ts[i].injection_table!=0)
419 free(dlt_user.dlt_ll_ts[i].injection_table);
420 dlt_user.dlt_ll_ts[i].injection_table = 0;
422 dlt_user.dlt_ll_ts[i].nrcallbacks = 0;
425 free(dlt_user.dlt_ll_ts);
426 dlt_user.dlt_ll_ts = 0;
427 dlt_user.dlt_ll_ts_max_num_entries = 0;
428 dlt_user.dlt_ll_ts_num_entries = 0;
431 dlt_user_initialised = 0;
436 int dlt_check_library_version(const char * user_major_version,const char * user_minor_version)
438 return dlt_user_check_library_version(user_major_version, user_minor_version);
441 int dlt_register_app(const char *appid, const char * description)
445 if (dlt_user_initialised==0)
453 if ((appid==0) || (appid[0]=='\0'))
460 /* Store locally application id and application description */
461 dlt_set_id(dlt_user.appID, appid);
463 if (dlt_user.application_description!=0)
465 free(dlt_user.application_description);
468 dlt_user.application_description = 0;
472 size_t desc_len = strlen(description);
473 dlt_user.application_description= malloc(desc_len+1);
474 if (dlt_user.application_description){
475 strncpy(dlt_user.application_description, description, desc_len);
477 /* Terminate transmitted string with 0 */
478 dlt_user.application_description[desc_len]='\0';
484 ret = dlt_user_log_send_register_application();
488 int dlt_register_context(DltContext *handle, const char *contextid, const char * description)
490 if (dlt_user_initialised==0)
500 if (dlt_user.appID[0]=='\0')
502 dlt_log(LOG_ERR, "no application registered!\n");
508 if ((contextid==0) || (contextid[0]=='\0'))
516 return dlt_register_context_ll_ts(handle, contextid, description, DLT_USER_LOG_LEVEL_NOT_SET, DLT_USER_TRACE_STATUS_NOT_SET);
519 int dlt_register_context_ll_ts(DltContext *handle, const char *contextid, const char * description, int loglevel, int tracestatus)
524 char ctid[DLT_ID_SIZE+1];
526 if (dlt_user_initialised==0)
536 if (dlt_user.appID[0]=='\0')
538 dlt_log(LOG_ERR, "no application registered!\n");
546 if ((contextid==0) || (contextid[0]=='\0'))
551 if ((loglevel<DLT_USER_LOG_LEVEL_NOT_SET) || (loglevel>DLT_LOG_VERBOSE) || (loglevel==DLT_LOG_DEFAULT))
556 if ((tracestatus<DLT_USER_TRACE_STATUS_NOT_SET) || (tracestatus>DLT_TRACE_STATUS_ON) || (tracestatus==DLT_TRACE_STATUS_DEFAULT))
561 if (dlt_user_log_init(handle, &log)==-1)
566 /* Reset message counter */
569 /* Store context id in log level/trace status field */
571 /* Check if already registered, else register context */
575 for (i=0;i<dlt_user.dlt_ll_ts_num_entries;i++)
577 if (dlt_user.dlt_ll_ts)
579 if (memcmp(dlt_user.dlt_ll_ts[i].contextID, contextid,DLT_ID_SIZE)==0)
583 memset(ctid,0,(DLT_ID_SIZE+1));
584 dlt_print_id(ctid, contextid);
586 sprintf(str,"context '%s' already registered!\n",ctid);
587 dlt_log(LOG_WARNING, str);
596 /* Allocate or expand context array */
597 if (dlt_user.dlt_ll_ts == 0)
599 dlt_user.dlt_ll_ts = (dlt_ll_ts_type*) malloc(sizeof(dlt_ll_ts_type)*DLT_USER_CONTEXT_ALLOC_SIZE);
600 if (dlt_user.dlt_ll_ts==0)
606 dlt_user.dlt_ll_ts_max_num_entries = DLT_USER_CONTEXT_ALLOC_SIZE;
608 /* Initialize new entries */
609 for (i=0;i<dlt_user.dlt_ll_ts_max_num_entries;i++)
611 dlt_set_id(dlt_user.dlt_ll_ts[i].contextID,"");
613 /* At startup, logging and tracing is locally enabled */
614 /* the correct log level/status is set after received from daemon */
615 dlt_user.dlt_ll_ts[i].log_level = DLT_USER_INITIAL_LOG_LEVEL;
616 dlt_user.dlt_ll_ts[i].trace_status = DLT_USER_INITIAL_TRACE_STATUS;
618 dlt_user.dlt_ll_ts[i].context_description = 0;
620 dlt_user.dlt_ll_ts[i].injection_table = 0;
621 dlt_user.dlt_ll_ts[i].nrcallbacks = 0;
626 if ((dlt_user.dlt_ll_ts_num_entries%DLT_USER_CONTEXT_ALLOC_SIZE)==0)
628 /* allocate memory in steps of DLT_USER_CONTEXT_ALLOC_SIZE, e.g. 500 */
629 dlt_ll_ts_type *old_ll_ts;
630 uint32_t old_max_entries;
632 old_ll_ts = dlt_user.dlt_ll_ts;
633 old_max_entries = dlt_user.dlt_ll_ts_max_num_entries;
635 dlt_user.dlt_ll_ts_max_num_entries = ((dlt_user.dlt_ll_ts_num_entries/DLT_USER_CONTEXT_ALLOC_SIZE)+1)*DLT_USER_CONTEXT_ALLOC_SIZE;
636 dlt_user.dlt_ll_ts = (dlt_ll_ts_type*) malloc(sizeof(dlt_ll_ts_type)*
637 dlt_user.dlt_ll_ts_max_num_entries);
638 if (dlt_user.dlt_ll_ts==0)
640 dlt_user.dlt_ll_ts = old_ll_ts;
641 dlt_user.dlt_ll_ts_max_num_entries = old_max_entries;
646 memcpy(dlt_user.dlt_ll_ts,old_ll_ts,sizeof(dlt_ll_ts_type)*dlt_user.dlt_ll_ts_num_entries);
649 /* Initialize new entries */
650 for (i=dlt_user.dlt_ll_ts_num_entries;i<dlt_user.dlt_ll_ts_max_num_entries;i++)
652 dlt_set_id(dlt_user.dlt_ll_ts[i].contextID,"");
654 /* At startup, logging and tracing is locally enabled */
655 /* the correct log level/status is set after received from daemon */
656 dlt_user.dlt_ll_ts[i].log_level = DLT_USER_INITIAL_LOG_LEVEL;
657 dlt_user.dlt_ll_ts[i].trace_status = DLT_USER_INITIAL_TRACE_STATUS;
659 dlt_user.dlt_ll_ts[i].context_description = 0;
661 dlt_user.dlt_ll_ts[i].injection_table = 0;
662 dlt_user.dlt_ll_ts[i].nrcallbacks = 0;
667 /* Store locally context id and context description */
668 dlt_set_id(dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].contextID, contextid);
670 if (dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].context_description!=0)
672 free(dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].context_description);
675 dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].context_description = 0;
679 size_t desc_len = strlen(description);
680 dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].context_description = malloc(desc_len+1);
681 strncpy(dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].context_description, description, desc_len);
683 /* Terminate transmitted string with 0 */
684 dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].context_description[desc_len]='\0';
687 if (loglevel!=DLT_USER_LOG_LEVEL_NOT_SET)
689 dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].log_level = loglevel;
692 if (tracestatus!=DLT_USER_TRACE_STATUS_NOT_SET)
694 dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].trace_status = tracestatus;
697 /* Prepare transfer struct */
698 //dlt_set_id(log->appID, dlt_user.appID);
699 dlt_set_id(handle->contextID, contextid);
700 handle->log_level_pos = dlt_user.dlt_ll_ts_num_entries;
702 log.context_description = dlt_user.dlt_ll_ts[dlt_user.dlt_ll_ts_num_entries].context_description;
704 if (loglevel!=DLT_USER_LOG_LEVEL_NOT_SET)
706 log.log_level = loglevel;
710 log.log_level = DLT_USER_LOG_LEVEL_NOT_SET;
713 if (tracestatus!=DLT_USER_TRACE_STATUS_NOT_SET)
715 log.trace_status = tracestatus;
719 log.trace_status = DLT_USER_TRACE_STATUS_NOT_SET;
722 dlt_user.dlt_ll_ts_num_entries++;
726 ret=dlt_user_log_send_register_context(&log);
738 int dlt_unregister_app(void)
742 if (dlt_user_initialised==0)
747 /* Inform daemon to unregister application and all of its contexts */
748 ret = dlt_user_log_send_unregister_application();
752 /* Clear and free local stored application information */
753 dlt_set_id(dlt_user.appID, "");
755 if (dlt_user.application_description!=0)
757 free(dlt_user.application_description);
760 dlt_user.application_description = 0;
767 int dlt_unregister_context(DltContext *handle)
772 if (dlt_user_initialised==0)
777 if (dlt_user_log_init(handle, &log) == -1)
784 if (dlt_user.dlt_ll_ts)
786 /* Clear and free local stored context information */
787 dlt_set_id(dlt_user.dlt_ll_ts[handle->log_level_pos].contextID, "");
789 dlt_user.dlt_ll_ts[handle->log_level_pos].log_level = DLT_USER_INITIAL_LOG_LEVEL;
790 dlt_user.dlt_ll_ts[handle->log_level_pos].trace_status = DLT_USER_INITIAL_TRACE_STATUS;
792 if (dlt_user.dlt_ll_ts[handle->log_level_pos].context_description!=0)
794 free(dlt_user.dlt_ll_ts[handle->log_level_pos].context_description);
797 dlt_user.dlt_ll_ts[handle->log_level_pos].context_description = 0;
799 if (dlt_user.dlt_ll_ts[handle->log_level_pos].injection_table)
801 free(dlt_user.dlt_ll_ts[handle->log_level_pos].injection_table);
802 dlt_user.dlt_ll_ts[handle->log_level_pos].injection_table = 0;
805 dlt_user.dlt_ll_ts[handle->log_level_pos].nrcallbacks = 0;
810 /* Inform daemon to unregister context */
811 ret = dlt_user_log_send_unregister_context(&log);
816 int dlt_set_application_ll_ts_limit(DltLogLevelType loglevel, DltTraceStatusType tracestatus)
821 if (dlt_user_initialised==0)
829 /* Removed because of DltLogLevelType and DltTraceStatusType
831 if ((loglevel<DLT_LOG_DEFAULT) || (loglevel>DLT_LOG_VERBOSE))
836 if ((tracestatus<DLT_TRACE_STATUS_DEFAULT) || (tracestatus>DLT_TRACE_STATUS_ON))
841 if (dlt_user.dlt_ll_ts==0)
850 /* Update local structures */
851 for (i=0; i<dlt_user.dlt_ll_ts_num_entries;i++)
853 dlt_user.dlt_ll_ts[i].log_level = loglevel;
854 dlt_user.dlt_ll_ts[i].trace_status = tracestatus;
859 /* Inform DLT server about update */
860 ret = dlt_send_app_ll_ts_limit(dlt_user.appID, loglevel, tracestatus);
865 int dlt_get_log_state()
867 return dlt_user.log_state;
870 int dlt_set_log_mode(DltUserLogMode mode)
872 if (dlt_user_initialised==0)
880 return dlt_user_log_send_log_mode(mode);
883 int dlt_forward_msg(void *msgdata,size_t size)
885 DltUserHeader userheader;
888 if ((msgdata==0) || (size==0))
893 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_LOG)==-1)
895 /* Type of internal user message; same value for Trace messages */
899 if (dlt_user.dlt_is_file)
902 ret = dlt_user_log_out2(dlt_user.dlt_log_handle, msgdata, size, 0, 0);
903 return ((ret==DLT_RETURN_OK)?0:-1);
907 /* Reattach to daemon if neccesary */
908 dlt_user_log_reattach_to_daemon();
910 if (dlt_user.overflow)
912 if (dlt_user_log_send_overflow()==0)
919 ret = dlt_user_log_out3(dlt_user.dlt_log_handle,
920 &(userheader), sizeof(DltUserHeader),
921 msgdata, size, 0, 0);
923 /* store message in ringbuffer, if an error has occured */
924 if (ret!=DLT_RETURN_OK)
928 if (dlt_buffer_push3(&(dlt_user.startup_buffer),
929 (unsigned char *)&(userheader), sizeof(DltUserHeader),
930 msgdata, size, 0, 0)==-1)
932 dlt_log(LOG_ERR,"Storing message to history buffer failed! Message discarded.\n");
940 case DLT_RETURN_PIPE_FULL:
942 /* data could not be written */
943 dlt_user.overflow = 1;
946 case DLT_RETURN_PIPE_ERROR:
948 /* handle not open or pipe error */
949 close(dlt_user.dlt_log_handle);
950 dlt_user.dlt_log_handle = -1;
954 case DLT_RETURN_ERROR:
956 /* other error condition */
965 /* This case should not occur */
974 /* ********************************************************************************************* */
976 inline int dlt_user_log_write_start(DltContext *handle, DltContextData *log,DltLogLevelType loglevel)
978 return dlt_user_log_write_start_id(handle,log,loglevel,DLT_USER_DEFAULT_MSGID);
981 int dlt_user_log_write_start_id(DltContext *handle, DltContextData *log,DltLogLevelType loglevel, uint32_t messageid)
983 if(dlt_user_initialised==0)
995 if (dlt_user_log_init(handle, log)==-1)
1000 if (dlt_user.dlt_ll_ts==0)
1007 if ((loglevel<=(int)(dlt_user.dlt_ll_ts[handle->log_level_pos].log_level) ) && (loglevel!=0))
1011 log->log_level = loglevel;
1013 /* In non-verbose mode, insert message id */
1014 if (dlt_user.verbose_mode==0)
1016 if ((sizeof(uint32_t))>DLT_USER_BUF_MAX_SIZE)
1020 /* Write message id */
1021 memcpy(log->buffer,&(messageid),sizeof(uint32_t));
1022 log->size = sizeof(uint32_t);
1024 /* as the message id is part of each message in non-verbose mode,
1025 it doesn't increment the argument counter in extended header (if used) */
1039 int dlt_user_log_write_finish(DltContextData *log)
1046 return dlt_user_log_send_log(log, DLT_TYPE_LOG);
1049 int dlt_user_log_write_raw(DltContextData *log,void *data,uint16_t length)
1059 if ((log->size+length+sizeof(uint16_t))>DLT_USER_BUF_MAX_SIZE)
1064 if (dlt_user.verbose_mode)
1066 if ((log->size+length+sizeof(uint32_t)+sizeof(uint16_t))>DLT_USER_BUF_MAX_SIZE)
1071 /* Transmit type information */
1072 type_info = DLT_TYPE_INFO_RAWD;
1074 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1075 log->size += sizeof(uint32_t);
1079 /* First transmit length of raw data, then the raw data itself */
1080 arg_size = (uint16_t)length;
1082 memcpy((log->buffer)+log->size,&(arg_size),sizeof(uint16_t));
1083 log->size += sizeof(uint16_t);
1085 memcpy((log->buffer)+log->size,data,arg_size);
1086 log->size += arg_size;
1093 int dlt_user_log_write_float32(DltContextData *log, float32_t data)
1102 if (sizeof(float32_t)!=4)
1107 if ((log->size+sizeof(float32_t))>DLT_USER_BUF_MAX_SIZE)
1112 if (dlt_user.verbose_mode)
1114 if ((log->size+sizeof(uint32_t)+sizeof(float32_t))>DLT_USER_BUF_MAX_SIZE)
1119 type_info = DLT_TYPE_INFO_FLOA | DLT_TYLE_32BIT;
1121 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1122 log->size += sizeof(uint32_t);
1125 memcpy((log->buffer)+log->size,&data, sizeof(float32_t));
1126 log->size += sizeof(float32_t);
1133 int dlt_user_log_write_float64(DltContextData *log, float64_t data)
1142 if (sizeof(float64_t)!=8)
1147 if ((log->size+sizeof(float64_t))>DLT_USER_BUF_MAX_SIZE)
1152 if (dlt_user.verbose_mode)
1154 if ((log->size+sizeof(uint32_t)+sizeof(float64_t))>DLT_USER_BUF_MAX_SIZE)
1159 type_info = DLT_TYPE_INFO_FLOA | DLT_TYLE_64BIT;
1161 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1162 log->size += sizeof(uint32_t);
1165 memcpy((log->buffer)+log->size,&data, sizeof(float64_t));
1166 log->size += sizeof(float64_t);
1173 int dlt_user_log_write_uint( DltContextData *log, unsigned int data)
1180 switch (sizeof(unsigned int))
1184 return dlt_user_log_write_uint8(log, (uint8_t)data);
1189 return dlt_user_log_write_uint16(log, (uint16_t)data);
1194 return dlt_user_log_write_uint32(log, (uint32_t)data);
1199 return dlt_user_log_write_uint64(log, (uint64_t)data);
1212 int dlt_user_log_write_uint8(DltContextData *log, uint8_t data)
1221 if ((log->size+sizeof(uint8_t))>DLT_USER_BUF_MAX_SIZE)
1226 if (dlt_user.verbose_mode)
1228 if ((log->size+sizeof(uint32_t)+sizeof(uint8_t))>DLT_USER_BUF_MAX_SIZE)
1233 type_info = DLT_TYPE_INFO_UINT | DLT_TYLE_8BIT;
1235 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1236 log->size += sizeof(uint32_t);
1239 memcpy((log->buffer)+log->size,&data,sizeof(uint8_t));
1240 log->size += sizeof(uint8_t);
1247 int dlt_user_log_write_uint16(DltContextData *log, uint16_t data)
1256 if ((log->size+sizeof(uint16_t))>DLT_USER_BUF_MAX_SIZE)
1261 if (dlt_user.verbose_mode)
1263 if ((log->size+sizeof(uint32_t)+sizeof(uint16_t))>DLT_USER_BUF_MAX_SIZE)
1268 type_info = DLT_TYPE_INFO_UINT | DLT_TYLE_16BIT;
1270 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1271 log->size += sizeof(uint32_t);
1274 memcpy((log->buffer)+log->size,&data,sizeof(uint16_t));
1275 log->size += sizeof(uint16_t);
1282 int dlt_user_log_write_uint32(DltContextData *log, uint32_t data)
1291 if ((log->size+sizeof(uint32_t))>DLT_USER_BUF_MAX_SIZE)
1296 if (dlt_user.verbose_mode)
1298 if ((log->size+sizeof(uint32_t)+sizeof(uint32_t))>DLT_USER_BUF_MAX_SIZE)
1303 type_info = DLT_TYPE_INFO_UINT | DLT_TYLE_32BIT;
1305 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1306 log->size += sizeof(uint32_t);
1309 memcpy((log->buffer)+log->size,&data, sizeof(uint32_t));
1310 log->size += sizeof(uint32_t);
1317 int dlt_user_log_write_uint64(DltContextData *log, uint64_t data)
1326 if ((log->size+sizeof(uint64_t))>DLT_USER_BUF_MAX_SIZE)
1331 if (dlt_user.verbose_mode)
1333 if ((log->size+sizeof(uint32_t)+sizeof(uint64_t))>DLT_USER_BUF_MAX_SIZE)
1338 type_info = DLT_TYPE_INFO_UINT | DLT_TYLE_64BIT;
1340 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1341 log->size +=sizeof(uint32_t);
1344 memcpy((log->buffer)+log->size,&data,sizeof(uint64_t));
1345 log->size += sizeof(uint64_t);
1352 int dlt_user_log_write_int(DltContextData *log, int data)
1359 switch (sizeof(int))
1363 return dlt_user_log_write_int8(log, (int8_t)data);
1368 return dlt_user_log_write_int16(log, (int16_t)data);
1373 return dlt_user_log_write_int32(log, (int32_t)data);
1378 return dlt_user_log_write_int64(log, (int64_t)data);
1391 int dlt_user_log_write_int8(DltContextData *log, int8_t data)
1400 if ((log->size+sizeof(int8_t))>DLT_USER_BUF_MAX_SIZE)
1405 if (dlt_user.verbose_mode)
1407 if ((log->size+sizeof(uint32_t)+sizeof(int8_t))>DLT_USER_BUF_MAX_SIZE)
1412 type_info = DLT_TYPE_INFO_SINT | DLT_TYLE_8BIT;
1414 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1415 log->size += sizeof(uint32_t);
1418 memcpy((log->buffer)+log->size,&data,sizeof(int8_t));
1419 log->size += sizeof(int8_t);
1426 int dlt_user_log_write_int16(DltContextData *log, int16_t data)
1435 if ((log->size+sizeof(int16_t))>DLT_USER_BUF_MAX_SIZE)
1440 if (dlt_user.verbose_mode)
1442 if ((log->size+sizeof(uint32_t)+sizeof(int16_t))>DLT_USER_BUF_MAX_SIZE)
1447 type_info = DLT_TYPE_INFO_SINT | DLT_TYLE_16BIT;
1449 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1450 log->size += sizeof(uint32_t);
1453 memcpy((log->buffer)+log->size,&data,sizeof(int16_t));
1454 log->size += sizeof(int16_t);
1461 int dlt_user_log_write_int32(DltContextData *log, int32_t data)
1470 if ((log->size+sizeof(int32_t))>DLT_USER_BUF_MAX_SIZE)
1475 if (dlt_user.verbose_mode)
1477 if ((log->size+sizeof(uint32_t)+sizeof(int32_t))>DLT_USER_BUF_MAX_SIZE)
1482 type_info = DLT_TYPE_INFO_SINT | DLT_TYLE_32BIT;
1484 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1485 log->size += sizeof(uint32_t);
1488 memcpy((log->buffer)+log->size,&data, sizeof(int32_t));
1489 log->size += sizeof(int32_t);
1496 int dlt_user_log_write_int64(DltContextData *log, int64_t data)
1505 if ((log->size+sizeof(int64_t))>DLT_USER_BUF_MAX_SIZE)
1510 if (dlt_user.verbose_mode)
1512 if ((log->size+sizeof(uint32_t)+sizeof(int64_t))>DLT_USER_BUF_MAX_SIZE)
1517 type_info = DLT_TYPE_INFO_SINT | DLT_TYLE_64BIT;
1519 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1520 log->size += sizeof(uint32_t);
1523 memcpy((log->buffer)+log->size,&data,sizeof(int64_t));
1524 log->size += sizeof(int64_t);
1531 int dlt_user_log_write_bool(DltContextData *log, uint8_t data)
1540 if ((log->size+sizeof(uint8_t))>DLT_USER_BUF_MAX_SIZE)
1545 if (dlt_user.verbose_mode)
1547 if ((log->size+sizeof(uint32_t)+sizeof(uint8_t))>DLT_USER_BUF_MAX_SIZE)
1552 type_info = DLT_TYPE_INFO_BOOL;
1554 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1555 log->size += sizeof(uint32_t);
1558 memcpy((log->buffer)+log->size,&data,sizeof(uint8_t));
1559 log->size += sizeof(uint8_t);
1566 int dlt_user_log_write_string(DltContextData *log, const char *text)
1571 if ((log==0) || (text==0))
1576 if ((log->size+(strlen(text)+1)+sizeof(uint16_t))>DLT_USER_BUF_MAX_SIZE)
1581 if (dlt_user.verbose_mode)
1583 if ((log->size+(strlen(text)+1)+sizeof(uint32_t)+sizeof(uint16_t))>DLT_USER_BUF_MAX_SIZE)
1588 type_info = DLT_TYPE_INFO_STRG;
1590 memcpy((log->buffer)+log->size,&(type_info),sizeof(uint32_t));
1591 log->size += sizeof(uint32_t);
1594 arg_size = strlen(text) + 1;
1596 memcpy((log->buffer)+log->size,&(arg_size),sizeof(uint16_t));
1597 log->size += sizeof(uint16_t);
1599 memcpy((log->buffer)+log->size,text,arg_size);
1600 log->size += arg_size;
1607 int dlt_register_injection_callback(DltContext *handle, uint32_t service_id,
1608 int (*dlt_injection_callback)(uint32_t service_id, void *data, uint32_t length))
1614 DltUserInjectionCallback *old;
1621 if (dlt_user_log_init(handle, &log)==-1)
1626 if (service_id<DLT_USER_INJECTION_MIN)
1630 /* This function doesn't make sense storing to local file is choosen;
1631 so terminate this function */
1632 if (dlt_user.dlt_is_file)
1639 if (dlt_user.dlt_ll_ts==0)
1645 /* Insert callback in corresponding table */
1646 i=handle->log_level_pos;
1648 /* Insert each service_id only once */
1649 for (k=0;k<dlt_user.dlt_ll_ts[i].nrcallbacks;k++)
1651 if ((dlt_user.dlt_ll_ts[i].injection_table) &&
1652 (dlt_user.dlt_ll_ts[i].injection_table[k].service_id == service_id))
1665 j=dlt_user.dlt_ll_ts[i].nrcallbacks;
1667 /* Allocate or expand injection table */
1668 if (dlt_user.dlt_ll_ts[i].injection_table == 0)
1670 dlt_user.dlt_ll_ts[i].injection_table = (DltUserInjectionCallback*) malloc(sizeof(DltUserInjectionCallback));
1674 old = dlt_user.dlt_ll_ts[i].injection_table;
1675 dlt_user.dlt_ll_ts[i].injection_table = (DltUserInjectionCallback*) malloc(sizeof(DltUserInjectionCallback)*(j+1));
1676 memcpy(dlt_user.dlt_ll_ts[i].injection_table,old,sizeof(DltUserInjectionCallback)*j);
1680 dlt_user.dlt_ll_ts[i].nrcallbacks++;
1683 /* Store service_id and corresponding function pointer for callback function */
1684 dlt_user.dlt_ll_ts[i].injection_table[j].service_id = service_id;
1685 dlt_user.dlt_ll_ts[i].injection_table[j].injection_callback = dlt_injection_callback;
1691 int dlt_user_trace_network(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload)
1695 if (dlt_user_initialised==0)
1703 if (dlt_user_log_init(handle, &log)==-1)
1713 /* Commented out because of DltNetworkTraceType:
1715 if ((nw_trace_type<=0) || (nw_trace_type>0x15))
1724 if (dlt_user.dlt_ll_ts==0)
1730 if (dlt_user.dlt_ll_ts[handle->log_level_pos].trace_status==DLT_TRACE_STATUS_ON)
1735 log.trace_status = nw_trace_type;
1743 /* Write header and its length */
1744 if (dlt_user_log_write_raw(&log, header, header_len)==-1)
1754 /* Write payload and its length */
1755 if (dlt_user_log_write_raw(&log, payload, payload_len)==-1)
1761 return dlt_user_log_send_log(&log, DLT_TYPE_NW_TRACE);
1771 int dlt_log_string(DltContext *handle,DltLogLevelType loglevel, const char *text)
1775 if (dlt_user.verbose_mode==0)
1780 if ((handle==0) || (text==0))
1785 if (dlt_user_log_write_start(handle,&log,loglevel)>0)
1787 if (dlt_user_log_write_string(&log,text)==-1)
1791 if (dlt_user_log_write_finish(&log)==-1)
1800 int dlt_log_string_int(DltContext *handle,DltLogLevelType loglevel, const char *text, int data)
1804 if (dlt_user.verbose_mode==0)
1809 if ((handle==0) || (text==0))
1814 if (dlt_user_log_write_start(handle,&log,loglevel)>0)
1816 if (dlt_user_log_write_string(&log,text)==-1)
1820 if (dlt_user_log_write_int(&log,data)==-1)
1824 if (dlt_user_log_write_finish(&log)==-1)
1833 int dlt_log_string_uint(DltContext *handle,DltLogLevelType loglevel, const char *text, unsigned int data)
1837 if (dlt_user.verbose_mode==0)
1842 if ((handle==0) || (text==0))
1847 if (dlt_user_log_write_start(handle,&log,loglevel)>0)
1849 if (dlt_user_log_write_string(&log,text)==-1)
1853 if (dlt_user_log_write_uint(&log,data)==-1)
1857 if (dlt_user_log_write_finish(&log)==-1)
1866 int dlt_log_int(DltContext *handle,DltLogLevelType loglevel, int data)
1870 if (dlt_user.verbose_mode==0)
1880 if (dlt_user_log_write_start(handle,&log,loglevel)>0)
1882 if (dlt_user_log_write_int(&log,data)==-1)
1886 if (dlt_user_log_write_finish(&log)==-1)
1895 int dlt_log_uint(DltContext *handle,DltLogLevelType loglevel, unsigned int data)
1899 if (dlt_user.verbose_mode==0)
1909 if (dlt_user_log_write_start(handle,&log,loglevel)>0)
1911 if (dlt_user_log_write_uint(&log,data)==-1)
1915 if (dlt_user_log_write_finish(&log)==-1)
1924 int dlt_log_raw(DltContext *handle,DltLogLevelType loglevel, void *data,uint16_t length)
1928 if (dlt_user.verbose_mode==0)
1938 if (dlt_user_log_write_start(handle,&log,loglevel)>0)
1940 if (dlt_user_log_write_raw(&log,data,length)==-1)
1944 if (dlt_user_log_write_finish(&log)==-1)
1953 int dlt_verbose_mode(void)
1955 if (dlt_user_initialised==0)
1963 /* Switch to verbose mode */
1964 dlt_user.verbose_mode = 1;
1969 int dlt_nonverbose_mode(void)
1971 if (dlt_user_initialised==0)
1979 /* Switch to non-verbose mode */
1980 dlt_user.verbose_mode = 0;
1985 int dlt_enable_local_print(void)
1987 if (dlt_user_initialised==0)
1995 dlt_user.enable_local_print = 1;
2000 int dlt_disable_local_print(void)
2002 if (dlt_user_initialised==0)
2010 dlt_user.enable_local_print = 0;
2015 void dlt_user_receiverthread_function(void *ptr)
2019 /* Check for new messages from DLT daemon */
2020 if (dlt_user_log_check_user_message()==-1)
2022 /* Critical error */
2023 dlt_log(LOG_CRIT,"Receiver thread encountered error condition\n");
2026 usleep(DLT_USER_RECEIVE_DELAY); /* delay */
2030 /* Private functions of user library */
2032 int dlt_user_log_init(DltContext *handle, DltContextData *log)
2034 if (dlt_user_initialised==0)
2042 log->handle = handle;
2047 int dlt_user_log_send_log(DltContextData *log, int mtype)
2050 DltUserHeader userheader;
2053 DltReturnValue ret = 0;
2065 if (dlt_user.appID[0]=='\0')
2070 if (log->handle->contextID[0]=='\0')
2075 if ((mtype<DLT_TYPE_LOG) || (mtype>DLT_TYPE_CONTROL))
2080 /* also for Trace messages */
2081 #ifdef DLT_SHM_ENABLE
2082 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_LOG_SHM)==-1)
2084 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_LOG)==-1)
2090 if (dlt_message_init(&msg,0)==-1)
2095 msg.storageheader = (DltStorageHeader*)msg.headerbuffer;
2097 if (dlt_set_storageheader(msg.storageheader,dlt_user.ecuID)==-1)
2102 msg.standardheader = (DltStandardHeader*)(msg.headerbuffer + sizeof(DltStorageHeader));
2103 msg.standardheader->htyp = DLT_HTYP_WEID | DLT_HTYP_WTMS | DLT_HTYP_PROTOCOL_VERSION1 ;
2105 if (dlt_user.verbose_mode)
2107 /* In verbose mode, send extended header */
2108 msg.standardheader->htyp = (msg.standardheader->htyp | DLT_HTYP_UEH );
2112 /* In non-verbose, send extended header if desired */
2113 #if (DLT_USER_USE_EXTENDED_HEADER_FOR_NONVERBOSE==1)
2114 msg.standardheader->htyp = (msg.standardheader->htyp | DLT_HTYP_UEH );
2118 #if (BYTE_ORDER==BIG_ENDIAN)
2119 msg.standardheader->htyp = (msg.standardheader->htyp | DLT_HTYP_MSBF);
2122 msg.standardheader->mcnt = log->handle->mcnt++;
2124 /* Set header extra parameters */
2125 dlt_set_id(msg.headerextra.ecu,dlt_user.ecuID);
2126 //msg.headerextra.seid = 0;
2127 msg.headerextra.tmsp = dlt_uptime();
2129 if (dlt_message_set_extraparameters(&msg,0)==-1)
2134 /* Fill out extended header, if extended header should be provided */
2135 if (DLT_IS_HTYP_UEH(msg.standardheader->htyp))
2137 /* with extended header */
2138 msg.extendedheader = (DltExtendedHeader*)(msg.headerbuffer + sizeof(DltStorageHeader) + sizeof(DltStandardHeader) + DLT_STANDARD_HEADER_EXTRA_SIZE(msg.standardheader->htyp) );
2144 msg.extendedheader->msin = (DLT_TYPE_LOG << DLT_MSIN_MSTP_SHIFT) | ((log->log_level << DLT_MSIN_MTIN_SHIFT) & DLT_MSIN_MTIN) ; /* messsage info */
2147 case DLT_TYPE_NW_TRACE:
2149 msg.extendedheader->msin = (DLT_TYPE_NW_TRACE << DLT_MSIN_MSTP_SHIFT) | ((log->trace_status << DLT_MSIN_MTIN_SHIFT) & DLT_MSIN_MTIN) ; /* messsage info */
2154 /* This case should not occur */
2160 /* If in verbose mode, set flag in header for verbose mode */
2161 if (dlt_user.verbose_mode)
2163 msg.extendedheader->msin |= DLT_MSIN_VERB;
2166 msg.extendedheader->noar = log->args_num; /* number of arguments */
2167 dlt_set_id(msg.extendedheader->apid,dlt_user.appID); /* application id */
2168 dlt_set_id(msg.extendedheader->ctid,log->handle->contextID); /* context id */
2170 msg.headersize = sizeof(DltStorageHeader) + sizeof(DltStandardHeader) + sizeof(DltExtendedHeader) + DLT_STANDARD_HEADER_EXTRA_SIZE(msg.standardheader->htyp);
2174 /* without extended header */
2175 msg.headersize = sizeof(DltStorageHeader) + sizeof(DltStandardHeader) + DLT_STANDARD_HEADER_EXTRA_SIZE(msg.standardheader->htyp);
2178 len=msg.headersize - sizeof(DltStorageHeader) +log->size;
2181 dlt_log(LOG_CRIT,"Huge message discarded!\n");
2185 msg.standardheader->len = DLT_HTOBE_16(len);
2187 /* print to std out, if enabled */
2188 if ((dlt_user.local_print_mode != DLT_PM_FORCE_OFF) &&
2189 (dlt_user.local_print_mode != DLT_PM_AUTOMATIC))
2191 if ((dlt_user.enable_local_print) || (dlt_user.local_print_mode == DLT_PM_FORCE_ON))
2193 if (dlt_user_print_msg(&msg, log)==-1)
2200 if (dlt_user.dlt_is_file)
2203 ret=dlt_user_log_out2(dlt_user.dlt_log_handle, msg.headerbuffer, msg.headersize, log->buffer, log->size);
2204 return ((ret==DLT_RETURN_OK)?0:-1);
2208 /* Reattach to daemon if neccesary */
2209 dlt_user_log_reattach_to_daemon();
2211 if (dlt_user.overflow)
2213 if (dlt_user_log_send_overflow()==0)
2215 dlt_user.overflow=0;
2219 /* try to resent old data first */
2221 if(dlt_user.dlt_log_handle!=-1)
2222 ret = dlt_user_log_resend_buffer();
2225 /* resend ok or nothing to resent */
2226 #ifdef DLT_SHM_ENABLE
2227 if(dlt_user.dlt_log_handle!=-1)
2228 dlt_shm_push(&dlt_user.dlt_shm,msg.headerbuffer+sizeof(DltStorageHeader), msg.headersize-sizeof(DltStorageHeader),
2229 log->buffer, log->size,0,0);
2232 ret = dlt_user_log_out3(dlt_user.dlt_log_handle,
2233 &(userheader), sizeof(DltUserHeader),
2238 #ifdef DLT_TEST_ENABLE
2239 if(dlt_user.corrupt_user_header) {
2240 userheader.pattern[0]=0xff;
2241 userheader.pattern[1]=0xff;
2242 userheader.pattern[2]=0xff;
2243 userheader.pattern[3]=0xff;
2245 if(dlt_user.corrupt_message_size) {
2246 msg.standardheader->len = DLT_HTOBE_16(dlt_user.corrupt_message_size_size);
2249 ret = dlt_user_log_out3(dlt_user.dlt_log_handle,
2250 &(userheader), sizeof(DltUserHeader),
2251 msg.headerbuffer+sizeof(DltStorageHeader), msg.headersize-sizeof(DltStorageHeader),
2252 log->buffer, log->size);
2256 /* store message in ringbuffer, if an error has occured */
2257 if (ret!=DLT_RETURN_OK)
2261 if (dlt_buffer_push3(&(dlt_user.startup_buffer),
2262 (unsigned char *)&(userheader), sizeof(DltUserHeader),
2263 msg.headerbuffer+sizeof(DltStorageHeader), msg.headersize-sizeof(DltStorageHeader),
2264 log->buffer, log->size)==-1)
2266 dlt_log(LOG_ERR,"Storing message to history buffer failed! Message discarded.\n");
2274 case DLT_RETURN_PIPE_FULL:
2276 /* data could not be written */
2277 dlt_user.overflow = 1;
2280 case DLT_RETURN_PIPE_ERROR:
2282 /* handle not open or pipe error */
2283 close(dlt_user.dlt_log_handle);
2284 dlt_user.dlt_log_handle = -1;
2286 #ifdef DLT_SHM_ENABLE
2287 /* free shared memory */
2288 dlt_shm_free_client(&dlt_user.dlt_shm);
2291 if (dlt_user.local_print_mode == DLT_PM_AUTOMATIC)
2293 dlt_user_print_msg(&msg, log);
2298 case DLT_RETURN_ERROR:
2300 /* other error condition */
2309 /* This case should never occur. */
2318 int dlt_user_log_send_register_application(void)
2320 DltUserHeader userheader;
2321 DltUserControlMsgRegisterApplication usercontext;
2325 if (dlt_user.appID[0]=='\0')
2330 /* set userheader */
2331 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_REGISTER_APPLICATION)==-1)
2336 /* set usercontext */
2337 dlt_set_id(usercontext.apid,dlt_user.appID); /* application id */
2338 usercontext.pid = getpid();
2340 if (dlt_user.application_description!=0)
2342 usercontext.description_length = strlen(dlt_user.application_description);
2346 usercontext.description_length = 0;
2349 if (dlt_user.dlt_is_file)
2355 ret=dlt_user_log_out3(dlt_user.dlt_log_handle, &(userheader), sizeof(DltUserHeader), &(usercontext), sizeof(DltUserControlMsgRegisterApplication),dlt_user.application_description,usercontext.description_length);
2356 return ((ret==DLT_RETURN_OK)?0:-1);
2359 int dlt_user_log_send_unregister_application(void)
2361 DltUserHeader userheader;
2362 DltUserControlMsgUnregisterApplication usercontext;
2366 if (dlt_user.appID[0]=='\0')
2371 /* set userheader */
2372 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_UNREGISTER_APPLICATION)==-1)
2377 /* set usercontext */
2378 dlt_set_id(usercontext.apid,dlt_user.appID); /* application id */
2379 usercontext.pid = getpid();
2381 if (dlt_user.dlt_is_file)
2387 ret=dlt_user_log_out2(dlt_user.dlt_log_handle, &(userheader), sizeof(DltUserHeader), &(usercontext), sizeof(DltUserControlMsgUnregisterApplication));
2388 return ((ret==DLT_RETURN_OK)?0:-1);
2391 int dlt_user_log_send_register_context(DltContextData *log)
2393 DltUserHeader userheader;
2394 DltUserControlMsgRegisterContext usercontext;
2407 if ((dlt_user.appID[0]=='\0') || (log->handle->contextID=='\0'))
2412 /* set userheader */
2413 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_REGISTER_CONTEXT)==-1)
2418 /* set usercontext */
2419 dlt_set_id(usercontext.apid,dlt_user.appID); /* application id */
2420 dlt_set_id(usercontext.ctid,log->handle->contextID); /* context id */
2421 usercontext.log_level_pos = log->handle->log_level_pos;
2422 usercontext.pid = getpid();
2424 usercontext.log_level = (int8_t)log->log_level;
2425 usercontext.trace_status = (int8_t)log->trace_status;
2427 if (log->context_description!=0)
2429 usercontext.description_length = strlen(log->context_description);
2433 usercontext.description_length = 0;
2436 if (dlt_user.dlt_is_file)
2442 ret=dlt_user_log_out3(dlt_user.dlt_log_handle, &(userheader), sizeof(DltUserHeader), &(usercontext), sizeof(DltUserControlMsgRegisterContext),log->context_description,usercontext.description_length);
2443 return ((ret==DLT_RETURN_OK)?0:-1);
2446 int dlt_user_log_send_unregister_context(DltContextData *log)
2448 DltUserHeader userheader;
2449 DltUserControlMsgUnregisterContext usercontext;
2462 if ((dlt_user.appID[0]=='\0') || (log->handle->contextID=='\0'))
2467 /* set userheader */
2468 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_UNREGISTER_CONTEXT)==-1)
2473 /* set usercontext */
2474 dlt_set_id(usercontext.apid,dlt_user.appID); /* application id */
2475 dlt_set_id(usercontext.ctid,log->handle->contextID); /* context id */
2476 usercontext.pid = getpid();
2478 if (dlt_user.dlt_is_file)
2484 ret=dlt_user_log_out2(dlt_user.dlt_log_handle, &(userheader), sizeof(DltUserHeader), &(usercontext), sizeof(DltUserControlMsgUnregisterContext));
2485 return ((ret==DLT_RETURN_OK)?0:-1);
2488 int dlt_send_app_ll_ts_limit(const char *appid, DltLogLevelType loglevel, DltTraceStatusType tracestatus)
2490 DltUserHeader userheader;
2491 DltUserControlMsgAppLogLevelTraceStatus usercontext;
2494 if ((appid==0) || (appid[0]=='\0'))
2499 /* Removed because of DltLogLevelType and DltTraceStatusType
2501 if ((loglevel<DLT_LOG_DEFAULT) || (loglevel>DLT_LOG_VERBOSE))
2506 if ((tracestatus<DLT_TRACE_STATUS_DEFAULT) || (tracestatus>DLT_TRACE_STATUS_ON))
2513 /* set userheader */
2514 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_APP_LL_TS)==-1)
2519 /* set usercontext */
2520 dlt_set_id(usercontext.apid,appid); /* application id */
2521 usercontext.log_level = loglevel;
2522 usercontext.trace_status = tracestatus;
2524 if (dlt_user.dlt_is_file)
2530 ret=dlt_user_log_out2(dlt_user.dlt_log_handle, &(userheader), sizeof(DltUserHeader), &(usercontext), sizeof(DltUserControlMsgAppLogLevelTraceStatus));
2531 return ((ret==DLT_RETURN_OK)?0:-1);
2534 int dlt_user_log_send_log_mode(DltUserLogMode mode)
2536 DltUserHeader userheader;
2537 DltUserControlMsgLogMode logmode;
2541 /* set userheader */
2542 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_LOG_MODE)==-1)
2548 logmode.log_mode = (unsigned char) mode;
2550 if (dlt_user.dlt_is_file)
2556 ret=dlt_user_log_out2(dlt_user.dlt_log_handle, &(userheader), sizeof(DltUserHeader), &(logmode), sizeof(DltUserControlMsgLogMode));
2557 return ((ret==DLT_RETURN_OK)?0:-1);
2560 int dlt_user_print_msg(DltMessage *msg, DltContextData *log)
2562 uint8_t *databuffer_tmp;
2563 int32_t datasize_tmp;
2564 int32_t databuffersize_tmp;
2565 static char text[DLT_USER_TEXT_LENGTH];
2567 if ((msg==0) || (log==0))
2572 /* Save variables before print */
2573 databuffer_tmp = msg->databuffer;
2574 datasize_tmp = msg->datasize;
2575 databuffersize_tmp = msg->databuffersize;
2577 /* Act like a receiver, convert header back to host format */
2578 msg->standardheader->len = DLT_BETOH_16(msg->standardheader->len);
2579 dlt_message_get_extraparameters(msg,0);
2581 msg->databuffer = log->buffer;
2582 msg->datasize = log->size;
2583 msg->databuffersize = log->size;
2585 /* Print message as ASCII */
2586 if (dlt_message_print_ascii(msg,text,DLT_USER_TEXT_LENGTH,0)==-1)
2591 /* Restore variables and set len to BE*/
2592 msg->databuffer = databuffer_tmp;
2593 msg->databuffersize = databuffersize_tmp;
2594 msg->datasize = datasize_tmp;
2596 msg->standardheader->len = DLT_HTOBE_16(msg->standardheader->len);
2601 int dlt_user_log_check_user_message(void)
2608 DltUserHeader *userheader;
2609 DltReceiver *receiver = &(dlt_user.receiver);
2611 DltUserControlMsgLogLevel *usercontextll;
2612 DltUserControlMsgInjection *usercontextinj;
2613 DltUserControlMsgLogState *userlogstate;
2614 unsigned char *userbuffer;
2615 unsigned char *inject_buffer;
2617 if (dlt_user.dlt_user_handle!=-1)
2621 if (dlt_receiver_receive_fd(receiver)<=0)
2623 /* No new message available */
2627 /* look through buffer as long as data is in there */
2630 if (receiver->bytesRcvd < (int32_t)sizeof(DltUserHeader))
2635 /* resync if necessary */
2639 userheader = (DltUserHeader*) (receiver->buf+offset);
2641 /* Check for user header pattern */
2642 if (dlt_user_check_userheader(userheader))
2649 while ((int32_t)(sizeof(DltUserHeader)+offset)<=receiver->bytesRcvd);
2651 /* Check for user header pattern */
2652 if (dlt_user_check_userheader(userheader)==0)
2657 /* Set new start offset */
2660 receiver->buf+=offset;
2661 receiver->bytesRcvd-=offset;
2664 switch (userheader->message)
2666 case DLT_USER_MESSAGE_LOG_LEVEL:
2668 if (receiver->bytesRcvd < (int32_t)(sizeof(DltUserHeader)+sizeof(DltUserControlMsgLogLevel)))
2674 usercontextll = (DltUserControlMsgLogLevel*) (receiver->buf+sizeof(DltUserHeader));
2676 /* Update log level and trace status */
2677 if (usercontextll!=0)
2681 if ((usercontextll->log_level_pos >= 0) && (usercontextll->log_level_pos < (int32_t)dlt_user.dlt_ll_ts_num_entries))
2683 // printf("Store ll, ts\n");
2684 if (dlt_user.dlt_ll_ts)
2686 dlt_user.dlt_ll_ts[usercontextll->log_level_pos].log_level = usercontextll->log_level;
2687 dlt_user.dlt_ll_ts[usercontextll->log_level_pos].trace_status = usercontextll->trace_status;
2694 /* keep not read data in buffer */
2695 if (dlt_receiver_remove(receiver,sizeof(DltUserHeader)+sizeof(DltUserControlMsgLogLevel))==-1)
2701 case DLT_USER_MESSAGE_INJECTION:
2703 /* At least, user header, user context, and service id and data_length of injected message is available */
2704 if (receiver->bytesRcvd < (int32_t)(sizeof(DltUserHeader)+sizeof(DltUserControlMsgInjection)))
2710 usercontextinj = (DltUserControlMsgInjection*) (receiver->buf+sizeof(DltUserHeader));
2711 userbuffer = (unsigned char*) (receiver->buf+sizeof(DltUserHeader)+sizeof(DltUserControlMsgInjection));
2717 if (receiver->bytesRcvd < (int32_t)(sizeof(DltUserHeader)+sizeof(DltUserControlMsgInjection)+usercontextinj->data_length_inject))
2725 if ((usercontextinj->data_length_inject>0) && (dlt_user.dlt_ll_ts))
2727 /* Check if injection callback is registered for this context */
2728 for (i=0; i<dlt_user.dlt_ll_ts[usercontextinj->log_level_pos].nrcallbacks;i++)
2730 if ((dlt_user.dlt_ll_ts[usercontextinj->log_level_pos].injection_table) &&
2731 (dlt_user.dlt_ll_ts[usercontextinj->log_level_pos].injection_table[i].service_id == usercontextinj->service_id))
2733 /* callback available, so prepare data, then call it */
2734 inject_buffer = malloc(usercontextinj->data_length_inject);
2735 if (inject_buffer!=0)
2737 /* copy from receiver to inject_buffer */
2738 memcpy(inject_buffer, userbuffer, usercontextinj->data_length_inject);
2741 if (dlt_user.dlt_ll_ts[usercontextinj->log_level_pos].injection_table[i].injection_callback!=0)
2743 // printf("Got injection(%d), length=%d, '%s' \n", usercontext->service_id, usercontext->data_length_inject, inject_buffer);
2744 dlt_user.dlt_ll_ts[usercontextinj->log_level_pos].injection_table[i].injection_callback(
2745 usercontextinj->service_id, inject_buffer, usercontextinj->data_length_inject);
2748 if (inject_buffer!=0)
2750 free(inject_buffer);
2762 /* keep not read data in buffer */
2763 if (dlt_receiver_remove(receiver,(sizeof(DltUserHeader)+sizeof(DltUserControlMsgInjection)+usercontextinj->data_length_inject))==-1)
2770 case DLT_USER_MESSAGE_LOG_STATE:
2772 /* At least, user header, user context, and service id and data_length of injected message is available */
2773 if (receiver->bytesRcvd < (int32_t)(sizeof(DltUserHeader)+sizeof(DltUserControlMsgLogState)))
2779 userlogstate = (DltUserControlMsgLogState*) (receiver->buf+sizeof(DltUserHeader));
2780 dlt_user.log_state = userlogstate->log_state;
2782 /* keep not read data in buffer */
2783 if (dlt_receiver_remove(receiver,(sizeof(DltUserHeader)+sizeof(DltUserControlMsgLogState)))==-1)
2791 dlt_log(LOG_ERR,"Invalid user message type received!\n");
2793 dlt_receiver_remove(receiver,sizeof(DltUserHeader));
2794 /* In next invocation of while loop, a resync will be triggered if additional data was received */
2807 if (dlt_receiver_move_to_begin(receiver)==-1)
2811 } /* while receive */
2814 return DLT_RETURN_OK;
2817 int dlt_user_log_resend_buffer(void)
2820 uint8_t buf[DLT_USER_RCVBUF_MAX_SIZE];
2824 /* Send content of ringbuffer */
2826 count = dlt_buffer_get_message_count(&(dlt_user.startup_buffer));
2829 for (num=0;num<count;num++)
2833 size = dlt_buffer_copy(&(dlt_user.startup_buffer),buf,sizeof(buf));
2837 #ifdef DLT_SHM_ENABLE
2838 dlt_shm_push(&dlt_user.dlt_shm,buf+sizeof(DltUserHeader),size-sizeof(DltUserHeader),0,0,0,0);
2841 ret = dlt_user_log_out3(dlt_user.dlt_log_handle, buf,sizeof(DltUserHeader),0,0,0,0);
2844 ret = dlt_user_log_out3(dlt_user.dlt_log_handle, buf,size,0,0,0,0);
2847 /* in case of error, keep message in ringbuffer */
2848 if (ret==DLT_RETURN_OK)
2850 dlt_buffer_remove(&(dlt_user.startup_buffer));
2853 if (dlt_buffer_push(&(dlt_user.startup_buffer), buf, size)==-1)
2855 dlt_log(LOG_ERR,"Error pushing back message to history buffer. Message discarded.\n");
2859 // In case of: data could not be written, set overflow flag
2860 if (ret==DLT_RETURN_PIPE_FULL)
2862 dlt_user.overflow = 1;
2868 /* keep message in ringbuffer */
2879 void dlt_user_log_reattach_to_daemon(void)
2881 uint32_t num,reregistered=0;
2884 DltContextData log_new;
2886 if (dlt_user.dlt_log_handle<0)
2888 dlt_user.dlt_log_handle=-1;
2890 /* try to open pipe to dlt daemon */
2891 dlt_user.dlt_log_handle = open(DLT_USER_FIFO, O_WRONLY | O_NONBLOCK);
2892 if (dlt_user.dlt_log_handle > 0)
2894 if (dlt_user_log_init(&handle,&log_new)==-1)
2899 #ifdef DLT_SHM_ENABLE
2900 /* init shared memory */
2901 if (dlt_shm_init_client(&dlt_user.dlt_shm,DLT_SHM_KEY) < 0)
2903 sprintf(str,"Loging disabled, Shared memory %d cannot be created!\n",DLT_SHM_KEY);
2904 dlt_log(LOG_WARNING, str);
2909 dlt_log(LOG_NOTICE, "Logging re-enabled!\n");
2911 /* Re-register application */
2912 if (dlt_user_log_send_register_application()==-1)
2919 /* Re-register all stored contexts */
2920 for (num=0; num<dlt_user.dlt_ll_ts_num_entries; num++)
2922 /* Re-register stored context */
2923 if ((dlt_user.appID[0]!='\0') && (dlt_user.dlt_ll_ts[num].contextID[0]!='\0') && (dlt_user.dlt_ll_ts))
2925 //dlt_set_id(log_new.appID, dlt_user.appID);
2926 dlt_set_id(handle.contextID, dlt_user.dlt_ll_ts[num].contextID);
2927 handle.log_level_pos = num;
2928 log_new.context_description = dlt_user.dlt_ll_ts[num].context_description;
2930 log_new.log_level = DLT_USER_LOG_LEVEL_NOT_SET;
2931 log_new.trace_status = DLT_USER_TRACE_STATUS_NOT_SET;
2933 if (dlt_user_log_send_register_context(&log_new)==-1)
2945 if (reregistered==1)
2947 dlt_user_log_resend_buffer();
2953 int dlt_user_log_send_overflow(void)
2955 DltUserHeader userheader;
2958 /* set userheader */
2959 if (dlt_user_set_userheader(&userheader, DLT_USER_MESSAGE_OVERFLOW)==-1)
2964 if (dlt_user.dlt_is_file)
2970 ret=dlt_user_log_out2(dlt_user.dlt_log_handle, &(userheader), sizeof(DltUserHeader), 0, 0);
2971 return ((ret==DLT_RETURN_OK)?0:-1);
2974 int dlt_user_check_buffer(int *total_size, int *used_size)
2976 #ifdef DLT_SHM_ENABLE
2977 *total_size = dlt_shm_get_total_size(&(dlt_user.dlt_shm));
2978 *used_size = dlt_shm_get_used_size(&(dlt_user.dlt_shm));
2980 *total_size = dlt_buffer_get_total_size(&(dlt_user.startup_buffer));
2981 *used_size = dlt_buffer_get_used_size(&(dlt_user.startup_buffer));
2987 #ifdef DLT_TEST_ENABLE
2988 void dlt_user_test_corrupt_user_header(int enable)
2990 dlt_user.corrupt_user_header = enable;
2992 void dlt_user_test_corrupt_message_size(int enable,int16_t size)
2994 dlt_user.corrupt_message_size = enable;
2995 dlt_user.corrupt_message_size_size = size;