probe-finder.c 42.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
/*
 * probe-finder.c : C expression to kprobe event converter
 *
 * Written by Masami Hiramatsu <mhiramat@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

#include <sys/utsname.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
32
#include <dwarf-regs.h>
33

34
#include <linux/bitops.h>
35
#include "event.h"
36
#include "dso.h"
37
#include "debug.h"
38
#include "intlist.h"
39
#include "util.h"
40
#include "symbol.h"
41 42
#include "probe-finder.h"

43 44 45
/* Kprobe tracer basic type is up to u64 */
#define MAX_BASIC_TYPE_BITS	64

46 47 48 49 50 51 52 53 54 55 56 57 58 59
/* Dwarf FL wrappers */
static char *debuginfo_path;	/* Currently dummy */

static const Dwfl_Callbacks offline_callbacks = {
	.find_debuginfo = dwfl_standard_find_debuginfo,
	.debuginfo_path = &debuginfo_path,

	.section_address = dwfl_offline_section_address,

	/* We use this table for core files too.  */
	.find_elf = dwfl_build_id_find_elf,
};

/* Get a Dwarf from offline image */
60
static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
61
					 const char *path)
62
{
63
	int fd;
64

65 66 67
	fd = open(path, O_RDONLY);
	if (fd < 0)
		return fd;
68

69 70
	dbg->dwfl = dwfl_begin(&offline_callbacks);
	if (!dbg->dwfl)
71
		goto error;
72

73
	dwfl_report_begin(dbg->dwfl);
74 75
	dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
	if (!dbg->mod)
76 77
		goto error;

78 79
	dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
	if (!dbg->dbg)
80 81
		goto error;

82 83
	dwfl_report_end(dbg->dwfl, NULL, NULL);

84
	return 0;
85
error:
86 87
	if (dbg->dwfl)
		dwfl_end(dbg->dwfl);
88 89
	else
		close(fd);
90
	memset(dbg, 0, sizeof(*dbg));
91 92

	return -ENOENT;
93 94
}

95
static struct debuginfo *__debuginfo__new(const char *path)
96
{
97 98
	struct debuginfo *dbg = zalloc(sizeof(*dbg));
	if (!dbg)
99 100
		return NULL;

101 102
	if (debuginfo__init_offline_dwarf(dbg, path) < 0)
		zfree(&dbg);
103 104
	if (dbg)
		pr_debug("Open Debuginfo file: %s\n", path);
105
	return dbg;
106 107
}

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
enum dso_binary_type distro_dwarf_types[] = {
	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
	DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
	DSO_BINARY_TYPE__NOT_FOUND,
};

struct debuginfo *debuginfo__new(const char *path)
{
	enum dso_binary_type *type;
	char buf[PATH_MAX], nil = '\0';
	struct dso *dso;
	struct debuginfo *dinfo = NULL;

	/* Try to open distro debuginfo files */
	dso = dso__new(path);
	if (!dso)
		goto out;

	for (type = distro_dwarf_types;
	     !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
	     type++) {
		if (dso__read_binary_type_filename(dso, *type, &nil,
						   buf, PATH_MAX) < 0)
			continue;
		dinfo = __debuginfo__new(buf);
	}
136
	dso__put(dso);
137 138 139 140 141 142

out:
	/* if failed to open all distro debuginfo, open given binary */
	return dinfo ? : __debuginfo__new(path);
}

143
void debuginfo__delete(struct debuginfo *dbg)
144
{
145 146 147 148
	if (dbg) {
		if (dbg->dwfl)
			dwfl_end(dbg->dwfl);
		free(dbg);
149
	}
150
}
151

152 153 154 155
/*
 * Probe finder related functions
 */

156
static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
157
{
158 159
	struct probe_trace_arg_ref *ref;
	ref = zalloc(sizeof(struct probe_trace_arg_ref));
160 161 162 163 164
	if (ref != NULL)
		ref->offset = offs;
	return ref;
}

165 166 167
/*
 * Convert a location into trace_arg.
 * If tvar == NULL, this just checks variable can be converted.
168 169
 * If fentry == true and vr_die is a parameter, do huristic search
 * for the location fuzzed by function entry mcount.
170 171
 */
static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
172
				     Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
173
				     struct probe_trace_arg *tvar)
174
{
175
	Dwarf_Attribute attr;
176
	Dwarf_Addr tmp = 0;
177 178
	Dwarf_Op *op;
	size_t nops;
179 180
	unsigned int regn;
	Dwarf_Word offs = 0;
181
	bool ref = false;
182
	const char *regs;
183
	int ret, ret2 = 0;
184

185 186 187
	if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
		goto static_var;

188
	/* TODO: handle more than 1 exprs */
189 190 191 192
	if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
		return -EINVAL;	/* Broken DIE ? */
	if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
		ret = dwarf_entrypc(sp_die, &tmp);
193 194 195 196 197 198 199 200 201 202 203 204 205
		if (ret)
			return -ENOENT;

		if (probe_conf.show_location_range &&
			(dwarf_tag(vr_die) == DW_TAG_variable)) {
			ret2 = -ERANGE;
		} else if (addr != tmp ||
			dwarf_tag(vr_die) != DW_TAG_formal_parameter) {
			return -ENOENT;
		}

		ret = dwarf_highpc(sp_die, &tmp);
		if (ret)
206 207 208 209 210 211 212 213 214 215
			return -ENOENT;
		/*
		 * This is fuzzed by fentry mcount. We try to find the
		 * parameter location at the earliest address.
		 */
		for (addr += 1; addr <= tmp; addr++) {
			if (dwarf_getlocation_addr(&attr, addr, &op,
						   &nops, 1) > 0)
				goto found;
		}
216 217
		return -ENOENT;
	}
218 219 220 221
found:
	if (nops == 0)
		/* TODO: Support const_value */
		return -ENOENT;
222 223

	if (op->atom == DW_OP_addr) {
224
static_var:
225
		if (!tvar)
226
			return ret2;
227 228 229 230 231 232 233 234 235
		/* Static variables on memory (not stack), make @varname */
		ret = strlen(dwarf_diename(vr_die));
		tvar->value = zalloc(ret + 2);
		if (tvar->value == NULL)
			return -ENOMEM;
		snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
		tvar->ref = alloc_trace_arg_ref((long)offs);
		if (tvar->ref == NULL)
			return -ENOMEM;
236
		return ret2;
237
	}
238 239

	/* If this is based on frame buffer, set the offset */
240
	if (op->atom == DW_OP_fbreg) {
241
		if (fb_ops == NULL)
242
			return -ENOTSUP;
243
		ref = true;
244
		offs = op->number;
245
		op = &fb_ops[0];
246
	}
247

