probe-finder.c 45.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
#include "probe-finder.h"
42
#include "probe-file.h"
43

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

47 48 49 50 51 52 53 54 55 56 57 58 59 60
/* 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 */
61
static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
62
					 const char *path)
63
{
64
	int fd;
65

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

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

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

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

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

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

	return -ENOENT;
94 95
}

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

102 103
	if (debuginfo__init_offline_dwarf(dbg, path) < 0)
		zfree(&dbg);
104 105
	if (dbg)
		pr_debug("Open Debuginfo file: %s\n", path);
106
	return dbg;
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
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);
	}
137
	dso__put(dso);
138 139 140 141 142 143

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

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

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

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

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

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

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

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

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

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

266
	if (!tvar)
267
		return ret2;
268

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

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

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

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

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

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

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

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

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

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

368
	if (cast && (strcmp(cast, "u") == 0))
369
		prefix = 'u';
370
	else if (cast && (strcmp(cast, "s") == 0))
371 372 373 374
		prefix = 's';
	else if (cast && (strcmp(cast, "x") == 0) &&
		 probe_type_is_available(PROBE_TYPE_X))
		prefix = 'x';
375
	else
376 377
		prefix = die_is_signed_type(&type) ? 's' :
			 probe_type_is_available(PROBE_TYPE_X) ? 'x' : 'u';
378

379 380
	ret = dwarf_bytesize(&type);
	if (ret <= 0)
381 382
		/* No size ... try to use default type */
		return 0;
383
	ret = BYTES_TO_BITS(ret);
384

385 386 387 388 389
	/* 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;
390
	}
391
	ret = snprintf(buf, 16, "%c%d", prefix, ret);
392 393 394 395 396 397

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

407
static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
408
				    struct perf_probe_arg_field *field,
409
				    struct probe_trace_arg_ref **ref_ptr,
410
				    Dwarf_Die *die_mem)
411
{
412
	struct probe_trace_arg_ref *ref = *ref_ptr;
413 414
	Dwarf_Die type;
	Dwarf_Word offs;
415
	int ret, tag;
416 417

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

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

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

	/* Get the offset of the field */
510 511 512 513 514 515 516 517 518
	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;
		}
519
	}
520 521
	ref->offset += (long)offs;

522 523 524 525 526
	/* 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);

527
next:
528 529
	/* Converting next field */
	if (field->next)
530
		return convert_variable_fields(die_mem, field->name,
531
					field->next, &ref, die_mem);
532 533
	else
		return 0;
534 535
}

536
/* Show a variables in kprobe event format */
537
static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
538
{
539
	Dwarf_Die die_mem;
540 541
	int ret;

542 543
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
544

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

566 567
/* Find a variable in a scope DIE */
static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
568
{
569
	Dwarf_Die vr_die;
570
	char *buf, *ptr;
571
	int ret = 0;
572

573 574 575
	/* Copy raw parameters */
	if (!is_c_varname(pf->pvar->var))
		return copy_to_probe_trace_arg(pf->tvar, pf->pvar);
576

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

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

605
	return ret;
606 607
}

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

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

652
	/* Return probe must be on the head of a subprogram */
653 654
	if (retprobe) {
		if (eaddr != paddr) {
655 656 657 658
			pr_warning("Failed to find \"%s%%return\",\n"
				   " because %s is an inlined function and"
				   " has no return point.\n", function,
				   function);
659 660
			return -EINVAL;
		}
661
		tp->retprobe = true;
662 663
	}

664 665 666
	return 0;
}

667 668
/* Call probe_finder callback with scope DIE */
static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
669 670
{
	Dwarf_Attribute fb_attr;
671
	Dwarf_Frame *frame = NULL;
672 673 674
	size_t nops;
	int ret;

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

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

715
	/* Call finder's callback handler */
716
	ret = pf->callback(sc_die, pf);
717

718 719
	/* Since *pf->fb_ops can be a part of frame. we should free it here. */
	free(frame);
720
	pf->fb_ops = NULL;
721 722

	return ret;
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
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) {
748
		if (die_match_name(fn_die, fsp->function)) {
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 778 779 780 781 782
			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;
}

783 784
static int probe_point_line_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
785
{
786
	struct probe_finder *pf = data;
787
	Dwarf_Die *sc_die, die_mem;
788
	int ret;
789

790 791
	if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
		return 0;
792

793
	pf->addr = addr;
794 795 796 797 798 799 800
	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);
801

802
	/* Continue if no error, because the line will be in inline function */
803
	return ret < 0 ? ret : 0;
804
}
805

