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