1 // debug.h -- gold internal debugging support   -*- C++ -*-
2 
3 // Copyright (C) 2007-2020 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
5 
6 // This file is part of gold.
7 
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
12 
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
22 
23 #ifndef GOLD_DEBUG_H
24 #define GOLD_DEBUG_H
25 
26 #include <cstring>
27 
28 #include "parameters.h"
29 #include "errors.h"
30 
31 namespace gold
32 {
33 
34 // The different types of debugging we support.  These are bitflags.
35 
36 const int DEBUG_TASK = 0x1;
37 const int DEBUG_SCRIPT = 0x2;
38 const int DEBUG_FILES = 0x4;
39 const int DEBUG_RELAXATION = 0x8;
40 const int DEBUG_INCREMENTAL = 0x10;
41 const int DEBUG_LOCATION = 0x20;
42 const int DEBUG_TARGET = 0x40;
43 const int DEBUG_PLUGIN = 0x80;
44 
45 const int DEBUG_ALL = (DEBUG_TASK | DEBUG_SCRIPT | DEBUG_FILES
46 		       | DEBUG_RELAXATION | DEBUG_INCREMENTAL
47 		       | DEBUG_LOCATION | DEBUG_TARGET | DEBUG_PLUGIN);
48 
49 // Convert a debug string to the appropriate enum.
50 inline int
51 debug_string_to_enum(const char* arg)
52 {
53   static const struct { const char* name; int value; }
54   debug_options[] =
55   {
56     { "task", DEBUG_TASK },
57     { "script", DEBUG_SCRIPT },
58     { "files", DEBUG_FILES },
59     { "relaxation", DEBUG_RELAXATION },
60     { "incremental", DEBUG_INCREMENTAL },
61     { "location", DEBUG_LOCATION },
62     { "target", DEBUG_TARGET },
63     { "plugin", DEBUG_PLUGIN },
64     { "all", DEBUG_ALL }
65   };
66 
67   int retval = 0;
68   for (size_t i = 0; i < sizeof(debug_options) / sizeof(*debug_options); ++i)
69     if (strstr(arg, debug_options[i].name))
70       retval |= debug_options[i].value;
71   return retval;
72 }
73 
74 // Print a debug message if TYPE is enabled.  This is a macro so that
75 // we only evaluate the arguments if necessary.
76 
77 #define gold_debug(TYPE, ...)					\
78   do								\
79     {								\
80       if (is_debugging_enabled(TYPE))				\
81 	parameters->errors()->debug(__VA_ARGS__);		\
82     }								\
83   while (0)
84 
85 } // End namespace gold.
86 
87 #endif // !defined(GOLD_DEBUG_H)
88