gdbserver/debug.h

   1 /* Debugging routines for the remote server for GDB.
   2    Copyright (C) 2014-2021 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 #ifndef GDBSERVER_DEBUG_H
  20 #define GDBSERVER_DEBUG_H
  21
  22 #if !defined (IN_PROCESS_AGENT)
  23 extern int remote_debug;
  24
  25 /* Switch all debug output to DEBUG_FILE.  If DEBUG_FILE is nullptr or an
  26    empty string, or if the file cannot be opened, then debug output is sent to
  27    stderr.  */
  28 void debug_set_output (const char *debug_file);
  29 #endif
  30
  31 extern int using_threads;
  32
  33 /* Enable miscellaneous debugging output.  The name is historical - it
  34    was originally used to debug LinuxThreads support.  */
  35
  36 extern int debug_threads;
  37
  38 extern int debug_timestamp;
  39
  40 void debug_flush (void);
  41 void do_debug_enter (const char *function_name);
  42 void do_debug_exit (const char *function_name);
  43
  44 /* Async signal safe debug output function that calls write directly.  */
  45 ssize_t debug_write (const void *buf, size_t nbyte);
  46
  47 /* These macros are for use in major functions that produce a lot of
  48    debugging output.  They help identify in the mass of debugging output
  49    when these functions enter and exit.  debug_enter is intended to be
  50    called at the start of a function, before any other debugging output.
  51    debug_exit is intended to be called at the end of the same function,
  52    after all debugging output.  */
  53 #ifdef FUNCTION_NAME
  54 #define debug_enter() \
  55   do { do_debug_enter (FUNCTION_NAME); } while (0)
  56 #define debug_exit() \
  57   do { do_debug_exit (FUNCTION_NAME); } while (0)
  58 #else
  59 #define debug_enter() \
  60   do { } while (0)
  61 #define debug_exit() \
  62   do { } while (0)
  63 #endif
  64
  65 #endif /* GDBSERVER_DEBUG_H */