1 /*
2 * probe-finder.c : C expression to kprobe event converter
3 *
4 * Written by Masami Hiramatsu <mhiramat@redhat.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 *
20 */
21
22 #include <inttypes.h>
23 #include <sys/utsname.h>
24 #include <sys/types.h>
25 #include <sys/stat.h>
26 #include <fcntl.h>
27 #include <errno.h>
28 #include <stdio.h>
29 #include <unistd.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <stdarg.h>
33 #include <dwarf-regs.h>
34
35 #include <linux/bitops.h>
36 #include "event.h"
37 #include "dso.h"
38 #include "debug.h"
39 #include "intlist.h"
40 #include "util.h"
41 #include "strlist.h"
42 #include "symbol.h"
43 #include "probe-finder.h"
44 #include "probe-file.h"
45 #include "string2.h"
46
47 /* Kprobe tracer basic type is up to u64 */
48 #define MAX_BASIC_TYPE_BITS 64
49
50 /* Dwarf FL wrappers */
51 static char *debuginfo_path; /* Currently dummy */
52
53 static const Dwfl_Callbacks offline_callbacks = {
54 .find_debuginfo = dwfl_standard_find_debuginfo,
55 .debuginfo_path = &debuginfo_path,
56
57 .section_address = dwfl_offline_section_address,
58
59 /* We use this table for core files too. */
60 .find_elf = dwfl_build_id_find_elf,
61 };
62
63 /* Get a Dwarf from offline image */
debuginfo__init_offline_dwarf(struct debuginfo * dbg,const char * path)64 static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
65 const char *path)
66 {
67 int fd;
68
69 fd = open(path, O_RDONLY);
70 if (fd < 0)
71 return fd;
72
73 dbg->dwfl = dwfl_begin(&offline_callbacks);
74 if (!dbg->dwfl)
75 goto error;
76
77 dwfl_report_begin(dbg->dwfl);
78 dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
79 if (!dbg->mod)
80 goto error;
81
82 dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
83 if (!dbg->dbg)
84 goto error;
85
86 dwfl_report_end(dbg->dwfl, NULL, NULL);
87
88 return 0;
89 error:
90 if (dbg->dwfl)
91 dwfl_end(dbg->dwfl);
92 else
93 close(fd);
94 memset(dbg, 0, sizeof(*dbg));
95
96 return -ENOENT;
97 }
98
__debuginfo__new(const char * path)99 static struct debuginfo *__debuginfo__new(const char *path)
100 {
101 struct debuginfo *dbg = zalloc(sizeof(*dbg));
102 if (!dbg)
103 return NULL;
104
105 if (debuginfo__init_offline_dwarf(dbg, path) < 0)
106 zfree(&dbg);
107 if (dbg)
108 pr_debug("Open Debuginfo file: %s\n", path);
109 return dbg;
110 }
111
112 enum dso_binary_type distro_dwarf_types[] = {
113 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
114 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
115 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
116 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
117 DSO_BINARY_TYPE__NOT_FOUND,
118 };
119
debuginfo__new(const char * path)120 struct debuginfo *debuginfo__new(const char *path)
121 {
122 enum dso_binary_type *type;
123 char buf[PATH_MAX], nil = '\0';
124 struct dso *dso;
125 struct debuginfo *dinfo = NULL;
126
127 /* Try to open distro debuginfo files */
128 dso = dso__new(path);
129 if (!dso)
130 goto out;
131
132 for (type = distro_dwarf_types;
133 !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
134 type++) {
135 if (dso__read_binary_type_filename(dso, *type, &nil,
136 buf, PATH_MAX) < 0)
137 continue;
138 dinfo = __debuginfo__new(buf);
139 }
140 dso__put(dso);
141
142 out:
143 /* if failed to open all distro debuginfo, open given binary */
144 return dinfo ? : __debuginfo__new(path);
145 }
146
debuginfo__delete(struct debuginfo * dbg)147 void debuginfo__delete(struct debuginfo *dbg)
148 {
149 if (dbg) {
150 if (dbg->dwfl)
151 dwfl_end(dbg->dwfl);
152 free(dbg);
153 }
154 }
155
156 /*
157 * Probe finder related functions
158 */
159
alloc_trace_arg_ref(long offs)160 static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
161 {
162 struct probe_trace_arg_ref *ref;
163 ref = zalloc(sizeof(struct probe_trace_arg_ref));
164 if (ref != NULL)
165 ref->offset = offs;
166 return ref;
167 }
168
169 /*
170 * Convert a location into trace_arg.
171 * If tvar == NULL, this just checks variable can be converted.
172 * If fentry == true and vr_die is a parameter, do huristic search
173 * for the location fuzzed by function entry mcount.
174 */
convert_variable_location(Dwarf_Die * vr_die,Dwarf_Addr addr,Dwarf_Op * fb_ops,Dwarf_Die * sp_die,unsigned int machine,struct probe_trace_arg * tvar)175 static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
176 Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
177 unsigned int machine,
178 struct probe_trace_arg *tvar)
179 {
180 Dwarf_Attribute attr;
181 Dwarf_Addr tmp = 0;
182 Dwarf_Op *op;
183 size_t nops;
184 unsigned int regn;
185 Dwarf_Word offs = 0;
186 bool ref = false;
187 const char *regs;
188 int ret, ret2 = 0;
189
190 if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
191 goto static_var;
192
193 /* TODO: handle more than 1 exprs */
194 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
195 return -EINVAL; /* Broken DIE ? */
196 if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
197 ret = dwarf_entrypc(sp_die, &tmp);
198 if (ret)
199 return -ENOENT;
200
201 if (probe_conf.show_location_range &&
202 (dwarf_tag(vr_die) == DW_TAG_variable)) {
203 ret2 = -ERANGE;
204 } else if (addr != tmp ||
205 dwarf_tag(vr_die) != DW_TAG_formal_parameter) {
206 return -ENOENT;
207 }
208
209 ret = dwarf_highpc(sp_die, &tmp);
210 if (ret)
211 return -ENOENT;
212 /*
213 * This is fuzzed by fentry mcount. We try to find the
214 * parameter location at the earliest address.
215 */
216 for (addr += 1; addr <= tmp; addr++) {
217 if (dwarf_getlocation_addr(&attr, addr, &op,
218 &nops, 1) > 0)
219 goto found;
220 }
221 return -ENOENT;
222 }
223 found:
224 if (nops == 0)
225 /* TODO: Support const_value */
226 return -ENOENT;
227
228 if (op->atom == DW_OP_addr) {
229 static_var:
230 if (!tvar)
231 return ret2;
232 /* Static variables on memory (not stack), make @varname */
233 ret = strlen(dwarf_diename(vr_die));
234 tvar->value = zalloc(ret + 2);
235 if (tvar->value == NULL)
236 return -ENOMEM;
237 snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
238 tvar->ref = alloc_trace_arg_ref((long)offs);
239 if (tvar->ref == NULL)
240 return -ENOMEM;
241 return ret2;
242 }
243
244 /* If this is based on frame buffer, set the offset */
245 if (op->atom == DW_OP_fbreg) {
246 if (fb_ops == NULL)
247 return -ENOTSUP;
248 ref = true;
249 offs = op->number;
250 op = &fb_ops[0];
251 }
252
253 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
254 regn = op->atom - DW_OP_breg0;
255 offs += op->number;
256 ref = true;
257 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
258 regn = op->atom - DW_OP_reg0;
259 } else if (op->atom == DW_OP_bregx) {
260 regn = op->number;
261 offs += op->number2;
262 ref = true;
263 } else if (op->atom == DW_OP_regx) {
264 regn = op->number;
265 } else {
266 pr_debug("DW_OP %x is not supported.\n", op->atom);
267 return -ENOTSUP;
268 }
269
270 if (!tvar)
271 return ret2;
272
273 regs = get_dwarf_regstr(regn, machine);
274 if (!regs) {
275 /* This should be a bug in DWARF or this tool */
276 pr_warning("Mapping for the register number %u "
277 "missing on this architecture.\n", regn);
278 return -ENOTSUP;
279 }
280
281 tvar->value = strdup(regs);
282 if (tvar->value == NULL)
283 return -ENOMEM;
284
285 if (ref) {
286 tvar->ref = alloc_trace_arg_ref((long)offs);
287 if (tvar->ref == NULL)
288 return -ENOMEM;
289 }
290 return ret2;
291 }
292
293 #define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
294
convert_variable_type(Dwarf_Die * vr_die,struct probe_trace_arg * tvar,const char * cast)295 static int convert_variable_type(Dwarf_Die *vr_die,
296 struct probe_trace_arg *tvar,
297 const char *cast)
298 {
299 struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
300 Dwarf_Die type;
301 char buf[16];
302 char sbuf[STRERR_BUFSIZE];
303 int bsize, boffs, total;
304 int ret;
305 char prefix;
306
307 /* TODO: check all types */
308 if (cast && strcmp(cast, "string") != 0 && strcmp(cast, "x") != 0 &&
309 strcmp(cast, "s") != 0 && strcmp(cast, "u") != 0) {
310 /* Non string type is OK */
311 /* and respect signedness/hexadecimal cast */
312 tvar->type = strdup(cast);
313 return (tvar->type == NULL) ? -ENOMEM : 0;
314 }
315
316 bsize = dwarf_bitsize(vr_die);
317 if (bsize > 0) {
318 /* This is a bitfield */
319 boffs = dwarf_bitoffset(vr_die);
320 total = dwarf_bytesize(vr_die);
321 if (boffs < 0 || total < 0)
322 return -ENOENT;
323 ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
324 BYTES_TO_BITS(total));
325 goto formatted;
326 }
327
328 if (die_get_real_type(vr_die, &type) == NULL) {
329 pr_warning("Failed to get a type information of %s.\n",
330 dwarf_diename(vr_die));
331 return -ENOENT;
332 }
333
334 pr_debug("%s type is %s.\n",
335 dwarf_diename(vr_die), dwarf_diename(&type));
336
337 if (cast && strcmp(cast, "string") == 0) { /* String type */
338 ret = dwarf_tag(&type);
339 if (ret != DW_TAG_pointer_type &&
340 ret != DW_TAG_array_type) {
341 pr_warning("Failed to cast into string: "
342 "%s(%s) is not a pointer nor array.\n",
343 dwarf_diename(vr_die), dwarf_diename(&type));
344 return -EINVAL;
345 }
346 if (die_get_real_type(&type, &type) == NULL) {
347 pr_warning("Failed to get a type"
348 " information.\n");
349 return -ENOENT;
350 }
351 if (ret == DW_TAG_pointer_type) {
352 while (*ref_ptr)
353 ref_ptr = &(*ref_ptr)->next;
354 /* Add new reference with offset +0 */
355 *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
356 if (*ref_ptr == NULL) {
357 pr_warning("Out of memory error\n");
358 return -ENOMEM;
359 }
360 }
361 if (!die_compare_name(&type, "char") &&
362 !die_compare_name(&type, "unsigned char")) {
363 pr_warning("Failed to cast into string: "
364 "%s is not (unsigned) char *.\n",
365 dwarf_diename(vr_die));
366 return -EINVAL;
367 }
368 tvar->type = strdup(cast);
369 return (tvar->type == NULL) ? -ENOMEM : 0;
370 }
371
372 if (cast && (strcmp(cast, "u") == 0))
373 prefix = 'u';
374 else if (cast && (strcmp(cast, "s") == 0))
375 prefix = 's';
376 else if (cast && (strcmp(cast, "x") == 0) &&
377 probe_type_is_available(PROBE_TYPE_X))
378 prefix = 'x';
379 else
380 prefix = die_is_signed_type(&type) ? 's' :
381 probe_type_is_available(PROBE_TYPE_X) ? 'x' : 'u';
382
383 ret = dwarf_bytesize(&type);
384 if (ret <= 0)
385 /* No size ... try to use default type */
386 return 0;
387 ret = BYTES_TO_BITS(ret);
388
389 /* Check the bitwidth */
390 if (ret > MAX_BASIC_TYPE_BITS) {
391 pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
392 dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
393 ret = MAX_BASIC_TYPE_BITS;
394 }
395 ret = snprintf(buf, 16, "%c%d", prefix, ret);
396
397 formatted:
398 if (ret < 0 || ret >= 16) {
399 if (ret >= 16)
400 ret = -E2BIG;
401 pr_warning("Failed to convert variable type: %s\n",
402 str_error_r(-ret, sbuf, sizeof(sbuf)));
403 return ret;
404 }
405 tvar->type = strdup(buf);
406 if (tvar->type == NULL)
407 return -ENOMEM;
408 return 0;
409 }
410
convert_variable_fields(Dwarf_Die * vr_die,const char * varname,struct perf_probe_arg_field * field,struct probe_trace_arg_ref ** ref_ptr,Dwarf_Die * die_mem)411 static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
412 struct perf_probe_arg_field *field,
413 struct probe_trace_arg_ref **ref_ptr,
414 Dwarf_Die *die_mem)
415 {
416 struct probe_trace_arg_ref *ref = *ref_ptr;
417 Dwarf_Die type;
418 Dwarf_Word offs;
419 int ret, tag;
420
421 pr_debug("converting %s in %s\n", field->name, varname);
422 if (die_get_real_type(vr_die, &type) == NULL) {
423 pr_warning("Failed to get the type of %s.\n", varname);
424 return -ENOENT;
425 }
426 pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
427 tag = dwarf_tag(&type);
428
429 if (field->name[0] == '[' &&
430 (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
431 if (field->next)
432 /* Save original type for next field */
433 memcpy(die_mem, &type, sizeof(*die_mem));
434 /* Get the type of this array */
435 if (die_get_real_type(&type, &type) == NULL) {
436 pr_warning("Failed to get the type of %s.\n", varname);
437 return -ENOENT;
438 }
439 pr_debug2("Array real type: (%x)\n",
440 (unsigned)dwarf_dieoffset(&type));
441 if (tag == DW_TAG_pointer_type) {
442 ref = zalloc(sizeof(struct probe_trace_arg_ref));
443 if (ref == NULL)
444 return -ENOMEM;
445 if (*ref_ptr)
446 (*ref_ptr)->next = ref;
447 else
448 *ref_ptr = ref;
449 }
450 ref->offset += dwarf_bytesize(&type) * field->index;
451 if (!field->next)
452 /* Save vr_die for converting types */
453 memcpy(die_mem, vr_die, sizeof(*die_mem));
454 goto next;
455 } else if (tag == DW_TAG_pointer_type) {
456 /* Check the pointer and dereference */
457 if (!field->ref) {
458 pr_err("Semantic error: %s must be referred by '->'\n",
459 field->name);
460 return -EINVAL;
461 }
462 /* Get the type pointed by this pointer */
463 if (die_get_real_type(&type, &type) == NULL) {
464 pr_warning("Failed to get the type of %s.\n", varname);
465 return -ENOENT;
466 }
467 /* Verify it is a data structure */
468 tag = dwarf_tag(&type);
469 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
470 pr_warning("%s is not a data structure nor a union.\n",
471 varname);
472 return -EINVAL;
473 }
474
475 ref = zalloc(sizeof(struct probe_trace_arg_ref));
476 if (ref == NULL)
477 return -ENOMEM;
478 if (*ref_ptr)
479 (*ref_ptr)->next = ref;
480 else
481 *ref_ptr = ref;
482 } else {
483 /* Verify it is a data structure */
484 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
485 pr_warning("%s is not a data structure nor a union.\n",
486 varname);
487 return -EINVAL;
488 }
489 if (field->name[0] == '[') {
490 pr_err("Semantic error: %s is not a pointer"
491 " nor array.\n", varname);
492 return -EINVAL;
493 }
494 /* While prcessing unnamed field, we don't care about this */
495 if (field->ref && dwarf_diename(vr_die)) {
496 pr_err("Semantic error: %s must be referred by '.'\n",
497 field->name);
498 return -EINVAL;
499 }
500 if (!ref) {
501 pr_warning("Structure on a register is not "
502 "supported yet.\n");
503 return -ENOTSUP;
504 }
505 }
506
507 if (die_find_member(&type, field->name, die_mem) == NULL) {
508 pr_warning("%s(type:%s) has no member %s.\n", varname,
509 dwarf_diename(&type), field->name);
510 return -EINVAL;
511 }
512
513 /* Get the offset of the field */
514 if (tag == DW_TAG_union_type) {
515 offs = 0;
516 } else {
517 ret = die_get_data_member_location(die_mem, &offs);
518 if (ret < 0) {
519 pr_warning("Failed to get the offset of %s.\n",
520 field->name);
521 return ret;
522 }
523 }
524 ref->offset += (long)offs;
525
526 /* If this member is unnamed, we need to reuse this field */
527 if (!dwarf_diename(die_mem))
528 return convert_variable_fields(die_mem, varname, field,
529 &ref, die_mem);
530
531 next:
532 /* Converting next field */
533 if (field->next)
534 return convert_variable_fields(die_mem, field->name,
535 field->next, &ref, die_mem);
536 else
537 return 0;
538 }
539
540 /* Show a variables in kprobe event format */
convert_variable(Dwarf_Die * vr_die,struct probe_finder * pf)541 static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
542 {
543 Dwarf_Die die_mem;
544 int ret;
545
546 pr_debug("Converting variable %s into trace event.\n",
547 dwarf_diename(vr_die));
548
549 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
550 &pf->sp_die, pf->machine, pf->tvar);
551 if (ret == -ENOENT || ret == -EINVAL) {
552 pr_err("Failed to find the location of the '%s' variable at this address.\n"
553 " Perhaps it has been optimized out.\n"
554 " Use -V with the --range option to show '%s' location range.\n",
555 pf->pvar->var, pf->pvar->var);
556 } else if (ret == -ENOTSUP)
557 pr_err("Sorry, we don't support this variable location yet.\n");
558 else if (ret == 0 && pf->pvar->field) {
559 ret = convert_variable_fields(vr_die, pf->pvar->var,
560 pf->pvar->field, &pf->tvar->ref,
561 &die_mem);
562 vr_die = &die_mem;
563 }
564 if (ret == 0)
565 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
566 /* *expr will be cached in libdw. Don't free it. */
567 return ret;
568 }
569
570 /* Find a variable in a scope DIE */
find_variable(Dwarf_Die * sc_die,struct probe_finder * pf)571 static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
572 {
573 Dwarf_Die vr_die;
574 char *buf, *ptr;
575 int ret = 0;
576
577 /* Copy raw parameters */
578 if (!is_c_varname(pf->pvar->var))
579 return copy_to_probe_trace_arg(pf->tvar, pf->pvar);
580
581 if (pf->pvar->name)
582 pf->tvar->name = strdup(pf->pvar->name);
583 else {
584 buf = synthesize_perf_probe_arg(pf->pvar);
585 if (!buf)
586 return -ENOMEM;
587 ptr = strchr(buf, ':'); /* Change type separator to _ */
588 if (ptr)
589 *ptr = '_';
590 pf->tvar->name = buf;
591 }
592 if (pf->tvar->name == NULL)
593 return -ENOMEM;
594
595 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
596 /* Search child die for local variables and parameters. */
597 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
598 /* Search again in global variables */
599 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
600 0, &vr_die)) {
601 pr_warning("Failed to find '%s' in this function.\n",
602 pf->pvar->var);
603 ret = -ENOENT;
604 }
605 }
606 if (ret >= 0)
607 ret = convert_variable(&vr_die, pf);
608
609 return ret;
610 }
611
612 /* Convert subprogram DIE to trace point */
convert_to_trace_point(Dwarf_Die * sp_die,Dwfl_Module * mod,Dwarf_Addr paddr,bool retprobe,const char * function,struct probe_trace_point * tp)613 static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
614 Dwarf_Addr paddr, bool retprobe,
615 const char *function,
616 struct probe_trace_point *tp)
617 {
618 Dwarf_Addr eaddr;
619 GElf_Sym sym;
620 const char *symbol;
621
622 /* Verify the address is correct */
623 if (!dwarf_haspc(sp_die, paddr)) {
624 pr_warning("Specified offset is out of %s\n",
625 dwarf_diename(sp_die));
626 return -EINVAL;
627 }
628
629 if (dwarf_entrypc(sp_die, &eaddr) == 0) {
630 /* If the DIE has entrypc, use it. */
631 symbol = dwarf_diename(sp_die);
632 } else {
633 /* Try to get actual symbol name and address from symtab */
634 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
635 eaddr = sym.st_value;
636 }
637 if (!symbol) {
638 pr_warning("Failed to find symbol at 0x%lx\n",
639 (unsigned long)paddr);
640 return -ENOENT;
641 }
642
643 tp->offset = (unsigned long)(paddr - eaddr);
644 tp->address = (unsigned long)paddr;
645 tp->symbol = strdup(symbol);
646 if (!tp->symbol)
647 return -ENOMEM;
648
649 /* Return probe must be on the head of a subprogram */
650 if (retprobe) {
651 if (eaddr != paddr) {
652 pr_warning("Failed to find \"%s%%return\",\n"
653 " because %s is an inlined function and"
654 " has no return point.\n", function,
655 function);
656 return -EINVAL;
657 }
658 tp->retprobe = true;
659 }
660
661 return 0;
662 }
663
664 /* Call probe_finder callback with scope DIE */
call_probe_finder(Dwarf_Die * sc_die,struct probe_finder * pf)665 static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
666 {
667 Dwarf_Attribute fb_attr;
668 Dwarf_Frame *frame = NULL;
669 size_t nops;
670 int ret;
671
672 if (!sc_die) {
673 pr_err("Caller must pass a scope DIE. Program error.\n");
674 return -EINVAL;
675 }
676
677 /* If not a real subprogram, find a real one */
678 if (!die_is_func_def(sc_die)) {
679 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
680 if (die_find_tailfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
681 pr_warning("Ignoring tail call from %s\n",
682 dwarf_diename(&pf->sp_die));
683 return 0;
684 } else {
685 pr_warning("Failed to find probe point in any "
686 "functions.\n");
687 return -ENOENT;
688 }
689 }
690 } else
691 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
692
693 /* Get the frame base attribute/ops from subprogram */
694 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
695 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
696 if (ret <= 0 || nops == 0) {
697 pf->fb_ops = NULL;
698 #if _ELFUTILS_PREREQ(0, 142)
699 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
700 (pf->cfi_eh != NULL || pf->cfi_dbg != NULL)) {
701 if ((dwarf_cfi_addrframe(pf->cfi_eh, pf->addr, &frame) != 0 &&
702 (dwarf_cfi_addrframe(pf->cfi_dbg, pf->addr, &frame) != 0)) ||
703 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
704 pr_warning("Failed to get call frame on 0x%jx\n",
705 (uintmax_t)pf->addr);
706 free(frame);
707 return -ENOENT;
708 }
709 #endif
710 }
711
712 /* Call finder's callback handler */
713 ret = pf->callback(sc_die, pf);
714
715 /* Since *pf->fb_ops can be a part of frame. we should free it here. */
716 free(frame);
717 pf->fb_ops = NULL;
718
719 return ret;
720 }
721
722 struct find_scope_param {
723 const char *function;
724 const char *file;
725 int line;
726 int diff;
727 Dwarf_Die *die_mem;
728 bool found;
729 };
730
find_best_scope_cb(Dwarf_Die * fn_die,void * data)731 static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
732 {
733 struct find_scope_param *fsp = data;
734 const char *file;
735 int lno;
736
737 /* Skip if declared file name does not match */
738 if (fsp->file) {
739 file = dwarf_decl_file(fn_die);
740 if (!file || strcmp(fsp->file, file) != 0)
741 return 0;
742 }
743 /* If the function name is given, that's what user expects */
744 if (fsp->function) {
745 if (die_match_name(fn_die, fsp->function)) {
746 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
747 fsp->found = true;
748 return 1;
749 }
750 } else {
751 /* With the line number, find the nearest declared DIE */
752 dwarf_decl_line(fn_die, &lno);
753 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
754 /* Keep a candidate and continue */
755 fsp->diff = fsp->line - lno;
756 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
757 fsp->found = true;
758 }
759 }
760 return 0;
761 }
762
763 /* Return innermost DIE */
find_inner_scope_cb(Dwarf_Die * fn_die,void * data)764 static int find_inner_scope_cb(Dwarf_Die *fn_die, void *data)
765 {
766 struct find_scope_param *fsp = data;
767
768 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
769 fsp->found = true;
770 return 1;
771 }
772
773 /* Find an appropriate scope fits to given conditions */
find_best_scope(struct probe_finder * pf,Dwarf_Die * die_mem)774 static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
775 {
776 struct find_scope_param fsp = {
777 .function = pf->pev->point.function,
778 .file = pf->fname,
779 .line = pf->lno,
780 .diff = INT_MAX,
781 .die_mem = die_mem,
782 .found = false,
783 };
784 int ret;
785
786 ret = cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb,
787 &fsp);
788 if (!ret && !fsp.found)
789 cu_walk_functions_at(&pf->cu_die, pf->addr,
790 find_inner_scope_cb, &fsp);
791
792 return fsp.found ? die_mem : NULL;
793 }
794
probe_point_line_walker(const char * fname,int lineno,Dwarf_Addr addr,void * data)795 static int probe_point_line_walker(const char *fname, int lineno,
796 Dwarf_Addr addr, void *data)
797 {
798 struct probe_finder *pf = data;
799 Dwarf_Die *sc_die, die_mem;
800 int ret;
801
802 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
803 return 0;
804
805 pf->addr = addr;
806 sc_die = find_best_scope(pf, &die_mem);
807 if (!sc_die) {
808 pr_warning("Failed to find scope of probe point.\n");
809 return -ENOENT;
810 }
811
812 ret = call_probe_finder(sc_die, pf);
813
814 /* Continue if no error, because the line will be in inline function */
815 return ret < 0 ? ret : 0;
816 }
817
818 /* Find probe point from its line number */
find_probe_point_by_line(struct probe_finder * pf)819 static int find_probe_point_by_line(struct probe_finder *pf)
820 {
821 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
822 }
823
824 /* Find lines which match lazy pattern */
find_lazy_match_lines(struct intlist * list,const char * fname,const char * pat)825 static int find_lazy_match_lines(struct intlist *list,
826 const char *fname, const char *pat)
827 {
828 FILE *fp;
829 char *line = NULL;
830 size_t line_len;
831 ssize_t len;
832 int count = 0, linenum = 1;
833 char sbuf[STRERR_BUFSIZE];
834
835 fp = fopen(fname, "r");
836 if (!fp) {
837 pr_warning("Failed to open %s: %s\n", fname,
838 str_error_r(errno, sbuf, sizeof(sbuf)));
839 return -errno;
840 }
841
842 while ((len = getline(&line, &line_len, fp)) > 0) {
843
844 if (line[len - 1] == '\n')
845 line[len - 1] = '\0';
846
847 if (strlazymatch(line, pat)) {
848 intlist__add(list, linenum);
849 count++;
850 }
851 linenum++;
852 }
853
854 if (ferror(fp))
855 count = -errno;
856 free(line);
857 fclose(fp);
858
859 if (count == 0)
860 pr_debug("No matched lines found in %s.\n", fname);
861 return count;
862 }
863
probe_point_lazy_walker(const char * fname,int lineno,Dwarf_Addr addr,void * data)864 static int probe_point_lazy_walker(const char *fname, int lineno,
865 Dwarf_Addr addr, void *data)
866 {
867 struct probe_finder *pf = data;
868 Dwarf_Die *sc_die, die_mem;
869 int ret;
870
871 if (!intlist__has_entry(pf->lcache, lineno) ||
872 strtailcmp(fname, pf->fname) != 0)
873 return 0;
874
875 pr_debug("Probe line found: line:%d addr:0x%llx\n",
876 lineno, (unsigned long long)addr);
877 pf->addr = addr;
878 pf->lno = lineno;
879 sc_die = find_best_scope(pf, &die_mem);
880 if (!sc_die) {
881 pr_warning("Failed to find scope of probe point.\n");
882 return -ENOENT;
883 }
884
885 ret = call_probe_finder(sc_die, pf);
886
887 /*
888 * Continue if no error, because the lazy pattern will match
889 * to other lines
890 */
891 return ret < 0 ? ret : 0;
892 }
893
894 /* Find probe points from lazy pattern */
find_probe_point_lazy(Dwarf_Die * sp_die,struct probe_finder * pf)895 static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
896 {
897 int ret = 0;
898 char *fpath;
899
900 if (intlist__empty(pf->lcache)) {
901 const char *comp_dir;
902
903 comp_dir = cu_get_comp_dir(&pf->cu_die);
904 ret = get_real_path(pf->fname, comp_dir, &fpath);
905 if (ret < 0) {
906 pr_warning("Failed to find source file path.\n");
907 return ret;
908 }
909
910 /* Matching lazy line pattern */
911 ret = find_lazy_match_lines(pf->lcache, fpath,
912 pf->pev->point.lazy_line);
913 free(fpath);
914 if (ret <= 0)
915 return ret;
916 }
917
918 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
919 }
920
skip_prologue(Dwarf_Die * sp_die,struct probe_finder * pf)921 static void skip_prologue(Dwarf_Die *sp_die, struct probe_finder *pf)
922 {
923 struct perf_probe_point *pp = &pf->pev->point;
924
925 /* Not uprobe? */
926 if (!pf->pev->uprobes)
927 return;
928
929 /* Compiled with optimization? */
930 if (die_is_optimized_target(&pf->cu_die))
931 return;
932
933 /* Don't know entrypc? */
934 if (!pf->addr)
935 return;
936
937 /* Only FUNC and FUNC@SRC are eligible. */
938 if (!pp->function || pp->line || pp->retprobe || pp->lazy_line ||
939 pp->offset || pp->abs_address)
940 return;
941
942 /* Not interested in func parameter? */
943 if (!perf_probe_with_var(pf->pev))
944 return;
945
946 pr_info("Target program is compiled without optimization. Skipping prologue.\n"
947 "Probe on address 0x%" PRIx64 " to force probing at the function entry.\n\n",
948 pf->addr);
949
950 die_skip_prologue(sp_die, &pf->cu_die, &pf->addr);
951 }
952
probe_point_inline_cb(Dwarf_Die * in_die,void * data)953 static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
954 {
955 struct probe_finder *pf = data;
956 struct perf_probe_point *pp = &pf->pev->point;
957 Dwarf_Addr addr;
958 int ret;
959
960 if (pp->lazy_line)
961 ret = find_probe_point_lazy(in_die, pf);
962 else {
963 /* Get probe address */
964 if (die_entrypc(in_die, &addr) != 0) {
965 pr_warning("Failed to get entry address of %s.\n",
966 dwarf_diename(in_die));
967 return -ENOENT;
968 }
969 if (addr == 0) {
970 pr_debug("%s has no valid entry address. skipped.\n",
971 dwarf_diename(in_die));
972 return -ENOENT;
973 }
974 pf->addr = addr;
975 pf->addr += pp->offset;
976 pr_debug("found inline addr: 0x%jx\n",
977 (uintmax_t)pf->addr);
978
979 ret = call_probe_finder(in_die, pf);
980 }
981
982 return ret;
983 }
984
985 /* Callback parameter with return value for libdw */
986 struct dwarf_callback_param {
987 void *data;
988 int retval;
989 };
990
991 /* Search function from function name */
probe_point_search_cb(Dwarf_Die * sp_die,void * data)992 static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
993 {
994 struct dwarf_callback_param *param = data;
995 struct probe_finder *pf = param->data;
996 struct perf_probe_point *pp = &pf->pev->point;
997
998 /* Check tag and diename */
999 if (!die_is_func_def(sp_die) ||
1000 !die_match_name(sp_die, pp->function))
1001 return DWARF_CB_OK;
1002
1003 /* Check declared file */
1004 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
1005 return DWARF_CB_OK;
1006
1007 pr_debug("Matched function: %s [%lx]\n", dwarf_diename(sp_die),
1008 (unsigned long)dwarf_dieoffset(sp_die));
1009 pf->fname = dwarf_decl_file(sp_die);
1010 if (pp->line) { /* Function relative line */
1011 dwarf_decl_line(sp_die, &pf->lno);
1012 pf->lno += pp->line;
1013 param->retval = find_probe_point_by_line(pf);
1014 } else if (die_is_func_instance(sp_die)) {
1015 /* Instances always have the entry address */
1016 die_entrypc(sp_die, &pf->addr);
1017 /* But in some case the entry address is 0 */
1018 if (pf->addr == 0) {
1019 pr_debug("%s has no entry PC. Skipped\n",
1020 dwarf_diename(sp_die));
1021 param->retval = 0;
1022 /* Real function */
1023 } else if (pp->lazy_line)
1024 param->retval = find_probe_point_lazy(sp_die, pf);
1025 else {
1026 skip_prologue(sp_die, pf);
1027 pf->addr += pp->offset;
1028 /* TODO: Check the address in this function */
1029 param->retval = call_probe_finder(sp_die, pf);
1030 }
1031 } else if (!probe_conf.no_inlines) {
1032 /* Inlined function: search instances */
1033 param->retval = die_walk_instances(sp_die,
1034 probe_point_inline_cb, (void *)pf);
1035 /* This could be a non-existed inline definition */
1036 if (param->retval == -ENOENT)
1037 param->retval = 0;
1038 }
1039
1040 /* We need to find other candidates */
1041 if (strisglob(pp->function) && param->retval >= 0) {
1042 param->retval = 0; /* We have to clear the result */
1043 return DWARF_CB_OK;
1044 }
1045
1046 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
1047 }
1048
find_probe_point_by_func(struct probe_finder * pf)1049 static int find_probe_point_by_func(struct probe_finder *pf)
1050 {
1051 struct dwarf_callback_param _param = {.data = (void *)pf,
1052 .retval = 0};
1053 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
1054 return _param.retval;
1055 }
1056
1057 struct pubname_callback_param {
1058 char *function;
1059 char *file;
1060 Dwarf_Die *cu_die;
1061 Dwarf_Die *sp_die;
1062 int found;
1063 };
1064
pubname_search_cb(Dwarf * dbg,Dwarf_Global * gl,void * data)1065 static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
1066 {
1067 struct pubname_callback_param *param = data;
1068
1069 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
1070 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
1071 return DWARF_CB_OK;
1072
1073 if (die_match_name(param->sp_die, param->function)) {
1074 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
1075 return DWARF_CB_OK;
1076
1077 if (param->file &&
1078 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
1079 return DWARF_CB_OK;
1080
1081 param->found = 1;
1082 return DWARF_CB_ABORT;
1083 }
1084 }
1085
1086 return DWARF_CB_OK;
1087 }
1088
debuginfo__find_probe_location(struct debuginfo * dbg,struct probe_finder * pf)1089 static int debuginfo__find_probe_location(struct debuginfo *dbg,
1090 struct probe_finder *pf)
1091 {
1092 struct perf_probe_point *pp = &pf->pev->point;
1093 Dwarf_Off off, noff;
1094 size_t cuhl;
1095 Dwarf_Die *diep;
1096 int ret = 0;
1097
1098 off = 0;
1099 pf->lcache = intlist__new(NULL);
1100 if (!pf->lcache)
1101 return -ENOMEM;
1102
1103 /* Fastpath: lookup by function name from .debug_pubnames section */
1104 if (pp->function && !strisglob(pp->function)) {
1105 struct pubname_callback_param pubname_param = {
1106 .function = pp->function,
1107 .file = pp->file,
1108 .cu_die = &pf->cu_die,
1109 .sp_die = &pf->sp_die,
1110 .found = 0,
1111 };
1112 struct dwarf_callback_param probe_param = {
1113 .data = pf,
1114 };
1115
1116 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1117 &pubname_param, 0);
1118 if (pubname_param.found) {
1119 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1120 if (ret)
1121 goto found;
1122 }
1123 }
1124
1125 /* Loop on CUs (Compilation Unit) */
1126 while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1127 /* Get the DIE(Debugging Information Entry) of this CU */
1128 diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1129 if (!diep)
1130 continue;
1131
1132 /* Check if target file is included. */
1133 if (pp->file)
1134 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1135 else
1136 pf->fname = NULL;
1137
1138 if (!pp->file || pf->fname) {
1139 if (pp->function)
1140 ret = find_probe_point_by_func(pf);
1141 else if (pp->lazy_line)
1142 ret = find_probe_point_lazy(&pf->cu_die, pf);
1143 else {
1144 pf->lno = pp->line;
1145 ret = find_probe_point_by_line(pf);
1146 }
1147 if (ret < 0)
1148 break;
1149 }
1150 off = noff;
1151 }
1152
1153 found:
1154 intlist__delete(pf->lcache);
1155 pf->lcache = NULL;
1156
1157 return ret;
1158 }
1159
1160 /* Find probe points from debuginfo */
debuginfo__find_probes(struct debuginfo * dbg,struct probe_finder * pf)1161 static int debuginfo__find_probes(struct debuginfo *dbg,
1162 struct probe_finder *pf)
1163 {
1164 int ret = 0;
1165 Elf *elf;
1166 GElf_Ehdr ehdr;
1167
1168 if (pf->cfi_eh || pf->cfi_dbg)
1169 return debuginfo__find_probe_location(dbg, pf);
1170
1171 /* Get the call frame information from this dwarf */
1172 elf = dwarf_getelf(dbg->dbg);
1173 if (elf == NULL)
1174 return -EINVAL;
1175
1176 if (gelf_getehdr(elf, &ehdr) == NULL)
1177 return -EINVAL;
1178
1179 pf->machine = ehdr.e_machine;
1180
1181 #if _ELFUTILS_PREREQ(0, 142)
1182 do {
1183 GElf_Shdr shdr;
1184
1185 if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
1186 shdr.sh_type == SHT_PROGBITS)
1187 pf->cfi_eh = dwarf_getcfi_elf(elf);
1188
1189 pf->cfi_dbg = dwarf_getcfi(dbg->dbg);
1190 } while (0);
1191 #endif
1192
1193 ret = debuginfo__find_probe_location(dbg, pf);
1194 return ret;
1195 }
1196
1197 struct local_vars_finder {
1198 struct probe_finder *pf;
1199 struct perf_probe_arg *args;
1200 bool vars;
1201 int max_args;
1202 int nargs;
1203 int ret;
1204 };
1205
1206 /* Collect available variables in this scope */
copy_variables_cb(Dwarf_Die * die_mem,void * data)1207 static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1208 {
1209 struct local_vars_finder *vf = data;
1210 struct probe_finder *pf = vf->pf;
1211 int tag;
1212
1213 tag = dwarf_tag(die_mem);
1214 if (tag == DW_TAG_formal_parameter ||
1215 (tag == DW_TAG_variable && vf->vars)) {
1216 if (convert_variable_location(die_mem, vf->pf->addr,
1217 vf->pf->fb_ops, &pf->sp_die,
1218 pf->machine, NULL) == 0) {
1219 vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1220 if (vf->args[vf->nargs].var == NULL) {
1221 vf->ret = -ENOMEM;
1222 return DIE_FIND_CB_END;
1223 }
1224 pr_debug(" %s", vf->args[vf->nargs].var);
1225 vf->nargs++;
1226 }
1227 }
1228
1229 if (dwarf_haspc(die_mem, vf->pf->addr))
1230 return DIE_FIND_CB_CONTINUE;
1231 else
1232 return DIE_FIND_CB_SIBLING;
1233 }
1234
expand_probe_args(Dwarf_Die * sc_die,struct probe_finder * pf,struct perf_probe_arg * args)1235 static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1236 struct perf_probe_arg *args)
1237 {
1238 Dwarf_Die die_mem;
1239 int i;
1240 int n = 0;
1241 struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1242 .max_args = MAX_PROBE_ARGS, .ret = 0};
1243
1244 for (i = 0; i < pf->pev->nargs; i++) {
1245 /* var never be NULL */
1246 if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
1247 vf.vars = true;
1248 else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
1249 /* Copy normal argument */
1250 args[n] = pf->pev->args[i];
1251 n++;
1252 continue;
1253 }
1254 pr_debug("Expanding %s into:", pf->pev->args[i].var);
1255 vf.nargs = n;
1256 /* Special local variables */
1257 die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1258 &die_mem);
1259 pr_debug(" (%d)\n", vf.nargs - n);
1260 if (vf.ret < 0)
1261 return vf.ret;
1262 n = vf.nargs;
1263 }
1264 return n;
1265 }
1266
1267 /* Add a found probe point into trace event list */
add_probe_trace_event(Dwarf_Die * sc_die,struct probe_finder * pf)1268 static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1269 {
1270 struct trace_event_finder *tf =
1271 container_of(pf, struct trace_event_finder, pf);
1272 struct perf_probe_point *pp = &pf->pev->point;
1273 struct probe_trace_event *tev;
1274 struct perf_probe_arg *args = NULL;
1275 int ret, i;
1276
1277 /* Check number of tevs */
1278 if (tf->ntevs == tf->max_tevs) {
1279 pr_warning("Too many( > %d) probe point found.\n",
1280 tf->max_tevs);
1281 return -ERANGE;
1282 }
1283 tev = &tf->tevs[tf->ntevs++];
1284
1285 /* Trace point should be converted from subprogram DIE */
1286 ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1287 pp->retprobe, pp->function, &tev->point);
1288 if (ret < 0)
1289 goto end;
1290
1291 tev->point.realname = strdup(dwarf_diename(sc_die));
1292 if (!tev->point.realname) {
1293 ret = -ENOMEM;
1294 goto end;
1295 }
1296
1297 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1298 tev->point.offset);
1299
1300 /* Expand special probe argument if exist */
1301 args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1302 if (args == NULL) {
1303 ret = -ENOMEM;
1304 goto end;
1305 }
1306
1307 ret = expand_probe_args(sc_die, pf, args);
1308 if (ret < 0)
1309 goto end;
1310
1311 tev->nargs = ret;
1312 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1313 if (tev->args == NULL) {
1314 ret = -ENOMEM;
1315 goto end;
1316 }
1317
1318 /* Find each argument */
1319 for (i = 0; i < tev->nargs; i++) {
1320 pf->pvar = &args[i];
1321 pf->tvar = &tev->args[i];
1322 /* Variable should be found from scope DIE */
1323 ret = find_variable(sc_die, pf);
1324 if (ret != 0)
1325 break;
1326 }
1327
1328 end:
1329 if (ret) {
1330 clear_probe_trace_event(tev);
1331 tf->ntevs--;
1332 }
1333 free(args);
1334 return ret;
1335 }
1336
1337 /* Find probe_trace_events specified by perf_probe_event from debuginfo */
debuginfo__find_trace_events(struct debuginfo * dbg,struct perf_probe_event * pev,struct probe_trace_event ** tevs)1338 int debuginfo__find_trace_events(struct debuginfo *dbg,
1339 struct perf_probe_event *pev,
1340 struct probe_trace_event **tevs)
1341 {
1342 struct trace_event_finder tf = {
1343 .pf = {.pev = pev, .callback = add_probe_trace_event},
1344 .max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1345 int ret, i;
1346
1347 /* Allocate result tevs array */
1348 *tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1349 if (*tevs == NULL)
1350 return -ENOMEM;
1351
1352 tf.tevs = *tevs;
1353 tf.ntevs = 0;
1354
1355 ret = debuginfo__find_probes(dbg, &tf.pf);
1356 if (ret < 0) {
1357 for (i = 0; i < tf.ntevs; i++)
1358 clear_probe_trace_event(&tf.tevs[i]);
1359 zfree(tevs);
1360 return ret;
1361 }
1362
1363 return (ret < 0) ? ret : tf.ntevs;
1364 }
1365
1366 /* Collect available variables in this scope */
collect_variables_cb(Dwarf_Die * die_mem,void * data)1367 static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1368 {
1369 struct available_var_finder *af = data;
1370 struct variable_list *vl;
1371 struct strbuf buf = STRBUF_INIT;
1372 int tag, ret;
1373
1374 vl = &af->vls[af->nvls - 1];
1375
1376 tag = dwarf_tag(die_mem);
1377 if (tag == DW_TAG_formal_parameter ||
1378 tag == DW_TAG_variable) {
1379 ret = convert_variable_location(die_mem, af->pf.addr,
1380 af->pf.fb_ops, &af->pf.sp_die,
1381 af->pf.machine, NULL);
1382 if (ret == 0 || ret == -ERANGE) {
1383 int ret2;
1384 bool externs = !af->child;
1385
1386 if (strbuf_init(&buf, 64) < 0)
1387 goto error;
1388
1389 if (probe_conf.show_location_range) {
1390 if (!externs)
1391 ret2 = strbuf_add(&buf,
1392 ret ? "[INV]\t" : "[VAL]\t", 6);
1393 else
1394 ret2 = strbuf_add(&buf, "[EXT]\t", 6);
1395 if (ret2)
1396 goto error;
1397 }
1398
1399 ret2 = die_get_varname(die_mem, &buf);
1400
1401 if (!ret2 && probe_conf.show_location_range &&
1402 !externs) {
1403 if (strbuf_addch(&buf, '\t') < 0)
1404 goto error;
1405 ret2 = die_get_var_range(&af->pf.sp_die,
1406 die_mem, &buf);
1407 }
1408
1409 pr_debug("Add new var: %s\n", buf.buf);
1410 if (ret2 == 0) {
1411 strlist__add(vl->vars,
1412 strbuf_detach(&buf, NULL));
1413 }
1414 strbuf_release(&buf);
1415 }
1416 }
1417
1418 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1419 return DIE_FIND_CB_CONTINUE;
1420 else
1421 return DIE_FIND_CB_SIBLING;
1422 error:
1423 strbuf_release(&buf);
1424 pr_debug("Error in strbuf\n");
1425 return DIE_FIND_CB_END;
1426 }
1427
available_var_finder_overlap(struct available_var_finder * af)1428 static bool available_var_finder_overlap(struct available_var_finder *af)
1429 {
1430 int i;
1431
1432 for (i = 0; i < af->nvls; i++) {
1433 if (af->pf.addr == af->vls[i].point.address)
1434 return true;
1435 }
1436 return false;
1437
1438 }
1439
1440 /* Add a found vars into available variables list */
add_available_vars(Dwarf_Die * sc_die,struct probe_finder * pf)1441 static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1442 {
1443 struct available_var_finder *af =
1444 container_of(pf, struct available_var_finder, pf);
1445 struct perf_probe_point *pp = &pf->pev->point;
1446 struct variable_list *vl;
1447 Dwarf_Die die_mem;
1448 int ret;
1449
1450 /*
1451 * For some reason (e.g. different column assigned to same address),
1452 * this callback can be called with the address which already passed.
1453 * Ignore it first.
1454 */
1455 if (available_var_finder_overlap(af))
1456 return 0;
1457
1458 /* Check number of tevs */
1459 if (af->nvls == af->max_vls) {
1460 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1461 return -ERANGE;
1462 }
1463 vl = &af->vls[af->nvls++];
1464
1465 /* Trace point should be converted from subprogram DIE */
1466 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1467 pp->retprobe, pp->function, &vl->point);
1468 if (ret < 0)
1469 return ret;
1470
1471 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1472 vl->point.offset);
1473
1474 /* Find local variables */
1475 vl->vars = strlist__new(NULL, NULL);
1476 if (vl->vars == NULL)
1477 return -ENOMEM;
1478 af->child = true;
1479 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1480
1481 /* Find external variables */
1482 if (!probe_conf.show_ext_vars)
1483 goto out;
1484 /* Don't need to search child DIE for external vars. */
1485 af->child = false;
1486 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1487
1488 out:
1489 if (strlist__empty(vl->vars)) {
1490 strlist__delete(vl->vars);
1491 vl->vars = NULL;
1492 }
1493
1494 return ret;
1495 }
1496
1497 /*
1498 * Find available variables at given probe point
1499 * Return the number of found probe points. Return 0 if there is no
1500 * matched probe point. Return <0 if an error occurs.
1501 */
debuginfo__find_available_vars_at(struct debuginfo * dbg,struct perf_probe_event * pev,struct variable_list ** vls)1502 int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1503 struct perf_probe_event *pev,
1504 struct variable_list **vls)
1505 {
1506 struct available_var_finder af = {
1507 .pf = {.pev = pev, .callback = add_available_vars},
1508 .mod = dbg->mod,
1509 .max_vls = probe_conf.max_probes};
1510 int ret;
1511
1512 /* Allocate result vls array */
1513 *vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1514 if (*vls == NULL)
1515 return -ENOMEM;
1516
1517 af.vls = *vls;
1518 af.nvls = 0;
1519
1520 ret = debuginfo__find_probes(dbg, &af.pf);
1521 if (ret < 0) {
1522 /* Free vlist for error */
1523 while (af.nvls--) {
1524 zfree(&af.vls[af.nvls].point.symbol);
1525 strlist__delete(af.vls[af.nvls].vars);
1526 }
1527 zfree(vls);
1528 return ret;
1529 }
1530
1531 return (ret < 0) ? ret : af.nvls;
1532 }
1533
1534 /* For the kernel module, we need a special code to get a DIE */
debuginfo__get_text_offset(struct debuginfo * dbg,Dwarf_Addr * offs,bool adjust_offset)1535 int debuginfo__get_text_offset(struct debuginfo *dbg, Dwarf_Addr *offs,
1536 bool adjust_offset)
1537 {
1538 int n, i;
1539 Elf32_Word shndx;
1540 Elf_Scn *scn;
1541 Elf *elf;
1542 GElf_Shdr mem, *shdr;
1543 const char *p;
1544
1545 elf = dwfl_module_getelf(dbg->mod, &dbg->bias);
1546 if (!elf)
1547 return -EINVAL;
1548
1549 /* Get the number of relocations */
1550 n = dwfl_module_relocations(dbg->mod);
1551 if (n < 0)
1552 return -ENOENT;
1553 /* Search the relocation related .text section */
1554 for (i = 0; i < n; i++) {
1555 p = dwfl_module_relocation_info(dbg->mod, i, &shndx);
1556 if (strcmp(p, ".text") == 0) {
1557 /* OK, get the section header */
1558 scn = elf_getscn(elf, shndx);
1559 if (!scn)
1560 return -ENOENT;
1561 shdr = gelf_getshdr(scn, &mem);
1562 if (!shdr)
1563 return -ENOENT;
1564 *offs = shdr->sh_addr;
1565 if (adjust_offset)
1566 *offs -= shdr->sh_offset;
1567 }
1568 }
1569 return 0;
1570 }
1571
1572 /* Reverse search */
debuginfo__find_probe_point(struct debuginfo * dbg,unsigned long addr,struct perf_probe_point * ppt)1573 int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1574 struct perf_probe_point *ppt)
1575 {
1576 Dwarf_Die cudie, spdie, indie;
1577 Dwarf_Addr _addr = 0, baseaddr = 0;
1578 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1579 int baseline = 0, lineno = 0, ret = 0;
1580
1581 /* We always need to relocate the address for aranges */
1582 if (debuginfo__get_text_offset(dbg, &baseaddr, false) == 0)
1583 addr += baseaddr;
1584 /* Find cu die */
1585 if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
1586 pr_warning("Failed to find debug information for address %lx\n",
1587 addr);
1588 ret = -EINVAL;
1589 goto end;
1590 }
1591
1592 /* Find a corresponding line (filename and lineno) */
1593 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1594 /* Don't care whether it failed or not */
1595
1596 /* Find a corresponding function (name, baseline and baseaddr) */
1597 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1598 /* Get function entry information */
1599 func = basefunc = dwarf_diename(&spdie);
1600 if (!func ||
1601 die_entrypc(&spdie, &baseaddr) != 0 ||
1602 dwarf_decl_line(&spdie, &baseline) != 0) {
1603 lineno = 0;
1604 goto post;
1605 }
1606
1607 fname = dwarf_decl_file(&spdie);
1608 if (addr == (unsigned long)baseaddr) {
1609 /* Function entry - Relative line number is 0 */
1610 lineno = baseline;
1611 goto post;
1612 }
1613
1614 /* Track down the inline functions step by step */
1615 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1616 &indie)) {
1617 /* There is an inline function */
1618 if (die_entrypc(&indie, &_addr) == 0 &&
1619 _addr == addr) {
1620 /*
1621 * addr is at an inline function entry.
1622 * In this case, lineno should be the call-site
1623 * line number. (overwrite lineinfo)
1624 */
1625 lineno = die_get_call_lineno(&indie);
1626 fname = die_get_call_file(&indie);
1627 break;
1628 } else {
1629 /*
1630 * addr is in an inline function body.
1631 * Since lineno points one of the lines
1632 * of the inline function, baseline should
1633 * be the entry line of the inline function.
1634 */
1635 tmp = dwarf_diename(&indie);
1636 if (!tmp ||
1637 dwarf_decl_line(&indie, &baseline) != 0)
1638 break;
1639 func = tmp;
1640 spdie = indie;
1641 }
1642 }
1643 /* Verify the lineno and baseline are in a same file */
1644 tmp = dwarf_decl_file(&spdie);
1645 if (!tmp || strcmp(tmp, fname) != 0)
1646 lineno = 0;
1647 }
1648
1649 post:
1650 /* Make a relative line number or an offset */
1651 if (lineno)
1652 ppt->line = lineno - baseline;
1653 else if (basefunc) {
1654 ppt->offset = addr - (unsigned long)baseaddr;
1655 func = basefunc;
1656 }
1657
1658 /* Duplicate strings */
1659 if (func) {
1660 ppt->function = strdup(func);
1661 if (ppt->function == NULL) {
1662 ret = -ENOMEM;
1663 goto end;
1664 }
1665 }
1666 if (fname) {
1667 ppt->file = strdup(fname);
1668 if (ppt->file == NULL) {
1669 zfree(&ppt->function);
1670 ret = -ENOMEM;
1671 goto end;
1672 }
1673 }
1674 end:
1675 if (ret == 0 && (fname || func))
1676 ret = 1; /* Found a point */
1677 return ret;
1678 }
1679
1680 /* Add a line and store the src path */
line_range_add_line(const char * src,unsigned int lineno,struct line_range * lr)1681 static int line_range_add_line(const char *src, unsigned int lineno,
1682 struct line_range *lr)
1683 {
1684 /* Copy source path */
1685 if (!lr->path) {
1686 lr->path = strdup(src);
1687 if (lr->path == NULL)
1688 return -ENOMEM;
1689 }
1690 return intlist__add(lr->line_list, lineno);
1691 }
1692
line_range_walk_cb(const char * fname,int lineno,Dwarf_Addr addr __maybe_unused,void * data)1693 static int line_range_walk_cb(const char *fname, int lineno,
1694 Dwarf_Addr addr __maybe_unused,
1695 void *data)
1696 {
1697 struct line_finder *lf = data;
1698 int err;
1699
1700 if ((strtailcmp(fname, lf->fname) != 0) ||
1701 (lf->lno_s > lineno || lf->lno_e < lineno))
1702 return 0;
1703
1704 err = line_range_add_line(fname, lineno, lf->lr);
1705 if (err < 0 && err != -EEXIST)
1706 return err;
1707
1708 return 0;
1709 }
1710
1711 /* Find line range from its line number */
find_line_range_by_line(Dwarf_Die * sp_die,struct line_finder * lf)1712 static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1713 {
1714 int ret;
1715
1716 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1717
1718 /* Update status */
1719 if (ret >= 0)
1720 if (!intlist__empty(lf->lr->line_list))
1721 ret = lf->found = 1;
1722 else
1723 ret = 0; /* Lines are not found */
1724 else {
1725 zfree(&lf->lr->path);
1726 }
1727 return ret;
1728 }
1729
line_range_inline_cb(Dwarf_Die * in_die,void * data)1730 static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1731 {
1732 int ret = find_line_range_by_line(in_die, data);
1733
1734 /*
1735 * We have to check all instances of inlined function, because
1736 * some execution paths can be optimized out depends on the
1737 * function argument of instances. However, if an error occurs,
1738 * it should be handled by the caller.
1739 */
1740 return ret < 0 ? ret : 0;
1741 }
1742
1743 /* Search function definition from function name */
line_range_search_cb(Dwarf_Die * sp_die,void * data)1744 static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1745 {
1746 struct dwarf_callback_param *param = data;
1747 struct line_finder *lf = param->data;
1748 struct line_range *lr = lf->lr;
1749
1750 /* Check declared file */
1751 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1752 return DWARF_CB_OK;
1753
1754 if (die_is_func_def(sp_die) &&
1755 die_match_name(sp_die, lr->function)) {
1756 lf->fname = dwarf_decl_file(sp_die);
1757 dwarf_decl_line(sp_die, &lr->offset);
1758 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1759 lf->lno_s = lr->offset + lr->start;
1760 if (lf->lno_s < 0) /* Overflow */
1761 lf->lno_s = INT_MAX;
1762 lf->lno_e = lr->offset + lr->end;
1763 if (lf->lno_e < 0) /* Overflow */
1764 lf->lno_e = INT_MAX;
1765 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1766 lr->start = lf->lno_s;
1767 lr->end = lf->lno_e;
1768 if (!die_is_func_instance(sp_die))
1769 param->retval = die_walk_instances(sp_die,
1770 line_range_inline_cb, lf);
1771 else
1772 param->retval = find_line_range_by_line(sp_die, lf);
1773 return DWARF_CB_ABORT;
1774 }
1775 return DWARF_CB_OK;
1776 }
1777
find_line_range_by_func(struct line_finder * lf)1778 static int find_line_range_by_func(struct line_finder *lf)
1779 {
1780 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1781 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, ¶m, 0);
1782 return param.retval;
1783 }
1784
debuginfo__find_line_range(struct debuginfo * dbg,struct line_range * lr)1785 int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1786 {
1787 struct line_finder lf = {.lr = lr, .found = 0};
1788 int ret = 0;
1789 Dwarf_Off off = 0, noff;
1790 size_t cuhl;
1791 Dwarf_Die *diep;
1792 const char *comp_dir;
1793
1794 /* Fastpath: lookup by function name from .debug_pubnames section */
1795 if (lr->function) {
1796 struct pubname_callback_param pubname_param = {
1797 .function = lr->function, .file = lr->file,
1798 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1799 struct dwarf_callback_param line_range_param = {
1800 .data = (void *)&lf, .retval = 0};
1801
1802 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1803 &pubname_param, 0);
1804 if (pubname_param.found) {
1805 line_range_search_cb(&lf.sp_die, &line_range_param);
1806 if (lf.found)
1807 goto found;
1808 }
1809 }
1810
1811 /* Loop on CUs (Compilation Unit) */
1812 while (!lf.found && ret >= 0) {
1813 if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1814 NULL, NULL, NULL) != 0)
1815 break;
1816
1817 /* Get the DIE(Debugging Information Entry) of this CU */
1818 diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1819 if (!diep)
1820 continue;
1821
1822 /* Check if target file is included. */
1823 if (lr->file)
1824 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1825 else
1826 lf.fname = 0;
1827
1828 if (!lr->file || lf.fname) {
1829 if (lr->function)
1830 ret = find_line_range_by_func(&lf);
1831 else {
1832 lf.lno_s = lr->start;
1833 lf.lno_e = lr->end;
1834 ret = find_line_range_by_line(NULL, &lf);
1835 }
1836 }
1837 off = noff;
1838 }
1839
1840 found:
1841 /* Store comp_dir */
1842 if (lf.found) {
1843 comp_dir = cu_get_comp_dir(&lf.cu_die);
1844 if (comp_dir) {
1845 lr->comp_dir = strdup(comp_dir);
1846 if (!lr->comp_dir)
1847 ret = -ENOMEM;
1848 }
1849 }
1850
1851 pr_debug("path: %s\n", lr->path);
1852 return (ret < 0) ? ret : lf.found;
1853 }
1854
1855 /*
1856 * Find a src file from a DWARF tag path. Prepend optional source path prefix
1857 * and chop off leading directories that do not exist. Result is passed back as
1858 * a newly allocated path on success.
1859 * Return 0 if file was found and readable, -errno otherwise.
1860 */
get_real_path(const char * raw_path,const char * comp_dir,char ** new_path)1861 int get_real_path(const char *raw_path, const char *comp_dir,
1862 char **new_path)
1863 {
1864 const char *prefix = symbol_conf.source_prefix;
1865
1866 if (!prefix) {
1867 if (raw_path[0] != '/' && comp_dir)
1868 /* If not an absolute path, try to use comp_dir */
1869 prefix = comp_dir;
1870 else {
1871 if (access(raw_path, R_OK) == 0) {
1872 *new_path = strdup(raw_path);
1873 return *new_path ? 0 : -ENOMEM;
1874 } else
1875 return -errno;
1876 }
1877 }
1878
1879 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
1880 if (!*new_path)
1881 return -ENOMEM;
1882
1883 for (;;) {
1884 sprintf(*new_path, "%s/%s", prefix, raw_path);
1885
1886 if (access(*new_path, R_OK) == 0)
1887 return 0;
1888
1889 if (!symbol_conf.source_prefix) {
1890 /* In case of searching comp_dir, don't retry */
1891 zfree(new_path);
1892 return -errno;
1893 }
1894
1895 switch (errno) {
1896 case ENAMETOOLONG:
1897 case ENOENT:
1898 case EROFS:
1899 case EFAULT:
1900 raw_path = strchr(++raw_path, '/');
1901 if (!raw_path) {
1902 zfree(new_path);
1903 return -ENOENT;
1904 }
1905 continue;
1906
1907 default:
1908 zfree(new_path);
1909 return -errno;
1910 }
1911 }
1912 }
1913