248 249 250
	if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
		regn = op->atom - DW_OP_breg0;
		offs += op->number;
251
		ref = true;
252 253 254 255 256
	} else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
		regn = op->atom - DW_OP_reg0;
	} else if (op->atom == DW_OP_bregx) {
		regn = op->number;
		offs += op->number2;
257
		ref = true;
258 259
	} else if (op->atom == DW_OP_regx) {
		regn = op->number;
260
	} else {
261
		pr_debug("DW_OP %x is not supported.\n", op->atom);
262 263
		return -ENOTSUP;
	}
264

265
	if (!tvar)
266
		return ret2;
267

268
	regs = get_arch_regstr(regn);
269
	if (!regs) {
270
		/* This should be a bug in DWARF or this tool */
M
Masami Hiramatsu 已提交
271 272
		pr_warning("Mapping for the register number %u "
			   "missing on this architecture.\n", regn);
273
		return -ENOTSUP;
274
	}
275

276 277 278 279
	tvar->value = strdup(regs);
	if (tvar->value == NULL)
		return -ENOMEM;

280
	if (ref) {
281
		tvar->ref = alloc_trace_arg_ref((long)offs);
282 283
		if (tvar->ref == NULL)
			return -ENOMEM;
284
	}
285
	return ret2;
286 287
}

288 289
#define BYTES_TO_BITS(nb)	((nb) * BITS_PER_LONG / sizeof(long))

290
static int convert_variable_type(Dwarf_Die *vr_die,
291
				 struct probe_trace_arg *tvar,
292
				 const char *cast)
293
{
294
	struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
295 296
	Dwarf_Die type;
	char buf[16];
297
	char sbuf[STRERR_BUFSIZE];
298
	int bsize, boffs, total;
299 300
	int ret;

301 302 303 304 305 306 307
	/* TODO: check all types */
	if (cast && strcmp(cast, "string") != 0) {
		/* Non string type is OK */
		tvar->type = strdup(cast);
		return (tvar->type == NULL) ? -ENOMEM : 0;
	}

308 309
	bsize = dwarf_bitsize(vr_die);
	if (bsize > 0) {
310
		/* This is a bitfield */
311 312 313 314 315 316
		boffs = dwarf_bitoffset(vr_die);
		total = dwarf_bytesize(vr_die);
		if (boffs < 0 || total < 0)
			return -ENOENT;
		ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
				BYTES_TO_BITS(total));
317 318 319
		goto formatted;
	}

320 321 322 323 324
	if (die_get_real_type(vr_die, &type) == NULL) {
		pr_warning("Failed to get a type information of %s.\n",
			   dwarf_diename(vr_die));
		return -ENOENT;
	}
325

326 327 328
	pr_debug("%s type is %s.\n",
		 dwarf_diename(vr_die), dwarf_diename(&type));

329 330 331 332 333
	if (cast && strcmp(cast, "string") == 0) {	/* String type */
		ret = dwarf_tag(&type);
		if (ret != DW_TAG_pointer_type &&
		    ret != DW_TAG_array_type) {
			pr_warning("Failed to cast into string: "
M
Masami Hiramatsu 已提交
334
				   "%s(%s) is not a pointer nor array.\n",
335 336 337
				   dwarf_diename(vr_die), dwarf_diename(&type));
			return -EINVAL;
		}
338 339 340 341 342
		if (die_get_real_type(&type, &type) == NULL) {
			pr_warning("Failed to get a type"
				   " information.\n");
			return -ENOENT;
		}
343 344 345 346
		if (ret == DW_TAG_pointer_type) {
			while (*ref_ptr)
				ref_ptr = &(*ref_ptr)->next;
			/* Add new reference with offset +0 */
347
			*ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
348 349 350 351 352
			if (*ref_ptr == NULL) {
				pr_warning("Out of memory error\n");
				return -ENOMEM;
			}
		}
353 354
		if (!die_compare_name(&type, "char") &&
		    !die_compare_name(&type, "unsigned char")) {
355
			pr_warning("Failed to cast into string: "
M
Masami Hiramatsu 已提交
356
				   "%s is not (unsigned) char *.\n",
357 358 359 360 361 362 363
				   dwarf_diename(vr_die));
			return -EINVAL;
		}
		tvar->type = strdup(cast);
		return (tvar->type == NULL) ? -ENOMEM : 0;
	}

364 365
	ret = dwarf_bytesize(&type);
	if (ret <= 0)
366 367
		/* No size ... try to use default type */
		return 0;
368
	ret = BYTES_TO_BITS(ret);
369

370 371 372 373 374
	/* Check the bitwidth */
	if (ret > MAX_BASIC_TYPE_BITS) {
		pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
			dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
		ret = MAX_BASIC_TYPE_BITS;
375
	}
376 377 378 379 380 381 382 383
	ret = snprintf(buf, 16, "%c%d",
		       die_is_signed_type(&type) ? 's' : 'u', ret);

formatted:
	if (ret < 0 || ret >= 16) {
		if (ret >= 16)
			ret = -E2BIG;
		pr_warning("Failed to convert variable type: %s\n",
384
			   strerror_r(-ret, sbuf, sizeof(sbuf)));
385 386 387 388 389
		return ret;
	}
	tvar->type = strdup(buf);
	if (tvar->type == NULL)
		return -ENOMEM;
390
	return 0;
391 392
}

393
static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
394
				    struct perf_probe_arg_field *field,
395
				    struct probe_trace_arg_ref **ref_ptr,
396
				    Dwarf_Die *die_mem)
