1 /* $OpenBSD: t_backtrace.c,v 1.1 2021/06/10 23:40:46 jca 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 33 #include <atf-c.h> 34 #include <string.h> 35 #include <stdbool.h> 36 #include <stdio.h> 37 #include <stdlib.h> 38 #include <execinfo.h> 39 #include <unistd.h> 40 41 #ifndef __arraycount 42 #define __arraycount(a) (sizeof(a) / sizeof(a[0])) 43 #endif 44 45 void myfunc3(size_t ncalls); 46 void myfunc2(size_t ncalls); 47 void myfunc1(size_t origcalls, volatile size_t ncalls); 48 void myfunc(size_t ncalls); 49 50 static volatile int prevent_inline; 51 52 void 53 myfunc3(size_t ncalls) 54 { 55 static const struct { 56 const char *name; 57 bool is_optional; 58 } frames[] = { 59 { "myfunc", false }, 60 { "atf_body_backtrace_fmt_basic", false }, 61 { "atf_test", true }, 62 { "main", true }, 63 { "_start", true }, 64 }; 65 size_t j, nptrs, min_frames, max_frames; 66 void *buffer[ncalls + 10]; 67 char **strings; 68 69 min_frames = 0; 70 max_frames = 0; 71 for (j = 0; j < __arraycount(frames); ++j) { 72 if (!frames[j].is_optional) 73 ++min_frames; 74 ++max_frames; 75 } 76 nptrs = backtrace(buffer, __arraycount(buffer)); 77 ATF_REQUIRE(nptrs != (size_t)-1); 78 strings = backtrace_symbols_fmt(buffer, nptrs, "%n"); 79 80 ATF_CHECK(strings != NULL); 81 82 printf("got nptrs=%zu ncalls=%zu (min_frames: %zu, max_frames: %zu)\n", 83 nptrs, ncalls, min_frames, max_frames); 84 printf("backtrace is:\n"); 85 for (j = 0; j < nptrs; j++) { 86 printf("#%zu: %s\n", j, strings[j]); 87 } 88 89 ATF_REQUIRE(nptrs >= ncalls + 2 + min_frames); 90 ATF_REQUIRE(nptrs <= ncalls + 2 + max_frames); 91 ATF_CHECK_STREQ(strings[0], "myfunc3"); 92 ATF_CHECK_STREQ(strings[1], "myfunc2"); 93 94 for (j = 2; j < ncalls + 2; j++) 95 ATF_CHECK_STREQ(strings[j], "myfunc1"); 96 97 for (size_t i = 0; j < nptrs; i++, j++) { 98 if (frames[i].is_optional && 99 strcmp(strings[j], frames[i].name)) { 100 --i; 101 continue; 102 } 103 ATF_CHECK_STREQ(strings[j], frames[i].name); 104 } 105 106 free(strings); 107 108 if (prevent_inline) 109 vfork(); 110 } 111 112 void 113 myfunc2(size_t ncalls) 114 { 115 myfunc3(ncalls); 116 117 if (prevent_inline) 118 vfork(); 119 } 120 121 void 122 myfunc1(size_t origcalls, volatile size_t ncalls) 123 { 124 if (ncalls > 1) 125 myfunc1(origcalls, ncalls - 1); 126 else 127 myfunc2(origcalls); 128 129 if (prevent_inline) 130 vfork(); 131 } 132 133 void 134 myfunc(size_t ncalls) 135 { 136 myfunc1(ncalls, ncalls); 137 138 if (prevent_inline) 139 vfork(); 140 } 141 142 ATF_TC(backtrace_fmt_basic); 143 ATF_TC_HEAD(backtrace_fmt_basic, tc) 144 { 145 atf_tc_set_md_var(tc, "descr", "Test backtrace_fmt(3)"); 146 atf_tc_set_md_var(tc, "require.files", "/proc/self"); 147 } 148 149 ATF_TC_BODY(backtrace_fmt_basic, tc) 150 { 151 myfunc(12); 152 153 if (prevent_inline) 154 vfork(); 155 } 156 157 ATF_TP_ADD_TCS(tp) 158 { 159 160 ATF_TP_ADD_TC(tp, backtrace_fmt_basic); 161 162 return atf_no_error(); 163 } 164