1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* SPDX license identifier: MPL-2.0
*
* Copyright (C) 2024, Mercedes Benz Tech Innovation GmbH
*
* 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 https://www.covesa.global/.
*/
/*!
* \author
* Daniel Weber <daniel.w.weber@mercedes-benz.com>
*
* \copyright Copyright © 2024 Mercedes Benz Tech Innovation GmbH. \n
* License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/.
*
* \file dlt_log.h
*/
#ifndef DLT_COMMON_LOG_H
#define DLT_COMMON_LOG_H
#include <stdio.h>
#include <stdbool.h>
#include "dlt_types.h"
# if defined(__GNUC__)
# define PURE_FUNCTION __attribute__((pure))
# define PRINTF_FORMAT(a,b) __attribute__ ((format (printf, a, b)))
# else
# define PURE_FUNCTION /* nothing */
# define PRINTF_FORMAT(a,b) /* nothing */
# endif
typedef enum {
DLT_LOG_TO_CONSOLE = 0,
DLT_LOG_TO_SYSLOG = 1,
DLT_LOG_TO_FILE = 2,
DLT_LOG_TO_STDERR = 3,
DLT_LOG_DROPPED = 4
} DltLoggingMode;
/* initialize this variables in dlt_log.c */
extern DltLoggingMode logging_mode;
extern FILE *logging_handle;
# ifdef __cplusplus
extern "C"
{
# endif
/**
* Set internal logging filename if mode 2
* @param filename the filename
*/
void dlt_log_set_filename(const char *filename);
/**
* Set internal logging level
* @param level the level
*/
void dlt_log_set_level(int level);
/**
* Initialize (external) logging facility
* @param mode positive, 0 = log to stdout, 1 = log to syslog, 2 = log to file, 3 = log to stderr
*/
DltReturnValue dlt_log_init(int mode);
/**
* Initialize (external) logging facility
* @param mode DltLoggingMode, 0 = log to stdout, 1 = log to syslog, 2 = log to file, 3 = log to stderr
* @param enable_multiple_logfiles, true if multiple logfiles (incl. size limits) should be use
* @param logging_file_size, maximum size in bytes of one logging file
* @param logging_files_max_size, maximum size in bytes of all logging files
*/
DltReturnValue dlt_log_init_multiple_logfiles_support(DltLoggingMode mode, bool enable_multiple_logfiles, int logging_file_size, int logging_files_max_size);
/**
* Initialize (external) logging facility for single logfile.
*/
DltReturnValue dlt_log_init_single_logfile(void);
/**
* Initialize (external) logging facility for multiple files logging.
*/
DltReturnValue dlt_log_init_multiple_logfiles(int logging_file_size, int logging_files_max_size);
/**
* Print with variable arguments to specified file descriptor by DLT_LOG_MODE environment variable (like fprintf)
* @param format format string for message
* @return negative value if there was an error or the total number of characters written is returned on success
*/
int dlt_user_printf(const char *format, ...) PRINTF_FORMAT(1, 2);
/**
* Log ASCII string with null-termination to (external) logging facility
* @param prio priority (see syslog() call)
* @param s Pointer to ASCII string with null-termination
* @return negative value if there was an error
*/
DltReturnValue dlt_log(int prio, const char *s);
/**
* Log with variable arguments to (external) logging facility (like printf)
* @param prio priority (see syslog() call)
* @param format format string for log message
* @return negative value if there was an error
*/
DltReturnValue dlt_vlog(int prio, const char *format, ...) PRINTF_FORMAT(2, 3);
/**
* Log size bytes with variable arguments to (external) logging facility (similar to snprintf)
* @param prio priority (see syslog() call)
* @param size number of bytes to log
* @param format format string for log message
* @return negative value if there was an error
*/
DltReturnValue dlt_vnlog(int prio, size_t size, const char *format, ...) PRINTF_FORMAT(3, 4);
/**
* Logs into log files represented by the multiple files buffer.
* @param format First element in a specific format that will be logged.
* @param ... Further elements in a specific format that will be logged.
*/
void dlt_log_multiple_files_write(const char* format, ...);
/**
* De-Initialize (external) logging facility
*/
void dlt_log_free(void);
void dlt_log_free_single_logfile(void);
void dlt_log_free_multiple_logfiles(void);
/**
* Checks whether (internal) logging in multiple files is active.
*/
bool dlt_is_log_in_multiple_files_active(void);
# ifdef __cplusplus
}
# endif
#endif /* DLT_COMMON_LOG_H */
|