397
{
398
	struct probe_trace_arg_ref *ref = *ref_ptr;
399 400
	Dwarf_Die type;
	Dwarf_Word offs;
401
	int ret, tag;
402 403

	pr_debug("converting %s in %s\n", field->name, varname);
404 405 406 407
	if (die_get_real_type(vr_die, &type) == NULL) {
		pr_warning("Failed to get the type of %s.\n", varname);
		return -ENOENT;
	}
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
	pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
	tag = dwarf_tag(&type);

	if (field->name[0] == '[' &&
	    (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
		if (field->next)
			/* Save original type for next field */
			memcpy(die_mem, &type, sizeof(*die_mem));
		/* Get the type of this array */
		if (die_get_real_type(&type, &type) == NULL) {
			pr_warning("Failed to get the type of %s.\n", varname);
			return -ENOENT;
		}
		pr_debug2("Array real type: (%x)\n",
			 (unsigned)dwarf_dieoffset(&type));
		if (tag == DW_TAG_pointer_type) {
424
			ref = zalloc(sizeof(struct probe_trace_arg_ref));
425 426 427 428 429 430 431
			if (ref == NULL)
				return -ENOMEM;
			if (*ref_ptr)
				(*ref_ptr)->next = ref;
			else
				*ref_ptr = ref;
		}
432
		ref->offset += dwarf_bytesize(&type) * field->index;
433 434 435 436 437 438
		if (!field->next)
			/* Save vr_die for converting types */
			memcpy(die_mem, vr_die, sizeof(*die_mem));
		goto next;
	} else if (tag == DW_TAG_pointer_type) {
		/* Check the pointer and dereference */
439 440 441 442 443
		if (!field->ref) {
			pr_err("Semantic error: %s must be referred by '->'\n",
			       field->name);
			return -EINVAL;
		}
444
		/* Get the type pointed by this pointer */
445 446 447 448
		if (die_get_real_type(&type, &type) == NULL) {
			pr_warning("Failed to get the type of %s.\n", varname);
			return -ENOENT;
		}
449
		/* Verify it is a data structure  */
450 451 452 453
		tag = dwarf_tag(&type);
		if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
			pr_warning("%s is not a data structure nor an union.\n",
				   varname);
454 455
			return -EINVAL;
		}
456

457
		ref = zalloc(sizeof(struct probe_trace_arg_ref));
458 459
		if (ref == NULL)
			return -ENOMEM;
460 461 462 463 464
		if (*ref_ptr)
			(*ref_ptr)->next = ref;
		else
			*ref_ptr = ref;
	} else {
465
		/* Verify it is a data structure  */
466 467 468
		if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
			pr_warning("%s is not a data structure nor an union.\n",
				   varname);
469 470
			return -EINVAL;
		}
471
		if (field->name[0] == '[') {
472
			pr_err("Semantic error: %s is not a pointer"
M
Masami Hiramatsu 已提交
473
			       " nor array.\n", varname);
474 475
			return -EINVAL;
		}
476 477
		/* While prcessing unnamed field, we don't care about this */
		if (field->ref && dwarf_diename(vr_die)) {
478 479 480 481 482 483 484 485 486
			pr_err("Semantic error: %s must be referred by '.'\n",
			       field->name);
			return -EINVAL;
		}
		if (!ref) {
			pr_warning("Structure on a register is not "
				   "supported yet.\n");
			return -ENOTSUP;
		}
487 488
	}

489
	if (die_find_member(&type, field->name, die_mem) == NULL) {
A
Arnaldo Carvalho de Melo 已提交
490
		pr_warning("%s(type:%s) has no member %s.\n", varname,
491 492 493
			   dwarf_diename(&type), field->name);
		return -EINVAL;
	}
494 495

	/* Get the offset of the field */
496 497 498 499 500 501 502 503 504
	if (tag == DW_TAG_union_type) {
		offs = 0;
	} else {
		ret = die_get_data_member_location(die_mem, &offs);
		if (ret < 0) {
			pr_warning("Failed to get the offset of %s.\n",
				   field->name);
			return ret;
		}
505
	}
506 507
	ref->offset += (long)offs;

508 509 510 511 512
	/* If this member is unnamed, we need to reuse this field */
	if (!dwarf_diename(die_mem))
		return convert_variable_fields(die_mem, varname, field,
						&ref, die_mem);

513
next:
514 515
	/* Converting next field */
	if (field->next)
516
		return convert_variable_fields(die_mem, field->name,
517
					field->next, &ref, die_mem);
518 519
	else
		return 0;
520 521
}

522
/* Show a variables in kprobe event format */
523
static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
524
{
525
	Dwarf_Die die_mem;
526 527
	int ret;

528 529
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
530

531
	ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
532
					&pf->sp_die, pf->tvar);
533 534 535 536 537 538
	if (ret == -ENOENT || ret == -EINVAL) {
		pr_err("Failed to find the location of the '%s' variable at this address.\n"
		       " Perhaps it has been optimized out.\n"
		       " Use -V with the --range option to show '%s' location range.\n",
		       pf->pvar->var, pf->pvar->var);
	} else if (ret == -ENOTSUP)
539
		pr_err("Sorry, we don't support this variable location yet.\n");
540
	else if (ret == 0 && pf->pvar->field) {
541 542 543
		ret = convert_variable_fields(vr_die, pf->pvar->var,
					      pf->pvar->field, &pf->tvar->ref,
					      &die_mem);
544 545
		vr_die = &die_mem;
	}
546 547
	if (ret == 0)
		ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
548
	/* *expr will be cached in libdw. Don't free it. */
549
	return ret;
550 551
}

552 553
/* Find a variable in a scope DIE */
static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
554
{
555
	Dwarf_Die vr_die;
556
	char buf[32], *ptr;
557
	int ret = 0;
558

559 560 561
	/* Copy raw parameters */
	if (!is_c_varname(pf->pvar->var))
		return copy_to_probe_trace_arg(pf->tvar, pf->pvar);
562

563
	if (pf->pvar->name)
564
		pf->tvar->name = strdup(pf->pvar->name);
565
	else {
566 567 568
		ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
		if (ret < 0)
			return ret;
569 570 571
		ptr = strchr(buf, ':');	/* Change type separator to _ */
		if (ptr)
			*ptr = '_';
572
		pf->tvar->name = strdup(buf);
573
	}
574 575
	if (pf->tvar->name == NULL)
		return -ENOMEM;
576

577
	pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
578
	/* Search child die for local variables and parameters. */
579 580
	if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
		/* Search again in global variables */
581 582
		if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
						0, &vr_die)) {
583 584
			pr_warning("Failed to find '%s' in this function.\n",
				   pf->pvar->var);
585
			ret = -ENOENT;
586
		}
587
	}
588
	if (ret >= 0)
589 590
		ret = convert_variable(&vr_die, pf);

591
	return ret;
592 593
}

594
/* Convert subprogram DIE to trace point */
595 596 597
static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
				  Dwarf_Addr paddr, bool retprobe,
				  struct probe_trace_point *tp)
598
{
599
	Dwarf_Addr eaddr, highaddr;
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
	GElf_Sym sym;
	const char *symbol;

	/* Verify the address is correct */
	if (dwarf_entrypc(sp_die, &eaddr) != 0) {
		pr_warning("Failed to get entry address of %s\n",
			   dwarf_diename(sp_die));
		return -ENOENT;
	}
	if (dwarf_highpc(sp_die, &highaddr) != 0) {
		pr_warning("Failed to get end address of %s\n",
			   dwarf_diename(sp_die));
		return -ENOENT;
	}
	if (paddr > highaddr) {
		pr_warning("Offset specified is greater than size of %s\n",
			   dwarf_diename(sp_die));
		return -EINVAL;
	}

620
	symbol = dwarf_diename(sp_die);
621
	if (!symbol) {
622 623 624 625 626 627 628 629
		/* Try to get the symbol name from symtab */
		symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
		if (!symbol) {
			pr_warning("Failed to find symbol at 0x%lx\n",
				   (unsigned long)paddr);
			return -ENOENT;
		}
		eaddr = sym.st_value;
630
	}
631
	tp->offset = (unsigned long)(paddr - eaddr);
632
	tp->address = (unsigned long)paddr;
633 634 635
	tp->symbol = strdup(symbol);
	if (!tp->symbol)
		return -ENOMEM;
636

637
	/* Return probe must be on the head of a subprogram */
638 639
	if (retprobe) {
		if (eaddr != paddr) {
640
			pr_warning("Return probe must be on the head of"
M
Masami Hiramatsu 已提交
641
				   " a real function.\n");
642 643
			return -EINVAL;
		}
644
		tp->retprobe = true;
645 646
	}

647 648 649
	return 0;
}

