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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
/*
* c't-Sim - Robotersimulator fuer den c't-Bot
*
* This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at your
* option) any later version.
* 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 General Public License for more details.
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307, USA.
*
*/
/*! @file log.c
* @brief Routinen zum Loggen von Informationen. Es sollten ausschliesslich nur
* die Log-Makros: LOG_DEBUG(), LOG_INFO(), LOG_WARN(), LOG_ERROR() und LOG_FATAL()
* verwendet werden.
* Eine Ausgabe kann wie folgt erzeugt werden:
* LOG_DEBUG(("Hallo Welt!"));
* LOG_INFO(("Wert x=%d", x));
* Wichtig ist die doppelte Klammerung. Bei den Ausgaben kann auf ein Line Feed
* '\n' am Ende des Strings verzichtet werden, da dies automatisch angeh�ngt
* hinzugefuegt wird.
*
* @author Andreas Merkle (mail@blue-andi.de)
* @date 27.02.06
*/
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include "log.h"
#include "display.h"
#include "command.h"
#include "uart.h"
#ifdef LOG_AVAILABLE
#ifdef PC
#include <pthread.h>
#endif /* PC */
#ifdef LOG_DISPLAY_AVAILABLE
/*! Nummer des Screens auf den Loggings ausgegeben werden sollen. */
#define LOG_TO_SCREEN 4
/*! Groesse des Puffers fuer die Logausgaben bei Verwendung des LCD-Displays. */
#define LOG_BUFFER_SIZE (DISPLAY_LENGTH + 1)
#else
/*! Groesse des Puffers fuer die Logausgaben ueber UART und ueber TCP/IP. */
#define LOG_BUFFER_SIZE 200
#endif /* LOG_DISPLAY_AVAILABLE */
#ifdef PC
/*! Schuetzt den Ausgabepuffer */
#define LOCK() pthread_mutex_lock(&log_buffer_mutex);
/*! Hebt den Schutz fuer den Ausgabepuffer wieder auf */
#define UNLOCK() pthread_mutex_unlock(&log_buffer_mutex);
#else
/*! Schuetzt den Ausgabepuffer */
#define LOCK() /* TODO */
/*! Hebt den Schutz fuer den Ausgabepuffer wieder auf */
#define UNLOCK() /* TODO */
#endif /* PC */
/*!
* Liefert den Log-Typ als String.
* @param log_type Log-Typ
* @return char*
*/
static char* log_get_type_str(LOG_TYPE log_type);
/*! Puffer fuer das Zusammenstellen einer Logausgabe */
static char log_buffer[LOG_BUFFER_SIZE];
#ifdef PC
/*! Schuetzt den Ausgabepuffer */
static pthread_mutex_t log_buffer_mutex = PTHREAD_MUTEX_INITIALIZER;
#endif /* PC */
#ifdef LOG_DISPLAY_AVAILABLE
/*! Zeile in der die naechste Logausgabe erfolgt. */
static uint16 log_line = 0;
#endif /* LOG_DISPLAY_AVAILABLE */
/*!
* Schreibt Angaben ueber Datei, Zeilennummer und den Log-Typ in den Puffer.
* Achtung, Mutex wird gelockt und muss explizit durch log_end() wieder
* freigegeben werden!
* @param filename Dateiname
* @param line Zeilennummer
* @param log_type Log-Typ
*/
extern void log_begin(char *filename, unsigned int line, LOG_TYPE log_type) {
/* Ausgaben ueber das LCD-Display werden ohne Dateiname und Zeilennumer
* gemacht. Der Log-Typ versteckt sich im ersten Buchstaben. Durch eine
* die Markierung mit '>' erkennt man das letzte Logging.
* Nur bei Ausgaben ueber UART und an ct-Sim werden Dateiname, Zeilennummer
* und der Log-Typ vollstaendig ausgegeben.
*/
#ifdef LOG_DISPLAY_AVAILABLE
LOCK();
/* Nur auf einem bestimmten Screen werden Loggings ausgegeben. */
if (display_screen != LOG_TO_SCREEN) {
log_buffer[0] = '\0';
return;
}
/* Zum ersten Mal aufgerufen? */
if (log_line == 0) {
log_line++;
} else {
/* Alte Markierung loeschen */
if (log_line - 1 == 0) {
display_cursor(4, 1);
}
else {
display_cursor(log_line - 1, 1);
}
display_printf(" ");
}
display_cursor(log_line, 1);
log_line++;
if (log_line >= DISPLAY_SCREENS) {
log_line = 1;
}
snprintf(log_buffer, LOG_BUFFER_SIZE, ">%s:", log_get_type_str(log_type));
#else
char *ptr = NULL;
/* Nur den Dateinamen loggen, ohne Verzeichnisangabe */
ptr = strrchr(filename, '/');
if (ptr == NULL)
ptr = filename;
else
ptr++;
LOCK();
snprintf(log_buffer, LOG_BUFFER_SIZE, "%s(%d)\t%s\t",
ptr, line, log_get_type_str(log_type));
#endif
return;
}
/*!
* Schreibt die eigentliche Ausgabeinformation in den Puffer.
* @param format Format
*/
extern void log_printf(char *format, ...) {
va_list args;
unsigned int len = strlen(log_buffer);
#ifdef LOG_DISPLAY_AVAILABLE
/* Nur auf einem bestimmten Screen werden Loggings ausgegeben. */
if (display_screen != LOG_TO_SCREEN)
return;
#endif
va_start(args, format);
vsnprintf(&log_buffer[len], LOG_BUFFER_SIZE - len, format, args);
va_end(args);
return;
}
/*!
* Gibt den Puffer entsprechend aus.
*/
extern void log_end(void) {
#ifdef LOG_UART_AVAILABLE
/* String ueber UART senden, ohne '\0'-Terminierung */
uart_write((uint8*)log_buffer, strlen(log_buffer));
/* Line feed senden */
uart_write((uint8*)LINE_FEED,strlen(LINE_FEED));
#endif /* LOG_UART_AVAILABLE */
#ifdef LOG_CTSIM_AVAILABLE
/* Kommando an ct-Sim senden, ohne Line feed am Ende. */
command_write_data(CMD_LOG, SUB_CMD_NORM, NULL, NULL, log_buffer);
#endif /* LOG_CTSIM_AVAILABLE */
#ifdef LOG_DISPLAY_AVAILABLE
/* Nur auf einem bestimmten Screen werden Loggings ausgegeben. */
if (display_screen == LOG_TO_SCREEN) {
/* String aufs LCD-Display schreiben */
display_printf("%s", log_buffer);
}
#endif /* LOG_DISPLAY_AVAILABLE */
/* Wenn das Logging aktiviert und keine Ausgabeschnittstelle
* definiert ist, dann wird auf dem PC auf die Konsole geschrieben.
*/
#ifdef LOG_STDOUT_AVAILABLE
printf("%s\n", log_buffer);
#endif /* LOG_STDOUT_AVAILABLE */
UNLOCK();
return;
}
#ifdef LOG_DISPLAY_AVAILABLE
/*!
* Liefert den Log-Typ als String.
* @param log_type Log-Typ
* @return char*
*/
static char* log_get_type_str(LOG_TYPE log_type) {
switch(log_type) {
case LOG_TYPE_DEBUG:
return "D";
case LOG_TYPE_INFO:
return "I";
case LOG_TYPE_WARN:
return "W";
case LOG_TYPE_ERROR:
return "E";
case LOG_TYPE_FATAL:
return "F";
default:
break;
}
return "";
}
#else
/*!
* Liefert den Log-Typ als String.
* @param log_type Log-Typ
* @return char*
*/
static char* log_get_type_str(LOG_TYPE log_type) {
switch(log_type) {
case LOG_TYPE_DEBUG:
return "- DEBUG -";
case LOG_TYPE_INFO:
return "- INFO -";
case LOG_TYPE_WARN:
return "- WARNING -";
case LOG_TYPE_ERROR:
return "- ERROR -";
case LOG_TYPE_FATAL:
return "- FATAL -";
default:
break;
}
return "";
}
#endif /* LOG_DISPLAY_AVAILABLE */
#endif /* LOG_AVAILABLE */
|
