Assorted spelling fixes.
[wine] / dlls / dbghelp / elf_module.c
1 /*
2  * File elf.c - processing of ELF files
3  *
4  * Copyright (C) 1996, Eric Youngdale.
5  *               1999-2004 Eric Pouech
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #include "config.h"
23
24 #include <assert.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <sys/stat.h>
28 #include <fcntl.h>
29 #ifdef HAVE_SYS_MMAN_H
30 #include <sys/mman.h>
31 #endif
32 #ifdef HAVE_UNISTD_H
33 # include <unistd.h>
34 #endif
35 #ifndef PATH_MAX
36 #define PATH_MAX MAX_PATH
37 #endif
38
39 #include "dbghelp_private.h"
40
41 #if defined(__svr4__) || defined(__sun)
42 #define __ELF__
43 #endif
44
45 #ifdef HAVE_ELF_H
46 # include <elf.h>
47 #endif
48 #ifdef HAVE_SYS_ELF32_H
49 # include <sys/elf32.h>
50 #endif
51 #ifdef HAVE_SYS_EXEC_ELF_H
52 # include <sys/exec_elf.h>
53 #endif
54 #if !defined(DT_NUM)
55 # if defined(DT_COUNT)
56 #  define DT_NUM DT_COUNT
57 # else
58 /* this seems to be a satisfactory value on Solaris, which doesn't support this AFAICT */
59 #  define DT_NUM 24
60 # endif
61 #endif
62 #ifdef HAVE_LINK_H
63 # include <link.h>
64 #endif
65 #ifdef HAVE_SYS_LINK_H
66 # include <sys/link.h>
67 #endif
68
69 #include "wine/debug.h"
70
71 WINE_DEFAULT_DEBUG_CHANNEL(dbghelp);
72
73 typedef struct tagELF_DBG_INFO
74 {
75     unsigned long       elf_addr;
76 } ELF_DBG_INFO;
77
78 #ifdef __ELF__
79
80 #define ELF_INFO_DEBUG_HEADER   0x0001
81 #define ELF_INFO_MODULE         0x0002
82
83 struct elf_info
84 {
85     unsigned            flags;          /* IN  one (or several) of the ELF_INFO constants */
86     unsigned long       dbg_hdr_addr;   /* OUT address of debug header (if ELF_INFO_DEBUG_HEADER is set) */
87     struct module*      module;         /* OUT loaded module (if ELF_INFO_MODULE is set) */
88 };
89
90 /******************************************************************
91  *              elf_load_symtab
92  *
93  * Walk through the entire symbol table and add any symbols we find there.
94  * This can be used in cases where we have stripped ELF shared libraries,
95  * or it can be used in cases where we have data symbols for which the address
96  * isn't encoded in the stabs.
97  *
98  * This is all really quite easy, since we don't have to worry about line
99  * numbers or local data variables.
100  */
101 static int elf_load_symtab(struct module* module, const char* addr,
102                            unsigned long load_addr, const Elf32_Shdr* symtab,
103                            const Elf32_Shdr* strtab)
104 {
105     int                         i, nsym;
106     const char*                 strp;
107     const char*                 symname;
108     const Elf32_Sym*            symp;
109     struct symt_compiland*      compiland = NULL;
110
111     symp = (Elf32_Sym*)(addr + symtab->sh_offset);
112     nsym = symtab->sh_size / sizeof(*symp);
113     strp = (char*)(addr + strtab->sh_offset);
114
115     for (i = 0; i < nsym; i++, symp++)
116     {
117         /* Ignore certain types of entries which really aren't of that much
118          * interest.
119          */
120         if (ELF32_ST_TYPE(symp->st_info) == STT_SECTION || 
121             symp->st_shndx == SHN_UNDEF)
122         {
123             continue;
124         }
125
126         symname = strp + symp->st_name;
127
128         if (ELF32_ST_TYPE(symp->st_info) == STT_FILE)
129         {
130             compiland = symt_new_compiland(module, symname);
131             continue;
132         }
133         symt_new_public(module, compiland, symname,
134                         load_addr + symp->st_value, symp->st_size,
135                         TRUE /* FIXME */, ELF32_ST_TYPE(symp->st_info) == STT_FUNC);
136     }
137
138     return TRUE;
139 }
140
141 /******************************************************************
142  *              elf_load_debug_info
143  *
144  * Loads the symbolic information from ELF module stored in 'filename'
145  * the module has been loaded at 'load_offset' address, so symbols' address
146  * relocation is performed
147  * returns
148  *      -1 if the file cannot be found/opened
149  *      0 if the file doesn't contain symbolic info (or this info cannot be
150  *      read or parsed)
151  *      1 on success
152  */
153 SYM_TYPE elf_load_debug_info(struct module* module)
154 {
155     SYM_TYPE            sym_type = -1;
156     char*               addr = (char*)0xffffffff;
157     int                 fd = -1;
158     struct stat         statbuf;
159     const Elf32_Ehdr*   ehptr;
160     const Elf32_Shdr*   spnt;
161     const char*         shstrtab;
162     int                 i;
163     int                 stabsect, stabstrsect, debugsect;
164     int                 symsect, dynsect;
165
166     if (module->type != DMT_ELF || !module->elf_dbg_info)
167     {
168         ERR("Bad elf module '%s'\n", module->module.LoadedImageName);
169         return sym_type;
170     }
171
172     TRACE("%s\n", module->module.LoadedImageName);
173     /* check that the file exists, and that the module hasn't been loaded yet */
174     if (stat(module->module.LoadedImageName, &statbuf) == -1) goto leave;
175     if (S_ISDIR(statbuf.st_mode)) goto leave;
176
177     /*
178      * Now open the file, so that we can mmap() it.
179      */
180     if ((fd = open(module->module.LoadedImageName, O_RDONLY)) == -1) goto leave;
181
182     /*
183      * Now mmap() the file.
184      */
185     addr = mmap(0, statbuf.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
186     if (addr == (char*)0xffffffff) goto leave;
187
188     sym_type = SymNone;
189     /*
190      * Next, we need to find a few of the internal ELF headers within
191      * this thing.  We need the main executable header, and the section
192      * table.
193      */
194     ehptr = (Elf32_Ehdr*)addr;
195     spnt = (Elf32_Shdr*)(addr + ehptr->e_shoff);
196     shstrtab = (addr + spnt[ehptr->e_shstrndx].sh_offset);
197
198     symsect = dynsect = stabsect = stabstrsect = debugsect = -1;
199
200     for (i = 0; i < ehptr->e_shnum; i++)
201     {
202         if (strcmp(shstrtab + spnt[i].sh_name, ".stab") == 0)
203             stabsect = i;
204         if (strcmp(shstrtab + spnt[i].sh_name, ".stabstr") == 0)
205             stabstrsect = i;
206         if (strcmp(shstrtab + spnt[i].sh_name, ".debug_info") == 0)
207             debugsect = i;
208         if ((strcmp(shstrtab + spnt[i].sh_name, ".symtab") == 0) &&
209             (spnt[i].sh_type == SHT_SYMTAB))
210             symsect = i;
211         if ((strcmp(shstrtab + spnt[i].sh_name, ".dynsym") == 0) &&
212             (spnt[i].sh_type == SHT_DYNSYM))
213             dynsect = i;
214     }
215     /* start loading dynamic symbol info (so that we can get the correct address) */
216     if (symsect != -1)
217         elf_load_symtab(module, addr, module->elf_dbg_info->elf_addr,
218                         spnt + symsect, spnt + spnt[symsect].sh_link);
219     else if (dynsect != -1)
220         elf_load_symtab(module, addr, module->elf_dbg_info->elf_addr,
221                         spnt + dynsect, spnt + spnt[dynsect].sh_link);
222     sym_type = SymExport;
223
224     if (!(dbghelp_options & SYMOPT_PUBLICS_ONLY))
225     {
226         if (stabsect != -1 && stabstrsect != -1)
227         {
228             /* OK, now just parse all of the stabs. */
229             sym_type = stabs_parse(module, addr, module->elf_dbg_info->elf_addr,
230                                    spnt[stabsect].sh_offset, spnt[stabsect].sh_size,
231                                    spnt[stabstrsect].sh_offset,
232                                    spnt[stabstrsect].sh_size);
233             if (sym_type == -1)
234             {
235                 WARN("Couldn't read correctly read stabs\n");
236                 goto leave;
237             }
238         }
239         else if (debugsect != -1)
240         {
241             /* Dwarf 2 debug information */
242             FIXME("Unsupported Dwarf2 information\n");
243             sym_type = SymNone;
244         }
245     }
246
247 leave:
248     if (addr != (char*)0xffffffff) munmap(addr, statbuf.st_size);
249     if (fd != -1) close(fd);
250
251     return module->module.SymType = sym_type;
252 }
253
254 /******************************************************************
255  *              is_dt_flag_valid
256  * returns true iff the section tag is valid 
257  */
258 static unsigned is_dt_flag_valid(unsigned d_tag)
259 {
260 #ifndef DT_PROCNUM
261 #define DT_PROCNUM 0
262 #endif
263 #ifndef DT_EXTRANUM
264 #define DT_EXTRANUM 0
265 #endif
266     return (d_tag >= 0 && d_tag < DT_NUM + DT_PROCNUM + DT_EXTRANUM)
267 #if defined(DT_LOOS) && defined(DT_HIOS)
268         || (d_tag >= DT_LOOS && d_tag < DT_HIOS)
269 #endif
270 #if defined(DT_LOPROC) && defined(DT_HIPROC)
271         || (d_tag >= DT_LOPROC && d_tag < DT_HIPROC)
272 #endif
273         ;
274 }
275
276 /******************************************************************
277  *              elf_load_file
278  *
279  * Loads the information for ELF module stored in 'filename'
280  * the module has been loaded at 'load_offset' address
281  * returns
282  *      -1 if the file cannot be found/opened
283  *      0 if the file doesn't contain symbolic info (or this info cannot be
284  *      read or parsed)
285  *      1 on success
286  */
287 static SYM_TYPE elf_load_file(struct process* pcs, const char* filename,
288                               unsigned long load_offset, struct elf_info* elf_info)
289 {
290     static const BYTE   elf_signature[4] = { ELFMAG0, ELFMAG1, ELFMAG2, ELFMAG3 };
291     SYM_TYPE            sym_type = -1;
292     const char*         addr = (char*)0xffffffff;
293     int                 fd = -1;
294     struct stat         statbuf;
295     const Elf32_Ehdr*   ehptr;
296     const Elf32_Shdr*   spnt;
297     const Elf32_Phdr*   ppnt;
298     const char*         shstrtab;
299     int                 i;
300     DWORD               delta, size;
301
302     TRACE("Processing elf file '%s' at %08lx\n", filename, load_offset);
303
304     /* check that the file exists, and that the module hasn't been loaded yet */
305     if (stat(filename, &statbuf) == -1) goto leave;
306
307     /* Now open the file, so that we can mmap() it. */
308     if ((fd = open(filename, O_RDONLY)) == -1) goto leave;
309
310     /* Now mmap() the file. */
311     addr = mmap(0, statbuf.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
312     if (addr == (char*)-1) goto leave;
313
314     sym_type = SymNone;
315
316     /* Next, we need to find a few of the internal ELF headers within
317      * this thing.  We need the main executable header, and the section
318      * table.
319      */
320     ehptr = (Elf32_Ehdr*)addr;
321     if (memcmp(ehptr->e_ident, elf_signature, sizeof(elf_signature))) goto leave;
322
323     spnt = (Elf32_Shdr*)(addr + ehptr->e_shoff);
324     shstrtab = (addr + spnt[ehptr->e_shstrndx].sh_offset);
325
326     /* if non relocatable ELF, then remove fixed address from computation
327      * otherwise, all addresses are zero based
328      */
329     delta = (load_offset == 0) ? ehptr->e_entry : 0;
330
331     /* grab size of module once loaded in memory */
332     ppnt = (Elf32_Phdr*)(addr + ehptr->e_phoff);
333     size = 0;
334     for (i = 0; i < ehptr->e_phnum; i++)
335     {
336         if (ppnt[i].p_type == PT_LOAD)
337         {
338             size += (ppnt[i].p_align <= 1) ? ppnt[i].p_memsz :
339                 (ppnt[i].p_memsz + ppnt[i].p_align - 1) & ~(ppnt[i].p_align - 1);
340         }
341     }
342
343     if (elf_info->flags & ELF_INFO_DEBUG_HEADER)
344     {
345         for (i = 0; i < ehptr->e_shnum; i++)
346         {
347             if (strcmp(shstrtab + spnt[i].sh_name, ".dynamic") == 0 &&
348                 spnt[i].sh_type == SHT_DYNAMIC)
349             {
350                 Elf32_Dyn       dyn;
351                 char*           ptr = (char*)spnt[i].sh_addr;
352                 unsigned long   len;
353
354                 do
355                 {
356                     if (!ReadProcessMemory(pcs->handle, ptr, &dyn, sizeof(dyn), &len) ||
357                         len != sizeof(dyn) || !is_dt_flag_valid(dyn.d_tag))
358                         dyn.d_tag = DT_NULL;
359                     ptr += sizeof(dyn);
360                 } while (dyn.d_tag != DT_DEBUG && dyn.d_tag != DT_NULL);
361                 if (dyn.d_tag == DT_NULL)
362                 {
363                     sym_type = -1;
364                     goto leave;
365                 }
366                 elf_info->dbg_hdr_addr = dyn.d_un.d_ptr;
367             }
368         }
369     }
370
371     if (elf_info->flags & ELF_INFO_MODULE)
372     {
373         elf_info->module = module_new(pcs, filename, DMT_ELF, 
374                                       (load_offset) ? load_offset : ehptr->e_entry, 
375                                       size, 0, 0);
376         if (elf_info->module)
377         {
378             if ((elf_info->module->elf_dbg_info = HeapAlloc(GetProcessHeap(), 0, sizeof(ELF_DBG_INFO))) == NULL) 
379             {
380                 ERR("OOM\n");
381                 exit(0); /* FIXME */
382             }
383             elf_info->module->elf_dbg_info->elf_addr = load_offset;
384             elf_info->module->module.SymType = sym_type = 
385                 (dbghelp_options & SYMOPT_DEFERRED_LOADS) ? SymDeferred : 
386                 elf_load_debug_info(elf_info->module);
387             elf_info->module->elf_mark = 1;
388         }
389         else sym_type = -1;
390     }
391
392 leave:
393     if (addr != (char*)0xffffffff) munmap((void*)addr, statbuf.st_size);
394     if (fd != -1) close(fd);
395
396     return sym_type;
397 }
398
399 /******************************************************************
400  *              elf_load_file_from_path
401  * tries to load an ELF file from a set of paths (separated by ':')
402  */
403 static SYM_TYPE elf_load_file_from_path(HANDLE hProcess,
404                                         const char* filename,
405                                         unsigned long load_offset,
406                                         const char* path,
407                                         struct elf_info* elf_info)
408 {
409     SYM_TYPE            sym_type = -1;
410     char                *s, *t, *fn;
411     char*               paths = NULL;
412
413     if (!path) return sym_type;
414
415     paths = strcpy(HeapAlloc(GetProcessHeap(), 0, strlen(path) + 1), path);
416     for (s = paths; s && *s; s = (t) ? (t+1) : NULL) 
417     {
418         t = strchr(s, ':');
419         if (t) *t = '\0';
420         fn = HeapAlloc(GetProcessHeap(), 0, strlen(filename) + 1 + strlen(s) + 1);
421         if (!fn) break;
422         strcpy(fn, s);
423         strcat(fn, "/");
424         strcat(fn, filename);
425         sym_type = elf_load_file(hProcess, fn, load_offset, elf_info);
426         HeapFree(GetProcessHeap(), 0, fn);
427         if (sym_type != -1) break;
428         s = (t) ? (t+1) : NULL;
429     }
430     
431     HeapFree(GetProcessHeap(), 0, paths);
432     return sym_type;
433 }
434
435 /******************************************************************
436  *              elf_search_and_load_file
437  *
438  * lookup a file in standard ELF locations, and if found, load it
439  */
440 static SYM_TYPE elf_search_and_load_file(struct process* pcs, const char* filename,
441                                          unsigned long load_offset, struct elf_info* elf_info)
442 {
443     SYM_TYPE            sym_type = -1;
444     struct module*      module;
445
446     if (filename == NULL || *filename == '\0') return sym_type;
447     if ((module = module_find_by_name(pcs, filename, DMT_ELF)))
448     {
449         elf_info->module = module;
450         module->elf_mark = 1;
451         return module->module.SymType;
452     }
453
454     if (strstr(filename, "libstdc++")) return -1; /* We know we can't do it */
455     sym_type = elf_load_file(pcs, filename, load_offset, elf_info);
456     /* if relative pathname, try some absolute base dirs */
457     if (sym_type == -1 && !strchr(filename, '/'))
458     {
459         sym_type = elf_load_file_from_path(pcs, filename, load_offset, 
460                                            getenv("PATH"), elf_info);
461         if (sym_type == -1)
462             sym_type = elf_load_file_from_path(pcs, filename, load_offset,
463                                                getenv("LD_LIBRARY_PATH"), elf_info);
464         if (sym_type == -1)
465             sym_type = elf_load_file_from_path(pcs, filename, load_offset,
466                                                getenv("WINEDLLPATH"), elf_info);
467     }
468     
469     return sym_type;
470 }
471
472 /******************************************************************
473  *              elf_synchronize_module_list
474  *
475  * this functions rescans the debuggee module's list and synchronizes it with
476  * the one from 'pcs', ie:
477  * - if a module is in debuggee and not in pcs, it's loaded into pcs
478  * - if a module is in pcs and not in debuggee, it's unloaded from pcs
479  */
480 BOOL    elf_synchronize_module_list(struct process* pcs)
481 {
482     struct r_debug      dbg_hdr;
483     void*               lm_addr;
484     struct link_map     lm;
485     char                bufstr[256];
486     struct elf_info     elf_info;
487     struct module*      module;
488
489     if (!pcs->dbg_hdr_addr) return FALSE;
490     if (!read_mem(pcs->handle, pcs->dbg_hdr_addr, &dbg_hdr, sizeof(dbg_hdr)) ||
491         dbg_hdr.r_state != RT_CONSISTENT)
492         return FALSE;
493
494     for (module = pcs->lmodules; module; module = module->next)
495     {
496         if (module->type == DMT_ELF) module->elf_mark = 0;
497     }
498
499     elf_info.flags = ELF_INFO_MODULE;
500     /* Now walk the linked list.  In all known ELF implementations,
501      * the dynamic loader maintains this linked list for us.  In some
502      * cases the first entry doesn't appear with a name, in other cases it
503      * does.
504      */
505     for (lm_addr = (void*)dbg_hdr.r_map; lm_addr; lm_addr = (void*)lm.l_next)
506     {
507         if (!read_mem(pcs->handle, (ULONG)lm_addr, &lm, sizeof(lm)))
508             return FALSE;
509
510         if (lm.l_prev != NULL && /* skip first entry, normally debuggee itself */
511             lm.l_name != NULL &&
512             read_mem(pcs->handle, (ULONG)lm.l_name, bufstr, sizeof(bufstr))) 
513         {
514             bufstr[sizeof(bufstr) - 1] = '\0';
515             elf_search_and_load_file(pcs, bufstr, (unsigned long)lm.l_addr,
516                                      &elf_info);
517         }
518     }
519
520     for (module = pcs->lmodules; module; module = module->next)
521     {
522         if (module->type == DMT_ELF && !module->elf_mark)
523         {
524             module_remove(pcs, module);
525             /* restart all over */
526             module = pcs->lmodules;
527         }
528     }
529     return TRUE;
530 }
531
532 /******************************************************************
533  *              elf_read_wine_loader_dbg_info
534  *
535  * Try to find a decent wine executable which could have loader the debuggee
536  */
537 unsigned long        elf_read_wine_loader_dbg_info(struct process* pcs)
538 {
539     const char*         ptr;
540     SYM_TYPE            sym_type;
541     struct elf_info     elf_info;
542
543     elf_info.flags = ELF_INFO_DEBUG_HEADER;
544     /* All binaries are loaded with WINELOADER (if run from tree) or by the
545      * main executable (either wine-kthread or wine-pthread)
546      * Note: the heuristic use to know whether we need to load wine-pthread or
547      * wine-kthread is not 100% safe
548      */
549     if ((ptr = getenv("WINELOADER")))
550         sym_type = elf_search_and_load_file(pcs, ptr, 0, &elf_info);
551     else 
552     {
553         if ((sym_type = elf_search_and_load_file(pcs, "wine-kthread", 0, &elf_info)) == -1)
554             sym_type = elf_search_and_load_file(pcs, "wine-pthread", 0, &elf_info);
555     }
556     return (sym_type < 0) ? 0 : elf_info.dbg_hdr_addr;
557 }
558
559 /******************************************************************
560  *              elf_load_module
561  *
562  * loads an ELF module and stores it in process' module list
563  * if 'sync' is TRUE, let's find module real name and load address from
564  * the real loaded modules list in pcs address space
565  */
566 struct module*  elf_load_module(struct process* pcs, const char* name)
567 {
568     struct elf_info     elf_info;
569     SYM_TYPE            sym_type = -1;
570     const char*         p;
571     const char*         xname;
572     struct r_debug      dbg_hdr;
573     void*               lm_addr;
574     struct link_map     lm;
575     char                bufstr[256];
576
577     TRACE("(%p %s)\n", pcs, name);
578
579     elf_info.flags = ELF_INFO_MODULE;
580
581     /* do only the lookup from the filename, not the path (as we lookup module name
582      * in the process' loaded module list)
583      */
584     xname = strrchr(name, '/');
585     if (!xname++) xname = name;
586
587     if (!read_mem(pcs->handle, pcs->dbg_hdr_addr, &dbg_hdr, sizeof(dbg_hdr)) ||
588         dbg_hdr.r_state != RT_CONSISTENT)
589         return NULL;
590
591     for (lm_addr = (void*)dbg_hdr.r_map; lm_addr; lm_addr = (void*)lm.l_next)
592     {
593         if (!read_mem(pcs->handle, (ULONG)lm_addr, &lm, sizeof(lm)))
594             return NULL;
595
596         if (lm.l_prev != NULL && /* skip first entry, normally debuggee itself */
597             lm.l_name != NULL &&
598             read_mem(pcs->handle, (ULONG)lm.l_name, bufstr, sizeof(bufstr))) 
599         {
600             bufstr[sizeof(bufstr) - 1] = '\0';
601             /* memcmp is needed for matches when bufstr contains also version information
602              * name: libc.so, bufstr: libc.so.6.0
603              */
604             p = strrchr(bufstr, '/');
605             if (!p++) p = bufstr;
606             if (!memcmp(p, xname, strlen(xname)))
607             {
608                 sym_type = elf_search_and_load_file(pcs, bufstr,
609                                          (unsigned long)lm.l_addr, &elf_info);
610                 break;
611             }
612         }
613     }
614     if (!lm_addr || sym_type == -1) return NULL;
615     assert(elf_info.module);
616     return elf_info.module;
617 }
618
619 #else   /* !__ELF__ */
620
621 BOOL    elf_synchronize_module_list(struct process* pcs)
622 {
623     return FALSE;
624 }
625
626 unsigned long elf_read_wine_loader_dbg_info(struct process* pcs)
627 {
628     return -1;
629 }
630
631 struct module*  elf_load_module(struct process* pcs, const char* name)
632 {
633     return NULL;
634 }
635
636 SYM_TYPE elf_load_debug_info(struct module* module)
637 {
638     return -1;
639 }
640 #endif  /* __ELF__ */