7c4c77afe245f3b269f0db71b848c857bce3b694
[external/binutils.git] / gdb / gdbserver / debug.c
1 /* Debugging routines for the remote server for GDB.
2    Copyright (C) 2014-2019 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 <chrono>
21
22 #if !defined (IN_PROCESS_AGENT)
23 int remote_debug = 0;
24 #endif
25
26 /* Enable miscellaneous debugging output.  The name is historical - it
27    was originally used to debug LinuxThreads support.  */
28 int debug_threads;
29
30 /* Include timestamps in debugging output.  */
31 int debug_timestamp;
32
33 /* Print a debugging message.
34    If the text begins a new line it is preceded by a timestamp.
35    We don't get fancy with newline checking, we just check whether the
36    previous call ended with "\n".  */
37
38 void
39 debug_vprintf (const char *format, va_list ap)
40 {
41 #if !defined (IN_PROCESS_AGENT)
42   /* N.B. Not thread safe, and can't be used, as is, with IPA.  */
43   static int new_line = 1;
44
45   if (debug_timestamp && new_line)
46     {
47       using namespace std::chrono;
48
49       steady_clock::time_point now = steady_clock::now ();
50       seconds s = duration_cast<seconds> (now.time_since_epoch ());
51       microseconds us = duration_cast<microseconds> (now.time_since_epoch ()) - s;
52
53       fprintf (stderr, "%ld.%06ld ", (long) s.count (), (long) us.count ());
54     }
55 #endif
56
57   vfprintf (stderr, format, ap);
58
59 #if !defined (IN_PROCESS_AGENT)
60   if (*format)
61     new_line = format[strlen (format) - 1] == '\n';
62 #endif
63 }
64
65 /* Flush debugging output.
66    This is called, for example, when starting an inferior to ensure all debug
67    output thus far appears before any inferior output.  */
68
69 void
70 debug_flush (void)
71 {
72   fflush (stderr);
73 }
74
75 /* Notify the user that the code is entering FUNCTION_NAME.
76    FUNCTION_NAME is the name of the calling function, or NULL if unknown.
77
78    This is intended to be called via the debug_enter macro.  */
79
80 void
81 do_debug_enter (const char *function_name)
82 {
83   if (function_name != NULL)
84     debug_printf (">>>> entering %s\n", function_name);
85 }
86
87 /* Notify the user that the code is exiting FUNCTION_NAME.
88    FUNCTION_NAME is the name of the calling function, or NULL if unknown.
89
90    This is intended to be called via the debug_exit macro.  */
91
92 void
93 do_debug_exit (const char *function_name)
94 {
95   if (function_name != NULL)
96     debug_printf ("<<<< exiting %s\n", function_name);
97 }