Init of dlt daemon

1 files changed, 420 insertions, 0 deletions

diff --git a/src/daemon/dlt_daemon_common.h b/src/daemon/dlt_daemon_common.h
new file mode 100755
index 0000000..fa0fe53
--- /dev/null
+++ b/src/daemon/dlt_daemon_common.h
@@ -0,0 +1,420 @@
+/*

+ * Dlt- Diagnostic Log and Trace daemon

+ * @licence app begin@
+ *
+ * Copyright (C) 2011, BMW AG - Alexander Wenzel <alexander.wenzel@bmw.de>
+ * 
+ * This program is free software; you can redistribute it and/or modify it under the terms of the 
+ * GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even 
+ * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General 
+ * Public License, version 2.1, for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License, version 2.1, along 
+ * with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ * 
+ * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may 
+ * also be applicable to programs even in cases in which the program is not a library in the technical sense.
+ * 
+ * Linking DLT statically or dynamically with other modules is making a combined work based on DLT. You may 
+ * license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to 
+ * license your linked modules under the GNU Lesser General Public License, version 2.1, you 
+ * may use the program under the following exception.
+ * 
+ * As a special exception, the copyright holders of DLT give you permission to combine DLT 
+ * with software programs or libraries that are released under any license unless such a combination is not
+ * permitted by the license of such a software program or library. You may copy and distribute such a 
+ * system following the terms of the GNU Lesser General Public License, version 2.1, including this
+ * special exception, for DLT and the licenses of the other code concerned.
+ * 
+ * Note that people who make modified versions of DLT are not obligated to grant this special exception 
+ * for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, 
+ * version 2.1, gives permission to release a modified version without this exception; this exception 
+ * also makes it possible to release a modified version which carries forward this exception.
+ *
+ * @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

+

+/**

+  \defgroup daemonapi DLT Daemon API

+  \addtogroup daemonapi

+  \{

+*/

+

+#include <semaphore.h>

+#include "dlt_common.h"

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+

+#define DLT_DAEMON_RINGBUFFER_SIZE 100000 /**< Ring buffer size for storing log messages while no client is connected */

+

+#define DLT_DAEMON_STORE_TO_BUFFER -2   /**< Constant value to identify the command "store to buffer" */

+

+/* 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;

+

+

+/**

+ * The parameters of a daemon application.

+ */

+typedef struct

+{

+	char  apid[DLT_ID_SIZE];                  /**< application id */

+	pid_t pid;                   /**< process id of user application */

+	int user_handle;    /**< connection handle for connection to user application */

+	char *application_description; /**< context description */

+	int num_contexts; /**< number of contexts for this application */

+} DltDaemonApplication;

+

+/**

+ * The parameters of a daemon context.

+ */

+typedef struct

+{

+	char apid[DLT_ID_SIZE];               /**< application id */

+	char ctid[DLT_ID_SIZE];   	        /**< context id */

+	int8_t log_level;		/**< the current log level of the context */

+	int8_t trace_status;	/**< the current trace status of the context */

+	int log_level_pos;  /**< offset of context in context field on user application */

+	int user_handle;    /**< connection handle for connection to user application */

+	char *context_description; /**< context description */

+} DltDaemonContext;

+

+/**

+ * The parameters of a daemon.

+ */

+typedef struct

+{

+	int num_contexts;               /**< Total number of all contexts in all applications */

+	DltDaemonContext *contexts;         /**< Pointer to contexts */

+	int num_applications;			/**< Number of available application */

+	DltDaemonApplication *applications; /**< Pointer to applications */

+	int8_t default_log_level;          /**< Default log level (of daemon) */

+	int8_t default_trace_status;       /**< Default trace status (of daemon) */

+	int message_buffer_overflow;   /**< Set to one, if buffer overflow has occured, zero otherwise */

+	int runtime_context_cfg_loaded;         /**< Set to one, if runtime context configuration has been loaded, zero otherwise */

+	char ecuid[DLT_ID_SIZE];       /**< ECU ID of daemon */

+	int sendserialheader;          /**< 1: send serial header; 0 don't send serial header */

+	int timingpackets;              /**< 1: send continous timing packets; 0 don't send continous timing packets */

+	DltRingBuffer client_ringbuffer; /**< Ring-buffer for storing received logs while no client connection is available */

+} DltDaemon;

+

+/**

+ * Initialise the dlt daemon structure

+ * This function must be called before using further dlt daemon structure

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_init(DltDaemon *daemon,int verbose);

+/**

+ * De-Initialise the dlt daemon structure

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_free(DltDaemon *daemon,int verbose);

+

+/**

+ * Add (new) application to internal application management

+ * @param daemon pointer to dlt daemon structure

+ * @param apid pointer to application id

+ * @param pid process id of user application

+ * @param description description of application

+ * @param verbose if set to true verbose information is printed out.

+ * @return Pointer to added context, null pointer on error

+ */

+DltDaemonApplication* dlt_daemon_application_add(DltDaemon *daemon,char *apid,pid_t pid,char *description, int verbose);

+/**

+ * Delete application from internal application management

+ * @param daemon pointer to dlt daemon structure

+ * @param application pointer to application to be deleted

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_application_del(DltDaemon *daemon, DltDaemonApplication *application, int verbose);

+/**

+ * Find application with specific application id

+ * @param daemon pointer to dlt daemon structure

+ * @param apid pointer to application id

+ * @param verbose if set to true verbose information is printed out.

+ * @return Pointer to application, null pointer on error or not found

+ */

