probe-finder.c 44.9 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
	int ret;
300
	char sign;
301

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

311 312
	bsize = dwarf_bitsize(vr_die);
	if (bsize > 0) {
313
		/* This is a bitfield */
314 315 316 317 318 319
		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));
320 321 322
		goto formatted;
	}

323 324 325 326 327
	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;
	}
328

329 330 331
	pr_debug("%s type is %s.\n",
		 dwarf_diename(vr_die), dwarf_diename(&type));

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

367 368 369 370 371 372 373
	if (cast && (strcmp(cast, "u") == 0))
		sign = 'u';
	else if (cast && (strcmp(cast, "s") == 0))
		sign = 's';
	else
		sign = die_is_signed_type(&type) ? 's' : 'u';

374 375
	ret = dwarf_bytesize(&type);
	if (ret <= 0)
376 377
		/* No size ... try to use default type */
		return 0;
378
	ret = BYTES_TO_BITS(ret);
379

380 381 382 383 384
	/* 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;
385
	}
386
	ret = snprintf(buf, 16, "%c%d", sign, ret);
387 388 389 390 391 392

formatted:
	if (ret < 0 || ret >= 16) {
		if (ret >= 16)
			ret = -E2BIG;
		pr_warning("Failed to convert variable type: %s\n",
393
			   str_error_r(-ret, sbuf, sizeof(sbuf)));
394 395 396 397 398
		return ret;
	}
	tvar->type = strdup(buf);
	if (tvar->type == NULL)
		return -ENOMEM;
399
	return 0;
400 401
}

402
static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
403
				    struct perf_probe_arg_field *field,
404
				    struct probe_trace_arg_ref **ref_ptr,
405
				    Dwarf_Die *die_mem)
406
{
407
	struct probe_trace_arg_ref *ref = *ref_ptr;
408 409
	Dwarf_Die type;
	Dwarf_Word offs;
410
	int ret, tag;
411 412

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

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

498
	if (die_find_member(&type, field->name, die_mem) == NULL) {
A
Arnaldo Carvalho de Melo 已提交
499
		pr_warning("%s(type:%s) has no member %s.\n", varname,
500 501 502
			   dwarf_diename(&type), field->name);
		return -EINVAL;
	}
503 504

	/* Get the offset of the field */
505 506 507 508 509 510 511 512 513
	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;
		}
514
	}
515 516
	ref->offset += (long)offs;

517 518 519 520 521
	/* 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);

522
next:
523 524
	/* Converting next field */
	if (field->next)
525
		return convert_variable_fields(die_mem, field->name,
526
					field->next, &ref, die_mem);
527 528
	else
		return 0;
529 530
}

531
/* Show a variables in kprobe event format */
532
static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
533
{
534
	Dwarf_Die die_mem;
535 536
	int ret;

537 538
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
539

540
	ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
541
					&pf->sp_die, pf->tvar);
542 543 544 545 546 547
	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)
548
		pr_err("Sorry, we don't support this variable location yet.\n");
549
	else if (ret == 0 && pf->pvar->field) {
550 551 552
		ret = convert_variable_fields(vr_die, pf->pvar->var,
					      pf->pvar->field, &pf->tvar->ref,
					      &die_mem);
553 554
		vr_die = &die_mem;
	}
555 556
	if (ret == 0)
		ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
557
	/* *expr will be cached in libdw. Don't free it. */
558
	return ret;
559 560
}

561 562
/* Find a variable in a scope DIE */
static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
563
{
564
	Dwarf_Die vr_die;
565
	char *buf, *ptr;
566
	int ret = 0;
567

568 569 570
	/* Copy raw parameters */
	if (!is_c_varname(pf->pvar->var))
		return copy_to_probe_trace_arg(pf->tvar, pf->pvar);
571

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

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

600
	return ret;
601 602
}

603
/* Convert subprogram DIE to trace point */
604 605
static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
				  Dwarf_Addr paddr, bool retprobe,
606
				  const char *function,
607
				  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 651 652 653
			pr_warning("Failed to find \"%s%%return\",\n"
				   " because %s is an inlined function and"
				   " has no return point.\n", function,
				   function);
654 655
			return -EINVAL;
		}
656
		tp->retprobe = true;
657 658
	}

659 660 661
	return 0;
}

