gold/debug.h

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