probe-finder.c 42.1 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 181
	int ret;

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 190 191 192 193 194 195 196 197 198 199 200 201 202
	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);
		if (ret || addr != tmp ||
		    dwarf_tag(vr_die) != DW_TAG_formal_parameter ||
		    dwarf_highpc(sp_die, &tmp))
			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;
		}
203 204
		return -ENOENT;
	}
205 206 207 208
found:
	if (nops == 0)
		/* TODO: Support const_value */
		return -ENOENT;
209 210

	if (op->atom == DW_OP_addr) {
211
static_var:
212 213
		if (!tvar)
			return 0;
214 215 216 217 218 219 220 221 222 223 224
		/* 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;
		return 0;
	}
225 226

	/* If this is based on frame buffer, set the offset */
227
	if (op->atom == DW_OP_fbreg) {
228
		if (fb_ops == NULL)
229
			return -ENOTSUP;
230
		ref = true;
231
		offs = op->number;
232
		op = &fb_ops[0];
233
	}
234

235 236 237
	if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
		regn = op->atom - DW_OP_breg0;
		offs += op->number;
238
		ref = true;
239 240 241 242 243
	} 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;
244
		ref = true;
245 246
	} else if (op->atom == DW_OP_regx) {
		regn = op->number;
247
	} else {
248
		pr_debug("DW_OP %x is not supported.\n", op->atom);
249 250
		return -ENOTSUP;
	}
251

252 253 254
	if (!tvar)
		return 0;

255
	regs = get_arch_regstr(regn);
256
	if (!regs) {
257
		/* This should be a bug in DWARF or this tool */
M
Masami Hiramatsu 已提交
258 259
		pr_warning("Mapping for the register number %u "
			   "missing on this architecture.\n", regn);
260 261
		return -ERANGE;
	}
262

263 264 265 266
	tvar->value = strdup(regs);
	if (tvar->value == NULL)
		return -ENOMEM;

267
	if (ref) {
268
		tvar->ref = alloc_trace_arg_ref((long)offs);
269 270
		if (tvar->ref == NULL)
			return -ENOMEM;
271
	}
272
	return 0;
273 274
}

275 276
#define BYTES_TO_BITS(nb)	((nb) * BITS_PER_LONG / sizeof(long))

277
static int convert_variable_type(Dwarf_Die *vr_die,
278
				 struct probe_trace_arg *tvar,
279
				 const char *cast)
280
{
281
	struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
282 283
	Dwarf_Die type;
	char buf[16];
284
	char sbuf[STRERR_BUFSIZE];
285
	int bsize, boffs, total;
286 287
	int ret;

288 289 290 291 292 293 294
	/* 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;
	}

295 296
	bsize = dwarf_bitsize(vr_die);
	if (bsize > 0) {
297
		/* This is a bitfield */
298 299 300 301 302 303
		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));
304 305 306
		goto formatted;
	}

307 308 309 310 311
	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;
	}
312

313 314 315
	pr_debug("%s type is %s.\n",
		 dwarf_diename(vr_die), dwarf_diename(&type));

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

351 352
	ret = dwarf_bytesize(&type);
	if (ret <= 0)
353 354
		/* No size ... try to use default type */
		return 0;
355
	ret = BYTES_TO_BITS(ret);
356

357 358 359 360 361
	/* 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;
362
	}
363 364 365 366 367 368 369 370
	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",
371
			   strerror_r(-ret, sbuf, sizeof(sbuf)));
372 373 374 375 376
		return ret;
	}
	tvar->type = strdup(buf);
	if (tvar->type == NULL)
		return -ENOMEM;
377
	return 0;
378 379
}

380
static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
381
				    struct perf_probe_arg_field *field,
382
				    struct probe_trace_arg_ref **ref_ptr,
383
				    Dwarf_Die *die_mem)
384
{
385
	struct probe_trace_arg_ref *ref = *ref_ptr;
386 387
	Dwarf_Die type;
	Dwarf_Word offs;
388
	int ret, tag;
389 390

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

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

476
	if (die_find_member(&type, field->name, die_mem) == NULL) {
A
Arnaldo Carvalho de Melo 已提交
477
		pr_warning("%s(type:%s) has no member %s.\n", varname,
478 479 480
			   dwarf_diename(&type), field->name);
		return -EINVAL;
	}
481 482

	/* Get the offset of the field */
