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"
44 #ifdef _DEBUG_FREE_SPACE_
48 #error "malloc.h is required to use --enable-malloc-logging"
54 static FILE* log_output
;
55 static log_callback_t
*log_callbacks
= NULL
;
57 static long long last_time
;
58 static long long current_time
;
60 static long long start
;
62 static char *log_strings
[5] =
66 "Warn : ", /* want a space after each colon, all same width, colons aligned */
74 /* The log_puts() serves to somewhat different goals:
77 * - feeding low-level info to the user in GDB or Telnet
79 * The latter dictates that strings without newline are not logged, lest there
80 * will be *MANY log lines when sending one char at the time(e.g.
84 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
87 if (level
== LOG_LVL_OUTPUT
)
89 /* do not prepend any headers, just print out what we were given and return */
90 fputs(string
, log_output
);
95 f
= strrchr(file
, '/');
99 if (strchr(string
, '\n')!=NULL
)
101 if (debug_level
>= LOG_LVL_DEBUG
)
103 /* print with count and time information */
104 int t
=(int)(timeval_ms()-start
);
105 #ifdef _DEBUG_FREE_SPACE_
106 struct mallinfo info
;
109 fprintf(log_output
, "%s%d %d %s:%d %s()"
110 #ifdef _DEBUG_FREE_SPACE_
113 ": %s", log_strings
[level
+1], count
, t
, file
, line
, function
,
114 #ifdef _DEBUG_FREE_SPACE_
119 else if(server_use_pipes
== 0)
121 /* if we are using gdb through pipes then we do not want any output
122 * to the pipe otherwise we get repeated strings */
123 if (strcmp(string
, "\n") != 0)
125 /* print human readable output - but skip empty lines */
126 fprintf(log_output
, "%s%s",
127 (level
> LOG_LVL_USER
)?log_strings
[level
+1]:"", string
);
132 /* only entire lines are logged. Otherwise it's
133 * single chars intended for the log callbacks. */
138 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
139 if (level
<= LOG_LVL_INFO
)
141 log_callback_t
*cb
, *next
;
143 /* DANGER!!!! the log callback can remove itself!!!! */
147 cb
->fn(cb
->priv
, file
, line
, function
, string
);
153 void log_printf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
159 if (level
> debug_level
)
162 va_start(ap
, format
);
164 string
= alloc_vprintf(format
, ap
);
167 log_puts(level
, file
, line
, function
, string
);
174 void log_printf_lf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
180 if (level
> debug_level
)
183 va_start(ap
, format
);
185 string
= alloc_vprintf(format
, ap
);
188 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
189 log_puts(level
, file
, line
, function
, string
);
196 /* change the current debug level on the fly
199 * 2: + INFORMATIONAL MSGS
202 int handle_debug_level_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
205 command_print(cmd_ctx
, "debug_level: %i", debug_level
);
208 debug_level
= strtoul(args
[0], NULL
, 0);
216 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
218 /* if we are enabling debug info then we need to write to a log file
219 * otherwise the pipe will get full and cause issues with gdb */
220 FILE* file
= fopen("openocd.log", "w");
224 LOG_WARNING("enabling log output as we are using pipes");
231 int handle_log_output_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
235 FILE* file
= fopen(args
[0], "w");
246 int log_register_commands(struct command_context_s
*cmd_ctx
)
248 start
= timeval_ms();
249 register_command(cmd_ctx
, NULL
, "log_output", handle_log_output_command
,
250 COMMAND_ANY
, "redirect logging to <file> (default: stderr)");
251 register_command(cmd_ctx
, NULL
, "debug_level", handle_debug_level_command
,
252 COMMAND_ANY
, "adjust debug level <0-3>");
257 int log_init(struct command_context_s
*cmd_ctx
)
259 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
260 if (debug_level
== -1)
261 debug_level
= LOG_LVL_INFO
;
263 if (log_output
== NULL
)
268 start
=last_time
=timeval_ms();
273 int set_log_output(struct command_context_s
*cmd_ctx
, FILE *output
)
279 /* add/remove log callback handler */
280 int log_add_callback(log_callback_fn fn
, void *priv
)
284 /* prevent the same callback to be registered more than once, just for sure */
285 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
287 if (cb
->fn
== fn
&& cb
->priv
== priv
)
288 return ERROR_INVALID_ARGUMENTS
;
291 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
292 if ((cb
= malloc(sizeof(log_callback_t
))) == NULL
)
293 return ERROR_BUF_TOO_SMALL
;
295 /* add item to the beginning of the linked list */
298 cb
->next
= log_callbacks
;
304 int log_remove_callback(log_callback_fn fn
, void *priv
)
306 log_callback_t
*cb
, **p
;
308 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
310 if (cb
->fn
== fn
&& cb
->priv
== priv
)
319 return ERROR_INVALID_ARGUMENTS
;
322 /* return allocated string w/printf() result */
323 char *alloc_vprintf(const char *fmt
, va_list ap
)
325 /* no buffer at the beginning, force realloc to do the job */
328 /* start with buffer size suitable for typical messages */
336 string
= realloc(string
, size
);
344 va_copy(ap_copy
, ap
);
346 ret
= vsnprintf(string
, size
, fmt
, ap_copy
);
347 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
348 if ((ret
>= 0) && ((ret
+ 1) < size
))
351 /* there was just enough or not enough space, allocate more in the next round */
352 size
*= 2; /* double the buffer size */
355 /* the returned buffer is by principle guaranteed to be at least one character longer */
359 char *alloc_printf(const char *format
, ...)
363 va_start(ap
, format
);
364 string
= alloc_vprintf(format
, ap
);
369 /* Code must return to the server loop before 1000ms has returned or invoke
372 * The GDB connection will time out if it spends >2000ms and you'll get nasty
373 * error messages from GDB:
375 * Ignoring packet error, continuing...
376 * Reply contains invalid hex digit 116
378 * While it is possible use "set remotetimeout" to more than the default 2000ms
379 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
380 * GDB protocol and it is a bug in OpenOCD not to either return to the server
381 * loop or invoke keep_alive() every 1000ms.
383 * This function will send a keep alive packet if >500ms has passed since last time
386 * Note that this function can be invoked often, so it needs to be relatively
387 * fast when invoked more often than every 500ms.
392 current_time
=timeval_ms();
393 if (current_time
-last_time
>1000)
395 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
);
397 if (current_time
-last_time
>500)
399 /* this will keep the GDB connection alive */
400 LOG_USER_N("%s", "");
402 /* DANGER!!!! do not add code to invoke e.g. target event processing,
403 * jim timer processing, etc. it can cause infinite recursion +
404 * jim event callbacks need to happen at a well defined time,
405 * not anywhere keep_alive() is invoked.
407 * These functions should be invoked at a well defined spot in server.c
410 last_time
=current_time
;
414 /* reset keep alive timer without sending message */
417 current_time
=timeval_ms();
418 last_time
=current_time
;
421 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
422 void alive_sleep(int ms
)
426 for (i
=0; i
<ms
; i
+=napTime
)
428 int sleep_a_bit
=ms
-i
;
429 if (sleep_a_bit
>napTime
)
433 usleep(sleep_a_bit
*1000);
438 void busy_sleep(int ms
)
442 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)