1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Ø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, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
30 #include "time_support.h"
31 // @todo the inclusion of server.h here is a layering violation
32 #include <server/server.h>
36 #ifdef _DEBUG_FREE_SPACE_
40 #error "malloc.h is required to use --enable-malloc-logging"
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] =
58 "Warn : ", /* want a space after each colon, all same width, colons aligned */
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
;
75 const char * function
;
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
;
86 /* DANGER!!!! the log callback can remove itself!!!! */
90 cb
->fn(cb
->priv
, file
, line
, function
, string
);
95 struct store_log_forward
*log
= malloc(sizeof (struct store_log_forward
));
96 log
->file
= strdup(file
);
98 log
->function
= strdup(function
);
99 log
->string
= strdup(string
);
106 struct store_log_forward
* t
;
108 while (t
->next
!=NULL
)
117 /* The log_puts() serves to somewhat different goals:
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.
127 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
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
);
138 f
= strrchr(file
, '/');
142 if (strchr(string
, '\n') != NULL
)
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
;
152 fprintf(log_output
, "%s%d %d %s:%d %s()"
153 #ifdef _DEBUG_FREE_SPACE_
156 ": %s", log_strings
[level
+ 1], count
, t
, file
, line
, function
,
157 #ifdef _DEBUG_FREE_SPACE_
162 else if (server_use_pipes
== 0)
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 if (strcmp(string
, "\n") != 0)
168 /* print human readable output - but skip empty lines */
169 fprintf(log_output
, "%s%s",
170 (level
> LOG_LVL_USER
)?log_strings
[level
+ 1]:"", string
);
175 /* only entire lines are logged. Otherwise it's
176 * single chars intended for the log callbacks. */
181 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
182 if (level
<= LOG_LVL_INFO
)
184 log_forward(file
, line
, function
, string
);
189 void log_printf(enum log_levels level
, const char *file
, unsigned line
, const char *function
, const char *format
, ...)
195 if (level
> debug_level
)
198 va_start(ap
, format
);
200 string
= alloc_vprintf(format
, ap
);
203 log_puts(level
, file
, line
, function
, string
);
210 void log_printf_lf(enum log_levels level
, const char *file
, unsigned line
, const char *function
, const char *format
, ...)
216 if (level
> debug_level
)
219 va_start(ap
, format
);
221 string
= alloc_vprintf(format
, ap
);
224 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
225 log_puts(level
, file
, line
, function
, string
);
232 /* change the current debug level on the fly
235 * 2: + INFORMATIONAL MSGS
238 COMMAND_HANDLER(handle_debug_level_command
)
243 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], new_level
);
244 debug_level
= MIN(new_level
, LOG_LVL_DEBUG
);
246 else if (CMD_ARGC
> 1)
247 return ERROR_COMMAND_SYNTAX_ERROR
;
249 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
251 /* if we are enabling debug info then we need to write to a
252 * log file otherwise the pipe will get full and cause issues
255 FILE* file
= fopen("openocd.log", "w");
259 LOG_WARNING("enabling logfile output because "
260 "we are using pipes to talk to GDB.");
264 command_print(CMD_CTX
, "debug_level: %i", debug_level
);
269 COMMAND_HANDLER(handle_log_output_command
)
273 FILE* file
= fopen(CMD_ARGV
[0], "w");
284 static struct command_registration log_command_handlers
[] = {
286 .name
= "log_output",
287 .handler
= handle_log_output_command
,
289 .help
= "redirect logging to a file (default: stderr)",
290 .usage
= "file_name",
293 .name
= "debug_level",
294 .handler
= handle_debug_level_command
,
296 .help
= "Sets the verbosity level of debugging output. "
297 "0 shows errors only; 1 adds warnings; "
298 "2 (default) adds other info; 3 adds debugging.",
301 COMMAND_REGISTRATION_DONE
304 int log_register_commands(struct command_context
*cmd_ctx
)
306 return register_commands(cmd_ctx
, NULL
, log_command_handlers
);
311 /* set defaults for daemon configuration,
312 * if not set by cmdline or cfgfile */
313 if (debug_level
== -1)
314 debug_level
= LOG_LVL_INFO
;
316 char *debug_env
= getenv("OPENOCD_DEBUG_LEVEL");
317 if (NULL
!= debug_env
)
320 int retval
= parse_int(debug_env
, &value
);
321 if (ERROR_OK
== retval
&&
322 debug_level
>= LOG_LVL_SILENT
&&
323 debug_level
<= LOG_LVL_DEBUG
)
329 if (log_output
== NULL
)
332 start
= last_time
= timeval_ms();
335 int set_log_output(struct command_context
*cmd_ctx
, FILE *output
)
341 /* add/remove log callback handler */
342 int log_add_callback(log_callback_fn fn
, void *priv
)
344 struct log_callback
*cb
;
346 /* prevent the same callback to be registered more than once, just for sure */
347 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
349 if (cb
->fn
== fn
&& cb
->priv
== priv
)
350 return ERROR_INVALID_ARGUMENTS
;
353 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
354 if ((cb
= malloc(sizeof(struct log_callback
))) == NULL
)
355 return ERROR_BUF_TOO_SMALL
;
357 /* add item to the beginning of the linked list */
360 cb
->next
= log_callbacks
;
366 int log_remove_callback(log_callback_fn fn
, void *priv
)
368 struct log_callback
*cb
, **p
;
370 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
372 if (cb
->fn
== fn
&& cb
->priv
== priv
)
381 return ERROR_INVALID_ARGUMENTS
;
384 /* return allocated string w/printf() result */
385 char *alloc_vprintf(const char *fmt
, va_list ap
)
391 /* determine the length of the buffer needed */
392 va_copy(ap_copy
, ap
);
393 len
= vsnprintf(NULL
, 0, fmt
, ap_copy
);
396 /* allocate and make room for terminating zero. */
397 /* FIXME: The old version always allocated at least one byte extra and
398 * other code depend on that. They should be probably be fixed, but for
399 * now reserve the extra byte. */
400 string
= malloc(len
+ 2);
404 /* do the real work */
405 vsnprintf(string
, len
+ 1, fmt
, ap
);
410 char *alloc_printf(const char *format
, ...)
414 va_start(ap
, format
);
415 string
= alloc_vprintf(format
, ap
);
420 /* Code must return to the server loop before 1000ms has returned or invoke
423 * The GDB connection will time out if it spends >2000ms and you'll get nasty
424 * error messages from GDB:
426 * Ignoring packet error, continuing...
427 * Reply contains invalid hex digit 116
429 * While it is possible use "set remotetimeout" to more than the default 2000ms
430 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
431 * GDB protocol and it is a bug in OpenOCD not to either return to the server
432 * loop or invoke keep_alive() every 1000ms.
434 * This function will send a keep alive packet if >500ms has passed since last time
437 * Note that this function can be invoked often, so it needs to be relatively
438 * fast when invoked more often than every 500ms.
443 current_time
= timeval_ms();
444 if (current_time
-last_time
> 1000)
446 extern int gdb_actual_connections
;
448 if (gdb_actual_connections
)
449 LOG_WARNING("keep_alive() was not invoked in the "
450 "1000ms timelimit. GDB alive packet not "
451 "sent! (%lld). Workaround: increase "
452 "\"set remotetimeout\" in GDB",
453 current_time
-last_time
);
455 LOG_DEBUG("keep_alive() was not invoked in the "
456 "1000ms timelimit (%lld). This may cause "
457 "trouble with GDB connections.",
458 current_time
-last_time
);
460 if (current_time
-last_time
> 500)
462 /* this will keep the GDB connection alive */
463 LOG_USER_N("%s", "");
465 /* DANGER!!!! do not add code to invoke e.g. target event processing,
466 * jim timer processing, etc. it can cause infinite recursion +
467 * jim event callbacks need to happen at a well defined time,
468 * not anywhere keep_alive() is invoked.
470 * These functions should be invoked at a well defined spot in server.c
473 last_time
= current_time
;
477 /* reset keep alive timer without sending message */
480 current_time
= timeval_ms();
481 last_time
= current_time
;
484 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
485 void alive_sleep(uint64_t ms
)
487 uint64_t napTime
= 10;
488 for (uint64_t i
= 0; i
< ms
; i
+= napTime
)
490 uint64_t sleep_a_bit
= ms
- i
;
491 if (sleep_a_bit
> napTime
)
492 sleep_a_bit
= napTime
;
494 usleep(sleep_a_bit
* 1000);
499 void busy_sleep(uint64_t ms
)
501 uint64_t then
= timeval_ms();
502 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)