+DltDaemonApplication* dlt_daemon_application_find(DltDaemon *daemon,char *apid,int verbose);

+/**

+ * Load applications from file to internal context management

+ * @param daemon pointer to dlt daemon structure

+ * @param filename name of file to be used for loading

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_applications_load(DltDaemon *daemon,const char *filename, int verbose);

+/**

+ * Save applications from internal context management to file

+ * @param daemon pointer to dlt daemon structure

+ * @param filename name of file to be used for saving

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_applications_save(DltDaemon *daemon,const char *filename, int verbose);

+/**

+ * Clear all applications in internal application management

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_applications_clear(DltDaemon *daemon,int verbose);

+

+/**

+ * Add (new) context to internal context management

+ * @param daemon pointer to dlt daemon structure

+ * @param apid pointer to application id

+ * @param ctid pointer to context id

+ * @param log_level log level of context

+ * @param trace_status trace status of context

+ * @param log_level_pos offset of context in context field on user application

+ * @param user_handle connection handle for connection to user application

+ * @param description description of context

+ * @param verbose if set to true verbose information is printed out.

+ * @return Pointer to added context, null pointer on error

+ */

+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);

+/**

+ * Delete context from internal context management

+ * @param daemon pointer to dlt daemon structure

+ * @param context pointer to context to be deleted

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_context_del(DltDaemon *daemon, DltDaemonContext* context, int verbose);

+/**

+ * Find context with specific application id and context id

+ * @param daemon pointer to dlt daemon structure

+ * @param apid pointer to application id

+ * @param ctid pointer to context id

+ * @param verbose if set to true verbose information is printed out.

+ * @return Pointer to context, null pointer on error or not found

+ */

+DltDaemonContext* dlt_daemon_context_find(DltDaemon *daemon,char *apid,char *ctid,int verbose);

+/**

+ * Clear all contexts in internal context management

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_contexts_clear(DltDaemon *daemon,int verbose);

+/**

+ * Load contexts from file to internal context management

+ * @param daemon pointer to dlt daemon structure

+ * @param filename name of file to be used for loading

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_contexts_load(DltDaemon *daemon,const char *filename, int verbose);

+/**

+ * Save contexts from internal context management to file

+ * @param daemon pointer to dlt daemon structure

+ * @param filename name of file to be used for saving

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

+int dlt_daemon_contexts_save(DltDaemon *daemon,const char *filename, int verbose);

+

+/**

+ * Send user message DLT_USER_MESSAGE_LOG_LEVEL to user application

+ * @param daemon pointer to dlt daemon structure

+ * @param context pointer to context for response

+ * @param verbose if set to true verbose information is printed out.

+ * @return negative value if there was an error

+ */

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

+/**

+ * Send user messages to all user applications using default context, or trace status

+ * to update those values

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_user_send_default_update(DltDaemon *daemon, int verbose);

+

+/**

+ * Process received control message from dlt client

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+int dlt_daemon_control_process_control(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Generate response to control message from dlt client

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param service_id service id of control message

+ * @param status status of response (e.g. ok, not supported, error)

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_service_response(int sock, DltDaemon *daemon, uint32_t service_id, int8_t status, int verbose);

+/**

+ * Send out response message to dlt client

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to response message

+ * @param appid pointer to application id to be used in response message

+ * @param contid pointer to context id to be used in response message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_send_control_message(int sock, DltDaemon *daemon, DltMessage *msg, char* appid, char* contid, int verbose);

+

+/**

+ * Process and generate response to received sw injection control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received sw injection control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_callsw_cinjection(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Process and generate response to received set log level control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_set_log_level(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Process and generate response to received set trace status control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_set_trace_status(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Process and generate response to received set default log level control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_set_default_log_level(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Process and generate response to received set default trace status control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_set_default_trace_status(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Process and generate response to set timing packets control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_set_timing_packets(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Process and generate response to received get software version control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_get_software_version(int sock, DltDaemon *daemon, int verbose);

+/**

+ * Process and generate response to received get default log level control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_get_default_log_level(int sock, DltDaemon *daemon, int verbose);

+/**

+ * Process and generate response to received get log info control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param msg pointer to received control message

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_get_log_info(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);

+/**

+ * Process and generate response to message buffer overflow control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_message_buffer_overflow(int sock, DltDaemon *daemon, int verbose);

+/**

+ * Process reset to factory default control message

+ * @param daemon pointer to dlt daemon structure

+ * @param filename name of file containing the runtime defaults for applications

+ * @param filename1 name of file containing the runtime defaults for contexts

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_reset_to_factory_default(DltDaemon *daemon,const char *filename, const char *filename1, int verbose);

+/**

+ * Send time control message

+ * @param sock connection handle used for sending response

+ * @param daemon pointer to dlt daemon structure

+ * @param verbose if set to true verbose information is printed out.

+ */

+void dlt_daemon_control_message_time(int sock, DltDaemon *daemon, int verbose);

+

+#ifdef __cplusplus

+}

+#endif

+

+/**

+  \}

+*/

+

+#endif /* DLT_DAEMON_COMMON_H */