1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
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. *
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. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
31 #include "time_support.h"
35 #ifdef _DEBUG_FREE_SPACE_
39 #error "malloc.h is required to use --enable-malloc-logging"
45 static FILE *log_output
;
46 static struct log_callback
*log_callbacks
;
48 static int64_t last_time
;
49 static int64_t current_time
;
53 static const char * const log_strings
[6] = {
56 "Warn : ", /* want a space after each colon, all same width, colons aligned */
64 static struct store_log_forward
*log_head
;
65 static int log_forward_count
;
67 struct store_log_forward
{
68 struct store_log_forward
*next
;
75 /* either forward the log to the listeners or store it for possible forwarding later */
76 static void log_forward(const char *file
, unsigned line
, const char *function
, const char *string
)
78 if (log_forward_count
== 0) {
79 struct log_callback
*cb
, *next
;
81 /* DANGER!!!! the log callback can remove itself!!!! */
84 cb
->fn(cb
->priv
, file
, line
, function
, string
);
88 struct store_log_forward
*log
= malloc(sizeof(struct store_log_forward
));
89 log
->file
= strdup(file
);
91 log
->function
= strdup(function
);
92 log
->string
= strdup(string
);
98 struct store_log_forward
*t
;
100 while (t
->next
!= NULL
)
107 /* The log_puts() serves two somewhat different goals:
110 * - feeding low-level info to the user in GDB or Telnet
112 * The latter dictates that strings without newline are not logged, lest there
113 * will be *MANY log lines when sending one char at the time(e.g.
117 static void log_puts(enum log_levels level
,
120 const char *function
,
124 if (level
== LOG_LVL_OUTPUT
) {
125 /* do not prepend any headers, just print out what we were given and return */
126 fputs(string
, log_output
);
131 f
= strrchr(file
, '/');
135 if (strlen(string
) > 0) {
136 if (debug_level
>= LOG_LVL_DEBUG
) {
137 /* print with count and time information */
138 int64_t t
= timeval_ms() - start
;
139 #ifdef _DEBUG_FREE_SPACE_
140 struct mallinfo info
;
143 fprintf(log_output
, "%s%d %" PRId64
" %s:%d %s()"
144 #ifdef _DEBUG_FREE_SPACE_
147 ": %s", log_strings
[level
+ 1], count
, t
, file
, line
, function
,
148 #ifdef _DEBUG_FREE_SPACE_
153 /* if we are using gdb through pipes then we do not want any output
154 * to the pipe otherwise we get repeated strings */
155 fprintf(log_output
, "%s%s",
156 (level
> LOG_LVL_USER
) ? log_strings
[level
+ 1] : "", string
);
159 /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
165 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
166 if (level
<= LOG_LVL_INFO
)
167 log_forward(file
, line
, function
, string
);
170 void log_printf(enum log_levels level
,
173 const char *function
,
181 if (level
> debug_level
)
184 va_start(ap
, format
);
186 string
= alloc_vprintf(format
, ap
);
187 if (string
!= NULL
) {
188 log_puts(level
, file
, line
, function
, string
);
195 void log_vprintf_lf(enum log_levels level
, const char *file
, unsigned line
,
196 const char *function
, const char *format
, va_list args
)
202 if (level
> debug_level
)
205 tmp
= alloc_vprintf(format
, args
);
211 * Note: alloc_vprintf() guarantees that the buffer is at least one
215 log_puts(level
, file
, line
, function
, tmp
);
219 void log_printf_lf(enum log_levels level
,
222 const char *function
,
228 va_start(ap
, format
);
229 log_vprintf_lf(level
, file
, line
, function
, format
, ap
);
233 COMMAND_HANDLER(handle_debug_level_command
)
237 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], new_level
);
238 if ((new_level
> LOG_LVL_DEBUG_IO
) || (new_level
< LOG_LVL_SILENT
)) {
239 LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT
, LOG_LVL_DEBUG_IO
);
240 return ERROR_COMMAND_SYNTAX_ERROR
;
242 debug_level
= new_level
;
243 } else if (CMD_ARGC
> 1)
244 return ERROR_COMMAND_SYNTAX_ERROR
;
246 command_print(CMD_CTX
, "debug_level: %i", debug_level
);
251 COMMAND_HANDLER(handle_log_output_command
)
254 FILE *file
= fopen(CMD_ARGV
[0], "w");
256 LOG_ERROR("failed to open output log '%s'", CMD_ARGV
[0]);
259 if (log_output
!= stderr
&& log_output
!= NULL
) {
260 /* Close previous log file, if it was open and wasn't stderr. */
269 static struct command_registration log_command_handlers
[] = {
271 .name
= "log_output",
272 .handler
= handle_log_output_command
,
274 .help
= "redirect logging to a file (default: stderr)",
275 .usage
= "file_name",
278 .name
= "debug_level",
279 .handler
= handle_debug_level_command
,
281 .help
= "Sets the verbosity level of debugging output. "
282 "0 shows errors only; 1 adds warnings; "
283 "2 (default) adds other info; 3 adds debugging; "
284 "4 adds extra verbose debugging.",
287 COMMAND_REGISTRATION_DONE
290 int log_register_commands(struct command_context
*cmd_ctx
)
292 return register_commands(cmd_ctx
, NULL
, log_command_handlers
);
297 /* set defaults for daemon configuration,
298 * if not set by cmdline or cfgfile */
299 if (debug_level
== -1)
300 debug_level
= LOG_LVL_INFO
;
302 char *debug_env
= getenv("OPENOCD_DEBUG_LEVEL");
303 if (NULL
!= debug_env
) {
305 int retval
= parse_int(debug_env
, &value
);
306 if (ERROR_OK
== retval
&&
307 debug_level
>= LOG_LVL_SILENT
&&
308 debug_level
<= LOG_LVL_DEBUG_IO
)
312 if (log_output
== NULL
)
315 start
= last_time
= timeval_ms();
318 int set_log_output(struct command_context
*cmd_ctx
, FILE *output
)
324 /* add/remove log callback handler */
325 int log_add_callback(log_callback_fn fn
, void *priv
)
327 struct log_callback
*cb
;
329 /* prevent the same callback to be registered more than once, just for sure */
330 for (cb
= log_callbacks
; cb
; cb
= cb
->next
) {
331 if (cb
->fn
== fn
&& cb
->priv
== priv
)
332 return ERROR_COMMAND_SYNTAX_ERROR
;
335 /* alloc memory, it is safe just to return in case of an error, no need for the caller to
337 cb
= malloc(sizeof(struct log_callback
));
339 return ERROR_BUF_TOO_SMALL
;
341 /* add item to the beginning of the linked list */
344 cb
->next
= log_callbacks
;
350 int log_remove_callback(log_callback_fn fn
, void *priv
)
352 struct log_callback
*cb
, **p
;
354 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
) {
355 if (cb
->fn
== fn
&& cb
->priv
== priv
) {
363 return ERROR_COMMAND_SYNTAX_ERROR
;
366 /* return allocated string w/printf() result */
367 char *alloc_vprintf(const char *fmt
, va_list ap
)
373 /* determine the length of the buffer needed */
374 va_copy(ap_copy
, ap
);
375 len
= vsnprintf(NULL
, 0, fmt
, ap_copy
);
378 /* allocate and make room for terminating zero. */
379 /* FIXME: The old version always allocated at least one byte extra and
380 * other code depend on that. They should be probably be fixed, but for
381 * now reserve the extra byte. */
382 string
= malloc(len
+ 2);
386 /* do the real work */
387 vsnprintf(string
, len
+ 1, fmt
, ap
);
392 char *alloc_printf(const char *format
, ...)
396 va_start(ap
, format
);
397 string
= alloc_vprintf(format
, ap
);
402 /* Code must return to the server loop before 1000ms has returned or invoke
405 * The GDB connection will time out if it spends >2000ms and you'll get nasty
406 * error messages from GDB:
408 * Ignoring packet error, continuing...
409 * Reply contains invalid hex digit 116
411 * While it is possible use "set remotetimeout" to more than the default 2000ms
412 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
413 * GDB protocol and it is a bug in OpenOCD not to either return to the server
414 * loop or invoke keep_alive() every 1000ms.
416 * This function will send a keep alive packet if >500ms has passed since last time
419 * Note that this function can be invoked often, so it needs to be relatively
420 * fast when invoked more often than every 500ms.
425 current_time
= timeval_ms();
426 if (current_time
-last_time
> 1000) {
427 extern int gdb_actual_connections
;
429 if (gdb_actual_connections
)
430 LOG_WARNING("keep_alive() was not invoked in the "
431 "1000ms timelimit. GDB alive packet not "
432 "sent! (%" PRId64
"). Workaround: increase "
433 "\"set remotetimeout\" in GDB",
434 current_time
-last_time
);
436 LOG_DEBUG("keep_alive() was not invoked in the "
437 "1000ms timelimit (%" PRId64
"). This may cause "
438 "trouble with GDB connections.",
439 current_time
-last_time
);
441 if (current_time
-last_time
> 500) {
442 /* this will keep the GDB connection alive */
443 LOG_USER_N("%s", "");
445 /* DANGER!!!! do not add code to invoke e.g. target event processing,
446 * jim timer processing, etc. it can cause infinite recursion +
447 * jim event callbacks need to happen at a well defined time,
448 * not anywhere keep_alive() is invoked.
450 * These functions should be invoked at a well defined spot in server.c
453 last_time
= current_time
;
457 /* reset keep alive timer without sending message */
460 current_time
= timeval_ms();
461 last_time
= current_time
;
464 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
465 void alive_sleep(uint64_t ms
)
467 uint64_t napTime
= 10;
468 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);
478 void busy_sleep(uint64_t ms
)
480 uint64_t then
= timeval_ms();
481 while (timeval_ms() - then
< ms
) {
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)