662 663
/* Call probe_finder callback with scope DIE */
static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
664 665
{
	Dwarf_Attribute fb_attr;
666
	Dwarf_Frame *frame = NULL;
667 668 669
	size_t nops;
	int ret;

670 671 672 673 674 675
	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 */
676
	if (!die_is_func_def(sc_die)) {
677
		if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
678 679 680 681 682 683 684 685 686
			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;
			}
687
		}
688 689
	} else
		memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
690

691 692
	/* Get the frame base attribute/ops from subprogram */
	dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
693
	ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
694
	if (ret <= 0 || nops == 0) {
695
		pf->fb_ops = NULL;
696
#if _ELFUTILS_PREREQ(0, 142)
697
	} else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
698 699 700
		   (pf->cfi_eh != NULL || pf->cfi_dbg != NULL)) {
		if ((dwarf_cfi_addrframe(pf->cfi_eh, pf->addr, &frame) != 0 &&
		     (dwarf_cfi_addrframe(pf->cfi_dbg, pf->addr, &frame) != 0)) ||
701
		    dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
M
Masami Hiramatsu 已提交
702
			pr_warning("Failed to get call frame on 0x%jx\n",
703
				   (uintmax_t)pf->addr);
704 705
			free(frame);
			return -ENOENT;
706
		}
707
#endif
708
	}
709

710
	/* Call finder's callback handler */
711
	ret = pf->callback(sc_die, pf);
712

713 714
	/* Since *pf->fb_ops can be a part of frame. we should free it here. */
	free(frame);
715
	pf->fb_ops = NULL;
716 717

	return ret;
718 719
}

720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
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) {
743
		if (die_match_name(fn_die, fsp->function)) {
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
			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;
}

778 779
static int probe_point_line_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
780
{
781
	struct probe_finder *pf = data;
782
	Dwarf_Die *sc_die, die_mem;
783
	int ret;
784

785 786
	if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
		return 0;
787

788
	pf->addr = addr;
789 790 791 792 793 794 795
	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);
796

797
	/* Continue if no error, because the line will be in inline function */
798
	return ret < 0 ? ret : 0;
799
}
800

801 802 803 804
/* 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);
805 806
}

807
/* Find lines which match lazy pattern */
808
static int find_lazy_match_lines(struct intlist *list,
809 810
				 const char *fname, const char *pat)
{
811 812 813 814 815
	FILE *fp;
	char *line = NULL;
	size_t line_len;
	ssize_t len;
	int count = 0, linenum = 1;
816
	char sbuf[STRERR_BUFSIZE];
817 818 819

	fp = fopen(fname, "r");
	if (!fp) {
820
		pr_warning("Failed to open %s: %s\n", fname,
821
			   str_error_r(errno, sbuf, sizeof(sbuf)));
822
		return -errno;
823 824
	}

825
	while ((len = getline(&line, &line_len, fp)) > 0) {
826

827 828 829 830
		if (line[len - 1] == '\n')
			line[len - 1] = '\0';

		if (strlazymatch(line, pat)) {
831
			intlist__add(list, linenum);
832
			count++;
833
		}
834
		linenum++;
835
	}
836 837 838 839 840 841 842 843 844

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

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

847 848 849 850
static int probe_point_lazy_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
{
	struct probe_finder *pf = data;
851
	Dwarf_Die *sc_die, die_mem;
852 853
	int ret;

854
	if (!intlist__has_entry(pf->lcache, lineno) ||
855 856 857 858 859 860
	    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;
861 862 863 864 865 866 867 868
	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);
869 870 871 872 873

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

877
/* Find probe points from lazy pattern  */
878
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
879
{
880
	int ret = 0;
881
	char *fpath;
882

883
	if (intlist__empty(pf->lcache)) {
884 885 886 887 888 889 890 891 892
		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;
		}

893
		/* Matching lazy line pattern */
894
		ret = find_lazy_match_lines(pf->lcache, fpath,
895
					    pf->pev->point.lazy_line);
896
		free(fpath);
897
		if (ret <= 0)
898
			return ret;
899 900
	}

901
	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
902 903
}

904 905
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
906
	struct probe_finder *pf = data;
907
	struct perf_probe_point *pp = &pf->pev->point;
908
	Dwarf_Addr addr;
909
	int ret;
910

911
	if (pp->lazy_line)
912
		ret = find_probe_point_lazy(in_die, pf);
913 914
	else {
		/* Get probe address */
915
		if (dwarf_entrypc(in_die, &addr) != 0) {
M
Masami Hiramatsu 已提交
916
			pr_warning("Failed to get entry address of %s.\n",
917
				   dwarf_diename(in_die));
918
			return -ENOENT;
919 920
		}
		pf->addr = addr;
921 922 923 924
		pf->addr += pp->offset;
		pr_debug("found inline addr: 0x%jx\n",
			 (uintmax_t)pf->addr);

925
		ret = call_probe_finder(in_die, pf);
926
	}
927

928
	return ret;
929
}
930