483 484 485 486 487 488 489 490 491
	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;
		}
492
	}
493 494
	ref->offset += (long)offs;

495 496 497 498 499
	/* 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);

500
next:
501 502
	/* Converting next field */
	if (field->next)
503
		return convert_variable_fields(die_mem, field->name,
504
					field->next, &ref, die_mem);
505 506
	else
		return 0;
507 508
}

509
/* Show a variables in kprobe event format */
510
static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
511
{
512
	Dwarf_Die die_mem;
513 514
	int ret;

515 516
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
517

518
	ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
519
					&pf->sp_die, pf->tvar);
520
	if (ret == -ENOENT || ret == -EINVAL)
521 522 523 524
		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");
525
	else if (ret == 0 && pf->pvar->field) {
526 527 528
		ret = convert_variable_fields(vr_die, pf->pvar->var,
					      pf->pvar->field, &pf->tvar->ref,
					      &die_mem);
529 530
		vr_die = &die_mem;
	}
531 532
	if (ret == 0)
		ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
533
	/* *expr will be cached in libdw. Don't free it. */
534
	return ret;
535 536
}

537 538
/* Find a variable in a scope DIE */
static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
539
{
540
	Dwarf_Die vr_die;
541
	char buf[32], *ptr;
542
	int ret = 0;
543

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
	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;
	}

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

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

591
	return ret;
592 593
}

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

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

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

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

647 648 649
	return 0;
}

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

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

	/* If not a real subprogram, find a real one */
663
	if (!die_is_func_def(sc_die)) {
664
		if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
665 666 667 668
			pr_warning("Failed to find probe point in any "
				   "functions.\n");
			return -ENOENT;
		}
669 670
	} else
		memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
671

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

690
	/* Call finder's callback handler */
691
	ret = pf->callback(sc_die, pf);
692 693 694

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

	return ret;
697 698
}

699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
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) {
722
		if (die_match_name(fn_die, fsp->function)) {
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
			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;
}

757 758
static int probe_point_line_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
759
{
760
	struct probe_finder *pf = data;
761
	Dwarf_Die *sc_die, die_mem;
762
	int ret;
763

764 765
	if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
		return 0;
766

767
	pf->addr = addr;
768 769 770 771 772 773 774
	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);
775

776
	/* Continue if no error, because the line will be in inline function */
777
	return ret < 0 ? ret : 0;
778
}
779

780 781 782 783
/* 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);
784 785
}

786
/* Find lines which match lazy pattern */
787
static int find_lazy_match_lines(struct intlist *list,
788 789
				 const char *fname, const char *pat)
{
790 791 792 793 794
	FILE *fp;
	char *line = NULL;
	size_t line_len;
	ssize_t len;
	int count = 0, linenum = 1;
795
	char sbuf[STRERR_BUFSIZE];
796 797 798

	fp = fopen(fname, "r");
	if (!fp) {
799 800
		pr_warning("Failed to open %s: %s\n", fname,
			   strerror_r(errno, sbuf, sizeof(sbuf)));
801
		return -errno;
802 803
	}

804
	while ((len = getline(&line, &line_len, fp)) > 0) {
805

806 807 808 809
		if (line[len - 1] == '\n')
			line[len - 1] = '\0';

		if (strlazymatch(line, pat)) {
810
			intlist__add(list, linenum);
811
			count++;
812
		}
813
		linenum++;
814
	}
815 816 817 818 819 820 821 822 823

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

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

826 827 828 829
static int probe_point_lazy_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
{
	struct probe_finder *pf = data;
830
	Dwarf_Die *sc_die, die_mem;
831 832
	int ret;

833
	if (!intlist__has_entry(pf->lcache, lineno) ||
834 835 836 837 838 839
	    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;
840 841 842 843 844 845 846 847
	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);
848 849 850 851 852

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

856
/* Find probe points from lazy pattern  */
857
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
858
{
859
	int ret = 0;
860
	char *fpath;
861

862
	if (intlist__empty(pf->lcache)) {
863 864 865 866 867 868 869 870 871
		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;
		}

872
		/* Matching lazy line pattern */
873
		ret = find_lazy_match_lines(pf->lcache, fpath,
874
					    pf->pev->point.lazy_line);
875
		free(fpath);
876
		if (ret <= 0)
877
			return ret;
878 879
	}

880
	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
881 882
}

883 884
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
885
	struct probe_finder *pf = data;
886
	struct perf_probe_point *pp = &pf->pev->point;
887
	Dwarf_Addr addr;
888
	int ret;
889

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

904
		ret = call_probe_finder(in_die, pf);
905
	}
