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 74
	dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
	if (!dbg->mod)
75 76
		goto error;

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

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

	return -ENOENT;
90 91
}

92
static struct debuginfo *__debuginfo__new(const char *path)
93
{
94 95
	struct debuginfo *dbg = zalloc(sizeof(*dbg));
	if (!dbg)
96 97
		return NULL;

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

105 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 136 137 138 139
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);
	}
	dso__delete(dso);

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

140
void debuginfo__delete(struct debuginfo *dbg)
141
{
142 143 144 145
	if (dbg) {
		if (dbg->dwfl)
			dwfl_end(dbg->dwfl);
		free(dbg);
146
	}
147
}
148

149 150 151 152
/*
 * Probe finder related functions
 */

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

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

182 183 184
	if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
		goto static_var;

185
	/* TODO: handle more than 1 exprs */
186 187 188 189
	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);
190 191 192 193 194 195 196 197 198 199 200 201 202
		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)
203 204 205 206 207 208 209 210 211 212
			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;
		}
213 214
		return -ENOENT;
	}
215 216 217 218
found:
	if (nops == 0)
		/* TODO: Support const_value */
		return -ENOENT;
219 220

	if (op->atom == DW_OP_addr) {
221
static_var:
222
		if (!tvar)
223
			return ret2;
224 225 226 227 228 229 230 231 232
		/* 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;
233
		return ret2;
234
	}
235 236

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

245 246 247
	if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
		regn = op->atom - DW_OP_breg0;
		offs += op->number;
248
		ref = true;
249 250 251 252 253
	} 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;
254
		ref = true;
255 256
	} else if (op->atom == DW_OP_regx) {
		regn = op->number;
257
	} else {
258
		pr_debug("DW_OP %x is not supported.\n", op->atom);
259 260
		return -ENOTSUP;
	}
261

262
	if (!tvar)
263
		return ret2;
264

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

273 274 275 276
	tvar->value = strdup(regs);
	if (tvar->value == NULL)
		return -ENOMEM;

277
	if (ref) {
278
		tvar->ref = alloc_trace_arg_ref((long)offs);
279 280
		if (tvar->ref == NULL)
			return -ENOMEM;
281
	}
282
	return ret2;
283 284
}

285 286
#define BYTES_TO_BITS(nb)	((nb) * BITS_PER_LONG / sizeof(long))

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

298 299 300 301 302 303 304
	/* 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;
	}

305 306
	bsize = dwarf_bitsize(vr_die);
	if (bsize > 0) {
307
		/* This is a bitfield */
308 309 310 311 312 313
		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));
314 315 316
		goto formatted;
	}

317 318 319 320 321
	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;
	}
322

323 324 325
	pr_debug("%s type is %s.\n",
		 dwarf_diename(vr_die), dwarf_diename(&type));

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

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

367 368 369 370 371
	/* 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;
372
	}
373 374 375 376 377 378 379 380
	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",
381
			   strerror_r(-ret, sbuf, sizeof(sbuf)));
382 383 384 385 386
		return ret;
	}
	tvar->type = strdup(buf);
	if (tvar->type == NULL)
		return -ENOMEM;
387
	return 0;
388 389
}

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

	pr_debug("converting %s in %s\n", field->name, varname);
401 402 403 404
	if (die_get_real_type(vr_die, &type) == NULL) {
		pr_warning("Failed to get the type of %s.\n", varname);
		return -ENOENT;
	}
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
	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) {
421
			ref = zalloc(sizeof(struct probe_trace_arg_ref));
422 423 424 425 426 427 428
			if (ref == NULL)
				return -ENOMEM;
			if (*ref_ptr)
				(*ref_ptr)->next = ref;
			else
				*ref_ptr = ref;
		}
429
		ref->offset += dwarf_bytesize(&type) * field->index;
430 431 432 433 434 435
		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 */
436 437 438 439 440
		if (!field->ref) {
			pr_err("Semantic error: %s must be referred by '->'\n",
			       field->name);
			return -EINVAL;
		}
441
		/* Get the type pointed by this pointer */
