perf probe: Remove length limitation for showing available variables
[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>
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] == '[') {
d939be3a 459 pr_err("Semantic error: %s is not a pointer"
0e43e5d2 460 " nor array.\n", varname);
b2a3c12b
MH
461 return -EINVAL;
462 }
c7273835
MH
463 /* While prcessing unnamed field, we don't care about this */
464 if (field->ref && dwarf_diename(vr_die)) {
b55a87ad
MH
465 pr_err("Semantic error: %s must be referred by '.'\n",
466 field->name);
467 return -EINVAL;
468 }
469 if (!ref) {
470 pr_warning("Structure on a register is not "
471 "supported yet.\n");
472 return -ENOTSUP;
473 }
7df2f329
MH
474 }
475
b55a87ad 476 if (die_find_member(&type, field->name, die_mem) == NULL) {
9ef0438a 477 pr_warning("%s(type:%s) has no member %s.\n", varname,
b55a87ad
MH
478 dwarf_diename(&type), field->name);
479 return -EINVAL;
480 }
7df2f329
MH
481
482 /* Get the offset of the field */
7b0295b3
HL
483 if (tag == DW_TAG_union_type) {
484 offs = 0;
485 } else {
486 ret = die_get_data_member_location(die_mem, &offs);
487 if (ret < 0) {
488 pr_warning("Failed to get the offset of %s.\n",
489 field->name);
490 return ret;
491 }
b55a87ad 492 }
7df2f329
MH
493 ref->offset += (long)offs;
494
c7273835
MH
495 /* If this member is unnamed, we need to reuse this field */
496 if (!dwarf_diename(die_mem))
497 return convert_variable_fields(die_mem, varname, field,
498 &ref, die_mem);
499
b2a3c12b 500next:
7df2f329
MH
501 /* Converting next field */
502 if (field->next)
b55a87ad 503 return convert_variable_fields(die_mem, field->name,
de1439d8 504 field->next, &ref, die_mem);
b55a87ad
MH
505 else
506 return 0;
7df2f329
MH
507}
508
4ea42b18 509/* Show a variables in kprobe event format */
b55a87ad 510static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
4ea42b18 511{
4984912e 512 Dwarf_Die die_mem;
4ea42b18
MH
513 int ret;
514
b7dcb857
MH
515 pr_debug("Converting variable %s into trace event.\n",
516 dwarf_diename(vr_die));
804b3606 517
cf6eb489 518 ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
3d918a12 519 &pf->sp_die, pf->tvar);
0c188a07 520 if (ret == -ENOENT || ret == -EINVAL)
cf6eb489
MH
521 pr_err("Failed to find the location of %s at this address.\n"
522 " Perhaps, it has been optimized out.\n", pf->pvar->var);
523 else if (ret == -ENOTSUP)
524 pr_err("Sorry, we don't support this variable location yet.\n");
0c188a07 525 else if (ret == 0 && pf->pvar->field) {
b55a87ad
MH
526 ret = convert_variable_fields(vr_die, pf->pvar->var,
527 pf->pvar->field, &pf->tvar->ref,
528 &die_mem);
4984912e
MH
529 vr_die = &die_mem;
530 }
73317b95
MH
531 if (ret == 0)
532 ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
804b3606 533 /* *expr will be cached in libdw. Don't free it. */
b55a87ad 534 return ret;
4ea42b18
MH
535}
536
221d0611
MH
537/* Find a variable in a scope DIE */
538static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
4ea42b18 539{
f182e3e1 540 Dwarf_Die vr_die;
11a1ca35 541 char buf[32], *ptr;
f182e3e1 542 int ret = 0;
4ea42b18 543
367e94c1
MH
544 if (!is_c_varname(pf->pvar->var)) {
545 /* Copy raw parameters */
546 pf->tvar->value = strdup(pf->pvar->var);
547 if (pf->tvar->value == NULL)
548 return -ENOMEM;
549 if (pf->pvar->type) {
550 pf->tvar->type = strdup(pf->pvar->type);
551 if (pf->tvar->type == NULL)
552 return -ENOMEM;
553 }
554 if (pf->pvar->name) {
555 pf->tvar->name = strdup(pf->pvar->name);
556 if (pf->tvar->name == NULL)
557 return -ENOMEM;
558 } else
559 pf->tvar->name = NULL;
560 return 0;
561 }
562
48481938 563 if (pf->pvar->name)
02b95dad 564 pf->tvar->name = strdup(pf->pvar->name);
48481938 565 else {
02b95dad
MH
566 ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
567 if (ret < 0)
568 return ret;
11a1ca35
MH
569 ptr = strchr(buf, ':'); /* Change type separator to _ */
570 if (ptr)
571 *ptr = '_';
02b95dad 572 pf->tvar->name = strdup(buf);
48481938 573 }
02b95dad
MH
574 if (pf->tvar->name == NULL)
575 return -ENOMEM;
48481938 576
f182e3e1 577 pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
b55a87ad 578 /* Search child die for local variables and parameters. */
f182e3e1
MH
579 if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
580 /* Search again in global variables */
d13855ef
HK
581 if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
582 0, &vr_die)) {
36d789a4
MH
583 pr_warning("Failed to find '%s' in this function.\n",
584 pf->pvar->var);
f182e3e1 585 ret = -ENOENT;
d13855ef 586 }
b7dcb857 587 }
f66fedcb 588 if (ret >= 0)
f182e3e1
MH
589 ret = convert_variable(&vr_die, pf);
590
b7dcb857 591 return ret;
4ea42b18
MH
592}
593
cf6eb489 594/* Convert subprogram DIE to trace point */
576b5237
MH
595static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
596 Dwarf_Addr paddr, bool retprobe,
597 struct probe_trace_point *tp)
4ea42b18 598{
26b79524 599 Dwarf_Addr eaddr, highaddr;
576b5237
MH
600 GElf_Sym sym;
601 const char *symbol;
602
603 /* Verify the address is correct */
604 if (dwarf_entrypc(sp_die, &eaddr) != 0) {
605 pr_warning("Failed to get entry address of %s\n",
606 dwarf_diename(sp_die));
607 return -ENOENT;
608 }
609 if (dwarf_highpc(sp_die, &highaddr) != 0) {
610 pr_warning("Failed to get end address of %s\n",
611 dwarf_diename(sp_die));
612 return -ENOENT;
613 }
614 if (paddr > highaddr) {
615 pr_warning("Offset specified is greater than size of %s\n",
616 dwarf_diename(sp_die));
617 return -EINVAL;
618 }
619
664fee3d 620 symbol = dwarf_diename(sp_die);
576b5237 621 if (!symbol) {
664fee3d
MH
622 /* Try to get the symbol name from symtab */
623 symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
624 if (!symbol) {
625 pr_warning("Failed to find symbol at 0x%lx\n",
626 (unsigned long)paddr);
627 return -ENOENT;
628 }
629 eaddr = sym.st_value;
576b5237 630 }
664fee3d 631 tp->offset = (unsigned long)(paddr - eaddr);
fb7345bb 632 tp->address = (unsigned long)paddr;
576b5237
MH
633 tp->symbol = strdup(symbol);
634 if (!tp->symbol)
635 return -ENOMEM;
4235b045 636
04ddd04b 637 /* Return probe must be on the head of a subprogram */
cf6eb489
MH
638 if (retprobe) {
639 if (eaddr != paddr) {
04ddd04b 640 pr_warning("Return probe must be on the head of"
0e43e5d2 641 " a real function.\n");
04ddd04b
MH
642 return -EINVAL;
643 }
cf6eb489 644 tp->retprobe = true;
04ddd04b
MH
645 }
646
cf6eb489
MH
647 return 0;
648}
649
221d0611
MH
650/* Call probe_finder callback with scope DIE */
651static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
cf6eb489 652{
cf6eb489
MH
653 Dwarf_Attribute fb_attr;
654 size_t nops;
655 int ret;
656
221d0611
MH
657 if (!sc_die) {
658 pr_err("Caller must pass a scope DIE. Program error.\n");
659 return -EINVAL;
660 }
661
662 /* If not a real subprogram, find a real one */
0dbb1cac 663 if (!die_is_func_def(sc_die)) {
221d0611 664 if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
cf6eb489
MH
665 pr_warning("Failed to find probe point in any "
666 "functions.\n");
667 return -ENOENT;
668 }
221d0611
MH
669 } else
670 memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
4ea42b18 671
221d0611
MH
672 /* Get the frame base attribute/ops from subprogram */
673 dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
d0cb4260 674 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
a34a9854 675 if (ret <= 0 || nops == 0) {
804b3606 676 pf->fb_ops = NULL;
7752f1b0 677#if _ELFUTILS_PREREQ(0, 142)
a34a9854
MH
678 } else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
679 pf->cfi != NULL) {
680 Dwarf_Frame *frame;
b55a87ad
MH
681 if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
682 dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
0e43e5d2 683 pr_warning("Failed to get call frame on 0x%jx\n",
b55a87ad
MH
684 (uintmax_t)pf->addr);
685 return -ENOENT;
686 }
7752f1b0 687#endif
a34a9854 688 }
804b3606 689
cf6eb489 690 /* Call finder's callback handler */
221d0611 691 ret = pf->callback(sc_die, pf);
804b3606
MH
692
693 /* *pf->fb_ops will be cached in libdw. Don't free it. */
694 pf->fb_ops = NULL;
cf6eb489
MH
695
696 return ret;
4ea42b18
MH
697}
698
221d0611
MH
699struct find_scope_param {
700 const char *function;
701 const char *file;
702 int line;
703 int diff;
704 Dwarf_Die *die_mem;
705 bool found;
706};
707
708static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
709{
710 struct find_scope_param *fsp = data;
711 const char *file;
712 int lno;
713
714 /* Skip if declared file name does not match */
715 if (fsp->file) {
716 file = dwarf_decl_file(fn_die);
717 if (!file || strcmp(fsp->file, file) != 0)
718 return 0;
719 }
720 /* If the function name is given, that's what user expects */
721 if (fsp->function) {
4c859351 722 if (die_match_name(fn_die, fsp->function)) {
221d0611
MH
723 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
724 fsp->found = true;
725 return 1;
726 }
727 } else {
728 /* With the line number, find the nearest declared DIE */
729 dwarf_decl_line(fn_die, &lno);
730 if (lno < fsp->line && fsp->diff > fsp->line - lno) {
731 /* Keep a candidate and continue */
732 fsp->diff = fsp->line - lno;
733 memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
734 fsp->found = true;
735 }
736 }
737 return 0;
738}
739
740/* Find an appropriate scope fits to given conditions */
741static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
742{
743 struct find_scope_param fsp = {
744 .function = pf->pev->point.function,
745 .file = pf->fname,
746 .line = pf->lno,
747 .diff = INT_MAX,
748 .die_mem = die_mem,
749 .found = false,
750 };
751
752 cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
753
754 return fsp.found ? die_mem : NULL;
755}
756
4cc9cec6
MH
757static int probe_point_line_walker(const char *fname, int lineno,
758 Dwarf_Addr addr, void *data)
4ea42b18 759{
4cc9cec6 760 struct probe_finder *pf = data;
221d0611 761 Dwarf_Die *sc_die, die_mem;
4cc9cec6 762 int ret;
4ea42b18 763
4cc9cec6
MH
764 if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
765 return 0;
4ea42b18 766
4cc9cec6 767 pf->addr = addr;
221d0611
MH
768 sc_die = find_best_scope(pf, &die_mem);
769 if (!sc_die) {
770 pr_warning("Failed to find scope of probe point.\n");
771 return -ENOENT;
772 }
773
774 ret = call_probe_finder(sc_die, pf);
b0ef0732 775
4cc9cec6 776 /* Continue if no error, because the line will be in inline function */
fbee632d 777 return ret < 0 ? ret : 0;
4cc9cec6 778}
804b3606 779
4cc9cec6
MH
780/* Find probe point from its line number */
781static int find_probe_point_by_line(struct probe_finder *pf)
782{
783 return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
4ea42b18
MH
784}
785
2a9c8c36 786/* Find lines which match lazy pattern */
5a62257a 787static int find_lazy_match_lines(struct intlist *list,
2a9c8c36
MH
788 const char *fname, const char *pat)
789{
f50c2169
FBH
790 FILE *fp;
791 char *line = NULL;
792 size_t line_len;
793 ssize_t len;
794 int count = 0, linenum = 1;
5f03cba4 795 char sbuf[STRERR_BUFSIZE];
f50c2169
FBH
796
797 fp = fopen(fname, "r");
798 if (!fp) {
5f03cba4
MH
799 pr_warning("Failed to open %s: %s\n", fname,
800 strerror_r(errno, sbuf, sizeof(sbuf)));
b448c4b6 801 return -errno;
b55a87ad
MH
802 }
803
f50c2169 804 while ((len = getline(&line, &line_len, fp)) > 0) {
b448c4b6 805
f50c2169
FBH
806 if (line[len - 1] == '\n')
807 line[len - 1] = '\0';
808
809 if (strlazymatch(line, pat)) {
5a62257a 810 intlist__add(list, linenum);
f50c2169 811 count++;
2a9c8c36 812 }
f50c2169 813 linenum++;
2a9c8c36 814 }
f50c2169
FBH
815
816 if (ferror(fp))
817 count = -errno;
818 free(line);
819 fclose(fp);
820
821 if (count == 0)
822 pr_debug("No matched lines found in %s.\n", fname);
823 return count;
2a9c8c36
MH
824}
825
4cc9cec6
MH
826static int probe_point_lazy_walker(const char *fname, int lineno,
827 Dwarf_Addr addr, void *data)
828{
829 struct probe_finder *pf = data;
221d0611 830 Dwarf_Die *sc_die, die_mem;
4cc9cec6
MH
831 int ret;
832
5a62257a 833 if (!intlist__has_entry(pf->lcache, lineno) ||
4cc9cec6
MH
834 strtailcmp(fname, pf->fname) != 0)
835 return 0;
836
837 pr_debug("Probe line found: line:%d addr:0x%llx\n",
838 lineno, (unsigned long long)addr);
839 pf->addr = addr;
221d0611
MH
840 pf->lno = lineno;
841 sc_die = find_best_scope(pf, &die_mem);
842 if (!sc_die) {
843 pr_warning("Failed to find scope of probe point.\n");
844 return -ENOENT;
845 }
846
847 ret = call_probe_finder(sc_die, pf);
4cc9cec6
MH
848
849 /*
850 * Continue if no error, because the lazy pattern will match
851 * to other lines
852 */
5e814dd5 853 return ret < 0 ? ret : 0;
4cc9cec6
MH
854}
855
2a9c8c36 856/* Find probe points from lazy pattern */
b55a87ad 857static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
2a9c8c36 858{
b55a87ad 859 int ret = 0;
09ed8975 860 char *fpath;
2a9c8c36 861
5a62257a 862 if (intlist__empty(pf->lcache)) {
09ed8975
NA
863 const char *comp_dir;
864
865 comp_dir = cu_get_comp_dir(&pf->cu_die);
866 ret = get_real_path(pf->fname, comp_dir, &fpath);
867 if (ret < 0) {
868 pr_warning("Failed to find source file path.\n");
869 return ret;
870 }
871
2a9c8c36 872 /* Matching lazy line pattern */
09ed8975 873 ret = find_lazy_match_lines(pf->lcache, fpath,
4235b045 874 pf->pev->point.lazy_line);
09ed8975 875 free(fpath);
f50c2169 876 if (ret <= 0)
b55a87ad 877 return ret;
2a9c8c36
MH
878 }
879
4cc9cec6 880 return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
2a9c8c36
MH
881}
882
e92b85e1
MH
883static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
884{
db0d2c64 885 struct probe_finder *pf = data;
4235b045 886 struct perf_probe_point *pp = &pf->pev->point;
b55a87ad 887 Dwarf_Addr addr;
db0d2c64 888 int ret;
e92b85e1 889
2a9c8c36 890 if (pp->lazy_line)
db0d2c64 891 ret = find_probe_point_lazy(in_die, pf);
2a9c8c36
MH
892 else {
893 /* Get probe address */
b55a87ad 894 if (dwarf_entrypc(in_die, &addr) != 0) {
0e43e5d2 895 pr_warning("Failed to get entry address of %s.\n",
b55a87ad 896 dwarf_diename(in_die));
db0d2c64 897 return -ENOENT;
b55a87ad
MH
898 }
899 pf->addr = addr;
2a9c8c36
MH
900 pf->addr += pp->offset;
901 pr_debug("found inline addr: 0x%jx\n",
902 (uintmax_t)pf->addr);
903
db0d2c64 904 ret = call_probe_finder(in_die, pf);
2a9c8c36 905 }
e92b85e1 906
db0d2c64 907 return ret;
e92b85e1 908}
804b3606 909
db0d2c64
MH
910/* Callback parameter with return value for libdw */
911struct dwarf_callback_param {
912 void *data;
913 int retval;
914};
915
4ea42b18 916/* Search function from function name */
e92b85e1 917static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
4ea42b18 918{
b55a87ad
MH
919 struct dwarf_callback_param *param = data;
920 struct probe_finder *pf = param->data;
4235b045 921 struct perf_probe_point *pp = &pf->pev->point;
4ea42b18 922
e92b85e1 923 /* Check tag and diename */
0dbb1cac 924 if (!die_is_func_def(sp_die) ||
4c859351 925 !die_match_name(sp_die, pp->function))
b55a87ad 926 return DWARF_CB_OK;
e92b85e1 927
7d21635a
MH
928 /* Check declared file */
929 if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
930 return DWARF_CB_OK;
931
4c859351 932 pr_debug("Matched function: %s\n", dwarf_diename(sp_die));
2a9c8c36 933 pf->fname = dwarf_decl_file(sp_die);
e92b85e1 934 if (pp->line) { /* Function relative line */
e92b85e1
MH
935 dwarf_decl_line(sp_die, &pf->lno);
936 pf->lno += pp->line;
b55a87ad 937 param->retval = find_probe_point_by_line(pf);
e1ecbbc3
MH
938 } else if (die_is_func_instance(sp_die)) {
939 /* Instances always have the entry address */
940 dwarf_entrypc(sp_die, &pf->addr);
e92b85e1 941 /* Real function */
2a9c8c36 942 if (pp->lazy_line)
b55a87ad 943 param->retval = find_probe_point_lazy(sp_die, pf);
2a9c8c36 944 else {
2a9c8c36
MH
945 pf->addr += pp->offset;
946 /* TODO: Check the address in this function */
cf6eb489 947 param->retval = call_probe_finder(sp_die, pf);
2a9c8c36 948 }
4c859351 949 } else if (!probe_conf.no_inlines) {
e92b85e1 950 /* Inlined function: search instances */
db0d2c64
MH
951 param->retval = die_walk_instances(sp_die,
952 probe_point_inline_cb, (void *)pf);
4c859351
MH
953 /* This could be a non-existed inline definition */
954 if (param->retval == -ENOENT && strisglob(pp->function))
955 param->retval = 0;
956 }
957
958 /* We need to find other candidates */
959 if (strisglob(pp->function) && param->retval >= 0) {
960 param->retval = 0; /* We have to clear the result */
961 return DWARF_CB_OK;
962 }
e92b85e1 963
b55a87ad 964 return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
4ea42b18
MH
965}
966
b55a87ad 967static int find_probe_point_by_func(struct probe_finder *pf)
4ea42b18 968{
b55a87ad
MH
969 struct dwarf_callback_param _param = {.data = (void *)pf,
970 .retval = 0};
971 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
972 return _param.retval;
4ea42b18
MH
973}
974
cd25f8bc
LM
975struct pubname_callback_param {
976 char *function;
977 char *file;
978 Dwarf_Die *cu_die;
979 Dwarf_Die *sp_die;
980 int found;
981};
982
983static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
984{
985 struct pubname_callback_param *param = data;
986
987 if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
988 if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
989 return DWARF_CB_OK;
990
4c859351 991 if (die_match_name(param->sp_die, param->function)) {
cd25f8bc
LM
992 if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
993 return DWARF_CB_OK;
994
995 if (param->file &&
996 strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
997 return DWARF_CB_OK;
998
999 param->found = 1;
1000 return DWARF_CB_ABORT;
1001 }
1002 }
1003
1004 return DWARF_CB_OK;
1005}
1006
cf6eb489 1007/* Find probe points from debuginfo */
316c7136 1008static int debuginfo__find_probes(struct debuginfo *dbg,
ff741783 1009 struct probe_finder *pf)
4ea42b18 1010{
cf6eb489 1011 struct perf_probe_point *pp = &pf->pev->point;
804b3606
MH
1012 Dwarf_Off off, noff;
1013 size_t cuhl;
1014 Dwarf_Die *diep;
b55a87ad 1015 int ret = 0;
804b3606 1016
7752f1b0 1017#if _ELFUTILS_PREREQ(0, 142)
4093325f
NK
1018 Elf *elf;
1019 GElf_Ehdr ehdr;
1020 GElf_Shdr shdr;
1021
a34a9854 1022 /* Get the call frame information from this dwarf */
4093325f
NK
1023 elf = dwarf_getelf(dbg->dbg);
1024 if (elf == NULL)
1025 return -EINVAL;
1026
1027 if (gelf_getehdr(elf, &ehdr) == NULL)
1028 return -EINVAL;
1029
1030 if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
1031 shdr.sh_type == SHT_PROGBITS) {
1032 pf->cfi = dwarf_getcfi_elf(elf);
1033 } else {
1034 pf->cfi = dwarf_getcfi(dbg->dbg);
1035 }
7752f1b0 1036#endif
a34a9854 1037
804b3606 1038 off = 0;
5a62257a
MH
1039 pf->lcache = intlist__new(NULL);
1040 if (!pf->lcache)
1041 return -ENOMEM;
cd25f8bc
LM
1042
1043 /* Fastpath: lookup by function name from .debug_pubnames section */
4c859351 1044 if (pp->function && !strisglob(pp->function)) {
cd25f8bc
LM
1045 struct pubname_callback_param pubname_param = {
1046 .function = pp->function,
1047 .file = pp->file,
1048 .cu_die = &pf->cu_die,
1049 .sp_die = &pf->sp_die,
2b348a77 1050 .found = 0,
cd25f8bc
LM
1051 };
1052 struct dwarf_callback_param probe_param = {
1053 .data = pf,
1054 };
1055
316c7136 1056 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
ff741783 1057 &pubname_param, 0);
cd25f8bc
LM
1058 if (pubname_param.found) {
1059 ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1060 if (ret)
1061 goto found;
1062 }
1063 }
1064
804b3606 1065 /* Loop on CUs (Compilation Unit) */
316c7136 1066 while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
4ea42b18 1067 /* Get the DIE(Debugging Information Entry) of this CU */
316c7136 1068 diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
804b3606
MH
1069 if (!diep)
1070 continue;
4ea42b18
MH
1071
1072 /* Check if target file is included. */
1073 if (pp->file)
cf6eb489 1074 pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
804b3606 1075 else
cf6eb489 1076 pf->fname = NULL;
4ea42b18 1077
cf6eb489 1078 if (!pp->file || pf->fname) {
4ea42b18 1079 if (pp->function)
cf6eb489 1080 ret = find_probe_point_by_func(pf);
2a9c8c36 1081 else if (pp->lazy_line)
f19e80c6 1082 ret = find_probe_point_lazy(&pf->cu_die, pf);
b0ef0732 1083 else {
cf6eb489
MH
1084 pf->lno = pp->line;
1085 ret = find_probe_point_by_line(pf);
b0ef0732 1086 }
8635bf6e 1087 if (ret < 0)
fbee632d 1088 break;
4ea42b18 1089 }
804b3606 1090 off = noff;
4ea42b18 1091 }
cd25f8bc
LM
1092
1093found:
5a62257a
MH
1094 intlist__delete(pf->lcache);
1095 pf->lcache = NULL;
4ea42b18 1096
cf6eb489
MH
1097 return ret;
1098}
1099
7969ec77
MH
1100struct local_vars_finder {
1101 struct probe_finder *pf;
1102 struct perf_probe_arg *args;
f8bffbf1 1103 bool vars;
7969ec77
MH
1104 int max_args;
1105 int nargs;
1106 int ret;
1107};
1108
1109/* Collect available variables in this scope */
1110static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1111{
1112 struct local_vars_finder *vf = data;
3d918a12 1113 struct probe_finder *pf = vf->pf;
7969ec77
MH
1114 int tag;
1115
1116 tag = dwarf_tag(die_mem);
1117 if (tag == DW_TAG_formal_parameter ||
f8bffbf1 1118 (tag == DW_TAG_variable && vf->vars)) {
7969ec77 1119 if (convert_variable_location(die_mem, vf->pf->addr,
3d918a12
MH
1120 vf->pf->fb_ops, &pf->sp_die,
1121 NULL) == 0) {
7969ec77
MH
1122 vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1123 if (vf->args[vf->nargs].var == NULL) {
1124 vf->ret = -ENOMEM;
1125 return DIE_FIND_CB_END;
1126 }
1127 pr_debug(" %s", vf->args[vf->nargs].var);
1128 vf->nargs++;
1129 }
1130 }
1131
1132 if (dwarf_haspc(die_mem, vf->pf->addr))
1133 return DIE_FIND_CB_CONTINUE;
1134 else
1135 return DIE_FIND_CB_SIBLING;
1136}
1137
1138static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1139 struct perf_probe_arg *args)
1140{
1141 Dwarf_Die die_mem;
1142 int i;
1143 int n = 0;
f8bffbf1 1144 struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
7969ec77
MH
1145 .max_args = MAX_PROBE_ARGS, .ret = 0};
1146
1147 for (i = 0; i < pf->pev->nargs; i++) {
1148 /* var never be NULL */
f8bffbf1
MH
1149 if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
1150 vf.vars = true;
1151 else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
7969ec77
MH
1152 /* Copy normal argument */
1153 args[n] = pf->pev->args[i];
1154 n++;
f8bffbf1 1155 continue;
7969ec77 1156 }
f8bffbf1
MH
1157 pr_debug("Expanding %s into:", pf->pev->args[i].var);
1158 vf.nargs = n;
1159 /* Special local variables */
1160 die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1161 &die_mem);
1162 pr_debug(" (%d)\n", vf.nargs - n);
1163 if (vf.ret < 0)
1164 return vf.ret;
1165 n = vf.nargs;
7969ec77
MH
1166 }
1167 return n;
1168}
1169
cf6eb489 1170/* Add a found probe point into trace event list */
221d0611 1171static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
cf6eb489
MH
1172{
1173 struct trace_event_finder *tf =
1174 container_of(pf, struct trace_event_finder, pf);
1175 struct probe_trace_event *tev;
7969ec77 1176 struct perf_probe_arg *args;
cf6eb489
MH
1177 int ret, i;
1178
1179 /* Check number of tevs */
1180 if (tf->ntevs == tf->max_tevs) {
1181 pr_warning("Too many( > %d) probe point found.\n",
1182 tf->max_tevs);
1183 return -ERANGE;
1184 }
1185 tev = &tf->tevs[tf->ntevs++];
1186
221d0611 1187 /* Trace point should be converted from subprogram DIE */
576b5237 1188 ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
221d0611 1189 pf->pev->point.retprobe, &tev->point);
cf6eb489
MH
1190 if (ret < 0)
1191 return ret;
1192
4c859351
MH
1193 tev->point.realname = strdup(dwarf_diename(sc_die));
1194 if (!tev->point.realname)
1195 return -ENOMEM;
1196
cf6eb489
MH
1197 pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1198 tev->point.offset);
1199
7969ec77
MH
1200 /* Expand special probe argument if exist */
1201 args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1202 if (args == NULL)
cf6eb489 1203 return -ENOMEM;
7969ec77
MH
1204
1205 ret = expand_probe_args(sc_die, pf, args);
1206 if (ret < 0)
1207 goto end;
1208
1209 tev->nargs = ret;
1210 tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1211 if (tev->args == NULL) {
1212 ret = -ENOMEM;
1213 goto end;
1214 }
1215
1216 /* Find each argument */
1217 for (i = 0; i < tev->nargs; i++) {
1218 pf->pvar = &args[i];
cf6eb489 1219 pf->tvar = &tev->args[i];
221d0611
MH
1220 /* Variable should be found from scope DIE */
1221 ret = find_variable(sc_die, pf);
cf6eb489 1222 if (ret != 0)
7969ec77 1223 break;
cf6eb489
MH
1224 }
1225
7969ec77
MH
1226end:
1227 free(args);
1228 return ret;
cf6eb489
MH
1229}
1230
1231/* Find probe_trace_events specified by perf_probe_event from debuginfo */
316c7136 1232int debuginfo__find_trace_events(struct debuginfo *dbg,
ff741783 1233 struct perf_probe_event *pev,
ddb2f58f 1234 struct probe_trace_event **tevs)
cf6eb489
MH
1235{
1236 struct trace_event_finder tf = {
1237 .pf = {.pev = pev, .callback = add_probe_trace_event},
ddb2f58f 1238 .max_tevs = probe_conf.max_probes, .mod = dbg->mod};
cf6eb489
MH
1239 int ret;
1240
1241 /* Allocate result tevs array */
ddb2f58f 1242 *tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
cf6eb489
MH
1243 if (*tevs == NULL)
1244 return -ENOMEM;
1245
1246 tf.tevs = *tevs;
1247 tf.ntevs = 0;
1248
316c7136 1249 ret = debuginfo__find_probes(dbg, &tf.pf);
cf6eb489 1250 if (ret < 0) {
04662523 1251 zfree(tevs);
cf6eb489
MH
1252 return ret;
1253 }
1254
1255 return (ret < 0) ? ret : tf.ntevs;
1256}
1257
cf6eb489
MH
1258/* Collect available variables in this scope */
1259static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1260{
1261 struct available_var_finder *af = data;
1262 struct variable_list *vl;
cf6eb489
MH
1263 int tag, ret;
1264
1265 vl = &af->vls[af->nvls - 1];
1266
1267 tag = dwarf_tag(die_mem);
1268 if (tag == DW_TAG_formal_parameter ||
1269 tag == DW_TAG_variable) {
1270 ret = convert_variable_location(die_mem, af->pf.addr,
3d918a12
MH
1271 af->pf.fb_ops, &af->pf.sp_die,
1272 NULL);
cf6eb489 1273 if (ret == 0) {
fb9596d1
HK
1274 struct strbuf buf;
1275
1276 strbuf_init(&buf, 64);
1277 ret = die_get_varname(die_mem, &buf);
1278 pr_debug2("Add new var: %s\n", buf.buf);
1279 if (ret == 0) {
1280 strlist__add(vl->vars,
1281 strbuf_detach(&buf, NULL));
1282 }
1283 strbuf_release(&buf);
cf6eb489
MH
1284 }
1285 }
1286
fb8c5a56 1287 if (af->child && dwarf_haspc(die_mem, af->pf.addr))
cf6eb489
MH
1288 return DIE_FIND_CB_CONTINUE;
1289 else
1290 return DIE_FIND_CB_SIBLING;
1291}
1292
1293/* Add a found vars into available variables list */
221d0611 1294static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
cf6eb489
MH
1295{
1296 struct available_var_finder *af =
1297 container_of(pf, struct available_var_finder, pf);
1298 struct variable_list *vl;
f182e3e1
MH
1299 Dwarf_Die die_mem;
1300 int ret;
cf6eb489
MH
1301
1302 /* Check number of tevs */
1303 if (af->nvls == af->max_vls) {
1304 pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1305 return -ERANGE;
1306 }
1307 vl = &af->vls[af->nvls++];
1308
221d0611 1309 /* Trace point should be converted from subprogram DIE */
576b5237 1310 ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
221d0611 1311 pf->pev->point.retprobe, &vl->point);
cf6eb489
MH
1312 if (ret < 0)
1313 return ret;
1314
1315 pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1316 vl->point.offset);
1317
1318 /* Find local variables */
1319 vl->vars = strlist__new(true, NULL);
1320 if (vl->vars == NULL)
1321 return -ENOMEM;
fb8c5a56 1322 af->child = true;
221d0611 1323 die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
cf6eb489 1324
fb8c5a56 1325 /* Find external variables */
ddb2f58f 1326 if (!probe_conf.show_ext_vars)
fb8c5a56 1327 goto out;
ddb2f58f 1328 /* Don't need to search child DIE for external vars. */
fb8c5a56 1329 af->child = false;
f182e3e1 1330 die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
fb8c5a56
MH
1331
1332out:
cf6eb489
MH
1333 if (strlist__empty(vl->vars)) {
1334 strlist__delete(vl->vars);
1335 vl->vars = NULL;
1336 }
1337
1338 return ret;
1339}
1340
69e96eaa
MH
1341/*
1342 * Find available variables at given probe point
1343 * Return the number of found probe points. Return 0 if there is no
1344 * matched probe point. Return <0 if an error occurs.
1345 */
316c7136 1346int debuginfo__find_available_vars_at(struct debuginfo *dbg,
ff741783 1347 struct perf_probe_event *pev,
ddb2f58f 1348 struct variable_list **vls)
cf6eb489
MH
1349{
1350 struct available_var_finder af = {
1351 .pf = {.pev = pev, .callback = add_available_vars},
316c7136 1352 .mod = dbg->mod,
ddb2f58f 1353 .max_vls = probe_conf.max_probes};
cf6eb489
MH
1354 int ret;
1355
1356 /* Allocate result vls array */
ddb2f58f 1357 *vls = zalloc(sizeof(struct variable_list) * af.max_vls);
cf6eb489
MH
1358 if (*vls == NULL)
1359 return -ENOMEM;
1360
1361 af.vls = *vls;
1362 af.nvls = 0;
1363
316c7136 1364 ret = debuginfo__find_probes(dbg, &af.pf);
cf6eb489
MH
1365 if (ret < 0) {
1366 /* Free vlist for error */
1367 while (af.nvls--) {
74cf249d 1368 zfree(&af.vls[af.nvls].point.symbol);
f5385650 1369 strlist__delete(af.vls[af.nvls].vars);
cf6eb489 1370 }
04662523 1371 zfree(vls);
cf6eb489
MH
1372 return ret;
1373 }
1374
1375 return (ret < 0) ? ret : af.nvls;
4ea42b18
MH
1376}
1377
fb1587d8 1378/* Reverse search */
316c7136 1379int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
ff741783 1380 struct perf_probe_point *ppt)
fb1587d8
MH
1381{
1382 Dwarf_Die cudie, spdie, indie;
e08cfd4b
MH
1383 Dwarf_Addr _addr = 0, baseaddr = 0;
1384 const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1d46ea2a 1385 int baseline = 0, lineno = 0, ret = 0;
fb1587d8 1386
fb1587d8 1387 /* Find cu die */
0104fe69 1388 if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
0e43e5d2
MH
1389 pr_warning("Failed to find debug information for address %lx\n",
1390 addr);
75ec5a24
MH
1391 ret = -EINVAL;
1392 goto end;
1393 }
fb1587d8 1394
1d46ea2a
MH
1395 /* Find a corresponding line (filename and lineno) */
1396 cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1397 /* Don't care whether it failed or not */
fb1587d8 1398
1d46ea2a 1399 /* Find a corresponding function (name, baseline and baseaddr) */
e0d153c6 1400 if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1d46ea2a 1401 /* Get function entry information */
e08cfd4b
MH
1402 func = basefunc = dwarf_diename(&spdie);
1403 if (!func ||
1d46ea2a 1404 dwarf_entrypc(&spdie, &baseaddr) != 0 ||
e08cfd4b
MH
1405 dwarf_decl_line(&spdie, &baseline) != 0) {
1406 lineno = 0;
1d46ea2a 1407 goto post;
e08cfd4b 1408 }
1d46ea2a 1409
1b286bdd 1410 fname = dwarf_decl_file(&spdie);
e08cfd4b 1411 if (addr == (unsigned long)baseaddr) {
1d46ea2a
MH
1412 /* Function entry - Relative line number is 0 */
1413 lineno = baseline;
e08cfd4b
MH
1414 goto post;
1415 }
1416
1417 /* Track down the inline functions step by step */
1418 while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1419 &indie)) {
1420 /* There is an inline function */
1d46ea2a 1421 if (dwarf_entrypc(&indie, &_addr) == 0 &&
e08cfd4b 1422 _addr == addr) {
1d46ea2a
MH
1423 /*
1424 * addr is at an inline function entry.
1425 * In this case, lineno should be the call-site
e08cfd4b 1426 * line number. (overwrite lineinfo)
1d46ea2a
MH
1427 */
1428 lineno = die_get_call_lineno(&indie);
e08cfd4b
MH
1429 fname = die_get_call_file(&indie);
1430 break;
1431 } else {
1d46ea2a
MH
1432 /*
1433 * addr is in an inline function body.
1434 * Since lineno points one of the lines
1435 * of the inline function, baseline should
1436 * be the entry line of the inline function.
1437 */
b55a87ad 1438 tmp = dwarf_diename(&indie);
e08cfd4b
MH
1439 if (!tmp ||
1440 dwarf_decl_line(&indie, &baseline) != 0)
1441 break;
1442 func = tmp;
1443 spdie = indie;
b55a87ad 1444 }
fb1587d8 1445 }
e08cfd4b
MH
1446 /* Verify the lineno and baseline are in a same file */
1447 tmp = dwarf_decl_file(&spdie);
1448 if (!tmp || strcmp(tmp, fname) != 0)
1449 lineno = 0;
1d46ea2a
MH
1450 }
1451
1452post:
1453 /* Make a relative line number or an offset */
1454 if (lineno)
1455 ppt->line = lineno - baseline;
e08cfd4b 1456 else if (basefunc) {
1d46ea2a 1457 ppt->offset = addr - (unsigned long)baseaddr;
e08cfd4b
MH
1458 func = basefunc;
1459 }
1d46ea2a
MH
1460
1461 /* Duplicate strings */
1462 if (func) {
1463 ppt->function = strdup(func);
02b95dad
MH
1464 if (ppt->function == NULL) {
1465 ret = -ENOMEM;
1466 goto end;
1467 }
fb1587d8 1468 }
1d46ea2a
MH
1469 if (fname) {
1470 ppt->file = strdup(fname);
1471 if (ppt->file == NULL) {
04662523 1472 zfree(&ppt->function);
1d46ea2a
MH
1473 ret = -ENOMEM;
1474 goto end;
1475 }
1476 }
fb1587d8 1477end:
1d46ea2a
MH
1478 if (ret == 0 && (fname || func))
1479 ret = 1; /* Found a point */
fb1587d8
MH
1480 return ret;
1481}
1482
f6c903f5
MH
1483/* Add a line and store the src path */
1484static int line_range_add_line(const char *src, unsigned int lineno,
1485 struct line_range *lr)
1486{
7cf0b79e 1487 /* Copy source path */
f6c903f5 1488 if (!lr->path) {
7cf0b79e
MH
1489 lr->path = strdup(src);
1490 if (lr->path == NULL)
1491 return -ENOMEM;
f6c903f5 1492 }
5a62257a 1493 return intlist__add(lr->line_list, lineno);
f6c903f5
MH
1494}
1495
4cc9cec6 1496static int line_range_walk_cb(const char *fname, int lineno,
1d037ca1 1497 Dwarf_Addr addr __maybe_unused,
4cc9cec6 1498 void *data)
f6c903f5 1499{
4cc9cec6 1500 struct line_finder *lf = data;
202c7c12 1501 int err;
f6c903f5 1502
4cc9cec6 1503 if ((strtailcmp(fname, lf->fname) != 0) ||
f6c903f5 1504 (lf->lno_s > lineno || lf->lno_e < lineno))
4cc9cec6 1505 return 0;
f6c903f5 1506
202c7c12
NK
1507 err = line_range_add_line(fname, lineno, lf->lr);
1508 if (err < 0 && err != -EEXIST)
1509 return err;
f6c903f5 1510
4cc9cec6 1511 return 0;
f6c903f5 1512}
fb1587d8 1513
631c9def 1514/* Find line range from its line number */
b55a87ad 1515static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
631c9def 1516{
4cc9cec6 1517 int ret;
f6c903f5 1518
4cc9cec6 1519 ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
f6c903f5 1520
804b3606 1521 /* Update status */
f6c903f5 1522 if (ret >= 0)
5a62257a 1523 if (!intlist__empty(lf->lr->line_list))
f6c903f5
MH
1524 ret = lf->found = 1;
1525 else
1526 ret = 0; /* Lines are not found */
804b3606 1527 else {
04662523 1528 zfree(&lf->lr->path);
804b3606 1529 }
f6c903f5 1530 return ret;
631c9def
MH
1531}
1532
161a26b0
MH
1533static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1534{
182c228e 1535 int ret = find_line_range_by_line(in_die, data);
36c0c588
MH
1536
1537 /*
1538 * We have to check all instances of inlined function, because
1539 * some execution paths can be optimized out depends on the
182c228e
MH
1540 * function argument of instances. However, if an error occurs,
1541 * it should be handled by the caller.
36c0c588 1542 */
182c228e 1543 return ret < 0 ? ret : 0;
161a26b0
MH
1544}
1545
0dbb1cac 1546/* Search function definition from function name */
e92b85e1 1547static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
631c9def 1548{
b55a87ad
MH
1549 struct dwarf_callback_param *param = data;
1550 struct line_finder *lf = param->data;
631c9def 1551 struct line_range *lr = lf->lr;
631c9def 1552
7d21635a
MH
1553 /* Check declared file */
1554 if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1555 return DWARF_CB_OK;
1556
0dbb1cac 1557 if (die_is_func_def(sp_die) &&
4c859351 1558 die_match_name(sp_die, lr->function)) {
e92b85e1
MH
1559 lf->fname = dwarf_decl_file(sp_die);
1560 dwarf_decl_line(sp_die, &lr->offset);
804b3606 1561 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
631c9def 1562 lf->lno_s = lr->offset + lr->start;
d3b63d7a
MH
1563 if (lf->lno_s < 0) /* Overflow */
1564 lf->lno_s = INT_MAX;
1565 lf->lno_e = lr->offset + lr->end;
1566 if (lf->lno_e < 0) /* Overflow */
804b3606 1567 lf->lno_e = INT_MAX;
d3b63d7a 1568 pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
631c9def
MH
1569 lr->start = lf->lno_s;
1570 lr->end = lf->lno_e;
e1ecbbc3 1571 if (!die_is_func_instance(sp_die))
db0d2c64
MH
1572 param->retval = die_walk_instances(sp_die,
1573 line_range_inline_cb, lf);
1574 else
b55a87ad
MH
1575 param->retval = find_line_range_by_line(sp_die, lf);
1576 return DWARF_CB_ABORT;
631c9def 1577 }
b55a87ad 1578 return DWARF_CB_OK;
631c9def
MH
1579}
1580
b55a87ad 1581static int find_line_range_by_func(struct line_finder *lf)
631c9def 1582{
b55a87ad
MH
1583 struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1584 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
1585 return param.retval;
631c9def
MH
1586}
1587
316c7136 1588int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
631c9def 1589{
804b3606 1590 struct line_finder lf = {.lr = lr, .found = 0};
b55a87ad 1591 int ret = 0;
804b3606
MH
1592 Dwarf_Off off = 0, noff;
1593 size_t cuhl;
1594 Dwarf_Die *diep;
6a330a3c 1595 const char *comp_dir;
804b3606 1596
cd25f8bc
LM
1597 /* Fastpath: lookup by function name from .debug_pubnames section */
1598 if (lr->function) {
1599 struct pubname_callback_param pubname_param = {
1600 .function = lr->function, .file = lr->file,
1601 .cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1602 struct dwarf_callback_param line_range_param = {
1603 .data = (void *)&lf, .retval = 0};
1604
316c7136 1605 dwarf_getpubnames(dbg->dbg, pubname_search_cb,
ff741783 1606 &pubname_param, 0);
cd25f8bc
LM
1607 if (pubname_param.found) {
1608 line_range_search_cb(&lf.sp_die, &line_range_param);
1609 if (lf.found)
1610 goto found;
1611 }
1612 }
1613
804b3606 1614 /* Loop on CUs (Compilation Unit) */
b55a87ad 1615 while (!lf.found && ret >= 0) {
316c7136 1616 if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
ff741783 1617 NULL, NULL, NULL) != 0)
631c9def
MH
1618 break;
1619
1620 /* Get the DIE(Debugging Information Entry) of this CU */
316c7136 1621 diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
804b3606
MH
1622 if (!diep)
1623 continue;
631c9def
MH
1624
1625 /* Check if target file is included. */
1626 if (lr->file)
2a9c8c36 1627 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
804b3606 1628 else
2a9c8c36 1629 lf.fname = 0;
631c9def 1630
2a9c8c36 1631 if (!lr->file || lf.fname) {
631c9def 1632 if (lr->function)
b55a87ad 1633 ret = find_line_range_by_func(&lf);
631c9def
MH
1634 else {
1635 lf.lno_s = lr->start;
d3b63d7a 1636 lf.lno_e = lr->end;
b55a87ad 1637 ret = find_line_range_by_line(NULL, &lf);
631c9def 1638 }
631c9def 1639 }
804b3606 1640 off = noff;
631c9def 1641 }
6a330a3c 1642
cd25f8bc 1643found:
6a330a3c
MH
1644 /* Store comp_dir */
1645 if (lf.found) {
1646 comp_dir = cu_get_comp_dir(&lf.cu_die);
1647 if (comp_dir) {
1648 lr->comp_dir = strdup(comp_dir);
1649 if (!lr->comp_dir)
1650 ret = -ENOMEM;
1651 }
1652 }
1653
7cf0b79e 1654 pr_debug("path: %s\n", lr->path);
b55a87ad 1655 return (ret < 0) ? ret : lf.found;
631c9def
MH
1656}
1657
09ed8975
NA
1658/*
1659 * Find a src file from a DWARF tag path. Prepend optional source path prefix
1660 * and chop off leading directories that do not exist. Result is passed back as
1661 * a newly allocated path on success.
1662 * Return 0 if file was found and readable, -errno otherwise.
1663 */
1664int get_real_path(const char *raw_path, const char *comp_dir,
1665 char **new_path)
1666{
1667 const char *prefix = symbol_conf.source_prefix;
1668
1669 if (!prefix) {
1670 if (raw_path[0] != '/' && comp_dir)
1671 /* If not an absolute path, try to use comp_dir */
1672 prefix = comp_dir;
1673 else {
1674 if (access(raw_path, R_OK) == 0) {
1675 *new_path = strdup(raw_path);
1676 return *new_path ? 0 : -ENOMEM;
1677 } else
1678 return -errno;
1679 }
1680 }
1681
1682 *new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
1683 if (!*new_path)
1684 return -ENOMEM;
1685
1686 for (;;) {
1687 sprintf(*new_path, "%s/%s", prefix, raw_path);
1688
1689 if (access(*new_path, R_OK) == 0)
1690 return 0;
1691
1692 if (!symbol_conf.source_prefix) {
1693 /* In case of searching comp_dir, don't retry */
1694 zfree(new_path);
1695 return -errno;
1696 }
1697
1698 switch (errno) {
1699 case ENAMETOOLONG:
1700 case ENOENT:
1701 case EROFS:
1702 case EFAULT:
1703 raw_path = strchr(++raw_path, '/');
1704 if (!raw_path) {
1705 zfree(new_path);
1706 return -ENOENT;
1707 }
1708 continue;
1709
1710 default:
1711 zfree(new_path);
1712 return -errno;
1713 }
1714 }
1715}
This page took 0.356094 seconds and 5 git commands to generate.