1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
/*-
* Copyright (c) 2014 Mark Johnston <markj@FreeBSD.org>
* 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 <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/types.h>
#include <sys/wait.h>
#include <libgen.h>
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <atf-c.h>
#include <libelf.h>
#include <libproc.h>
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_obj2map);
ATF_TC_HEAD(map_alias_obj2map, 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_obj2map() handles "
"this properly.");
}
ATF_TC_BODY(map_alias_obj2map, 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_obj2map(phdl, target_prog_file);
ATF_REQUIRE_MSG(map1 != NULL, "failed to look up map for '%s'",
target_prog_file);
map2 = proc_obj2map(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_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_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;
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);
ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main' via %s",
target_prog_file);
error = proc_name2sym(phdl, aout_object, "main", &sym2);
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_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);
ATF_REQUIRE_EQ_MSG(error, 0, "failed to look up 'main'");
error = proc_name2sym(phdl, ldelf_object, "r_debug_state",
&r_debug_state_sym);
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(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_TP_ADD_TCS(tp)
{
ATF_TP_ADD_TC(tp, map_alias_obj2map);
ATF_TP_ADD_TC(tp, map_alias_name2map);
ATF_TP_ADD_TC(tp, map_alias_name2sym);
ATF_TP_ADD_TC(tp, symbol_lookup);
ATF_TP_ADD_TC(tp, signal_forward);
return (atf_no_error());
}
|