xref: /netbsd-src/tests/lib/libexecinfo/t_backtrace.c (revision dd255ccea4286b0c44fa8fd48a9a19a768afe8e1)
1 /*	$NetBSD: t_backtrace.c,v 1.12 2014/01/11 19:48:22 martin Exp $	*/
2 
3 /*-
4  * Copyright (c) 2012 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Christos Zoulas.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 #include <sys/cdefs.h>
32 __RCSID("$NetBSD: t_backtrace.c,v 1.12 2014/01/11 19:48:22 martin Exp $");
33 
34 #include <atf-c.h>
35 #include <atf-c/config.h>
36 #include <string.h>
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <execinfo.h>
40 #include <unistd.h>
41 
42 #ifndef __arraycount
43 #define __arraycount(a) (sizeof(a) / sizeof(a[0]))
44 #endif
45 
46 void myfunc3(size_t ncalls);
47 void myfunc2(size_t ncalls);
48 void myfunc1(size_t origcalls, volatile size_t ncalls);
49 void myfunc(size_t ncalls);
50 
51 volatile int prevent_inline;
52 
53 void
54 myfunc3(size_t ncalls)
55 {
56 	static const char *top[] = { "myfunc", "atfu_backtrace_fmt_basic_body",
57 	    "atf_tc_run", "atf_tp_run", "atf_tp_main", "main", "___start" };
58 	static bool optional_frame[] = { false, false, false, true, false,
59 	    true, true };
60 	size_t j, nptrs, min_frames, max_frames;
61 	void *buffer[ncalls + 10];
62 	char **strings;
63 	__CTASSERT(__arraycount(top) == __arraycount(optional_frame));
64 
65 	min_frames = 0;
66 	max_frames = 0;
67 	for (j = 0; j < __arraycount(optional_frame); ++j) {
68 		if (!optional_frame[j])
69 			++min_frames;
70 		++max_frames;
71 	}
72 	nptrs = backtrace(buffer, __arraycount(buffer));
73 	strings = backtrace_symbols_fmt(buffer, nptrs, "%n");
74 
75 	ATF_CHECK(strings != NULL);
76 
77 	printf("got nptrs=%zu ncalls=%zu (min_frames: %zu, max_frames: %zu)\n",
78 	    nptrs, ncalls, min_frames, max_frames);
79 	printf("backtrace is:\n");
80 	for (j = 0; j < nptrs; j++) {
81 		printf("#%zu: %s\n", j, strings[j]);
82 	}
83 
84 	ATF_REQUIRE(nptrs >= ncalls + 2 + min_frames);
85 	ATF_REQUIRE(nptrs <= ncalls + 2 + max_frames);
86 	ATF_CHECK_STREQ(strings[0], "myfunc3");
87 	ATF_CHECK_STREQ(strings[1], "myfunc2");
88 
89 	for (j = 2; j < ncalls + 2; j++)
90 		ATF_CHECK_STREQ(strings[j], "myfunc1");
91 
92 	for (size_t i = 0; j < nptrs; i++, j++) {
93 		if (optional_frame[i] && strcmp(strings[j], top[i])) {
94 			--i;
95 			continue;
96 		}
97 		ATF_CHECK_STREQ(strings[j], top[i]);
98 	}
99 
100 	free(strings);
101 
102 	if (prevent_inline)
103 		vfork();
104 }
105 
106 void
107 myfunc2(size_t ncalls)
108 {
109 	myfunc3(ncalls);
110 
111 	if (prevent_inline)
112 		vfork();
113 }
114 
115 void
116 myfunc1(size_t origcalls, volatile size_t ncalls)
117 {
118 	if (ncalls > 1)
119 		myfunc1(origcalls, ncalls - 1);
120 	else
121 		myfunc2(origcalls);
122 
123 	if (prevent_inline)
124 		vfork();
125 }
126 
127 void
128 myfunc(size_t ncalls)
129 {
130 	myfunc1(ncalls, ncalls);
131 
132 	if (prevent_inline)
133 		vfork();
134 }
135 
136 ATF_TC(backtrace_fmt_basic);
137 ATF_TC_HEAD(backtrace_fmt_basic, tc)
138 {
139         atf_tc_set_md_var(tc, "descr", "Test backtrace_fmt(3)");
140 }
141 
142 ATF_TC_BODY(backtrace_fmt_basic, tc)
143 {
144 	myfunc(12);
145 
146 	if (prevent_inline)
147 		vfork();
148 }
149 
150 ATF_TP_ADD_TCS(tp)
151 {
152 
153 	ATF_TP_ADD_TC(tp, backtrace_fmt_basic);
154 
155 	return atf_no_error();
156 }
157