650 651
/* Call probe_finder callback with scope DIE */
static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
652 653 654 655 656
{
	Dwarf_Attribute fb_attr;
	size_t nops;
	int ret;

657 658 659 660 661 662
	if (!sc_die) {
		pr_err("Caller must pass a scope DIE. Program error.\n");
		return -EINVAL;
	}

	/* If not a real subprogram, find a real one */
663
	if (!die_is_func_def(sc_die)) {
664
		if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
665 666 667 668 669 670 671 672 673
			if (die_find_tailfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
				pr_warning("Ignoring tail call from %s\n",
						dwarf_diename(&pf->sp_die));
				return 0;
			} else {
				pr_warning("Failed to find probe point in any "
					   "functions.\n");
				return -ENOENT;
			}
674
		}
675 676
	} else
		memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
677

678 679
	/* Get the frame base attribute/ops from subprogram */
	dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
680
	ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
681
	if (ret <= 0 || nops == 0) {
682
		pf->fb_ops = NULL;
683
#if _ELFUTILS_PREREQ(0, 142)
684 685 686
	} else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
		   pf->cfi != NULL) {
		Dwarf_Frame *frame;
687 688
		if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
		    dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
M
Masami Hiramatsu 已提交
689
			pr_warning("Failed to get call frame on 0x%jx\n",
690 691 692
				   (uintmax_t)pf->addr);
			return -ENOENT;
		}
693
#endif
694
	}
695

696
	/* Call finder's callback handler */
697
	ret = pf->callback(sc_die, pf);
698 699 700

	/* *pf->fb_ops will be cached in libdw. Don't free it. */
	pf->fb_ops = NULL;
701 702

	return ret;
703 704
}

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
struct find_scope_param {
	const char *function;
	const char *file;
	int line;
	int diff;
	Dwarf_Die *die_mem;
	bool found;
};

static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
{
	struct find_scope_param *fsp = data;
	const char *file;
	int lno;

	/* Skip if declared file name does not match */
	if (fsp->file) {
		file = dwarf_decl_file(fn_die);
		if (!file || strcmp(fsp->file, file) != 0)
			return 0;
	}
	/* If the function name is given, that's what user expects */
	if (fsp->function) {
728
		if (die_match_name(fn_die, fsp->function)) {
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
			memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
			fsp->found = true;
			return 1;
		}
	} else {
		/* With the line number, find the nearest declared DIE */
		dwarf_decl_line(fn_die, &lno);
		if (lno < fsp->line && fsp->diff > fsp->line - lno) {
			/* Keep a candidate and continue */
			fsp->diff = fsp->line - lno;
			memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
			fsp->found = true;
		}
	}
	return 0;
}

/* Find an appropriate scope fits to given conditions */
static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
{
	struct find_scope_param fsp = {
		.function = pf->pev->point.function,
		.file = pf->fname,
		.line = pf->lno,
		.diff = INT_MAX,
		.die_mem = die_mem,
		.found = false,
	};

	cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);

	return fsp.found ? die_mem : NULL;
}

763 764
static int probe_point_line_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
765
{
766
	struct probe_finder *pf = data;
767
	Dwarf_Die *sc_die, die_mem;
768
	int ret;
769

770 771
	if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
		return 0;
772

773
	pf->addr = addr;
774 775 776 777 778 779 780
	sc_die = find_best_scope(pf, &die_mem);
	if (!sc_die) {
		pr_warning("Failed to find scope of probe point.\n");
		return -ENOENT;
	}

	ret = call_probe_finder(sc_die, pf);
781

782
	/* Continue if no error, because the line will be in inline function */
783
	return ret < 0 ? ret : 0;
784
}
785

786 787 788 789
/* Find probe point from its line number */
static int find_probe_point_by_line(struct probe_finder *pf)
{
	return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
790 791
}

792
/* Find lines which match lazy pattern */
793
static int find_lazy_match_lines(struct intlist *list,
794 795
				 const char *fname, const char *pat)
{
796 797 798 799 800
	FILE *fp;
	char *line = NULL;
	size_t line_len;
	ssize_t len;
	int count = 0, linenum = 1;
801
	char sbuf[STRERR_BUFSIZE];
802 803 804

	fp = fopen(fname, "r");
	if (!fp) {
805 806
		pr_warning("Failed to open %s: %s\n", fname,
			   strerror_r(errno, sbuf, sizeof(sbuf)));
807
		return -errno;
808 809
	}

810
	while ((len = getline(&line, &line_len, fp)) > 0) {
811

812 813 814 815
		if (line[len - 1] == '\n')
			line[len - 1] = '\0';

		if (strlazymatch(line, pat)) {
816
			intlist__add(list, linenum);
817
			count++;
818
		}
819
		linenum++;
820
	}
821 822 823 824 825 826 827 828 829

	if (ferror(fp))
		count = -errno;
	free(line);
	fclose(fp);

	if (count == 0)
		pr_debug("No matched lines found in %s.\n", fname);
	return count;
830 831
}

832 833 834 835
static int probe_point_lazy_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
{
	struct probe_finder *pf = data;
836
	Dwarf_Die *sc_die, die_mem;
837 838
	int ret;

839
	if (!intlist__has_entry(pf->lcache, lineno) ||
840 841 842 843 844 845
	    strtailcmp(fname, pf->fname) != 0)
		return 0;

	pr_debug("Probe line found: line:%d addr:0x%llx\n",
		 lineno, (unsigned long long)addr);
	pf->addr = addr;
846 847 848 849 850 851 852 853
	pf->lno = lineno;
	sc_die = find_best_scope(pf, &die_mem);
	if (!sc_die) {
		pr_warning("Failed to find scope of probe point.\n");
		return -ENOENT;
	}

	ret = call_probe_finder(sc_die, pf);
854 855 856 857 858

	/*
	 * Continue if no error, because the lazy pattern will match
	 * to other lines
	 */
859
	return ret < 0 ? ret : 0;
860 861
}