931 932 933 934 935 936
/* Callback parameter with return value for libdw */
struct dwarf_callback_param {
	void *data;
	int retval;
};

937
/* Search function from function name */
938
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
939
{
940 941
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
942
	struct perf_probe_point *pp = &pf->pev->point;
943

944
	/* Check tag and diename */
945
	if (!die_is_func_def(sp_die) ||
946
	    !die_match_name(sp_die, pp->function))
947
		return DWARF_CB_OK;
948

949 950 951 952
	/* Check declared file */
	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

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

985
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
986 987
}

988
static int find_probe_point_by_func(struct probe_finder *pf)
989
{
990 991 992 993
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
994 995
}

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
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;

1012
		if (die_match_name(param->sp_die, param->function)) {
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
			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;
}

1028
static int debuginfo__find_probe_location(struct debuginfo *dbg,
1029
				  struct probe_finder *pf)
1030
{
1031
	struct perf_probe_point *pp = &pf->pev->point;
1032 1033 1034
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1035
	int ret = 0;
1036 1037

	off = 0;
1038 1039 1040
	pf->lcache = intlist__new(NULL);
	if (!pf->lcache)
		return -ENOMEM;
1041 1042

	/* Fastpath: lookup by function name from .debug_pubnames section */
1043
	if (pp->function && !strisglob(pp->function)) {
1044 1045 1046 1047 1048
		struct pubname_callback_param pubname_param = {
			.function = pp->function,
			.file	  = pp->file,
			.cu_die	  = &pf->cu_die,
			.sp_die	  = &pf->sp_die,
1049
			.found	  = 0,
1050 1051 1052 1053 1054
		};
		struct dwarf_callback_param probe_param = {
			.data = pf,
		};

1055
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1056
				  &pubname_param, 0);
1057 1058 1059 1060 1061 1062 1063
		if (pubname_param.found) {
			ret = probe_point_search_cb(&pf->sp_die, &probe_param);
			if (ret)
				goto found;
		}
	}

1064
	/* Loop on CUs (Compilation Unit) */
1065
	while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1066
		/* Get the DIE(Debugging Information Entry) of this CU */
1067
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1068 1069
		if (!diep)
			continue;
1070 1071 1072

		/* Check if target file is included. */
		if (pp->file)
1073
			pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1074
		else
1075
			pf->fname = NULL;
1076

1077
		if (!pp->file || pf->fname) {
1078
			if (pp->function)
1079
				ret = find_probe_point_by_func(pf);
1080
			else if (pp->lazy_line)
1081
				ret = find_probe_point_lazy(&pf->cu_die, pf);
1082
			else {
1083 1084
				pf->lno = pp->line;
				ret = find_probe_point_by_line(pf);
1085
			}
1086
			if (ret < 0)
1087
				break;
1088
		}
1089
		off = noff;
1090
	}
1091 1092

found:
1093 1094
	intlist__delete(pf->lcache);
	pf->lcache = NULL;
1095

1096 1097 1098
	return ret;
}

1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
/* Find probe points from debuginfo */
static int debuginfo__find_probes(struct debuginfo *dbg,
				  struct probe_finder *pf)
{
	int ret = 0;

#if _ELFUTILS_PREREQ(0, 142)
	Elf *elf;
	GElf_Ehdr ehdr;
	GElf_Shdr shdr;

	if (pf->cfi_eh || pf->cfi_dbg)
		return debuginfo__find_probe_location(dbg, pf);

	/* Get the call frame information from this dwarf */
	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_eh = dwarf_getcfi_elf(elf);

	pf->cfi_dbg = dwarf_getcfi(dbg->dbg);
#endif

	ret = debuginfo__find_probe_location(dbg, pf);
	return ret;
}

