Index: head/lib/libproc/proc_sym.c =================================================================== --- head/lib/libproc/proc_sym.c (revision 326063) +++ head/lib/libproc/proc_sym.c (revision 326064) @@ -1,664 +1,715 @@ /*- - * Copyright (c) 2016 Mark Johnston + * Copyright (c) 2016-2017 Mark Johnston * Copyright (c) 2010 The FreeBSD Foundation * Copyright (c) 2008 John Birrell (jb@freebsd.org) * All rights reserved. * * Portions of this software were developed by Rui Paulo under sponsorship * from the FreeBSD Foundation. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #include __FBSDID("$FreeBSD$"); #include #ifndef NO_CTF #include #include #endif #include #include #include #include #include #include #include #include #include #ifndef NO_CTF #include #endif #include #include "crc32.h" #include "_libproc.h" #define PATH_DEBUG_DIR "/usr/lib/debug" #ifdef NO_CTF typedef struct ctf_file ctf_file_t; #endif #ifndef NO_CXA_DEMANGLE extern char *__cxa_demangle(const char *, char *, size_t *, int *); #endif /* NO_CXA_DEMANGLE */ static int crc32_file(int fd, uint32_t *crc) { uint8_t buf[PAGE_SIZE], *p; size_t n; *crc = ~0; while ((n = read(fd, buf, sizeof(buf))) > 0) { p = &buf[0]; while (n-- > 0) *crc = crc32_tab[(*crc ^ *p++) & 0xff] ^ (*crc >> 8); } *crc = ~*crc; return (n); } static void demangle(const char *symbol, char *buf, size_t len) { #ifndef NO_CXA_DEMANGLE char *dembuf; if (symbol[0] == '_' && symbol[1] == 'Z' && symbol[2]) { dembuf = __cxa_demangle(symbol, NULL, NULL, NULL); if (!dembuf) goto fail; strlcpy(buf, dembuf, len); free(dembuf); return; } fail: #endif /* NO_CXA_DEMANGLE */ strlcpy(buf, symbol, len); } +struct symsort_thunk { + Elf *e; + struct symtab *symtab; +}; + static int -symvalcomp(void *thunk, const void *a1, const void *a2) +symvalcmp(void *_thunk, const void *a1, const void *a2) { - struct symtab *symtab; GElf_Sym sym1, sym2; + struct symsort_thunk *thunk; + const char *s1, *s2; u_int i1, i2; - int ret; + int bind1, bind2; i1 = *(const u_int *)a1; i2 = *(const u_int *)a2; - symtab = thunk; + thunk = _thunk; - (void)gelf_getsym(symtab->data, i1, &sym1); - (void)gelf_getsym(symtab->data, i2, &sym2); - if (sym1.st_value < sym2.st_value) - ret = -1; - else if (sym1.st_value == sym2.st_value) - ret = 0; - else - ret = 1; - return (ret); + (void)gelf_getsym(thunk->symtab->data, i1, &sym1); + (void)gelf_getsym(thunk->symtab->data, i2, &sym2); + + if (sym1.st_value != sym2.st_value) + return (sym1.st_value < sym2.st_value ? -1 : 1); + + /* Prefer non-local symbols. */ + bind1 = GELF_ST_BIND(sym1.st_info); + bind2 = GELF_ST_BIND(sym2.st_info); + if (bind1 != bind2) { + if (bind1 == STB_LOCAL && bind2 != STB_LOCAL) + return (-1); + if (bind1 != STB_LOCAL && bind2 == STB_LOCAL) + return (1); + } + + s1 = elf_strptr(thunk->e, thunk->symtab->stridx, sym1.st_name); + s2 = elf_strptr(thunk->e, thunk->symtab->stridx, sym2.st_name); + if (s1 != NULL && s2 != NULL) { + /* Prefer symbols without a leading '$'. */ + if (*s1 == '$') + return (-1); + if (*s2 == '$') + return (1); + + /* Prefer symbols with fewer leading underscores. */ + for (; *s1 == '_' && *s2 == '_'; s1++, s2++) + ; + if (*s1 == '_') + return (-1); + if (*s2 == '_') + return (1); + } + + return (0); } static int load_symtab(Elf *e, struct symtab *symtab, u_long sh_type) { GElf_Ehdr ehdr; GElf_Shdr shdr; + struct symsort_thunk thunk; Elf_Scn *scn; u_int nsyms; if (gelf_getehdr(e, &ehdr) == NULL) return (-1); scn = NULL; while ((scn = elf_nextscn(e, scn)) != NULL) { (void)gelf_getshdr(scn, &shdr); if (shdr.sh_type == sh_type) break; } if (scn == NULL) return (-1); nsyms = shdr.sh_size / shdr.sh_entsize; if (nsyms > (1 << 20)) return (-1); if ((symtab->data = elf_getdata(scn, NULL)) == NULL) return (-1); symtab->index = calloc(nsyms, sizeof(u_int)); if (symtab->index == NULL) return (-1); for (u_int i = 0; i < nsyms; i++) symtab->index[i] = i; - qsort_r(symtab->index, nsyms, sizeof(u_int), symtab, symvalcomp); symtab->nsyms = nsyms; symtab->stridx = shdr.sh_link; + + thunk.e = e; + thunk.symtab = symtab; + qsort_r(symtab->index, nsyms, sizeof(u_int), &thunk, symvalcmp); + return (0); } static void load_symtabs(struct file_info *file) { file->symtab.nsyms = file->dynsymtab.nsyms = 0; (void)load_symtab(file->elf, &file->symtab, SHT_SYMTAB); (void)load_symtab(file->elf, &file->dynsymtab, SHT_DYNSYM); } static int open_debug_file(char *path, const char *debugfile, uint32_t crc) { size_t n; uint32_t compcrc; int fd; fd = -1; if ((n = strlcat(path, "/", PATH_MAX)) >= PATH_MAX) return (fd); if (strlcat(path, debugfile, PATH_MAX) >= PATH_MAX) goto out; if ((fd = open(path, O_RDONLY | O_CLOEXEC)) < 0) goto out; if (crc32_file(fd, &compcrc) != 0 || crc != compcrc) { DPRINTFX("ERROR: CRC32 mismatch for %s", path); (void)close(fd); fd = -1; } out: path[n] = '\0'; return (fd); } /* * Obtain an ELF descriptor for the specified mapped object. If a GNU debuglink * section is present, a descriptor for the corresponding debug file is * returned. */ static int open_object(struct map_info *mapping) { char path[PATH_MAX]; GElf_Shdr shdr; Elf *e, *e2; Elf_Data *data; Elf_Scn *scn; struct file_info *file; prmap_t *map; const char *debugfile, *scnname; size_t ndx; uint32_t crc; int fd, fd2; if (mapping->map.pr_mapname[0] == '\0') return (-1); /* anonymous object */ if (mapping->file->elf != NULL) return (0); /* already loaded */ file = mapping->file; map = &mapping->map; if ((fd = open(map->pr_mapname, O_RDONLY | O_CLOEXEC)) < 0) { DPRINTF("ERROR: open %s failed", map->pr_mapname); return (-1); } if ((e = elf_begin(fd, ELF_C_READ, NULL)) == NULL) { DPRINTFX("ERROR: elf_begin() failed: %s", elf_errmsg(-1)); goto err; } if (gelf_getehdr(e, &file->ehdr) != &file->ehdr) { DPRINTFX("ERROR: elf_getehdr() failed: %s", elf_errmsg(-1)); goto err; } scn = NULL; while ((scn = elf_nextscn(e, scn)) != NULL) { if (gelf_getshdr(scn, &shdr) != &shdr) { DPRINTFX("ERROR: gelf_getshdr failed: %s", elf_errmsg(-1)); goto err; } if (shdr.sh_type != SHT_PROGBITS) continue; if (elf_getshdrstrndx(e, &ndx) != 0) { DPRINTFX("ERROR: elf_getshdrstrndx failed: %s", elf_errmsg(-1)); goto err; } if ((scnname = elf_strptr(e, ndx, shdr.sh_name)) == NULL) continue; if (strcmp(scnname, ".gnu_debuglink") == 0) break; } if (scn == NULL) goto internal; if ((data = elf_getdata(scn, NULL)) == NULL) { DPRINTFX("ERROR: elf_getdata failed: %s", elf_errmsg(-1)); goto err; } /* * The data contains a null-terminated file name followed by a 4-byte * CRC. */ if (data->d_size < sizeof(crc) + 1) { DPRINTFX("ERROR: debuglink section is too small (%zd bytes)", data->d_size); goto internal; } if (strnlen(data->d_buf, data->d_size) >= data->d_size - sizeof(crc)) { DPRINTFX("ERROR: no null-terminator in gnu_debuglink section"); goto internal; } debugfile = data->d_buf; memcpy(&crc, (char *)data->d_buf + data->d_size - sizeof(crc), sizeof(crc)); /* * Search for the debug file using the algorithm described in the gdb * documentation: * - look in the directory containing the object, * - look in the subdirectory ".debug" of the directory containing the * object, * - look in the global debug directories (currently /usr/lib/debug). */ (void)strlcpy(path, map->pr_mapname, sizeof(path)); (void)dirname(path); if ((fd2 = open_debug_file(path, debugfile, crc)) >= 0) goto external; if (strlcat(path, "/.debug", sizeof(path)) < sizeof(path) && (fd2 = open_debug_file(path, debugfile, crc)) >= 0) goto external; (void)snprintf(path, sizeof(path), PATH_DEBUG_DIR); if (strlcat(path, map->pr_mapname, sizeof(path)) < sizeof(path)) { (void)dirname(path); if ((fd2 = open_debug_file(path, debugfile, crc)) >= 0) goto external; } internal: /* We didn't find a debug file, just return the object's descriptor. */ file->elf = e; file->fd = fd; load_symtabs(file); return (0); external: if ((e2 = elf_begin(fd2, ELF_C_READ, NULL)) == NULL) { DPRINTFX("ERROR: elf_begin failed: %s", elf_errmsg(-1)); (void)close(fd2); goto err; } (void)elf_end(e); (void)close(fd); file->elf = e2; file->fd = fd2; load_symtabs(file); return (0); err: if (e != NULL) (void)elf_end(e); (void)close(fd); return (-1); } char * proc_objname(struct proc_handle *p, uintptr_t addr, char *objname, size_t objnamesz) { prmap_t *map; size_t i; if (p->nmappings == 0) if (proc_rdagent(p) == NULL) return (NULL); for (i = 0; i < p->nmappings; i++) { map = &p->mappings[i].map; if (addr >= map->pr_vaddr && addr < map->pr_vaddr + map->pr_size) { strlcpy(objname, map->pr_mapname, objnamesz); return (objname); } } return (NULL); } int proc_iter_objs(struct proc_handle *p, proc_map_f *func, void *cd) { char last[MAXPATHLEN], path[MAXPATHLEN], *base; prmap_t *map; size_t i; int error; if (p->nmappings == 0) if (proc_rdagent(p) == NULL) return (-1); error = 0; memset(last, 0, sizeof(last)); for (i = 0; i < p->nmappings; i++) { map = &p->mappings[i].map; strlcpy(path, map->pr_mapname, sizeof(path)); base = basename(path); /* * We shouldn't call the callback twice with the same object. * To do that we are assuming the fact that if there are * repeated object names (i.e. different mappings for the * same object) they occur next to each other. */ if (strcmp(base, last) == 0) continue; if ((error = (*func)(cd, map, base)) != 0) break; strlcpy(last, path, sizeof(last)); } return (error); } static struct map_info * _proc_addr2map(struct proc_handle *p, uintptr_t addr) { struct map_info *mapping; size_t i; if (p->nmappings == 0) if (proc_rdagent(p) == NULL) return (NULL); for (i = 0; i < p->nmappings; i++) { mapping = &p->mappings[i]; if (addr >= mapping->map.pr_vaddr && addr < mapping->map.pr_vaddr + mapping->map.pr_size) return (mapping); } return (NULL); } prmap_t * proc_addr2map(struct proc_handle *p, uintptr_t addr) { return (&_proc_addr2map(p, addr)->map); } /* * Look up the symbol at addr using a binary search, returning a copy of the * symbol and its name. */ static int -lookup_symbol_by_addr(Elf *elf, struct symtab *symtab, uintptr_t addr, - const char **namep, GElf_Sym *sym) +lookup_symbol_by_addr(Elf *e, struct symtab *symtab, uintptr_t addr, + const char **namep, GElf_Sym *symp) { + GElf_Sym sym; Elf_Data *data; const char *s; - int min, max, mid; + u_int i, min, max, mid; + if (symtab->nsyms == 0) + return (ENOENT); + data = symtab->data; min = 0; max = symtab->nsyms - 1; while (min <= max) { mid = (max + min) / 2; - (void)gelf_getsym(data, symtab->index[mid], sym); - if (addr >= sym->st_value && - addr < sym->st_value + sym->st_size) { - s = elf_strptr(elf, symtab->stridx, sym->st_name); - if (s != NULL && namep != NULL) - *namep = s; - return (0); - } + (void)gelf_getsym(data, symtab->index[mid], &sym); + if (addr >= sym.st_value && addr < sym.st_value + sym.st_size) + break; - if (addr < sym->st_value) + if (addr < sym.st_value) max = mid - 1; else min = mid + 1; } - return (ENOENT); + if (min > max) + return (ENOENT); + + /* + * Advance until we find the matching symbol with largest index. + */ + for (i = mid; i < symtab->nsyms; i++) { + (void)gelf_getsym(data, symtab->index[i], &sym); + if (addr < sym.st_value || addr >= sym.st_value + sym.st_size) + break; + } + (void)gelf_getsym(data, symtab->index[i - 1], symp); + s = elf_strptr(e, symtab->stridx, symp->st_name); + if (s != NULL && namep != NULL) + *namep = s; + return (0); } int proc_addr2sym(struct proc_handle *p, uintptr_t addr, char *name, size_t namesz, GElf_Sym *symcopy) { struct file_info *file; struct map_info *mapping; const char *s; uintptr_t off; int error; if ((mapping = _proc_addr2map(p, addr)) == NULL) { DPRINTFX("ERROR: proc_addr2map failed to resolve 0x%jx", addr); return (-1); } if (open_object(mapping) != 0) { DPRINTFX("ERROR: failed to open object %s", mapping->map.pr_mapname); return (-1); } file = mapping->file; off = file->ehdr.e_type == ET_DYN ? mapping->map.pr_vaddr : 0; if (addr < off) return (ENOENT); addr -= off; error = lookup_symbol_by_addr(file->elf, &file->dynsymtab, addr, &s, symcopy); if (error == ENOENT) error = lookup_symbol_by_addr(file->elf, &file->symtab, addr, &s, symcopy); if (error == 0) { symcopy->st_value += off; demangle(s, name, namesz); } return (error); } static struct map_info * _proc_name2map(struct proc_handle *p, const char *name) { char path[MAXPATHLEN], *base; struct map_info *mapping; size_t i, len; if ((len = strlen(name)) == 0) return (NULL); if (p->nmappings == 0) if (proc_rdagent(p) == NULL) return (NULL); for (i = 0; i < p->nmappings; i++) { mapping = &p->mappings[i]; (void)strlcpy(path, mapping->map.pr_mapname, sizeof(path)); base = basename(path); if (strcmp(base, name) == 0) return (mapping); } /* If we didn't find a match, try matching prefixes of the basename. */ for (i = 0; i < p->nmappings; i++) { strlcpy(path, p->mappings[i].map.pr_mapname, sizeof(path)); base = basename(path); if (strncmp(base, name, len) == 0) return (&p->mappings[i]); } if (strcmp(name, "a.out") == 0) return (_proc_addr2map(p, p->mappings[p->exec_map].map.pr_vaddr)); return (NULL); } prmap_t * proc_name2map(struct proc_handle *p, const char *name) { return (&_proc_name2map(p, name)->map); } /* * Look up the symbol with the given name and return a copy of it. */ static int lookup_symbol_by_name(Elf *elf, struct symtab *symtab, const char *symbol, GElf_Sym *symcopy, prsyminfo_t *si) { GElf_Sym sym; Elf_Data *data; char *s; int i; if (symtab->nsyms == 0) return (ENOENT); data = symtab->data; for (i = 0; gelf_getsym(data, i, &sym) != NULL; i++) { s = elf_strptr(elf, symtab->stridx, sym.st_name); if (s != NULL && strcmp(s, symbol) == 0) { memcpy(symcopy, &sym, sizeof(*symcopy)); if (si != NULL) si->prs_id = i; return (0); } } return (ENOENT); } int proc_name2sym(struct proc_handle *p, const char *object, const char *symbol, GElf_Sym *symcopy, prsyminfo_t *si) { struct file_info *file; struct map_info *mapping; uintptr_t off; int error; if ((mapping = _proc_name2map(p, object)) == NULL) { DPRINTFX("ERROR: proc_name2map failed to resolve %s", object); return (-1); } if (open_object(mapping) != 0) { DPRINTFX("ERROR: failed to open object %s", mapping->map.pr_mapname); return (-1); } file = mapping->file; off = file->ehdr.e_type == ET_DYN ? mapping->map.pr_vaddr : 0; error = lookup_symbol_by_name(file->elf, &file->dynsymtab, symbol, symcopy, si); if (error == ENOENT) error = lookup_symbol_by_name(file->elf, &file->symtab, symbol, symcopy, si); if (error == 0) symcopy->st_value += off; return (error); } ctf_file_t * proc_name2ctf(struct proc_handle *p, const char *name) { #ifndef NO_CTF ctf_file_t *ctf; prmap_t *map; int error; if ((map = proc_name2map(p, name)) == NULL) return (NULL); ctf = ctf_open(map->pr_mapname, &error); return (ctf); #else (void)p; (void)name; return (NULL); #endif } int proc_iter_symbyaddr(struct proc_handle *p, const char *object, int which, int mask, proc_sym_f *func, void *cd) { GElf_Sym sym; struct file_info *file; struct map_info *mapping; struct symtab *symtab; const char *s; int error, i; if ((mapping = _proc_name2map(p, object)) == NULL) { DPRINTFX("ERROR: proc_name2map failed to resolve %s", object); return (-1); } if (open_object(mapping) != 0) { DPRINTFX("ERROR: failed to open object %s", mapping->map.pr_mapname); return (-1); } file = mapping->file; symtab = which == PR_SYMTAB ? &file->symtab : &file->dynsymtab; if (symtab->nsyms == 0) return (-1); error = 0; for (i = 0; gelf_getsym(symtab->data, i, &sym) != NULL; i++) { if (GELF_ST_BIND(sym.st_info) == STB_LOCAL && (mask & BIND_LOCAL) == 0) continue; if (GELF_ST_BIND(sym.st_info) == STB_GLOBAL && (mask & BIND_GLOBAL) == 0) continue; if (GELF_ST_BIND(sym.st_info) == STB_WEAK && (mask & BIND_WEAK) == 0) continue; if (GELF_ST_TYPE(sym.st_info) == STT_NOTYPE && (mask & TYPE_NOTYPE) == 0) continue; if (GELF_ST_TYPE(sym.st_info) == STT_OBJECT && (mask & TYPE_OBJECT) == 0) continue; if (GELF_ST_TYPE(sym.st_info) == STT_FUNC && (mask & TYPE_FUNC) == 0) continue; if (GELF_ST_TYPE(sym.st_info) == STT_SECTION && (mask & TYPE_SECTION) == 0) continue; if (GELF_ST_TYPE(sym.st_info) == STT_FILE && (mask & TYPE_FILE) == 0) continue; s = elf_strptr(file->elf, symtab->stridx, sym.st_name); if (file->ehdr.e_type == ET_DYN) sym.st_value += mapping->map.pr_vaddr; if ((error = (*func)(cd, &sym, s)) != 0) break; } return (error); } Index: head/lib/libproc/tests/proc_test.c =================================================================== --- head/lib/libproc/tests/proc_test.c (revision 326063) +++ head/lib/libproc/tests/proc_test.c (revision 326064) @@ -1,384 +1,474 @@ /*- - * Copyright (c) 2014-2016 Mark Johnston + * Copyright (c) 2014-2017 Mark Johnston * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #include __FBSDID("$FreeBSD$"); #include #include #include #include #include #include #include #include #include #include static const char *aout_object = "a.out"; static const char *ldelf_object = "ld-elf.so.1"; static const char *target_prog_file = "target_prog"; /* * Run the test program. If the sig parameter is set to true, the test program * will deliver SIGUSR1 to itself during execution. */ static struct proc_handle * start_prog(const struct atf_tc *tc, bool sig) { char *argv[3]; struct proc_handle *phdl; int error; asprintf(&argv[0], "%s/%s", atf_tc_get_config_var(tc, "srcdir"), target_prog_file); ATF_REQUIRE(argv[0] != NULL); if (sig) { argv[1] = strdup("-s"); argv[2] = NULL; } else { argv[1] = NULL; } error = proc_create(argv[0], argv, NULL, NULL, &phdl); ATF_REQUIRE_EQ_MSG(error, 0, "failed to run '%s'", target_prog_file); ATF_REQUIRE(phdl != NULL); free(argv[0]); free(argv[1]); return (phdl); } static void set_bkpt(struct proc_handle *phdl, uintptr_t addr, u_long *saved) { int error; error = proc_bkptset(phdl, addr, saved); ATF_REQUIRE_EQ_MSG(error, 0, "failed to set breakpoint at 0x%jx", (uintmax_t)addr); } static void remove_bkpt(struct proc_handle *phdl, uintptr_t addr, u_long val) { int error; error = proc_bkptdel(phdl, addr, val); ATF_REQUIRE_EQ_MSG(error, 0, "failed to delete breakpoint at 0x%jx", (uintmax_t)addr); error = proc_regset(phdl, REG_PC, addr); ATF_REQUIRE_EQ_MSG(error, 0, "failed to reset program counter"); } /* * Wait for the specified process to hit a breakpoint at the specified symbol. */ static void verify_bkpt(struct proc_handle *phdl, GElf_Sym *sym, const char *symname, const char *mapname) { char mapbname[MAXPATHLEN], *name; GElf_Sym tsym; prmap_t *map; size_t namesz; u_long addr; int error, state; state = proc_wstatus(phdl); ATF_REQUIRE_EQ_MSG(state, PS_STOP, "process has state %d", state); /* Get the program counter and decrement it. */ error = proc_regget(phdl, REG_PC, &addr); ATF_REQUIRE_EQ_MSG(error, 0, "failed to obtain PC for '%s'", target_prog_file); proc_bkptregadj(&addr); /* * Make sure the PC matches the expected value obtained from the symbol * definition we looked up earlier. */ ATF_CHECK_EQ_MSG(addr, sym->st_value, "program counter 0x%lx doesn't match expected value 0x%jx", addr, (uintmax_t)sym->st_value); /* * Ensure we can look up the r_debug_state symbol using its starting * address and that the resulting symbol matches the one we found using * a name lookup. */ namesz = strlen(symname) + 1; name = malloc(namesz); ATF_REQUIRE(name != NULL); error = proc_addr2sym(phdl, addr, name, namesz, &tsym); ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up symbol at 0x%lx", addr); ATF_REQUIRE_EQ(memcmp(sym, &tsym, sizeof(*sym)), 0); ATF_REQUIRE_EQ(strcmp(symname, name), 0); free(name); map = proc_addr2map(phdl, addr); ATF_REQUIRE_MSG(map != NULL, "failed to look up map for address 0x%lx", addr); basename_r(map->pr_mapname, mapbname); ATF_REQUIRE_EQ_MSG(strcmp(mapname, mapbname), 0, "expected map name '%s' doesn't match '%s'", mapname, mapbname); } ATF_TC(map_alias_name2map); ATF_TC_HEAD(map_alias_name2map, tc) { atf_tc_set_md_var(tc, "descr", "Callers are supposed to be able to use \"a.out\" as an alias for " "the program executable. Make sure that proc_name2map() handles " "this properly."); } ATF_TC_BODY(map_alias_name2map, tc) { struct proc_handle *phdl; prmap_t *map1, *map2; phdl = start_prog(tc, false); /* Initialize the rtld_db handle. */ (void)proc_rdagent(phdl); /* Ensure that "target_prog" and "a.out" return the same map. */ map1 = proc_name2map(phdl, target_prog_file); ATF_REQUIRE_MSG(map1 != NULL, "failed to look up map for '%s'", target_prog_file); map2 = proc_name2map(phdl, aout_object); ATF_REQUIRE_MSG(map2 != NULL, "failed to look up map for '%s'", aout_object); ATF_CHECK_EQ(strcmp(map1->pr_mapname, map2->pr_mapname), 0); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); proc_free(phdl); } ATF_TC(map_prefix_name2map); ATF_TC_HEAD(map_prefix_name2map, tc) { atf_tc_set_md_var(tc, "descr", "Verify that proc_name2map() returns prefix matches of the " "basename of loaded objects if no full matches are found."); } ATF_TC_BODY(map_prefix_name2map, tc) { struct proc_handle *phdl; prmap_t *map1, *map2; phdl = start_prog(tc, false); /* Initialize the rtld_db handle. */ (void)proc_rdagent(phdl); /* Make sure that "ld-elf" and "ld-elf.so" return the same map. */ map1 = proc_name2map(phdl, "ld-elf"); ATF_REQUIRE_MSG(map1 != NULL, "failed to look up map for 'ld-elf'"); map2 = proc_name2map(phdl, "ld-elf.so"); ATF_REQUIRE_MSG(map2 != NULL, "failed to look up map for 'ld-elf.so'"); ATF_CHECK_EQ(strcmp(map1->pr_mapname, map2->pr_mapname), 0); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); proc_free(phdl); } ATF_TC(map_alias_name2sym); ATF_TC_HEAD(map_alias_name2sym, tc) { atf_tc_set_md_var(tc, "descr", "Callers are supposed to be able to use \"a.out\" as an alias for " "the program executable. Make sure that proc_name2sym() handles " "this properly."); } ATF_TC_BODY(map_alias_name2sym, tc) { GElf_Sym sym1, sym2; prsyminfo_t si1, si2; struct proc_handle *phdl; int error; phdl = start_prog(tc, false); /* Initialize the rtld_db handle. */ (void)proc_rdagent(phdl); /* * Make sure that "target_prog:main" and "a.out:main" return the same * symbol. */ error = proc_name2sym(phdl, target_prog_file, "main", &sym1, &si1); ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main' via %s", target_prog_file); error = proc_name2sym(phdl, aout_object, "main", &sym2, &si2); ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main' via %s", aout_object); ATF_CHECK_EQ(memcmp(&sym1, &sym2, sizeof(sym1)), 0); ATF_CHECK_EQ(si1.prs_id, si2.prs_id); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); proc_free(phdl); } ATF_TC(symbol_lookup); ATF_TC_HEAD(symbol_lookup, tc) { atf_tc_set_md_var(tc, "descr", "Look up a couple of well-known symbols in the test program, place " "breakpoints on them, and verify that we hit the breakpoints. Also " "make sure that we can use the breakpoint address to look up the " "corresponding symbol."); } ATF_TC_BODY(symbol_lookup, tc) { GElf_Sym main_sym, r_debug_state_sym; struct proc_handle *phdl; u_long saved; int error; phdl = start_prog(tc, false); error = proc_name2sym(phdl, target_prog_file, "main", &main_sym, NULL); ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main'"); error = proc_name2sym(phdl, ldelf_object, "r_debug_state", &r_debug_state_sym, NULL); ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'r_debug_state'"); set_bkpt(phdl, r_debug_state_sym.st_value, &saved); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); verify_bkpt(phdl, &r_debug_state_sym, "r_debug_state", ldelf_object); remove_bkpt(phdl, r_debug_state_sym.st_value, saved); set_bkpt(phdl, main_sym.st_value, &saved); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); verify_bkpt(phdl, &main_sym, "main", target_prog_file); remove_bkpt(phdl, main_sym.st_value, saved); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); proc_free(phdl); } ATF_TC(symbol_lookup_fail); ATF_TC_HEAD(symbol_lookup_fail, tc) { atf_tc_set_md_var(tc, "descr", "Verify that proc_addr2sym() returns an error when given an offset " "that it cannot resolve."); } ATF_TC_BODY(symbol_lookup_fail, tc) { char symname[32]; GElf_Sym sym; struct proc_handle *phdl; prmap_t *map; int error; phdl = start_prog(tc, false); /* Initialize the rtld_db handle. */ (void)proc_rdagent(phdl); map = proc_name2map(phdl, target_prog_file); ATF_REQUIRE_MSG(map != NULL, "failed to look up map for '%s'", target_prog_file); /* * We shouldn't be able to find symbols at the beginning of a mapped * file. */ error = proc_addr2sym(phdl, map->pr_vaddr, symname, sizeof(symname), &sym); ATF_REQUIRE_MSG(error != 0, "unexpectedly found a symbol"); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); proc_free(phdl); } ATF_TC(signal_forward); ATF_TC_HEAD(signal_forward, tc) { atf_tc_set_md_var(tc, "descr", "Run the test program in a mode which causes it to send a signal " "to itself. Make sure that we intercept the signal and that " "proc_continue() forwards it to the process."); } ATF_TC_BODY(signal_forward, tc) { struct proc_handle *phdl; int state, status; phdl = start_prog(tc, true); ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); /* The process should have been interrupted by a signal. */ state = proc_wstatus(phdl); ATF_REQUIRE_EQ_MSG(state, PS_STOP, "process has unexpected state %d", state); /* Continue execution and allow the signal to be delivered. */ ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution"); /* * Make sure the process exited with status 0. If it didn't receive the * SIGUSR1 that it sent to itself, it'll exit with a non-zero exit * status, causing the test to fail. */ state = proc_wstatus(phdl); ATF_REQUIRE_EQ_MSG(state, PS_UNDEAD, "process has unexpected state %d", state); status = proc_getwstat(phdl); ATF_REQUIRE(status >= 0); ATF_REQUIRE(WIFEXITED(status)); ATF_REQUIRE_EQ(WEXITSTATUS(status), 0); proc_free(phdl); } +ATF_TC(symbol_sort_local); +ATF_TC_HEAD(symbol_sort_local, tc) +{ + atf_tc_set_md_var(tc, "descr", + "Ensure that proc_addr2sym() returns the non-local alias when " + "the address resolves to multiple symbols."); +} +ATF_TC_BODY(symbol_sort_local, tc) +{ + char symname[32]; + GElf_Sym bar_sym; + struct proc_handle *phdl; + int error; + + phdl = start_prog(tc, true); + + error = proc_name2sym(phdl, target_prog_file, "bar", &bar_sym, NULL); + ATF_REQUIRE_MSG(error == 0, "failed to look up 'bar' in %s", + target_prog_file); + ATF_REQUIRE(GELF_ST_BIND(bar_sym.st_info) == STB_LOCAL); + + error = proc_addr2sym(phdl, bar_sym.st_value, symname, sizeof(symname), + &bar_sym); + ATF_REQUIRE_MSG(error == 0, "failed to resolve 'bar' by addr"); + + ATF_REQUIRE_MSG(strcmp(symname, "baz") == 0, + "unexpected symbol name '%s'", symname); + ATF_REQUIRE(GELF_ST_BIND(bar_sym.st_info) == STB_GLOBAL); +} + +ATF_TC(symbol_sort_prefix); +ATF_TC_HEAD(symbol_sort_prefix, tc) +{ + atf_tc_set_md_var(tc, "descr", + "Ensure that proc_addr2sym() returns the alias whose name is not " + "prefixed with '$' if one exists."); +} +ATF_TC_BODY(symbol_sort_prefix, tc) +{ + char symname[32]; + GElf_Sym qux_sym; + struct proc_handle *phdl; + int error; + + phdl = start_prog(tc, true); + + error = proc_name2sym(phdl, target_prog_file, "$qux", &qux_sym, NULL); + ATF_REQUIRE_MSG(error == 0, "failed to look up '$qux' in %s", + target_prog_file); + + error = proc_addr2sym(phdl, qux_sym.st_value, symname, sizeof(symname), + &qux_sym); + ATF_REQUIRE_MSG(error == 0, "failed to resolve 'qux' by addr"); + + ATF_REQUIRE_MSG(strcmp(symname, "qux") == 0, + "unexpected symbol name '%s'", symname); +} + +ATF_TC(symbol_sort_underscore); +ATF_TC_HEAD(symbol_sort_underscore, tc) +{ + atf_tc_set_md_var(tc, "descr", + "Ensure that proc_addr2sym() returns the alias with fewest leading " + "underscores in the name when the address resolves to multiple " + "symbols."); +} +ATF_TC_BODY(symbol_sort_underscore, tc) +{ + char symname[32]; + GElf_Sym foo_sym; + struct proc_handle *phdl; + int error; + + phdl = start_prog(tc, true); + + error = proc_name2sym(phdl, target_prog_file, "foo", &foo_sym, NULL); + ATF_REQUIRE_MSG(error == 0, "failed to look up 'foo' in %s", + target_prog_file); + + error = proc_addr2sym(phdl, foo_sym.st_value, symname, sizeof(symname), + &foo_sym); + ATF_REQUIRE_MSG(error == 0, "failed to resolve 'foo' by addr"); + + ATF_REQUIRE_MSG(strcmp(symname, "foo") == 0, + "unexpected symbol name '%s'", symname); +} + ATF_TP_ADD_TCS(tp) { ATF_TP_ADD_TC(tp, map_alias_name2map); ATF_TP_ADD_TC(tp, map_prefix_name2map); ATF_TP_ADD_TC(tp, map_alias_name2sym); ATF_TP_ADD_TC(tp, symbol_lookup); ATF_TP_ADD_TC(tp, symbol_lookup_fail); ATF_TP_ADD_TC(tp, signal_forward); + ATF_TP_ADD_TC(tp, symbol_sort_local); + ATF_TP_ADD_TC(tp, symbol_sort_prefix); + ATF_TP_ADD_TC(tp, symbol_sort_underscore); return (atf_no_error()); } Index: head/lib/libproc/tests/target_prog.c =================================================================== --- head/lib/libproc/tests/target_prog.c (revision 326063) +++ head/lib/libproc/tests/target_prog.c (revision 326064) @@ -1,59 +1,82 @@ /*- * Copyright (c) 2014 Mark Johnston * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #include __FBSDID("$FreeBSD$"); #include #include #include #include #include static volatile sig_atomic_t saw; static void usr1(int sig __unused) { saw = 1; } +void foo(void); +void qux(void); + +void +foo(void) +{ +} +__weak_reference(foo, _foo); + +static void +bar(void) +{ +} +__strong_reference(bar, baz); + +void +qux(void) +{ +} +__strong_reference(qux, $qux); + int main(int argc, char **argv) { + + bar(); /* force the symbol to be emitted */ if (argc == 1) return (EXIT_SUCCESS); if (argc == 2 && strcmp(argv[1], "-s") == 0) { if (signal(SIGUSR1, usr1) == SIG_ERR) err(1, "signal"); if (kill(getpid(), SIGUSR1) != 0) err(1, "kill"); return (saw == 1 ? EXIT_SUCCESS : EXIT_FAILURE); } return (EXIT_FAILURE); }