862
/* Find probe points from lazy pattern  */
863
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
864
{
865
	int ret = 0;
866
	char *fpath;
867

868
	if (intlist__empty(pf->lcache)) {
869 870 871 872 873 874 875 876 877
		const char *comp_dir;

		comp_dir = cu_get_comp_dir(&pf->cu_die);
		ret = get_real_path(pf->fname, comp_dir, &fpath);
		if (ret < 0) {
			pr_warning("Failed to find source file path.\n");
			return ret;
		}

878
		/* Matching lazy line pattern */
879
		ret = find_lazy_match_lines(pf->lcache, fpath,
880
					    pf->pev->point.lazy_line);
881
		free(fpath);
882
		if (ret <= 0)
883
			return ret;
884 885
	}

886
	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
887 888
}

889 890
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
891
	struct probe_finder *pf = data;
892
	struct perf_probe_point *pp = &pf->pev->point;
893
	Dwarf_Addr addr;
894
	int ret;
895

896
	if (pp->lazy_line)
897
		ret = find_probe_point_lazy(in_die, pf);
898 899
	else {
		/* Get probe address */
900
		if (dwarf_entrypc(in_die, &addr) != 0) {
M
Masami Hiramatsu 已提交
901
			pr_warning("Failed to get entry address of %s.\n",
902
				   dwarf_diename(in_die));
903
			return -ENOENT;
904 905
		}
		pf->addr = addr;
906 907 908 909
		pf->addr += pp->offset;
		pr_debug("found inline addr: 0x%jx\n",
			 (uintmax_t)pf->addr);

910
		ret = call_probe_finder(in_die, pf);
911
	}
912

913
	return ret;
914
}
915

916 917 918 919 920 921
/* Callback parameter with return value for libdw */
struct dwarf_callback_param {
	void *data;
	int retval;
};

922
/* Search function from function name */
923
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
924
{
925 926
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
927
	struct perf_probe_point *pp = &pf->pev->point;
928

929
	/* Check tag and diename */
930
	if (!die_is_func_def(sp_die) ||
931
	    !die_match_name(sp_die, pp->function))
932
		return DWARF_CB_OK;
933

934 935 936 937
	/* Check declared file */
	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

938
	pr_debug("Matched function: %s\n", dwarf_diename(sp_die));
939
	pf->fname = dwarf_decl_file(sp_die);
940 941 942
	if (pp->line) { /* Function relative line */
		dwarf_decl_line(sp_die, &pf->lno);
		pf->lno += pp->line;
943
		param->retval = find_probe_point_by_line(pf);
944 945 946
	} else if (die_is_func_instance(sp_die)) {
		/* Instances always have the entry address */
		dwarf_entrypc(sp_die, &pf->addr);
947
		/* Real function */
948
		if (pp->lazy_line)
949
			param->retval = find_probe_point_lazy(sp_die, pf);
950 951 952
		else {
			pf->addr += pp->offset;
			/* TODO: Check the address in this function */
953
			param->retval = call_probe_finder(sp_die, pf);
954
		}
955
	} else if (!probe_conf.no_inlines) {
956
		/* Inlined function: search instances */
957 958
		param->retval = die_walk_instances(sp_die,
					probe_point_inline_cb, (void *)pf);
959 960 961 962 963 964 965 966 967 968
		/* This could be a non-existed inline definition */
		if (param->retval == -ENOENT && strisglob(pp->function))
			param->retval = 0;
	}

	/* We need to find other candidates */
	if (strisglob(pp->function) && param->retval >= 0) {
		param->retval = 0;	/* We have to clear the result */
		return DWARF_CB_OK;
	}
969

970
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
971 972
}

973
static int find_probe_point_by_func(struct probe_finder *pf)
974
{
975 976 977 978
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
979 980
}

981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996
struct pubname_callback_param {
	char *function;
	char *file;
	Dwarf_Die *cu_die;
	Dwarf_Die *sp_die;
	int found;
};

static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
{
	struct pubname_callback_param *param = data;

	if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
		if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
			return DWARF_CB_OK;

997
		if (die_match_name(param->sp_die, param->function)) {
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
			if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
				return DWARF_CB_OK;

			if (param->file &&
			    strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
				return DWARF_CB_OK;

			param->found = 1;
			return DWARF_CB_ABORT;
		}
	}

	return DWARF_CB_OK;
}

1013
/* Find probe points from debuginfo */
1014
static int debuginfo__find_probes(struct debuginfo *dbg,
1015
				  struct probe_finder *pf)
1016
{
1017
	struct perf_probe_point *pp = &pf->pev->point;
1018 1019 1020
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1021
	int ret = 0;
1022

1023
#if _ELFUTILS_PREREQ(0, 142)
1024 1025 1026 1027
	Elf *elf;
	GElf_Ehdr ehdr;
	GElf_Shdr shdr;

1028
	/* Get the call frame information from this dwarf */
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
	elf = dwarf_getelf(dbg->dbg);
	if (elf == NULL)
		return -EINVAL;

	if (gelf_getehdr(elf, &ehdr) == NULL)
		return -EINVAL;

	if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
	    shdr.sh_type == SHT_PROGBITS) {
		pf->cfi = dwarf_getcfi_elf(elf);
	} else {
		pf->cfi = dwarf_getcfi(dbg->dbg);
	}
1042
#endif
1043

1044
	off = 0;
1045 1046 1047
	pf->lcache = intlist__new(NULL);
	if (!pf->lcache)
		return -ENOMEM;
1048 1049

	/* Fastpath: lookup by function name from .debug_pubnames section */
1050
	if (pp->function && !strisglob(pp->function)) {
1051 1052 1053 1054 1055
		struct pubname_callback_param pubname_param = {
			.function = pp->function,
			.file	  = pp->file,
			.cu_die	  = &pf->cu_die,
			.sp_die	  = &pf->sp_die,
1056
			.found	  = 0,
1057 1058 1059 1060 1061
		};
		struct dwarf_callback_param probe_param = {
			.data = pf,
		};

1062
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1063
				  &pubname_param, 0);
1064 1065 1066 1067 1068 1069 1070
		if (pubname_param.found) {
			ret = probe_point_search_cb(&pf->sp_die, &probe_param);
			if (ret)
				goto found;
		}
	}

1071
	/* Loop on CUs (Compilation Unit) */
1072
	while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1073
		/* Get the DIE(Debugging Information Entry) of this CU */
1074
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1075 1076
		if (!diep)
			continue;
1077 1078 1079

		/* Check if target file is included. */
		if (pp->file)
1080
			pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1081
		else
1082
			pf->fname = NULL;
