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