gdb/gdbserver/debug.c

   1 /* Debugging routines for the remote server for GDB.
   2    Copyright (C) 2014 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "server.h"
  20 #include <sys/time.h>
  21
  22 /* Enable miscellaneous debugging output.  The name is historical - it
  23    was originally used to debug LinuxThreads support.  */
  24 int debug_threads;
  25
  26 /* Include timestamps in debugging output.  */
  27 int debug_timestamp;
  28
  29 /* Print a debugging message.
  30    If the text begins a new line it is preceded by a timestamp, if the
  31    system has gettimeofday.
  32    We don't get fancy with newline checking, we just check whether the
  33    previous call ended with "\n".  */
  34
  35 void
  36 debug_printf (const char *msg, ...)
  37 {
  38   va_list args;
  39 #if defined (HAVE_GETTIMEOFDAY) && !defined (IN_PROCESS_AGENT)
  40   /* N.B. Not thread safe, and can't be used, as is, with IPA.  */
  41   static int new_line = 1;
  42
  43   if (debug_timestamp && new_line)
  44     {
  45       struct timeval tm;
  46
  47       gettimeofday (&tm, NULL);
  48
  49       /* If gettimeofday doesn't exist, and as a portability solution it has
  50          been replaced with, e.g., time, then it doesn't make sense to print
  51          the microseconds field.  Is there a way to check for that?  */
  52       fprintf (stderr, "%ld:%06ld ", (long) tm.tv_sec, (long) tm.tv_usec);
  53     }
  54 #endif
  55
  56   va_start (args, msg);
  57   vfprintf (stderr, msg, args);
  58   va_end (args);
  59
  60 #if defined (HAVE_GETTIMEOFDAY) && !defined (IN_PROCESS_AGENT)
  61   if (*msg)
  62     new_line = msg[strlen (msg) - 1] == '\n';
  63 #endif
  64 }
  65
  66 /* Flush debugging output.
  67    This is called, for example, when starting an inferior to ensure all debug
  68    output thus far appears before any inferior output.  */
  69
  70 void
  71 debug_flush (void)
  72 {
  73   fflush (stderr);
  74 }
  75
  76 /* Notify the user that the code is entering FUNCTION_NAME.
  77    FUNCTION_NAME is the name of the calling function, or NULL if unknown.
  78
  79    This is intended to be called via the debug_enter macro.  */
  80
  81 void
  82 do_debug_enter (const char *function_name)
  83 {
  84   if (function_name != NULL)
  85     debug_printf (">>>> entering %s\n", function_name);
  86 }
  87
  88 /* Notify the user that the code is exiting FUNCTION_NAME.
  89    FUNCTION_NAME is the name of the calling function, or NULL if unknown.
  90
  91    This is intended to be called via the debug_exit macro.  */
  92
  93 void
  94 do_debug_exit (const char *function_name)
  95 {
  96   if (function_name != NULL)
  97     debug_printf ("<<<< exiting %s\n", function_name);
  98 }