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 ***************************************************************************/
31 #include "time_support.h"
36 #ifdef _DEBUG_FREE_SPACE_
40 #error "malloc.h is required to use --enable-malloc-logging"
46 static FILE* log_output
;
47 static log_callback_t
*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 */
66 /* The log_puts() serves to somewhat different goals:
69 * - feeding low-level info to the user in GDB or Telnet
71 * The latter dictates that strings without newline are not logged, lest there
72 * will be *MANY log lines when sending one char at the time(e.g.
76 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
79 if (level
== LOG_LVL_OUTPUT
)
81 /* do not prepend any headers, just print out what we were given and return */
82 fputs(string
, log_output
);
87 f
= strrchr(file
, '/');
91 if (strchr(string
, '\n')!=NULL
)
93 if (debug_level
>= LOG_LVL_DEBUG
)
95 /* print with count and time information */
96 int t
=(int)(timeval_ms()-start
);
97 #ifdef _DEBUG_FREE_SPACE_
101 fprintf(log_output
, "%s%d %d %s:%d %s()"
102 #ifdef _DEBUG_FREE_SPACE_
105 ": %s", log_strings
[level
+1], count
, t
, file
, line
, function
,
106 #ifdef _DEBUG_FREE_SPACE_
111 else if(server_use_pipes
== 0)
113 /* if we are using gdb through pipes then we do not want any output
114 * to the pipe otherwise we get repeated strings */
115 if (strcmp(string
, "\n") != 0)
117 /* print human readable output - but skip empty lines */
118 fprintf(log_output
, "%s%s",
119 (level
> LOG_LVL_USER
)?log_strings
[level
+1]:"", string
);
124 /* only entire lines are logged. Otherwise it's
125 * single chars intended for the log callbacks. */
130 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
131 if (level
<= LOG_LVL_INFO
)
133 log_callback_t
*cb
, *next
;
135 /* DANGER!!!! the log callback can remove itself!!!! */
139 cb
->fn(cb
->priv
, file
, line
, function
, string
);
145 void log_printf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
151 if (level
> debug_level
)
154 va_start(ap
, format
);
156 string
= alloc_vprintf(format
, ap
);
159 log_puts(level
, file
, line
, function
, string
);
166 void log_printf_lf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
172 if (level
> debug_level
)
175 va_start(ap
, format
);
177 string
= alloc_vprintf(format
, ap
);
180 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
181 log_puts(level
, file
, line
, function
, string
);
188 /* change the current debug level on the fly
191 * 2: + INFORMATIONAL MSGS
194 int handle_debug_level_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
197 command_print(cmd_ctx
, "debug_level: %i", debug_level
);
200 debug_level
= strtoul(args
[0], NULL
, 0);
208 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
210 /* if we are enabling debug info then we need to write to a log file
211 * otherwise the pipe will get full and cause issues with gdb */
212 FILE* file
= fopen("openocd.log", "w");
216 LOG_WARNING("enabling log output as we are using pipes");
223 int handle_log_output_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
227 FILE* file
= fopen(args
[0], "w");
238 int log_register_commands(struct command_context_s
*cmd_ctx
)
240 start
= timeval_ms();
241 register_command(cmd_ctx
, NULL
, "log_output", handle_log_output_command
,
242 COMMAND_ANY
, "redirect logging to <file> (default: stderr)");
243 register_command(cmd_ctx
, NULL
, "debug_level", handle_debug_level_command
,
244 COMMAND_ANY
, "adjust debug level <0-3>");
249 int log_init(struct command_context_s
*cmd_ctx
)
251 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
252 if (debug_level
== -1)
253 debug_level
= LOG_LVL_INFO
;
255 if (log_output
== NULL
)
260 start
=last_time
=timeval_ms();
265 int set_log_output(struct command_context_s
*cmd_ctx
, FILE *output
)
271 /* add/remove log callback handler */
272 int log_add_callback(log_callback_fn fn
, void *priv
)
276 /* prevent the same callback to be registered more than once, just for sure */
277 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
279 if (cb
->fn
== fn
&& cb
->priv
== priv
)
280 return ERROR_INVALID_ARGUMENTS
;
283 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
284 if ((cb
= malloc(sizeof(log_callback_t
))) == NULL
)
285 return ERROR_BUF_TOO_SMALL
;
287 /* add item to the beginning of the linked list */
290 cb
->next
= log_callbacks
;
296 int log_remove_callback(log_callback_fn fn
, void *priv
)
298 log_callback_t
*cb
, **p
;
300 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
302 if (cb
->fn
== fn
&& cb
->priv
== priv
)
311 return ERROR_INVALID_ARGUMENTS
;
314 /* return allocated string w/printf() result */
315 char *alloc_vprintf(const char *fmt
, va_list ap
)
317 /* no buffer at the beginning, force realloc to do the job */
320 /* start with buffer size suitable for typical messages */
328 string
= realloc(string
, size
);
336 va_copy(ap_copy
, ap
);
338 ret
= vsnprintf(string
, size
, fmt
, ap_copy
);
339 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
340 if ((ret
>= 0) && ((ret
+ 1) < size
))
343 /* there was just enough or not enough space, allocate more in the next round */
344 size
*= 2; /* double the buffer size */
347 /* the returned buffer is by principle guaranteed to be at least one character longer */
351 char *alloc_printf(const char *format
, ...)
355 va_start(ap
, format
);
356 string
= alloc_vprintf(format
, ap
);
361 /* Code must return to the server loop before 1000ms has returned or invoke
364 * The GDB connection will time out if it spends >2000ms and you'll get nasty
365 * error messages from GDB:
367 * Ignoring packet error, continuing...
368 * Reply contains invalid hex digit 116
370 * While it is possible use "set remotetimeout" to more than the default 2000ms
371 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
372 * GDB protocol and it is a bug in OpenOCD not to either return to the server
373 * loop or invoke keep_alive() every 1000ms.
375 * This function will send a keep alive packet if >500ms has passed since last time
378 * Note that this function can be invoked often, so it needs to be relatively
379 * fast when invoked more often than every 500ms.
384 current_time
=timeval_ms();
385 if (current_time
-last_time
>1000)
387 LOG_WARNING("keep_alive() was not invoked in the 1000ms timelimit. GDB alive packet not sent! (%lld). Workaround: increase \"set remotetimeout\" in GDB", current_time
-last_time
);
389 if (current_time
-last_time
>500)
391 /* this will keep the GDB connection alive */
392 LOG_USER_N("%s", "");
394 /* DANGER!!!! do not add code to invoke e.g. target event processing,
395 * jim timer processing, etc. it can cause infinite recursion +
396 * jim event callbacks need to happen at a well defined time,
397 * not anywhere keep_alive() is invoked.
399 * These functions should be invoked at a well defined spot in server.c
402 last_time
=current_time
;
406 /* reset keep alive timer without sending message */
409 current_time
=timeval_ms();
410 last_time
=current_time
;
413 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
414 void alive_sleep(int ms
)
418 for (i
=0; i
<ms
; i
+=napTime
)
420 int sleep_a_bit
=ms
-i
;
421 if (sleep_a_bit
>napTime
)
425 usleep(sleep_a_bit
*1000);
430 void busy_sleep(int ms
)
434 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)