retire ERROR_INVALID_ARGUMENTS and replace with ERROR_COMMAND_SYNTAX_ERROR
[openocd/andreasf.git] / src / helper / log.c
blobfa66de065966de85f54c238f4275c790615118fc
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007-2010 Ø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
30 #include "time_support.h"
31 // @todo the inclusion of server.h here is a layering violation
32 #include <server/server.h>
34 #include <stdarg.h>
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
44 int debug_level = -1;
46 static FILE* log_output;
47 static struct log_callback *log_callbacks = NULL;
49 static long long last_time;
50 static long long current_time;
52 static long long start;
54 static char *log_strings[5] =
56 "User : ",
57 "Error: ",
58 "Warn : ", /* want a space after each colon, all same width, colons aligned */
59 "Info : ",
60 "Debug: "
64 static int count = 0;
67 static struct store_log_forward * log_head = NULL;
68 static int log_forward_count = 0;
70 struct store_log_forward
72 struct store_log_forward * next;
73 const char * file;
74 int line;
75 const char * function;
76 const char * string;
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)
82 if (log_forward_count==0)
84 struct log_callback *cb, *next;
85 cb = log_callbacks;
86 /* DANGER!!!! the log callback can remove itself!!!! */
87 while (cb)
89 next = cb->next;
90 cb->fn(cb->priv, file, line, function, string);
91 cb = next;
93 } else
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
105 /* append to tail */
106 struct store_log_forward * t;
107 t = log_head;
108 while (t->next!=NULL)
110 t = t->next;
112 t->next = log;
117 /* The log_puts() serves to somewhat different goals:
119 * - logging
120 * - feeding low-level info to the user in GDB or Telnet
122 * The latter dictates that strings without newline are not logged, lest there
123 * will be *MANY log lines when sending one char at the time(e.g.
124 * target_request.c).
127 static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string)
129 char *f;
130 if (level == LOG_LVL_OUTPUT)
132 /* do not prepend any headers, just print out what we were given and return */
133 fputs(string, log_output);
134 fflush(log_output);
135 return;
138 f = strrchr(file, '/');
139 if (f != NULL)
140 file = f + 1;
142 if (strlen(string) > 0)
144 if (debug_level >= LOG_LVL_DEBUG)
146 /* print with count and time information */
147 int t = (int)(timeval_ms()-start);
148 #ifdef _DEBUG_FREE_SPACE_
149 struct mallinfo info;
150 info = mallinfo();
151 #endif
152 fprintf(log_output, "%s%d %d %s:%d %s()"
153 #ifdef _DEBUG_FREE_SPACE_
154 " %d"
155 #endif
156 ": %s", log_strings[level + 1], count, t, file, line, function,
157 #ifdef _DEBUG_FREE_SPACE_
158 info.fordblks,
159 #endif
160 string);
162 else
164 /* if we are using gdb through pipes then we do not want any output
165 * to the pipe otherwise we get repeated strings */
166 fprintf(log_output, "%s%s",
167 (level > LOG_LVL_USER)?log_strings[level + 1]:"", string);
169 } else
171 /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do nothing. */
174 fflush(log_output);
176 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
177 if (level <= LOG_LVL_INFO)
179 log_forward(file, line, function, string);
184 void log_printf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format, ...)
186 char *string;
187 va_list ap;
189 count++;
190 if (level > debug_level)
191 return;
193 va_start(ap, format);
195 string = alloc_vprintf(format, ap);
196 if (string != NULL)
198 log_puts(level, file, line, function, string);
199 free(string);
202 va_end(ap);
205 void log_printf_lf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format, ...)
207 char *string;
208 va_list ap;
210 count++;
211 if (level > debug_level)
212 return;
214 va_start(ap, format);
216 string = alloc_vprintf(format, ap);
217 if (string != NULL)
219 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
220 log_puts(level, file, line, function, string);
221 free(string);
224 va_end(ap);
227 COMMAND_HANDLER(handle_debug_level_command)
229 if (CMD_ARGC == 1)
231 int new_level;
232 COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], new_level);
233 if ((debug_level > LOG_LVL_DEBUG) || (new_level < LOG_LVL_SILENT))
235 LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT, LOG_LVL_DEBUG);
236 return ERROR_COMMAND_SYNTAX_ERROR;
238 debug_level = new_level;
240 else if (CMD_ARGC > 1)
241 return ERROR_COMMAND_SYNTAX_ERROR;
243 command_print(CMD_CTX, "debug_level: %i", debug_level);
245 return ERROR_OK;
248 COMMAND_HANDLER(handle_log_output_command)
250 if (CMD_ARGC == 1)
252 FILE* file = fopen(CMD_ARGV[0], "w");
254 if (file)
256 log_output = file;
260 return ERROR_OK;
263 static struct command_registration log_command_handlers[] = {
265 .name = "log_output",
266 .handler = handle_log_output_command,
267 .mode = COMMAND_ANY,
268 .help = "redirect logging to a file (default: stderr)",
269 .usage = "file_name",
272 .name = "debug_level",
273 .handler = handle_debug_level_command,
274 .mode = COMMAND_ANY,
275 .help = "Sets the verbosity level of debugging output. "
276 "0 shows errors only; 1 adds warnings; "
277 "2 (default) adds other info; 3 adds debugging.",
278 .usage = "number",
280 COMMAND_REGISTRATION_DONE
283 int log_register_commands(struct command_context *cmd_ctx)
285 return register_commands(cmd_ctx, NULL, log_command_handlers);
288 void log_init(void)
290 /* set defaults for daemon configuration,
291 * if not set by cmdline or cfgfile */
292 if (debug_level == -1)
293 debug_level = LOG_LVL_INFO;
295 char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
296 if (NULL != debug_env)
298 int value;
299 int retval = parse_int(debug_env, &value);
300 if (ERROR_OK == retval &&
301 debug_level >= LOG_LVL_SILENT &&
302 debug_level <= LOG_LVL_DEBUG)
304 debug_level = value;
308 if (log_output == NULL)
309 log_output = stderr;
311 start = last_time = timeval_ms();
314 int set_log_output(struct command_context *cmd_ctx, FILE *output)
316 log_output = output;
317 return ERROR_OK;
320 /* add/remove log callback handler */
321 int log_add_callback(log_callback_fn fn, void *priv)
323 struct log_callback *cb;
325 /* prevent the same callback to be registered more than once, just for sure */
326 for (cb = log_callbacks; cb; cb = cb->next)
328 if (cb->fn == fn && cb->priv == priv)
329 return ERROR_COMMAND_SYNTAX_ERROR;
332 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
333 if ((cb = malloc(sizeof(struct log_callback))) == NULL)
334 return ERROR_BUF_TOO_SMALL;
336 /* add item to the beginning of the linked list */
337 cb->fn = fn;
338 cb->priv = priv;
339 cb->next = log_callbacks;
340 log_callbacks = cb;
342 return ERROR_OK;
345 int log_remove_callback(log_callback_fn fn, void *priv)
347 struct log_callback *cb, **p;
349 for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
351 if (cb->fn == fn && cb->priv == priv)
353 *p = cb->next;
354 free(cb);
355 return ERROR_OK;
359 /* no such item */
360 return ERROR_COMMAND_SYNTAX_ERROR;
363 /* return allocated string w/printf() result */
364 char *alloc_vprintf(const char *fmt, va_list ap)
366 va_list ap_copy;
367 int len;
368 char *string;
370 /* determine the length of the buffer needed */
371 va_copy(ap_copy, ap);
372 len = vsnprintf(NULL, 0, fmt, ap_copy);
373 va_end(ap_copy);
375 /* allocate and make room for terminating zero. */
376 /* FIXME: The old version always allocated at least one byte extra and
377 * other code depend on that. They should be probably be fixed, but for
378 * now reserve the extra byte. */
379 string = malloc(len + 2);
380 if (string == NULL)
381 return NULL;
383 /* do the real work */
384 vsnprintf(string, len + 1, fmt, ap);
386 return string;
389 char *alloc_printf(const char *format, ...)
391 char *string;
392 va_list ap;
393 va_start(ap, format);
394 string = alloc_vprintf(format, ap);
395 va_end(ap);
396 return string;
399 /* Code must return to the server loop before 1000ms has returned or invoke
400 * this function.
402 * The GDB connection will time out if it spends >2000ms and you'll get nasty
403 * error messages from GDB:
405 * Ignoring packet error, continuing...
406 * Reply contains invalid hex digit 116
408 * While it is possible use "set remotetimeout" to more than the default 2000ms
409 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
410 * GDB protocol and it is a bug in OpenOCD not to either return to the server
411 * loop or invoke keep_alive() every 1000ms.
413 * This function will send a keep alive packet if >500ms has passed since last time
414 * it was invoked.
416 * Note that this function can be invoked often, so it needs to be relatively
417 * fast when invoked more often than every 500ms.
420 void keep_alive()
422 current_time = timeval_ms();
423 if (current_time-last_time > 1000)
425 extern int gdb_actual_connections;
427 if (gdb_actual_connections)
428 LOG_WARNING("keep_alive() was not invoked in the "
429 "1000ms timelimit. GDB alive packet not "
430 "sent! (%lld). Workaround: increase "
431 "\"set remotetimeout\" in GDB",
432 current_time-last_time);
433 else
434 LOG_DEBUG("keep_alive() was not invoked in the "
435 "1000ms timelimit (%lld). This may cause "
436 "trouble with GDB connections.",
437 current_time-last_time);
439 if (current_time-last_time > 500)
441 /* this will keep the GDB connection alive */
442 LOG_USER_N("%s", "");
444 /* DANGER!!!! do not add code to invoke e.g. target event processing,
445 * jim timer processing, etc. it can cause infinite recursion +
446 * jim event callbacks need to happen at a well defined time,
447 * not anywhere keep_alive() is invoked.
449 * These functions should be invoked at a well defined spot in server.c
452 last_time = current_time;
456 /* reset keep alive timer without sending message */
457 void kept_alive()
459 current_time = timeval_ms();
460 last_time = current_time;
463 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
464 void alive_sleep(uint64_t ms)
466 uint64_t napTime = 10;
467 for (uint64_t i = 0; i < ms; i += napTime)
469 uint64_t sleep_a_bit = ms - i;
470 if (sleep_a_bit > napTime)
471 sleep_a_bit = napTime;
473 usleep(sleep_a_bit * 1000);
474 keep_alive();
478 void busy_sleep(uint64_t ms)
480 uint64_t then = timeval_ms();
481 while (timeval_ms() - then < ms)
483 /* busy wait */