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 */
68 static struct store_log_forward
* log_head
= NULL
;
69 static int log_forward_count
= 0;
71 struct store_log_forward
73 struct store_log_forward
* next
;
76 const char * function
;
80 /* either forward the log to the listeners or store it for possible forwarding later */
81 static void log_forward(const char *file
, int line
, const char *function
, const char *string
)
83 if (log_forward_count
==0)
85 log_callback_t
*cb
, *next
;
87 /* DANGER!!!! the log callback can remove itself!!!! */
91 cb
->fn(cb
->priv
, file
, line
, function
, string
);
96 struct store_log_forward
*log
= malloc(sizeof (struct store_log_forward
));
97 log
->file
= strdup(file
);
99 log
->function
= strdup(function
);
100 log
->string
= strdup(string
);
107 struct store_log_forward
* t
;
109 while (t
->next
!=NULL
)
125 assert(log_forward_count
>0);
129 void log_rethrow(void)
132 if (log_forward_count
==0)
134 struct store_log_forward
*log
;
139 log_forward(log
->file
, log
->line
, log
->function
, log
->string
);
141 struct store_log_forward
*t
=log
;
144 free((void *)t
->file
);
145 free((void *)t
->function
);
146 free((void *)t
->string
);
156 /* The log_puts() serves to somewhat different goals:
159 * - feeding low-level info to the user in GDB or Telnet
161 * The latter dictates that strings without newline are not logged, lest there
162 * will be *MANY log lines when sending one char at the time(e.g.
166 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
169 if (level
== LOG_LVL_OUTPUT
)
171 /* do not prepend any headers, just print out what we were given and return */
172 fputs(string
, log_output
);
177 f
= strrchr(file
, '/');
181 if (strchr(string
, '\n') != NULL
)
183 if (debug_level
>= LOG_LVL_DEBUG
)
185 /* print with count and time information */
186 int t
= (int)(timeval_ms()-start
);
187 #ifdef _DEBUG_FREE_SPACE_
188 struct mallinfo info
;
191 fprintf(log_output
, "%s%d %d %s:%d %s()"
192 #ifdef _DEBUG_FREE_SPACE_
195 ": %s", log_strings
[level
+ 1], count
, t
, file
, line
, function
,
196 #ifdef _DEBUG_FREE_SPACE_
201 else if (server_use_pipes
== 0)
203 /* if we are using gdb through pipes then we do not want any output
204 * to the pipe otherwise we get repeated strings */
205 if (strcmp(string
, "\n") != 0)
207 /* print human readable output - but skip empty lines */
208 fprintf(log_output
, "%s%s",
209 (level
> LOG_LVL_USER
)?log_strings
[level
+ 1]:"", string
);
214 /* only entire lines are logged. Otherwise it's
215 * single chars intended for the log callbacks. */
220 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
221 if (level
<= LOG_LVL_INFO
)
223 log_forward(file
, line
, function
, string
);
228 void log_printf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
234 if (level
> debug_level
)
237 va_start(ap
, format
);
239 string
= alloc_vprintf(format
, ap
);
242 log_puts(level
, file
, line
, function
, string
);
249 void log_printf_lf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
255 if (level
> debug_level
)
258 va_start(ap
, format
);
260 string
= alloc_vprintf(format
, ap
);
263 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
264 log_puts(level
, file
, line
, function
, string
);
271 /* change the current debug level on the fly
274 * 2: + INFORMATIONAL MSGS
277 int handle_debug_level_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
282 int retval
= parse_uint(args
[0], &new_level
);
283 if (ERROR_OK
!= retval
)
285 debug_level
= MIN(new_level
, LOG_LVL_DEBUG
);
288 return ERROR_COMMAND_SYNTAX_ERROR
;
290 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
292 /* if we are enabling debug info then we need to write to a log file
293 * otherwise the pipe will get full and cause issues with gdb */
294 FILE* file
= fopen("openocd.log", "w");
298 LOG_WARNING("enabling log output as we are using pipes");
302 command_print(cmd_ctx
, "debug_level: %i", debug_level
);
307 int handle_log_output_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
311 FILE* file
= fopen(args
[0], "w");
322 int log_register_commands(struct command_context_s
*cmd_ctx
)
324 start
= timeval_ms();
325 register_command(cmd_ctx
, NULL
, "log_output", handle_log_output_command
,
326 COMMAND_ANY
, "redirect logging to <file> (default: stderr)");
327 register_command(cmd_ctx
, NULL
, "debug_level", handle_debug_level_command
,
328 COMMAND_ANY
, "adjust debug level <0-3>");
333 int log_init(struct command_context_s
*cmd_ctx
)
335 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
336 if (debug_level
== -1)
337 debug_level
= LOG_LVL_INFO
;
339 if (log_output
== NULL
)
344 start
= last_time
= timeval_ms();
349 int set_log_output(struct command_context_s
*cmd_ctx
, FILE *output
)
355 /* add/remove log callback handler */
356 int log_add_callback(log_callback_fn fn
, void *priv
)
360 /* prevent the same callback to be registered more than once, just for sure */
361 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
363 if (cb
->fn
== fn
&& cb
->priv
== priv
)
364 return ERROR_INVALID_ARGUMENTS
;
367 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
368 if ((cb
= malloc(sizeof(log_callback_t
))) == NULL
)
369 return ERROR_BUF_TOO_SMALL
;
371 /* add item to the beginning of the linked list */
374 cb
->next
= log_callbacks
;
380 int log_remove_callback(log_callback_fn fn
, void *priv
)
382 log_callback_t
*cb
, **p
;
384 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
386 if (cb
->fn
== fn
&& cb
->priv
== priv
)
395 return ERROR_INVALID_ARGUMENTS
;
398 /* return allocated string w/printf() result */
399 char *alloc_vprintf(const char *fmt
, va_list ap
)
401 /* no buffer at the beginning, force realloc to do the job */
404 /* start with buffer size suitable for typical messages */
412 string
= realloc(string
, size
);
420 va_copy(ap_copy
, ap
);
422 ret
= vsnprintf(string
, size
, fmt
, ap_copy
);
423 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
424 if ((ret
>= 0) && ((ret
+ 1) < size
))
427 /* there was just enough or not enough space, allocate more in the next round */
428 size
*= 2; /* double the buffer size */
431 /* the returned buffer is by principle guaranteed to be at least one character longer */
435 char *alloc_printf(const char *format
, ...)
439 va_start(ap
, format
);
440 string
= alloc_vprintf(format
, ap
);
445 /* Code must return to the server loop before 1000ms has returned or invoke
448 * The GDB connection will time out if it spends >2000ms and you'll get nasty
449 * error messages from GDB:
451 * Ignoring packet error, continuing...
452 * Reply contains invalid hex digit 116
454 * While it is possible use "set remotetimeout" to more than the default 2000ms
455 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
456 * GDB protocol and it is a bug in OpenOCD not to either return to the server
457 * loop or invoke keep_alive() every 1000ms.
459 * This function will send a keep alive packet if >500ms has passed since last time
462 * Note that this function can be invoked often, so it needs to be relatively
463 * fast when invoked more often than every 500ms.
468 current_time
= timeval_ms();
469 if (current_time
-last_time
> 1000)
471 extern int gdb_actual_connections
;
473 if (gdb_actual_connections
)
474 LOG_WARNING("keep_alive() was not invoked in the "
475 "1000ms timelimit. GDB alive packet not "
476 "sent! (%lld). Workaround: increase "
477 "\"set remotetimeout\" in GDB",
478 current_time
-last_time
);
480 LOG_DEBUG("keep_alive() was not invoked in the "
481 "1000ms timelimit (%lld). This may cause "
482 "trouble with GDB connections.",
483 current_time
-last_time
);
485 if (current_time
-last_time
> 500)
487 /* this will keep the GDB connection alive */
488 LOG_USER_N("%s", "");
490 /* DANGER!!!! do not add code to invoke e.g. target event processing,
491 * jim timer processing, etc. it can cause infinite recursion +
492 * jim event callbacks need to happen at a well defined time,
493 * not anywhere keep_alive() is invoked.
495 * These functions should be invoked at a well defined spot in server.c
498 last_time
= current_time
;
502 /* reset keep alive timer without sending message */
505 current_time
= timeval_ms();
506 last_time
= current_time
;
509 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
510 void alive_sleep(int ms
)
514 for (i
= 0; i
< ms
; i
+= napTime
)
516 int sleep_a_bit
= ms
-i
;
517 if (sleep_a_bit
> napTime
)
519 sleep_a_bit
= napTime
;
521 usleep(sleep_a_bit
*1000);
526 void busy_sleep(int ms
)
530 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)