Merge branch 'merge' of git://git.kernel.org/pub/scm/linux/kernel/git/benh/powerpc
[deliverable/linux.git] / tools / perf / util / probe-finder.c
CommitLineData
4ea42b18
MH
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 <sys/utsname.h>
23#include <sys/types.h>
24#include <sys/stat.h>
25#include <fcntl.h>
26#include <errno.h>
27#include <stdio.h>
28#include <unistd.h>
29#include <getopt.h>
30#include <stdlib.h>
31#include <string.h>
32#include <stdarg.h>
cd932c59 33#include <dwarf-regs.h>
074fc0e4 34
124bb83c 35#include <linux/bitops.h>
89c69c0e 36#include "event.h"
a15ad2f5 37#include "dso.h"
89c69c0e 38#include "debug.h"
5a62257a 39#include "intlist.h"
074fc0e4 40#include "util.h"
9ed7e1b8 41#include "symbol.h"
4ea42b18
MH
42#include "probe-finder.h"
43
4984912e
MH
44/* Kprobe tracer basic type is up to u64 */
45#define MAX_BASIC_TYPE_BITS 64
46
469b9b88 47/* Dwarf FL wrappers */
469b9b88
MH
48static char *debuginfo_path; /* Currently dummy */
49
50static const Dwfl_Callbacks offline_callbacks = {
51 .find_debuginfo = dwfl_standard_find_debuginfo,
52 .debuginfo_path = &debuginfo_path,
53
54 .section_address = dwfl_offline_section_address,
55
56 /* We use this table for core files too. */
57 .find_elf = dwfl_build_id_find_elf,
58};
59
469b9b88 60/* Get a Dwarf from offline image */
316c7136 61static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
ff741783 62 const char *path)
469b9b88 63{
ff741783 64 int fd;
469b9b88 65
ff741783
MH
66 fd = open(path, O_RDONLY);
67 if (fd < 0)
68 return fd;
469b9b88 69
316c7136
ACM
70 dbg->dwfl = dwfl_begin(&offline_callbacks);
71 if (!dbg->dwfl)
ff741783 72 goto error;
469b9b88 73
316c7136
ACM
74 dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
75 if (!dbg->mod)
469b9b88
MH
76 goto error;
77
316c7136
ACM
78 dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
79 if (!dbg->dbg)
ff741783
MH
80 goto error;
81
82 return 0;
469b9b88 83error:
316c7136
ACM
84 if (dbg->dwfl)
85 dwfl_end(dbg->dwfl);
ff741783
MH
86 else
87 close(fd);
316c7136 88 memset(dbg, 0, sizeof(*dbg));
ff741783
MH
89
90 return -ENOENT;
469b9b88
MH
91}
92
a15ad2f5 93static struct debuginfo *__debuginfo__new(const char *path)
ff741783 94{
316c7136
ACM
95 struct debuginfo *dbg = zalloc(sizeof(*dbg));
96 if (!dbg)
3b4694de
MH
97 return NULL;
98
04662523
ACM
99 if (debuginfo__init_offline_dwarf(dbg, path) < 0)
100 zfree(&dbg);
a15ad2f5
MH
101 if (dbg)
102 pr_debug("Open Debuginfo file: %s\n", path);
316c7136 103 return dbg;
ff741783
MH
104}
105
a15ad2f5
MH
106enum dso_binary_type distro_dwarf_types[] = {
107 DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
108 DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
109 DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
110 DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
111 DSO_BINARY_TYPE__NOT_FOUND,
112};
113
114struct debuginfo *debuginfo__new(const char *path)
115{
116 enum dso_binary_type *type;
117 char buf[PATH_MAX], nil = '\0';
118 struct dso *dso;
119 struct debuginfo *dinfo = NULL;
120
121 /* Try to open distro debuginfo files */
122 dso = dso__new(path);
123 if (!dso)
124 goto out;
125
126 for (type = distro_dwarf_types;
127 !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
128 type++) {
129 if (dso__read_binary_type_filename(dso, *type, &nil,
130 buf, PATH_MAX) < 0)
131 continue;
132 dinfo = __debuginfo__new(buf);
133 }
134 dso__delete(dso);
135
136out:
137 /* if failed to open all distro debuginfo, open given binary */
138 return dinfo ? : __debuginfo__new(path);
139}
140
316c7136 141void debuginfo__delete(struct debuginfo *dbg)
ff741783 142{
316c7136
ACM
143 if (dbg) {
144 if (dbg->dwfl)
145 dwfl_end(dbg->dwfl);
146 free(dbg);
ff741783 147 }
3b4694de 148}
469b9b88 149
4ea42b18
MH
150/*
151 * Probe finder related functions
152 */
153
0e60836b 154static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
b7dcb857 155{
0e60836b
SD
156 struct probe_trace_arg_ref *ref;
157 ref = zalloc(sizeof(struct probe_trace_arg_ref));
b7dcb857
MH
158 if (ref != NULL)
159 ref->offset = offs;
160 return ref;
161}
162
cf6eb489
MH
163/*
164 * Convert a location into trace_arg.
165 * If tvar == NULL, this just checks variable can be converted.
3d918a12
MH
166 * If fentry == true and vr_die is a parameter, do huristic search
167 * for the location fuzzed by function entry mcount.
cf6eb489
MH
168 */
169static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
3d918a12 170 Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
cf6eb489 171 struct probe_trace_arg *tvar)
4ea42b18 172{
b7dcb857 173 Dwarf_Attribute attr;
3d918a12 174 Dwarf_Addr tmp = 0;
b7dcb857
MH
175 Dwarf_Op *op;
176 size_t nops;
804b3606
MH
177 unsigned int regn;
178 Dwarf_Word offs = 0;
4235b045 179 bool ref = false;
4ea42b18 180 const char *regs;
b7dcb857
MH
181 int ret;
182
632941c4
MH
183 if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
184 goto static_var;
185
b7dcb857 186 /* TODO: handle more than 1 exprs */
3d918a12
MH
187 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
188 return -EINVAL; /* Broken DIE ? */
189 if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
190 ret = dwarf_entrypc(sp_die, &tmp);
191 if (ret || addr != tmp ||
192 dwarf_tag(vr_die) != DW_TAG_formal_parameter ||
193 dwarf_highpc(sp_die, &tmp))
194 return -ENOENT;
195 /*
196 * This is fuzzed by fentry mcount. We try to find the
197 * parameter location at the earliest address.
198 */
199 for (addr += 1; addr <= tmp; addr++) {
200 if (dwarf_getlocation_addr(&attr, addr, &op,
201 &nops, 1) > 0)
202 goto found;
203 }
b7dcb857
MH
204 return -ENOENT;
205 }
3d918a12
MH
206found:
207 if (nops == 0)
208 /* TODO: Support const_value */
209 return -ENOENT;
b7dcb857
MH
210
211 if (op->atom == DW_OP_addr) {
632941c4 212static_var:
cf6eb489
MH
213 if (!tvar)
214 return 0;
b7dcb857
MH
215 /* Static variables on memory (not stack), make @varname */
216 ret = strlen(dwarf_diename(vr_die));
217 tvar->value = zalloc(ret + 2);
218 if (tvar->value == NULL)
219 return -ENOMEM;
220 snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
221 tvar->ref = alloc_trace_arg_ref((long)offs);
222 if (tvar->ref == NULL)
223 return -ENOMEM;
224 return 0;
225 }
4ea42b18 226
4ea42b18 227 /* If this is based on frame buffer, set the offset */
804b3606 228 if (op->atom == DW_OP_fbreg) {
cf6eb489 229 if (fb_ops == NULL)
b55a87ad 230 return -ENOTSUP;
4235b045 231 ref = true;
804b3606 232 offs = op->number;
cf6eb489 233 op = &fb_ops[0];
804b3606 234 }
4ea42b18 235
804b3606
MH
236 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
237 regn = op->atom - DW_OP_breg0;
238 offs += op->number;
4235b045 239 ref = true;
804b3606
MH
240 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
241 regn = op->atom - DW_OP_reg0;
242 } else if (op->atom == DW_OP_bregx) {
243 regn = op->number;
244 offs += op->number2;
4235b045 245 ref = true;
804b3606
MH
246 } else if (op->atom == DW_OP_regx) {
247 regn = op->number;
b55a87ad 248 } else {
cf6eb489 249 pr_debug("DW_OP %x is not supported.\n", op->atom);
b55a87ad
MH
250 return -ENOTSUP;
251 }
4ea42b18 252
cf6eb489
MH
253 if (!tvar)
254 return 0;
255
4ea42b18 256 regs = get_arch_regstr(regn);
b55a87ad 257 if (!regs) {
cf6eb489 258 /* This should be a bug in DWARF or this tool */
0e43e5d2
MH
259 pr_warning("Mapping for the register number %u "
260 "missing on this architecture.\n", regn);
b55a87ad
MH
261 return -ERANGE;
262 }
4ea42b18 263
02b95dad
MH
264 tvar->value = strdup(regs);
265 if (tvar->value == NULL)
266 return -ENOMEM;
267
4235b045 268 if (ref) {
b7dcb857 269 tvar->ref = alloc_trace_arg_ref((long)offs);
e334016f
MH
270 if (tvar->ref == NULL)
271 return -ENOMEM;
4235b045 272 }
b55a87ad 273 return 0;
4ea42b18
MH
274}
275
124bb83c
MH
276#define BYTES_TO_BITS(nb) ((nb) * BITS_PER_LONG / sizeof(long))
277
b55a87ad 278static int convert_variable_type(Dwarf_Die *vr_die,
0e60836b 279 struct probe_trace_arg *tvar,
73317b95 280 const char *cast)
4984912e 281{
0e60836b 282 struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
4984912e
MH
283 Dwarf_Die type;
284 char buf[16];
bcfc0821 285 int bsize, boffs, total;
4984912e
MH
286 int ret;
287
73317b95
MH
288 /* TODO: check all types */
289 if (cast && strcmp(cast, "string") != 0) {
290 /* Non string type is OK */
291 tvar->type = strdup(cast);
292 return (tvar->type == NULL) ? -ENOMEM : 0;
293 }
294
bcfc0821
MH
295 bsize = dwarf_bitsize(vr_die);
296 if (bsize > 0) {
124bb83c 297 /* This is a bitfield */
bcfc0821
MH
298 boffs = dwarf_bitoffset(vr_die);
299 total = dwarf_bytesize(vr_die);
300 if (boffs < 0 || total < 0)
301 return -ENOENT;
302 ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
303 BYTES_TO_BITS(total));
124bb83c
MH
304 goto formatted;
305 }
306
b55a87ad
MH
307 if (die_get_real_type(vr_die, &type) == NULL) {
308 pr_warning("Failed to get a type information of %s.\n",
309 dwarf_diename(vr_die));
310 return -ENOENT;
311 }
4984912e 312
b2a3c12b
MH
313 pr_debug("%s type is %s.\n",
314 dwarf_diename(vr_die), dwarf_diename(&type));
315
73317b95
MH
316 if (cast && strcmp(cast, "string") == 0) { /* String type */
317 ret = dwarf_tag(&type);
318 if (ret != DW_TAG_pointer_type &&
319 ret != DW_TAG_array_type) {
320 pr_warning("Failed to cast into string: "
0e43e5d2 321 "%s(%s) is not a pointer nor array.\n",
73317b95
MH
322 dwarf_diename(vr_die), dwarf_diename(&type));
323 return -EINVAL;
324 }
7ce28b5b
HL
325 if (die_get_real_type(&type, &type) == NULL) {
326 pr_warning("Failed to get a type"
327 " information.\n");
328 return -ENOENT;
329 }
73317b95 330 if (ret == DW_TAG_pointer_type) {
73317b95
MH
331 while (*ref_ptr)
332 ref_ptr = &(*ref_ptr)->next;
333 /* Add new reference with offset +0 */
0e60836b 334 *ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
73317b95
MH
335 if (*ref_ptr == NULL) {
336 pr_warning("Out of memory error\n");
337 return -ENOMEM;
338 }
339 }
82175633
MH
340 if (!die_compare_name(&type, "char") &&
341 !die_compare_name(&type, "unsigned char")) {
73317b95 342 pr_warning("Failed to cast into string: "
0e43e5d2 343 "%s is not (unsigned) char *.\n",
73317b95
MH
344 dwarf_diename(vr_die));
345 return -EINVAL;
346 }
347 tvar->type = strdup(cast);
348 return (tvar->type == NULL) ? -ENOMEM : 0;
349 }
350
bcfc0821
MH
351 ret = dwarf_bytesize(&type);
352 if (ret <= 0)
124bb83c
MH
353 /* No size ... try to use default type */
354 return 0;
bcfc0821 355 ret = BYTES_TO_BITS(ret);
4984912e 356
124bb83c
MH
357 /* Check the bitwidth */
358 if (ret > MAX_BASIC_TYPE_BITS) {
359 pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
360 dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
361 ret = MAX_BASIC_TYPE_BITS;
4984912e 362 }
124bb83c
MH
363 ret = snprintf(buf, 16, "%c%d",
364 die_is_signed_type(&type) ? 's' : 'u', ret);
365
366formatted:
367 if (ret < 0 || ret >= 16) {
368 if (ret >= 16)
369 ret = -E2BIG;
370 pr_warning("Failed to convert variable type: %s\n",
371 strerror(-ret));
372 return ret;
373 }
374 tvar->type = strdup(buf);
375 if (tvar->type == NULL)
376 return -ENOMEM;
b55a87ad 377 return 0;
4984912e
MH
378}
379
b55a87ad 380static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
7df2f329 381 struct perf_probe_arg_field *field,
0e60836b 382 struct probe_trace_arg_ref **ref_ptr,
4984912e 383 Dwarf_Die *die_mem)
7df2f329 384{
0e60836b 385 struct probe_trace_arg_ref *ref = *ref_ptr;
7df2f329
MH
386 Dwarf_Die type;
387 Dwarf_Word offs;
b2a3c12b 388 int ret, tag;
7df2f329
MH
389
390 pr_debug("converting %s in %s\n", field->name, varname);
b55a87ad
MH
391 if (die_get_real_type(vr_die, &type) == NULL) {
392 pr_warning("Failed to get the type of %s.\n", varname);
393 return -ENOENT;
394 }
b2a3c12b
MH
395 pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
396 tag = dwarf_tag(&type);
397
398 if (field->name[0] == '[' &&
399 (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
400 if (field->next)
401 /* Save original type for next field */
402 memcpy(die_mem, &type, sizeof(*die_mem));
403 /* Get the type of this array */
404 if (die_get_real_type(&type, &type) == NULL) {
405 pr_warning("Failed to get the type of %s.\n", varname);
406 return -ENOENT;
407 }
408 pr_debug2("Array real type: (%x)\n",
409 (unsigned)dwarf_dieoffset(&type));
410 if (tag == DW_TAG_pointer_type) {
0e60836b 411 ref = zalloc(sizeof(struct probe_trace_arg_ref));
b2a3c12b
MH
412 if (ref == NULL)
413 return -ENOMEM;
414 if (*ref_ptr)
415 (*ref_ptr)->next = ref;
416 else
417 *ref_ptr = ref;
418 }
bcfc0821 419 ref->offset += dwarf_bytesize(&type) * field->index;
b2a3c12b
MH
420 if (!field->next)
421 /* Save vr_die for converting types */
422 memcpy(die_mem, vr_die, sizeof(*die_mem));
423 goto next;
424 } else if (tag == DW_TAG_pointer_type) {
425 /* Check the pointer and dereference */
b55a87ad
MH
426 if (!field->ref) {
427 pr_err("Semantic error: %s must be referred by '->'\n",
428 field->name);
429 return -EINVAL;
430 }
7df2f329 431 /* Get the type pointed by this pointer */
b55a87ad
MH
432 if (die_get_real_type(&type, &type) == NULL) {
433 pr_warning("Failed to get the type of %s.\n", varname);
434 return -ENOENT;
435 }
12e5a7ae 436 /* Verify it is a data structure */
7b0295b3
HL
437 tag = dwarf_tag(&type);
438 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
439 pr_warning("%s is not a data structure nor an union.\n",
440 varname);
b55a87ad
MH
441 return -EINVAL;
442 }
12e5a7ae 443
0e60836b 444 ref = zalloc(sizeof(struct probe_trace_arg_ref));
e334016f
MH
445 if (ref == NULL)
446 return -ENOMEM;
7df2f329
MH
447 if (*ref_ptr)
448 (*ref_ptr)->next = ref;
449 else
450 *ref_ptr = ref;
451 } else {
12e5a7ae 452 /* Verify it is a data structure */
7b0295b3
HL
453 if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
454 pr_warning("%s is not a data structure nor an union.\n",
455 varname);
b55a87ad
MH
456 return -EINVAL;
457 }
b2a3c12b 458 if (field->name[0] == '[') {
0e43e5d2
MH
459 pr_err("Semantic error: %s is not a pointor"
460 " nor array.\n", varname);
b2a3c12b
MH
461 return -EINVAL;
462 }
b55a87ad
MH
463 if (field->ref) {
464 pr_err("Semantic error: %s must be referred by '.'\n",
465 field->name);
466 return -EINVAL;
467 }
468 if (!ref) {
469 pr_warning("Structure on a register is not "
470 "supported yet.\n");
471 return -ENOTSUP;
472 }
7df2f329
MH
473 }
474
b55a87ad 475 if (die_find_member(&type, field->name, die_mem) == NULL) {
9ef0438a 476 pr_warning("%s(type:%s) has no member %s.\n", varname,
b55a87ad
MH
477 dwarf_diename(&type), field->name);
478 return -EINVAL;
479 }
7df2f329
MH
480
481 /* Get the offset of the field */
7b0295b3
HL
482 if (tag == DW_TAG_union_type) {
483 offs = 0;
484 } else {
485 ret = die_get_data_member_location(die_mem, &offs);
486 if (ret < 0) {
487 pr_warning("Failed to get the offset of %s.\n",
488 field->name);
489 return ret;
490 }
b55a87ad 491 }
7df2f329
MH
492 ref->offset += (long)offs;
493
b2a3c12b 494next:
7df2f329
MH
495 /* Converting next field */
496 if (field->next)
b55a87ad 497 return convert_variable_fields(die_mem, field->name,
de1439d8 498 field->next, &ref, die_mem);
b55a87ad
MH
499 else
500 return 0;
7df2f329
MH
501}
502
4ea42b18 503/* Show a variables in kprobe event format */
b55a87ad 504static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
4ea42b18 505{
4984912e 506 Dwarf_Die die_mem;
4ea42b18
MH
507 int ret;
508
b7dcb857
MH
509 pr_debug("Converting variable %s into trace event.\n",
510 dwarf_diename(vr_die));
804b3606 511
cf6eb489 512 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
3d918a12 513 &pf->sp_die, pf->tvar);
0c188a07 514 if (ret == -ENOENT || ret == -EINVAL)
cf6eb489
MH
515 pr_err("Failed to find the location of %s at this address.\n"
516 " Perhaps, it has been optimized out.\n", pf->pvar->var);
517 else if (ret == -ENOTSUP)
518 pr_err("Sorry, we don't support this variable location yet.\n");
0c188a07 519 else if (ret == 0 && pf->pvar->field) {
b55a87ad
MH
520 ret = convert_variable_fields(vr_die, pf->pvar->var,
521 pf->pvar->field, &pf->tvar->ref,
522 &die_mem);
4984912e
MH
523 vr_die = &die_mem;
524 }
73317b95
MH
525 if (ret == 0)
526 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
804b3606 527 /* *expr will be cached in libdw. Don't free it. */
b55a87ad 528 return ret;
4ea42b18
MH
529}
530
221d0611
MH
531/* Find a variable in a scope DIE */
532static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
4ea42b18 533{
f182e3e1 534 Dwarf_Die vr_die;
11a1ca35 535 char buf[32], *ptr;
f182e3e1 536 int ret = 0;
4ea42b18 537
367e94c1
MH
538 if (!is_c_varname(pf->pvar->var)) {
539 /* Copy raw parameters */
540 pf->tvar->value = strdup(pf->pvar->var);
541 if (pf->tvar->value == NULL)
542 return -ENOMEM;
543 if (pf->pvar->type) {
544 pf->tvar->type = strdup(pf->pvar->type);
545 if (pf->tvar->type == NULL)
546 return -ENOMEM;
547 }
548 if (pf->pvar->name) {
549 pf->tvar->name = strdup(pf->pvar->name);
550 if (pf->tvar->name == NULL)
551 return -ENOMEM;
552 } else
553 pf->tvar->name = NULL;
554 return 0;
555 }
556
48481938 557 if (pf->pvar->name)
02b95dad 558 pf->tvar->name = strdup(pf->pvar->name);
48481938 559 else {
02b95dad
MH
560 ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
561 if (ret < 0)
562 return ret;
11a1ca35
MH
563 ptr = strchr(buf, ':'); /* Change type separator to _ */
564 if (ptr)
565 *ptr = '_';
02b95dad 566 pf->tvar->name = strdup(buf);
48481938 567 }
02b95dad
MH
568 if (pf->tvar->name == NULL)
569 return -ENOMEM;
48481938 570
f182e3e1 571 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
b55a87ad 572 /* Search child die for local variables and parameters. */
f182e3e1
MH
573 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
574 /* Search again in global variables */
575 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var, 0, &vr_die))
36d789a4
MH
576 pr_warning("Failed to find '%s' in this function.\n",
577 pf->pvar->var);
f182e3e1 578 ret = -ENOENT;
b7dcb857 579 }
f66fedcb 580 if (ret >= 0)
f182e3e1
MH
581 ret = convert_variable(&vr_die, pf);
582
b7dcb857 583 return ret;
4ea42b18
MH
584}
585
cf6eb489 586/* Convert subprogram DIE to trace point */
576b5237
MH
587static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
588 Dwarf_Addr paddr, bool retprobe,
589 struct probe_trace_point *tp)
4ea42b18 590{
26b79524 591 Dwarf_Addr eaddr, highaddr;
576b5237
MH
592 GElf_Sym sym;
593 const char *symbol;
594
595 /* Verify the address is correct */
596 if (dwarf_entrypc(sp_die, &eaddr) != 0) {
597 pr_warning("Failed to get entry address of %s\n",
598 dwarf_diename(sp_die));
599 return -ENOENT;
600 }
601 if (dwarf_highpc(sp_die, &highaddr) != 0) {
602 pr_warning("Failed to get end address of %s\n",
603 dwarf_diename(sp_die));
604 return -ENOENT;
605 }
606 if (paddr > highaddr) {
607 pr_warning("Offset specified is greater than size of %s\n",
608 dwarf_diename(sp_die));
609 return -EINVAL;
610 }
611
612 /* Get an appropriate symbol from symtab */
613 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
614 if (!symbol) {
615 pr_warning("Failed to find symbol at 0x%lx\n",
616 (unsigned long)paddr);
617 return -ENOENT;
618 }
619 tp->offset = (unsigned long)(paddr - sym.st_value);
fb7345bb 620 tp->address = (unsigned long)paddr;
576b5237
MH
621 tp->symbol = strdup(symbol);
622 if (!tp->symbol)
623 return -ENOMEM;
4235b045 624
04ddd04b 625 /* Return probe must be on the head of a subprogram */
cf6eb489
MH
626 if (retprobe) {
627 if (eaddr != paddr) {
04ddd04b 628 pr_warning("Return probe must be on the head of"
0e43e5d2 629 " a real function.\n");
04ddd04b
MH
630 return -EINVAL;
631 }
cf6eb489 632 tp->retprobe = true;
04ddd04b
MH
633 }
634
cf6eb489
MH
635 return 0;
636}
637
221d0611
MH
638/* Call probe_finder callback with scope DIE */
639static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
cf6eb489 640{
cf6eb489
MH
641 Dwarf_Attribute fb_attr;
642 size_t nops;
643 int ret;
644
221d0611
MH
645 if (!sc_die) {
646 pr_err("Caller must pass a scope DIE. Program error.\n");
647 return -EINVAL;
648 }
649
650 /* If not a real subprogram, find a real one */
0dbb1cac 651 if (!die_is_func_def(sc_die)) {
221d0611 652 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
cf6eb489
MH
653 pr_warning("Failed to find probe point in any "
654 "functions.\n");
655 return -ENOENT;
656 }
221d0611
MH
657 } else
658 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
4ea42b18 659
221d0611
MH
660 /* Get the frame base attribute/ops from subprogram */
661 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
d0cb4260 662 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
a34a9854 663 if (ret <= 0 || nops == 0) {
804b3606 664 pf->fb_ops = NULL;
7752f1b0 665#if _ELFUTILS_PREREQ(0, 142)
a34a9854
MH
666 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
667 pf->cfi != NULL) {
668 Dwarf_Frame *frame;
b55a87ad
MH
669 if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
670 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
0e43e5d2 671 pr_warning("Failed to get call frame on 0x%jx\n",
b55a87ad
MH
672 (uintmax_t)pf->addr);
673 return -ENOENT;
674 }
7752f1b0 675#endif
a34a9854 676 }
804b3606 677
cf6eb489 678 /* Call finder's callback handler */
221d0611 679 ret = pf->callback(sc_die, pf);
804b3606
MH
680
681 /* *pf->fb_ops will be cached in libdw. Don't free it. */
682 pf->fb_ops = NULL;
cf6eb489
MH
683
684 return ret;
4ea42b18
MH
685}
686
221d0611
MH
687struct find_scope_param {
688 const char *function;
689 const char *file;
690 int line;
691 int diff;
692 Dwarf_Die *die_mem;
693 bool found;
694};
695
696static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
697{
698 struct find_scope_param *fsp = data;
699 const char *file;
700 int lno;
701
702 /* Skip if declared file name does not match */
703 if (fsp->file) {
704 file = dwarf_decl_file(fn_die);
705 if (!file || strcmp(fsp->file, file) != 0)
706 return 0;
707 }
708 /* If the function name is given, that's what user expects */
709 if (fsp->function) {
710 if (die_compare_name(fn_die, fsp->function)) {
711 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
712 fsp->found = true;
713 return 1;
714 }
715 } else {
716 /* With the line number, find the nearest declared DIE */
717 dwarf_decl_line(fn_die, &lno);
718 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
719 /* Keep a candidate and continue */
720 fsp->diff = fsp->line - lno;
721 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
722 fsp->found = true;
723 }
724 }
725 return 0;
726}
727
728/* Find an appropriate scope fits to given conditions */
729static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
730{
731 struct find_scope_param fsp = {
732 .function = pf->pev->point.function,
733 .file = pf->fname,
734 .line = pf->lno,
735 .diff = INT_MAX,
736 .die_mem = die_mem,
737 .found = false,
738 };
739
740 cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
741
742 return fsp.found ? die_mem : NULL;
743}
744
4cc9cec6
MH
745static int probe_point_line_walker(const char *fname, int lineno,
746 Dwarf_Addr addr, void *data)
4ea42b18 747{
4cc9cec6 748 struct probe_finder *pf = data;
221d0611 749 Dwarf_Die *sc_die, die_mem;
4cc9cec6 750 int ret;
4ea42b18 751
4cc9cec6
MH
752 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
753 return 0;
4ea42b18 754
4cc9cec6 755 pf->addr = addr;
221d0611
MH
756 sc_die = find_best_scope(pf, &die_mem);
757 if (!sc_die) {
758 pr_warning("Failed to find scope of probe point.\n");
759 return -ENOENT;
760 }
761
762 ret = call_probe_finder(sc_die, pf);
b0ef0732 763
4cc9cec6 764 /* Continue if no error, because the line will be in inline function */
fbee632d 765 return ret < 0 ? ret : 0;
4cc9cec6 766}
804b3606 767
4cc9cec6
MH
768/* Find probe point from its line number */
769static int find_probe_point_by_line(struct probe_finder *pf)
770{
771 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
4ea42b18
MH
772}
773
2a9c8c36 774/* Find lines which match lazy pattern */
5a62257a 775static int find_lazy_match_lines(struct intlist *list,
2a9c8c36
MH
776 const char *fname, const char *pat)
777{
f50c2169
FBH
778 FILE *fp;
779 char *line = NULL;
780 size_t line_len;
781 ssize_t len;
782 int count = 0, linenum = 1;
783
784 fp = fopen(fname, "r");
785 if (!fp) {
786 pr_warning("Failed to open %s: %s\n", fname, strerror(errno));
b448c4b6 787 return -errno;
b55a87ad
MH
788 }
789
f50c2169 790 while ((len = getline(&line, &line_len, fp)) > 0) {
b448c4b6 791
f50c2169
FBH
792 if (line[len - 1] == '\n')
793 line[len - 1] = '\0';
794
795 if (strlazymatch(line, pat)) {
5a62257a 796 intlist__add(list, linenum);
f50c2169 797 count++;
2a9c8c36 798 }
f50c2169 799 linenum++;
2a9c8c36 800 }
f50c2169
FBH
801
802 if (ferror(fp))
803 count = -errno;
804 free(line);
805 fclose(fp);
806
807 if (count == 0)
808 pr_debug("No matched lines found in %s.\n", fname);
809 return count;
2a9c8c36
MH
810}
811
4cc9cec6
MH
812static int probe_point_lazy_walker(const char *fname, int lineno,
813 Dwarf_Addr addr, void *data)
814{
815 struct probe_finder *pf = data;
221d0611 816 Dwarf_Die *sc_die, die_mem;
4cc9cec6
MH
817 int ret;
818
5a62257a 819 if (!intlist__has_entry(pf->lcache, lineno) ||
4cc9cec6
MH
820 strtailcmp(fname, pf->fname) != 0)
821 return 0;
822
823 pr_debug("Probe line found: line:%d addr:0x%llx\n",
824 lineno, (unsigned long long)addr);
825 pf->addr = addr;
221d0611
MH
826 pf->lno = lineno;
827 sc_die = find_best_scope(pf, &die_mem);
828 if (!sc_die) {
829 pr_warning("Failed to find scope of probe point.\n");
830 return -ENOENT;
831 }
832
833 ret = call_probe_finder(sc_die, pf);
4cc9cec6
MH
834
835 /*
836 * Continue if no error, because the lazy pattern will match
837 * to other lines
838 */
5e814dd5 839 return ret < 0 ? ret : 0;
4cc9cec6
MH
840}
841
2a9c8c36 842/* Find probe points from lazy pattern */
b55a87ad 843static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
2a9c8c36 844{
b55a87ad 845 int ret = 0;
2a9c8c36 846
5a62257a 847 if (intlist__empty(pf->lcache)) {
2a9c8c36 848 /* Matching lazy line pattern */
5a62257a 849 ret = find_lazy_match_lines(pf->lcache, pf->fname,
4235b045 850 pf->pev->point.lazy_line);
f50c2169 851 if (ret <= 0)
b55a87ad 852 return ret;
2a9c8c36
MH
853 }
854
4cc9cec6 855 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
2a9c8c36
MH
856}
857
e92b85e1
MH
858static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
859{
db0d2c64 860 struct probe_finder *pf = data;
4235b045 861 struct perf_probe_point *pp = &pf->pev->point;
b55a87ad 862 Dwarf_Addr addr;
db0d2c64 863 int ret;
e92b85e1 864
2a9c8c36 865 if (pp->lazy_line)
db0d2c64 866 ret = find_probe_point_lazy(in_die, pf);
2a9c8c36
MH
867 else {
868 /* Get probe address */
b55a87ad 869 if (dwarf_entrypc(in_die, &addr) != 0) {
0e43e5d2 870 pr_warning("Failed to get entry address of %s.\n",
b55a87ad 871 dwarf_diename(in_die));
db0d2c64 872 return -ENOENT;
b55a87ad
MH
873 }
874 pf->addr = addr;
2a9c8c36
MH
875 pf->addr += pp->offset;
876 pr_debug("found inline addr: 0x%jx\n",
877 (uintmax_t)pf->addr);
878
db0d2c64 879 ret = call_probe_finder(in_die, pf);
2a9c8c36 880 }
e92b85e1 881
db0d2c64 882 return ret;
e92b85e1 883}
804b3606 884
db0d2c64
MH
885/* Callback parameter with return value for libdw */
886struct dwarf_callback_param {
887 void *data;
888 int retval;
889};
890
4ea42b18 891/* Search function from function name */
e92b85e1 892static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
4ea42b18 893{
b55a87ad
MH
894 struct dwarf_callback_param *param = data;
895 struct probe_finder *pf = param->data;
4235b045 896 struct perf_probe_point *pp = &pf->pev->point;
4ea42b18 897
e92b85e1 898 /* Check tag and diename */
0dbb1cac
MH
899 if (!die_is_func_def(sp_die) ||
900 !die_compare_name(sp_die, pp->function))
b55a87ad 901 return DWARF_CB_OK;
e92b85e1 902
7d21635a
MH
903 /* Check declared file */
904 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
905 return DWARF_CB_OK;
906
2a9c8c36 907 pf->fname = dwarf_decl_file(sp_die);
e92b85e1 908 if (pp->line) { /* Function relative line */
e92b85e1
MH
909 dwarf_decl_line(sp_die, &pf->lno);
910 pf->lno += pp->line;
b55a87ad 911 param->retval = find_probe_point_by_line(pf);
e92b85e1
MH
912 } else if (!dwarf_func_inline(sp_die)) {
913 /* Real function */
2a9c8c36 914 if (pp->lazy_line)
b55a87ad 915 param->retval = find_probe_point_lazy(sp_die, pf);
2a9c8c36 916 else {
b55a87ad 917 if (dwarf_entrypc(sp_die, &pf->addr) != 0) {
0e43e5d2
MH
918 pr_warning("Failed to get entry address of "
919 "%s.\n", dwarf_diename(sp_die));
b55a87ad
MH
920 param->retval = -ENOENT;
921 return DWARF_CB_ABORT;
922 }
2a9c8c36
MH
923 pf->addr += pp->offset;
924 /* TODO: Check the address in this function */
cf6eb489 925 param->retval = call_probe_finder(sp_die, pf);
2a9c8c36 926 }
db0d2c64 927 } else
e92b85e1 928 /* Inlined function: search instances */
db0d2c64
MH
929 param->retval = die_walk_instances(sp_die,
930 probe_point_inline_cb, (void *)pf);
e92b85e1 931
b55a87ad 932 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
4ea42b18
MH
933}
934
b55a87ad 935static int find_probe_point_by_func(struct probe_finder *pf)
4ea42b18 936{
b55a87ad
MH
937 struct dwarf_callback_param _param = {.data = (void *)pf,
938 .retval = 0};
939 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
940 return _param.retval;
4ea42b18
MH
941}
942
cd25f8bc
LM
943struct pubname_callback_param {
944 char *function;
945 char *file;
946 Dwarf_Die *cu_die;
947 Dwarf_Die *sp_die;
948 int found;
949};
950
951static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
952{
953 struct pubname_callback_param *param = data;
954
955 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
956 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
957 return DWARF_CB_OK;
958
959 if (die_compare_name(param->sp_die, param->function)) {
960 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
961 return DWARF_CB_OK;
962
963 if (param->file &&
964 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
965 return DWARF_CB_OK;
966
967 param->found = 1;
968 return DWARF_CB_ABORT;
969 }
970 }
971
972 return DWARF_CB_OK;
973}
974
cf6eb489 975/* Find probe points from debuginfo */
316c7136 976static int debuginfo__find_probes(struct debuginfo *dbg,
ff741783 977 struct probe_finder *pf)
4ea42b18 978{
cf6eb489 979 struct perf_probe_point *pp = &pf->pev->point;
804b3606
MH
980 Dwarf_Off off, noff;
981 size_t cuhl;
982 Dwarf_Die *diep;
b55a87ad 983 int ret = 0;
804b3606 984
7752f1b0 985#if _ELFUTILS_PREREQ(0, 142)
a34a9854 986 /* Get the call frame information from this dwarf */
03d89412 987 pf->cfi = dwarf_getcfi_elf(dwarf_getelf(dbg->dbg));
7752f1b0 988#endif
a34a9854 989
804b3606 990 off = 0;
5a62257a
MH
991 pf->lcache = intlist__new(NULL);
992 if (!pf->lcache)
993 return -ENOMEM;
cd25f8bc
LM
994
995 /* Fastpath: lookup by function name from .debug_pubnames section */
996 if (pp->function) {
997 struct pubname_callback_param pubname_param = {
998 .function = pp->function,
999 .file = pp->file,
1000 .cu_die = &pf->cu_die,
1001 .sp_die = &pf->sp_die,
2b348a77 1002 .found = 0,
cd25f8bc
LM
1003 };
1004 struct dwarf_callback_param probe_param = {
1005 .data = pf,
1006 };
1007
316c7136 1008 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
ff741783 1009 &pubname_param, 0);
cd25f8bc
LM
1010 if (pubname_param.found) {
1011 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1012 if (ret)
1013 goto found;
1014 }
1015 }
1016
804b3606 1017 /* Loop on CUs (Compilation Unit) */
316c7136 1018 while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
4ea42b18 1019 /* Get the DIE(Debugging Information Entry) of this CU */
316c7136 1020 diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
804b3606
MH
1021 if (!diep)
1022 continue;
4ea42b18
MH
1023
1024 /* Check if target file is included. */
1025 if (pp->file)
cf6eb489 1026 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
804b3606 1027 else
cf6eb489 1028 pf->fname = NULL;
4ea42b18 1029
cf6eb489 1030 if (!pp->file || pf->fname) {
4ea42b18 1031 if (pp->function)
cf6eb489 1032 ret = find_probe_point_by_func(pf);
2a9c8c36 1033 else if (pp->lazy_line)
cf6eb489 1034 ret = find_probe_point_lazy(NULL, pf);
b0ef0732 1035 else {
cf6eb489
MH
1036 pf->lno = pp->line;
1037 ret = find_probe_point_by_line(pf);
b0ef0732 1038 }
8635bf6e 1039 if (ret < 0)
fbee632d 1040 break;
4ea42b18 1041 }
804b3606 1042 off = noff;
4ea42b18 1043 }
cd25f8bc
LM
1044
1045found:
5a62257a
MH
1046 intlist__delete(pf->lcache);
1047 pf->lcache = NULL;
4ea42b18 1048
cf6eb489
MH
1049 return ret;
1050}
1051
7969ec77
MH
1052struct local_vars_finder {
1053 struct probe_finder *pf;
1054 struct perf_probe_arg *args;
1055 int max_args;
1056 int nargs;
1057 int ret;
1058};
1059
1060/* Collect available variables in this scope */
1061static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1062{
1063 struct local_vars_finder *vf = data;
3d918a12 1064 struct probe_finder *pf = vf->pf;
7969ec77
MH
1065 int tag;
1066
1067 tag = dwarf_tag(die_mem);
1068 if (tag == DW_TAG_formal_parameter ||
1069 tag == DW_TAG_variable) {
1070 if (convert_variable_location(die_mem, vf->pf->addr,
3d918a12
MH
1071 vf->pf->fb_ops, &pf->sp_die,
1072 NULL) == 0) {
7969ec77
MH
1073 vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1074 if (vf->args[vf->nargs].var == NULL) {
1075 vf->ret = -ENOMEM;
1076 return DIE_FIND_CB_END;
1077 }
1078 pr_debug(" %s", vf->args[vf->nargs].var);
1079 vf->nargs++;
1080 }
1081 }
1082
1083 if (dwarf_haspc(die_mem, vf->pf->addr))
1084 return DIE_FIND_CB_CONTINUE;
1085 else
1086 return DIE_FIND_CB_SIBLING;
1087}
1088
1089static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1090 struct perf_probe_arg *args)
1091{
1092 Dwarf_Die die_mem;
1093 int i;
1094 int n = 0;
1095 struct local_vars_finder vf = {.pf = pf, .args = args,
1096 .max_args = MAX_PROBE_ARGS, .ret = 0};
1097
1098 for (i = 0; i < pf->pev->nargs; i++) {
1099 /* var never be NULL */
1100 if (strcmp(pf->pev->args[i].var, "$vars") == 0) {
1101 pr_debug("Expanding $vars into:");
1102 vf.nargs = n;
1103 /* Special local variables */
1104 die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1105 &die_mem);
1106 pr_debug(" (%d)\n", vf.nargs - n);
1107 if (vf.ret < 0)
1108 return vf.ret;
1109 n = vf.nargs;
1110 } else {
1111 /* Copy normal argument */
1112 args[n] = pf->pev->args[i];
1113 n++;
1114 }
1115 }
1116 return n;
1117}
1118
cf6eb489 1119/* Add a found probe point into trace event list */
221d0611 1120static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
cf6eb489
MH
1121{
1122 struct trace_event_finder *tf =
1123 container_of(pf, struct trace_event_finder, pf);
1124 struct probe_trace_event *tev;
7969ec77 1125 struct perf_probe_arg *args;
cf6eb489
MH
1126 int ret, i;
1127
1128 /* Check number of tevs */
1129 if (tf->ntevs == tf->max_tevs) {
1130 pr_warning("Too many( > %d) probe point found.\n",
1131 tf->max_tevs);
1132 return -ERANGE;
1133 }
1134 tev = &tf->tevs[tf->ntevs++];
1135
221d0611 1136 /* Trace point should be converted from subprogram DIE */
576b5237 1137 ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
221d0611 1138 pf->pev->point.retprobe, &tev->point);
cf6eb489
MH
1139 if (ret < 0)
1140 return ret;
1141
1142 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1143 tev->point.offset);
1144
7969ec77
MH
1145 /* Expand special probe argument if exist */
1146 args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1147 if (args == NULL)
cf6eb489 1148 return -ENOMEM;
7969ec77
MH
1149
1150 ret = expand_probe_args(sc_die, pf, args);
1151 if (ret < 0)
1152 goto end;
1153
1154 tev->nargs = ret;
1155 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1156 if (tev->args == NULL) {
1157 ret = -ENOMEM;
1158 goto end;
1159 }
1160
1161 /* Find each argument */
1162 for (i = 0; i < tev->nargs; i++) {
1163 pf->pvar = &args[i];
cf6eb489 1164 pf->tvar = &tev->args[i];
221d0611
MH
1165 /* Variable should be found from scope DIE */
1166 ret = find_variable(sc_die, pf);
cf6eb489 1167 if (ret != 0)
7969ec77 1168 break;
cf6eb489
MH
1169 }
1170
7969ec77
MH
1171end:
1172 free(args);
1173 return ret;
cf6eb489
MH
1174}
1175
1176/* Find probe_trace_events specified by perf_probe_event from debuginfo */
316c7136 1177int debuginfo__find_trace_events(struct debuginfo *dbg,
ff741783
MH
1178 struct perf_probe_event *pev,
1179 struct probe_trace_event **tevs, int max_tevs)
cf6eb489
MH
1180{
1181 struct trace_event_finder tf = {
1182 .pf = {.pev = pev, .callback = add_probe_trace_event},
316c7136 1183 .mod = dbg->mod, .max_tevs = max_tevs};
cf6eb489
MH
1184 int ret;
1185
1186 /* Allocate result tevs array */
1187 *tevs = zalloc(sizeof(struct probe_trace_event) * max_tevs);
1188 if (*tevs == NULL)
1189 return -ENOMEM;
1190
1191 tf.tevs = *tevs;
1192 tf.ntevs = 0;
1193
316c7136 1194 ret = debuginfo__find_probes(dbg, &tf.pf);
cf6eb489 1195 if (ret < 0) {
04662523 1196 zfree(tevs);
cf6eb489
MH
1197 return ret;
1198 }
1199
1200 return (ret < 0) ? ret : tf.ntevs;
1201}
1202
1203#define MAX_VAR_LEN 64
1204
1205/* Collect available variables in this scope */
1206static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1207{
1208 struct available_var_finder *af = data;
1209 struct variable_list *vl;
1210 char buf[MAX_VAR_LEN];
1211 int tag, ret;
1212
1213 vl = &af->vls[af->nvls - 1];
1214
1215 tag = dwarf_tag(die_mem);
1216 if (tag == DW_TAG_formal_parameter ||
1217 tag == DW_TAG_variable) {
1218 ret = convert_variable_location(die_mem, af->pf.addr,
3d918a12
MH
1219 af->pf.fb_ops, &af->pf.sp_die,
1220 NULL);
cf6eb489
MH
1221 if (ret == 0) {
1222 ret = die_get_varname(die_mem, buf, MAX_VAR_LEN);
fb8c5a56 1223 pr_debug2("Add new var: %s\n", buf);
cf6eb489
MH
1224 if (ret > 0)
1225 strlist__add(vl->vars, buf);
1226 }
1227 }
1228
fb8c5a56 1229 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
cf6eb489
MH
1230 return DIE_FIND_CB_CONTINUE;
1231 else
1232 return DIE_FIND_CB_SIBLING;
1233}
1234
1235/* Add a found vars into available variables list */
221d0611 1236static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
cf6eb489
MH
1237{
1238 struct available_var_finder *af =
1239 container_of(pf, struct available_var_finder, pf);
1240 struct variable_list *vl;
f182e3e1
MH
1241 Dwarf_Die die_mem;
1242 int ret;
cf6eb489
MH
1243
1244 /* Check number of tevs */
1245 if (af->nvls == af->max_vls) {
1246 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1247 return -ERANGE;
1248 }
1249 vl = &af->vls[af->nvls++];
1250
221d0611 1251 /* Trace point should be converted from subprogram DIE */
576b5237 1252 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
221d0611 1253 pf->pev->point.retprobe, &vl->point);
cf6eb489
MH
1254 if (ret < 0)
1255 return ret;
1256
1257 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1258 vl->point.offset);
1259
1260 /* Find local variables */
1261 vl->vars = strlist__new(true, NULL);
1262 if (vl->vars == NULL)
1263 return -ENOMEM;
fb8c5a56 1264 af->child = true;
221d0611 1265 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
cf6eb489 1266
fb8c5a56
MH
1267 /* Find external variables */
1268 if (!af->externs)
1269 goto out;
1270 /* Don't need to search child DIE for externs. */
1271 af->child = false;
f182e3e1 1272 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
fb8c5a56
MH
1273
1274out:
cf6eb489
MH
1275 if (strlist__empty(vl->vars)) {
1276 strlist__delete(vl->vars);
1277 vl->vars = NULL;
1278 }
1279
1280 return ret;
1281}
1282
69e96eaa
MH
1283/*
1284 * Find available variables at given probe point
1285 * Return the number of found probe points. Return 0 if there is no
1286 * matched probe point. Return <0 if an error occurs.
1287 */
316c7136 1288int debuginfo__find_available_vars_at(struct debuginfo *dbg,
ff741783
MH
1289 struct perf_probe_event *pev,
1290 struct variable_list **vls,
1291 int max_vls, bool externs)
cf6eb489
MH
1292{
1293 struct available_var_finder af = {
1294 .pf = {.pev = pev, .callback = add_available_vars},
316c7136 1295 .mod = dbg->mod,
fb8c5a56 1296 .max_vls = max_vls, .externs = externs};
cf6eb489
MH
1297 int ret;
1298
1299 /* Allocate result vls array */
1300 *vls = zalloc(sizeof(struct variable_list) * max_vls);
1301 if (*vls == NULL)
1302 return -ENOMEM;
1303
1304 af.vls = *vls;
1305 af.nvls = 0;
1306
316c7136 1307 ret = debuginfo__find_probes(dbg, &af.pf);
cf6eb489
MH
1308 if (ret < 0) {
1309 /* Free vlist for error */
1310 while (af.nvls--) {
74cf249d 1311 zfree(&af.vls[af.nvls].point.symbol);
f5385650 1312 strlist__delete(af.vls[af.nvls].vars);
cf6eb489 1313 }
04662523 1314 zfree(vls);
cf6eb489
MH
1315 return ret;
1316 }
1317
1318 return (ret < 0) ? ret : af.nvls;
4ea42b18
MH
1319}
1320
fb1587d8 1321/* Reverse search */
316c7136 1322int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
ff741783 1323 struct perf_probe_point *ppt)
fb1587d8
MH
1324{
1325 Dwarf_Die cudie, spdie, indie;
e08cfd4b
MH
1326 Dwarf_Addr _addr = 0, baseaddr = 0;
1327 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1d46ea2a 1328 int baseline = 0, lineno = 0, ret = 0;
fb1587d8 1329
469b9b88 1330 /* Adjust address with bias */
316c7136 1331 addr += dbg->bias;
ff741783 1332
fb1587d8 1333 /* Find cu die */
316c7136 1334 if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr - dbg->bias, &cudie)) {
0e43e5d2
MH
1335 pr_warning("Failed to find debug information for address %lx\n",
1336 addr);
75ec5a24
MH
1337 ret = -EINVAL;
1338 goto end;
1339 }
fb1587d8 1340
1d46ea2a
MH
1341 /* Find a corresponding line (filename and lineno) */
1342 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1343 /* Don't care whether it failed or not */
fb1587d8 1344
1d46ea2a 1345 /* Find a corresponding function (name, baseline and baseaddr) */
e0d153c6 1346 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1d46ea2a 1347 /* Get function entry information */
e08cfd4b
MH
1348 func = basefunc = dwarf_diename(&spdie);
1349 if (!func ||
1d46ea2a 1350 dwarf_entrypc(&spdie, &baseaddr) != 0 ||
e08cfd4b
MH
1351 dwarf_decl_line(&spdie, &baseline) != 0) {
1352 lineno = 0;
1d46ea2a 1353 goto post;
e08cfd4b 1354 }
1d46ea2a 1355
1b286bdd 1356 fname = dwarf_decl_file(&spdie);
e08cfd4b 1357 if (addr == (unsigned long)baseaddr) {
1d46ea2a
MH
1358 /* Function entry - Relative line number is 0 */
1359 lineno = baseline;
e08cfd4b
MH
1360 goto post;
1361 }
1362
1363 /* Track down the inline functions step by step */
1364 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1365 &indie)) {
1366 /* There is an inline function */
1d46ea2a 1367 if (dwarf_entrypc(&indie, &_addr) == 0 &&
e08cfd4b 1368 _addr == addr) {
1d46ea2a
MH
1369 /*
1370 * addr is at an inline function entry.
1371 * In this case, lineno should be the call-site
e08cfd4b 1372 * line number. (overwrite lineinfo)
1d46ea2a
MH
1373 */
1374 lineno = die_get_call_lineno(&indie);
e08cfd4b
MH
1375 fname = die_get_call_file(&indie);
1376 break;
1377 } else {
1d46ea2a
MH
1378 /*
1379 * addr is in an inline function body.
1380 * Since lineno points one of the lines
1381 * of the inline function, baseline should
1382 * be the entry line of the inline function.
1383 */
b55a87ad 1384 tmp = dwarf_diename(&indie);
e08cfd4b
MH
1385 if (!tmp ||
1386 dwarf_decl_line(&indie, &baseline) != 0)
1387 break;
1388 func = tmp;
1389 spdie = indie;
b55a87ad 1390 }
fb1587d8 1391 }
e08cfd4b
MH
1392 /* Verify the lineno and baseline are in a same file */
1393 tmp = dwarf_decl_file(&spdie);
1394 if (!tmp || strcmp(tmp, fname) != 0)
1395 lineno = 0;
1d46ea2a
MH
1396 }
1397
1398post:
1399 /* Make a relative line number or an offset */
1400 if (lineno)
1401 ppt->line = lineno - baseline;
e08cfd4b 1402 else if (basefunc) {
1d46ea2a 1403 ppt->offset = addr - (unsigned long)baseaddr;
e08cfd4b
MH
1404 func = basefunc;
1405 }
1d46ea2a
MH
1406
1407 /* Duplicate strings */
1408 if (func) {
1409 ppt->function = strdup(func);
02b95dad
MH
1410 if (ppt->function == NULL) {
1411 ret = -ENOMEM;
1412 goto end;
1413 }
fb1587d8 1414 }
1d46ea2a
MH
1415 if (fname) {
1416 ppt->file = strdup(fname);
1417 if (ppt->file == NULL) {
04662523 1418 zfree(&ppt->function);
1d46ea2a
MH
1419 ret = -ENOMEM;
1420 goto end;
1421 }
1422 }
fb1587d8 1423end:
1d46ea2a
MH
1424 if (ret == 0 && (fname || func))
1425 ret = 1; /* Found a point */
fb1587d8
MH
1426 return ret;
1427}
1428
f6c903f5
MH
1429/* Add a line and store the src path */
1430static int line_range_add_line(const char *src, unsigned int lineno,
1431 struct line_range *lr)
1432{
7cf0b79e 1433 /* Copy source path */
f6c903f5 1434 if (!lr->path) {
7cf0b79e
MH
1435 lr->path = strdup(src);
1436 if (lr->path == NULL)
1437 return -ENOMEM;
f6c903f5 1438 }
5a62257a 1439 return intlist__add(lr->line_list, lineno);
f6c903f5
MH
1440}
1441
4cc9cec6 1442static int line_range_walk_cb(const char *fname, int lineno,
1d037ca1 1443 Dwarf_Addr addr __maybe_unused,
4cc9cec6 1444 void *data)
f6c903f5 1445{
4cc9cec6 1446 struct line_finder *lf = data;
202c7c12 1447 int err;
f6c903f5 1448
4cc9cec6 1449 if ((strtailcmp(fname, lf->fname) != 0) ||
f6c903f5 1450 (lf->lno_s > lineno || lf->lno_e < lineno))
4cc9cec6 1451 return 0;
f6c903f5 1452
202c7c12
NK
1453 err = line_range_add_line(fname, lineno, lf->lr);
1454 if (err < 0 && err != -EEXIST)
1455 return err;
f6c903f5 1456
4cc9cec6 1457 return 0;
f6c903f5 1458}
fb1587d8 1459
631c9def 1460/* Find line range from its line number */
b55a87ad 1461static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
631c9def 1462{
4cc9cec6 1463 int ret;
f6c903f5 1464
4cc9cec6 1465 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
f6c903f5 1466
804b3606 1467 /* Update status */
f6c903f5 1468 if (ret >= 0)
5a62257a 1469 if (!intlist__empty(lf->lr->line_list))
f6c903f5
MH
1470 ret = lf->found = 1;
1471 else
1472 ret = 0; /* Lines are not found */
804b3606 1473 else {
04662523 1474 zfree(&lf->lr->path);
804b3606 1475 }
f6c903f5 1476 return ret;
631c9def
MH
1477}
1478
161a26b0
MH
1479static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1480{
182c228e 1481 int ret = find_line_range_by_line(in_die, data);
36c0c588
MH
1482
1483 /*
1484 * We have to check all instances of inlined function, because
1485 * some execution paths can be optimized out depends on the
182c228e
MH
1486 * function argument of instances. However, if an error occurs,
1487 * it should be handled by the caller.
36c0c588 1488 */
182c228e 1489 return ret < 0 ? ret : 0;
161a26b0
MH
1490}
1491
0dbb1cac 1492/* Search function definition from function name */
e92b85e1 1493static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
631c9def 1494{
b55a87ad
MH
1495 struct dwarf_callback_param *param = data;
1496 struct line_finder *lf = param->data;
631c9def 1497 struct line_range *lr = lf->lr;
631c9def 1498
7d21635a
MH
1499 /* Check declared file */
1500 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1501 return DWARF_CB_OK;
1502
0dbb1cac 1503 if (die_is_func_def(sp_die) &&
82175633 1504 die_compare_name(sp_die, lr->function)) {
e92b85e1
MH
1505 lf->fname = dwarf_decl_file(sp_die);
1506 dwarf_decl_line(sp_die, &lr->offset);
804b3606 1507 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
631c9def 1508 lf->lno_s = lr->offset + lr->start;
d3b63d7a
MH
1509 if (lf->lno_s < 0) /* Overflow */
1510 lf->lno_s = INT_MAX;
1511 lf->lno_e = lr->offset + lr->end;
1512 if (lf->lno_e < 0) /* Overflow */
804b3606 1513 lf->lno_e = INT_MAX;
d3b63d7a 1514 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
631c9def
MH
1515 lr->start = lf->lno_s;
1516 lr->end = lf->lno_e;
db0d2c64
MH
1517 if (dwarf_func_inline(sp_die))
1518 param->retval = die_walk_instances(sp_die,
1519 line_range_inline_cb, lf);
1520 else
b55a87ad
MH
1521 param->retval = find_line_range_by_line(sp_die, lf);
1522 return DWARF_CB_ABORT;
631c9def 1523 }
b55a87ad 1524 return DWARF_CB_OK;
631c9def
MH
1525}
1526
b55a87ad 1527static int find_line_range_by_func(struct line_finder *lf)
631c9def 1528{
b55a87ad
MH
1529 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1530 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
1531 return param.retval;
631c9def
MH
1532}
1533
316c7136 1534int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
631c9def 1535{
804b3606 1536 struct line_finder lf = {.lr = lr, .found = 0};
b55a87ad 1537 int ret = 0;
804b3606
MH
1538 Dwarf_Off off = 0, noff;
1539 size_t cuhl;
1540 Dwarf_Die *diep;
6a330a3c 1541 const char *comp_dir;
804b3606 1542
cd25f8bc
LM
1543 /* Fastpath: lookup by function name from .debug_pubnames section */
1544 if (lr->function) {
1545 struct pubname_callback_param pubname_param = {
1546 .function = lr->function, .file = lr->file,
1547 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1548 struct dwarf_callback_param line_range_param = {
1549 .data = (void *)&lf, .retval = 0};
1550
316c7136 1551 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
ff741783 1552 &pubname_param, 0);
cd25f8bc
LM
1553 if (pubname_param.found) {
1554 line_range_search_cb(&lf.sp_die, &line_range_param);
1555 if (lf.found)
1556 goto found;
1557 }
1558 }
1559
804b3606 1560 /* Loop on CUs (Compilation Unit) */
b55a87ad 1561 while (!lf.found && ret >= 0) {
316c7136 1562 if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
ff741783 1563 NULL, NULL, NULL) != 0)
631c9def
MH
1564 break;
1565
1566 /* Get the DIE(Debugging Information Entry) of this CU */
316c7136 1567 diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
804b3606
MH
1568 if (!diep)
1569 continue;
631c9def
MH
1570
1571 /* Check if target file is included. */
1572 if (lr->file)
2a9c8c36 1573 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
804b3606 1574 else
2a9c8c36 1575 lf.fname = 0;
631c9def 1576
2a9c8c36 1577 if (!lr->file || lf.fname) {
631c9def 1578 if (lr->function)
b55a87ad 1579 ret = find_line_range_by_func(&lf);
631c9def
MH
1580 else {
1581 lf.lno_s = lr->start;
d3b63d7a 1582 lf.lno_e = lr->end;
b55a87ad 1583 ret = find_line_range_by_line(NULL, &lf);
631c9def 1584 }
631c9def 1585 }
804b3606 1586 off = noff;
631c9def 1587 }
6a330a3c 1588
cd25f8bc 1589found:
6a330a3c
MH
1590 /* Store comp_dir */
1591 if (lf.found) {
1592 comp_dir = cu_get_comp_dir(&lf.cu_die);
1593 if (comp_dir) {
1594 lr->comp_dir = strdup(comp_dir);
1595 if (!lr->comp_dir)
1596 ret = -ENOMEM;
1597 }
1598 }
1599
7cf0b79e 1600 pr_debug("path: %s\n", lr->path);
b55a87ad 1601 return (ret < 0) ? ret : lf.found;
631c9def
MH
1602}
1603
This page took 0.357466 seconds and 5 git commands to generate.