1132 1133 1134
struct local_vars_finder {
	struct probe_finder *pf;
	struct perf_probe_arg *args;
1135
	bool vars;
1136 1137 1138 1139 1140 1141 1142 1143 1144
	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;
1145
	struct probe_finder *pf = vf->pf;
1146 1147 1148 1149
	int tag;

	tag = dwarf_tag(die_mem);
	if (tag == DW_TAG_formal_parameter ||
1150
	    (tag == DW_TAG_variable && vf->vars)) {
1151
		if (convert_variable_location(die_mem, vf->pf->addr,
1152 1153
					      vf->pf->fb_ops, &pf->sp_die,
					      NULL) == 0) {
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
			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;
1176
	struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1177 1178 1179 1180
				.max_args = MAX_PROBE_ARGS, .ret = 0};

	for (i = 0; i < pf->pev->nargs; i++) {
		/* var never be NULL */
1181 1182 1183
		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) {
1184 1185 1186
			/* Copy normal argument */
			args[n] = pf->pev->args[i];
			n++;
1187
			continue;
1188
		}
1189 1190 1191 1192 1193 1194 1195 1196 1197
		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;
1198 1199 1200 1201
	}
	return n;
}

1202
/* Add a found probe point into trace event list */
1203
static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1204 1205 1206
{
	struct trace_event_finder *tf =
			container_of(pf, struct trace_event_finder, pf);
1207
	struct perf_probe_point *pp = &pf->pev->point;
1208
	struct probe_trace_event *tev;
1209
	struct perf_probe_arg *args = NULL;
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
	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++];

1220
	/* Trace point should be converted from subprogram DIE */
1221
	ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1222
				     pp->retprobe, pp->function, &tev->point);
1223
	if (ret < 0)
1224
		goto end;
1225

1226
	tev->point.realname = strdup(dwarf_diename(sc_die));
1227 1228 1229 1230
	if (!tev->point.realname) {
		ret = -ENOMEM;
		goto end;
	}
1231

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

1235 1236
	/* Expand special probe argument if exist */
	args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1237 1238 1239 1240
	if (args == NULL) {
		ret = -ENOMEM;
		goto end;
	}
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255

	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];
1256
		pf->tvar = &tev->args[i];
1257 1258
		/* Variable should be found from scope DIE */
		ret = find_variable(sc_die, pf);
1259
		if (ret != 0)
1260
			break;
1261 1262
	}

1263
end:
1264 1265 1266 1267
	if (ret) {
		clear_probe_trace_event(tev);
		tf->ntevs--;
	}
1268 1269
	free(args);
	return ret;
1270 1271 1272
}

/* Find probe_trace_events specified by perf_probe_event from debuginfo */
1273
int debuginfo__find_trace_events(struct debuginfo *dbg,
1274
				 struct perf_probe_event *pev,
1275
				 struct probe_trace_event **tevs)
1276 1277 1278
{
	struct trace_event_finder tf = {
			.pf = {.pev = pev, .callback = add_probe_trace_event},
1279
			.max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1280
	int ret, i;
1281 1282

	/* Allocate result tevs array */
1283
	*tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1284 1285 1286 1287 1288 1289
	if (*tevs == NULL)
		return -ENOMEM;

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

1290
	ret = debuginfo__find_probes(dbg, &tf.pf);
1291
	if (ret < 0) {
1292 1293
		for (i = 0; i < tf.ntevs; i++)
			clear_probe_trace_event(&tf.tevs[i]);
1294
		zfree(tevs);
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
		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;
1306
	struct strbuf buf = STRBUF_INIT;
1307 1308 1309 1310 1311 1312 1313 1314
	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,
1315 1316
						af->pf.fb_ops, &af->pf.sp_die,
						NULL);
1317 1318 1319
		if (ret == 0 || ret == -ERANGE) {
			int ret2;
			bool externs = !af->child;
1320

1321 1322
			if (strbuf_init(&buf, 64) < 0)
				goto error;
1323 1324

			if (probe_conf.show_location_range) {
1325 1326 1327 1328 1329 1330 1331
				if (!externs)
					ret2 = strbuf_add(&buf,
						ret ? "[INV]\t" : "[VAL]\t", 6);
				else
					ret2 = strbuf_add(&buf, "[EXT]\t", 6);
				if (ret2)
					goto error;
1332 1333 1334 1335 1336 1337
			}

			ret2 = die_get_varname(die_mem, &buf);

			if (!ret2 && probe_conf.show_location_range &&
				!externs) {
1338 1339
				if (strbuf_addch(&buf, '\t') < 0)
					goto error;
1340 1341 1342 1343 1344 1345
				ret2 = die_get_var_range(&af->pf.sp_die,
							die_mem, &buf);
			}

			pr_debug("Add new var: %s\n", buf.buf);
			if (ret2 == 0) {
1346 1347
				strlist__add(vl->vars,
					strbuf_detach(&buf, NULL));
1348 1349
			}
			strbuf_release(&buf);
1350 1351 1352
		}
	}

1353
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1354 1355 1356
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
1357 1358 1359 1360
error:
	strbuf_release(&buf);
	pr_debug("Error in strbuf\n");
	return DIE_FIND_CB_END;
1361 1362 1363
}

