[deliverable/binutils-gdb.git] / gold / debug.h

// debug.h -- gold internal debugging support   -*- C++ -*-

// Copyright (C) 2007-2016 Free Software Foundation, Inc.
// Written by Ian Lance Taylor <iant@google.com>.

// This file is part of gold.

// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
// MA 02110-1301, USA.

#ifndef GOLD_DEBUG_H
#define GOLD_DEBUG_H

#include <cstring>

#include "parameters.h"
#include "errors.h"

namespace gold
{

// The different types of debugging we support.  These are bitflags.

const int DEBUG_TASK = 0x1;
const int DEBUG_SCRIPT = 0x2;
const int DEBUG_FILES = 0x4;
const int DEBUG_RELAXATION = 0x8;
const int DEBUG_INCREMENTAL = 0x10;
const int DEBUG_LOCATION = 0x20;

const int DEBUG_ALL = (DEBUG_TASK | DEBUG_SCRIPT | DEBUG_FILES
		       | DEBUG_RELAXATION | DEBUG_INCREMENTAL
		       | DEBUG_LOCATION);

// Convert a debug string to the appropriate enum.
inline int
debug_string_to_enum(const char* arg)
{
  static const struct { const char* name; int value; }
  debug_options[] =
  {
    { "task", DEBUG_TASK },
    { "script", DEBUG_SCRIPT },
    { "files", DEBUG_FILES },
    { "relaxation", DEBUG_RELAXATION },
    { "incremental", DEBUG_INCREMENTAL },
    { "location", DEBUG_LOCATION },
    { "all", DEBUG_ALL }
  };

  int retval = 0;
  for (size_t i = 0; i < sizeof(debug_options) / sizeof(*debug_options); ++i)
    if (strstr(arg, debug_options[i].name))
      retval |= debug_options[i].value;
  return retval;
}

// Print a debug message if TYPE is enabled.  This is a macro so that
// we only evaluate the arguments if necessary.

#define gold_debug(TYPE, FORMAT, ...)				\
  do								\
    {								\
      if (is_debugging_enabled(TYPE))				\
	parameters->errors()->debug(FORMAT, __VA_ARGS__);	\
    }								\
  while (0)

} // End namespace gold.

#endif // !defined(GOLD_DEBUG_H)
Commit	Line	Data
c7912668 ILT	1	// debug.h -- gold internal debugging support -- C++ --
c7912668 ILT	2
6f2750fe	3	// Copyright (C) 2007-2016 Free Software Foundation, Inc.
c7912668 ILT	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
04bf7072 ILT	26	#include <cstring>
04bf7072 ILT	27
c7912668 ILT	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
2285a610 ILT	36	const int DEBUG_TASK = 0x1;
	37	const int DEBUG_SCRIPT = 0x2;
	38	const int DEBUG_FILES = 0x4;
20e6d0d6	39	const int DEBUG_RELAXATION = 0x8;
8c21d9d3	40	const int DEBUG_INCREMENTAL = 0x10;
437ddf0c	41	const int DEBUG_LOCATION = 0x20;
c7912668	42
20e6d0d6	43	const int DEBUG_ALL = (DEBUG_TASK \| DEBUG_SCRIPT \| DEBUG_FILES
437ddf0c CC	44	\| DEBUG_RELAXATION \| DEBUG_INCREMENTAL
437ddf0c CC	45	\| DEBUG_LOCATION);
c7912668	46
ee1fe73e ILT	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 },
2285a610	56	{ "files", DEBUG_FILES },
20e6d0d6	57	{ "relaxation", DEBUG_RELAXATION },
8c21d9d3	58	{ "incremental", DEBUG_INCREMENTAL },
437ddf0c	59	{ "location", DEBUG_LOCATION },
ee1fe73e ILT	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
c7912668 ILT	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)