442 443 444 445
		if (die_get_real_type(&type, &type) == NULL) {
			pr_warning("Failed to get the type of %s.\n", varname);
			return -ENOENT;
		}
446
		/* Verify it is a data structure  */
447 448 449 450
		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);
451 452
			return -EINVAL;
		}
453

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

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

	/* Get the offset of the field */
493 494 495 496 497 498 499 500 501
	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;
		}
502
	}
503 504
	ref->offset += (long)offs;

505 506 507 508 509
	/* 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);

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

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

525 526
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
527

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

547 548
/* Find a variable in a scope DIE */
static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
549
{
550
	Dwarf_Die vr_die;
551
	char buf[32], *ptr;
552
	int ret = 0;
553

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
	if (!is_c_varname(pf->pvar->var)) {
		/* Copy raw parameters */
		pf->tvar->value = strdup(pf->pvar->var);
		if (pf->tvar->value == NULL)
			return -ENOMEM;
		if (pf->pvar->type) {
			pf->tvar->type = strdup(pf->pvar->type);
			if (pf->tvar->type == NULL)
				return -ENOMEM;
		}
		if (pf->pvar->name) {
			pf->tvar->name = strdup(pf->pvar->name);
			if (pf->tvar->name == NULL)
				return -ENOMEM;
		} else
			pf->tvar->name = NULL;
		return 0;
	}

573
	if (pf->pvar->name)
574
		pf->tvar->name = strdup(pf->pvar->name);
575
	else {
576 577 578
		ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
		if (ret < 0)
			return ret;
579 580 581
		ptr = strchr(buf, ':');	/* Change type separator to _ */
		if (ptr)
			*ptr = '_';
582
		pf->tvar->name = strdup(buf);
583
	}
584 585
	if (pf->tvar->name == NULL)
		return -ENOMEM;
586

587
	pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
588
	/* Search child die for local variables and parameters. */
589 590
	if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
		/* Search again in global variables */
591 592
		if (!die_find_variable_at(&pf->cu_die, pf->pvar->var,
						0, &vr_die)) {
593 594
			pr_warning("Failed to find '%s' in this function.\n",
				   pf->pvar->var);
595
			ret = -ENOENT;
596
		}
597
	}
598
	if (ret >= 0)
599 600
		ret = convert_variable(&vr_die, pf);

601
	return ret;
602 603
}

604
/* Convert subprogram DIE to trace point */
605 606 607
static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
				  Dwarf_Addr paddr, bool retprobe,
				  struct probe_trace_point *tp)
608
{
609
	Dwarf_Addr eaddr, highaddr;
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
	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;
	}

630
	symbol = dwarf_diename(sp_die);
631
	if (!symbol) {
632 633 634 635 636 637 638 639
		/* 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;
640
	}
641
	tp->offset = (unsigned long)(paddr - eaddr);
642
	tp->address = (unsigned long)paddr;
643 644 645
	tp->symbol = strdup(symbol);
	if (!tp->symbol)
		return -ENOMEM;
646

647
	/* Return probe must be on the head of a subprogram */
648 649
	if (retprobe) {
		if (eaddr != paddr) {
650
			pr_warning("Return probe must be on the head of"
M
Masami Hiramatsu 已提交
651
				   " a real function.\n");
652 653
			return -EINVAL;
		}
654
		tp->retprobe = true;
655 656
	}

657 658 659
	return 0;
}

660 661
/* Call probe_finder callback with scope DIE */
static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
662 663 664 665 666
{
	Dwarf_Attribute fb_attr;
	size_t nops;
	int ret;

667 668 669 670 671 672
	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 */
673
	if (!die_is_func_def(sc_die)) {
674
		if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
675 676 677 678
			pr_warning("Failed to find probe point in any "
				   "functions.\n");
			return -ENOENT;
		}
679 680
	} else
		memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
681

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

700
	/* Call finder's callback handler */
701
	ret = pf->callback(sc_die, pf);
702 703 704

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

	return ret;
