dlt_daemon_common.h

Go to the documentation of this file.

/*
 * @licence app begin@
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2011-2015, BMW AG
 *
 * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
 *
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License (MPL), v. 2.0.
 * If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * For further information see http://www.genivi.org/.
 * @licence end@
 */

/*******************************************************************************
**                                                                            **
**  SRC-MODULE: dlt_daemon_common.h                                           **
**                                                                            **
**  TARGET    : linux                                                         **
**                                                                            **
**  PROJECT   : DLT                                                           **
**                                                                            **
**  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **
**              Markus Klein                                                  **
**                                                                            **
**  PURPOSE   :                                                               **
**                                                                            **
**  REMARKS   :                                                               **
**                                                                            **
**  PLATFORM DEPENDANT [yes/no]: yes                                          **
**                                                                            **
**  TO BE CHANGED BY USER [yes/no]: no                                        **
**                                                                            **
*******************************************************************************/

/*******************************************************************************
**                      Author Identity                                       **
********************************************************************************
**                                                                            **
** Initials     Name                       Company                            **
** --------     -------------------------  ---------------------------------- **
**  aw          Alexander Wenzel           BMW                                **
**  mk          Markus Klein               Fraunhofer ESK                     **
*******************************************************************************/

/*******************************************************************************
**                      Revision Control History                              **
*******************************************************************************/

/*
 * $LastChangedRevision: 1670 $
 * $LastChangedDate: 2011-04-08 15:12:06 +0200 (Fr, 08. Apr 2011) $
 * $LastChangedBy$
 Initials    Date         Comment
 aw          15.02.2010   initial
 */

#ifndef DLT_DAEMON_COMMON_H
#define DLT_DAEMON_COMMON_H

#include <limits.h>
#include <semaphore.h>
#include "dlt_common.h"
#include "dlt_user.h"
#include "dlt_offline_logstorage.h"

#ifdef __cplusplus
extern "C" {
#endif

#define DLT_DAEMON_RINGBUFFER_MIN_SIZE    500000 
#define DLT_DAEMON_RINGBUFFER_MAX_SIZE  10000000 
#define DLT_DAEMON_RINGBUFFER_STEP_SIZE   500000 
#define DLT_DAEMON_SEND_TO_ALL     -3   
#define DLT_DAEMON_SEND_FORCE      -4   
/* Use a semaphore or mutex from your OS to prevent concurrent access to the DLT buffer. */

#define DLT_DAEMON_SEM_LOCK() { sem_wait(&dlt_daemon_mutex); }
#define DLT_DAEMON_SEM_FREE() { sem_post(&dlt_daemon_mutex); }
extern sem_t dlt_daemon_mutex;

typedef enum
{
    DLT_DAEMON_STATE_INIT =                   0,  
    DLT_DAEMON_STATE_BUFFER =            1,  
    DLT_DAEMON_STATE_BUFFER_FULL =       2,  
    DLT_DAEMON_STATE_SEND_BUFFER =       3,  
    DLT_DAEMON_STATE_SEND_DIRECT =       4   
} DltDaemonState;

typedef struct
{
    char  apid[DLT_ID_SIZE];                  
    pid_t pid;                   
    int user_handle;    
    char *application_description; 
    int num_contexts; 
} DltDaemonApplication;

typedef struct
{
    char apid[DLT_ID_SIZE];               
    char ctid[DLT_ID_SIZE];               
    int8_t log_level;        
    int8_t trace_status;    
    int log_level_pos;  
    int user_handle;    
    char *context_description; 
    int8_t storage_log_level; 
} DltDaemonContext;

typedef struct
{
    int num_contexts;               
    DltDaemonContext *contexts;         
    int num_applications;            
    DltDaemonApplication *applications; 
    int8_t default_log_level;          
    int8_t default_trace_status;       
    int8_t force_ll_ts;                
    unsigned int overflow_counter;   
    int runtime_context_cfg_loaded;         
    char ecuid[DLT_ID_SIZE];       
    int sendserialheader;          
    int timingpackets;              
    DltBuffer client_ringbuffer; 
    char runtime_application_cfg[PATH_MAX + 1]; 
    char runtime_context_cfg[PATH_MAX + 1]; 
    char runtime_configuration[PATH_MAX + 1]; 
    DltUserLogMode mode;    
    char connectionState;                
    char *ECUVersionString; 
    DltDaemonState state;   
    DltLogStorage *storage_handle;
} DltDaemon;

int dlt_daemon_init(DltDaemon *daemon,unsigned long RingbufferMinSize,unsigned long RingbufferMaxSize,unsigned long RingbufferStepSize,const char *runtime_directory,int InitialContextLogLevel, int InitialContextTraceStatus, int ForceLLTS, int verbose);
int dlt_daemon_free(DltDaemon *daemon,int verbose);

DltDaemonApplication* dlt_daemon_application_add(DltDaemon *daemon,char *apid,pid_t pid,char *description, int verbose);
int dlt_daemon_application_del(DltDaemon *daemon, DltDaemonApplication *application, int verbose);
DltDaemonApplication* dlt_daemon_application_find(DltDaemon *daemon,char *apid,int verbose);
int dlt_daemon_applications_load(DltDaemon *daemon,const char *filename, int verbose);
int dlt_daemon_applications_save(DltDaemon *daemon,const char *filename, int verbose);
int dlt_daemon_applications_invalidate_fd(DltDaemon *daemon,int fd,int verbose);
int dlt_daemon_applications_clear(DltDaemon *daemon,int verbose);

DltDaemonContext* dlt_daemon_context_add(DltDaemon *daemon,char *apid,char *ctid,int8_t log_level,int8_t trace_status,int log_level_pos, int user_handle,char *description,int verbose);
int dlt_daemon_context_del(DltDaemon *daemon, DltDaemonContext* context, int verbose);
DltDaemonContext* dlt_daemon_context_find(DltDaemon *daemon,char *apid,char *ctid,int verbose);
int dlt_daemon_contexts_invalidate_fd(DltDaemon *daemon,int fd,int verbose);
int dlt_daemon_contexts_clear(DltDaemon *daemon,int verbose);
int dlt_daemon_contexts_load(DltDaemon *daemon,const char *filename, int verbose);
int dlt_daemon_contexts_save(DltDaemon *daemon,const char *filename, int verbose);
int dlt_daemon_configuration_load(DltDaemon *daemon,const char *filename, int verbose);
int dlt_daemon_configuration_save(DltDaemon *daemon,const char *filename, int verbose);


int dlt_daemon_user_send_log_level(DltDaemon *daemon,DltDaemonContext *context, int verbose);

int dlt_daemon_user_send_log_state(DltDaemon *daemon,DltDaemonApplication *app,int verbose);

void dlt_daemon_user_send_default_update(DltDaemon *daemon, int verbose);

void dlt_daemon_user_send_all_update(DltDaemon *daemon, int8_t log_level, int verbose);

void dlt_daemon_user_send_all_log_state(DltDaemon *daemon, int verbose);

void dlt_daemon_control_reset_to_factory_default(DltDaemon *daemon,const char *filename, const char *filename1, int InitialContextLogLevel, int InitialContextTraceStatus, int InitialEnforceLlTsStatus, int verbose);

void dlt_daemon_change_state(DltDaemon *daemon, DltDaemonState newState);

#ifdef __cplusplus
}
#endif

#endif /* DLT_DAEMON_COMMON_H */