806 807 808 809
/* 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);
810 811
}

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

	fp = fopen(fname, "r");
	if (!fp) {
825
		pr_warning("Failed to open %s: %s\n", fname,
826
			   str_error_r(errno, sbuf, sizeof(sbuf)));
827
		return -errno;
828 829
	}

830
	while ((len = getline(&line, &line_len, fp)) > 0) {
831

832 833 834 835
		if (line[len - 1] == '\n')
			line[len - 1] = '\0';

		if (strlazymatch(line, pat)) {
836
			intlist__add(list, linenum);
837
			count++;
838
		}
839
		linenum++;
840
	}
841 842 843 844 845 846 847 848 849

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

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

852 853 854 855
static int probe_point_lazy_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
{
	struct probe_finder *pf = data;
856
	Dwarf_Die *sc_die, die_mem;
857 858
	int ret;

859
	if (!intlist__has_entry(pf->lcache, lineno) ||
860 861 862 863 864 865
	    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;
866 867 868 869 870 871 872 873
	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);
874 875 876 877 878

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

882
/* Find probe points from lazy pattern  */
883
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
884
{
885
	int ret = 0;
886
	char *fpath;
887

888
	if (intlist__empty(pf->lcache)) {
889 890 891 892 893 894 895 896 897
		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;
		}

898
		/* Matching lazy line pattern */
899
		ret = find_lazy_match_lines(pf->lcache, fpath,
900
					    pf->pev->point.lazy_line);
901
		free(fpath);
902
		if (ret <= 0)
903
			return ret;
904 905
	}

906
	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
907 908
}

909 910
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
911
	struct probe_finder *pf = data;
912
	struct perf_probe_point *pp = &pf->pev->point;
913
	Dwarf_Addr addr;
914
	int ret;
915

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

930
		ret = call_probe_finder(in_die, pf);
931
	}
932

933
	return ret;
934
}
935

936 937 938 939 940 941
/* Callback parameter with return value for libdw */
struct dwarf_callback_param {
	void *data;
	int retval;
};

942
/* Search function from function name */
943
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
944
{
945 946
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
947
	struct perf_probe_point *pp = &pf->pev->point;
948

949
	/* Check tag and diename */
950
	if (!die_is_func_def(sp_die) ||
951
	    !die_match_name(sp_die, pp->function))
952
		return DWARF_CB_OK;
953

954 955 956 957
	/* Check declared file */
	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

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

990
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
991 992
}

993
static int find_probe_point_by_func(struct probe_finder *pf)
994
{
995 996 997 998
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
999 1000
}

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
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;

1017
		if (die_match_name(param->sp_die, param->function)) {
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
			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;
}

1033
static int debuginfo__find_probe_location(struct debuginfo *dbg,
1034
				  struct probe_finder *pf)
1035
{
1036
	struct perf_probe_point *pp = &pf->pev->point;
1037 1038 1039
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1040
	int ret = 0;
1041 1042

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

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

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

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

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

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

found:
1098 1099
	intlist__delete(pf->lcache);
	pf->lcache = NULL;
1100

1101 1102 1103
	return ret;
}

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 1132 1133 1134 1135 1136
/* 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;
}

1137 1138 1139
struct local_vars_finder {
	struct probe_finder *pf;
	struct perf_probe_arg *args;
1140
	bool vars;
1141 1142 1143 1144 1145 1146 1147 1148 1149
	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;
1150
	struct probe_finder *pf = vf->pf;
1151 1152 1153 1154
	int tag;

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

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

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

1225
	/* Trace point should be converted from subprogram DIE */
1226
	ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1227
				     pp->retprobe, pp->function, &tev->point);
1228
	if (ret < 0)
1229
		goto end;
1230

1231
	tev->point.realname = strdup(dwarf_diename(sc_die));
1232 1233 1234 1235
	if (!tev->point.realname) {
		ret = -ENOMEM;
		goto end;
	}
1236

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

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

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

1268
end:
1269 1270 1271 1272
	if (ret) {
		clear_probe_trace_event(tev);
		tf->ntevs--;
	}
1273 1274
	free(args);
	return ret;
1275 1276 1277
}

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

	/* Allocate result tevs array */
1288
	*tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1289 1290 1291 1292 1293 1294
	if (*tevs == NULL)
		return -ENOMEM;

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

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

1326 1327
			if (strbuf_init(&buf, 64) < 0)
				goto error;
1328 1329

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

			ret2 = die_get_varname(die_mem, &buf);

			if (!ret2 && probe_conf.show_location_range &&
				!externs) {
1343 1344
				if (strbuf_addch(&buf, '\t') < 0)
					goto error;
1345 1346 1347 1348 1349 1350
				ret2 = die_get_var_range(&af->pf.sp_die,
							die_mem, &buf);
			}

			pr_debug("Add new var: %s\n", buf.buf);
			if (ret2 == 0) {
1351 1352
				strlist__add(vl->vars,
					strbuf_detach(&buf, NULL));
1353 1354
			}
			strbuf_release(&buf);