707 708
}

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
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) {
732
		if (die_match_name(fn_die, fsp->function)) {
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 763 764 765 766
			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;
}

767 768
static int probe_point_line_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
769
{
770
	struct probe_finder *pf = data;
771
	Dwarf_Die *sc_die, die_mem;
772
	int ret;
773

774 775
	if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
		return 0;
776

777
	pf->addr = addr;
778 779 780 781 782 783 784
	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);
785

786
	/* Continue if no error, because the line will be in inline function */
787
	return ret < 0 ? ret : 0;
788
}
789

790 791 792 793
/* 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);
794 795
}

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

	fp = fopen(fname, "r");
	if (!fp) {
809 810
		pr_warning("Failed to open %s: %s\n", fname,
			   strerror_r(errno, sbuf, sizeof(sbuf)));
811
		return -errno;
812 813
	}

814
	while ((len = getline(&line, &line_len, fp)) > 0) {
815

816 817 818 819
		if (line[len - 1] == '\n')
			line[len - 1] = '\0';

		if (strlazymatch(line, pat)) {
820
			intlist__add(list, linenum);
821
			count++;
822
		}
823
		linenum++;
824
	}
825 826 827 828 829 830 831 832 833

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

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

836 837 838 839
static int probe_point_lazy_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
{
	struct probe_finder *pf = data;
840
	Dwarf_Die *sc_die, die_mem;
841 842
	int ret;

843
	if (!intlist__has_entry(pf->lcache, lineno) ||
844 845 846 847 848 849
	    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;
850 851 852 853 854 855 856 857
	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);
858 859 860 861 862

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

866
/* Find probe points from lazy pattern  */
867
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
868
{
869
	int ret = 0;
870
	char *fpath;
871

872
	if (intlist__empty(pf->lcache)) {
873 874 875 876 877 878 879 880 881
		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;
		}

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

890
	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
891 892
}

893 894
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
895
	struct probe_finder *pf = data;
896
	struct perf_probe_point *pp = &pf->pev->point;
897
	Dwarf_Addr addr;
898
	int ret;
899

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

914
		ret = call_probe_finder(in_die, pf);
915
	}
916

917
	return ret;
918
}
919

920 921 922 923 924 925
/* Callback parameter with return value for libdw */
struct dwarf_callback_param {
	void *data;
	int retval;
};

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

933
	/* Check tag and diename */
934
	if (!die_is_func_def(sp_die) ||
935
	    !die_match_name(sp_die, pp->function))
936
		return DWARF_CB_OK;
937

938 939 940 941
	/* Check declared file */
	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

942
	pr_debug("Matched function: %s\n", dwarf_diename(sp_die));
943
	pf->fname = dwarf_decl_file(sp_die);
944 945 946
	if (pp->line) { /* Function relative line */
		dwarf_decl_line(sp_die, &pf->lno);
		pf->lno += pp->line;
947
		param->retval = find_probe_point_by_line(pf);
948 949 950
	} else if (die_is_func_instance(sp_die)) {
		/* Instances always have the entry address */
		dwarf_entrypc(sp_die, &pf->addr);
951
		/* Real function */
952
		if (pp->lazy_line)
953
			param->retval = find_probe_point_lazy(sp_die, pf);
954 955 956
		else {
			pf->addr += pp->offset;
			/* TODO: Check the address in this function */
957
			param->retval = call_probe_finder(sp_die, pf);
958
		}
959
	} else if (!probe_conf.no_inlines) {
960
		/* Inlined function: search instances */
961 962
		param->retval = die_walk_instances(sp_die,
					probe_point_inline_cb, (void *)pf);
963 964 965 966 967 968 969 970 971 972
		/* 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;
	}
973

974
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
975 976
}

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

985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
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;

1001
		if (die_match_name(param->sp_die, param->function)) {
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
			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;
}

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

1027
#if _ELFUTILS_PREREQ(0, 142)
1028 1029 1030 1031
	Elf *elf;
	GElf_Ehdr ehdr;
	GElf_Shdr shdr;

1032
	/* Get the call frame information from this dwarf */
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
	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);
	}
1046
#endif
1047

1048
	off = 0;
