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 "replacements.h"
32 #include "time_support.h"
36 #ifdef _DEBUG_FREE_SPACE_
40 #error "malloc.h is required to use --enable-malloc-logging"
44 int debug_level
= LOG_LVL_INFO
;
46 static FILE *log_output
;
47 static struct log_callback
*log_callbacks
;
49 static int64_t last_time
;
53 static const char * const log_strings
[6] = {
56 "Warn : ", /* want a space after each colon, all same width, colons aligned */
64 /* forward the log to the listeners */
65 static void log_forward(const char *file
, unsigned line
, const char *function
, const char *string
)
67 struct log_callback
*cb
, *next
;
69 /* DANGER!!!! the log callback can remove itself!!!! */
72 cb
->fn(cb
->priv
, file
, line
, function
, string
);
77 /* The log_puts() serves two somewhat different goals:
80 * - feeding low-level info to the user in GDB or Telnet
82 * The latter dictates that strings without newline are not logged, lest there
83 * will be *MANY log lines when sending one char at the time(e.g.
87 static void log_puts(enum log_levels level
,
96 /* log_init() not called yet; print on stderr */
97 fputs(string
, stderr
);
102 if (level
== LOG_LVL_OUTPUT
) {
103 /* do not prepend any headers, just print out what we were given and return */
104 fputs(string
, log_output
);
109 f
= strrchr(file
, '/');
113 if (strlen(string
) > 0) {
114 if (debug_level
>= LOG_LVL_DEBUG
) {
115 /* print with count and time information */
116 int64_t t
= timeval_ms() - start
;
117 #ifdef _DEBUG_FREE_SPACE_
118 struct mallinfo info
;
121 fprintf(log_output
, "%s%d %" PRId64
" %s:%d %s()"
122 #ifdef _DEBUG_FREE_SPACE_
125 ": %s", log_strings
[level
+ 1], count
, t
, file
, line
, function
,
126 #ifdef _DEBUG_FREE_SPACE_
131 /* if we are using gdb through pipes then we do not want any output
132 * to the pipe otherwise we get repeated strings */
133 fprintf(log_output
, "%s%s",
134 (level
> LOG_LVL_USER
) ? log_strings
[level
+ 1] : "", string
);
137 /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
143 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
144 if (level
<= LOG_LVL_INFO
)
145 log_forward(file
, line
, function
, string
);
148 void log_printf(enum log_levels level
,
151 const char *function
,
159 if (level
> debug_level
)
162 va_start(ap
, format
);
164 string
= alloc_vprintf(format
, ap
);
166 log_puts(level
, file
, line
, function
, string
);
173 void log_vprintf_lf(enum log_levels level
, const char *file
, unsigned line
,
174 const char *function
, const char *format
, va_list args
)
180 if (level
> debug_level
)
183 tmp
= alloc_vprintf(format
, args
);
189 * Note: alloc_vprintf() guarantees that the buffer is at least one
193 log_puts(level
, file
, line
, function
, tmp
);
197 void log_printf_lf(enum log_levels level
,
200 const char *function
,
206 va_start(ap
, format
);
207 log_vprintf_lf(level
, file
, line
, function
, format
, ap
);
211 COMMAND_HANDLER(handle_debug_level_command
)
215 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], new_level
);
216 if ((new_level
> LOG_LVL_DEBUG_IO
) || (new_level
< LOG_LVL_SILENT
)) {
217 LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT
, LOG_LVL_DEBUG_IO
);
218 return ERROR_COMMAND_SYNTAX_ERROR
;
220 debug_level
= new_level
;
221 } else if (CMD_ARGC
> 1)
222 return ERROR_COMMAND_SYNTAX_ERROR
;
224 command_print(CMD
, "debug_level: %i", debug_level
);
229 COMMAND_HANDLER(handle_log_output_command
)
231 if (CMD_ARGC
== 0 || (CMD_ARGC
== 1 && strcmp(CMD_ARGV
[0], "default") == 0)) {
232 if (log_output
!= stderr
&& log_output
) {
233 /* Close previous log file, if it was open and wasn't stderr. */
237 LOG_DEBUG("set log_output to default");
241 FILE *file
= fopen(CMD_ARGV
[0], "w");
243 LOG_ERROR("failed to open output log '%s'", CMD_ARGV
[0]);
246 if (log_output
!= stderr
&& log_output
) {
247 /* Close previous log file, if it was open and wasn't stderr. */
251 LOG_DEBUG("set log_output to \"%s\"", CMD_ARGV
[0]);
255 return ERROR_COMMAND_SYNTAX_ERROR
;
258 static const struct command_registration log_command_handlers
[] = {
260 .name
= "log_output",
261 .handler
= handle_log_output_command
,
263 .help
= "redirect logging to a file (default: stderr)",
264 .usage
= "[file_name | \"default\"]",
267 .name
= "debug_level",
268 .handler
= handle_debug_level_command
,
270 .help
= "Sets the verbosity level of debugging output. "
271 "0 shows errors only; 1 adds warnings; "
272 "2 (default) adds other info; 3 adds debugging; "
273 "4 adds extra verbose debugging.",
276 COMMAND_REGISTRATION_DONE
279 int log_register_commands(struct command_context
*cmd_ctx
)
281 return register_commands(cmd_ctx
, NULL
, log_command_handlers
);
286 /* set defaults for daemon configuration,
287 * if not set by cmdline or cfgfile */
288 char *debug_env
= getenv("OPENOCD_DEBUG_LEVEL");
291 int retval
= parse_int(debug_env
, &value
);
292 if (retval
== ERROR_OK
&&
293 debug_level
>= LOG_LVL_SILENT
&&
294 debug_level
<= LOG_LVL_DEBUG_IO
)
301 start
= last_time
= timeval_ms();
306 if (log_output
&& log_output
!= stderr
) {
307 /* Close log file, if it was open and wasn't stderr. */
313 int set_log_output(struct command_context
*cmd_ctx
, FILE *output
)
319 /* add/remove log callback handler */
320 int log_add_callback(log_callback_fn fn
, void *priv
)
322 struct log_callback
*cb
;
324 /* prevent the same callback to be registered more than once, just for sure */
325 for (cb
= log_callbacks
; cb
; cb
= cb
->next
) {
326 if (cb
->fn
== fn
&& cb
->priv
== priv
)
327 return ERROR_COMMAND_SYNTAX_ERROR
;
330 /* alloc memory, it is safe just to return in case of an error, no need for the caller to
332 cb
= malloc(sizeof(struct log_callback
));
334 return ERROR_BUF_TOO_SMALL
;
336 /* add item to the beginning of the linked list */
339 cb
->next
= log_callbacks
;
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
) {
350 if (cb
->fn
== fn
&& cb
->priv
== priv
) {
358 return ERROR_COMMAND_SYNTAX_ERROR
;
361 /* return allocated string w/printf() result */
362 char *alloc_vprintf(const char *fmt
, va_list ap
)
368 /* determine the length of the buffer needed */
369 va_copy(ap_copy
, ap
);
370 len
= vsnprintf(NULL
, 0, fmt
, ap_copy
);
373 /* allocate and make room for terminating zero. */
374 /* FIXME: The old version always allocated at least one byte extra and
375 * other code depend on that. They should be probably be fixed, but for
376 * now reserve the extra byte. */
377 string
= malloc(len
+ 2);
381 /* do the real work */
382 vsnprintf(string
, len
+ 1, fmt
, ap
);
387 char *alloc_printf(const char *format
, ...)
391 va_start(ap
, format
);
392 string
= alloc_vprintf(format
, ap
);
397 /* Code must return to the server loop before 1000ms has returned or invoke
400 * The GDB connection will time out if it spends >2000ms and you'll get nasty
401 * error messages from GDB:
403 * Ignoring packet error, continuing...
404 * Reply contains invalid hex digit 116
406 * While it is possible use "set remotetimeout" to more than the default 2000ms
407 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
408 * GDB protocol and it is a bug in OpenOCD not to either return to the server
409 * loop or invoke keep_alive() every 1000ms.
411 * This function will send a keep alive packet if >500ms has passed since last time
414 * Note that this function can be invoked often, so it needs to be relatively
415 * fast when invoked more often than every 500ms.
418 #define KEEP_ALIVE_KICK_TIME_MS 500
419 #define KEEP_ALIVE_TIMEOUT_MS 1000
421 static void gdb_timeout_warning(int64_t delta_time
)
423 extern int gdb_actual_connections
;
425 if (gdb_actual_connections
)
426 LOG_WARNING("keep_alive() was not invoked in the "
427 "%d ms timelimit. GDB alive packet not "
428 "sent! (%" PRId64
" ms). Workaround: increase "
429 "\"set remotetimeout\" in GDB",
430 KEEP_ALIVE_TIMEOUT_MS
,
433 LOG_DEBUG("keep_alive() was not invoked in the "
434 "%d ms timelimit (%" PRId64
" ms). This may cause "
435 "trouble with GDB connections.",
436 KEEP_ALIVE_TIMEOUT_MS
,
440 void keep_alive(void)
442 int64_t current_time
= timeval_ms();
443 int64_t delta_time
= current_time
- last_time
;
445 if (delta_time
> KEEP_ALIVE_TIMEOUT_MS
) {
446 last_time
= current_time
;
448 gdb_timeout_warning(delta_time
);
451 if (delta_time
> KEEP_ALIVE_KICK_TIME_MS
) {
452 last_time
= current_time
;
454 /* this will keep the GDB connection alive */
455 LOG_USER_N("%s", "");
457 /* DANGER!!!! do not add code to invoke e.g. target event processing,
458 * jim timer processing, etc. it can cause infinite recursion +
459 * jim event callbacks need to happen at a well defined time,
460 * not anywhere keep_alive() is invoked.
462 * These functions should be invoked at a well defined spot in server.c
467 /* reset keep alive timer without sending message */
468 void kept_alive(void)
470 int64_t current_time
= timeval_ms();
472 int64_t delta_time
= current_time
- last_time
;
474 last_time
= current_time
;
476 if (delta_time
> KEEP_ALIVE_TIMEOUT_MS
)
477 gdb_timeout_warning(delta_time
);
480 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittently */
481 void alive_sleep(uint64_t ms
)
483 uint64_t nap_time
= 10;
484 for (uint64_t i
= 0; i
< ms
; i
+= nap_time
) {
485 uint64_t sleep_a_bit
= ms
- i
;
486 if (sleep_a_bit
> nap_time
)
487 sleep_a_bit
= nap_time
;
489 usleep(sleep_a_bit
* 1000);
494 void busy_sleep(uint64_t ms
)
496 uint64_t then
= timeval_ms();
497 while (timeval_ms() - then
< ms
) {
504 /* Maximum size of socket error message retrieved from operation system */
505 #define MAX_SOCKET_ERR_MSG_LENGTH 256
507 /* Provide log message for the last socket error.
508 Uses errno on *nix and WSAGetLastError() on Windows */
509 void log_socket_error(const char *socket_desc
)
513 error_code
= WSAGetLastError();
514 char error_message
[MAX_SOCKET_ERR_MSG_LENGTH
];
515 error_message
[0] = '\0';
516 DWORD retval
= FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, error_code
, 0,
517 error_message
, MAX_SOCKET_ERR_MSG_LENGTH
, NULL
);
518 error_message
[MAX_SOCKET_ERR_MSG_LENGTH
- 1] = '\0';
519 const bool have_message
= (retval
!= 0) && (error_message
[0] != '\0');
520 LOG_ERROR("Error on socket '%s': WSAGetLastError==%d%s%s.", socket_desc
, error_code
,
521 (have_message
? ", message: " : ""),
522 (have_message
? error_message
: ""));
525 LOG_ERROR("Error on socket '%s': errno==%d, message: %s.", socket_desc
, error_code
, strerror(error_code
));
530 * Find the first non-printable character in the char buffer, return a pointer to it.
531 * If no such character exists, return NULL.
533 char *find_nonprint_char(char *buf
, unsigned buf_len
)
535 for (unsigned int i
= 0; i
< buf_len
; i
++) {
536 if (!isprint(buf
[i
]))
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)