2 * Copyright (c) 2014, 2015 Mark Johnston <markj@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/types.h>
42 static const char *aout_object = "a.out";
43 static const char *ldelf_object = "ld-elf.so.1";
44 static const char *target_prog_file = "target_prog";
47 * Run the test program. If the sig parameter is set to true, the test program
48 * will deliver SIGUSR1 to itself during execution.
50 static struct proc_handle *
51 start_prog(const struct atf_tc *tc, bool sig)
54 struct proc_handle *phdl;
57 asprintf(&argv[0], "%s/%s", atf_tc_get_config_var(tc, "srcdir"),
59 ATF_REQUIRE(argv[0] != NULL);
62 argv[1] = strdup("-s");
68 error = proc_create(argv[0], argv, NULL, NULL, &phdl);
69 ATF_REQUIRE_EQ_MSG(error, 0, "failed to run '%s'", target_prog_file);
70 ATF_REQUIRE(phdl != NULL);
79 set_bkpt(struct proc_handle *phdl, uintptr_t addr, u_long *saved)
83 error = proc_bkptset(phdl, addr, saved);
84 ATF_REQUIRE_EQ_MSG(error, 0, "failed to set breakpoint at 0x%jx",
89 remove_bkpt(struct proc_handle *phdl, uintptr_t addr, u_long val)
93 error = proc_bkptdel(phdl, addr, val);
94 ATF_REQUIRE_EQ_MSG(error, 0,
95 "failed to delete breakpoint at 0x%jx", (uintmax_t)addr);
97 error = proc_regset(phdl, REG_PC, addr);
98 ATF_REQUIRE_EQ_MSG(error, 0, "failed to reset program counter");
102 * Wait for the specified process to hit a breakpoint at the specified symbol.
105 verify_bkpt(struct proc_handle *phdl, GElf_Sym *sym, const char *symname,
108 char mapbname[MAXPATHLEN], *name;
115 state = proc_wstatus(phdl);
116 ATF_REQUIRE_EQ_MSG(state, PS_STOP, "process has state %d", state);
118 /* Get the program counter and decrement it. */
119 error = proc_regget(phdl, REG_PC, &addr);
120 ATF_REQUIRE_EQ_MSG(error, 0, "failed to obtain PC for '%s'",
122 proc_bkptregadj(&addr);
125 * Make sure the PC matches the expected value obtained from the symbol
126 * definition we looked up earlier.
128 ATF_CHECK_EQ_MSG(addr, sym->st_value,
129 "program counter 0x%lx doesn't match expected value 0x%jx",
130 addr, (uintmax_t)sym->st_value);
133 * Ensure we can look up the r_debug_state symbol using its starting
134 * address and that the resulting symbol matches the one we found using
137 namesz = strlen(symname) + 1;
138 name = malloc(namesz);
139 ATF_REQUIRE(name != NULL);
141 error = proc_addr2sym(phdl, addr, name, namesz, &tsym);
142 ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up symbol at 0x%lx", addr);
143 ATF_REQUIRE_EQ(memcmp(sym, &tsym, sizeof(*sym)), 0);
144 ATF_REQUIRE_EQ(strcmp(symname, name), 0);
147 map = proc_addr2map(phdl, addr);
148 ATF_REQUIRE_MSG(map != NULL, "failed to look up map for address 0x%lx",
150 basename_r(map->pr_mapname, mapbname);
151 ATF_REQUIRE_EQ_MSG(strcmp(mapname, mapbname), 0,
152 "expected map name '%s' doesn't match '%s'", mapname, mapbname);
155 ATF_TC(map_alias_obj2map);
156 ATF_TC_HEAD(map_alias_obj2map, tc)
158 atf_tc_set_md_var(tc, "descr",
159 "Callers are supposed to be able to use \"a.out\" as an alias for "
160 "the program executable. Make sure that proc_obj2map() handles "
163 ATF_TC_BODY(map_alias_obj2map, tc)
165 struct proc_handle *phdl;
166 prmap_t *map1, *map2;
168 phdl = start_prog(tc, false);
170 /* Initialize the rtld_db handle. */
171 (void)proc_rdagent(phdl);
173 /* Ensure that "target_prog" and "a.out" return the same map. */
174 map1 = proc_obj2map(phdl, target_prog_file);
175 ATF_REQUIRE_MSG(map1 != NULL, "failed to look up map for '%s'",
177 map2 = proc_obj2map(phdl, aout_object);
178 ATF_REQUIRE_MSG(map2 != NULL, "failed to look up map for '%s'",
180 ATF_CHECK_EQ(strcmp(map1->pr_mapname, map2->pr_mapname), 0);
182 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
187 ATF_TC(map_alias_name2map);
188 ATF_TC_HEAD(map_alias_name2map, tc)
190 atf_tc_set_md_var(tc, "descr",
191 "Callers are supposed to be able to use \"a.out\" as an alias for "
192 "the program executable. Make sure that proc_name2map() handles "
195 ATF_TC_BODY(map_alias_name2map, tc)
197 struct proc_handle *phdl;
198 prmap_t *map1, *map2;
200 phdl = start_prog(tc, false);
202 /* Initialize the rtld_db handle. */
203 (void)proc_rdagent(phdl);
205 /* Ensure that "target_prog" and "a.out" return the same map. */
206 map1 = proc_name2map(phdl, target_prog_file);
207 ATF_REQUIRE_MSG(map1 != NULL, "failed to look up map for '%s'",
209 map2 = proc_name2map(phdl, aout_object);
210 ATF_REQUIRE_MSG(map2 != NULL, "failed to look up map for '%s'",
212 ATF_CHECK_EQ(strcmp(map1->pr_mapname, map2->pr_mapname), 0);
214 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
219 ATF_TC(map_alias_name2sym);
220 ATF_TC_HEAD(map_alias_name2sym, tc)
222 atf_tc_set_md_var(tc, "descr",
223 "Callers are supposed to be able to use \"a.out\" as an alias for "
224 "the program executable. Make sure that proc_name2sym() handles "
227 ATF_TC_BODY(map_alias_name2sym, tc)
230 prsyminfo_t si1, si2;
231 struct proc_handle *phdl;
234 phdl = start_prog(tc, false);
236 /* Initialize the rtld_db handle. */
237 (void)proc_rdagent(phdl);
240 * Make sure that "target_prog:main" and "a.out:main" return the same
243 error = proc_name2sym(phdl, target_prog_file, "main", &sym1, &si1);
244 ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main' via %s",
246 error = proc_name2sym(phdl, aout_object, "main", &sym2, &si2);
247 ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main' via %s",
250 ATF_CHECK_EQ(memcmp(&sym1, &sym2, sizeof(sym1)), 0);
251 ATF_CHECK_EQ(si1.prs_id, si2.prs_id);
253 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
258 ATF_TC(symbol_lookup);
259 ATF_TC_HEAD(symbol_lookup, tc)
261 atf_tc_set_md_var(tc, "descr",
262 "Look up a couple of well-known symbols in the test program, place "
263 "breakpoints on them, and verify that we hit the breakpoints. Also "
264 "make sure that we can use the breakpoint address to look up the "
265 "corresponding symbol.");
267 ATF_TC_BODY(symbol_lookup, tc)
269 GElf_Sym main_sym, r_debug_state_sym;
270 struct proc_handle *phdl;
274 phdl = start_prog(tc, false);
276 error = proc_name2sym(phdl, target_prog_file, "main", &main_sym, NULL);
277 ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main'");
279 error = proc_name2sym(phdl, ldelf_object, "r_debug_state",
280 &r_debug_state_sym, NULL);
281 ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'r_debug_state'");
283 set_bkpt(phdl, r_debug_state_sym.st_value, &saved);
284 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
285 verify_bkpt(phdl, &r_debug_state_sym, "r_debug_state", ldelf_object);
286 remove_bkpt(phdl, r_debug_state_sym.st_value, saved);
288 set_bkpt(phdl, main_sym.st_value, &saved);
289 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
290 verify_bkpt(phdl, &main_sym, "main", target_prog_file);
291 remove_bkpt(phdl, main_sym.st_value, saved);
293 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
298 ATF_TC(symbol_lookup_fail);
299 ATF_TC_HEAD(symbol_lookup_fail, tc)
301 atf_tc_set_md_var(tc, "descr",
302 "Verify that proc_addr2sym() returns an error when given an offset "
303 "that it cannot resolve.");
305 ATF_TC_BODY(symbol_lookup_fail, tc)
309 struct proc_handle *phdl;
313 phdl = start_prog(tc, false);
315 /* Initialize the rtld_db handle. */
316 (void)proc_rdagent(phdl);
318 map = proc_obj2map(phdl, target_prog_file);
319 ATF_REQUIRE_MSG(map != NULL, "failed to look up map for '%s'",
323 * We shouldn't be able to find symbols at the beginning of a mapped
326 error = proc_addr2sym(phdl, map->pr_vaddr, symname, sizeof(symname),
328 ATF_REQUIRE_MSG(error != 0, "unexpectedly found a symbol");
330 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
335 ATF_TC(signal_forward);
336 ATF_TC_HEAD(signal_forward, tc)
338 atf_tc_set_md_var(tc, "descr",
339 "Run the test program in a mode which causes it to send a signal "
340 "to itself. Make sure that we intercept the signal and that "
341 "proc_continue() forwards it to the process.");
343 ATF_TC_BODY(signal_forward, tc)
345 struct proc_handle *phdl;
348 phdl = start_prog(tc, true);
349 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
351 /* The process should have been interrupted by a signal. */
352 state = proc_wstatus(phdl);
353 ATF_REQUIRE_EQ_MSG(state, PS_STOP, "process has unexpected state %d",
356 /* Continue execution and allow the signal to be delivered. */
357 ATF_CHECK_EQ_MSG(proc_continue(phdl), 0, "failed to resume execution");
360 * Make sure the process exited with status 0. If it didn't receive the
361 * SIGUSR1 that it sent to itself, it'll exit with a non-zero exit
362 * status, causing the test to fail.
364 state = proc_wstatus(phdl);
365 ATF_REQUIRE_EQ_MSG(state, PS_UNDEAD, "process has unexpected state %d",
368 status = proc_getwstat(phdl);
369 ATF_REQUIRE(status >= 0);
370 ATF_REQUIRE(WIFEXITED(status));
371 ATF_REQUIRE_EQ(WEXITSTATUS(status), 0);
379 ATF_TP_ADD_TC(tp, map_alias_obj2map);
380 ATF_TP_ADD_TC(tp, map_alias_name2map);
381 ATF_TP_ADD_TC(tp, map_alias_name2sym);
382 ATF_TP_ADD_TC(tp, symbol_lookup);
383 ATF_TP_ADD_TC(tp, symbol_lookup_fail);
384 ATF_TP_ADD_TC(tp, signal_forward);
386 return (atf_no_error());