1049 1050 1051
	pf->lcache = intlist__new(NULL);
	if (!pf->lcache)
		return -ENOMEM;
1052 1053

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

1066
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1067
				  &pubname_param, 0);
1068 1069 1070 1071 1072 1073 1074
		if (pubname_param.found) {
			ret = probe_point_search_cb(&pf->sp_die, &probe_param);
			if (ret)
				goto found;
		}
	}

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

		/* Check if target file is included. */
		if (pp->file)
1084
			pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1085
		else
1086
			pf->fname = NULL;
1087

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

found:
1104 1105
	intlist__delete(pf->lcache);
	pf->lcache = NULL;
1106

1107 1108 1109
	return ret;
}

1110 1111 1112
struct local_vars_finder {
	struct probe_finder *pf;
	struct perf_probe_arg *args;
1113
	bool vars;
1114 1115 1116 1117 1118 1119 1120 1121 1122
	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;
1123
	struct probe_finder *pf = vf->pf;
1124 1125 1126 1127
	int tag;

	tag = dwarf_tag(die_mem);
	if (tag == DW_TAG_formal_parameter ||
1128
	    (tag == DW_TAG_variable && vf->vars)) {
1129
		if (convert_variable_location(die_mem, vf->pf->addr,
1130 1131
					      vf->pf->fb_ops, &pf->sp_die,
					      NULL) == 0) {
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
			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;
1154
	struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1155 1156 1157 1158
				.max_args = MAX_PROBE_ARGS, .ret = 0};

	for (i = 0; i < pf->pev->nargs; i++) {
		/* var never be NULL */
1159 1160 1161
		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) {
1162 1163 1164
			/* Copy normal argument */
			args[n] = pf->pev->args[i];
			n++;
1165
			continue;
1166
		}
1167 1168 1169 1170 1171 1172 1173 1174 1175
		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;
1176 1177 1178 1179
	}
	return n;
}

1180
/* Add a found probe point into trace event list */
1181
static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1182 1183 1184 1185
{
	struct trace_event_finder *tf =
			container_of(pf, struct trace_event_finder, pf);
	struct probe_trace_event *tev;
1186
	struct perf_probe_arg *args;
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
	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++];

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

1203 1204 1205 1206
	tev->point.realname = strdup(dwarf_diename(sc_die));
	if (!tev->point.realname)
		return -ENOMEM;

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

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

	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];
1229
		pf->tvar = &tev->args[i];
1230 1231
		/* Variable should be found from scope DIE */
		ret = find_variable(sc_die, pf);
1232
		if (ret != 0)
1233
			break;
1234 1235
	}

1236 1237 1238
end:
	free(args);
	return ret;
1239 1240 1241
}

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

	/* Allocate result tevs array */
1252
	*tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1253 1254 1255 1256 1257 1258
	if (*tevs == NULL)
		return -ENOMEM;

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

1259
	ret = debuginfo__find_probes(dbg, &tf.pf);
1260
	if (ret < 0) {
1261
		zfree(tevs);
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
		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,
1281 1282
						af->pf.fb_ops, &af->pf.sp_die,
						NULL);
1283 1284 1285
		if (ret == 0 || ret == -ERANGE) {
			int ret2;
			bool externs = !af->child;
1286 1287 1288
			struct strbuf buf;

			strbuf_init(&buf, 64);
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310

			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) {
1311 1312 1313 1314
				strlist__add(vl->vars,
					strbuf_detach(&buf, NULL));
			}
			strbuf_release(&buf);
1315 1316 1317
		}
	}

1318
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1319 1320 1321 1322 1323 1324
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
}

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

	/* 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++];

1340
	/* Trace point should be converted from subprogram DIE */
1341
	ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1342
				     pf->pev->point.retprobe, &vl->point);
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
	if (ret < 0)
		return ret;

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

	/* Find local variables */
	vl->vars = strlist__new(true, NULL);
	if (vl->vars == NULL)
		return -ENOMEM;
1353
	af->child = true;
1354
	die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1355

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

out:
1364 1365 1366 1367 1368 1369 1370 1371
	if (strlist__empty(vl->vars)) {
		strlist__delete(vl->vars);
		vl->vars = NULL;
	}

	return ret;
}

