target/xtensa: avoid IHI for writes to non-executable memory
[openocd.git] / src / helper / log.c
index 36b59fe77198bd528ca81da56be12140a92a05d6..471069adee713d380b1a7d510f9957438f88d4eb 100644 (file)
@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,19 +9,6 @@
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -30,6 +19,8 @@
 #include "command.h"
 #include "replacements.h"
 #include "time_support.h"
+#include <server/gdb_server.h>
+#include <server/server.h>
 
 #include <stdarg.h>
 
@@ -47,7 +38,6 @@ static FILE *log_output;
 static struct log_callback *log_callbacks;
 
 static int64_t last_time;
-static int64_t current_time;
 
 static int64_t start;
 
@@ -108,35 +98,30 @@ static void log_puts(enum log_levels level,
        }
 
        f = strrchr(file, '/');
-       if (f != NULL)
+       if (f)
                file = f + 1;
 
-       if (strlen(string) > 0) {
-               if (debug_level >= LOG_LVL_DEBUG) {
-                       /* print with count and time information */
-                       int64_t t = timeval_ms() - start;
+       if (debug_level >= LOG_LVL_DEBUG) {
+               /* print with count and time information */
+               int64_t t = timeval_ms() - start;
 #ifdef _DEBUG_FREE_SPACE_
-                       struct mallinfo info;
-                       info = mallinfo();
+               struct mallinfo info;
+               info = mallinfo();
 #endif
-                       fprintf(log_output, "%s%d %" PRId64 " %s:%d %s()"
+               fprintf(log_output, "%s%d %" PRId64 " %s:%d %s()"
 #ifdef _DEBUG_FREE_SPACE_
-                               " %d"
+                       " %d"
 #endif
-                               ": %s", log_strings[level + 1], count, t, file, line, function,
+                       ": %s", log_strings[level + 1], count, t, file, line, function,
 #ifdef _DEBUG_FREE_SPACE_
-                               info.fordblks,
+                       info.fordblks,
 #endif
-                               string);
-               } else {
-                       /* if we are using gdb through pipes then we do not want any output
-                        * to the pipe otherwise we get repeated strings */
-                       fprintf(log_output, "%s%s",
-                               (level > LOG_LVL_USER) ? log_strings[level + 1] : "", string);
-               }
+                       string);
        } else {
-               /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
-                *nothing. */
+               /* if we are using gdb through pipes then we do not want any output
+                * to the pipe otherwise we get repeated strings */
+               fprintf(log_output, "%s%s",
+                       (level > LOG_LVL_USER) ? log_strings[level + 1] : "", string);
        }
 
        fflush(log_output);
@@ -163,7 +148,7 @@ void log_printf(enum log_levels level,
        va_start(ap, format);
 
        string = alloc_vprintf(format, ap);
-       if (string != NULL) {
+       if (string) {
                log_puts(level, file, line, function, string);
                free(string);
        }
@@ -229,31 +214,28 @@ COMMAND_HANDLER(handle_debug_level_command)
 
 COMMAND_HANDLER(handle_log_output_command)
 {
-       if (CMD_ARGC == 0 || (CMD_ARGC == 1 && strcmp(CMD_ARGV[0], "default") == 0)) {
-               if (log_output != stderr && log_output != NULL) {
-                       /* Close previous log file, if it was open and wasn't stderr. */
-                       fclose(log_output);
-               }
-               log_output = stderr;
-               LOG_DEBUG("set log_output to default");
-               return ERROR_OK;
-       }
-       if (CMD_ARGC == 1) {
-               FILE *file = fopen(CMD_ARGV[0], "w");
-               if (file == NULL) {
-                       LOG_ERROR("failed to open output log '%s'", CMD_ARGV[0]);
+       if (CMD_ARGC > 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       FILE *file;
+       if (CMD_ARGC == 1 && strcmp(CMD_ARGV[0], "default") != 0) {
+               file = fopen(CMD_ARGV[0], "w");
+               if (!file) {
+                       command_print(CMD, "failed to open output log \"%s\"", CMD_ARGV[0]);
                        return ERROR_FAIL;
                }
-               if (log_output != stderr && log_output != NULL) {
-                       /* Close previous log file, if it was open and wasn't stderr. */
-                       fclose(log_output);
-               }
-               log_output = file;
-               LOG_DEBUG("set log_output to \"%s\"", CMD_ARGV[0]);
-               return ERROR_OK;
+               command_print(CMD, "set log_output to \"%s\"", CMD_ARGV[0]);
+       } else {
+               file = stderr;
+               command_print(CMD, "set log_output to default");
        }
 
-       return ERROR_COMMAND_SYNTAX_ERROR;
+       if (log_output != stderr && log_output) {
+               /* Close previous log file, if it was open and wasn't stderr. */
+               fclose(log_output);
+       }
+       log_output = file;
+       return ERROR_OK;
 }
 
 static const struct command_registration log_command_handlers[] = {
@@ -262,7 +244,7 @@ static const struct command_registration log_command_handlers[] = {
                .handler = handle_log_output_command,
                .mode = COMMAND_ANY,
                .help = "redirect logging to a file (default: stderr)",
-               .usage = "[file_name | \"default\"]",
+               .usage = "[file_name | 'default']",
        },
        {
                .name = "debug_level",
@@ -287,25 +269,28 @@ void log_init(void)
        /* set defaults for daemon configuration,
         * if not set by cmdline or cfgfile */
        char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
-       if (NULL != debug_env) {
+       if (debug_env) {
                int value;
                int retval = parse_int(debug_env, &value);
-               if (ERROR_OK == retval &&
+               if (retval == ERROR_OK &&
                                debug_level >= LOG_LVL_SILENT &&
                                debug_level <= LOG_LVL_DEBUG_IO)
                                debug_level = value;
        }
 
-       if (log_output == NULL)
+       if (!log_output)
                log_output = stderr;
 
        start = last_time = timeval_ms();
 }
 
-int set_log_output(struct command_context *cmd_ctx, FILE *output)
+void log_exit(void)
 {
-       log_output = output;
-       return ERROR_OK;
+       if (log_output && log_output != stderr) {
+               /* Close log file, if it was open and wasn't stderr. */
+               fclose(log_output);
+       }
+       log_output = NULL;
 }
 
 /* add/remove log callback handler */
@@ -322,7 +307,7 @@ int log_add_callback(log_callback_fn fn, void *priv)
        /* alloc memory, it is safe just to return in case of an error, no need for the caller to
         *check this */
        cb = malloc(sizeof(struct log_callback));
-       if (cb == NULL)
+       if (!cb)
                return ERROR_BUF_TOO_SMALL;
 
        /* add item to the beginning of the linked list */
@@ -367,7 +352,7 @@ char *alloc_vprintf(const char *fmt, va_list ap)
         * other code depend on that. They should be probably be fixed, but for
         * now reserve the extra byte. */
        string = malloc(len + 2);
-       if (string == NULL)
+       if (!string)
                return NULL;
 
        /* do the real work */
@@ -412,9 +397,7 @@ char *alloc_printf(const char *format, ...)
 
 static void gdb_timeout_warning(int64_t delta_time)
 {
-       extern int gdb_actual_connections;
-
-       if (gdb_actual_connections)
+       if (gdb_get_actual_connections())
                LOG_WARNING("keep_alive() was not invoked in the "
                        "%d ms timelimit. GDB alive packet not "
                        "sent! (%" PRId64 " ms). Workaround: increase "
@@ -431,8 +414,7 @@ static void gdb_timeout_warning(int64_t delta_time)
 
 void keep_alive(void)
 {
-       current_time = timeval_ms();
-
+       int64_t current_time = timeval_ms();
        int64_t delta_time = current_time - last_time;
 
        if (delta_time > KEEP_ALIVE_TIMEOUT_MS) {
@@ -445,7 +427,7 @@ void keep_alive(void)
                last_time = current_time;
 
                /* this will keep the GDB connection alive */
-               LOG_USER_N("%s", "");
+               server_keep_clients_alive();
 
                /* DANGER!!!! do not add code to invoke e.g. target event processing,
                 * jim timer processing, etc. it can cause infinite recursion +
@@ -460,7 +442,7 @@ void keep_alive(void)
 /* reset keep alive timer without sending message */
 void kept_alive(void)
 {
-       current_time = timeval_ms();
+       int64_t current_time = timeval_ms();
 
        int64_t delta_time = current_time - last_time;
 
@@ -473,11 +455,11 @@ void kept_alive(void)
 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittently */
 void alive_sleep(uint64_t ms)
 {
-       uint64_t napTime = 10;
-       for (uint64_t i = 0; i < ms; i += napTime) {
+       uint64_t nap_time = 10;
+       for (uint64_t i = 0; i < ms; i += nap_time) {
                uint64_t sleep_a_bit = ms - i;
-               if (sleep_a_bit > napTime)
-                       sleep_a_bit = napTime;
+               if (sleep_a_bit > nap_time)
+                       sleep_a_bit = nap_time;
 
                usleep(sleep_a_bit * 1000);
                keep_alive();

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)