gold/errors.h

   1 // errors.h -- handle errors for gold  -*- C++ -*-
   2
   3 // Copyright 2006, 2007, 2008 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_ERRORS_H
  24 #define GOLD_ERRORS_H
  25
  26 #include <cstdarg>
  27
  28 #include "gold-threads.h"
  29
  30 namespace gold
  31 {
  32
  33 class Symbol;
  34 template<int size, bool big_endian>
  35 struct Relocate_info;
  36
  37 // This class handles errors for gold.  There is a single instance
  38 // which is used by all threads.  If and when we make the gold code
  39 // more amenable to being used in a library, we will make this an
  40 // abstract interface class, and expect the caller to provide their
  41 // own instantiation.
  42
  43 class Errors
  44 {
  45  public:
  46   Errors(const char* program_name);
  47
  48   // Report a fatal error.  After printing the error, this must exit.
  49   void
  50   fatal(const char* format, va_list) ATTRIBUTE_NORETURN;
  51
  52   // Report an error and continue.
  53   void
  54   error(const char* format, va_list);
  55
  56   // Report a warning and continue.
  57   void
  58   warning(const char* format, va_list);
  59
  60   // Report an error at a reloc location.
  61   template<int size, bool big_endian>
  62   void
  63   error_at_location(const Relocate_info<size, big_endian>* relinfo,
  64                     size_t relnum, off_t reloffset,
  65                     const char* format, va_list);
  66
  67   // Report a warning at a reloc location.
  68   template<int size, bool big_endian>
  69   void
  70   warning_at_location(const Relocate_info<size, big_endian>* relinfo,
  71                       size_t relnum, off_t reloffset,
  72                       const char* format, va_list);
  73
  74   // Issue an undefined symbol error.  SYM is the undefined symbol.
  75   // RELINFO is the general relocation info.  RELNUM is the number of
  76   // the reloc, and RELOFFSET is the reloc's offset.
  77   template<int size, bool big_endian>
  78   void
  79   undefined_symbol(const Symbol* sym,
  80                    const Relocate_info<size, big_endian>* relinfo,
  81                    size_t relnum, off_t reloffset);
  82
  83   // Report a debugging message.
  84   void
  85   debug(const char* format, ...) ATTRIBUTE_PRINTF_2;
  86
  87   // Return the number of errors.
  88   int
  89   error_count() const
  90   { return this->error_count_; }
  91
  92  private:
  93   Errors(const Errors&);
  94   Errors& operator=(const Errors&);
  95
  96   // Initialize the lock.  We don't do this in the constructor because
  97   // lock initialization wants to know whether we are using threads or
  98   // not.  This returns true if the lock is now initialized.
  99   bool
 100   initialize_lock();
 101
 102   // Increment a counter, holding the lock.
 103   void
 104   increment_counter(int*);
 105
 106   // The number of times we report an undefined symbol.
 107   static const int max_undefined_error_report = 5;
 108
 109   // The name of the program.
 110   const char* program_name_;
 111   // This class can be accessed from multiple threads.  This lock is
 112   // used to control access to the data structures.
 113   Lock* lock_;
 114   // Numbers of errors reported.
 115   int error_count_;
 116   // Number of warnings reported.
 117   int warning_count_;
 118   // A map counting the numbers of times we have seen an undefined
 119   // symbol.
 120   Unordered_map<const Symbol*, int> undefined_symbols_;
 121 };
 122
 123 } // End namespace gold.
 124
 125 #endif // !defined(GOLD_ERRORS_H)