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 /* 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
,
94 if (level
== LOG_LVL_OUTPUT
) {
95 /* do not prepend any headers, just print out what we were given and return */
96 fputs(string
, log_output
);
101 f
= strrchr(file
, '/');
105 if (strlen(string
) > 0) {
106 if (debug_level
>= LOG_LVL_DEBUG
) {
107 /* print with count and time information */
108 int64_t t
= timeval_ms() - start
;
109 #ifdef _DEBUG_FREE_SPACE_
110 struct mallinfo info
;
113 fprintf(log_output
, "%s%d %" PRId64
" %s:%d %s()"
114 #ifdef _DEBUG_FREE_SPACE_
117 ": %s", log_strings
[level
+ 1], count
, t
, file
, line
, function
,
118 #ifdef _DEBUG_FREE_SPACE_
123 /* if we are using gdb through pipes then we do not want any output
124 * to the pipe otherwise we get repeated strings */
125 fprintf(log_output
, "%s%s",
126 (level
> LOG_LVL_USER
) ? log_strings
[level
+ 1] : "", string
);
129 /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
135 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
136 if (level
<= LOG_LVL_INFO
)
137 log_forward(file
, line
, function
, string
);
140 void log_printf(enum log_levels level
,
143 const char *function
,
151 if (level
> debug_level
)
154 va_start(ap
, format
);
156 string
= alloc_vprintf(format
, ap
);
157 if (string
!= NULL
) {
158 log_puts(level
, file
, line
, function
, string
);
165 void log_vprintf_lf(enum log_levels level
, const char *file
, unsigned line
,
166 const char *function
, const char *format
, va_list args
)
172 if (level
> debug_level
)
175 tmp
= alloc_vprintf(format
, args
);
181 * Note: alloc_vprintf() guarantees that the buffer is at least one
185 log_puts(level
, file
, line
, function
, tmp
);
189 void log_printf_lf(enum log_levels level
,
192 const char *function
,
198 va_start(ap
, format
);
199 log_vprintf_lf(level
, file
, line
, function
, format
, ap
);
203 COMMAND_HANDLER(handle_debug_level_command
)
207 COMMAND_PARSE_NUMBER(int, CMD_ARGV
[0], new_level
);
208 if ((new_level
> LOG_LVL_DEBUG_IO
) || (new_level
< LOG_LVL_SILENT
)) {
209 LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT
, LOG_LVL_DEBUG_IO
);
210 return ERROR_COMMAND_SYNTAX_ERROR
;
212 debug_level
= new_level
;
213 } else if (CMD_ARGC
> 1)
214 return ERROR_COMMAND_SYNTAX_ERROR
;
216 command_print(CMD
, "debug_level: %i", debug_level
);
221 COMMAND_HANDLER(handle_log_output_command
)
223 if (CMD_ARGC
== 0 || (CMD_ARGC
== 1 && strcmp(CMD_ARGV
[0], "default") == 0)) {
224 if (log_output
!= stderr
&& log_output
!= NULL
) {
225 /* Close previous log file, if it was open and wasn't stderr. */
229 LOG_DEBUG("set log_output to default");
233 FILE *file
= fopen(CMD_ARGV
[0], "w");
235 LOG_ERROR("failed to open output log '%s'", CMD_ARGV
[0]);
238 if (log_output
!= stderr
&& log_output
!= NULL
) {
239 /* Close previous log file, if it was open and wasn't stderr. */
243 LOG_DEBUG("set log_output to \"%s\"", CMD_ARGV
[0]);
247 return ERROR_COMMAND_SYNTAX_ERROR
;
250 static const struct command_registration log_command_handlers
[] = {
252 .name
= "log_output",
253 .handler
= handle_log_output_command
,
255 .help
= "redirect logging to a file (default: stderr)",
256 .usage
= "[file_name | \"default\"]",
259 .name
= "debug_level",
260 .handler
= handle_debug_level_command
,
262 .help
= "Sets the verbosity level of debugging output. "
263 "0 shows errors only; 1 adds warnings; "
264 "2 (default) adds other info; 3 adds debugging; "
265 "4 adds extra verbose debugging.",
268 COMMAND_REGISTRATION_DONE
271 int log_register_commands(struct command_context
*cmd_ctx
)
273 return register_commands(cmd_ctx
, NULL
, log_command_handlers
);
278 /* set defaults for daemon configuration,
279 * if not set by cmdline or cfgfile */
280 if (debug_level
== -1)
281 debug_level
= LOG_LVL_INFO
;
283 char *debug_env
= getenv("OPENOCD_DEBUG_LEVEL");
284 if (NULL
!= debug_env
) {
286 int retval
= parse_int(debug_env
, &value
);
287 if (ERROR_OK
== retval
&&
288 debug_level
>= LOG_LVL_SILENT
&&
289 debug_level
<= LOG_LVL_DEBUG_IO
)
293 if (log_output
== NULL
)
296 start
= last_time
= timeval_ms();
299 int set_log_output(struct command_context
*cmd_ctx
, FILE *output
)
305 /* add/remove log callback handler */
306 int log_add_callback(log_callback_fn fn
, void *priv
)
308 struct log_callback
*cb
;
310 /* prevent the same callback to be registered more than once, just for sure */
311 for (cb
= log_callbacks
; cb
; cb
= cb
->next
) {
312 if (cb
->fn
== fn
&& cb
->priv
== priv
)
313 return ERROR_COMMAND_SYNTAX_ERROR
;
316 /* alloc memory, it is safe just to return in case of an error, no need for the caller to
318 cb
= malloc(sizeof(struct log_callback
));
320 return ERROR_BUF_TOO_SMALL
;
322 /* add item to the beginning of the linked list */
325 cb
->next
= log_callbacks
;
331 int log_remove_callback(log_callback_fn fn
, void *priv
)
333 struct log_callback
*cb
, **p
;
335 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
) {
336 if (cb
->fn
== fn
&& cb
->priv
== priv
) {
344 return ERROR_COMMAND_SYNTAX_ERROR
;
347 /* return allocated string w/printf() result */
348 char *alloc_vprintf(const char *fmt
, va_list ap
)
354 /* determine the length of the buffer needed */
355 va_copy(ap_copy
, ap
);
356 len
= vsnprintf(NULL
, 0, fmt
, ap_copy
);
359 /* allocate and make room for terminating zero. */
360 /* FIXME: The old version always allocated at least one byte extra and
361 * other code depend on that. They should be probably be fixed, but for
362 * now reserve the extra byte. */
363 string
= malloc(len
+ 2);
367 /* do the real work */
368 vsnprintf(string
, len
+ 1, fmt
, ap
);
373 char *alloc_printf(const char *format
, ...)
377 va_start(ap
, format
);
378 string
= alloc_vprintf(format
, ap
);
383 /* Code must return to the server loop before 1000ms has returned or invoke
386 * The GDB connection will time out if it spends >2000ms and you'll get nasty
387 * error messages from GDB:
389 * Ignoring packet error, continuing...
390 * Reply contains invalid hex digit 116
392 * While it is possible use "set remotetimeout" to more than the default 2000ms
393 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
394 * GDB protocol and it is a bug in OpenOCD not to either return to the server
395 * loop or invoke keep_alive() every 1000ms.
397 * This function will send a keep alive packet if >500ms has passed since last time
400 * Note that this function can be invoked often, so it needs to be relatively
401 * fast when invoked more often than every 500ms.
404 void keep_alive(void)
406 current_time
= timeval_ms();
407 if (current_time
-last_time
> 1000) {
408 extern int gdb_actual_connections
;
410 if (gdb_actual_connections
)
411 LOG_WARNING("keep_alive() was not invoked in the "
412 "1000ms timelimit. GDB alive packet not "
413 "sent! (%" PRId64
"). Workaround: increase "
414 "\"set remotetimeout\" in GDB",
415 current_time
-last_time
);
417 LOG_DEBUG("keep_alive() was not invoked in the "
418 "1000ms timelimit (%" PRId64
"). This may cause "
419 "trouble with GDB connections.",
420 current_time
-last_time
);
422 if (current_time
-last_time
> 500) {
423 /* this will keep the GDB connection alive */
424 LOG_USER_N("%s", "");
426 /* DANGER!!!! do not add code to invoke e.g. target event processing,
427 * jim timer processing, etc. it can cause infinite recursion +
428 * jim event callbacks need to happen at a well defined time,
429 * not anywhere keep_alive() is invoked.
431 * These functions should be invoked at a well defined spot in server.c
434 last_time
= current_time
;
438 /* reset keep alive timer without sending message */
439 void kept_alive(void)
441 current_time
= timeval_ms();
442 last_time
= current_time
;
445 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
446 void alive_sleep(uint64_t ms
)
448 uint64_t napTime
= 10;
449 for (uint64_t i
= 0; i
< ms
; i
+= napTime
) {
450 uint64_t sleep_a_bit
= ms
- i
;
451 if (sleep_a_bit
> napTime
)
452 sleep_a_bit
= napTime
;
454 usleep(sleep_a_bit
* 1000);
459 void busy_sleep(uint64_t ms
)
461 uint64_t then
= timeval_ms();
462 while (timeval_ms() - then
< ms
) {
469 /* Maximum size of socket error message retreived from operation system */
470 #define MAX_SOCKET_ERR_MSG_LENGTH 256
472 /* Provide log message for the last socket error.
473 Uses errno on *nix and WSAGetLastError() on Windows */
474 void log_socket_error(const char *socket_desc
)
478 error_code
= WSAGetLastError();
479 char error_message
[MAX_SOCKET_ERR_MSG_LENGTH
];
480 error_message
[0] = '\0';
481 DWORD retval
= FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, error_code
, 0,
482 error_message
, MAX_SOCKET_ERR_MSG_LENGTH
, NULL
);
483 error_message
[MAX_SOCKET_ERR_MSG_LENGTH
- 1] = '\0';
484 const bool have_message
= (retval
!= 0) && (error_message
[0] != '\0');
485 LOG_ERROR("Error on socket '%s': WSAGetLastError==%d%s%s.", socket_desc
, error_code
,
486 (have_message
? ", message: " : ""),
487 (have_message
? error_message
: ""));
490 LOG_ERROR("Error on socket '%s': errno==%d, message: %s.", socket_desc
, error_code
, strerror(error_code
));
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)