/* Add a found vars into available variables list */
1364
static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1365 1366 1367
{
	struct available_var_finder *af =
			container_of(pf, struct available_var_finder, pf);
1368
	struct perf_probe_point *pp = &pf->pev->point;
1369
	struct variable_list *vl;
1370 1371
	Dwarf_Die die_mem;
	int ret;
1372 1373 1374 1375 1376 1377 1378 1379

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

1380
	/* Trace point should be converted from subprogram DIE */
1381
	ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1382
				     pp->retprobe, pp->function, &vl->point);
1383 1384 1385 1386 1387 1388 1389
	if (ret < 0)
		return ret;

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

	/* Find local variables */
1390
	vl->vars = strlist__new(NULL, NULL);
1391 1392
	if (vl->vars == NULL)
		return -ENOMEM;
1393
	af->child = true;
1394
	die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1395

1396
	/* Find external variables */
1397
	if (!probe_conf.show_ext_vars)
1398
		goto out;
1399
	/* Don't need to search child DIE for external vars. */
1400
	af->child = false;
1401
	die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1402 1403

out:
1404 1405 1406 1407 1408 1409 1410 1411
	if (strlist__empty(vl->vars)) {
		strlist__delete(vl->vars);
		vl->vars = NULL;
	}

	return ret;
}

1412 1413 1414 1415 1416
/*
 * 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.
 */
1417
int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1418
				      struct perf_probe_event *pev,
1419
				      struct variable_list **vls)
1420 1421 1422
{
	struct available_var_finder af = {
			.pf = {.pev = pev, .callback = add_available_vars},
1423
			.mod = dbg->mod,
1424
			.max_vls = probe_conf.max_probes};
1425 1426 1427
	int ret;

	/* Allocate result vls array */
1428
	*vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1429 1430 1431 1432 1433 1434
	if (*vls == NULL)
		return -ENOMEM;

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

1435
	ret = debuginfo__find_probes(dbg, &af.pf);
1436 1437 1438
	if (ret < 0) {
		/* Free vlist for error */
		while (af.nvls--) {
1439
			zfree(&af.vls[af.nvls].point.symbol);
1440
			strlist__delete(af.vls[af.nvls].vars);
1441
		}
1442
		zfree(vls);
1443 1444 1445 1446
		return ret;
	}

	return (ret < 0) ? ret : af.nvls;
1447 1448
}

1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
/* For the kernel module, we need a special code to get a DIE */
static int debuginfo__get_text_offset(struct debuginfo *dbg, Dwarf_Addr *offs)
{
	int n, i;
	Elf32_Word shndx;
	Elf_Scn *scn;
	Elf *elf;
	GElf_Shdr mem, *shdr;
	const char *p;

	elf = dwfl_module_getelf(dbg->mod, &dbg->bias);
	if (!elf)
		return -EINVAL;

	/* Get the number of relocations */
	n = dwfl_module_relocations(dbg->mod);
	if (n < 0)
		return -ENOENT;
	/* Search the relocation related .text section */
	for (i = 0; i < n; i++) {
		p = dwfl_module_relocation_info(dbg->mod, i, &shndx);
		if (strcmp(p, ".text") == 0) {
			/* OK, get the section header */
			scn = elf_getscn(elf, shndx);
			if (!scn)
				return -ENOENT;
			shdr = gelf_getshdr(scn, &mem);
			if (!shdr)
				return -ENOENT;
			*offs = shdr->sh_addr;
		}
	}
	return 0;
}