1372 1373 1374 1375 1376
/*
 * 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.
 */
1377
int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1378
				      struct perf_probe_event *pev,
1379
				      struct variable_list **vls)
1380 1381 1382
{
	struct available_var_finder af = {
			.pf = {.pev = pev, .callback = add_available_vars},
1383
			.mod = dbg->mod,
1384
			.max_vls = probe_conf.max_probes};
1385 1386 1387
	int ret;

	/* Allocate result vls array */
1388
	*vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1389 1390 1391 1392 1393 1394
	if (*vls == NULL)
		return -ENOMEM;

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

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

	return (ret < 0) ? ret : af.nvls;
1407 1408
}

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

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

1426 1427 1428
	/* Find a corresponding line (filename and lineno) */
	cu_find_lineinfo(&cudie, addr, &fname, &lineno);
	/* Don't care whether it failed or not */
1429

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

1441
		fname = dwarf_decl_file(&spdie);
1442
		if (addr == (unsigned long)baseaddr) {
1443 1444
			/* Function entry - Relative line number is 0 */
			lineno = baseline;
1445 1446 1447 1448 1449 1450 1451
			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 */
1452
			if (dwarf_entrypc(&indie, &_addr) == 0 &&
1453
			    _addr == addr) {
1454 1455 1456
				/*
				 * addr is at an inline function entry.
				 * In this case, lineno should be the call-site
1457
				 * line number. (overwrite lineinfo)
1458 1459
				 */
				lineno = die_get_call_lineno(&indie);
1460 1461 1462
				fname = die_get_call_file(&indie);
				break;
			} else {
1463 1464 1465 1466 1467 1468
				/*
				 * 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.
				 */
1469
				tmp = dwarf_diename(&indie);
1470 1471 1472 1473 1474
				if (!tmp ||
				    dwarf_decl_line(&indie, &baseline) != 0)
					break;
				func = tmp;
				spdie = indie;
1475
			}
1476
		}
1477 1478 1479 1480
		/* Verify the lineno and baseline are in a same file */
		tmp = dwarf_decl_file(&spdie);
		if (!tmp || strcmp(tmp, fname) != 0)
			lineno = 0;
1481 1482 1483 1484 1485 1486
	}

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

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

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

1527
static int line_range_walk_cb(const char *fname, int lineno,
1528
			      Dwarf_Addr addr __maybe_unused,
1529
			      void *data)
1530
{
1531
	struct line_finder *lf = data;
1532
	int err;
1533

1534
	if ((strtailcmp(fname, lf->fname) != 0) ||
1535
	    (lf->lno_s > lineno || lf->lno_e < lineno))
1536
		return 0;
1537

1538 1539 1540
	err = line_range_add_line(fname, lineno, lf->lr);
	if (err < 0 && err != -EEXIST)
		return err;
1541

1542
	return 0;
1543
}
1544

1545
/* Find line range from its line number */
1546
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1547
{
1548
	int ret;
1549

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

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

1564 1565
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1566
	int ret = find_line_range_by_line(in_die, data);
1567 1568 1569 1570

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

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

1584 1585 1586 1587
	/* Check declared file */
	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

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

1612
static int find_line_range_by_func(struct line_finder *lf)
1613
{
1614 1615 1616
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1617 1618
}

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

1628 1629 1630 1631 1632 1633 1634 1635
	/* 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};

1636
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1637
				  &pubname_param, 0);
1638 1639 1640 1641 1642 1643 1644
		if (pubname_param.found) {
			line_range_search_cb(&lf.sp_die, &line_range_param);
			if (lf.found)
				goto found;
		}
	}

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

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

		/* Check if target file is included. */
		if (lr->file)
1658
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1659
		else
1660
			lf.fname = 0;
1661

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

1674
found:
1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
	/* 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;
		}
	}

1685
	pr_debug("path: %s\n", lr->path);
1686
	return (ret < 0) ? ret : lf.found;
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 1743 1744 1745 1746
/*
 * 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;
		}
	}
}