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"
32 // @todo the inclusion of server.h here is a layering violation
37 #ifdef _DEBUG_FREE_SPACE_
41 #error "malloc.h is required to use --enable-malloc-logging"
47 static FILE* log_output
;
48 static log_callback_t
*log_callbacks
= NULL
;
50 static long long last_time
;
51 static long long current_time
;
53 static long long start
;
55 static char *log_strings
[5] =
59 "Warn : ", /* want a space after each colon, all same width, colons aligned */
67 /* The log_puts() serves to somewhat different goals:
70 * - feeding low-level info to the user in GDB or Telnet
72 * The latter dictates that strings without newline are not logged, lest there
73 * will be *MANY log lines when sending one char at the time(e.g.
77 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
80 if (level
== LOG_LVL_OUTPUT
)
82 /* do not prepend any headers, just print out what we were given and return */
83 fputs(string
, log_output
);
88 f
= strrchr(file
, '/');
92 if (strchr(string
, '\n')!=NULL
)
94 if (debug_level
>= LOG_LVL_DEBUG
)
96 /* print with count and time information */
97 int t
=(int)(timeval_ms()-start
);
98 #ifdef _DEBUG_FREE_SPACE_
102 fprintf(log_output
, "%s%d %d %s:%d %s()"
103 #ifdef _DEBUG_FREE_SPACE_
106 ": %s", log_strings
[level
+1], count
, t
, file
, line
, function
,
107 #ifdef _DEBUG_FREE_SPACE_
112 else if(server_use_pipes
== 0)
114 /* if we are using gdb through pipes then we do not want any output
115 * to the pipe otherwise we get repeated strings */
116 if (strcmp(string
, "\n") != 0)
118 /* print human readable output - but skip empty lines */
119 fprintf(log_output
, "%s%s",
120 (level
> LOG_LVL_USER
)?log_strings
[level
+1]:"", string
);
125 /* only entire lines are logged. Otherwise it's
126 * single chars intended for the log callbacks. */
131 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
132 if (level
<= LOG_LVL_INFO
)
134 log_callback_t
*cb
, *next
;
136 /* DANGER!!!! the log callback can remove itself!!!! */
140 cb
->fn(cb
->priv
, file
, line
, function
, string
);
146 void log_printf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
152 if (level
> debug_level
)
155 va_start(ap
, format
);
157 string
= alloc_vprintf(format
, ap
);
160 log_puts(level
, file
, line
, function
, string
);
167 void log_printf_lf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
173 if (level
> debug_level
)
176 va_start(ap
, format
);
178 string
= alloc_vprintf(format
, ap
);
181 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
182 log_puts(level
, file
, line
, function
, string
);
189 /* change the current debug level on the fly
192 * 2: + INFORMATIONAL MSGS
195 int handle_debug_level_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
198 command_print(cmd_ctx
, "debug_level: %i", debug_level
);
201 debug_level
= strtoul(args
[0], NULL
, 0);
209 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
211 /* if we are enabling debug info then we need to write to a log file
212 * otherwise the pipe will get full and cause issues with gdb */
213 FILE* file
= fopen("openocd.log", "w");
217 LOG_WARNING("enabling log output as we are using pipes");
224 int handle_log_output_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
228 FILE* file
= fopen(args
[0], "w");
239 int log_register_commands(struct command_context_s
*cmd_ctx
)
241 start
= timeval_ms();
242 register_command(cmd_ctx
, NULL
, "log_output", handle_log_output_command
,
243 COMMAND_ANY
, "redirect logging to <file> (default: stderr)");
244 register_command(cmd_ctx
, NULL
, "debug_level", handle_debug_level_command
,
245 COMMAND_ANY
, "adjust debug level <0-3>");
250 int log_init(struct command_context_s
*cmd_ctx
)
252 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
253 if (debug_level
== -1)
254 debug_level
= LOG_LVL_INFO
;
256 if (log_output
== NULL
)
261 start
=last_time
=timeval_ms();
266 int set_log_output(struct command_context_s
*cmd_ctx
, FILE *output
)
272 /* add/remove log callback handler */
273 int log_add_callback(log_callback_fn fn
, void *priv
)
277 /* prevent the same callback to be registered more than once, just for sure */
278 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
280 if (cb
->fn
== fn
&& cb
->priv
== priv
)
281 return ERROR_INVALID_ARGUMENTS
;
284 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
285 if ((cb
= malloc(sizeof(log_callback_t
))) == NULL
)
286 return ERROR_BUF_TOO_SMALL
;
288 /* add item to the beginning of the linked list */
291 cb
->next
= log_callbacks
;
297 int log_remove_callback(log_callback_fn fn
, void *priv
)
299 log_callback_t
*cb
, **p
;
301 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
303 if (cb
->fn
== fn
&& cb
->priv
== priv
)
312 return ERROR_INVALID_ARGUMENTS
;
315 /* return allocated string w/printf() result */
316 char *alloc_vprintf(const char *fmt
, va_list ap
)
318 /* no buffer at the beginning, force realloc to do the job */
321 /* start with buffer size suitable for typical messages */
329 string
= realloc(string
, size
);
337 va_copy(ap_copy
, ap
);
339 ret
= vsnprintf(string
, size
, fmt
, ap_copy
);
340 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
341 if ((ret
>= 0) && ((ret
+ 1) < size
))
344 /* there was just enough or not enough space, allocate more in the next round */
345 size
*= 2; /* double the buffer size */
348 /* the returned buffer is by principle guaranteed to be at least one character longer */
352 char *alloc_printf(const char *format
, ...)
356 va_start(ap
, format
);
357 string
= alloc_vprintf(format
, ap
);
362 /* Code must return to the server loop before 1000ms has returned or invoke
365 * The GDB connection will time out if it spends >2000ms and you'll get nasty
366 * error messages from GDB:
368 * Ignoring packet error, continuing...
369 * Reply contains invalid hex digit 116
371 * While it is possible use "set remotetimeout" to more than the default 2000ms
372 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
373 * GDB protocol and it is a bug in OpenOCD not to either return to the server
374 * loop or invoke keep_alive() every 1000ms.
376 * This function will send a keep alive packet if >500ms has passed since last time
379 * Note that this function can be invoked often, so it needs to be relatively
380 * fast when invoked more often than every 500ms.
385 current_time
=timeval_ms();
386 if (current_time
-last_time
>1000)
388 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
);
390 if (current_time
-last_time
>500)
392 /* this will keep the GDB connection alive */
393 LOG_USER_N("%s", "");
395 /* DANGER!!!! do not add code to invoke e.g. target event processing,
396 * jim timer processing, etc. it can cause infinite recursion +
397 * jim event callbacks need to happen at a well defined time,
398 * not anywhere keep_alive() is invoked.
400 * These functions should be invoked at a well defined spot in server.c
403 last_time
=current_time
;
407 /* reset keep alive timer without sending message */
410 current_time
=timeval_ms();
411 last_time
=current_time
;
414 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
415 void alive_sleep(int ms
)
419 for (i
=0; i
<ms
; i
+=napTime
)
421 int sleep_a_bit
=ms
-i
;
422 if (sleep_a_bit
>napTime
)
426 usleep(sleep_a_bit
*1000);
431 void busy_sleep(int ms
)
435 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)