1484
/* Reverse search */
1485
int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1486
				struct perf_probe_point *ppt)
1487 1488
{
	Dwarf_Die cudie, spdie, indie;
1489 1490
	Dwarf_Addr _addr = 0, baseaddr = 0;
	const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1491
	int baseline = 0, lineno = 0, ret = 0;
1492
	bool reloc = false;
1493

1494
retry:
1495
	/* Find cu die */
1496
	if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
1497 1498 1499 1500 1501
		if (!reloc && debuginfo__get_text_offset(dbg, &baseaddr) == 0) {
			addr += baseaddr;
			reloc = true;
			goto retry;
		}
M
Masami Hiramatsu 已提交
1502 1503
		pr_warning("Failed to find debug information for address %lx\n",
			   addr);
1504 1505 1506
		ret = -EINVAL;
		goto end;
	}
1507

1508 1509 1510
	/* Find a corresponding line (filename and lineno) */
	cu_find_lineinfo(&cudie, addr, &fname, &lineno);
	/* Don't care whether it failed or not */
1511

1512
	/* Find a corresponding function (name, baseline and baseaddr) */
1513
	if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1514
		/* Get function entry information */
1515 1516
		func = basefunc = dwarf_diename(&spdie);
		if (!func ||
1517
		    dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1518 1519
		    dwarf_decl_line(&spdie, &baseline) != 0) {
			lineno = 0;
1520
			goto post;
1521
		}
1522

1523
		fname = dwarf_decl_file(&spdie);
1524
		if (addr == (unsigned long)baseaddr) {
1525 1526
			/* Function entry - Relative line number is 0 */
			lineno = baseline;
1527 1528 1529 1530 1531 1532 1533
			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 */
1534
			if (dwarf_entrypc(&indie, &_addr) == 0 &&
1535
			    _addr == addr) {
1536 1537 1538
				/*
				 * addr is at an inline function entry.
				 * In this case, lineno should be the call-site
1539
				 * line number. (overwrite lineinfo)
1540 1541
				 */
				lineno = die_get_call_lineno(&indie);
1542 1543 1544
				fname = die_get_call_file(&indie);
				break;
			} else {
1545 1546 1547 1548 1549 1550
				/*
				 * 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.
				 */
1551
				tmp = dwarf_diename(&indie);
1552 1553 1554 1555 1556
				if (!tmp ||
				    dwarf_decl_line(&indie, &baseline) != 0)
					break;
				func = tmp;
				spdie = indie;
1557
			}
1558
		}
1559 1560 1561 1562
		/* Verify the lineno and baseline are in a same file */
		tmp = dwarf_decl_file(&spdie);
		if (!tmp || strcmp(tmp, fname) != 0)
			lineno = 0;
1563 1564 1565 1566 1567 1568
	}

post:
	/* Make a relative line number or an offset */
	if (lineno)
		ppt->line = lineno - baseline;
1569
	else if (basefunc) {
1570
		ppt->offset = addr - (unsigned long)baseaddr;
1571 1572
		func = basefunc;
	}
1573 1574 1575 1576

	/* Duplicate strings */
	if (func) {
		ppt->function = strdup(func);
1577 1578 1579 1580
		if (ppt->function == NULL) {
			ret = -ENOMEM;
			goto end;
		}
1581
	}
1582 1583 1584
	if (fname) {
		ppt->file = strdup(fname);
		if (ppt->file == NULL) {
1585
			zfree(&ppt->function);
1586 1587 1588 1589
			ret = -ENOMEM;
			goto end;
		}
	}
1590
end:
1591 1592
	if (ret == 0 && (fname || func))
		ret = 1;	/* Found a point */
1593 1594 1595
	return ret;
}

1596 1597 1598 1599
/* Add a line and store the src path */
static int line_range_add_line(const char *src, unsigned int lineno,
			       struct line_range *lr)
{
1600
	/* Copy source path */
1601
	if (!lr->path) {
1602 1603 1604
		lr->path = strdup(src);
		if (lr->path == NULL)
			return -ENOMEM;
1605
	}
1606
	return intlist__add(lr->line_list, lineno);
1607 1608
}

