Update.
[platform/upstream/glibc.git] / elf / dl-open.c
1 /* Load a shared object at runtime, relocate it, and run its initializer.
2    Copyright (C) 1996-2001, 2002, 2003, 2004 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 <assert.h>
21 #include <dlfcn.h>
22 #include <errno.h>
23 #include <libintl.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <unistd.h>
28 #include <sys/mman.h>           /* Check whether MAP_COPY is defined.  */
29 #include <sys/param.h>
30 #include <bits/libc-lock.h>
31 #include <ldsodefs.h>
32 #include <bp-sym.h>
33 #include <gnu/lib-names.h>
34
35 #include <dl-dst.h>
36
37
38 #ifndef SHARED
39 /* Giving this initialized value preallocates some surplus bytes in the
40    static TLS area, see __libc_setup_tls (libc-tls.c).  */
41 size_t _dl_tls_static_size = 2048;
42 #endif
43
44 extern ElfW(Addr) _dl_sysdep_start (void **start_argptr,
45                                     void (*dl_main) (const ElfW(Phdr) *phdr,
46                                                      ElfW(Word) phnum,
47                                                      ElfW(Addr) *user_entry));
48 weak_extern (BP_SYM (_dl_sysdep_start))
49
50 extern int __libc_multiple_libcs;       /* Defined in init-first.c.  */
51
52 extern int __libc_argc attribute_hidden;
53 extern char **__libc_argv attribute_hidden;
54
55 extern char **__environ;
56
57 /* Undefine the following for debugging.  */
58 /* #define SCOPE_DEBUG 1 */
59 #ifdef SCOPE_DEBUG
60 static void show_scope (struct link_map *new);
61 #endif
62
63 /* We must be carefull not to leave us in an inconsistent state.  Thus we
64    catch any error and re-raise it after cleaning up.  */
65
66 struct dl_open_args
67 {
68   const char *file;
69   int mode;
70   /* This is the caller of the dlopen() function.  */
71   const void *caller_dlopen;
72   /* This is the caller if _dl_open().  */
73   const void *caller_dl_open;
74   struct link_map *map;
75 };
76
77
78 static int
79 add_to_global (struct link_map *new)
80 {
81   struct link_map **new_global;
82   unsigned int to_add = 0;
83   unsigned int cnt;
84
85   /* Count the objects we have to put in the global scope.  */
86   for (cnt = 0; cnt < new->l_searchlist.r_nlist; ++cnt)
87     if (new->l_searchlist.r_list[cnt]->l_global == 0)
88       ++to_add;
89
90   /* The symbols of the new objects and its dependencies are to be
91      introduced into the global scope that will be used to resolve
92      references from other dynamically-loaded objects.
93
94      The global scope is the searchlist in the main link map.  We
95      extend this list if necessary.  There is one problem though:
96      since this structure was allocated very early (before the libc
97      is loaded) the memory it uses is allocated by the malloc()-stub
98      in the ld.so.  When we come here these functions are not used
99      anymore.  Instead the malloc() implementation of the libc is
100      used.  But this means the block from the main map cannot be used
101      in an realloc() call.  Therefore we allocate a completely new
102      array the first time we have to add something to the locale scope.  */
103
104   if (GL(dl_global_scope_alloc) == 0)
105     {
106       /* This is the first dynamic object given global scope.  */
107       GL(dl_global_scope_alloc) = GL(dl_main_searchlist)->r_nlist + to_add + 8;
108       new_global = (struct link_map **)
109         malloc (GL(dl_global_scope_alloc) * sizeof (struct link_map *));
110       if (new_global == NULL)
111         {
112           GL(dl_global_scope_alloc) = 0;
113         nomem:
114           GLRO(dl_signal_error) (ENOMEM, new->l_libname->name, NULL,
115                                  N_("cannot extend global scope"));
116           return 1;
117         }
118
119       /* Copy over the old entries.  */
120       memcpy (new_global, GL(dl_main_searchlist)->r_list,
121               (GL(dl_main_searchlist)->r_nlist * sizeof (struct link_map *)));
122
123       GL(dl_main_searchlist)->r_list = new_global;
124     }
125   else if (GL(dl_main_searchlist)->r_nlist + to_add
126            > GL(dl_global_scope_alloc))
127     {
128       /* We have to extend the existing array of link maps in the
129          main map.  */
130       new_global = (struct link_map **)
131         realloc (GL(dl_main_searchlist)->r_list,
132                  ((GL(dl_global_scope_alloc) + to_add + 8)
133                   * sizeof (struct link_map *)));
134       if (new_global == NULL)
135         goto nomem;
136
137       GL(dl_global_scope_alloc) += to_add + 8;
138       GL(dl_main_searchlist)->r_list = new_global;
139     }
140
141   /* Now add the new entries.  */
142   for (cnt = 0; cnt < new->l_searchlist.r_nlist; ++cnt)
143     {
144       struct link_map *map = new->l_searchlist.r_list[cnt];
145
146       if (map->l_global == 0)
147         {
148           map->l_global = 1;
149           GL(dl_main_searchlist)->r_list[GL(dl_main_searchlist)->r_nlist]
150             = map;
151           ++GL(dl_main_searchlist)->r_nlist;
152         }
153     }
154
155   return 0;
156 }
157
158
159 #ifdef SHARED
160 static int
161 internal_function
162 check_libc_caller (const void *caller)
163 {
164   static const char expected1[] = LIBC_SO;
165   static const char expected2[] = LIBDL_SO;
166
167   /* If we already know the address ranges, just test.  */
168   static const void *expected1_from;
169   static const void *expected1_to;
170   static const void *expected2_from;
171   static const void *expected2_to;
172
173   if (expected1_from == NULL)
174     {
175       /* The only other DSO which is allowed to call these functions is
176          libdl.  Find the address range containing the caller.  */
177       struct link_map *l;
178
179       for (l = GL(dl_loaded); l != NULL; l = l->l_next)
180         if (strcmp (expected1, l->l_name) == 0)
181           {
182           is_1:
183             expected1_from = (const void *) l->l_map_start;
184             expected1_to = (const void *) l->l_map_end;
185           }
186         else if (strcmp (expected1, l->l_name) == 0)
187           {
188           is_2:
189             expected2_from = (const void *) l->l_map_start;
190             expected2_to = (const void *) l->l_map_end;
191           }
192         else
193           {
194             struct libname_list *runp = l->l_libname;
195
196             while (runp != NULL)
197               {
198                 if (strcmp (expected1, runp->name) == 0)
199                   goto is_1;
200                 else if (strcmp (expected2, runp->name) == 0)
201                   goto is_2;
202
203                 runp = runp->next;
204               }
205           }
206
207       assert (expected1_from != NULL);
208     }
209
210   /* When there would be more than two expected caller we could use an
211      array for the values but for now this is cheaper.  */
212   if ((caller >= expected1_from && caller < expected1_to)
213       || (caller >= expected2_from && caller < expected2_to))
214     return 0;
215
216   return 1;
217 }
218 #endif
219
220
221 static void
222 dl_open_worker (void *a)
223 {
224   struct dl_open_args *args = a;
225   const char *file = args->file;
226   int mode = args->mode;
227   struct link_map *new, *l;
228   const char *dst;
229   int lazy;
230   unsigned int i;
231 #ifdef USE_TLS
232   bool any_tls;
233 #endif
234
235 #ifdef SHARED
236   /* Check whether _dl_open() has been called from a valid DSO.  */
237   if (check_libc_caller (args->caller_dl_open) != 0)
238     GLRO(dl_signal_error) (0, "dlopen", NULL, N_("invalid caller"));
239 #endif
240
241   /* Maybe we have to expand a DST.  */
242   dst = strchr (file, '$');
243   if (__builtin_expect (dst != NULL, 0))
244     {
245       const void *caller_dlopen = args->caller_dlopen;
246       size_t len = strlen (file);
247       size_t required;
248       struct link_map *call_map;
249       char *new_file;
250
251       /* DSTs must not appear in SUID/SGID programs.  */
252       if (__libc_enable_secure)
253         /* This is an error.  */
254         GLRO(dl_signal_error) (0, "dlopen", NULL,
255                                N_("DST not allowed in SUID/SGID programs"));
256
257       /* We have to find out from which object the caller is calling.  */
258       call_map = NULL;
259       for (l = GL(dl_loaded); l; l = l->l_next)
260         if (caller_dlopen >= (const void *) l->l_map_start
261             && caller_dlopen < (const void *) l->l_map_end)
262           {
263             /* There must be exactly one DSO for the range of the virtual
264                memory.  Otherwise something is really broken.  */
265             call_map = l;
266             break;
267           }
268
269       if (call_map == NULL)
270         /* In this case we assume this is the main application.  */
271         call_map = GL(dl_loaded);
272
273       /* Determine how much space we need.  We have to allocate the
274          memory locally.  */
275       required = DL_DST_REQUIRED (call_map, file, len, _dl_dst_count (dst, 0));
276
277       /* Get space for the new file name.  */
278       new_file = (char *) alloca (required + 1);
279
280       /* Generate the new file name.  */
281       _dl_dst_substitute (call_map, file, new_file, 0);
282
283       /* If the substitution failed don't try to load.  */
284       if (*new_file == '\0')
285         GLRO(dl_signal_error) (0, "dlopen", NULL,
286                                N_("empty dynamic string token substitution"));
287
288       /* Now we have a new file name.  */
289       file = new_file;
290     }
291
292   /* Load the named object.  */
293   args->map = new = GLRO(dl_map_object) (NULL, file, 0, lt_loaded, 0, mode);
294
295   /* If the pointer returned is NULL this means the RTLD_NOLOAD flag is
296      set and the object is not already loaded.  */
297   if (new == NULL)
298     {
299       assert (mode & RTLD_NOLOAD);
300       return;
301     }
302
303   if (__builtin_expect (mode & __RTLD_SPROF, 0))
304     /* This happens only if we load a DSO for 'sprof'.  */
305     return;
306
307   /* It was already open.  */
308   if (__builtin_expect (new->l_searchlist.r_list != NULL, 0))
309     {
310       /* Let the user know about the opencount.  */
311       if (__builtin_expect (GLRO(dl_debug_mask) & DL_DEBUG_FILES, 0))
312         GLRO(dl_debug_printf) ("opening file=%s; opencount == %u\n\n",
313                                new->l_name, new->l_opencount);
314
315       /* If the user requested the object to be in the global namespace
316          but it is not so far, add it now.  */
317       if ((mode & RTLD_GLOBAL) && new->l_global == 0)
318         (void) add_to_global (new);
319
320       /* Increment just the reference counter of the object.  */
321       ++new->l_opencount;
322
323       return;
324     }
325
326   /* Load that object's dependencies.  */
327   GLRO(dl_map_object_deps) (new, NULL, 0, 0, mode & __RTLD_DLOPEN);
328
329   /* So far, so good.  Now check the versions.  */
330   for (i = 0; i < new->l_searchlist.r_nlist; ++i)
331     if (new->l_searchlist.r_list[i]->l_versions == NULL)
332       (void) GLRO(dl_check_map_versions) (new->l_searchlist.r_list[i], 0, 0);
333
334 #ifdef SCOPE_DEBUG
335   show_scope (new);
336 #endif
337
338   /* Only do lazy relocation if `LD_BIND_NOW' is not set.  */
339   lazy = (mode & RTLD_BINDING_MASK) == RTLD_LAZY && GLRO(dl_lazy);
340
341   /* Relocate the objects loaded.  We do this in reverse order so that copy
342      relocs of earlier objects overwrite the data written by later objects.  */
343
344   l = new;
345   while (l->l_next)
346     l = l->l_next;
347   while (1)
348     {
349       if (! l->l_relocated)
350         {
351 #ifdef SHARED
352           if (GLRO(dl_profile) != NULL)
353             {
354               /* If this here is the shared object which we want to profile
355                  make sure the profile is started.  We can find out whether
356                  this is necessary or not by observing the `_dl_profile_map'
357                  variable.  If was NULL but is not NULL afterwars we must
358                  start the profiling.  */
359               struct link_map *old_profile_map = GL(dl_profile_map);
360
361               GLRO(dl_relocate_object) (l, l->l_scope, 1, 1);
362
363               if (old_profile_map == NULL && GL(dl_profile_map) != NULL)
364                 /* We must prepare the profiling.  */
365                 GLRO(dl_start_profile) ();
366             }
367           else
368 #endif
369             GLRO(dl_relocate_object) (l, l->l_scope, lazy, 0);
370         }
371
372       if (l == new)
373         break;
374       l = l->l_prev;
375     }
376
377 #ifdef USE_TLS
378   /* Do static TLS initialization now if it has been delayed because
379      the TLS template might not be fully relocated at _dl_allocate_static_tls
380      time.  */
381   for (l = new; l; l = l->l_next)
382     if (l->l_need_tls_init)
383       {
384         l->l_need_tls_init = 0;
385         GL(dl_init_static_tls) (l);
386       }
387
388   /* We normally don't bump the TLS generation counter.  There must be
389      actually a need to do this.  */
390   any_tls = false;
391 #endif
392
393   /* Increment the open count for all dependencies.  If the file is
394      not loaded as a dependency here add the search list of the newly
395      loaded object to the scope.  */
396   for (i = 0; i < new->l_searchlist.r_nlist; ++i)
397     if (++new->l_searchlist.r_list[i]->l_opencount > 1
398         && new->l_searchlist.r_list[i]->l_type == lt_loaded)
399       {
400         struct link_map *imap = new->l_searchlist.r_list[i];
401         struct r_scope_elem **runp = imap->l_scope;
402         size_t cnt = 0;
403
404         while (*runp != NULL)
405           {
406             /* This can happen if imap was just loaded, but during
407                relocation had l_opencount bumped because of relocation
408                dependency.  Avoid duplicates in l_scope.  */
409             if (__builtin_expect (*runp == &new->l_searchlist, 0))
410               break;
411
412             ++cnt;
413             ++runp;
414           }
415
416         if (*runp != NULL)
417           /* Avoid duplicates.  */
418           continue;
419
420         if (__builtin_expect (cnt + 1 >= imap->l_scope_max, 0))
421           {
422             /* The 'r_scope' array is too small.  Allocate a new one
423                dynamically.  */
424             struct r_scope_elem **newp;
425             size_t new_size = imap->l_scope_max * 2;
426
427             if (imap->l_scope == imap->l_scope_mem)
428               {
429                 newp = (struct r_scope_elem **)
430                   malloc (new_size * sizeof (struct r_scope_elem *));
431                 if (newp == NULL)
432                   GLRO(dl_signal_error) (ENOMEM, "dlopen", NULL,
433                                          N_("cannot create scope list"));
434                 imap->l_scope = memcpy (newp, imap->l_scope,
435                                         cnt * sizeof (imap->l_scope[0]));
436               }
437             else
438               {
439                 newp = (struct r_scope_elem **)
440                   realloc (imap->l_scope,
441                            new_size * sizeof (struct r_scope_elem *));
442                 if (newp == NULL)
443                   GLRO(dl_signal_error) (ENOMEM, "dlopen", NULL,
444                                          N_("cannot create scope list"));
445                 imap->l_scope = newp;
446               }
447
448             imap->l_scope_max = new_size;
449           }
450
451         imap->l_scope[cnt++] = &new->l_searchlist;
452         imap->l_scope[cnt] = NULL;
453       }
454 #if USE_TLS
455     else if (new->l_searchlist.r_list[i]->l_opencount == 1
456              /* Only if the module defines thread local data.  */
457              && __builtin_expect (new->l_searchlist.r_list[i]->l_tls_blocksize
458                                   > 0, 0))
459       {
460         /* Now that we know the object is loaded successfully add
461            modules containing TLS data to the dtv info table.  We
462            might have to increase its size.  */
463         struct dtv_slotinfo_list *listp;
464         struct dtv_slotinfo_list *prevp;
465         size_t idx = new->l_searchlist.r_list[i]->l_tls_modid;
466
467         assert (new->l_searchlist.r_list[i]->l_type == lt_loaded);
468
469         /* Find the place in the dtv slotinfo list.  */
470         listp = GL(dl_tls_dtv_slotinfo_list);
471         prevp = NULL;           /* Needed to shut up gcc.  */
472         do
473           {
474             /* Does it fit in the array of this list element?  */
475             if (idx < listp->len)
476               break;
477             idx -= listp->len;
478             prevp = listp;
479             listp = listp->next;
480           }
481         while (listp != NULL);
482
483         if (listp == NULL)
484           {
485             /* When we come here it means we have to add a new element
486                to the slotinfo list.  And the new module must be in
487                the first slot.  */
488             assert (idx == 0);
489
490             listp = prevp->next = (struct dtv_slotinfo_list *)
491               malloc (sizeof (struct dtv_slotinfo_list)
492                       + TLS_SLOTINFO_SURPLUS * sizeof (struct dtv_slotinfo));
493             if (listp == NULL)
494               {
495                 /* We ran out of memory.  We will simply fail this
496                    call but don't undo anything we did so far.  The
497                    application will crash or be terminated anyway very
498                    soon.  */
499
500                 /* We have to do this since some entries in the dtv
501                    slotinfo array might already point to this
502                    generation.  */
503                 ++GL(dl_tls_generation);
504
505                 GLRO(dl_signal_error) (ENOMEM, "dlopen", NULL, N_("\
506 cannot create TLS data structures"));
507               }
508
509             listp->len = TLS_SLOTINFO_SURPLUS;
510             listp->next = NULL;
511             memset (listp->slotinfo, '\0',
512                     TLS_SLOTINFO_SURPLUS * sizeof (struct dtv_slotinfo));
513           }
514
515         /* Add the information into the slotinfo data structure.  */
516         listp->slotinfo[idx].map = new->l_searchlist.r_list[i];
517         listp->slotinfo[idx].gen = GL(dl_tls_generation) + 1;
518
519         /* We have to bump the generation counter.  */
520         any_tls = true;
521       }
522
523   /* Bump the generation number if necessary.  */
524   if (any_tls)
525     if (__builtin_expect (++GL(dl_tls_generation) == 0, 0))
526       __libc_fatal (_("TLS generation counter wrapped!  Please send report with the 'glibcbug' script."));
527 #endif
528
529   /* Run the initializer functions of new objects.  */
530   GLRO(dl_init) (new, __libc_argc, __libc_argv, __environ);
531
532   /* Now we can make the new map available in the global scope.  */
533   if (mode & RTLD_GLOBAL)
534     /* Move the object in the global namespace.  */
535     if (add_to_global (new) != 0)
536       /* It failed.  */
537       return;
538
539   /* Mark the object as not deletable if the RTLD_NODELETE flags was
540      passed.  */
541   if (__builtin_expect (mode & RTLD_NODELETE, 0))
542     new->l_flags_1 |= DF_1_NODELETE;
543
544 #ifndef SHARED
545   /* We must be the static _dl_open in libc.a.  A static program that
546      has loaded a dynamic object now has competition.  */
547   __libc_multiple_libcs = 1;
548 #endif
549
550   /* Let the user know about the opencount.  */
551   if (__builtin_expect (GLRO(dl_debug_mask) & DL_DEBUG_FILES, 0))
552     GLRO(dl_debug_printf) ("opening file=%s; opencount == %u\n\n",
553                            new->l_name, new->l_opencount);
554 }
555
556
557 void *
558 internal_function
559 _dl_open (const char *file, int mode, const void *caller_dlopen)
560 {
561   struct dl_open_args args;
562   const char *objname;
563   const char *errstring;
564   int errcode;
565
566   if ((mode & RTLD_BINDING_MASK) == 0)
567     /* One of the flags must be set.  */
568     GLRO(dl_signal_error) (EINVAL, file, NULL,
569                            N_("invalid mode for dlopen()"));
570
571   /* Make sure we are alone.  */
572   __rtld_lock_lock_recursive (GL(dl_load_lock));
573
574   args.file = file;
575   args.mode = mode;
576   args.caller_dlopen = caller_dlopen;
577   args.caller_dl_open = RETURN_ADDRESS (0);
578   args.map = NULL;
579   errcode = GLRO(dl_catch_error) (&objname, &errstring, dl_open_worker, &args);
580
581 #ifndef MAP_COPY
582   /* We must munmap() the cache file.  */
583   GLRO(dl_unload_cache) ();
584 #endif
585
586   /* Release the lock.  */
587   __rtld_lock_unlock_recursive (GL(dl_load_lock));
588
589   if (__builtin_expect (errstring != NULL, 0))
590     {
591       /* Some error occurred during loading.  */
592       char *local_errstring;
593       size_t len_errstring;
594
595       /* Remove the object from memory.  It may be in an inconsistent
596          state if relocation failed, for example.  */
597       if (args.map)
598         {
599           unsigned int i;
600
601           /* Increment open counters for all objects since this
602              sometimes has not happened yet.  */
603           if (args.map->l_searchlist.r_list[0]->l_opencount == 0)
604             for (i = 0; i < args.map->l_searchlist.r_nlist; ++i)
605               ++args.map->l_searchlist.r_list[i]->l_opencount;
606
607 #ifdef USE_TLS
608           /* Maybe some of the modules which were loaded uses TLS.
609              Since it will be removed in the following _dl_close call
610              we have to mark the dtv array as having gaps to fill
611              the holes.  This is a pessimistic assumption which won't
612              hurt if not true.  */
613           GL(dl_tls_dtv_gaps) = true;
614 #endif
615
616           _dl_close (args.map);
617         }
618
619       /* Make a local copy of the error string so that we can release the
620          memory allocated for it.  */
621       len_errstring = strlen (errstring) + 1;
622       if (objname == errstring + len_errstring)
623         {
624           size_t total_len = len_errstring + strlen (objname) + 1;
625           local_errstring = alloca (total_len);
626           memcpy (local_errstring, errstring, total_len);
627           objname = local_errstring + len_errstring;
628         }
629       else
630         {
631           local_errstring = alloca (len_errstring);
632           memcpy (local_errstring, errstring, len_errstring);
633         }
634
635       if (errstring != _dl_out_of_memory)
636         free ((char *) errstring);
637
638       /* Reraise the error.  */
639       GLRO(dl_signal_error) (errcode, objname, NULL, local_errstring);
640     }
641
642 #ifndef SHARED
643   DL_STATIC_INIT (args.map);
644 #endif
645
646   return args.map;
647 }
648 libc_hidden_def (_dl_open)
649
650
651 #ifdef SCOPE_DEBUG
652 #include <unistd.h>
653
654 static void
655 show_scope (struct link_map *new)
656 {
657   int scope_cnt;
658
659   for (scope_cnt = 0; new->l_scope[scope_cnt] != NULL; ++scope_cnt)
660     {
661       char numbuf[2];
662       unsigned int cnt;
663
664       numbuf[0] = '0' + scope_cnt;
665       numbuf[1] = '\0';
666       _dl_printf ("scope %s:", numbuf);
667
668       for (cnt = 0; cnt < new->l_scope[scope_cnt]->r_nlist; ++cnt)
669         if (*new->l_scope[scope_cnt]->r_list[cnt]->l_name)
670           _dl_printf (" %s", new->l_scope[scope_cnt]->r_list[cnt]->l_name);
671         else
672           _dl_printf (" <main>");
673
674       _dl_printf ("\n");
675     }
676 }
677 #endif