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"
33 #include <server/server.h>
37 #ifdef _DEBUG_FREE_SPACE_
41 #error "malloc.h is required to use --enable-malloc-logging"
45 int debug_level
= LOG_LVL_INFO
;
47 static FILE *log_output
;
48 static struct log_callback
*log_callbacks
;
50 static int64_t last_time
;
54 static const char * const log_strings
[6] = {
57 "Warn : ", /* want a space after each colon, all same width, colons aligned */
65 /* forward the log to the listeners */
66 static void log_forward(const char *file
, unsigned line
, const char *function
, const char *string
)
68 struct log_callback
*cb
, *next
;
70 /* DANGER!!!! the log callback can remove itself!!!! */
73 cb
->fn(cb
->priv
, file
, line
, function
, string
);
78 /* The log_puts() serves two somewhat different goals:
81 * - feeding low-level info to the user in GDB or Telnet
83 * The latter dictates that strings without newline are not logged, lest there
84 * will be *MANY log lines when sending one char at the time(e.g.
88 static void log_puts(enum log_levels level
,
97 /* log_init() not called yet; print on stderr */
98 fputs(string
, stderr
);
103 if (level
== LOG_LVL_OUTPUT
) {
104 /* do not prepend any headers, just print out what we were given and return */
105 fputs(string
, log_output
);
110 f
= strrchr(file
, '/');
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
);
139 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
140 if (level
<= LOG_LVL_INFO
)
141 log_forward(file
, line
, function
, string
);
144 void log_printf(enum log_levels level
,
147 const char *function
,
155 if (level
> debug_level
)
158 va_start(ap
, format
);
160 string
= alloc_vprintf(format
, ap
);
162 log_puts(level
, file
, line
, function
, string
);
169 void log_vprintf_lf(enum log_levels level
, const char *file
, unsigned line
,
170 const char *function
, const char *format
, va_list args
)
176 if (level
> debug_level
)
179 tmp
= alloc_vprintf(format
, args
);
185 * Note: alloc_vprintf() guarantees that the buffer is at least one
189 log_puts(level
, file
, line
, function
, tmp
);
193 void log_printf_lf(enum log_levels level
,
196 const char *function
,
202 va_start(ap
, format
);
203 log_vprintf_lf(level
, file
, line
, function
, format
, ap
);
207 COMMAND_HANDLER(handle_debug_level_command
)
211 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], new_level
);
212 if ((new_level
> LOG_LVL_DEBUG_IO
) || (new_level
< LOG_LVL_SILENT
)) {
213 LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT
, LOG_LVL_DEBUG_IO
);
214 return ERROR_COMMAND_SYNTAX_ERROR
;
216 debug_level
= new_level
;
217 } else if (CMD_ARGC
> 1)
218 return ERROR_COMMAND_SYNTAX_ERROR
;
220 command_print(CMD
, "debug_level: %i", debug_level
);
225 COMMAND_HANDLER(handle_log_output_command
)
227 if (CMD_ARGC
== 0 || (CMD_ARGC
== 1 && strcmp(CMD_ARGV
[0], "default") == 0)) {
228 if (log_output
!= stderr
&& log_output
) {
229 /* Close previous log file, if it was open and wasn't stderr. */
233 LOG_DEBUG("set log_output to default");
237 FILE *file
= fopen(CMD_ARGV
[0], "w");
239 LOG_ERROR("failed to open output log '%s'", CMD_ARGV
[0]);
242 if (log_output
!= stderr
&& log_output
) {
243 /* Close previous log file, if it was open and wasn't stderr. */
247 LOG_DEBUG("set log_output to \"%s\"", CMD_ARGV
[0]);
251 return ERROR_COMMAND_SYNTAX_ERROR
;
254 static const struct command_registration log_command_handlers
[] = {
256 .name
= "log_output",
257 .handler
= handle_log_output_command
,
259 .help
= "redirect logging to a file (default: stderr)",
260 .usage
= "[file_name | \"default\"]",
263 .name
= "debug_level",
264 .handler
= handle_debug_level_command
,
266 .help
= "Sets the verbosity level of debugging output. "
267 "0 shows errors only; 1 adds warnings; "
268 "2 (default) adds other info; 3 adds debugging; "
269 "4 adds extra verbose debugging.",
272 COMMAND_REGISTRATION_DONE
275 int log_register_commands(struct command_context
*cmd_ctx
)
277 return register_commands(cmd_ctx
, NULL
, log_command_handlers
);
282 /* set defaults for daemon configuration,
283 * if not set by cmdline or cfgfile */
284 char *debug_env
= getenv("OPENOCD_DEBUG_LEVEL");
287 int retval
= parse_int(debug_env
, &value
);
288 if (retval
== ERROR_OK
&&
289 debug_level
>= LOG_LVL_SILENT
&&
290 debug_level
<= LOG_LVL_DEBUG_IO
)
297 start
= last_time
= timeval_ms();
302 if (log_output
&& log_output
!= stderr
) {
303 /* Close log file, if it was open and wasn't stderr. */
309 int set_log_output(struct command_context
*cmd_ctx
, FILE *output
)
315 /* add/remove log callback handler */
316 int log_add_callback(log_callback_fn fn
, void *priv
)
318 struct log_callback
*cb
;
320 /* prevent the same callback to be registered more than once, just for sure */
321 for (cb
= log_callbacks
; cb
; cb
= cb
->next
) {
322 if (cb
->fn
== fn
&& cb
->priv
== priv
)
323 return ERROR_COMMAND_SYNTAX_ERROR
;
326 /* alloc memory, it is safe just to return in case of an error, no need for the caller to
328 cb
= malloc(sizeof(struct log_callback
));
330 return ERROR_BUF_TOO_SMALL
;
332 /* add item to the beginning of the linked list */
335 cb
->next
= log_callbacks
;
341 int log_remove_callback(log_callback_fn fn
, void *priv
)
343 struct log_callback
*cb
, **p
;
345 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
) {
346 if (cb
->fn
== fn
&& cb
->priv
== priv
) {
354 return ERROR_COMMAND_SYNTAX_ERROR
;
357 /* return allocated string w/printf() result */
358 char *alloc_vprintf(const char *fmt
, va_list ap
)
364 /* determine the length of the buffer needed */
365 va_copy(ap_copy
, ap
);
366 len
= vsnprintf(NULL
, 0, fmt
, ap_copy
);
369 /* allocate and make room for terminating zero. */
370 /* FIXME: The old version always allocated at least one byte extra and
371 * other code depend on that. They should be probably be fixed, but for
372 * now reserve the extra byte. */
373 string
= malloc(len
+ 2);
377 /* do the real work */
378 vsnprintf(string
, len
+ 1, fmt
, ap
);
383 char *alloc_printf(const char *format
, ...)
387 va_start(ap
, format
);
388 string
= alloc_vprintf(format
, ap
);
393 /* Code must return to the server loop before 1000ms has returned or invoke
396 * The GDB connection will time out if it spends >2000ms and you'll get nasty
397 * error messages from GDB:
399 * Ignoring packet error, continuing...
400 * Reply contains invalid hex digit 116
402 * While it is possible use "set remotetimeout" to more than the default 2000ms
403 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
404 * GDB protocol and it is a bug in OpenOCD not to either return to the server
405 * loop or invoke keep_alive() every 1000ms.
407 * This function will send a keep alive packet if >500ms has passed since last time
410 * Note that this function can be invoked often, so it needs to be relatively
411 * fast when invoked more often than every 500ms.
414 #define KEEP_ALIVE_KICK_TIME_MS 500
415 #define KEEP_ALIVE_TIMEOUT_MS 1000
417 static void gdb_timeout_warning(int64_t delta_time
)
419 extern int gdb_actual_connections
;
421 if (gdb_actual_connections
)
422 LOG_WARNING("keep_alive() was not invoked in the "
423 "%d ms timelimit. GDB alive packet not "
424 "sent! (%" PRId64
" ms). Workaround: increase "
425 "\"set remotetimeout\" in GDB",
426 KEEP_ALIVE_TIMEOUT_MS
,
429 LOG_DEBUG("keep_alive() was not invoked in the "
430 "%d ms timelimit (%" PRId64
" ms). This may cause "
431 "trouble with GDB connections.",
432 KEEP_ALIVE_TIMEOUT_MS
,
436 void keep_alive(void)
438 int64_t current_time
= timeval_ms();
439 int64_t delta_time
= current_time
- last_time
;
441 if (delta_time
> KEEP_ALIVE_TIMEOUT_MS
) {
442 last_time
= current_time
;
444 gdb_timeout_warning(delta_time
);
447 if (delta_time
> KEEP_ALIVE_KICK_TIME_MS
) {
448 last_time
= current_time
;
450 /* this will keep the GDB connection alive */
451 server_keep_clients_alive();
453 /* DANGER!!!! do not add code to invoke e.g. target event processing,
454 * jim timer processing, etc. it can cause infinite recursion +
455 * jim event callbacks need to happen at a well defined time,
456 * not anywhere keep_alive() is invoked.
458 * These functions should be invoked at a well defined spot in server.c
463 /* reset keep alive timer without sending message */
464 void kept_alive(void)
466 int64_t current_time
= timeval_ms();
468 int64_t delta_time
= current_time
- last_time
;
470 last_time
= current_time
;
472 if (delta_time
> KEEP_ALIVE_TIMEOUT_MS
)
473 gdb_timeout_warning(delta_time
);
476 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittently */
477 void alive_sleep(uint64_t ms
)
479 uint64_t nap_time
= 10;
480 for (uint64_t i
= 0; i
< ms
; i
+= nap_time
) {
481 uint64_t sleep_a_bit
= ms
- i
;
482 if (sleep_a_bit
> nap_time
)
483 sleep_a_bit
= nap_time
;
485 usleep(sleep_a_bit
* 1000);
490 void busy_sleep(uint64_t ms
)
492 uint64_t then
= timeval_ms();
493 while (timeval_ms() - then
< ms
) {
500 /* Maximum size of socket error message retrieved from operation system */
501 #define MAX_SOCKET_ERR_MSG_LENGTH 256
503 /* Provide log message for the last socket error.
504 Uses errno on *nix and WSAGetLastError() on Windows */
505 void log_socket_error(const char *socket_desc
)
509 error_code
= WSAGetLastError();
510 char error_message
[MAX_SOCKET_ERR_MSG_LENGTH
];
511 error_message
[0] = '\0';
512 DWORD retval
= FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, error_code
, 0,
513 error_message
, MAX_SOCKET_ERR_MSG_LENGTH
, NULL
);
514 error_message
[MAX_SOCKET_ERR_MSG_LENGTH
- 1] = '\0';
515 const bool have_message
= (retval
!= 0) && (error_message
[0] != '\0');
516 LOG_ERROR("Error on socket '%s': WSAGetLastError==%d%s%s.", socket_desc
, error_code
,
517 (have_message
? ", message: " : ""),
518 (have_message
? error_message
: ""));
521 LOG_ERROR("Error on socket '%s': errno==%d, message: %s.", socket_desc
, error_code
, strerror(error_code
));
526 * Find the first non-printable character in the char buffer, return a pointer to it.
527 * If no such character exists, return NULL.
529 char *find_nonprint_char(char *buf
, unsigned buf_len
)
531 for (unsigned int i
= 0; i
< buf_len
; i
++) {
532 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)