1083

1084
		if (!pp->file || pf->fname) {
1085
			if (pp->function)
1086
				ret = find_probe_point_by_func(pf);
1087
			else if (pp->lazy_line)
1088
				ret = find_probe_point_lazy(&pf->cu_die, pf);
1089
			else {
1090 1091
				pf->lno = pp->line;
				ret = find_probe_point_by_line(pf);
1092
			}
1093
			if (ret < 0)
1094
				break;
1095
		}
1096
		off = noff;
1097
	}
1098 1099

found:
1100 1101
	intlist__delete(pf->lcache);
	pf->lcache = NULL;
1102

1103 1104 1105
	return ret;
}

1106 1107 1108
struct local_vars_finder {
	struct probe_finder *pf;
	struct perf_probe_arg *args;
1109
	bool vars;
1110 1111 1112 1113 1114 1115 1116 1117 1118
	int max_args;
	int nargs;
	int ret;
};

/* Collect available variables in this scope */
static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
{
	struct local_vars_finder *vf = data;
1119
	struct probe_finder *pf = vf->pf;
1120 1121 1122 1123
	int tag;

	tag = dwarf_tag(die_mem);
	if (tag == DW_TAG_formal_parameter ||
1124
	    (tag == DW_TAG_variable && vf->vars)) {
1125
		if (convert_variable_location(die_mem, vf->pf->addr,
1126 1127
					      vf->pf->fb_ops, &pf->sp_die,
					      NULL) == 0) {
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
			vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
			if (vf->args[vf->nargs].var == NULL) {
				vf->ret = -ENOMEM;
				return DIE_FIND_CB_END;
			}
			pr_debug(" %s", vf->args[vf->nargs].var);
			vf->nargs++;
		}
	}

	if (dwarf_haspc(die_mem, vf->pf->addr))
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
}

static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
			     struct perf_probe_arg *args)
{
	Dwarf_Die die_mem;
	int i;
	int n = 0;
1150
	struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1151 1152 1153 1154
				.max_args = MAX_PROBE_ARGS, .ret = 0};

	for (i = 0; i < pf->pev->nargs; i++) {
		/* var never be NULL */
1155 1156 1157
		if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
			vf.vars = true;
		else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
1158 1159 1160
			/* Copy normal argument */
			args[n] = pf->pev->args[i];
			n++;
1161
			continue;
1162
		}
1163 1164 1165 1166 1167 1168 1169 1170 1171
		pr_debug("Expanding %s into:", pf->pev->args[i].var);
		vf.nargs = n;
		/* Special local variables */
		die_find_child(sc_die, copy_variables_cb, (void *)&vf,
			       &die_mem);
		pr_debug(" (%d)\n", vf.nargs - n);
		if (vf.ret < 0)
			return vf.ret;
		n = vf.nargs;
1172 1173 1174 1175
	}
	return n;
}

1176
/* Add a found probe point into trace event list */
1177
static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1178 1179 1180 1181
{
	struct trace_event_finder *tf =
			container_of(pf, struct trace_event_finder, pf);
	struct probe_trace_event *tev;
1182
	struct perf_probe_arg *args;
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
	int ret, i;

	/* Check number of tevs */
	if (tf->ntevs == tf->max_tevs) {
		pr_warning("Too many( > %d) probe point found.\n",
			   tf->max_tevs);
		return -ERANGE;
	}
	tev = &tf->tevs[tf->ntevs++];

1193
	/* Trace point should be converted from subprogram DIE */
1194
	ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1195
				     pf->pev->point.retprobe, &tev->point);
1196 1197 1198
	if (ret < 0)
		return ret;

1199 1200 1201 1202
	tev->point.realname = strdup(dwarf_diename(sc_die));
	if (!tev->point.realname)
		return -ENOMEM;

1203 1204 1205
	pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
		 tev->point.offset);

1206 1207 1208
	/* Expand special probe argument if exist */
	args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
	if (args == NULL)
1209
		return -ENOMEM;
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224

	ret = expand_probe_args(sc_die, pf, args);
	if (ret < 0)
		goto end;

	tev->nargs = ret;
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
	if (tev->args == NULL) {
		ret = -ENOMEM;
		goto end;
	}

	/* Find each argument */
	for (i = 0; i < tev->nargs; i++) {
		pf->pvar = &args[i];
1225
		pf->tvar = &tev->args[i];
1226 1227
		/* Variable should be found from scope DIE */
		ret = find_variable(sc_die, pf);
1228
		if (ret != 0)
1229
			break;
1230 1231
	}

1232 1233 1234
end:
	free(args);
	return ret;
1235 1236 1237
}

/* Find probe_trace_events specified by perf_probe_event from debuginfo */
1238
int debuginfo__find_trace_events(struct debuginfo *dbg,
1239
				 struct perf_probe_event *pev,
1240
				 struct probe_trace_event **tevs)
1241 1242 1243
{
	struct trace_event_finder tf = {
			.pf = {.pev = pev, .callback = add_probe_trace_event},
1244
			.max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1245 1246 1247
	int ret;

	/* Allocate result tevs array */
1248
	*tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1249 1250 1251 1252 1253 1254
	if (*tevs == NULL)
		return -ENOMEM;

	tf.tevs = *tevs;
	tf.ntevs = 0;

1255
	ret = debuginfo__find_probes(dbg, &tf.pf);
1256
	if (ret < 0) {
1257
		zfree(tevs);
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
		return ret;
	}

	return (ret < 0) ? ret : tf.ntevs;
}

/* Collect available variables in this scope */
static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
{
	struct available_var_finder *af = data;
	struct variable_list *vl;
	int tag, ret;

	vl = &af->vls[af->nvls - 1];

	tag = dwarf_tag(die_mem);
	if (tag == DW_TAG_formal_parameter ||
	    tag == DW_TAG_variable) {
		ret = convert_variable_location(die_mem, af->pf.addr,
1277 1278
						af->pf.fb_ops, &af->pf.sp_die,
						NULL);
1279 1280 1281
		if (ret == 0 || ret == -ERANGE) {
			int ret2;
			bool externs = !af->child;
1282 1283 1284
			struct strbuf buf;

			strbuf_init(&buf, 64);
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306

			if (probe_conf.show_location_range) {
				if (!externs) {
					if (ret)
						strbuf_addf(&buf, "[INV]\t");
					else
						strbuf_addf(&buf, "[VAL]\t");
				} else
					strbuf_addf(&buf, "[EXT]\t");
			}

			ret2 = die_get_varname(die_mem, &buf);

			if (!ret2 && probe_conf.show_location_range &&
				!externs) {
				strbuf_addf(&buf, "\t");
				ret2 = die_get_var_range(&af->pf.sp_die,
							die_mem, &buf);
			}

			pr_debug("Add new var: %s\n", buf.buf);
			if (ret2 == 0) {
1307 1308 1309 1310
				strlist__add(vl->vars,
					strbuf_detach(&buf, NULL));
			}
			strbuf_release(&buf);
1311 1312 1313
		}
	}

1314
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1315 1316 1317 1318 1319 1320
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
}

/* Add a found vars into available variables list */
1321
static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1322 1323 1324 1325
{
	struct available_var_finder *af =
			container_of(pf, struct available_var_finder, pf);
	struct variable_list *vl;
1326 1327
	Dwarf_Die die_mem;
	int ret;
1328 1329 1330 1331 1332 1333 1334 1335

	/* Check number of tevs */
	if (af->nvls == af->max_vls) {
		pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
		return -ERANGE;
	}
	vl = &af->vls[af->nvls++];

1336
	/* Trace point should be converted from subprogram DIE */
1337
	ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1338
				     pf->pev->point.retprobe, &vl->point);
1339 1340 1341 1342 1343 1344 1345
	if (ret < 0)
		return ret;

	pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
		 vl->point.offset);

	/* Find local variables */
