Offline Logstorage [3/4]: Core implementation

Signed-off-by: Christoph Lipka <clipka@de.adit-jv.com>

1 files changed, 214 insertions, 0 deletions

diff --git a/src/offlinelogstorage/dlt_offline_logstorage.h b/src/offlinelogstorage/dlt_offline_logstorage.h
new file mode 100644
index 0000000..bec4fe3
--- /dev/null
+++ b/src/offlinelogstorage/dlt_offline_logstorage.h
@@ -0,0 +1,214 @@
+/**
+ * @licence app begin@
+ * Copyright (C) 2013 - 2015  Advanced Driver Information Technology.
+ * This code is developed by Advanced Driver Information Technology.
+ * Copyright of Advanced Driver Information Technology, Bosch and DENSO.
+ *
+ * DLT offline log storage functionality header file.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, 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/.
+ *
+ *
+ * \author Syed Hameed <shameed@jp.adit-jv.com> ADIT 2013 - 2015
+ * \author Christoph Lipka <clipka@jp.adit-jv.com> ADIT 2015
+ *
+ * \file: dlt_offline_logstorage.h
+ * For further information see http://www.genivi.org/.
+ * @licence end@
+ */
+
+/*******************************************************************************
+**                                                                            **
+**  SRC-MODULE: dlt_offline_logstorage.h                                      **
+**                                                                            **
+**  TARGET    : linux                                                         **
+**                                                                            **
+**  PROJECT   : DLT                                                           **
+**                                                                            **
+**  AUTHOR    : Syed Hameed shameed@jp.adit-jv.com                            **
+**              Christoph Lipka clipka@jp.adit-jv.com                         **
+**  PURPOSE   :                                                               **
+**                                                                            **
+**  REMARKS   :                                                               **
+**                                                                            **
+**  PLATFORM DEPENDANT [yes/no]: yes                                          **
+**                                                                            **
+**  TO BE CHANGED BY USER [yes/no]: no                                        **
+**                                                                            **
+*******************************************************************************/
+
+/*******************************************************************************
+**                      Author Identity                                       **
+********************************************************************************
+**                                                                            **
+** Initials     Name                       Company                            **
+** --------     -------------------------  ---------------------------------- **
+**  sh          Syed Hameed                ADIT                               **
+**  cl          Christoph Lipka            ADIT                               **
+*******************************************************************************/
+
+#ifndef DLT_OFFLINE_LOGSTORAGE_H
+#define DLT_OFFLINE_LOGSTORAGE_H
+
+#include <search.h>
+#include "dlt_common.h"
+#include "dlt-daemon_cfg.h"
+
+#define DLT_OFFLINE_LOGSTORAGE_MAXFILTERS          100  /* Maximum entries in hashmap */
+
+#define DLT_OFFLINE_LOGSTORAGE_INIT_DONE           1  /* For device configuration status */
+#define DLT_OFFLINE_LOGSTORAGE_DEVICE_CONNECTED    1
+#define DLT_OFFLINE_LOGSTORAGE_FREE                0
+#define DLT_OFFLINE_LOGSTORAGE_DEVICE_DISCONNECTED 0
+#define DLT_OFFLINE_LOGSTORAGE_CONFIG_DONE         1
+
+#define DLT_OFFLINE_LOGSTORAGE_MAX_KEY_LEN         10  /* Maximum size for key */
+#define DLT_OFFLINE_LOGSTORAGE_MAX_FILE_NAME_LEN   50  /* Maximum file name length of the log file */
+#define DLT_OFFLINE_LOGSTORAGE_MAX_LINE_SIZE       80  /* Maximum length of a line in configuration file */
+
+#define DLT_OFFLINE_LOGSTORAGE_FILE_EXTENSION_LEN   4
+#define DLT_OFFLINE_LOGSTORAGE_INDEX_LEN            3
+#define DLT_OFFLINE_LOGSTORAGE_MAX_INDEX          999
+#define DLT_OFFLINE_LOGSTORAGE_TIMESTAMP_LEN       16
+#define DLT_OFFLINE_LOGSTORAGE_INDEX_OFFSET        (DLT_OFFLINE_LOGSTORAGE_TIMESTAMP_LEN + \
+                                                    DLT_OFFLINE_LOGSTORAGE_FILE_EXTENSION_LEN + \
+                                                    DLT_OFFLINE_LOGSTORAGE_INDEX_LEN)
+#define DLT_OFFLINE_LOGSTORAGE_MAX_LOG_FILE_LEN    (DLT_OFFLINE_LOGSTORAGE_MAX_FILE_NAME_LEN + \
+                                                    DLT_OFFLINE_LOGSTORAGE_TIMESTAMP_LEN + \
+                                                    DLT_OFFLINE_LOGSTORAGE_INDEX_LEN + \
+                                                    DLT_OFFLINE_LOGSTORAGE_FILE_EXTENSION_LEN + 1)
+
+#define DLT_OFFLINE_LOGSTORAGE_FILTER_UNINIT       0
+#define DLT_OFFLINE_LOGSTORAGE_FILTER_PRESENT      (1<<6)
+#define DLT_OFFLINE_LOGSTORAGE_APP_INIT            (1<<5)
+#define DLT_OFFLINE_LOGSTORAGE_CTX_INIT            (1<<4)
+#define DLT_OFFLINE_LOGSTORAGE_LOG_LVL_INIT        (1<<3)
+#define DLT_OFFLINE_LOGSTORAGE_NAME_INIT           (1<<2)
+#define DLT_OFFLINE_LOGSTORAGE_SIZE_INIT           (1<<1)
+#define DLT_OFFLINE_LOGSTORAGE_NUM_INIT            1
+#define DLT_OFFLINE_LOGSTORAGE_FILTER_INIT         0x7F
+
+#define DLT_OFFLINE_LOGSTORAGE_FILTER_INITIALIZED(A) ((A) == DLT_OFFLINE_LOGSTORAGE_FILTER_INIT)
+
+#define DLT_OFFLINE_LOGSTORAGE_IS_FILTER_PRESENT(A) ((A) & DLT_OFFLINE_LOGSTORAGE_FILTER_PRESENT)
+
+#define DLT_OFFLINE_LOGSTORAGE_CONFIG_DIR_PATH_LEN 50
+#define DLT_OFFLINE_LOGSTORAGE_CONFIG_DIR_PATH     "/tmp/dltlogs/dltlogsdev"
+#define DLT_OFFLINE_LOGSTORAGE_CONFIG_FILE_NAME    "dlt_logstorage.conf"
+
+/* +3 because of device number and \0 */
+#define DLT_OFFLINE_LOGSTORAGE_MAX_PATH_LEN (DLT_OFFLINE_LOGSTORAGE_MAX_LOG_FILE_LEN + \
+                                             DLT_OFFLINE_LOGSTORAGE_CONFIG_DIR_PATH_LEN + 3)
+
+#define DLT_OFFLINE_LOGSTORAGE_MAX(A, B)   ((A) > (B) ? (A) : (B))
+#define DLT_OFFLINE_LOGSTORAGE_MIN(A, B)   ((A) < (B) ? (A) : (B))
+
+#define DLT_OFFLINE_LOGSTORAGE_MAX_WRITE_ERRORS     5
+
+typedef struct
+{
+    /* filter section */
+    int log_level;              /* Log level number configured for filter */
+    char *file_name;            /* File name for log storage configured for filter */
+    unsigned int file_size;     /* MAX FIle size of storage file configured for filter */
+    unsigned int num_files;     /* MAX number of storage files configured for filters */
+    FILE *log;                  /* current open log file */
+}DltLogStorageConfigData;
+
+
+typedef struct
+{
+    char key[DLT_OFFLINE_LOGSTORAGE_MAX_KEY_LEN]; /* Keys stored in hash table */
+    DltLogStorageConfigData data;               /* Data stored in hash table */
+}DltLogStorageConfig;
+
+
+typedef struct
+{
+    struct hsearch_data config_htab;    /* Hash table object declaration used by hsearch_r()*/
+    DltLogStorageConfig *config_data; /* Configuration data  */
+    char *filter_keys;                 /* List of all keys stored in config_htab */
+    int num_filter_keys;                /* Number of keys */
+    unsigned int device_num;           /* Number of device to be used */
+    unsigned int connection_type;      /* Type of connection */
+    unsigned int config_status;        /* Status of configuration */
+    int write_errors;                  /* number of write errors */
+}DltLogStorage;
+
+/**
+ * dlt_logstorage_device_connected
+ *
+ * Initializes DLT Offline Logstorage with respect to device status
+ *
+ *
+ * @param handle         DLT Logstorage handle
+ * @param device_num     device number
+ * @return               0 on success, -1 on error
+ */
+extern int dlt_logstorage_device_connected(DltLogStorage *handle, int device_num);
+
+/**
+  * dlt_logstorage_load_config
+  *
+  * Parse dlt_logstorage.conf file in the device and setup internal info table
+  *
+  * @param handle    DltLogStorage handle
+  * @return          0 on success, -1 on error
+  */
+extern int dlt_logstorage_load_config(DltLogStorage *handle);
+/**
+ * dlt_logstorage_device_disconnected
+ * De-Initializes DLT Offline Logstorage with respect to device status
+ *
+ * @param handle         DLT Logstorage handle
+ * @return               0 on success, -1 on error
+ */
+extern int dlt_logstorage_device_disconnected(DltLogStorage *handle);
+/**
+ * dlt_logstorage_get_config
+ *
+ * Obtain the configuration data of all filters for provided apid and ctid
+ * For a given apid and ctid, there can be 3 possiblities of configuration
+ * data available in the Hash map, this function will return the address
+ * of configuration data for all these 3 combinations
+ *
+ * @param handle        DltLogStorage handle
+ * @param appid         application id
+ * @param ctxid         context id
+ * @param num_config    (o/p) contains the number of filter configration data obtained
+ * @return              on success: address of configuration data, NULL on failure or no configuration data found
+ */
+extern DltLogStorageConfigData **dlt_logstorage_get_config(DltLogStorage *handle, char *apid, char *ctid, int *num_config);
+/**
+ * dlt_logstorage_get_loglevel_by_key
+ *
+ * Obtain the log level for the provided key
+ * This function can be used to obtain log level when the actual
+ * key stored in the Hash map is availble with the caller
+ *
+ * @param handle    DltLogstorage handle
+ * @param key       key to search for in Hash MAP
+ * @return          log level on success:, -1 on error
+ */
+extern int dlt_logstorage_get_loglevel_by_key(DltLogStorage *handle, char *key);
+
+/**
+ * dlt_logstorage_write
+ *
+ * Write a message to one or more configured log files, based on filter configuration.
+ *
+ * @param handle    DltLogStorage handle
+ * @param appid     Application id of sender
+ * @param ctxid     Context id of sender
+ * @param log_level log_level of message to store
+ * @param data1     Data buffer of message header
+ * @param size1     Size of message header buffer
+ * @param data2     Data buffer of message body
+ * @param size2     Size of message body
+ * @return          0 on success or write errors < max write errors, -1 on error
+ */
+extern int dlt_logstorage_write(DltLogStorage *handle, char *appid, char *ctxid, int loglevel, unsigned char *data1, int size1, unsigned char *data2, int size2, unsigned char *data3, int size3);
+#endif /* DLT_OFFLINE_LOGSTORAGE_H */