elf/dl-lookup.c

   1 /* Look up a symbol in the loaded objects.
   2    Copyright (C) 1995, 1996, 1997, 1998 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 Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    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    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #include <alloca.h>
  21 #include <link.h>
  22 #include <assert.h>
  23 #include <string.h>
  24 #include <unistd.h>
  25
  26 #include "dl-hash.h"
  27 #include <dl-machine.h>
  28
  29 #define VERSTAG(tag)    (DT_NUM + DT_PROCNUM + DT_VERSIONTAGIDX (tag))
  30
  31 /* We need this string more than once.  */
  32 static const char undefined_msg[] = "undefined symbol: ";
  33
  34
  35 struct sym_val
  36   {
  37     const ElfW(Sym) *s;
  38     struct link_map *m;
  39   };
  40
  41
  42 #define make_string(string, rest...) \
  43   ({                                                                          \
  44     const char *all[] = { string, ## rest };                                  \
  45     size_t len, cnt;                                                          \
  46     char *result, *cp;                                                        \
  47                                                                               \
  48     len = 1;                                                                  \
  49     for (cnt = 0; cnt < sizeof (all) / sizeof (all[0]); ++cnt)                \
  50       len += strlen (all[cnt]);                                               \
  51                                                                               \
  52     cp = result = alloca (len);                                               \
  53     for (cnt = 0; cnt < sizeof (all) / sizeof (all[0]); ++cnt)                \
  54       cp = __stpcpy (cp, all[cnt]);                                           \
  55                                                                               \
  56     result;                                                                   \
  57   })
  58
  59
  60 /* Inner part of the lookup functions.  We return a value > 0 if we
  61    found the symbol, the value 0 if nothing is found and < 0 if
  62    something bad happened.  */
  63 static inline int
  64 do_lookup (const char *undef_name, unsigned long int hash,
  65            const ElfW(Sym) *ref, struct sym_val *result,
  66            struct link_map *scope, size_t i, const char *reference_name,
  67            const struct r_found_version *version, struct link_map *skip,
  68            int reloc_type)
  69 {
  70   struct link_map **list = scope->l_searchlist;
  71   size_t n = scope->l_nsearchlist;
  72   struct link_map *map;
  73
  74   for (; i < n; ++i)
  75     {
  76       const ElfW(Sym) *symtab;
  77       const char *strtab;
  78       const ElfW(Half) *verstab;
  79       ElfW(Symndx) symidx;
  80
  81       map = list[i];
  82
  83       /* Here come the extra test needed for `_dl_lookup_symbol_skip'.  */
  84       if (skip != NULL && map == skip)
  85         continue;
  86
  87       /* Skip objects that could not be opened, which can occur in trace
  88          mode.  */
  89       if (map->l_opencount == 0)
  90         continue;
  91
  92       /* Don't search the executable when resolving a copy reloc.  */
  93       if (elf_machine_lookup_noexec_p (reloc_type)
  94           && map->l_type == lt_executable)
  95         continue;
  96
  97       /* Skip objects without symbol tables.  */
  98       if (map->l_info[DT_SYMTAB] == NULL)
  99         continue;
 100
 101       /* Print some debugging info if wanted.  */
 102       if (_dl_debug_symbols)
 103         _dl_debug_message ("\tsymbol=", undef_name, ";  lookup in file=",
 104                            map->l_name[0] ? map->l_name : _dl_argv[0],
 105                            "\n", NULL);
 106
 107       symtab = ((void *) map->l_addr + map->l_info[DT_SYMTAB]->d_un.d_ptr);
 108       strtab = ((void *) map->l_addr + map->l_info[DT_STRTAB]->d_un.d_ptr);
 109       verstab = map->l_versyms;
 110
 111       /* Search the appropriate hash bucket in this object's symbol table
 112          for a definition for the same symbol name.  */
 113       for (symidx = map->l_buckets[hash % map->l_nbuckets];
 114            symidx != STN_UNDEF;
 115            symidx = map->l_chain[symidx])
 116         {
 117           const ElfW(Sym) *sym = &symtab[symidx];
 118
 119           if (sym->st_value == 0 || /* No value.  */
 120               (elf_machine_lookup_noplt_p (reloc_type) /* Reject PLT entry.  */
 121                && sym->st_shndx == SHN_UNDEF))
 122             continue;
 123
 124           if (ELFW(ST_TYPE) (sym->st_info) > STT_FUNC)
 125             /* Ignore all but STT_NOTYPE, STT_OBJECT and STT_FUNC entries
 126                since these are no code/data definitions.  */
 127             continue;
 128
 129           if (sym != ref && strcmp (strtab + sym->st_name, undef_name))
 130             /* Not the symbol we are looking for.  */
 131             continue;
 132
 133           if (version == NULL)
 134             {
 135               /* No specific version is selected.  When the object
 136                  file also does not define a version we have a match.
 137                  Otherwise we only accept the default version, i.e.,
 138                  the version which name is "".  */
 139               if (verstab != NULL)
 140                 {
 141                   ElfW(Half) ndx = verstab[symidx] & 0x7fff;
 142                   if (ndx > 2) /* map->l_versions[ndx].hash != 0) */
 143                     continue;
 144                 }
 145             }
 146           else
 147             {
 148               if (verstab == NULL)
 149                 {
 150                   /* We need a versioned system but haven't found any.
 151                      If this is the object which is referenced in the
 152                      verneed entry it is a bug in the library since a
 153                      symbol must not simply disappear.  */
 154                   if (version->filename != NULL
 155                       && _dl_name_match_p (version->filename, map))
 156                     return -2;
 157                   /* Otherwise we accept the symbol.  */
 158                 }
 159               else
 160                 {
 161                   /* We can match the version information or use the
 162                      default one if it is not hidden.  */
 163                   ElfW(Half) ndx = verstab[symidx] & 0x7fff;
 164                   if ((map->l_versions[ndx].hash != version->hash
 165                        || strcmp (map->l_versions[ndx].name, version->name))
 166                       && (version->hidden || map->l_versions[ndx].hash
 167                           || (verstab[symidx] & 0x8000)))
 168                     /* It's not the version we want.  */
 169                     continue;
 170                 }
 171             }
 172
 173           switch (ELFW(ST_BIND) (sym->st_info))
 174             {
 175             case STB_GLOBAL:
 176               /* Global definition.  Just what we need.  */
 177               result->s = sym;
 178               result->m = map;
 179               return 1;
 180             case STB_WEAK:
 181               /* Weak definition.  Use this value if we don't find
 182                  another.  */
 183               if (! result->s)
 184                 {
 185                   result->s = sym;
 186                   result->m = map;
 187                 }
 188               break;
 189             default:
 190               /* Local symbols are ignored.  */
 191               break;
 192             }
 193
 194           /* There cannot be another entry for this symbol so stop here.  */
 195           break;
 196         }
 197
 198       /* If this current map is the one mentioned in the verneed entry
 199          and we have not found a weak entry, it is a bug.  */
 200       if (symidx == STN_UNDEF && version != NULL && version->filename != NULL
 201           && _dl_name_match_p (version->filename, map))
 202         return -1;
 203     }
 204
 205   /* We have not found anything until now.  */
 206   return 0;
 207 }
 208
 209 /* Search loaded objects' symbol tables for a definition of the symbol
 210    UNDEF_NAME.  */
 211
 212 ElfW(Addr)
 213 _dl_lookup_symbol (const char *undef_name, const ElfW(Sym) **ref,
 214                    struct link_map *symbol_scope[],
 215                    const char *reference_name,
 216                    int reloc_type)
 217 {
 218   const unsigned long int hash = _dl_elf_hash (undef_name);
 219   struct sym_val current_value = { NULL, NULL };
 220   struct link_map **scope;
 221
 222   /* Search the relevant loaded objects for a definition.  */
 223   for (scope = symbol_scope; *scope; ++scope)
 224     if (do_lookup (undef_name, hash, *ref, &current_value,
 225                    *scope, 0, reference_name, NULL, NULL, reloc_type))
 226       break;
 227
 228   if (current_value.s == NULL)
 229     {
 230       if (*ref == NULL || ELFW(ST_BIND) ((*ref)->st_info) != STB_WEAK)
 231         /* We could find no value for a strong reference.  */
 232         _dl_signal_error (0, reference_name,
 233                           make_string (undefined_msg, undef_name));
 234       *ref = NULL;
 235       return 0;
 236     }
 237
 238   if (_dl_debug_bindings)
 239     _dl_debug_message ("\tbinding file ", reference_name, " to ",
 240                        current_value.m->l_name[0]
 241                        ? current_value.m->l_name : _dl_argv[0],
 242                        ": symbol `", undef_name, "'\n", NULL);
 243
 244   *ref = current_value.s;
 245   return current_value.m->l_addr;
 246 }
 247
 248
 249 /* This function is nearly the same as `_dl_lookup_symbol' but it
 250    skips in the first list all objects until SKIP_MAP is found.  I.e.,
 251    it only considers objects which were loaded after the described
 252    object.  If there are more search lists the object described by
 253    SKIP_MAP is only skipped.  */
 254 ElfW(Addr)
 255 _dl_lookup_symbol_skip (const char *undef_name, const ElfW(Sym) **ref,
 256                         struct link_map *symbol_scope[],
 257                         const char *reference_name,
 258                         struct link_map *skip_map)
 259 {
 260   const unsigned long int hash = _dl_elf_hash (undef_name);
 261   struct sym_val current_value = { NULL, NULL };
 262   struct link_map **scope;
 263   size_t i;
 264
 265   /* Search the relevant loaded objects for a definition.  */
 266   scope = symbol_scope;
 267   for (i = 0; (*scope)->l_dupsearchlist[i] != skip_map; ++i)
 268     assert (i < (*scope)->l_ndupsearchlist);
 269
 270   if (! do_lookup (undef_name, hash, *ref, &current_value,
 271                    *scope, i, reference_name, NULL, skip_map, 0))
 272     while (*++scope)
 273       if (do_lookup (undef_name, hash, *ref, &current_value,
 274                      *scope, 0, reference_name, NULL, skip_map, 0))
 275         break;
 276
 277   if (current_value.s == NULL)
 278     {
 279       *ref = NULL;
 280       return 0;
 281     }
 282
 283   if (_dl_debug_bindings)
 284     _dl_debug_message ("\tbinding file ", reference_name, " to ",
 285                        current_value.m->l_name[0]
 286                        ? current_value.m->l_name : _dl_argv[0],
 287                        ": symbol `", undef_name, "'\n", NULL);
 288
 289   *ref = current_value.s;
 290   return current_value.m->l_addr;
 291 }
 292
 293
 294 /* This function works like _dl_lookup_symbol but it takes an
 295    additional arguement with the version number of the requested
 296    symbol.
 297
 298    XXX We'll see whether we need this separate function.  */
 299 ElfW(Addr)
 300 _dl_lookup_versioned_symbol (const char *undef_name, const ElfW(Sym) **ref,
 301                              struct link_map *symbol_scope[],
 302                              const char *reference_name,
 303                              const struct r_found_version *version,
 304                              int reloc_type)
 305 {
 306   const unsigned long int hash = _dl_elf_hash (undef_name);
 307   struct sym_val current_value = { NULL, NULL };
 308   struct link_map **scope;
 309
 310   /* Search the relevant loaded objects for a definition.  */
 311   for (scope = symbol_scope; *scope; ++scope)
 312     {
 313       int res = do_lookup (undef_name, hash, *ref, &current_value,
 314                            *scope, 0, reference_name, version, NULL, reloc_type);
 315       if (res > 0)
 316         break;
 317
 318       if (res < 0)
 319         /* Oh, oh.  The file named in the relocation entry does not
 320            contain the needed symbol.  */
 321         _dl_signal_error (0, (*reference_name
 322                               ? reference_name
 323                               : (_dl_argv[0] ?: "<main program>")),
 324                           make_string ("symbol ", undef_name, ", version ",
 325                                        version->name,
 326                                        " not defined in file ",
 327                                        version->filename,
 328                                        " with link time reference",
 329                                        res == -2
 330                                        ? " (no version symbols)" : ""));
 331     }
 332
 333   if (current_value.s == NULL)
 334     {
 335       if (*ref == NULL || ELFW(ST_BIND) ((*ref)->st_info) != STB_WEAK)
 336         /* We could find no value for a strong reference.  */
 337         _dl_signal_error (0, reference_name,
 338                           make_string (undefined_msg, undef_name,
 339                                        ", version ", version->name ?: NULL));
 340       *ref = NULL;
 341       return 0;
 342     }
 343
 344   if (_dl_debug_bindings)
 345     _dl_debug_message ("\tbinding file ", reference_name, " to ",
 346                        current_value.m->l_name[0]
 347                        ? current_value.m->l_name : _dl_argv[0],
 348                        ": symbol `", undef_name, "' [", version->name,
 349                        "]\n", NULL);
 350
 351   *ref = current_value.s;
 352   return current_value.m->l_addr;
 353 }
 354
 355
 356 /* Similar to _dl_lookup_symbol_skip but takes an additional argument
 357    with the version we are looking for.  */
 358 ElfW(Addr)
 359 _dl_lookup_versioned_symbol_skip (const char *undef_name,
 360                                   const ElfW(Sym) **ref,
 361                                   struct link_map *symbol_scope[],
 362                                   const char *reference_name,
 363                                   const struct r_found_version *version,
 364                                   struct link_map *skip_map)
 365 {
 366   const unsigned long int hash = _dl_elf_hash (undef_name);
 367   struct sym_val current_value = { NULL, NULL };
 368   struct link_map **scope;
 369   size_t i;
 370
 371   /* Search the relevant loaded objects for a definition.  */
 372   scope = symbol_scope;
 373   for (i = 0; (*scope)->l_dupsearchlist[i] != skip_map; ++i)
 374     assert (i < (*scope)->l_ndupsearchlist);
 375
 376   if (! do_lookup (undef_name, hash, *ref, &current_value,
 377                    *scope, i, reference_name, version, skip_map, 0))
 378     while (*++scope)
 379       if (do_lookup (undef_name, hash, *ref, &current_value,
 380                      *scope, 0, reference_name, version, skip_map, 0))
 381         break;
 382
 383   if (current_value.s == NULL)
 384     {
 385       if (*ref == NULL || ELFW(ST_BIND) ((*ref)->st_info) != STB_WEAK)
 386         {
 387           /* We could find no value for a strong reference.  */
 388           const size_t len = strlen (undef_name);
 389           char buf[sizeof undefined_msg + len];
 390           __mempcpy (__mempcpy (buf, undefined_msg, sizeof undefined_msg - 1),
 391                      undef_name, len + 1);
 392           _dl_signal_error (0, reference_name, buf);
 393         }
 394       *ref = NULL;
 395       return 0;
 396     }
 397
 398   if (_dl_debug_bindings)
 399     _dl_debug_message ("\tbinding file ", reference_name, " to ",
 400                        current_value.m->l_name[0]
 401                        ? current_value.m->l_name : _dl_argv[0],
 402                        ": symbol `", undef_name, "' [", version->name,
 403                        "]\n", NULL);
 404
 405   *ref = current_value.s;
 406   return current_value.m->l_addr;
 407 }
 408
 409
 410 /* Cache the location of MAP's hash table.  */
 411
 412 void
 413 _dl_setup_hash (struct link_map *map)
 414 {
 415   ElfW(Symndx) *hash;
 416   ElfW(Symndx) nchain;
 417
 418   if (!map->l_info[DT_HASH])
 419     return;
 420   hash = (void *)(map->l_addr + map->l_info[DT_HASH]->d_un.d_ptr);
 421
 422   map->l_nbuckets = *hash++;
 423   nchain = *hash++;
 424   map->l_buckets = hash;
 425   hash += map->l_nbuckets;
 426   map->l_chain = hash;
 427 }