libdwfl/dwfl_error.c

   1 /* Error handling in libdwfl.
   2    Copyright (C) 2005-2010 Red Hat, Inc.
   3    This file is part of Red Hat elfutils.
   4
   5    Red Hat elfutils is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by the
   7    Free Software Foundation; version 2 of the License.
   8
   9    Red Hat elfutils is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License along
  15    with Red Hat elfutils; if not, write to the Free Software Foundation,
  16    Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA.
  17
  18    In addition, as a special exception, Red Hat, Inc. gives You the
  19    additional right to link the code of Red Hat elfutils with code licensed
  20    under any Open Source Initiative certified open source license
  21    (http://www.opensource.org/licenses/index.php) which requires the
  22    distribution of source code with any binary distribution and to
  23    distribute linked combinations of the two.  Non-GPL Code permitted under
  24    this exception must only link to the code of Red Hat elfutils through
  25    those well defined interfaces identified in the file named EXCEPTION
  26    found in the source code files (the "Approved Interfaces").  The files
  27    of Non-GPL Code may instantiate templates or use macros or inline
  28    functions from the Approved Interfaces without causing the resulting
  29    work to be covered by the GNU General Public License.  Only Red Hat,
  30    Inc. may make changes or additions to the list of Approved Interfaces.
  31    Red Hat's grant of this exception is conditioned upon your not adding
  32    any new exceptions.  If you wish to add a new Approved Interface or
  33    exception, please contact Red Hat.  You must obey the GNU General Public
  34    License in all respects for all of the Red Hat elfutils code and other
  35    code used in conjunction with Red Hat elfutils except the Non-GPL Code
  36    covered by this exception.  If you modify this file, you may extend this
  37    exception to your version of the file, but you are not obligated to do
  38    so.  If you do not wish to provide this exception without modification,
  39    you must delete this exception statement from your version and license
  40    this file solely under the GPL without exception.
  41
  42    Red Hat elfutils is an included package of the Open Invention Network.
  43    An included package of the Open Invention Network is a package for which
  44    Open Invention Network licensees cross-license their patents.  No patent
  45    license is granted, either expressly or impliedly, by designation as an
  46    included package.  Should you wish to participate in the Open Invention
  47    Network licensing program, please visit www.openinventionnetwork.com
  48    <http://www.openinventionnetwork.com>.  */
  49
  50 #ifdef HAVE_CONFIG_H
  51 # include <config.h>
  52 #endif
  53
  54 #include <assert.h>
  55 #include <libintl.h>
  56 #include <stdbool.h>
  57 #include <stdint.h>
  58 #include <stdlib.h>
  59 #include <errno.h>
  60
  61 #include "libdwflP.h"
  62
  63
  64 /* The error number.  */
  65 static __thread int global_error;
  66
  67
  68 int
  69 dwfl_errno (void)
  70 {
  71   int result = global_error;
  72   global_error = DWFL_E_NOERROR;
  73   return result;
  74 }
  75 INTDEF (dwfl_errno)
  76
  77
  78 static const struct msgtable
  79 {
  80 #define DWFL_ERROR(name, text) char msg_##name[sizeof text];
  81   DWFL_ERRORS
  82 #undef  DWFL_ERROR
  83 } msgtable =
  84   {
  85 #define DWFL_ERROR(name, text) text,
  86   DWFL_ERRORS
  87 #undef  DWFL_ERROR
  88   };
  89 #define msgstr (&msgtable.msg_NOERROR[0])
  90
  91 static const uint_fast16_t msgidx[] =
  92 {
  93 #define DWFL_ERROR(name, text) \
  94   [DWFL_E_##name] = offsetof (struct msgtable, msg_##name),
  95   DWFL_ERRORS
  96 #undef  DWFL_ERROR
  97 };
  98 #define nmsgidx (sizeof msgidx / sizeof msgidx[0])
  99
 100
 101 static inline int
 102 canonicalize (Dwfl_Error error)
 103 {
 104   unsigned int value;
 105
 106   switch (error)
 107     {
 108     default:
 109       value = error;
 110       if ((value &~ 0xffff) != 0)
 111         break;
 112       assert (value < nmsgidx);
 113       break;
 114     case DWFL_E_ERRNO:
 115       value = DWFL_E (ERRNO, errno);
 116       break;
 117     case DWFL_E_LIBELF:
 118       value = DWFL_E (LIBELF, elf_errno ());
 119       break;
 120     case DWFL_E_LIBDW:
 121       value = DWFL_E (LIBDW, INTUSE(dwarf_errno) ());
 122       break;
 123 #if 0
 124     DWFL_E_LIBEBL:
 125       value = DWFL_E (LIBEBL, ebl_errno ());
 126       break;
 127 #endif
 128     }
 129
 130   return value;
 131 }
 132
 133 int
 134 internal_function
 135 __libdwfl_canon_error (Dwfl_Error error)
 136 {
 137   return canonicalize (error);
 138 }
 139
 140 void
 141 internal_function
 142 __libdwfl_seterrno (Dwfl_Error error)
 143 {
 144   global_error = canonicalize (error);
 145 }
 146
 147
 148 const char *
 149 dwfl_errmsg (error)
 150      int error;
 151 {
 152   if (error == 0 || error == -1)
 153     {
 154       int last_error = global_error;
 155
 156       if (error == 0 && last_error == 0)
 157         return NULL;
 158
 159       error = last_error;
 160       global_error = DWFL_E_NOERROR;
 161     }
 162
 163   switch (error &~ 0xffff)
 164     {
 165     case OTHER_ERROR (ERRNO):
 166       return strerror_r (error & 0xffff, "bad", 0);
 167     case OTHER_ERROR (LIBELF):
 168       return elf_errmsg (error & 0xffff);
 169     case OTHER_ERROR (LIBDW):
 170       return INTUSE(dwarf_errmsg) (error & 0xffff);
 171 #if 0
 172     case OTHER_ERROR (LIBEBL):
 173       return ebl_errmsg (error & 0xffff);
 174 #endif
 175     }
 176
 177   return _(&msgstr[msgidx[(unsigned int) error < nmsgidx
 178                           ? error : DWFL_E_UNKNOWN_ERROR]]);
 179 }
 180 INTDEF (dwfl_errmsg)