1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
25 #include "configuration.h"
26 #include "time_support.h"
40 static FILE* log_output
;
41 static log_callback_t
*log_callbacks
= NULL
;
43 static long long last_time
;
44 static long long current_time
;
46 static long long start
;
48 static char *log_strings
[5] =
59 /* The log_puts() serves to somewhat different goals:
62 * - feeding low-level info to the user in GDB or Telnet
64 * The latter dictates that strings without newline are not logged, lest there
65 * will be *MANY log lines when sending one char at the time(e.g.
69 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
72 if (level
== LOG_LVL_OUTPUT
)
74 /* do not prepend any headers, just print out what we were given and return */
75 fputs(string
, log_output
);
80 f
= strrchr(file
, '/');
84 if (strchr(string
, '\n')!=NULL
)
86 if (debug_level
>= LOG_LVL_DEBUG
)
88 /* print with count and time information */
89 int t
=(int)(timeval_ms()-start
);
94 fprintf(log_output
, "%s %d %d %s:%d %s()"
98 ": %s", log_strings
[level
+1], count
, t
, file
, line
, function
,
106 /* do not print count and time */
107 fprintf(log_output
, "%s %s:%d %s(): %s", log_strings
[level
+1], file
, line
, function
, string
);
111 /* only entire lines are logged. Otherwise it's
112 * single chars intended for the log callbacks. */
117 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
118 if (level
<= LOG_LVL_INFO
)
120 log_callback_t
*cb
, *next
;
122 /* DANGER!!!! the log callback can remove itself!!!! */
126 cb
->fn(cb
->priv
, file
, line
, function
, string
);
132 void log_printf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
138 if (level
> debug_level
)
141 va_start(ap
, format
);
143 string
= alloc_vprintf(format
, ap
);
146 log_puts(level
, file
, line
, function
, string
);
153 void log_printf_lf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
159 if (level
> debug_level
)
162 va_start(ap
, format
);
164 string
= alloc_vprintf(format
, ap
);
167 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
168 log_puts(level
, file
, line
, function
, string
);
175 /* change the current debug level on the fly
178 * 2: + INFORMATIONAL MSGS
181 int handle_debug_level_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
184 command_print(cmd_ctx
, "debug_level: %i", debug_level
);
187 debug_level
= strtoul(args
[0], NULL
, 0);
198 int handle_log_output_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
202 FILE* file
= fopen(args
[0], "w");
213 int log_register_commands(struct command_context_s
*cmd_ctx
)
215 start
= timeval_ms();
216 register_command(cmd_ctx
, NULL
, "log_output", handle_log_output_command
,
217 COMMAND_ANY
, "redirect logging to <file> (default: stderr)");
218 register_command(cmd_ctx
, NULL
, "debug_level", handle_debug_level_command
,
219 COMMAND_ANY
, "adjust debug level <0-3>");
224 int log_init(struct command_context_s
*cmd_ctx
)
226 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
227 if (debug_level
== -1)
228 debug_level
= LOG_LVL_INFO
;
230 if (log_output
== NULL
)
235 start
=last_time
=timeval_ms();
240 int set_log_output(struct command_context_s
*cmd_ctx
, FILE *output
)
246 /* add/remove log callback handler */
247 int log_add_callback(log_callback_fn fn
, void *priv
)
251 /* prevent the same callback to be registered more than once, just for sure */
252 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
254 if (cb
->fn
== fn
&& cb
->priv
== priv
)
255 return ERROR_INVALID_ARGUMENTS
;
258 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
259 if ((cb
= malloc(sizeof(log_callback_t
))) == NULL
)
260 return ERROR_BUF_TOO_SMALL
;
262 /* add item to the beginning of the linked list */
265 cb
->next
= log_callbacks
;
271 int log_remove_callback(log_callback_fn fn
, void *priv
)
273 log_callback_t
*cb
, **p
;
275 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
277 if (cb
->fn
== fn
&& cb
->priv
== priv
)
286 return ERROR_INVALID_ARGUMENTS
;
289 /* return allocated string w/printf() result */
290 char *alloc_vprintf(const char *fmt
, va_list ap
)
292 /* no buffer at the beginning, force realloc to do the job */
295 /* start with buffer size suitable for typical messages */
303 string
= realloc(string
, size
);
311 va_copy(ap_copy
, ap
);
313 ret
= vsnprintf(string
, size
, fmt
, ap_copy
);
314 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
315 if ((ret
>= 0) && ((ret
+ 1) < size
))
318 /* there was just enough or not enough space, allocate more in the next round */
319 size
*= 2; /* double the buffer size */
322 /* the returned buffer is by principle guaranteed to be at least one character longer */
326 char *alloc_printf(const char *format
, ...)
330 va_start(ap
, format
);
331 string
= alloc_vprintf(format
, ap
);
336 /* Code must return to the server loop before 1000ms has returned or invoke
339 * The GDB connection will time out if it spends >2000ms and you'll get nasty
340 * error messages from GDB:
342 * Ignoring packet error, continuing...
343 * Reply contains invalid hex digit 116
345 * While it is possible use "set remotetimeout" to more than the default 2000ms
346 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
347 * GDB protocol and it is a bug in OpenOCD not to either return to the server
348 * loop or invoke keep_alive() every 1000ms.
350 * This function will send a keep alive packet if >500ms has passed since last time
356 current_time
=timeval_ms();
357 if (current_time
-last_time
>1000)
359 LOG_WARNING("keep_alive() was not invoked in the 1000ms timelimit. GDB alive packet not sent! (%d)", current_time
-last_time
);
360 last_time
=current_time
;
361 } else if (current_time
-last_time
>500)
363 /* this will keep the GDB connection alive */
364 LOG_USER_N("%s", "");
365 last_time
=current_time
;
369 /* reset keep alive timer without sending message */
372 current_time
=timeval_ms();
373 last_time
=current_time
;