elf/dl-error.c

   1 /* Error handling for runtime dynamic linker.
   2    Copyright (C) 1995,96,97,98,99,2000,2001,2002 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #include <libintl.h>
  21 #include <setjmp.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <unistd.h>
  25 #include <ldsodefs.h>
  26
  27 /* This structure communicates state between _dl_catch_error and
  28    _dl_signal_error.  */
  29 struct catch
  30   {
  31     const char *objname;        /* Object/File name.  */
  32     const char *errstring;      /* Error detail filled in here.  */
  33     jmp_buf env;                /* longjmp here on error.  */
  34   };
  35
  36 /* Multiple threads at once can use the `_dl_catch_error' function.  The
  37    calls can come from `_dl_map_object_deps', `_dlerror_run', or from
  38    any of the libc functionality which loads dynamic objects (NSS, iconv).
  39    Therefore we have to be prepared to save the state in thread-local
  40    memory.  The _dl_error_catch_tsd function pointer is reset by the thread
  41    library so that it returns the address of a thread-local variable.  */
  42
  43
  44 /* This message we return as a last resort.  We define the string in a
  45    variable since we have to avoid freeing it and so have to enable
  46    a pointer comparison.  See below and in dlfcn/dlerror.c.  */
  47 const char _dl_out_of_memory[] = "out of memory";
  48 INTVARDEF(_dl_out_of_memory)
  49
  50
  51 /* This points to a function which is called when an continuable error is
  52    received.  Unlike the handling of `catch' this function may return.
  53    The arguments will be the `errstring' and `objname'.
  54
  55    Since this functionality is not used in normal programs (only in ld.so)
  56    we do not care about multi-threaded programs here.  We keep this as a
  57    global variable.  */
  58 static receiver_fct receiver;
  59
  60
  61 void
  62 internal_function
  63 _dl_signal_error (int errcode, const char *objname, const char *occation,
  64                   const char *errstring)
  65 {
  66   struct catch *lcatch;
  67
  68   if (! errstring)
  69     errstring = N_("DYNAMIC LINKER BUG!!!");
  70
  71   lcatch = *((*GL(dl_error_catch_tsd)) ());
  72   if (objname == NULL)
  73     objname = "";
  74   if (lcatch != NULL)
  75     {
  76       /* We are inside _dl_catch_error.  Return to it.  We have to
  77          duplicate the error string since it might be allocated on the
  78          stack.  The object name is always a string constant.  */
  79       size_t len_objname = strlen (objname) + 1;
  80       size_t len_errstring = strlen (errstring) + 1;
  81
  82       lcatch->errstring = (char *) malloc (len_objname + len_errstring);
  83       if (lcatch->errstring != NULL)
  84         /* Make a copy of the object file name and the error string.  */
  85         lcatch->objname = memcpy (__mempcpy ((char *) lcatch->errstring,
  86                                              errstring, len_errstring),
  87                                   objname, len_objname);
  88       else
  89         {
  90           /* This is better than nothing.  */
  91           lcatch->objname = "";
  92           lcatch->errstring = INTUSE(_dl_out_of_memory);
  93         }
  94       longjmp (lcatch->env, errcode ?: -1);
  95     }
  96   else
  97     {
  98       /* Lossage while resolving the program's own symbols is always fatal.  */
  99       char buffer[1024];
 100       _dl_fatal_printf ("%s: %s: %s%s%s%s%s\n",
 101                         rtld_progname ?: "<program name unknown>",
 102                         occation ?: N_("error while loading shared libraries"),
 103                         objname, *objname ? ": " : "",
 104                         errstring, errcode ? ": " : "",
 105                         (errcode
 106                          ? __strerror_r (errcode, buffer, sizeof buffer)
 107                          : ""));
 108     }
 109 }
 110 INTDEF (_dl_signal_error)
 111
 112
 113 void
 114 internal_function
 115 _dl_signal_cerror (int errcode, const char *objname, const char *occation,
 116                    const char *errstring)
 117 {
 118   if (__builtin_expect (GL(dl_debug_mask)
 119                         & ~(DL_DEBUG_STATISTICS|DL_DEBUG_PRELINK), 0))
 120     INTUSE(_dl_debug_printf) ("%s: error: %s: %s (%s)\n", objname, occation,
 121                               errstring, receiver ? "continued" : "fatal");
 122
 123   if (receiver)
 124     {
 125       /* We are inside _dl_receive_error.  Call the user supplied
 126          handler and resume the work.  The receiver will still be
 127          installed.  */
 128       (*receiver) (errcode, objname, errstring);
 129     }
 130   else
 131     INTUSE(_dl_signal_error) (errcode, objname, occation, errstring);
 132 }
 133
 134
 135 int
 136 internal_function
 137 _dl_catch_error (const char **objname, const char **errstring,
 138                  void (*operate) (void *), void *args)
 139 {
 140   int errcode;
 141   struct catch *volatile old;
 142   struct catch c;
 143   /* We need not handle `receiver' since setting a `catch' is handled
 144      before it.  */
 145
 146   /* Some systems (e.g., SPARC) handle constructors to local variables
 147      inefficient.  So we initialize `c' by hand.  */
 148   c.errstring = NULL;
 149
 150   void **catchp = (*GL(dl_error_catch_tsd)) ();
 151   old = *catchp;
 152   errcode = setjmp (c.env);
 153   if (__builtin_expect (errcode, 0) == 0)
 154     {
 155       *catchp = &c;
 156       (*operate) (args);
 157       *catchp = old;
 158       *objname = NULL;
 159       *errstring = NULL;
 160       return 0;
 161     }
 162
 163   /* We get here only if we longjmp'd out of OPERATE.  */
 164   *catchp = old;
 165   *objname = c.objname;
 166   *errstring = c.errstring;
 167   return errcode == -1 ? 0 : errcode;
 168 }
 169 INTDEF (_dl_catch_error)
 170
 171
 172 void
 173 internal_function
 174 _dl_receive_error (receiver_fct fct, void (*operate) (void *), void *args)
 175 {
 176   void **catchp = (*GL(dl_error_catch_tsd)) ();
 177   struct catch *old_catch;
 178   receiver_fct old_receiver;
 179
 180   old_catch = *catchp;
 181   old_receiver = receiver;
 182
 183   /* Set the new values.  */
 184   *catchp = NULL;
 185   receiver = fct;
 186
 187   (*operate) (args);
 188
 189   *catchp = old_catch;
 190   receiver = old_receiver;
 191 }