1609
static int line_range_walk_cb(const char *fname, int lineno,
1610
			      Dwarf_Addr addr __maybe_unused,
1611
			      void *data)
1612
{
1613
	struct line_finder *lf = data;
1614
	int err;
1615

1616
	if ((strtailcmp(fname, lf->fname) != 0) ||
1617
	    (lf->lno_s > lineno || lf->lno_e < lineno))
1618
		return 0;
1619

1620 1621 1622
	err = line_range_add_line(fname, lineno, lf->lr);
	if (err < 0 && err != -EEXIST)
		return err;
1623

1624
	return 0;
1625
}
1626

1627
/* Find line range from its line number */
1628
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1629
{
1630
	int ret;
1631

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

1634
	/* Update status */
1635
	if (ret >= 0)
1636
		if (!intlist__empty(lf->lr->line_list))
1637 1638 1639
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1640
	else {
1641
		zfree(&lf->lr->path);
1642
	}
1643
	return ret;
1644 1645
}

1646 1647
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1648
	int ret = find_line_range_by_line(in_die, data);
1649 1650 1651 1652

	/*
	 * We have to check all instances of inlined function, because
	 * some execution paths can be optimized out depends on the
1653 1654
	 * function argument of instances. However, if an error occurs,
	 * it should be handled by the caller.
1655
	 */
1656
	return ret < 0 ? ret : 0;
1657 1658
}

1659
/* Search function definition from function name */
1660
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1661
{
1662 1663
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1664 1665
	struct line_range *lr = lf->lr;

1666 1667 1668 1669
	/* Check declared file */
	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

1670
	if (die_is_func_def(sp_die) &&
1671
	    die_match_name(sp_die, lr->function)) {
1672 1673
		lf->fname = dwarf_decl_file(sp_die);
		dwarf_decl_line(sp_die, &lr->offset);
1674
		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1675
		lf->lno_s = lr->offset + lr->start;
1676 1677 1678 1679
		if (lf->lno_s < 0)	/* Overflow */
			lf->lno_s = INT_MAX;
		lf->lno_e = lr->offset + lr->end;
		if (lf->lno_e < 0)	/* Overflow */
1680
			lf->lno_e = INT_MAX;
1681
		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1682 1683
		lr->start = lf->lno_s;
		lr->end = lf->lno_e;
1684
		if (!die_is_func_instance(sp_die))
1685 1686 1687
			param->retval = die_walk_instances(sp_die,
						line_range_inline_cb, lf);
		else
1688 1689
			param->retval = find_line_range_by_line(sp_die, lf);
		return DWARF_CB_ABORT;
1690
	}
1691
	return DWARF_CB_OK;
1692 1693
}

1694
static int find_line_range_by_func(struct line_finder *lf)
1695
{
1696 1697 1698
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1699 1700
}

1701
int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1702
{
1703
	struct line_finder lf = {.lr = lr, .found = 0};
1704
	int ret = 0;
1705 1706 1707
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1708
	const char *comp_dir;
1709

1710 1711 1712 1713 1714 1715 1716 1717
	/* 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};

1718
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1719
				  &pubname_param, 0);
1720 1721 1722 1723 1724 1725 1726
		if (pubname_param.found) {
			line_range_search_cb(&lf.sp_die, &line_range_param);
			if (lf.found)
				goto found;
		}
	}

1727
	/* Loop on CUs (Compilation Unit) */
1728
	while (!lf.found && ret >= 0) {
1729
		if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1730
				 NULL, NULL, NULL) != 0)
1731 1732 1733
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1734
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1735 1736
		if (!diep)
			continue;
1737 1738 1739

		/* Check if target file is included. */
		if (lr->file)
1740
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1741
		else
1742
			lf.fname = 0;
1743

1744
		if (!lr->file || lf.fname) {
1745
			if (lr->function)
1746
				ret = find_line_range_by_func(&lf);
1747 1748
			else {
				lf.lno_s = lr->start;
1749
				lf.lno_e = lr->end;
1750
				ret = find_line_range_by_line(NULL, &lf);
1751 1752
			}
		}
1753
		off = noff;
1754
	}
1755

1756
found:
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
	/* 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;
		}
	}

1767
	pr_debug("path: %s\n", lr->path);
1768
	return (ret < 0) ? ret : lf.found;
1769 1770
}

1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
/*
 * 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;
		}
	}
}