1346
	vl->vars = strlist__new(NULL, NULL);
1347 1348
	if (vl->vars == NULL)
		return -ENOMEM;
1349
	af->child = true;
1350
	die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1351

1352
	/* Find external variables */
1353
	if (!probe_conf.show_ext_vars)
1354
		goto out;
1355
	/* Don't need to search child DIE for external vars. */
1356
	af->child = false;
1357
	die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1358 1359

out:
1360 1361 1362 1363 1364 1365 1366 1367
	if (strlist__empty(vl->vars)) {
		strlist__delete(vl->vars);
		vl->vars = NULL;
	}

	return ret;
}

1368 1369 1370 1371 1372
/*
 * Find available variables at given probe point
 * Return the number of found probe points. Return 0 if there is no
 * matched probe point. Return <0 if an error occurs.
 */
1373
int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1374
				      struct perf_probe_event *pev,
1375
				      struct variable_list **vls)
1376 1377 1378
{
	struct available_var_finder af = {
			.pf = {.pev = pev, .callback = add_available_vars},
1379
			.mod = dbg->mod,
1380
			.max_vls = probe_conf.max_probes};
1381 1382 1383
	int ret;

	/* Allocate result vls array */
1384
	*vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1385 1386 1387 1388 1389 1390
	if (*vls == NULL)
		return -ENOMEM;

	af.vls = *vls;
	af.nvls = 0;

1391
	ret = debuginfo__find_probes(dbg, &af.pf);
1392 1393 1394
	if (ret < 0) {
		/* Free vlist for error */
		while (af.nvls--) {
1395
			zfree(&af.vls[af.nvls].point.symbol);
1396
			strlist__delete(af.vls[af.nvls].vars);
1397
		}
1398
		zfree(vls);
1399 1400 1401 1402
		return ret;
	}

	return (ret < 0) ? ret : af.nvls;
1403 1404
}

1405
/* Reverse search */
1406
int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1407
				struct perf_probe_point *ppt)
1408 1409
{
	Dwarf_Die cudie, spdie, indie;
1410 1411
	Dwarf_Addr _addr = 0, baseaddr = 0;
	const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1412
	int baseline = 0, lineno = 0, ret = 0;
1413 1414

	/* Find cu die */
1415
	if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
M
Masami Hiramatsu 已提交
1416 1417
		pr_warning("Failed to find debug information for address %lx\n",
			   addr);
1418 1419 1420
		ret = -EINVAL;
		goto end;
	}
1421

1422 1423 1424
	/* Find a corresponding line (filename and lineno) */
	cu_find_lineinfo(&cudie, addr, &fname, &lineno);
	/* Don't care whether it failed or not */
1425

1426
	/* Find a corresponding function (name, baseline and baseaddr) */
1427
	if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1428
		/* Get function entry information */
1429 1430
		func = basefunc = dwarf_diename(&spdie);
		if (!func ||
1431
		    dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1432 1433
		    dwarf_decl_line(&spdie, &baseline) != 0) {
			lineno = 0;
1434
			goto post;
1435
		}
1436

1437
		fname = dwarf_decl_file(&spdie);
1438
		if (addr == (unsigned long)baseaddr) {
1439 1440
			/* Function entry - Relative line number is 0 */
			lineno = baseline;
1441 1442 1443 1444 1445 1446 1447
			goto post;
		}

		/* Track down the inline functions step by step */
		while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
						&indie)) {
			/* There is an inline function */
1448
			if (dwarf_entrypc(&indie, &_addr) == 0 &&
1449
			    _addr == addr) {
1450 1451 1452
				/*
				 * addr is at an inline function entry.
				 * In this case, lineno should be the call-site
1453
				 * line number. (overwrite lineinfo)
1454 1455
				 */
				lineno = die_get_call_lineno(&indie);
1456 1457 1458
				fname = die_get_call_file(&indie);
				break;
			} else {
1459 1460 1461 1462 1463 1464
				/*
				 * addr is in an inline function body.
				 * Since lineno points one of the lines
				 * of the inline function, baseline should
				 * be the entry line of the inline function.
				 */
1465
				tmp = dwarf_diename(&indie);
1466 1467 1468 1469 1470
				if (!tmp ||
				    dwarf_decl_line(&indie, &baseline) != 0)
					break;
				func = tmp;
				spdie = indie;
1471
			}
1472
		}
1473 1474 1475 1476
		/* Verify the lineno and baseline are in a same file */
		tmp = dwarf_decl_file(&spdie);
		if (!tmp || strcmp(tmp, fname) != 0)
			lineno = 0;
1477 1478 1479 1480 1481 1482
	}

post:
	/* Make a relative line number or an offset */
	if (lineno)
		ppt->line = lineno - baseline;
1483
	else if (basefunc) {
1484
		ppt->offset = addr - (unsigned long)baseaddr;
1485 1486
		func = basefunc;
	}
1487 1488 1489 1490

	/* Duplicate strings */
	if (func) {
		ppt->function = strdup(func);
1491 1492 1493 1494
		if (ppt->function == NULL) {
			ret = -ENOMEM;
			goto end;
		}
1495
	}
1496 1497 1498
	if (fname) {
		ppt->file = strdup(fname);
		if (ppt->file == NULL) {
1499
			zfree(&ppt->function);
1500 1501 1502 1503
			ret = -ENOMEM;
			goto end;
		}
	}
1504
end:
1505 1506
	if (ret == 0 && (fname || func))
		ret = 1;	/* Found a point */
1507 1508 1509
	return ret;
}

