reclaim the memory wasted by dynamic linking for use by malloc
[musl] / src / ldso / dynlink.c
1 #include <stdio.h>
2 #include <stdlib.h>
3 #include <string.h>
4 #include <unistd.h>
5 #include <stdint.h>
6 #include <elf.h>
7 #include <sys/mman.h>
8 #include <limits.h>
9 #include <stdint.h>
10 #include <fcntl.h>
11 #include <sys/stat.h>
12 #include <errno.h>
13 #include <limits.h>
14 #include <elf.h>
15 #include <setjmp.h>
16 #include <pthread.h>
17 #include <dlfcn.h>
18
19 #include "reloc.h"
20
21 #if ULONG_MAX == 0xffffffff
22 typedef Elf32_Ehdr Ehdr;
23 typedef Elf32_Phdr Phdr;
24 typedef Elf32_Sym Sym;
25 #define R_TYPE(x) ((x)&255)
26 #define R_SYM(x) ((x)>>8)
27 #else
28 typedef Elf64_Ehdr Ehdr;
29 typedef Elf64_Phdr Phdr;
30 typedef Elf64_Sym Sym;
31 #define R_TYPE(x) ((x)&0xffffffff)
32 #define R_SYM(x) ((x)>>32)
33 #endif
34
35 struct dso
36 {
37         struct dso *next, *prev;
38         int refcnt;
39         size_t *dynv;
40         Sym *syms;
41         uint32_t *hashtab;
42         char *strings;
43         unsigned char *base;
44         unsigned char *map;
45         size_t map_len;
46         dev_t dev;
47         ino_t ino;
48         int global;
49         int relocated;
50         struct dso **deps;
51         char *name;
52         char buf[];
53 };
54
55 static struct dso *head, *tail, *libc;
56 static char *env_path, *sys_path;
57 static int rtld_used;
58 static int runtime;
59 static jmp_buf rtld_fail;
60 static pthread_rwlock_t lock;
61
62 #define AUX_CNT 15
63 #define DYN_CNT 34
64
65 static void decode_vec(size_t *v, size_t *a, size_t cnt)
66 {
67         memset(a, 0, cnt*sizeof(size_t));
68         for (; v[0]; v+=2) if (v[0]<cnt) {
69                 a[0] |= 1ULL<<v[0];
70                 a[v[0]] = v[1];
71         }
72 }
73
74 static uint32_t hash(const char *s)
75 {
76         uint_fast32_t h = 0;
77         while (*s) {
78                 h = 16*h + *s++;
79                 h ^= h>>24 & 0xf0;
80         }
81         return h & 0xfffffff;
82 }
83
84 static Sym *lookup(const char *s, uint32_t h, Sym *syms, uint32_t *hashtab, char *strings)
85 {
86         size_t i;
87         for (i=hashtab[2+h%hashtab[0]]; i; i=hashtab[2+hashtab[0]+i]) {
88                 if (!strcmp(s, strings+syms[i].st_name))
89                         return syms+i;
90         }
91         return 0;
92 }
93
94 #define OK_TYPES (1<<STT_NOTYPE | 1<<STT_OBJECT | 1<<STT_FUNC | 1<<STT_COMMON)
95
96 static void *find_sym(struct dso *dso, const char *s, int need_def)
97 {
98         uint32_t h = hash(s);
99         if (h==0x6b366be && !strcmp(s, "dlopen")) rtld_used = 1;
100         if (h==0x6b3afd && !strcmp(s, "dlsym")) rtld_used = 1;
101         for (; dso; dso=dso->next) {
102                 Sym *sym;
103                 if (!dso->global) continue;
104                 sym = lookup(s, h, dso->syms, dso->hashtab, dso->strings);
105                 if (sym && (!need_def || sym->st_shndx) && sym->st_value
106                  && (1<<(sym->st_info&0xf) & OK_TYPES))
107                         return dso->base + sym->st_value;
108         }
109         return 0;
110 }
111
112 static void do_relocs(unsigned char *base, size_t *rel, size_t rel_size, size_t stride, Sym *syms, char *strings, struct dso *dso)
113 {
114         Sym *sym;
115         const char *name;
116         size_t sym_val, sym_size;
117         size_t *reloc_addr;
118         void *ctx;
119         int type;
120         int sym_index;
121
122         for (; rel_size; rel+=stride, rel_size-=stride*sizeof(size_t)) {
123                 reloc_addr = (void *)(base + rel[0]);
124                 type = R_TYPE(rel[1]);
125                 sym_index = R_SYM(rel[1]);
126                 if (sym_index) {
127                         sym = syms + sym_index;
128                         name = strings + sym->st_name;
129                         ctx = IS_COPY(type) ? dso->next : dso;
130                         sym_val = (size_t)find_sym(ctx, name, IS_PLT(type));
131                         if (!sym_val && sym->st_info>>4 != STB_WEAK) {
132                                 if (runtime) longjmp(rtld_fail, 1);
133                                 dprintf(2, "%s: symbol not found\n", name);
134                                 _exit(127);
135                         }
136                         sym_size = sym->st_size;
137                 }
138                 do_single_reloc(reloc_addr, type, sym_val, sym_size, base, rel[2]);
139         }
140 }
141
142 /* A huge hack: to make up for the wastefulness of shared libraries
143  * needing at least a page of dirty memory even if they have no global
144  * data, we reclaim the gaps at the beginning and end of writable maps
145  * and "donate" them to the heap by setting up minimal malloc
146  * structures and then freeing them. */
147
148 static void reclaim(unsigned char *base, size_t start, size_t end)
149 {
150         size_t *a, *z;
151         start = start + 6*sizeof(size_t)-1 & -4*sizeof(size_t);
152         end = (end & -4*sizeof(size_t)) - 2*sizeof(size_t);
153         if (start>end || end-start < 4*sizeof(size_t)) return;
154         a = (size_t *)(base + start);
155         z = (size_t *)(base + end);
156         a[-2] = 1;
157         a[-1] = z[0] = end-start + 2*sizeof(size_t) | 1;
158         z[1] = 1;
159         free(a);
160 }
161
162 static void reclaim_gaps(unsigned char *base, Phdr *ph, size_t phent, size_t phcnt)
163 {
164         for (; phcnt--; ph=(void *)((char *)ph+phent)) {
165                 if (ph->p_type!=PT_LOAD) continue;
166                 if ((ph->p_flags&(PF_R|PF_W))!=(PF_R|PF_W)) continue;
167                 reclaim(base, ph->p_vaddr & -PAGE_SIZE, ph->p_vaddr);
168                 reclaim(base, ph->p_vaddr+ph->p_memsz,
169                         ph->p_vaddr+ph->p_memsz+PAGE_SIZE-1 & -PAGE_SIZE);
170         }
171 }
172
173 static void *map_library(int fd, size_t *lenp, unsigned char **basep, size_t *dynp)
174 {
175         Ehdr buf[(896+sizeof(Ehdr))/sizeof(Ehdr)];
176         size_t phsize;
177         size_t addr_min=SIZE_MAX, addr_max=0, map_len;
178         size_t this_min, this_max;
179         off_t off_start;
180         Ehdr *eh;
181         Phdr *ph;
182         unsigned prot;
183         unsigned char *map, *base;
184         size_t dyn;
185         size_t i;
186
187         ssize_t l = read(fd, buf, sizeof buf);
188         if (l<sizeof *eh) return 0;
189         eh = buf;
190         phsize = eh->e_phentsize * eh->e_phnum;
191         if (phsize + sizeof *eh > l) return 0;
192         if (eh->e_phoff + phsize > l) {
193                 l = pread(fd, buf+1, phsize, eh->e_phoff);
194                 if (l != phsize) return 0;
195                 eh->e_phoff = sizeof *eh;
196         }
197         ph = (void *)((char *)buf + eh->e_phoff);
198         for (i=eh->e_phnum; i; i--, ph=(void *)((char *)ph+eh->e_phentsize)) {
199                 if (ph->p_type == PT_DYNAMIC)
200                         dyn = ph->p_vaddr;
201                 if (ph->p_type != PT_LOAD) continue;
202                 if (ph->p_vaddr < addr_min) {
203                         addr_min = ph->p_vaddr;
204                         off_start = ph->p_offset;
205                         prot = (((ph->p_flags&PF_R) ? PROT_READ : 0) |
206                                 ((ph->p_flags&PF_W) ? PROT_WRITE: 0) |
207                                 ((ph->p_flags&PF_X) ? PROT_EXEC : 0));
208                 }
209                 if (ph->p_vaddr+ph->p_memsz > addr_max) {
210                         addr_max = ph->p_vaddr+ph->p_memsz;
211                 }
212         }
213         if (!dyn) return 0;
214         addr_max += PAGE_SIZE-1;
215         addr_max &= -PAGE_SIZE;
216         addr_min &= -PAGE_SIZE;
217         off_start &= -PAGE_SIZE;
218         map_len = addr_max - addr_min + off_start;
219         /* The first time, we map too much, possibly even more than
220          * the length of the file. This is okay because we will not
221          * use the invalid part; we just need to reserve the right
222          * amount of virtual address space to map over later. */
223         map = mmap((void *)addr_min, map_len, prot, MAP_PRIVATE, fd, off_start);
224         if (map==MAP_FAILED) return 0;
225         base = map - addr_min;
226         ph = (void *)((char *)buf + eh->e_phoff);
227         for (i=eh->e_phnum; i; i--, ph=(void *)((char *)ph+eh->e_phentsize)) {
228                 if (ph->p_type != PT_LOAD) continue;
229                 /* Reuse the existing mapping for the lowest-address LOAD */
230                 if ((ph->p_vaddr & -PAGE_SIZE) == addr_min) continue;
231                 this_min = ph->p_vaddr & -PAGE_SIZE;
232                 this_max = ph->p_vaddr+ph->p_memsz+PAGE_SIZE-1 & -PAGE_SIZE;
233                 off_start = ph->p_offset & -PAGE_SIZE;
234                 prot = (((ph->p_flags&PF_R) ? PROT_READ : 0) |
235                         ((ph->p_flags&PF_W) ? PROT_WRITE: 0) |
236                         ((ph->p_flags&PF_X) ? PROT_EXEC : 0));
237                 if (mmap(base+this_min, this_max-this_min, prot, MAP_PRIVATE|MAP_FIXED, fd, off_start) == MAP_FAILED) {
238                         munmap(map, map_len);
239                         return 0;
240                 }
241                 if (ph->p_memsz > ph->p_filesz) {
242                         size_t brk = (size_t)base+ph->p_vaddr+ph->p_filesz;
243                         size_t pgbrk = brk+PAGE_SIZE-1 & -PAGE_SIZE;
244                         memset((void *)brk, 0, pgbrk-brk & PAGE_SIZE-1);
245                         if (pgbrk-(size_t)base < this_max && mmap((void *)pgbrk, (size_t)base+this_max-pgbrk, prot, MAP_PRIVATE|MAP_FIXED|MAP_ANONYMOUS, -1, 0) == MAP_FAILED) {
246                                 munmap(map, map_len);
247                                 return 0;
248                         }
249                 }
250         }
251         if (!runtime) reclaim_gaps(base, (void *)((char *)buf + eh->e_phoff),
252                 eh->e_phentsize, eh->e_phnum);
253         *lenp = map_len;
254         *basep = base;
255         *dynp = dyn;
256         return map;
257 }
258
259 static int path_open(const char *name, const char *search)
260 {
261         char buf[2*NAME_MAX+2];
262         const char *s=search, *z;
263         int l, fd;
264         for (;;) {
265                 while (*s==':') s++;
266                 if (!*s) return -1;
267                 z = strchr(s, ':');
268                 l = z ? z-s : strlen(s);
269                 snprintf(buf, sizeof buf, "%.*s/%s", l, s, name);
270                 if ((fd = open(buf, O_RDONLY))>=0) return fd;
271                 s += l;
272         }
273 }
274
275 static struct dso *load_library(const char *name)
276 {
277         unsigned char *base, *map;
278         size_t dyno, map_len;
279         struct dso *p;
280         size_t dyn[DYN_CNT] = {0};
281         int fd;
282         struct stat st;
283
284         /* Catch and block attempts to reload the implementation itself */
285         if (name[0]=='l' && name[1]=='i' && name[2]=='b') {
286                 static const char *rp, reserved[] =
287                         "c\0pthread\0rt\0m\0dl\0util\0xnet\0";
288                 char *z = strchr(name, '.');
289                 if (z) {
290                         size_t l = z-name;
291                         for (rp=reserved; *rp && memcmp(name+3, rp, l-3); rp+=strlen(rp)+1);
292                         if (*rp) {
293                                 if (!libc->prev) {
294                                         tail->next = libc;
295                                         libc->prev = tail;
296                                         tail = libc;
297                                 }
298                                 return libc;
299                         }
300                 }
301         }
302         /* Search for the name to see if it's already loaded */
303         for (p=head->next; p; p=p->next) {
304                 if (!strcmp(p->name, name)) {
305                         p->refcnt++;
306                         return p;
307                 }
308         }
309         if (strchr(name, '/')) {
310                 fd = open(name, O_RDONLY);
311         } else {
312                 if (strlen(name) > NAME_MAX) return 0;
313                 fd = -1;
314                 if (env_path) fd = path_open(name, env_path);
315                 if (fd < 0) {
316                         if (!sys_path) {
317                                 FILE *f = fopen(ETC_LDSO_PATH, "r");
318                                 if (f) {
319                                         if (getline(&sys_path, (size_t[1]){0}, f) > 0)
320                                                 sys_path[strlen(sys_path)-1]=0;
321                                         fclose(f);
322                                 }
323                         }
324                         if (sys_path) fd = path_open(name, sys_path);
325                         else fd = path_open(name, "/lib:/usr/local/lib:/usr/lib");
326                 }
327         }
328         if (fd < 0) return 0;
329         if (fstat(fd, &st) < 0) {
330                 close(fd);
331                 return 0;
332         }
333         for (p=head->next; p; p=p->next) {
334                 if (p->dev == st.st_dev && p->ino == st.st_ino) {
335                         close(fd);
336                         p->refcnt++;
337                         return p;
338                 }
339         }
340         map = map_library(fd, &map_len, &base, &dyno);
341         close(fd);
342         if (!map) return 0;
343         p = calloc(1, sizeof *p + strlen(name) + 1);
344         if (!p) {
345                 munmap(map, map_len);
346                 return 0;
347         }
348
349         p->map = map;
350         p->map_len = map_len;
351         p->base = base;
352         p->dynv = (void *)(base + dyno);
353         decode_vec(p->dynv, dyn, DYN_CNT);
354
355         p->syms = (void *)(base + dyn[DT_SYMTAB]);
356         p->hashtab = (void *)(base + dyn[DT_HASH]);
357         p->strings = (void *)(base + dyn[DT_STRTAB]);
358         p->dev = st.st_dev;
359         p->ino = st.st_ino;
360         p->refcnt = 1;
361         p->name = p->buf;
362         strcpy(p->name, name);
363
364         tail->next = p;
365         p->prev = tail;
366         tail = p;
367
368         return p;
369 }
370
371 static void load_deps(struct dso *p)
372 {
373         size_t i, ndeps=0;
374         struct dso ***deps = &p->deps, **tmp, *dep;
375         for (; p; p=p->next) {
376                 for (i=0; p->dynv[i]; i+=2) {
377                         if (p->dynv[i] != DT_NEEDED) continue;
378                         dep = load_library(p->strings + p->dynv[i+1]);
379                         if (!dep) {
380                                 if (runtime) longjmp(rtld_fail, 1);
381                                 dprintf(2, "%s: %m (needed by %s)\n",
382                                         p->strings + p->dynv[i+1], p->name);
383                                 _exit(127);
384                         }
385                         if (runtime) {
386                                 tmp = realloc(*deps, sizeof(*tmp)*(ndeps+2));
387                                 if (!tmp) longjmp(rtld_fail, 1);
388                                 tmp[ndeps++] = dep;
389                                 tmp[ndeps] = 0;
390                                 *deps = tmp;
391                         }
392                 }
393         }
394 }
395
396 static void make_global(struct dso *p)
397 {
398         for (; p; p=p->next) p->global = 1;
399 }
400
401 static void reloc_all(struct dso *p)
402 {
403         size_t dyn[DYN_CNT] = {0};
404         for (; p; p=p->next) {
405                 if (p->relocated) continue;
406                 decode_vec(p->dynv, dyn, DYN_CNT);
407                 do_relocs(p->base, (void *)(p->base+dyn[DT_JMPREL]), dyn[DT_PLTRELSZ],
408                         2+(dyn[DT_PLTREL]==DT_RELA), p->syms, p->strings, head);
409                 do_relocs(p->base, (void *)(p->base+dyn[DT_REL]), dyn[DT_RELSZ],
410                         2, p->syms, p->strings, head);
411                 do_relocs(p->base, (void *)(p->base+dyn[DT_RELA]), dyn[DT_RELASZ],
412                         3, p->syms, p->strings, head);
413                 p->relocated = 1;
414         }
415 }
416
417 static void free_all(struct dso *p)
418 {
419         struct dso *n;
420         while (p) {
421                 n = p->next;
422                 if (p->map) free(p);
423                 p = n;
424         }
425 }
426
427 void *__dynlink(int argc, char **argv, size_t *got)
428 {
429         size_t *auxv, aux[AUX_CNT] = {0};
430         size_t app_dyn[DYN_CNT] = {0};
431         size_t lib_dyn[DYN_CNT] = {0};
432         size_t i;
433         Phdr *phdr;
434         Ehdr *ehdr;
435         struct dso lib, app;
436
437         /* Find aux vector just past environ[] */
438         for (i=argc+1; argv[i]; i++)
439                 if (!memcmp(argv[i], "LD_LIBRARY_PATH=", 16))
440                         env_path = argv[i]+16;
441         auxv = (void *)(argv+i+1);
442
443         decode_vec(auxv, aux, AUX_CNT);
444
445         /* Only trust user/env if kernel says we're not suid/sgid */
446         if ((aux[0]&0x7800)!=0x7800 || aux[AT_UID]!=aux[AT_EUID]
447           || aux[AT_GID]!=aux[AT_EGID]) {
448                 env_path = 0;
449         }
450
451         /* Relocate ldso's DYNAMIC pointer and load vector */
452         decode_vec((void *)(got[0] += aux[AT_BASE]), lib_dyn, DYN_CNT);
453
454         /* Find the program image's DYNAMIC section and decode it */
455         phdr = (void *)aux[AT_PHDR];
456         for (i=aux[AT_PHNUM]; i--; phdr=(void *)((char *)phdr + aux[AT_PHENT])) {
457                 if (phdr->p_type == PT_DYNAMIC) {
458                         decode_vec((void *)phdr->p_vaddr, app_dyn, DYN_CNT);
459                         break;
460                 }
461         }
462
463         app = (struct dso){
464                 .base = 0,
465                 .strings = (void *)(app_dyn[DT_STRTAB]),
466                 .hashtab = (void *)(app_dyn[DT_HASH]),
467                 .syms = (void *)(app_dyn[DT_SYMTAB]),
468                 .dynv = (void *)(phdr->p_vaddr),
469                 .name = argv[0],
470                 .global = 1,
471                 .next = &lib
472         };
473
474         lib = (struct dso){
475                 .base = (void *)aux[AT_BASE],
476                 .strings = (void *)(aux[AT_BASE]+lib_dyn[DT_STRTAB]),
477                 .hashtab = (void *)(aux[AT_BASE]+lib_dyn[DT_HASH]),
478                 .syms = (void *)(aux[AT_BASE]+lib_dyn[DT_SYMTAB]),
479                 .dynv = (void *)(got[0]),
480                 .name = "libc.so",
481                 .global = 1,
482                 .relocated = 1
483         };
484
485         /* Relocate the dynamic linker/libc */
486         do_relocs((void *)aux[AT_BASE], (void *)(aux[AT_BASE]+lib_dyn[DT_REL]),
487                 lib_dyn[DT_RELSZ], 2, lib.syms, lib.strings, &app);
488         do_relocs((void *)aux[AT_BASE], (void *)(aux[AT_BASE]+lib_dyn[DT_RELA]),
489                 lib_dyn[DT_RELASZ], 3, lib.syms, lib.strings, &app);
490
491         /* At this point the standard library is fully functional */
492
493         reclaim_gaps(app.base, (void *)aux[AT_PHDR], aux[AT_PHENT], aux[AT_PHNUM]);
494         ehdr = (void *)lib.base;
495         reclaim_gaps(lib.base, (void *)(lib.base+ehdr->e_phoff),
496                 ehdr->e_phentsize, ehdr->e_phnum);
497
498         head = tail = &app;
499         libc = &lib;
500         app.next = 0;
501         load_deps(head);
502
503         make_global(head);
504         reloc_all(head->next);
505         reloc_all(head);
506
507         if (rtld_used) {
508                 runtime = 1;
509                 head->next->prev = malloc(sizeof *head);
510                 *head->next->prev = *head;
511                 head = head->next->prev;
512                 libc->prev->next = malloc(sizeof *libc);
513                 *libc->prev->next = *libc;
514                 libc = libc->prev->next;
515                 if (libc->next) libc->next->prev = libc;
516                 if (tail == &lib) tail = libc;
517         } else {
518                 free_all(head);
519                 free(sys_path);
520         }
521
522         errno = 0;
523         return (void *)aux[AT_ENTRY];
524 }
525
526 void *dlopen(const char *file, int mode)
527 {
528         struct dso *p, *orig_tail = tail, *next;
529         size_t i;
530
531         if (!file) return head;
532
533         pthread_rwlock_wrlock(&lock);
534
535         if (setjmp(rtld_fail)) {
536                 /* Clean up anything new that was (partially) loaded */
537                 if (p->deps) for (i=0; p->deps[i]; i++)
538                         if (p->deps[i]->global < 0)
539                                 p->deps[i]->global = 0;
540                 for (p=orig_tail->next; p; p=next) {
541                         next = p->next;
542                         munmap(p->map, p->map_len);
543                         free(p->deps);
544                         free(p);
545                 }
546                 tail = orig_tail;
547                 tail->next = 0;
548                 pthread_rwlock_unlock(&lock);
549                 return 0;
550         }
551
552         p = load_library(file);
553         if (!p) goto end;
554
555         /* First load handling */
556         if (!p->deps) {
557                 load_deps(p);
558                 if (p->deps) for (i=0; p->deps[i]; i++)
559                         if (!p->deps[i]->global)
560                                 p->deps[i]->global = -1;
561                 if (!p->global) p->global = -1;
562                 reloc_all(p);
563                 if (p->deps) for (i=0; p->deps[i]; i++)
564                         if (p->deps[i]->global < 0)
565                                 p->deps[i]->global = 0;
566                 if (p->global < 0) p->global = 0;
567         }
568
569         if (mode & RTLD_GLOBAL) {
570                 if (p->deps) for (i=0; p->deps[i]; i++)
571                         p->deps[i]->global = 1;
572                 p->global = 1;
573         }
574
575 end:
576         pthread_rwlock_unlock(&lock);
577         return p;
578 }
579
580 static void *do_dlsym(struct dso *p, const char *s)
581 {
582         size_t i;
583         uint32_t h;
584         Sym *sym;
585         if (p == head || p == RTLD_DEFAULT)
586                 return find_sym(head, s, 0);
587         h = hash(s);
588         sym = lookup(s, h, p->syms, p->hashtab, p->strings);
589         if (sym && sym->st_value && (1<<(sym->st_info&0xf) & OK_TYPES))
590                 return p->base + sym->st_value;
591         if (p->deps) for (i=0; p->deps[i]; i++) {
592                 sym = lookup(s, h, p->deps[i]->syms,
593                         p->deps[i]->hashtab, p->deps[i]->strings);
594                 if (sym && sym->st_value && (1<<(sym->st_info&0xf) & OK_TYPES))
595                         return p->deps[i]->base + sym->st_value;
596         }
597         return 0;
598 }
599
600 void *dlsym(void *p, const char *s)
601 {
602         void *res;
603         pthread_rwlock_rdlock(&lock);
604         res = do_dlsym(p, s);
605         pthread_rwlock_unlock(&lock);
606         return res;
607 }
608
609 char *dlerror()
610 {
611         return "unknown error";
612 }
613
614 int dlclose(void *p)
615 {
616         return 0;
617 }