906

907
	return ret;
908
}
909

910 911 912 913 914 915
/* Callback parameter with return value for libdw */
struct dwarf_callback_param {
	void *data;
	int retval;
};

916
/* Search function from function name */
917
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
918
{
919 920
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
921
	struct perf_probe_point *pp = &pf->pev->point;
922

923
	/* Check tag and diename */
924
	if (!die_is_func_def(sp_die) ||
925
	    !die_match_name(sp_die, pp->function))
926
		return DWARF_CB_OK;
927

928 929 930 931
	/* Check declared file */
	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

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

964
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
965 966
}

967
static int find_probe_point_by_func(struct probe_finder *pf)
968
{
969 970 971 972
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
973 974
}

975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
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;

991
		if (die_match_name(param->sp_die, param->function)) {
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
			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;
}

1007
/* Find probe points from debuginfo */
1008
static int debuginfo__find_probes(struct debuginfo *dbg,
1009
				  struct probe_finder *pf)
1010
{
1011
	struct perf_probe_point *pp = &pf->pev->point;
1012 1013 1014
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1015
	int ret = 0;
1016

1017
#if _ELFUTILS_PREREQ(0, 142)
1018 1019 1020 1021
	Elf *elf;
	GElf_Ehdr ehdr;
	GElf_Shdr shdr;

1022
	/* Get the call frame information from this dwarf */
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
	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);
	}
1036
#endif
1037

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

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

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

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

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

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

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

1097 1098 1099
	return ret;
}

1100 1101 1102
struct local_vars_finder {
	struct probe_finder *pf;
	struct perf_probe_arg *args;
1103
	bool vars;
1104 1105 1106 1107 1108 1109 1110 1111 1112
	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;
1113
	struct probe_finder *pf = vf->pf;
1114 1115 1116 1117
	int tag;

	tag = dwarf_tag(die_mem);
	if (tag == DW_TAG_formal_parameter ||
1118
	    (tag == DW_TAG_variable && vf->vars)) {
1119
		if (convert_variable_location(die_mem, vf->pf->addr,
1120 1121
					      vf->pf->fb_ops, &pf->sp_die,
					      NULL) == 0) {
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
			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;
1144
	struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1145 1146 1147 1148
				.max_args = MAX_PROBE_ARGS, .ret = 0};

	for (i = 0; i < pf->pev->nargs; i++) {
		/* var never be NULL */
1149 1150 1151
		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) {
1152 1153 1154
			/* Copy normal argument */
			args[n] = pf->pev->args[i];
			n++;
1155
			continue;
1156
		}
1157 1158 1159 1160 1161 1162 1163 1164 1165
		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;
1166 1167 1168 1169
	}
	return n;
}

1170
/* Add a found probe point into trace event list */
1171
static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1172 1173 1174 1175
{
	struct trace_event_finder *tf =
			container_of(pf, struct trace_event_finder, pf);
	struct probe_trace_event *tev;
1176
	struct perf_probe_arg *args;
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
	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++];

1187
	/* Trace point should be converted from subprogram DIE */
1188
	ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1189
				     pf->pev->point.retprobe, &tev->point);
1190 1191 1192
	if (ret < 0)
		return ret;

