7319602d813bdb71c969e5b5a74e86be417ae0b8
[kopensolaris-gnu/glibc.git] / elf / dl-load.c
1 /* _dl_map_object -- Map in a shared object's segments from the file.
2 Copyright (C) 1995 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
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 #include <link.h>
21 #include <sys/types.h>
22 #include <sys/mman.h>
23 #include <string.h>
24 #include <fcntl.h>
25 #include <unistd.h>
26 #include <stdlib.h>
27 #include <errno.h>
28 #include "dynamic-link.h"
29
30
31 #include <endian.h>
32 #if BYTE_ORDER == BIG_ENDIAN
33 #define byteorder ELFDATA2MSB
34 #define byteorder_name "big-endian"
35 #elif BYTE_ORDER == LITTLE_ENDIAN
36 #define byteorder ELFDATA2LSB
37 #define byteorder_name "little-endian"
38 #else
39 #error "Unknown BYTE_ORDER " BYTE_ORDER
40 #define byteorder ELFDATANONE
41 #endif
42
43 #define STRING(x) #x
44
45 int _dl_zerofd = -1;
46
47
48 /* Try to open NAME in one of the directories in DIRPATH.
49    Return the fd, or -1.  If successful, fill in *REALNAME
50    with the malloc'd full directory name.  */
51
52 static int
53 open_path (const char *name, size_t namelen,
54            const char *dirpath,
55            char **realname)
56 {
57   char *buf;
58   const char *p;
59   int fd;
60
61   p = dirpath;
62   if (p == NULL || *p == '\0')
63     {
64       errno = ENOENT;
65       return -1;
66     }
67
68   buf = alloca (strlen (dirpath) + 1 + namelen);
69   do
70     {
71       dirpath = p;
72       p = strpbrk (dirpath, ":;");
73       if (p == NULL)
74         p = strchr (dirpath, '\0');
75
76       if (p == dirpath)
77         /* Two adjacent colons, or a colon at the beginning or the end of
78            the path means to search the current directory.  */
79         (void) memcpy (buf, name, namelen);
80       else
81         {
82           /* Construct the pathname to try.  */
83           (void) memcpy (buf, dirpath, p - dirpath);
84           buf[p - dirpath] = '/';
85           (void) memcpy (&buf[(p - dirpath) + 1], name, namelen);
86         }
87
88       fd = open (buf, O_RDONLY);
89       if (fd != -1)
90         {
91           *realname = strdup (buf);
92           return fd;
93         }
94       if (errno != ENOENT && errno != EACCES)
95         /* The file exists and is readable, but something went wrong.  */
96         return -1;
97     }
98   while (*p++ != '\0');
99
100   return -1;
101 }
102
103
104 /* Map in the shared object file NAME.  */
105
106 struct link_map *
107 _dl_map_object (struct link_map *loader, const char *name,
108                 Elf32_Addr *entry_point)
109 {
110   int fd;
111   char *realname;
112   struct link_map *l;
113
114   /* Look for this name among those already loaded.  */
115   for (l = _dl_loaded; l; l = l->l_next)
116     if (! strcmp (name, l->l_libname))
117       {
118         /* The object is already loaded.
119            Just bump its reference count and return it.  */
120         ++l->l_opencount;
121         return l;
122       }
123
124   if (strchr (name, '/') == NULL)
125     {
126       /* Search for NAME in several places.  */
127
128       size_t namelen = strlen (name) + 1;
129
130       inline void trypath (const char *dirpath)
131         {
132           fd = open_path (name, namelen, dirpath, &realname);
133         }
134
135       fd = -1;
136       if (loader && loader->l_info[DT_RPATH])
137         trypath ((const char *) (loader->l_addr +
138                                  loader->l_info[DT_STRTAB]->d_un.d_ptr +
139                                  loader->l_info[DT_RPATH]->d_un.d_val));
140       if (fd == -1 && ! _dl_secure)
141         trypath (getenv ("LD_LIBRARY_PATH"));
142       if (fd == -1)
143         trypath ("/lib:/usr/lib");
144     }
145   else
146     {
147       fd = open (name, O_RDONLY);
148       if (fd != -1)
149         realname = strdup (name);
150     }
151
152   if (fd == -1)
153     _dl_signal_error (errno, name, "cannot open shared object file");
154
155   return _dl_map_object_from_fd (name, fd, realname, entry_point);
156 }
157
158
159 /* Map in the shared object NAME, actually located in REALNAME, and already
160    opened on FD.  */
161
162 struct link_map *
163 _dl_map_object_from_fd (const char *name, int fd, char *realname, 
164                         Elf32_Addr *entry_point)
165 {
166   struct link_map *l = NULL;
167   const size_t pagesize = getpagesize ();
168   void *file_mapping = NULL;
169   size_t mapping_size = 0;
170
171   void lose (int code, const char *msg)
172     {
173       (void) close (fd);
174       if (file_mapping)
175         munmap (file_mapping, mapping_size);
176       _dl_signal_error (code, l ? l->l_name : name, msg);
177     }
178
179   /* Make sure LOCATION is mapped in.  */
180   void *map (off_t location, size_t size)
181     {
182       if ((off_t) mapping_size <= location + (off_t) size)
183         {
184           void *result;
185           if (file_mapping)
186             munmap (file_mapping, mapping_size);
187           mapping_size = (location + size + 1 + pagesize - 1);
188           mapping_size &= ~(pagesize - 1);
189           result = mmap (file_mapping, mapping_size, PROT_READ,
190                          MAP_COPY|MAP_FILE, fd, 0);
191           if (result == (void *) -1)
192             lose (errno, "cannot map file data");
193           file_mapping = result;
194         }
195       return file_mapping + location;
196     }
197
198   const Elf32_Ehdr *header;
199
200   /* Look again to see if the real name matched another already loaded.  */
201   for (l = _dl_loaded; l; l = l->l_next)
202     if (! strcmp (realname, l->l_name))
203       {
204         /* The object is already loaded.
205            Just bump its reference count and return it.  */
206         close (fd);
207         free (realname);
208         ++l->l_opencount;
209         return l;
210       }
211
212   /* Map in the first page to read the header.  */
213   header = map (0, sizeof *header);
214
215 #undef LOSE
216 #define LOSE(s) lose (0, (s))
217   /* Check the header for basic validity.  */
218   if (*(Elf32_Word *) &header->e_ident != ((ELFMAG0 << (EI_MAG0 * 8)) |
219                                            (ELFMAG1 << (EI_MAG1 * 8)) |
220                                            (ELFMAG2 << (EI_MAG2 * 8)) |
221                                            (ELFMAG3 << (EI_MAG3 * 8))))
222     LOSE ("invalid ELF header");
223   if (header->e_ident[EI_CLASS] != ELFCLASS32)
224     LOSE ("ELF file class not 32-bit");
225   if (header->e_ident[EI_DATA] != byteorder)
226     LOSE ("ELF file data encoding not " byteorder_name);
227   if (header->e_ident[EI_VERSION] != EV_CURRENT)
228     LOSE ("ELF file version ident not " STRING(EV_CURRENT));
229   if (header->e_version != EV_CURRENT)
230     LOSE ("ELF file version not " STRING(EV_CURRENT));
231   if (! elf_machine_matches_host (header->e_machine))
232     LOSE ("ELF file machine architecture not " ELF_MACHINE_NAME);
233   if (header->e_phentsize != sizeof (Elf32_Phdr))
234     LOSE ("ELF file's phentsize not the expected size");
235
236   /* Enter the new object in the list of loaded objects.  */
237   l = _dl_new_object (realname, name, lt_loaded);
238   l->l_opencount = 1;
239
240   if (_dl_zerofd == -1)
241     {
242       _dl_zerofd = _dl_sysdep_open_zero_fill ();
243       if (_dl_zerofd == -1)
244         _dl_signal_error (errno, NULL, "cannot open zero fill device");
245     }
246
247   {
248     /* Copy the program header table into stack space so we can then unmap
249        the headers.  */
250     Elf32_Phdr phdr[header->e_phnum];
251     const Elf32_Phdr *ph;
252     int anywhere;
253
254     ph = map (header->e_phoff, header->e_phnum * sizeof (Elf32_Phdr));
255     memcpy (phdr, ph, sizeof phdr);
256     l->l_phnum = header->e_phnum;
257
258     anywhere = header->e_type == ET_DYN || header->e_type == ET_REL;
259
260     if (entry_point)
261       *entry_point = header->e_entry;
262
263     /* We are done reading the file's headers now.  Unmap them.  */
264     munmap (file_mapping, mapping_size);
265
266     /* Scan the program header table, processing its load commands.  */
267     l->l_addr = 0;
268     l->l_ld = 0;
269     for (ph = phdr; ph < &phdr[l->l_phnum]; ++ph)
270       switch (ph->p_type)
271         {
272           /* These entries tell us where to find things once the file's
273              segments are mapped in.  We record the addresses it says
274              verbatim, and later correct for the run-time load address.  */
275         case PT_DYNAMIC:
276           l->l_ld = (void *) ph->p_vaddr;
277           break;
278         case PT_PHDR:
279           l->l_phdr = (void *) ph->p_vaddr;
280           break;
281
282         case PT_LOAD:
283           /* A load command tells us to map in part of the file.  */
284           if (ph->p_align % pagesize != 0)
285             LOSE ("ELF load command alignment not page-aligned");
286           if ((ph->p_vaddr - ph->p_offset) % ph->p_align)
287             LOSE ("ELF load command address/offset not properly aligned");
288           {
289             Elf32_Addr mapstart = ph->p_vaddr & ~(ph->p_align - 1);
290             Elf32_Addr mapend = ((ph->p_vaddr + ph->p_filesz + ph->p_align - 1)
291                                  & ~(ph->p_align - 1));
292             off_t mapoff = ph->p_offset & ~(ph->p_align - 1);
293             caddr_t mapat;
294             int prot = 0;
295             if (ph->p_flags & PF_R)
296               prot |= PROT_READ;
297             if (ph->p_flags & PF_W)
298               prot |= PROT_WRITE;
299             if (ph->p_flags & PF_X)
300               prot |= PROT_EXEC;
301
302             if (anywhere)
303               {
304                 /* XXX this loses if the first segment mmap call puts
305                    it someplace where the later segments cannot fit.  */
306                 mapat = mmap ((caddr_t) (l->l_addr + mapstart),
307                               mapend - mapstart,
308                               prot, MAP_COPY|MAP_FILE|MAP_INHERIT |
309                               /* Let the system choose any convenient
310                                  location if this is the first segment.
311                                  Following segments must be contiguous in
312                                  virtual space with the first.  */
313                               (l->l_addr == 0 ? 0 : MAP_FIXED),
314                               fd, mapoff);
315                 if (l->l_addr == 0)
316                   /* This was the first segment mapped, so MAPAT is
317                      the address the system chose for us.  Record it.  */
318                   l->l_addr = (Elf32_Addr) mapat - mapstart;
319               }
320             else
321               {
322                 mapat = mmap ((caddr_t) mapstart, mapend - mapstart,
323                               prot, MAP_COPY|MAP_FILE|MAP_INHERIT|MAP_FIXED,
324                               fd, mapoff);
325                 /* This file refers to absolute addresses.  So consider its
326                    "load base" to be zero, since that is what we add to the
327                    file's addresses to find them in our memory.  */
328                 l->l_addr = 0;
329               }
330             if (mapat == (caddr_t) -1)
331               lose (errno, "failed to map segment from shared object");
332
333             if (ph->p_memsz > ph->p_filesz)
334               {
335                 /* Extra zero pages should appear at the end of this segment,
336                    after the data mapped from the file.   */
337                 caddr_t zero, zeroend, zeropage;
338
339                 mapat += ph->p_vaddr - mapstart;
340                 zero = mapat + ph->p_filesz;
341                 zeroend = mapat + ph->p_memsz;
342                 zeropage = (caddr_t) ((Elf32_Addr) (zero + pagesize - 1)
343                                       & ~(pagesize - 1));
344
345                 if (zeroend < zeropage)
346                   /* All the extra data is in the last page of the segment.
347                      We can just zero it.  */
348                   zeropage = zeroend;
349                 if (zeropage > zero)
350                   {
351                     /* Zero the final part of the last page of the segment.  */
352                     if ((prot & PROT_WRITE) == 0)
353                       {
354                         /* Dag nab it.  */
355                         if (mprotect ((caddr_t) ((Elf32_Addr) zero
356                                                  & ~(pagesize - 1)),
357                                       pagesize,
358                                       prot|PROT_WRITE) < 0)
359                           lose (errno, "cannot change memory protections");
360                       }
361                     memset (zero, 0, zeropage - zero);
362                     if ((prot & PROT_WRITE) == 0)
363                       mprotect ((caddr_t) ((Elf32_Addr) zero
364                                            & ~(pagesize - 1)),
365                                 pagesize, prot);
366                   }
367
368                 if (zeroend > zeropage)
369                   /* Map the remaining zero pages in from the zero fill FD.  */
370                   mapat = mmap (zeropage, zeroend - zeropage, prot,
371                                 MAP_ANON|MAP_PRIVATE|MAP_FIXED|MAP_INHERIT,
372                                 _dl_zerofd, 0);
373               }
374           }
375         }
376
377     if (l->l_ld == 0)
378       LOSE ("object file has no dynamic section");
379     (Elf32_Addr) l->l_ld += l->l_addr;
380
381     if (l->l_phdr == 0)
382       l->l_phdr = (void *) ((const Elf32_Ehdr *) l->l_addr)->e_phoff;
383     (Elf32_Addr) l->l_phdr += l->l_addr;
384   }
385
386   elf_get_dynamic_info (l->l_ld, l->l_info);
387   if (l->l_info[DT_HASH])
388     _dl_setup_hash (l);
389
390   return l;
391 }