jtag_vpi: added an option to stop simulation on exit
[fw/openocd] / src / helper / log.c
index 74fdd65726e1e18717bc4191ebda7755df36ddfb..8f48b928b5640791b1fd757be7d1150bdb24a742 100644 (file)
  *   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, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
+#include "log.h"
+#include "command.h"
 #include "time_support.h"
-/* @todo the inclusion of server.h here is a layering violation */
-#include <server/server.h>
 
 #include <stdarg.h>
 
@@ -47,65 +45,36 @@ int debug_level = -1;
 static FILE *log_output;
 static struct log_callback *log_callbacks;
 
-static long long last_time;
-static long long current_time;
+static int64_t last_time;
+static int64_t current_time;
 
-static long long start;
+static int64_t start;
 
-static char *log_strings[5] = {
+static const char * const log_strings[6] = {
        "User : ",
        "Error: ",
        "Warn : ",      /* want a space after each colon, all same width, colons aligned */
        "Info : ",
+       "Debug: ",
        "Debug: "
 };
 
 static int count;
 
-static struct store_log_forward *log_head;
-static int log_forward_count;
-
-struct store_log_forward {
-       struct store_log_forward *next;
-       const char *file;
-       int line;
-       const char *function;
-       const char *string;
-};
-
-/* either forward the log to the listeners or store it for possible forwarding later */
+/* forward the log to the listeners */
 static void log_forward(const char *file, unsigned line, const char *function, const char *string)
 {
-       if (log_forward_count == 0) {
-               struct log_callback *cb, *next;
-               cb = log_callbacks;
-               /* DANGER!!!! the log callback can remove itself!!!! */
-               while (cb) {
-                       next = cb->next;
-                       cb->fn(cb->priv, file, line, function, string);
-                       cb = next;
-               }
-       } else {
-               struct store_log_forward *log = malloc(sizeof(struct store_log_forward));
-               log->file = strdup(file);
-               log->line = line;
-               log->function = strdup(function);
-               log->string = strdup(string);
-               log->next = NULL;
-               if (log_head == NULL)
-                       log_head = log;
-               else {
-                       /* append to tail */
-                       struct store_log_forward *t;
-                       t = log_head;
-                       while (t->next != NULL)
-                               t = t->next;
-                       t->next = log;
-               }
+       struct log_callback *cb, *next;
+       cb = log_callbacks;
+       /* DANGER!!!! the log callback can remove itself!!!! */
+       while (cb) {
+               next = cb->next;
+               cb->fn(cb->priv, file, line, function, string);
+               cb = next;
        }
 }
 
-/* The log_puts() serves to somewhat different goals:
+/* The log_puts() serves two somewhat different goals:
  *
  * - logging
  * - feeding low-level info to the user in GDB or Telnet
@@ -136,12 +105,12 @@ static void log_puts(enum log_levels level,
        if (strlen(string) > 0) {
                if (debug_level >= LOG_LVL_DEBUG) {
                        /* print with count and time information */
-                       int t = (int)(timeval_ms()-start);
+                       int64_t t = timeval_ms() - start;
 #ifdef _DEBUG_FREE_SPACE_
                        struct mallinfo info;
                        info = mallinfo();
 #endif
-                       fprintf(log_output, "%s%d %d %s:%d %s()"
+                       fprintf(log_output, "%s%d %" PRId64 " %s:%d %s()"
 #ifdef _DEBUG_FREE_SPACE_
                                " %d"
 #endif
@@ -193,6 +162,30 @@ void log_printf(enum log_levels level,
        va_end(ap);
 }
 
+void log_vprintf_lf(enum log_levels level, const char *file, unsigned line,
+               const char *function, const char *format, va_list args)
+{
+       char *tmp;
+
+       count++;
+
+       if (level > debug_level)
+               return;
+
+       tmp = alloc_vprintf(format, args);
+
+       if (!tmp)
+               return;
+
+       /*
+        * Note: alloc_vprintf() guarantees that the buffer is at least one
+        * character longer.
+        */
+       strcat(tmp, "\n");
+       log_puts(level, file, line, function, tmp);
+       free(tmp);
+}
+
 void log_printf_lf(enum log_levels level,
        const char *file,
        unsigned line,
@@ -200,23 +193,10 @@ void log_printf_lf(enum log_levels level,
        const char *format,
        ...)
 {
-       char *string;
        va_list ap;
 
-       count++;
-       if (level > debug_level)
-               return;
-
        va_start(ap, format);
-
-       string = alloc_vprintf(format, ap);
-       if (string != NULL) {
-               strcat(string, "\n");   /* alloc_vprintf guaranteed the buffer to be at least one
-                                        *char longer */
-               log_puts(level, file, line, function, string);
-               free(string);
-       }
-
+       log_vprintf_lf(level, file, line, function, format, ap);
        va_end(ap);
 }
 
@@ -225,15 +205,15 @@ COMMAND_HANDLER(handle_debug_level_command)
        if (CMD_ARGC == 1) {
                int new_level;
                COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], new_level);
-               if ((debug_level > LOG_LVL_DEBUG) || (new_level < LOG_LVL_SILENT)) {
-                       LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT, LOG_LVL_DEBUG);
+               if ((new_level > LOG_LVL_DEBUG_IO) || (new_level < LOG_LVL_SILENT)) {
+                       LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT, LOG_LVL_DEBUG_IO);
                        return ERROR_COMMAND_SYNTAX_ERROR;
                }
                debug_level = new_level;
        } else if (CMD_ARGC > 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       command_print(CMD_CTX, "debug_level: %i", debug_level);
+       command_print(CMD, "debug_level: %i", debug_level);
 
        return ERROR_OK;
 }
@@ -242,15 +222,21 @@ COMMAND_HANDLER(handle_log_output_command)
 {
        if (CMD_ARGC == 1) {
                FILE *file = fopen(CMD_ARGV[0], "w");
-
-               if (file)
-                       log_output = file;
+               if (file == NULL) {
+                       LOG_ERROR("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;
        }
 
        return ERROR_OK;
 }
 
-static struct command_registration log_command_handlers[] = {
+static const struct command_registration log_command_handlers[] = {
        {
                .name = "log_output",
                .handler = handle_log_output_command,
@@ -264,7 +250,8 @@ static struct command_registration log_command_handlers[] = {
                .mode = COMMAND_ANY,
                .help = "Sets the verbosity level of debugging output. "
                        "0 shows errors only; 1 adds warnings; "
-                       "2 (default) adds other info; 3 adds debugging.",
+                       "2 (default) adds other info; 3 adds debugging; "
+                       "4 adds extra verbose debugging.",
                .usage = "number",
        },
        COMMAND_REGISTRATION_DONE
@@ -288,7 +275,7 @@ void log_init(void)
                int retval = parse_int(debug_env, &value);
                if (ERROR_OK == retval &&
                                debug_level >= LOG_LVL_SILENT &&
-                               debug_level <= LOG_LVL_DEBUG)
+                               debug_level <= LOG_LVL_DEBUG_IO)
                                debug_level = value;
        }
 
@@ -412,12 +399,12 @@ void keep_alive()
                if (gdb_actual_connections)
                        LOG_WARNING("keep_alive() was not invoked in the "
                                "1000ms timelimit. GDB alive packet not "
-                               "sent! (%lld). Workaround: increase "
+                               "sent! (%" PRId64 "). Workaround: increase "
                                "\"set remotetimeout\" in GDB",
                                current_time-last_time);
                else
                        LOG_DEBUG("keep_alive() was not invoked in the "
-                               "1000ms timelimit (%lld). This may cause "
+                               "1000ms timelimit (%" PRId64 "). This may cause "
                                "trouble with GDB connections.",
                                current_time-last_time);
        }
@@ -467,3 +454,28 @@ void busy_sleep(uint64_t ms)
                 */
        }
 }
+
+/* Maximum size of socket error message retreived from operation system */
+#define MAX_SOCKET_ERR_MSG_LENGTH 256
+
+/* Provide log message for the last socket error.
+   Uses errno on *nix and WSAGetLastError() on Windows */
+void log_socket_error(const char *socket_desc)
+{
+       int error_code;
+#ifdef _WIN32
+       error_code = WSAGetLastError();
+       char error_message[MAX_SOCKET_ERR_MSG_LENGTH];
+       error_message[0] = '\0';
+       DWORD retval = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, error_code, 0,
+               error_message, MAX_SOCKET_ERR_MSG_LENGTH, NULL);
+       error_message[MAX_SOCKET_ERR_MSG_LENGTH - 1] = '\0';
+       const bool have_message = (retval != 0) && (error_message[0] != '\0');
+       LOG_ERROR("Error on socket '%s': WSAGetLastError==%d%s%s.", socket_desc, error_code,
+               (have_message ? ", message: " : ""),
+               (have_message ? error_message : ""));
+#else
+       error_code = errno;
+       LOG_ERROR("Error on socket '%s': errno==%d, message: %s.", socket_desc, error_code, strerror(error_code));
+#endif
+}