1193 1194 1195 1196
	tev->point.realname = strdup(dwarf_diename(sc_die));
	if (!tev->point.realname)
		return -ENOMEM;

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

1200 1201 1202
	/* Expand special probe argument if exist */
	args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
	if (args == NULL)
1203
		return -ENOMEM;
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218

	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];
1219
		pf->tvar = &tev->args[i];
1220 1221
		/* Variable should be found from scope DIE */
		ret = find_variable(sc_die, pf);
1222
		if (ret != 0)
1223
			break;
1224 1225
	}

1226 1227 1228
end:
	free(args);
	return ret;
1229 1230 1231
}

/* Find probe_trace_events specified by perf_probe_event from debuginfo */
1232
int debuginfo__find_trace_events(struct debuginfo *dbg,
1233
				 struct perf_probe_event *pev,
1234
				 struct probe_trace_event **tevs)
1235 1236 1237
{
	struct trace_event_finder tf = {
			.pf = {.pev = pev, .callback = add_probe_trace_event},
1238
			.max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1239 1240 1241
	int ret;

	/* Allocate result tevs array */
1242
	*tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1243 1244 1245 1246 1247 1248
	if (*tevs == NULL)
		return -ENOMEM;

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

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

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

#define MAX_VAR_LEN 64

/* 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;
	char buf[MAX_VAR_LEN];
	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,
1274 1275
						af->pf.fb_ops, &af->pf.sp_die,
						NULL);
1276 1277
		if (ret == 0) {
			ret = die_get_varname(die_mem, buf, MAX_VAR_LEN);
1278
			pr_debug2("Add new var: %s\n", buf);
1279 1280 1281 1282 1283
			if (ret > 0)
				strlist__add(vl->vars, buf);
		}
	}

1284
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1285 1286 1287 1288 1289 1290
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
}

/* Add a found vars into available variables list */
1291
static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1292 1293 1294 1295
{
	struct available_var_finder *af =
			container_of(pf, struct available_var_finder, pf);
	struct variable_list *vl;
1296 1297
	Dwarf_Die die_mem;
	int ret;
1298 1299 1300 1301 1302 1303 1304 1305

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

1306
	/* Trace point should be converted from subprogram DIE */
1307
	ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1308
				     pf->pev->point.retprobe, &vl->point);
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
	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;
1319
	af->child = true;
1320
	die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1321

1322
	/* Find external variables */
1323
	if (!probe_conf.show_ext_vars)
1324
		goto out;
1325
	/* Don't need to search child DIE for external vars. */
1326
	af->child = false;
1327
	die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1328 1329

out:
1330 1331 1332 1333 1334 1335 1336 1337
	if (strlist__empty(vl->vars)) {
		strlist__delete(vl->vars);
		vl->vars = NULL;
	}

	return ret;
}

1338 1339 1340 1341 1342
/*
 * 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.
 */
1343
int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1344
				      struct perf_probe_event *pev,
1345
				      struct variable_list **vls)
1346 1347 1348
{
	struct available_var_finder af = {
			.pf = {.pev = pev, .callback = add_available_vars},
1349
			.mod = dbg->mod,
1350
			.max_vls = probe_conf.max_probes};
1351 1352 1353
	int ret;

	/* Allocate result vls array */
1354
	*vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1355 1356 1357 1358 1359 1360
	if (*vls == NULL)
		return -ENOMEM;

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

1361
	ret = debuginfo__find_probes(dbg, &af.pf);
1362 1363 1364
	if (ret < 0) {
		/* Free vlist for error */
		while (af.nvls--) {
1365
			zfree(&af.vls[af.nvls].point.symbol);
1366
			strlist__delete(af.vls[af.nvls].vars);
1367
		}
1368
		zfree(vls);
1369 1370 1371 1372
		return ret;
	}

	return (ret < 0) ? ret : af.nvls;
1373 1374
}

1375
/* Reverse search */
1376
int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1377
				struct perf_probe_point *ppt)