1355 1356 1357
		}
	}

1358
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1359 1360 1361
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
1362 1363 1364 1365
error:
	strbuf_release(&buf);
	pr_debug("Error in strbuf\n");
	return DIE_FIND_CB_END;
1366 1367 1368
}

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

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

1385
	/* Trace point should be converted from subprogram DIE */
1386
	ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1387
				     pp->retprobe, pp->function, &vl->point);
1388 1389 1390 1391 1392 1393 1394
	if (ret < 0)
		return ret;

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

	/* Find local variables */
1395
	vl->vars = strlist__new(NULL, NULL);
1396 1397
	if (vl->vars == NULL)
		return -ENOMEM;
1398
	af->child = true;
1399
	die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1400

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

out:
1409 1410 1411 1412 1413 1414 1415 1416
	if (strlist__empty(vl->vars)) {
		strlist__delete(vl->vars);
		vl->vars = NULL;
	}

	return ret;
}

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

	/* Allocate result vls array */
1433
	*vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1434 1435 1436 1437 1438 1439
	if (*vls == NULL)
		return -ENOMEM;

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

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

	return (ret < 0) ? ret : af.nvls;
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 1484 1485 1486 1487 1488
/* 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;
}

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

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

1513 1514 1515
	/* Find a corresponding line (filename and lineno) */
	cu_find_lineinfo(&cudie, addr, &fname, &lineno);
	/* Don't care whether it failed or not */
1516

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

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

post:
	/* Make a relative line number or an offset */
	if (lineno)
		ppt->line = lineno - baseline;
1574
	else if (basefunc) {
1575
		ppt->offset = addr - (unsigned long)baseaddr;
1576 1577
		func = basefunc;
	}
1578 1579 1580 1581

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

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

1614
static int line_range_walk_cb(const char *fname, int lineno,
1615
			      Dwarf_Addr addr __maybe_unused,
1616
			      void *data)
1617
{
1618
	struct line_finder *lf = data;
1619
	int err;
1620

1621
	if ((strtailcmp(fname, lf->fname) != 0) ||
1622
	    (lf->lno_s > lineno || lf->lno_e < lineno))
1623
		return 0;
1624

1625 1626 1627
	err = line_range_add_line(fname, lineno, lf->lr);
	if (err < 0 && err != -EEXIST)
		return err;
1628

1629
	return 0;
1630
}
1631

1632
/* Find line range from its line number */
1633
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1634
{
1635
	int ret;
1636

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

1639
	/* Update status */
1640
	if (ret >= 0)
1641
		if (!intlist__empty(lf->lr->line_list))
1642 1643 1644
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1645
	else {
1646
		zfree(&lf->lr->path);
1647
	}
1648
	return ret;
1649 1650
}

1651 1652
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1653
	int ret = find_line_range_by_line(in_die, data);
1654 1655 1656 1657

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

1664
/* Search function definition from function name */
1665
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1666
{
1667 1668
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1669 1670
	struct line_range *lr = lf->lr;

1671 1672 1673 1674
	/* Check declared file */
	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

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

1699
static int find_line_range_by_func(struct line_finder *lf)
1700
{
1701 1702 1703
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1704 1705
}

1706
int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1707
{
1708
	struct line_finder lf = {.lr = lr, .found = 0};
1709
	int ret = 0;
1710 1711 1712
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1713
	const char *comp_dir;
1714

1715 1716 1717 1718 1719 1720 1721 1722
	/* 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};

1723
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1724
				  &pubname_param, 0);
1725 1726 1727 1728 1729 1730 1731
		if (pubname_param.found) {
			line_range_search_cb(&lf.sp_die, &line_range_param);
			if (lf.found)
				goto found;
		}
	}

1732
	/* Loop on CUs (Compilation Unit) */
1733
	while (!lf.found && ret >= 0) {
1734
		if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1735
				 NULL, NULL, NULL) != 0)
1736 1737 1738
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1739
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1740 1741
		if (!diep)
			continue;
1742 1743 1744

		/* Check if target file is included. */
		if (lr->file)
1745
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1746
		else
1747
			lf.fname = 0;
1748

1749
		if (!lr->file || lf.fname) {
1750
			if (lr->function)
1751
				ret = find_line_range_by_func(&lf);
1752 1753
			else {
				lf.lno_s = lr->start;
1754
				lf.lno_e = lr->end;
1755
				ret = find_line_range_by_line(NULL, &lf);
1756 1757
			}
		}
1758
		off = noff;
1759
	}
1760

1761
found:
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771
	/* 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;
		}
	}

1772
	pr_debug("path: %s\n", lr->path);
1773
	return (ret < 0) ? ret : lf.found;
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 1829 1830 1831 1832 1833
/*
 * 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;
		}
	}
}