src/daemon/dlt_daemon_common.h

   1 /*\r
   2  * Dlt- Diagnostic Log and Trace daemon\r
   3  * @licence app begin@
   4  *
   5  * Copyright (C) 2011, BMW AG - Alexander Wenzel <alexander.wenzel@bmw.de>
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under the terms of the
   8  * GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  10  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  11  * Public License, version 2.1, for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License, version 2.1, along
  14  * with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
  15  *
  16  * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may
  17  * also be applicable to programs even in cases in which the program is not a library in the technical sense.
  18  *
  19  * Linking DLT statically or dynamically with other modules is making a combined work based on DLT. You may
  20  * license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to
  21  * license your linked modules under the GNU Lesser General Public License, version 2.1, you
  22  * may use the program under the following exception.
  23  *
  24  * As a special exception, the copyright holders of DLT give you permission to combine DLT
  25  * with software programs or libraries that are released under any license unless such a combination is not
  26  * permitted by the license of such a software program or library. You may copy and distribute such a
  27  * system following the terms of the GNU Lesser General Public License, version 2.1, including this
  28  * special exception, for DLT and the licenses of the other code concerned.
  29  *
  30  * Note that people who make modified versions of DLT are not obligated to grant this special exception
  31  * for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License,
  32  * version 2.1, gives permission to release a modified version without this exception; this exception
  33  * also makes it possible to release a modified version which carries forward this exception.
  34  *
  35  * @licence end@\r
  36  */\r
  37 \r
  38 \r
  39 /*******************************************************************************\r
  40 **                                                                            **\r
  41 **  SRC-MODULE: dlt_daemon_common.h                                           **\r
  42 **                                                                            **\r
  43 **  TARGET    : linux                                                         **\r
  44 **                                                                            **\r
  45 **  PROJECT   : DLT                                                           **\r
  46 **                                                                            **\r
  47 **  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **\r
  48 **              Markus Klein                                                  **\r
  49 **                                                                            **\r
  50 **  PURPOSE   :                                                               **\r
  51 **                                                                            **\r
  52 **  REMARKS   :                                                               **\r
  53 **                                                                            **\r
  54 **  PLATFORM DEPENDANT [yes/no]: yes                                          **\r
  55 **                                                                            **\r
  56 **  TO BE CHANGED BY USER [yes/no]: no                                        **\r
  57 **                                                                            **\r
  58 *******************************************************************************/\r
  59 \r
  60 /*******************************************************************************\r
  61 **                      Author Identity                                       **\r
  62 ********************************************************************************\r
  63 **                                                                            **\r
  64 ** Initials     Name                       Company                            **\r
  65 ** --------     -------------------------  ---------------------------------- **\r
  66 **  aw          Alexander Wenzel           BMW                                **\r
  67 **  mk          Markus Klein               Fraunhofer ESK                     **\r
  68 *******************************************************************************/\r
  69 \r
  70 /*******************************************************************************\r
  71 **                      Revision Control History                              **\r
  72 *******************************************************************************/\r
  73 \r
  74 /*\r
  75  * $LastChangedRevision: 1670 $\r
  76  * $LastChangedDate: 2011-04-08 15:12:06 +0200 (Fr, 08. Apr 2011) $\r
  77  * $LastChangedBy$\r
  78  Initials    Date         Comment\r
  79  aw          15.02.2010   initial\r
  80  */\r
  81 \r
  82 #ifndef DLT_DAEMON_COMMON_H\r
  83 #define DLT_DAEMON_COMMON_H\r
  84 \r
  85 /**\r
  86   \defgroup daemonapi DLT Daemon API\r
  87   \addtogroup daemonapi\r
  88   \{\r
  89 */\r
  90 \r
  91 #include <semaphore.h>\r
  92 #include "dlt_common.h"\r
  93 \r
  94 #ifdef __cplusplus\r
  95 extern "C" {\r
  96 #endif\r
  97 \r
  98 #define DLT_DAEMON_RINGBUFFER_SIZE 100000 /**< Ring buffer size for storing log messages while no client is connected */\r
  99 \r
 100 #define DLT_DAEMON_RINGBUFFER_INCREASE_SIZE  DLT_DAEMON_RINGBUFFER_SIZE\r
 101 \r
 102 #define DLT_DAEMON_RINGBUFFER_MAXIMUM_SIZE 100*DLT_DAEMON_RINGBUFFER_INCREASE_SIZE    \r
 103 \r
 104 #define DLT_DAEMON_STORE_TO_BUFFER -2   /**< Constant value to identify the command "store to buffer" */\r
 105 \r
 106 /* Use a semaphore or mutex from your OS to prevent concurrent access to the DLT buffer. */\r
 107 \r
 108 #define DLT_DAEMON_SEM_LOCK() { sem_wait(&dlt_daemon_mutex); }\r
 109 #define DLT_DAEMON_SEM_FREE() { sem_post(&dlt_daemon_mutex); }\r
 110 extern sem_t dlt_daemon_mutex;\r
 111 \r
 112 \r
 113 /**\r
 114  * The parameters of a daemon application.\r
 115  */\r
 116 typedef struct\r
 117 {\r
 118         char  apid[DLT_ID_SIZE];                  /**< application id */\r
 119         pid_t pid;                   /**< process id of user application */\r
 120         int user_handle;    /**< connection handle for connection to user application */\r
 121         char *application_description; /**< context description */\r
 122         int num_contexts; /**< number of contexts for this application */\r
 123 } DltDaemonApplication;\r
 124 \r
 125 /**\r
 126  * The parameters of a daemon context.\r
 127  */\r
 128 typedef struct\r
 129 {\r
 130         char apid[DLT_ID_SIZE];               /**< application id */\r
 131         char ctid[DLT_ID_SIZE];                 /**< context id */\r
 132         int8_t log_level;               /**< the current log level of the context */\r
 133         int8_t trace_status;    /**< the current trace status of the context */\r
 134         int log_level_pos;  /**< offset of context in context field on user application */\r
 135         int user_handle;    /**< connection handle for connection to user application */\r
 136         char *context_description; /**< context description */\r
 137 } DltDaemonContext;\r
 138 \r
 139 /**\r
 140  * The parameters of a daemon.\r
 141  */\r
 142 typedef struct\r
 143 {\r
 144         int num_contexts;               /**< Total number of all contexts in all applications */\r
 145         DltDaemonContext *contexts;         /**< Pointer to contexts */\r
 146         int num_applications;                   /**< Number of available application */\r
 147         DltDaemonApplication *applications; /**< Pointer to applications */\r
 148         int8_t default_log_level;          /**< Default log level (of daemon) */\r
 149         int8_t default_trace_status;       /**< Default trace status (of daemon) */\r
 150         int message_buffer_overflow;   /**< Set to one, if buffer overflow has occured, zero otherwise */\r
 151         int runtime_context_cfg_loaded;         /**< Set to one, if runtime context configuration has been loaded, zero otherwise */\r
 152         char ecuid[DLT_ID_SIZE];       /**< ECU ID of daemon */\r
 153         int sendserialheader;          /**< 1: send serial header; 0 don't send serial header */\r
 154         int timingpackets;              /**< 1: send continous timing packets; 0 don't send continous timing packets */\r
 155         DltRingBuffer client_ringbuffer; /**< Ring-buffer for storing received logs while no client connection is available */\r
 156 } DltDaemon;\r
 157 \r
 158 /**\r
 159  * Initialise the dlt daemon structure\r
 160  * This function must be called before using further dlt daemon structure\r
 161  * @param daemon pointer to dlt daemon structure\r
 162  * @param verbose if set to true verbose information is printed out.\r
 163  * @return negative value if there was an error\r
 164  */\r
 165 int dlt_daemon_init(DltDaemon *daemon,int verbose);\r
 166 /**\r
 167  * De-Initialise the dlt daemon structure\r
 168  * @param daemon pointer to dlt daemon structure\r
 169  * @param verbose if set to true verbose information is printed out.\r
 170  * @return negative value if there was an error\r
 171  */\r
 172 int dlt_daemon_free(DltDaemon *daemon,int verbose);\r
 173 \r
 174 /**\r
 175  * Add (new) application to internal application management\r
 176  * @param daemon pointer to dlt daemon structure\r
 177  * @param apid pointer to application id\r
 178  * @param pid process id of user application\r
 179  * @param description description of application\r
 180  * @param verbose if set to true verbose information is printed out.\r
 181  * @return Pointer to added context, null pointer on error\r
 182  */\r
 183 DltDaemonApplication* dlt_daemon_application_add(DltDaemon *daemon,char *apid,pid_t pid,char *description, int verbose);\r
 184 /**\r
 185  * Delete application from internal application management\r
 186  * @param daemon pointer to dlt daemon structure\r
 187  * @param application pointer to application to be deleted\r
 188  * @param verbose if set to true verbose information is printed out.\r
 189  * @return negative value if there was an error\r
 190  */\r
 191 int dlt_daemon_application_del(DltDaemon *daemon, DltDaemonApplication *application, int verbose);\r
 192 /**\r
 193  * Find application with specific application id\r
 194  * @param daemon pointer to dlt daemon structure\r
 195  * @param apid pointer to application id\r
 196  * @param verbose if set to true verbose information is printed out.\r
 197  * @return Pointer to application, null pointer on error or not found\r
 198  */\r
 199 DltDaemonApplication* dlt_daemon_application_find(DltDaemon *daemon,char *apid,int verbose);\r
 200 /**\r
 201  * Load applications from file to internal context management\r
 202  * @param daemon pointer to dlt daemon structure\r
 203  * @param filename name of file to be used for loading\r
 204  * @param verbose if set to true verbose information is printed out.\r
 205  * @return negative value if there was an error\r
 206  */\r
 207 int dlt_daemon_applications_load(DltDaemon *daemon,const char *filename, int verbose);\r
 208 /**\r
 209  * Save applications from internal context management to file\r
 210  * @param daemon pointer to dlt daemon structure\r
 211  * @param filename name of file to be used for saving\r
 212  * @param verbose if set to true verbose information is printed out.\r
 213  * @return negative value if there was an error\r
 214  */\r
 215 int dlt_daemon_applications_save(DltDaemon *daemon,const char *filename, int verbose);\r
 216 /**\r
 217  * Clear all applications in internal application management\r
 218  * @param daemon pointer to dlt daemon structure\r
 219  * @param verbose if set to true verbose information is printed out.\r
 220  * @return negative value if there was an error\r
 221  */\r
 222 int dlt_daemon_applications_clear(DltDaemon *daemon,int verbose);\r
 223 \r
 224 /**\r
 225  * Add (new) context to internal context management\r
 226  * @param daemon pointer to dlt daemon structure\r
 227  * @param apid pointer to application id\r
 228  * @param ctid pointer to context id\r
 229  * @param log_level log level of context\r
 230  * @param trace_status trace status of context\r
 231  * @param log_level_pos offset of context in context field on user application\r
 232  * @param user_handle connection handle for connection to user application\r
 233  * @param description description of context\r
 234  * @param verbose if set to true verbose information is printed out.\r
 235  * @return Pointer to added context, null pointer on error\r
 236  */\r
 237 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);\r
 238 /**\r
 239  * Delete context from internal context management\r
 240  * @param daemon pointer to dlt daemon structure\r
 241  * @param context pointer to context to be deleted\r
 242  * @param verbose if set to true verbose information is printed out.\r
 243  * @return negative value if there was an error\r
 244  */\r
 245 int dlt_daemon_context_del(DltDaemon *daemon, DltDaemonContext* context, int verbose);\r
 246 /**\r
 247  * Find context with specific application id and context id\r
 248  * @param daemon pointer to dlt daemon structure\r
 249  * @param apid pointer to application id\r
 250  * @param ctid pointer to context id\r
 251  * @param verbose if set to true verbose information is printed out.\r
 252  * @return Pointer to context, null pointer on error or not found\r
 253  */\r
 254 DltDaemonContext* dlt_daemon_context_find(DltDaemon *daemon,char *apid,char *ctid,int verbose);\r
 255 /**\r
 256  * Clear all contexts in internal context management\r
 257  * @param daemon pointer to dlt daemon structure\r
 258  * @param verbose if set to true verbose information is printed out.\r
 259  * @return negative value if there was an error\r
 260  */\r
 261 int dlt_daemon_contexts_clear(DltDaemon *daemon,int verbose);\r
 262 /**\r
 263  * Load contexts from file to internal context management\r
 264  * @param daemon pointer to dlt daemon structure\r
 265  * @param filename name of file to be used for loading\r
 266  * @param verbose if set to true verbose information is printed out.\r
 267  * @return negative value if there was an error\r
 268  */\r
 269 int dlt_daemon_contexts_load(DltDaemon *daemon,const char *filename, int verbose);\r
 270 /**\r
 271  * Save contexts from internal context management to file\r
 272  * @param daemon pointer to dlt daemon structure\r
 273  * @param filename name of file to be used for saving\r
 274  * @param verbose if set to true verbose information is printed out.\r
 275  * @return negative value if there was an error\r
 276  */\r
 277 int dlt_daemon_contexts_save(DltDaemon *daemon,const char *filename, int verbose);\r
 278 \r
 279 /**\r
 280  * Send user message DLT_USER_MESSAGE_LOG_LEVEL to user application\r
 281  * @param daemon pointer to dlt daemon structure\r
 282  * @param context pointer to context for response\r
 283  * @param verbose if set to true verbose information is printed out.\r
 284  * @return negative value if there was an error\r
 285  */\r
 286 int dlt_daemon_user_send_log_level(DltDaemon *daemon,DltDaemonContext *context, int verbose);\r
 287 /**\r
 288  * Send user messages to all user applications using default context, or trace status\r
 289  * to update those values\r
 290  * @param daemon pointer to dlt daemon structure\r
 291  * @param verbose if set to true verbose information is printed out.\r
 292  */\r
 293 void dlt_daemon_user_send_default_update(DltDaemon *daemon, int verbose);\r
 294 \r
 295 /**\r
 296  * Process received control message from dlt client\r
 297  * @param sock connection handle used for sending response\r
 298  * @param daemon pointer to dlt daemon structure\r
 299  * @param msg pointer to received control message\r
 300  * @param verbose if set to true verbose information is printed out.\r
 301  */\r
 302 int dlt_daemon_control_process_control(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 303 /**\r
 304  * Generate response to control message from dlt client\r
 305  * @param sock connection handle used for sending response\r
 306  * @param daemon pointer to dlt daemon structure\r
 307  * @param service_id service id of control message\r
 308  * @param status status of response (e.g. ok, not supported, error)\r
 309  * @param verbose if set to true verbose information is printed out.\r
 310  */\r
 311 void dlt_daemon_control_service_response(int sock, DltDaemon *daemon, uint32_t service_id, int8_t status, int verbose);\r
 312 /**\r
 313  * Send out response message to dlt client\r
 314  * @param sock connection handle used for sending response\r
 315  * @param daemon pointer to dlt daemon structure\r
 316  * @param msg pointer to response message\r
 317  * @param appid pointer to application id to be used in response message\r
 318  * @param contid pointer to context id to be used in response message\r
 319  * @param verbose if set to true verbose information is printed out.\r
 320  */\r
 321 void dlt_daemon_control_send_control_message(int sock, DltDaemon *daemon, DltMessage *msg, char* appid, char* contid, int verbose);\r
 322 \r
 323 /**\r
 324  * Process and generate response to received sw injection control message\r
 325  * @param sock connection handle used for sending response\r
 326  * @param daemon pointer to dlt daemon structure\r
 327  * @param msg pointer to received sw injection control message\r
 328  * @param verbose if set to true verbose information is printed out.\r
 329  */\r
 330 void dlt_daemon_control_callsw_cinjection(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 331 /**\r
 332  * Process and generate response to received set log level control message\r
 333  * @param sock connection handle used for sending response\r
 334  * @param daemon pointer to dlt daemon structure\r
 335  * @param msg pointer to received control message\r
 336  * @param verbose if set to true verbose information is printed out.\r
 337  */\r
 338 void dlt_daemon_control_set_log_level(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 339 /**\r
 340  * Process and generate response to received set trace status control message\r
 341  * @param sock connection handle used for sending response\r
 342  * @param daemon pointer to dlt daemon structure\r
 343  * @param msg pointer to received control message\r
 344  * @param verbose if set to true verbose information is printed out.\r
 345  */\r
 346 void dlt_daemon_control_set_trace_status(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 347 /**\r
 348  * Process and generate response to received set default log level control message\r
 349  * @param sock connection handle used for sending response\r
 350  * @param daemon pointer to dlt daemon structure\r
 351  * @param msg pointer to received control message\r
 352  * @param verbose if set to true verbose information is printed out.\r
 353  */\r
 354 void dlt_daemon_control_set_default_log_level(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 355 /**\r
 356  * Process and generate response to received set default trace status control message\r
 357  * @param sock connection handle used for sending response\r
 358  * @param daemon pointer to dlt daemon structure\r
 359  * @param msg pointer to received control message\r
 360  * @param verbose if set to true verbose information is printed out.\r
 361  */\r
 362 void dlt_daemon_control_set_default_trace_status(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 363 /**\r
 364  * Process and generate response to set timing packets control message\r
 365  * @param sock connection handle used for sending response\r
 366  * @param daemon pointer to dlt daemon structure\r
 367  * @param msg pointer to received control message\r
 368  * @param verbose if set to true verbose information is printed out.\r
 369  */\r
 370 void dlt_daemon_control_set_timing_packets(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 371 /**\r
 372  * Process and generate response to received get software version control message\r
 373  * @param sock connection handle used for sending response\r
 374  * @param daemon pointer to dlt daemon structure\r
 375  * @param verbose if set to true verbose information is printed out.\r
 376  */\r
 377 void dlt_daemon_control_get_software_version(int sock, DltDaemon *daemon, int verbose);\r
 378 /**\r
 379  * Process and generate response to received get default log level control message\r
 380  * @param sock connection handle used for sending response\r
 381  * @param daemon pointer to dlt daemon structure\r
 382  * @param verbose if set to true verbose information is printed out.\r
 383  */\r
 384 void dlt_daemon_control_get_default_log_level(int sock, DltDaemon *daemon, int verbose);\r
 385 /**\r
 386  * Process and generate response to received get log info control message\r
 387  * @param sock connection handle used for sending response\r
 388  * @param daemon pointer to dlt daemon structure\r
 389  * @param msg pointer to received control message\r
 390  * @param verbose if set to true verbose information is printed out.\r
 391  */\r
 392 void dlt_daemon_control_get_log_info(int sock, DltDaemon *daemon, DltMessage *msg, int verbose);\r
 393 /**\r
 394  * Process and generate response to message buffer overflow control message\r
 395  * @param sock connection handle used for sending response\r
 396  * @param daemon pointer to dlt daemon structure\r
 397  * @param verbose if set to true verbose information is printed out.\r
 398  */\r
 399 void dlt_daemon_control_message_buffer_overflow(int sock, DltDaemon *daemon, int verbose);\r
 400 /**\r
 401  * Process reset to factory default control message\r
 402  * @param daemon pointer to dlt daemon structure\r
 403  * @param filename name of file containing the runtime defaults for applications\r
 404  * @param filename1 name of file containing the runtime defaults for contexts\r
 405  * @param verbose if set to true verbose information is printed out.\r
 406  */\r
 407 void dlt_daemon_control_reset_to_factory_default(DltDaemon *daemon,const char *filename, const char *filename1, int verbose);\r
 408 /**\r
 409  * Send time control message\r
 410  * @param sock connection handle used for sending response\r
 411  * @param daemon pointer to dlt daemon structure\r
 412  * @param verbose if set to true verbose information is printed out.\r
 413  */\r
 414 void dlt_daemon_control_message_time(int sock, DltDaemon *daemon, int verbose);\r
 415 \r
 416 #ifdef __cplusplus\r
 417 }\r
 418 #endif\r
 419 \r
 420 /**\r
 421   \}\r
 422 */\r
 423 \r
 424 #endif /* DLT_DAEMON_COMMON_H */\r