1378 1379
{
	Dwarf_Die cudie, spdie, indie;
1380 1381
	Dwarf_Addr _addr = 0, baseaddr = 0;
	const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1382
	int baseline = 0, lineno = 0, ret = 0;
1383 1384

	/* Find cu die */
1385
	if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
M
Masami Hiramatsu 已提交
1386 1387
		pr_warning("Failed to find debug information for address %lx\n",
			   addr);
1388 1389 1390
		ret = -EINVAL;
		goto end;
	}
1391

1392 1393 1394
	/* Find a corresponding line (filename and lineno) */
	cu_find_lineinfo(&cudie, addr, &fname, &lineno);
	/* Don't care whether it failed or not */
1395

1396
	/* Find a corresponding function (name, baseline and baseaddr) */
1397
	if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1398
		/* Get function entry information */
1399 1400
		func = basefunc = dwarf_diename(&spdie);
		if (!func ||
1401
		    dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1402 1403
		    dwarf_decl_line(&spdie, &baseline) != 0) {
			lineno = 0;
1404
			goto post;
1405
		}
1406

1407
		fname = dwarf_decl_file(&spdie);
1408
		if (addr == (unsigned long)baseaddr) {
1409 1410
			/* Function entry - Relative line number is 0 */
			lineno = baseline;
1411 1412 1413 1414 1415 1416 1417
			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 */
1418
			if (dwarf_entrypc(&indie, &_addr) == 0 &&
1419
			    _addr == addr) {
1420 1421 1422
				/*
				 * addr is at an inline function entry.
				 * In this case, lineno should be the call-site
1423
				 * line number. (overwrite lineinfo)
1424 1425
				 */
				lineno = die_get_call_lineno(&indie);
1426 1427 1428
				fname = die_get_call_file(&indie);
				break;
			} else {
1429 1430 1431 1432 1433 1434
				/*
				 * 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.
				 */
1435
				tmp = dwarf_diename(&indie);
1436 1437 1438 1439 1440
				if (!tmp ||
				    dwarf_decl_line(&indie, &baseline) != 0)
					break;
				func = tmp;
				spdie = indie;
1441
			}
1442
		}
1443 1444 1445 1446
		/* Verify the lineno and baseline are in a same file */
		tmp = dwarf_decl_file(&spdie);
		if (!tmp || strcmp(tmp, fname) != 0)
			lineno = 0;
1447 1448 1449 1450 1451 1452
	}

post:
	/* Make a relative line number or an offset */
	if (lineno)
		ppt->line = lineno - baseline;
1453
	else if (basefunc) {
1454
		ppt->offset = addr - (unsigned long)baseaddr;
1455 1456
		func = basefunc;
	}
1457 1458 1459 1460

	/* Duplicate strings */
	if (func) {
		ppt->function = strdup(func);
1461 1462 1463 1464
		if (ppt->function == NULL) {
			ret = -ENOMEM;
			goto end;
		}
1465
	}
1466 1467 1468
	if (fname) {
		ppt->file = strdup(fname);
		if (ppt->file == NULL) {
1469
			zfree(&ppt->function);
1470 1471 1472 1473
			ret = -ENOMEM;
			goto end;
		}
	}
1474
end:
1475 1476
	if (ret == 0 && (fname || func))
		ret = 1;	/* Found a point */
1477 1478 1479
	return ret;
}

1480 1481 1482 1483
/* Add a line and store the src path */
static int line_range_add_line(const char *src, unsigned int lineno,
			       struct line_range *lr)
{
1484
	/* Copy source path */
1485
	if (!lr->path) {
1486 1487 1488
		lr->path = strdup(src);
		if (lr->path == NULL)
			return -ENOMEM;
1489
	}
1490
	return intlist__add(lr->line_list, lineno);
1491 1492
}

1493
static int line_range_walk_cb(const char *fname, int lineno,
1494
			      Dwarf_Addr addr __maybe_unused,
1495
			      void *data)
