elf/dl-deps.c

   1 /* Load the dependencies of a mapped object.
   2    Copyright (C) 1996, 1997, 1998, 1999, 2000 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 <assert.h>
  21 #include <dlfcn.h>
  22 #include <errno.h>
  23 #include <libintl.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27 #include <sys/param.h>
  28 #include <ldsodefs.h>
  29
  30 #include <dl-dst.h>
  31
  32 /* Whether an shared object references one or more auxiliary objects
  33    is signaled by the AUXTAG entry in l_info.  */
  34 #define AUXTAG  (DT_NUM + DT_THISPROCNUM + DT_VERSIONTAGNUM \
  35                  + DT_EXTRATAGIDX (DT_AUXILIARY))
  36 /* Whether an shared object references one or more auxiliary objects
  37    is signaled by the AUXTAG entry in l_info.  */
  38 #define FILTERTAG (DT_NUM + DT_THISPROCNUM + DT_VERSIONTAGNUM \
  39                    + DT_EXTRATAGIDX (DT_FILTER))
  40
  41 /* This is zero at program start to signal that the global scope map is
  42    allocated by rtld.  Later it keeps the size of the map.  It might be
  43    reset if in _dl_close if the last global object is removed.  */
  44 size_t _dl_global_scope_alloc;
  45
  46 extern size_t _dl_platformlen;
  47
  48 /* When loading auxiliary objects we must ignore errors.  It's ok if
  49    an object is missing.  */
  50 struct openaux_args
  51   {
  52     /* The arguments to openaux.  */
  53     struct link_map *map;
  54     int trace_mode;
  55     const char *strtab;
  56     const char *name;
  57
  58     /* The return value of openaux.  */
  59     struct link_map *aux;
  60   };
  61
  62 static void
  63 openaux (void *a)
  64 {
  65   struct openaux_args *args = (struct openaux_args *) a;
  66
  67   args->aux = _dl_map_object (args->map, args->name, 0,
  68                               (args->map->l_type == lt_executable
  69                                ? lt_library : args->map->l_type),
  70                               args->trace_mode, 0);
  71 }
  72
  73
  74
  75 /* We use a very special kind of list to track the two kinds paths
  76    through the list of loaded shared objects.  We have to
  77
  78    - produce a flat list with unique members of all involved objects
  79
  80    - produce a flat list of all shared objects.
  81 */
  82 struct list
  83   {
  84     int done;                   /* Nonzero if this map was processed.  */
  85     struct link_map *map;       /* The data.  */
  86
  87     struct list *unique;        /* Elements for normal list.  */
  88     struct list *dup;           /* Elements in complete list.  */
  89   };
  90
  91
  92 /* Macro to expand DST.  It is an macro since we use `alloca'.  */
  93 #define expand_dst(l, str, fatal) \
  94   ({                                                                          \
  95     const char *__str = (str);                                                \
  96     const char *__result = __str;                                             \
  97     size_t __cnt = DL_DST_COUNT(__str, 0);                                    \
  98                                                                               \
  99     if (__cnt != 0)                                                           \
 100       {                                                                       \
 101         char *__newp;                                                         \
 102                                                                               \
 103         /* DST must not appear in SUID/SGID programs.  */                     \
 104         if (__libc_enable_secure)                                             \
 105           _dl_signal_error (0, __str,                                         \
 106                             N_("DST not allowed in SUID/SGID programs"));     \
 107                                                                               \
 108         __newp = (char *) alloca (DL_DST_REQUIRED (l, __str, strlen (__str),  \
 109                                                    __cnt));                   \
 110                                                                               \
 111         __result = DL_DST_SUBSTITUTE (l, __str, __newp, 0);                   \
 112                                                                               \
 113         if (*__result == '\0')                                                \
 114           {                                                                   \
 115             /* The replacement for the DST is not known.  We can't            \
 116                processed.  */                                                 \
 117             if (fatal)                                                        \
 118               _dl_signal_error (0, __str, N_("\
 119 empty dynamics string token substitution"));                                  \
 120             else                                                              \
 121               {                                                               \
 122                 /* This is for DT_AUXILIARY.  */                              \
 123                 if (__builtin_expect (_dl_debug_libs, 0))                     \
 124                   _dl_debug_message (1, "cannot load auxiliary `", __str,     \
 125                                      "' because of empty dynamic string"      \
 126                                      " token substitution\n", NULL);          \
 127                 continue;                                                     \
 128               }                                                               \
 129           }                                                                   \
 130       }                                                                       \
 131                                                                               \
 132     __result; })
 133
 134
 135 void
 136 internal_function
 137 _dl_map_object_deps (struct link_map *map,
 138                      struct link_map **preloads, unsigned int npreloads,
 139                      int trace_mode)
 140 {
 141   struct list known[1 + npreloads + 1];
 142   struct list *runp, *utail, *dtail;
 143   unsigned int nlist, nduplist, i;
 144
 145   inline void preload (struct link_map *map)
 146     {
 147       known[nlist].done = 0;
 148       known[nlist].map = map;
 149
 150       known[nlist].unique = &known[nlist + 1];
 151       known[nlist].dup = &known[nlist + 1];
 152
 153       ++nlist;
 154       /* We use `l_reserved' as a mark bit to detect objects we have
 155          already put in the search list and avoid adding duplicate
 156          elements later in the list.  */
 157       map->l_reserved = 1;
 158     }
 159
 160   /* No loaded object so far.  */
 161   nlist = 0;
 162
 163   /* First load MAP itself.  */
 164   preload (map);
 165
 166   /* Add the preloaded items after MAP but before any of its dependencies.  */
 167   for (i = 0; i < npreloads; ++i)
 168     preload (preloads[i]);
 169
 170   /* Terminate the lists.  */
 171   known[nlist - 1].unique = NULL;
 172   known[nlist - 1].dup = NULL;
 173
 174   /* Pointer to last unique object.  */
 175   utail = &known[nlist - 1];
 176   /* Pointer to last loaded object.  */
 177   dtail = &known[nlist - 1];
 178
 179   /* Until now we have the same number of libraries in the normal and
 180      the list with duplicates.  */
 181   nduplist = nlist;
 182
 183   /* Process each element of the search list, loading each of its
 184      auxiliary objects and immediate dependencies.  Auxiliary objects
 185      will be added in the list before the object itself and
 186      dependencies will be appended to the list as we step through it.
 187      This produces a flat, ordered list that represents a
 188      breadth-first search of the dependency tree.
 189
 190      The whole process is complicated by the fact that we better
 191      should use alloca for the temporary list elements.  But using
 192      alloca means we cannot use recursive function calls.  */
 193   for (runp = known; runp; )
 194     {
 195       struct link_map *l = runp->map;
 196       struct link_map **needed = NULL;
 197       unsigned int nneeded = 0;
 198
 199       /* Unless otherwise stated, this object is handled.  */
 200       runp->done = 1;
 201
 202       /* Allocate a temporary record to contain the references to the
 203          dependencies of this object.  */
 204       if (l->l_searchlist.r_list == NULL && l->l_initfini == NULL
 205           && l != map && l->l_ldnum > 0)
 206         needed = (struct link_map **) alloca (l->l_ldnum
 207                                               * sizeof (struct link_map *));
 208
 209       if (l->l_info[DT_NEEDED] || l->l_info[AUXTAG] || l->l_info[FILTERTAG])
 210         {
 211           const char *strtab = (const void *) D_PTR (l, l_info[DT_STRTAB]);
 212           struct openaux_args args;
 213           struct list *orig;
 214           const ElfW(Dyn) *d;
 215
 216           args.strtab = strtab;
 217           args.map = l;
 218           args.trace_mode = trace_mode;
 219           orig = runp;
 220
 221           for (d = l->l_ld; d->d_tag != DT_NULL; ++d)
 222             if (__builtin_expect (d->d_tag, DT_NEEDED) == DT_NEEDED)
 223               {
 224                 /* Map in the needed object.  */
 225                 struct link_map *dep;
 226                 /* Allocate new entry.  */
 227                 struct list *newp;
 228                 /* Object name.  */
 229                 const char *name;
 230
 231                 /* Recognize DSTs.  */
 232                 name = expand_dst (l, strtab + d->d_un.d_val, 0);
 233
 234                 dep = _dl_map_object (l, name, 0,
 235                                       l->l_type == lt_executable ? lt_library :
 236                                       l->l_type, trace_mode, 0);
 237
 238                 /* Add it in any case to the duplicate list.  */
 239                 newp = alloca (sizeof (struct list));
 240                 newp->map = dep;
 241                 newp->dup = NULL;
 242                 dtail->dup = newp;
 243                 dtail = newp;
 244                 ++nduplist;
 245
 246                 if (dep->l_reserved)
 247                   /* This object is already in the search list we are
 248                      building.  Don't add a duplicate pointer.
 249                      Release the reference just added by
 250                      _dl_map_object.  */
 251                   --dep->l_opencount;
 252                 else
 253                   {
 254                     /* Append DEP to the unique list.  */
 255                     newp->done = 0;
 256                     newp->unique = NULL;
 257                     utail->unique = newp;
 258                     utail = newp;
 259                     ++nlist;
 260                     /* Set the mark bit that says it's already in the list.  */
 261                     dep->l_reserved = 1;
 262                   }
 263
 264                 /* Remember this dependency.  */
 265                 if (needed != NULL)
 266                   needed[nneeded++] = dep;
 267               }
 268             else if (d->d_tag == DT_AUXILIARY || d->d_tag == DT_FILTER)
 269               {
 270                 const char *objname;
 271                 const char *errstring;
 272                 struct list *newp;
 273                 /* Object name.  */
 274                 const char *name;
 275
 276                 /* Recognize DSTs.  */
 277                 name = expand_dst (l, strtab + d->d_un.d_val,
 278                                    d->d_tag == DT_AUXILIARY);
 279
 280                 if (d->d_tag == DT_AUXILIARY)
 281                   {
 282                     /* Store the tag in the argument structure.  */
 283                     args.name = name;
 284
 285                     /* Say that we are about to load an auxiliary library.  */
 286                     if (__builtin_expect (_dl_debug_libs, 0))
 287                       _dl_debug_message (1, "load auxiliary object=",
 288                                          name, " requested by file=",
 289                                          l->l_name[0]
 290                                          ? l->l_name : _dl_argv[0],
 291                                          "\n", NULL);
 292
 293                     /* We must be prepared that the addressed shared
 294                        object is not available.  */
 295                     if (_dl_catch_error (&objname, &errstring, openaux, &args))
 296                       {
 297                         /* We are not interested in the error message.  */
 298                         assert (errstring != NULL);
 299                         if (errstring != _dl_out_of_memory)
 300                           free ((char *) errstring);
 301
 302                         /* Simply ignore this error and continue the work.  */
 303                         continue;
 304                       }
 305                   }
 306                 else
 307                   {
 308                     /* Say that we are about to load an auxiliary library.  */
 309                     if (__builtin_expect (_dl_debug_libs, 0))
 310                       _dl_debug_message (1, "load filtered object=", name,
 311                                          " requested by file=",
 312                                          l->l_name[0]
 313                                          ? l->l_name : _dl_argv[0],
 314                                          "\n", NULL);
 315
 316                     /* For filter objects the dependency must be available.  */
 317                     args.aux = _dl_map_object (l, name, 0,
 318                                                (l->l_type == lt_executable
 319                                                 ? lt_library : l->l_type),
 320                                                trace_mode, 0);
 321                   }
 322
 323                 /* The auxiliary object is actually available.
 324                    Incorporate the map in all the lists.  */
 325
 326                 /* Allocate new entry.  This always has to be done.  */
 327                 newp = alloca (sizeof (struct list));
 328
 329                 /* We want to insert the new map before the current one,
 330                    but we have no back links.  So we copy the contents of
 331                    the current entry over.  Note that ORIG and NEWP now
 332                    have switched their meanings.  */
 333                 orig->dup = memcpy (newp, orig, sizeof (*newp));
 334
 335                 /* Initialize new entry.  */
 336                 orig->done = 0;
 337                 orig->map = args.aux;
 338
 339                 /* Remember this dependency.  */
 340                 if (needed != NULL)
 341                   needed[nneeded++] = args.aux;
 342
 343                 /* We must handle two situations here: the map is new,
 344                    so we must add it in all three lists.  If the map
 345                    is already known, we have two further possibilities:
 346                    - if the object is before the current map in the
 347                    search list, we do nothing.  It is already found
 348                    early
 349                    - if the object is after the current one, we must
 350                    move it just before the current map to make sure
 351                    the symbols are found early enough
 352                 */
 353                 if (args.aux->l_reserved)
 354                   {
 355                     /* The object is already somewhere in the list.
 356                        Locate it first.  */
 357                     struct list *late;
 358
 359                     /* This object is already in the search list we
 360                        are building.  Don't add a duplicate pointer.
 361                        Release the reference just added by
 362                        _dl_map_object.  */
 363                     --args.aux->l_opencount;
 364
 365                     for (late = newp; late->unique; late = late->unique)
 366                       if (late->unique->map == args.aux)
 367                         break;
 368
 369                     if (late->unique)
 370                       {
 371                         /* The object is somewhere behind the current
 372                            position in the search path.  We have to
 373                            move it to this earlier position.  */
 374                         orig->unique = newp;
 375
 376                         /* Now remove the later entry from the unique list
 377                            and adjust the tail pointer.  */
 378                         if (utail == late->unique)
 379                           utail = late;
 380                         late->unique = late->unique->unique;
 381
 382                         /* We must move the object earlier in the chain.  */
 383                         if (args.aux->l_prev)
 384                           args.aux->l_prev->l_next = args.aux->l_next;
 385                         if (args.aux->l_next)
 386                           args.aux->l_next->l_prev = args.aux->l_prev;
 387
 388                         args.aux->l_prev = newp->map->l_prev;
 389                         newp->map->l_prev = args.aux;
 390                         if (args.aux->l_prev != NULL)
 391                           args.aux->l_prev->l_next = args.aux;
 392                         args.aux->l_next = newp->map;
 393                       }
 394                     else
 395                       {
 396                         /* The object must be somewhere earlier in the
 397                            list.  That's good, we only have to insert
 398                            an entry for the duplicate list.  */
 399                         orig->unique = NULL;    /* Never used.  */
 400
 401                         /* Now we have a problem.  The element
 402                            pointing to ORIG in the unique list must
 403                            point to NEWP now.  This is the only place
 404                            where we need this backreference and this
 405                            situation is really not that frequent.  So
 406                            we don't use a double-linked list but
 407                            instead search for the preceding element.  */
 408                         late = known;
 409                         while (late->unique != orig)
 410                           late = late->unique;
 411                         late->unique = newp;
 412                       }
 413                   }
 414                 else
 415                   {
 416                     /* This is easy.  We just add the symbol right here.  */
 417                     orig->unique = newp;
 418                     ++nlist;
 419                     /* Set the mark bit that says it's already in the list.  */
 420                     args.aux->l_reserved = 1;
 421
 422                     /* The only problem is that in the double linked
 423                        list of all objects we don't have this new
 424                        object at the correct place.  Correct this here.  */
 425                     if (args.aux->l_prev)
 426                       args.aux->l_prev->l_next = args.aux->l_next;
 427                     if (args.aux->l_next)
 428                       args.aux->l_next->l_prev = args.aux->l_prev;
 429
 430                     args.aux->l_prev = newp->map->l_prev;
 431                     newp->map->l_prev = args.aux;
 432                     if (args.aux->l_prev != NULL)
 433                       args.aux->l_prev->l_next = args.aux;
 434                     args.aux->l_next = newp->map;
 435                   }
 436
 437                 /* Move the tail pointers if necessary.  */
 438                 if (orig == utail)
 439                   utail = newp;
 440                 if (orig == dtail)
 441                   dtail = newp;
 442
 443                 /* Move on the insert point.  */
 444                 orig = newp;
 445
 446                 /* We always add an entry to the duplicate list.  */
 447                 ++nduplist;
 448               }
 449         }
 450
 451       /* Terminate the list of dependencies and store the array address.  */
 452       if (needed != NULL)
 453         {
 454           needed[nneeded++] = NULL;
 455
 456           l->l_initfini = malloc (nneeded * sizeof needed[0]);
 457           if (l->l_initfini == NULL)
 458             _dl_signal_error (ENOMEM, map->l_name,
 459                               N_("cannot allocate dependency list"));
 460           memcpy (l->l_initfini, needed, nneeded * sizeof needed[0]);
 461         }
 462
 463       /* If we have no auxiliary objects just go on to the next map.  */
 464       if (runp->done)
 465         do
 466           runp = runp->unique;
 467         while (runp != NULL && runp->done);
 468     }
 469
 470   if (map->l_initfini != NULL && map->l_type == lt_loaded)
 471     {
 472       /* This object was previously loaded as a dependency and we have
 473          a separate l_initfini list.  We don't need it anymore.  */
 474       assert (map->l_searchlist.r_list == NULL);
 475       free (map->l_initfini);
 476     }
 477
 478   /* Store the search list we built in the object.  It will be used for
 479      searches in the scope of this object.  */
 480   map->l_searchlist.r_list = malloc ((2 * nlist + 1
 481                                       + (nlist == nduplist ? 0 : nduplist))
 482                                      * sizeof (struct link_map *));
 483   if (map->l_searchlist.r_list == NULL)
 484     _dl_signal_error (ENOMEM, map->l_name,
 485                       N_("cannot allocate symbol search list"));
 486   map->l_searchlist.r_nlist = nlist;
 487
 488   for (nlist = 0, runp = known; runp; runp = runp->unique)
 489     {
 490       if (trace_mode && runp->map->l_opencount == 0)
 491         /* This can happen when we trace the loading.  */
 492         --map->l_searchlist.r_nlist;
 493       else
 494         map->l_searchlist.r_list[nlist++] = runp->map;
 495
 496       /* Now clear all the mark bits we set in the objects on the search list
 497          to avoid duplicates, so the next call starts fresh.  */
 498       runp->map->l_reserved = 0;
 499     }
 500
 501   map->l_searchlist.r_nduplist = nduplist;
 502   if (nlist == nduplist)
 503     map->l_searchlist.r_duplist = map->l_searchlist.r_list;
 504   else
 505     {
 506       unsigned int cnt;
 507
 508       map->l_searchlist.r_duplist = map->l_searchlist.r_list + nlist;
 509
 510       for (cnt = 0, runp = known; runp; runp = runp->dup)
 511         if (trace_mode && runp->map->l_opencount == 0)
 512           /* This can happen when we trace the loading.  */
 513           --map->l_searchlist.r_nduplist;
 514         else
 515           map->l_searchlist.r_duplist[cnt++] = runp->map;
 516     }
 517
 518   /* Now determine the order in which the initialization has to happen.  */
 519   map->l_initfini =
 520     (struct link_map **) memcpy (map->l_searchlist.r_duplist + nduplist,
 521                                  map->l_searchlist.r_list,
 522                                  nlist * sizeof (struct link_map *));
 523   /* We can skip looking for the binary itself which is at the front
 524      of the search list.  Look through the list backward so that circular
 525      dependencies are not changing the order.  */
 526   for (i = 1; i < nlist; ++i)
 527     {
 528       struct link_map *l = map->l_searchlist.r_list[i];
 529       unsigned int j;
 530       unsigned int k;
 531
 532       /* Find the place in the initfini list where the map is currently
 533          located.  */
 534       for (j = 1; map->l_initfini[j] != l; ++j)
 535         ;
 536
 537       /* Find all object for which the current one is a dependency and
 538          move the found object (if necessary) in front.  */
 539       for (k = j + 1; k < nlist; ++k)
 540         {
 541           struct link_map **runp;
 542
 543           runp = map->l_initfini[k]->l_initfini;
 544           if (runp != NULL)
 545             {
 546               while (*runp != NULL)
 547                 if (*runp == l)
 548                   {
 549                     struct link_map *here = map->l_initfini[k];
 550
 551                     /* Move it now.  */
 552                     memmove (&map->l_initfini[j] + 1,
 553                              &map->l_initfini[j],
 554                              (k - j) * sizeof (struct link_map *));
 555                     map->l_initfini[j] = here;
 556
 557                     break;
 558                   }
 559                 else
 560                   ++runp;
 561             }
 562         }
 563     }
 564   /* Terminate the list of dependencies.  */
 565   map->l_initfini[nlist] = NULL;
 566 }