1510 1511 1512 1513
/* Add a line and store the src path */
static int line_range_add_line(const char *src, unsigned int lineno,
			       struct line_range *lr)
{
1514
	/* Copy source path */
1515
	if (!lr->path) {
1516 1517 1518
		lr->path = strdup(src);
		if (lr->path == NULL)
			return -ENOMEM;
1519
	}
1520
	return intlist__add(lr->line_list, lineno);
1521 1522
}

1523
static int line_range_walk_cb(const char *fname, int lineno,
1524
			      Dwarf_Addr addr __maybe_unused,
1525
			      void *data)
1526
{
1527
	struct line_finder *lf = data;
1528
	int err;
1529

1530
	if ((strtailcmp(fname, lf->fname) != 0) ||
1531
	    (lf->lno_s > lineno || lf->lno_e < lineno))
1532
		return 0;
1533

1534 1535 1536
	err = line_range_add_line(fname, lineno, lf->lr);
	if (err < 0 && err != -EEXIST)
		return err;
1537

1538
	return 0;
1539
}
1540

1541
/* Find line range from its line number */
1542
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1543
{
1544
	int ret;
1545

1546
	ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1547

1548
	/* Update status */
1549
	if (ret >= 0)
1550
		if (!intlist__empty(lf->lr->line_list))
1551 1552 1553
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1554
	else {
1555
		zfree(&lf->lr->path);
1556
	}
1557
	return ret;
1558 1559
}

1560 1561
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1562
	int ret = find_line_range_by_line(in_die, data);
1563 1564 1565 1566

	/*
	 * We have to check all instances of inlined function, because
	 * some execution paths can be optimized out depends on the
1567 1568
	 * function argument of instances. However, if an error occurs,
	 * it should be handled by the caller.
1569
	 */
1570
	return ret < 0 ? ret : 0;
1571 1572
}

1573
/* Search function definition from function name */
1574
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1575
{
1576 1577
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1578 1579
	struct line_range *lr = lf->lr;

1580 1581 1582 1583
	/* Check declared file */
	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

1584
	if (die_is_func_def(sp_die) &&
1585
	    die_match_name(sp_die, lr->function)) {
1586 1587
		lf->fname = dwarf_decl_file(sp_die);
		dwarf_decl_line(sp_die, &lr->offset);
1588
		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1589
		lf->lno_s = lr->offset + lr->start;
1590 1591 1592 1593
		if (lf->lno_s < 0)	/* Overflow */
			lf->lno_s = INT_MAX;
		lf->lno_e = lr->offset + lr->end;
		if (lf->lno_e < 0)	/* Overflow */
1594
			lf->lno_e = INT_MAX;
1595
		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1596 1597
		lr->start = lf->lno_s;
		lr->end = lf->lno_e;
1598
		if (!die_is_func_instance(sp_die))
1599 1600 1601
			param->retval = die_walk_instances(sp_die,
						line_range_inline_cb, lf);
		else
1602 1603
			param->retval = find_line_range_by_line(sp_die, lf);
		return DWARF_CB_ABORT;
1604
	}
1605
	return DWARF_CB_OK;
1606 1607
}

1608
static int find_line_range_by_func(struct line_finder *lf)
1609
{
1610 1611 1612
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1613 1614
}

1615
int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1616
{
1617
	struct line_finder lf = {.lr = lr, .found = 0};
1618
	int ret = 0;
1619 1620 1621
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1622
	const char *comp_dir;
1623

1624 1625 1626 1627 1628 1629 1630 1631
	/* Fastpath: lookup by function name from .debug_pubnames section */
	if (lr->function) {
		struct pubname_callback_param pubname_param = {
			.function = lr->function, .file = lr->file,
			.cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
		struct dwarf_callback_param line_range_param = {
			.data = (void *)&lf, .retval = 0};

1632
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1633
				  &pubname_param, 0);
1634 1635 1636 1637 1638 1639 1640
		if (pubname_param.found) {
			line_range_search_cb(&lf.sp_die, &line_range_param);
			if (lf.found)
				goto found;
		}
	}

1641
	/* Loop on CUs (Compilation Unit) */
1642
	while (!lf.found && ret >= 0) {
1643
		if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1644
				 NULL, NULL, NULL) != 0)
1645 1646 1647
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1648
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1649 1650
		if (!diep)
			continue;
1651 1652 1653

		/* Check if target file is included. */
		if (lr->file)
1654
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1655
		else
1656
			lf.fname = 0;
1657

1658
		if (!lr->file || lf.fname) {
1659
			if (lr->function)
1660
				ret = find_line_range_by_func(&lf);
1661 1662
			else {
				lf.lno_s = lr->start;
1663
				lf.lno_e = lr->end;
1664
				ret = find_line_range_by_line(NULL, &lf);
1665 1666
			}
		}
1667
		off = noff;
1668
	}
1669

1670
found:
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
	/* Store comp_dir */
	if (lf.found) {
		comp_dir = cu_get_comp_dir(&lf.cu_die);
		if (comp_dir) {
			lr->comp_dir = strdup(comp_dir);
			if (!lr->comp_dir)
				ret = -ENOMEM;
		}
	}

1681
	pr_debug("path: %s\n", lr->path);
1682
	return (ret < 0) ? ret : lf.found;
1683 1684
}

1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742
/*
 * Find a src file from a DWARF tag path. Prepend optional source path prefix
 * and chop off leading directories that do not exist. Result is passed back as
 * a newly allocated path on success.
 * Return 0 if file was found and readable, -errno otherwise.
 */
int get_real_path(const char *raw_path, const char *comp_dir,
			 char **new_path)
{
	const char *prefix = symbol_conf.source_prefix;

	if (!prefix) {
		if (raw_path[0] != '/' && comp_dir)
			/* If not an absolute path, try to use comp_dir */
			prefix = comp_dir;
		else {
			if (access(raw_path, R_OK) == 0) {
				*new_path = strdup(raw_path);
				return *new_path ? 0 : -ENOMEM;
			} else
				return -errno;
		}
	}

	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
	if (!*new_path)
		return -ENOMEM;

	for (;;) {
		sprintf(*new_path, "%s/%s", prefix, raw_path);

		if (access(*new_path, R_OK) == 0)
			return 0;

		if (!symbol_conf.source_prefix) {
			/* In case of searching comp_dir, don't retry */
			zfree(new_path);
			return -errno;
		}

		switch (errno) {
		case ENAMETOOLONG:
		case ENOENT:
		case EROFS:
		case EFAULT:
			raw_path = strchr(++raw_path, '/');
			if (!raw_path) {
				zfree(new_path);
				return -ENOENT;
			}
			continue;

		default:
			zfree(new_path);
			return -errno;
		}
	}
}