1 // SPDX-License-Identifier: GPL-2.0 2 #include <linux/compiler.h> 3 #include <elfutils/libdw.h> 4 #include <elfutils/libdwfl.h> 5 #include <inttypes.h> 6 #include <errno.h> 7 #include "debug.h" 8 #include "dso.h" 9 #include "unwind.h" 10 #include "unwind-libdw.h" 11 #include "machine.h" 12 #include "map.h" 13 #include "symbol.h" 14 #include "thread.h" 15 #include <linux/types.h> 16 #include <linux/zalloc.h> 17 #include "event.h" 18 #include "perf_regs.h" 19 #include "callchain.h" 20 #include "util/env.h" 21 22 static char *debuginfo_path; 23 24 static int __find_debuginfo(Dwfl_Module *mod __maybe_unused, void **userdata, 25 const char *modname __maybe_unused, Dwarf_Addr base __maybe_unused, 26 const char *file_name, const char *debuglink_file __maybe_unused, 27 GElf_Word debuglink_crc __maybe_unused, char **debuginfo_file_name) 28 { 29 const struct dso *dso = *userdata; 30 31 assert(dso); 32 if (dso__symsrc_filename(dso) && strcmp(file_name, dso__symsrc_filename(dso))) 33 *debuginfo_file_name = strdup(dso__symsrc_filename(dso)); 34 return -1; 35 } 36 37 static const Dwfl_Callbacks offline_callbacks = { 38 .find_debuginfo = __find_debuginfo, 39 .debuginfo_path = &debuginfo_path, 40 .section_address = dwfl_offline_section_address, 41 // .find_elf is not set as we use dwfl_report_elf() instead. 42 }; 43 44 static int __report_module(struct addr_location *al, u64 ip, 45 struct unwind_info *ui) 46 { 47 Dwfl_Module *mod; 48 struct dso *dso = NULL; 49 Dwarf_Addr base; 50 /* 51 * Some callers will use al->sym, so we can't just use the 52 * cheaper thread__find_map() here. 53 */ 54 thread__find_symbol(ui->thread, PERF_RECORD_MISC_USER, ip, al); 55 56 if (al->map) 57 dso = map__dso(al->map); 58 59 if (!dso) 60 return 0; 61 62 /* 63 * The generated JIT DSO files only map the code segment without 64 * ELF headers. Since JIT codes used to be packed in a memory 65 * segment, calculating the base address using pgoff falls into 66 * a different code in another DSO. So just use the map->start 67 * directly to pick the correct one. 68 */ 69 if (!strncmp(dso__long_name(dso), "/tmp/jitted-", 12)) 70 base = map__start(al->map); 71 else 72 base = map__start(al->map) - map__pgoff(al->map); 73 74 mod = dwfl_addrmodule(ui->dwfl, ip); 75 if (mod) { 76 Dwarf_Addr s; 77 78 dwfl_module_info(mod, NULL, &s, NULL, NULL, NULL, NULL, NULL); 79 if (s != base) 80 mod = NULL; 81 } 82 83 if (!mod) { 84 char filename[PATH_MAX]; 85 86 __symbol__join_symfs(filename, sizeof(filename), dso__long_name(dso)); 87 /* Don't hang up on device files like /dev/dri/renderD128. */ 88 if (is_regular_file(filename)) { 89 mod = dwfl_report_elf(ui->dwfl, dso__short_name(dso), filename, -1, 90 base, false); 91 } 92 } 93 if (!mod) { 94 char filename[PATH_MAX]; 95 96 if (dso__build_id_filename(dso, filename, sizeof(filename), false)) 97 mod = dwfl_report_elf(ui->dwfl, dso__short_name(dso), filename, -1, 98 base, false); 99 } 100 101 if (mod) { 102 void **userdatap; 103 104 dwfl_module_info(mod, &userdatap, NULL, NULL, NULL, NULL, NULL, NULL); 105 *userdatap = dso; 106 } 107 108 return mod && dwfl_addrmodule(ui->dwfl, ip) == mod ? 0 : -1; 109 } 110 111 static int report_module(u64 ip, struct unwind_info *ui) 112 { 113 struct addr_location al; 114 int res; 115 116 addr_location__init(&al); 117 res = __report_module(&al, ip, ui); 118 addr_location__exit(&al); 119 return res; 120 } 121 122 /* 123 * Store all entries within entries array, 124 * we will process it after we finish unwind. 125 */ 126 static int entry(u64 ip, struct unwind_info *ui) 127 128 { 129 struct unwind_entry *e = &ui->entries[ui->idx++]; 130 struct addr_location al; 131 132 addr_location__init(&al); 133 if (__report_module(&al, ip, ui)) { 134 addr_location__exit(&al); 135 return -1; 136 } 137 138 e->ip = ip; 139 e->ms.maps = maps__get(al.maps); 140 e->ms.map = map__get(al.map); 141 e->ms.sym = al.sym; 142 143 pr_debug("unwind: %s:ip = 0x%" PRIx64 " (0x%" PRIx64 ")\n", 144 al.sym ? al.sym->name : "''", 145 ip, 146 al.map ? map__map_ip(al.map, ip) : (u64) 0); 147 addr_location__exit(&al); 148 return 0; 149 } 150 151 static pid_t next_thread(Dwfl *dwfl, void *arg, void **thread_argp) 152 { 153 /* We want only single thread to be processed. */ 154 if (*thread_argp != NULL) 155 return 0; 156 157 *thread_argp = arg; 158 return dwfl_pid(dwfl); 159 } 160 161 static int access_dso_mem(struct unwind_info *ui, Dwarf_Addr addr, 162 Dwarf_Word *data) 163 { 164 struct addr_location al; 165 ssize_t size; 166 struct dso *dso; 167 168 addr_location__init(&al); 169 if (!thread__find_map(ui->thread, PERF_RECORD_MISC_USER, addr, &al)) { 170 pr_debug("unwind: no map for %lx\n", (unsigned long)addr); 171 goto out_fail; 172 } 173 dso = map__dso(al.map); 174 if (!dso) 175 goto out_fail; 176 177 size = dso__data_read_addr(dso, al.map, ui->machine, addr, (u8 *) data, sizeof(*data)); 178 179 addr_location__exit(&al); 180 return !(size == sizeof(*data)); 181 out_fail: 182 addr_location__exit(&al); 183 return -1; 184 } 185 186 static bool memory_read(Dwfl *dwfl __maybe_unused, Dwarf_Addr addr, Dwarf_Word *result, 187 void *arg) 188 { 189 struct unwind_info *ui = arg; 190 uint16_t e_machine = thread__e_machine(ui->thread, ui->machine); 191 struct stack_dump *stack = &ui->sample->user_stack; 192 u64 start, end; 193 int offset; 194 int ret; 195 196 if (!ui->sample->user_regs) 197 return false; 198 199 ret = perf_reg_value(&start, ui->sample->user_regs, 200 perf_arch_reg_sp(e_machine)); 201 if (ret) 202 return false; 203 204 end = start + stack->size; 205 206 /* Check overflow. */ 207 if (addr + sizeof(Dwarf_Word) < addr) 208 return false; 209 210 if (addr < start || addr + sizeof(Dwarf_Word) > end) { 211 ret = access_dso_mem(ui, addr, result); 212 if (ret) { 213 pr_debug("unwind: access_mem 0x%" PRIx64 " not inside range" 214 " 0x%" PRIx64 "-0x%" PRIx64 "\n", 215 addr, start, end); 216 return false; 217 } 218 return true; 219 } 220 221 offset = addr - start; 222 *result = *(Dwarf_Word *)&stack->data[offset]; 223 pr_debug("unwind: access_mem addr 0x%" PRIx64 ", val %lx, offset %d\n", 224 addr, (unsigned long)*result, offset); 225 return true; 226 } 227 228 #define DEFINE_DWFL_THREAD_CALLBACKS(arch) \ 229 static const Dwfl_Thread_Callbacks callbacks_##arch = { \ 230 .next_thread = next_thread, \ 231 .memory_read = memory_read, \ 232 .set_initial_registers = libdw_set_initial_registers_##arch, \ 233 } 234 235 DEFINE_DWFL_THREAD_CALLBACKS(x86); 236 DEFINE_DWFL_THREAD_CALLBACKS(arm); 237 DEFINE_DWFL_THREAD_CALLBACKS(arm64); 238 DEFINE_DWFL_THREAD_CALLBACKS(csky); 239 DEFINE_DWFL_THREAD_CALLBACKS(loongarch); 240 DEFINE_DWFL_THREAD_CALLBACKS(powerpc); 241 DEFINE_DWFL_THREAD_CALLBACKS(riscv); 242 DEFINE_DWFL_THREAD_CALLBACKS(s390); 243 244 static const Dwfl_Thread_Callbacks *get_thread_callbacks(const char *arch) 245 { 246 if (!strcmp(arch, "arm")) 247 return &callbacks_arm; 248 else if (!strcmp(arch, "arm64")) 249 return &callbacks_arm64; 250 else if (!strcmp(arch, "csky")) 251 return &callbacks_csky; 252 else if (!strcmp(arch, "loongarch")) 253 return &callbacks_loongarch; 254 else if (!strcmp(arch, "powerpc")) 255 return &callbacks_powerpc; 256 else if (!strcmp(arch, "riscv")) 257 return &callbacks_riscv; 258 else if (!strcmp(arch, "s390")) 259 return &callbacks_s390; 260 else if (!strcmp(arch, "x86")) 261 return &callbacks_x86; 262 263 pr_err("Fail to get thread callbacks for arch %s, returns NULL\n", 264 arch); 265 return NULL; 266 } 267 268 static int 269 frame_callback(Dwfl_Frame *state, void *arg) 270 { 271 struct unwind_info *ui = arg; 272 Dwarf_Addr pc; 273 bool isactivation; 274 275 if (!dwfl_frame_pc(state, &pc, NULL)) { 276 if (!ui->best_effort) 277 pr_err("%s", dwfl_errmsg(-1)); 278 return DWARF_CB_ABORT; 279 } 280 281 // report the module before we query for isactivation 282 report_module(pc, ui); 283 284 if (!dwfl_frame_pc(state, &pc, &isactivation)) { 285 if (!ui->best_effort) 286 pr_err("%s", dwfl_errmsg(-1)); 287 return DWARF_CB_ABORT; 288 } 289 290 if (!isactivation) 291 --pc; 292 293 return entry(pc, ui) || !(--ui->max_stack) ? 294 DWARF_CB_ABORT : DWARF_CB_OK; 295 } 296 297 int unwind__get_entries(unwind_entry_cb_t cb, void *arg, 298 struct thread *thread, 299 struct perf_sample *data, 300 int max_stack, 301 bool best_effort) 302 { 303 struct machine *machine = maps__machine(thread__maps(thread)); 304 struct unwind_info *ui, ui_buf = { 305 .sample = data, 306 .thread = thread, 307 .machine = machine, 308 .cb = cb, 309 .arg = arg, 310 .max_stack = max_stack, 311 .best_effort = best_effort 312 }; 313 uint16_t e_machine = thread__e_machine(thread, machine); 314 const char *arch = perf_env__arch(machine->env); 315 Dwarf_Word ip; 316 int err = -EINVAL, i; 317 const Dwfl_Thread_Callbacks *callbacks; 318 319 if (!data->user_regs || !data->user_regs->regs) 320 return -EINVAL; 321 322 ui = zalloc(sizeof(ui_buf) + sizeof(ui_buf.entries[0]) * max_stack); 323 if (!ui) 324 return -ENOMEM; 325 326 *ui = ui_buf; 327 328 ui->dwfl = dwfl_begin(&offline_callbacks); 329 if (!ui->dwfl) 330 goto out; 331 332 err = perf_reg_value(&ip, data->user_regs, perf_arch_reg_ip(e_machine)); 333 if (err) 334 goto out; 335 336 err = report_module(ip, ui); 337 if (err) 338 goto out; 339 340 callbacks = get_thread_callbacks(arch); 341 if (!callbacks) 342 goto out; 343 344 err = !dwfl_attach_state(ui->dwfl, /*elf=*/NULL, thread__tid(thread), callbacks, ui); 345 if (err) 346 goto out; 347 348 err = dwfl_getthread_frames(ui->dwfl, thread__tid(thread), frame_callback, ui); 349 350 if (err && ui->max_stack != max_stack) 351 err = 0; 352 353 /* 354 * Display what we got based on the order setup. 355 */ 356 for (i = 0; i < ui->idx && !err; i++) { 357 int j = i; 358 359 if (callchain_param.order == ORDER_CALLER) 360 j = ui->idx - i - 1; 361 362 err = ui->entries[j].ip ? ui->cb(&ui->entries[j], ui->arg) : 0; 363 } 364 365 out: 366 if (err) 367 pr_debug("unwind: failed with '%s'\n", dwfl_errmsg(-1)); 368 369 for (i = 0; i < ui->idx; i++) 370 map_symbol__exit(&ui->entries[i].ms); 371 372 dwfl_end(ui->dwfl); 373 free(ui); 374 return 0; 375 } 376