command_handler: change 'args' to CMD_ARGV
[openocd.git] / src / helper / log.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include "time_support.h"
31 // @todo the inclusion of server.h here is a layering violation
32 #include "server.h"
33
34 #include <stdarg.h>
35
36 #ifdef _DEBUG_FREE_SPACE_
37 #ifdef HAVE_MALLOC_H
38 #include <malloc.h>
39 #else
40 #error "malloc.h is required to use --enable-malloc-logging"
41 #endif
42 #endif
43
44 int debug_level = -1;
45
46 static FILE* log_output;
47 static struct log_callback *log_callbacks = NULL;
48
49 static long long last_time;
50 static long long current_time;
51
52 static long long start;
53
54 static char *log_strings[5] =
55 {
56 "User : ",
57 "Error: ",
58 "Warn : ", /* want a space after each colon, all same width, colons aligned */
59 "Info : ",
60 "Debug: "
61 };
62
63
64 static int count = 0;
65
66
67 static struct store_log_forward * log_head = NULL;
68 static int log_forward_count = 0;
69
70 struct store_log_forward
71 {
72 struct store_log_forward * next;
73 const char * file;
74 int line;
75 const char * function;
76 const char * string;
77 };
78
79 /* either forward the log to the listeners or store it for possible forwarding later */
80 static void log_forward(const char *file, unsigned line, const char *function, const char *string)
81 {
82 if (log_forward_count==0)
83 {
84 struct log_callback *cb, *next;
85 cb = log_callbacks;
86 /* DANGER!!!! the log callback can remove itself!!!! */
87 while (cb)
88 {
89 next = cb->next;
90 cb->fn(cb->priv, file, line, function, string);
91 cb = next;
92 }
93 } else
94 {
95 struct store_log_forward *log = malloc(sizeof (struct store_log_forward));
96 log->file = strdup(file);
97 log->line = line;
98 log->function = strdup(function);
99 log->string = strdup(string);
100 log->next = NULL;
101 if (log_head==NULL)
102 log_head = log;
103 else
104 {
105 /* append to tail */
106 struct store_log_forward * t;
107 t = log_head;
108 while (t->next!=NULL)
109 {
110 t = t->next;
111 }
112 t->next = log;
113 }
114 }
115 }
116
117 void log_try(void)
118 {
119 log_forward_count++;
120 }
121
122 void log_catch(void)
123 {
124 assert(log_forward_count>0);
125 log_forward_count--;
126 }
127
128 void log_rethrow(void)
129 {
130 log_catch();
131 if (log_forward_count==0)
132 {
133 struct store_log_forward *log;
134
135 log = log_head;
136 while (log != NULL)
137 {
138 log_forward(log->file, log->line, log->function, log->string);
139
140 struct store_log_forward *t=log;
141 log = log->next;
142
143 free((void *)t->file);
144 free((void *)t->function);
145 free((void *)t->string);
146 free(t);
147
148 }
149
150 log_head = NULL;
151 }
152 }
153
154
155 /* The log_puts() serves to somewhat different goals:
156 *
157 * - logging
158 * - feeding low-level info to the user in GDB or Telnet
159 *
160 * The latter dictates that strings without newline are not logged, lest there
161 * will be *MANY log lines when sending one char at the time(e.g.
162 * target_request.c).
163 *
164 */
165 static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string)
166 {
167 char *f;
168 if (level == LOG_LVL_OUTPUT)
169 {
170 /* do not prepend any headers, just print out what we were given and return */
171 fputs(string, log_output);
172 fflush(log_output);
173 return;
174 }
175
176 f = strrchr(file, '/');
177 if (f != NULL)
178 file = f + 1;
179
180 if (strchr(string, '\n') != NULL)
181 {
182 if (debug_level >= LOG_LVL_DEBUG)
183 {
184 /* print with count and time information */
185 int t = (int)(timeval_ms()-start);
186 #ifdef _DEBUG_FREE_SPACE_
187 struct mallinfo info;
188 info = mallinfo();
189 #endif
190 fprintf(log_output, "%s%d %d %s:%d %s()"
191 #ifdef _DEBUG_FREE_SPACE_
192 " %d"
193 #endif
194 ": %s", log_strings[level + 1], count, t, file, line, function,
195 #ifdef _DEBUG_FREE_SPACE_
196 info.fordblks,
197 #endif
198 string);
199 }
200 else if (server_use_pipes == 0)
201 {
202 /* if we are using gdb through pipes then we do not want any output
203 * to the pipe otherwise we get repeated strings */
204 if (strcmp(string, "\n") != 0)
205 {
206 /* print human readable output - but skip empty lines */
207 fprintf(log_output, "%s%s",
208 (level > LOG_LVL_USER)?log_strings[level + 1]:"", string);
209 }
210 }
211 } else
212 {
213 /* only entire lines are logged. Otherwise it's
214 * single chars intended for the log callbacks. */
215 }
216
217 fflush(log_output);
218
219 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
220 if (level <= LOG_LVL_INFO)
221 {
222 log_forward(file, line, function, string);
223 }
224 }
225
226
227 void log_printf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format, ...)
228 {
229 char *string;
230 va_list ap;
231
232 count++;
233 if (level > debug_level)
234 return;
235
236 va_start(ap, format);
237
238 string = alloc_vprintf(format, ap);
239 if (string != NULL)
240 {
241 log_puts(level, file, line, function, string);
242 free(string);
243 }
244
245 va_end(ap);
246 }
247
248 void log_printf_lf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format, ...)
249 {
250 char *string;
251 va_list ap;
252
253 count++;
254 if (level > debug_level)
255 return;
256
257 va_start(ap, format);
258
259 string = alloc_vprintf(format, ap);
260 if (string != NULL)
261 {
262 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
263 log_puts(level, file, line, function, string);
264 free(string);
265 }
266
267 va_end(ap);
268 }
269
270 /* change the current debug level on the fly
271 * 0: only ERRORS
272 * 1: + WARNINGS
273 * 2: + INFORMATIONAL MSGS
274 * 3: + DEBUG MSGS
275 */
276 COMMAND_HANDLER(handle_debug_level_command)
277 {
278 if (CMD_ARGC == 1)
279 {
280 unsigned new_level;
281 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_level);
282 debug_level = MIN(new_level, LOG_LVL_DEBUG);
283 }
284 else if (CMD_ARGC > 1)
285 return ERROR_COMMAND_SYNTAX_ERROR;
286
287 if (debug_level >= LOG_LVL_DEBUG && server_use_pipes == 1)
288 {
289 /* if we are enabling debug info then we need to write to a log file
290 * otherwise the pipe will get full and cause issues with gdb */
291 FILE* file = fopen("openocd.log", "w");
292 if (file)
293 {
294 log_output = file;
295 LOG_WARNING("enabling log output as we are using pipes");
296 }
297 }
298
299 command_print(cmd_ctx, "debug_level: %i", debug_level);
300
301 return ERROR_OK;
302 }
303
304 COMMAND_HANDLER(handle_log_output_command)
305 {
306 if (CMD_ARGC == 1)
307 {
308 FILE* file = fopen(CMD_ARGV[0], "w");
309
310 if (file)
311 {
312 log_output = file;
313 }
314 }
315
316 return ERROR_OK;
317 }
318
319 int log_register_commands(struct command_context *cmd_ctx)
320 {
321 start = timeval_ms();
322 register_command(cmd_ctx, NULL, "log_output", handle_log_output_command,
323 COMMAND_ANY, "redirect logging to <file> (default: stderr)");
324 register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command,
325 COMMAND_ANY, "adjust debug level <0-3>");
326
327 return ERROR_OK;
328 }
329
330 int log_init(struct command_context *cmd_ctx)
331 {
332 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
333 if (debug_level == -1)
334 debug_level = LOG_LVL_INFO;
335
336 if (log_output == NULL)
337 {
338 log_output = stderr;
339 }
340
341 start = last_time = timeval_ms();
342
343 return ERROR_OK;
344 }
345
346 int set_log_output(struct command_context *cmd_ctx, FILE *output)
347 {
348 log_output = output;
349 return ERROR_OK;
350 }
351
352 /* add/remove log callback handler */
353 int log_add_callback(log_callback_fn fn, void *priv)
354 {
355 struct log_callback *cb;
356
357 /* prevent the same callback to be registered more than once, just for sure */
358 for (cb = log_callbacks; cb; cb = cb->next)
359 {
360 if (cb->fn == fn && cb->priv == priv)
361 return ERROR_INVALID_ARGUMENTS;
362 }
363
364 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
365 if ((cb = malloc(sizeof(struct log_callback))) == NULL)
366 return ERROR_BUF_TOO_SMALL;
367
368 /* add item to the beginning of the linked list */
369 cb->fn = fn;
370 cb->priv = priv;
371 cb->next = log_callbacks;
372 log_callbacks = cb;
373
374 return ERROR_OK;
375 }
376
377 int log_remove_callback(log_callback_fn fn, void *priv)
378 {
379 struct log_callback *cb, **p;
380
381 for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
382 {
383 if (cb->fn == fn && cb->priv == priv)
384 {
385 *p = cb->next;
386 free(cb);
387 return ERROR_OK;
388 }
389 }
390
391 /* no such item */
392 return ERROR_INVALID_ARGUMENTS;
393 }
394
395 /* return allocated string w/printf() result */
396 char *alloc_vprintf(const char *fmt, va_list ap)
397 {
398 /* no buffer at the beginning, force realloc to do the job */
399 char *string = NULL;
400
401 /* start with buffer size suitable for typical messages */
402 int size = 128;
403
404 for (;;)
405 {
406 char *t = string;
407 va_list ap_copy;
408 int ret;
409 string = realloc(string, size);
410 if (string == NULL)
411 {
412 if (t != NULL)
413 free(t);
414 return NULL;
415 }
416
417 va_copy(ap_copy, ap);
418
419 ret = vsnprintf(string, size, fmt, ap_copy);
420 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
421 if ((ret >= 0) && ((ret + 1) < size))
422 break;
423
424 /* there was just enough or not enough space, allocate more in the next round */
425 size *= 2; /* double the buffer size */
426 }
427
428 /* the returned buffer is by principle guaranteed to be at least one character longer */
429 return string;
430 }
431
432 char *alloc_printf(const char *format, ...)
433 {
434 char *string;
435 va_list ap;
436 va_start(ap, format);
437 string = alloc_vprintf(format, ap);
438 va_end(ap);
439 return string;
440 }
441
442 /* Code must return to the server loop before 1000ms has returned or invoke
443 * this function.
444 *
445 * The GDB connection will time out if it spends >2000ms and you'll get nasty
446 * error messages from GDB:
447 *
448 * Ignoring packet error, continuing...
449 * Reply contains invalid hex digit 116
450 *
451 * While it is possible use "set remotetimeout" to more than the default 2000ms
452 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
453 * GDB protocol and it is a bug in OpenOCD not to either return to the server
454 * loop or invoke keep_alive() every 1000ms.
455 *
456 * This function will send a keep alive packet if >500ms has passed since last time
457 * it was invoked.
458 *
459 * Note that this function can be invoked often, so it needs to be relatively
460 * fast when invoked more often than every 500ms.
461 *
462 */
463 void keep_alive()
464 {
465 current_time = timeval_ms();
466 if (current_time-last_time > 1000)
467 {
468 extern int gdb_actual_connections;
469
470 if (gdb_actual_connections)
471 LOG_WARNING("keep_alive() was not invoked in the "
472 "1000ms timelimit. GDB alive packet not "
473 "sent! (%lld). Workaround: increase "
474 "\"set remotetimeout\" in GDB",
475 current_time-last_time);
476 else
477 LOG_DEBUG("keep_alive() was not invoked in the "
478 "1000ms timelimit (%lld). This may cause "
479 "trouble with GDB connections.",
480 current_time-last_time);
481 }
482 if (current_time-last_time > 500)
483 {
484 /* this will keep the GDB connection alive */
485 LOG_USER_N("%s", "");
486
487 /* DANGER!!!! do not add code to invoke e.g. target event processing,
488 * jim timer processing, etc. it can cause infinite recursion +
489 * jim event callbacks need to happen at a well defined time,
490 * not anywhere keep_alive() is invoked.
491 *
492 * These functions should be invoked at a well defined spot in server.c
493 */
494
495 last_time = current_time;
496 }
497 }
498
499 /* reset keep alive timer without sending message */
500 void kept_alive()
501 {
502 current_time = timeval_ms();
503 last_time = current_time;
504 }
505
506 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
507 void alive_sleep(uint64_t ms)
508 {
509 uint64_t napTime = 10;
510 for (uint64_t i = 0; i < ms; i += napTime)
511 {
512 uint64_t sleep_a_bit = ms - i;
513 if (sleep_a_bit > napTime)
514 sleep_a_bit = napTime;
515
516 usleep(sleep_a_bit * 1000);
517 keep_alive();
518 }
519 }
520
521 void busy_sleep(uint64_t ms)
522 {
523 uint64_t then = timeval_ms();
524 while (timeval_ms() - then < ms)
525 {
526 /* busy wait */
527 }
528 }