1496
{
1497
	struct line_finder *lf = data;
1498
	int err;
1499

1500
	if ((strtailcmp(fname, lf->fname) != 0) ||
1501
	    (lf->lno_s > lineno || lf->lno_e < lineno))
1502
		return 0;
1503

1504 1505 1506
	err = line_range_add_line(fname, lineno, lf->lr);
	if (err < 0 && err != -EEXIST)
		return err;
1507

1508
	return 0;
1509
}
1510

1511
/* Find line range from its line number */
1512
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1513
{
1514
	int ret;
1515

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

1518
	/* Update status */
1519
	if (ret >= 0)
1520
		if (!intlist__empty(lf->lr->line_list))
1521 1522 1523
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1524
	else {
1525
		zfree(&lf->lr->path);
1526
	}
1527
	return ret;
1528 1529
}

1530 1531
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1532
	int ret = find_line_range_by_line(in_die, data);
1533 1534 1535 1536

	/*
	 * We have to check all instances of inlined function, because
	 * some execution paths can be optimized out depends on the
1537 1538
	 * function argument of instances. However, if an error occurs,
	 * it should be handled by the caller.
1539
	 */
1540
	return ret < 0 ? ret : 0;
1541 1542
}

1543
/* Search function definition from function name */
1544
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1545
{
1546 1547
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1548 1549
	struct line_range *lr = lf->lr;

1550 1551 1552 1553
	/* Check declared file */
	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

1554
	if (die_is_func_def(sp_die) &&
1555
	    die_match_name(sp_die, lr->function)) {
1556 1557
		lf->fname = dwarf_decl_file(sp_die);
		dwarf_decl_line(sp_die, &lr->offset);
1558
		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1559
		lf->lno_s = lr->offset + lr->start;
1560 1561 1562 1563
		if (lf->lno_s < 0)	/* Overflow */
			lf->lno_s = INT_MAX;
		lf->lno_e = lr->offset + lr->end;
		if (lf->lno_e < 0)	/* Overflow */
1564
			lf->lno_e = INT_MAX;
1565
		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1566 1567
		lr->start = lf->lno_s;
		lr->end = lf->lno_e;
1568
		if (!die_is_func_instance(sp_die))
1569 1570 1571
			param->retval = die_walk_instances(sp_die,
						line_range_inline_cb, lf);
		else
1572 1573
			param->retval = find_line_range_by_line(sp_die, lf);
		return DWARF_CB_ABORT;
1574
	}
1575
	return DWARF_CB_OK;
1576 1577
}

1578
static int find_line_range_by_func(struct line_finder *lf)
1579
{
1580 1581 1582
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1583 1584
}

1585
int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1586
{
1587
	struct line_finder lf = {.lr = lr, .found = 0};
1588
	int ret = 0;
1589 1590 1591
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1592
	const char *comp_dir;
1593

1594 1595 1596 1597 1598 1599 1600 1601
	/* 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};

1602
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1603
				  &pubname_param, 0);
1604 1605 1606 1607 1608 1609 1610
		if (pubname_param.found) {
			line_range_search_cb(&lf.sp_die, &line_range_param);
			if (lf.found)
				goto found;
		}
	}

1611
	/* Loop on CUs (Compilation Unit) */
1612
	while (!lf.found && ret >= 0) {
1613
		if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1614
				 NULL, NULL, NULL) != 0)
1615 1616 1617
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1618
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1619 1620
		if (!diep)
			continue;
1621 1622 1623

		/* Check if target file is included. */
		if (lr->file)
1624
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1625
		else
1626
			lf.fname = 0;
1627

1628
		if (!lr->file || lf.fname) {
1629
			if (lr->function)
1630
				ret = find_line_range_by_func(&lf);
1631 1632
			else {
				lf.lno_s = lr->start;
1633
				lf.lno_e = lr->end;
1634
				ret = find_line_range_by_line(NULL, &lf);
1635 1636
			}
		}
1637
		off = noff;
1638
	}
1639

1640
found:
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
	/* 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;
		}
	}

1651
	pr_debug("path: %s\n", lr->path);
1652
	return (ret < 0) ? ret : lf.found;
1653 1654
}

1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
/*
 * 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;
		}
	}
}