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 "replacements.h"
33 #include "configuration.h"
34 #include "time_support.h"
51 static FILE* log_output
;
52 static log_callback_t
*log_callbacks
= NULL
;
54 static long long last_time
;
55 static long long current_time
;
57 static long long start
;
59 static char *log_strings
[5] =
63 "Warn : ", /* want a space after each colon, all same width, colons aligned */
71 /* The log_puts() serves to somewhat different goals:
74 * - feeding low-level info to the user in GDB or Telnet
76 * The latter dictates that strings without newline are not logged, lest there
77 * will be *MANY log lines when sending one char at the time(e.g.
81 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
84 if (level
== LOG_LVL_OUTPUT
)
86 /* do not prepend any headers, just print out what we were given and return */
87 fputs(string
, log_output
);
92 f
= strrchr(file
, '/');
96 if (strchr(string
, '\n')!=NULL
)
98 if (debug_level
>= LOG_LVL_DEBUG
)
100 /* print with count and time information */
101 int t
=(int)(timeval_ms()-start
);
103 struct mallinfo info
;
106 fprintf(log_output
, "%s%d %d %s:%d %s()"
110 ": %s", log_strings
[level
+1], count
, t
, file
, line
, function
,
116 else if(server_use_pipes
== 0)
118 /* if we are using gdb through pipes then we do not want any output
119 * to the pipe otherwise we get repeated strings */
120 if (strcmp(string
, "\n") != 0)
122 /* print human readable output - but skip empty lines */
123 fprintf(log_output
, "%s%s",
124 (level
> LOG_LVL_USER
)?log_strings
[level
+1]:"", string
);
129 /* only entire lines are logged. Otherwise it's
130 * single chars intended for the log callbacks. */
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
)
138 log_callback_t
*cb
, *next
;
140 /* DANGER!!!! the log callback can remove itself!!!! */
144 cb
->fn(cb
->priv
, file
, line
, function
, string
);
150 void log_printf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
156 if (level
> debug_level
)
159 va_start(ap
, format
);
161 string
= alloc_vprintf(format
, ap
);
164 log_puts(level
, file
, line
, function
, string
);
171 void log_printf_lf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
177 if (level
> debug_level
)
180 va_start(ap
, format
);
182 string
= alloc_vprintf(format
, ap
);
185 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
186 log_puts(level
, file
, line
, function
, string
);
193 /* change the current debug level on the fly
196 * 2: + INFORMATIONAL MSGS
199 int handle_debug_level_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
202 command_print(cmd_ctx
, "debug_level: %i", debug_level
);
205 debug_level
= strtoul(args
[0], NULL
, 0);
213 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
215 /* if we are enabling debug info then we need to write to a log file
216 * otherwise the pipe will get full and cause issues with gdb */
217 FILE* file
= fopen("openocd.log", "w");
221 LOG_WARNING("enabling log output as we are using pipes");
228 int handle_log_output_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
232 FILE* file
= fopen(args
[0], "w");
243 int log_register_commands(struct command_context_s
*cmd_ctx
)
245 start
= timeval_ms();
246 register_command(cmd_ctx
, NULL
, "log_output", handle_log_output_command
,
247 COMMAND_ANY
, "redirect logging to <file> (default: stderr)");
248 register_command(cmd_ctx
, NULL
, "debug_level", handle_debug_level_command
,
249 COMMAND_ANY
, "adjust debug level <0-3>");
254 int log_init(struct command_context_s
*cmd_ctx
)
256 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
257 if (debug_level
== -1)
258 debug_level
= LOG_LVL_INFO
;
260 if (log_output
== NULL
)
265 start
=last_time
=timeval_ms();
270 int set_log_output(struct command_context_s
*cmd_ctx
, FILE *output
)
276 /* add/remove log callback handler */
277 int log_add_callback(log_callback_fn fn
, void *priv
)
281 /* prevent the same callback to be registered more than once, just for sure */
282 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
284 if (cb
->fn
== fn
&& cb
->priv
== priv
)
285 return ERROR_INVALID_ARGUMENTS
;
288 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
289 if ((cb
= malloc(sizeof(log_callback_t
))) == NULL
)
290 return ERROR_BUF_TOO_SMALL
;
292 /* add item to the beginning of the linked list */
295 cb
->next
= log_callbacks
;
301 int log_remove_callback(log_callback_fn fn
, void *priv
)
303 log_callback_t
*cb
, **p
;
305 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
307 if (cb
->fn
== fn
&& cb
->priv
== priv
)
316 return ERROR_INVALID_ARGUMENTS
;
319 /* return allocated string w/printf() result */
320 char *alloc_vprintf(const char *fmt
, va_list ap
)
322 /* no buffer at the beginning, force realloc to do the job */
325 /* start with buffer size suitable for typical messages */
333 string
= realloc(string
, size
);
341 va_copy(ap_copy
, ap
);
343 ret
= vsnprintf(string
, size
, fmt
, ap_copy
);
344 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
345 if ((ret
>= 0) && ((ret
+ 1) < size
))
348 /* there was just enough or not enough space, allocate more in the next round */
349 size
*= 2; /* double the buffer size */
352 /* the returned buffer is by principle guaranteed to be at least one character longer */
356 char *alloc_printf(const char *format
, ...)
360 va_start(ap
, format
);
361 string
= alloc_vprintf(format
, ap
);
366 /* Code must return to the server loop before 1000ms has returned or invoke
369 * The GDB connection will time out if it spends >2000ms and you'll get nasty
370 * error messages from GDB:
372 * Ignoring packet error, continuing...
373 * Reply contains invalid hex digit 116
375 * While it is possible use "set remotetimeout" to more than the default 2000ms
376 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
377 * GDB protocol and it is a bug in OpenOCD not to either return to the server
378 * loop or invoke keep_alive() every 1000ms.
380 * This function will send a keep alive packet if >500ms has passed since last time
383 * Note that this function can be invoked often, so it needs to be relatively
384 * fast when invoked more often than every 500ms.
389 current_time
=timeval_ms();
390 if (current_time
-last_time
>1000)
392 LOG_WARNING("BUG: keep_alive() was not invoked in the 1000ms timelimit. GDB alive packet not sent! (%lld)", current_time
-last_time
);
394 if (current_time
-last_time
>500)
396 /* this will keep the GDB connection alive */
397 LOG_USER_N("%s", "");
399 /* DANGER!!!! do not add code to invoke e.g. target event processing,
400 * jim timer processing, etc. it can cause infinite recursion +
401 * jim event callbacks need to happen at a well defined time,
402 * not anywhere keep_alive() is invoked.
404 * These functions should be invoked at a well defined spot in server.c
407 last_time
=current_time
;
411 /* reset keep alive timer without sending message */
414 current_time
=timeval_ms();
415 last_time
=current_time
;
418 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
419 void alive_sleep(int ms
)
423 for (i
=0; i
<ms
; i
+=napTime
)
425 int sleep_a_bit
=ms
-i
;
426 if (sleep_a_bit
>napTime
)
430 usleep(sleep_a_bit
*1000);
435 void busy_sleep(int ms
)
439 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)