1// debug.h -- gold internal debugging support   -*- C++ -*-
2
3// Copyright (C) 2007-2017 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
31namespace gold
32{
33
34// The different types of debugging we support.  These are bitflags.
35
36const int DEBUG_TASK = 0x1;
37const int DEBUG_SCRIPT = 0x2;
38const int DEBUG_FILES = 0x4;
39const int DEBUG_RELAXATION = 0x8;
40const int DEBUG_INCREMENTAL = 0x10;
41const int DEBUG_LOCATION = 0x20;
42const int DEBUG_TARGET = 0x40;
43
44const int DEBUG_ALL = (DEBUG_TASK | DEBUG_SCRIPT | DEBUG_FILES
45		       | DEBUG_RELAXATION | DEBUG_INCREMENTAL
46		       | DEBUG_LOCATION | DEBUG_TARGET);
47
48// Convert a debug string to the appropriate enum.
49inline int
50debug_string_to_enum(const char* arg)
51{
52  static const struct { const char* name; int value; }
53  debug_options[] =
54  {
55    { "task", DEBUG_TASK },
56    { "script", DEBUG_SCRIPT },
57    { "files", DEBUG_FILES },
58    { "relaxation", DEBUG_RELAXATION },
59    { "incremental", DEBUG_INCREMENTAL },
60    { "location", DEBUG_LOCATION },
61    { "target", DEBUG_TARGET },
62    { "all", DEBUG_ALL }
63  };
64
65  int retval = 0;
66  for (size_t i = 0; i < sizeof(debug_options) / sizeof(*debug_options); ++i)
67    if (strstr(arg, debug_options[i].name))
68      retval |= debug_options[i].value;
69  return retval;
70}
71
72// Print a debug message if TYPE is enabled.  This is a macro so that
73// we only evaluate the arguments if necessary.
74
75#define gold_debug(TYPE, ...)					\
76  do								\
77    {								\
78      if (is_debugging_enabled(TYPE))				\
79	parameters->errors()->debug(__VA_ARGS__);		\
80    }								\
81  while (0)
82
83} // End namespace gold.
84
85#endif // !defined(GOLD_DEBUG_H)
86