probe-finder.c 46.1 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-or-later
2 3 4 5 6 7
/*
 * probe-finder.c : C expression to kprobe event converter
 *
 * Written by Masami Hiramatsu <mhiramat@redhat.com>
 */

8
#include <inttypes.h>
9 10 11 12 13 14 15 16 17 18
#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>
19
#include <dwarf-regs.h>
20

21
#include <linux/bitops.h>
22
#include <linux/zalloc.h>
23
#include "event.h"
24
#include "dso.h"
25
#include "debug.h"
26
#include "intlist.h"
27
#include "strbuf.h"
28
#include "strlist.h"
29
#include "symbol.h"
30
#include "probe-finder.h"
31
#include "probe-file.h"
32
#include "string2.h"
33

34 35 36
/* Kprobe tracer basic type is up to u64 */
#define MAX_BASIC_TYPE_BITS	64

37 38 39 40 41 42 43 44 45 46 47 48 49 50
/* 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 */
51
static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
52
					 const char *path)
53
{
54
	int fd;
55

56 57 58
	fd = open(path, O_RDONLY);
	if (fd < 0)
		return fd;
59

60 61
	dbg->dwfl = dwfl_begin(&offline_callbacks);
	if (!dbg->dwfl)
62
		goto error;
63

64
	dwfl_report_begin(dbg->dwfl);
65 66
	dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
	if (!dbg->mod)
67 68
		goto error;

69 70
	dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
	if (!dbg->dbg)
71 72
		goto error;

73 74
	dwfl_report_end(dbg->dwfl, NULL, NULL);

75
	return 0;
76
error:
77 78
	if (dbg->dwfl)
		dwfl_end(dbg->dwfl);
79 80
	else
		close(fd);
81
	memset(dbg, 0, sizeof(*dbg));
82 83

	return -ENOENT;
84 85
}

86
static struct debuginfo *__debuginfo__new(const char *path)
87
{
88 89
	struct debuginfo *dbg = zalloc(sizeof(*dbg));
	if (!dbg)
90 91
		return NULL;

92 93
	if (debuginfo__init_offline_dwarf(dbg, path) < 0)
		zfree(&dbg);
94 95
	if (dbg)
		pr_debug("Open Debuginfo file: %s\n", path);
96
	return dbg;
97 98
}

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
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);
	}
127
	dso__put(dso);
128 129 130 131 132 133

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

134
void debuginfo__delete(struct debuginfo *dbg)
135
{
136 137 138 139
	if (dbg) {
		if (dbg->dwfl)
			dwfl_end(dbg->dwfl);
		free(dbg);
140
	}
141
}
142

143 144 145 146
/*
 * Probe finder related functions
 */

147
static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
148
{
149 150
	struct probe_trace_arg_ref *ref;
	ref = zalloc(sizeof(struct probe_trace_arg_ref));
151 152 153 154 155
	if (ref != NULL)
		ref->offset = offs;
	return ref;
}

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

177 178 179
	if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
		goto static_var;

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

	if (op->atom == DW_OP_addr) {
216
static_var:
217
		if (!tvar)
218
			return ret2;
219 220 221 222 223 224 225 226 227
		/* 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;
228
		return ret2;
229
	}
230 231

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

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

257
	if (!tvar)
258
		return ret2;
259

260
	regs = get_dwarf_regstr(regn, machine);
261
	if (!regs) {
262
		/* This should be a bug in DWARF or this tool */
M
Masami Hiramatsu 已提交
263 264
		pr_warning("Mapping for the register number %u "
			   "missing on this architecture.\n", regn);
265
		return -ENOTSUP;
266
	}
267

268 269 270 271
	tvar->value = strdup(regs);
	if (tvar->value == NULL)
		return -ENOMEM;

272
	if (ref) {
273
		tvar->ref = alloc_trace_arg_ref((long)offs);
274 275
		if (tvar->ref == NULL)
			return -ENOMEM;
276
	}
277
	return ret2;
278 279
}

280 281
#define BYTES_TO_BITS(nb)	((nb) * BITS_PER_LONG / sizeof(long))

282
static int convert_variable_type(Dwarf_Die *vr_die,
283
				 struct probe_trace_arg *tvar,
284
				 const char *cast, bool user_access)
285
{
286
	struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
287 288
	Dwarf_Die type;
	char buf[16];
289
	char sbuf[STRERR_BUFSIZE];
290
	int bsize, boffs, total;
291
	int ret;
292
	char prefix;
293

294
	/* TODO: check all types */
295
	if (cast && strcmp(cast, "string") != 0 && strcmp(cast, "x") != 0 &&
296
	    strcmp(cast, "s") != 0 && strcmp(cast, "u") != 0) {
297
		/* Non string type is OK */
298
		/* and respect signedness/hexadecimal cast */
299 300 301 302
		tvar->type = strdup(cast);
		return (tvar->type == NULL) ? -ENOMEM : 0;
	}

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

315 316 317 318 319
	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;
	}
320

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

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

361
	if (cast && (strcmp(cast, "u") == 0))
362
		prefix = 'u';
363
	else if (cast && (strcmp(cast, "s") == 0))
364 365 366 367
		prefix = 's';
	else if (cast && (strcmp(cast, "x") == 0) &&
		 probe_type_is_available(PROBE_TYPE_X))
		prefix = 'x';
368
	else
369 370
		prefix = die_is_signed_type(&type) ? 's' :
			 probe_type_is_available(PROBE_TYPE_X) ? 'x' : 'u';
371

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

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

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

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

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

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

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

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

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

514 515 516
	/* If this member is unnamed, we need to reuse this field */
	if (!dwarf_diename(die_mem))
		return convert_variable_fields(die_mem, varname, field,
517
						&ref, die_mem, user_access);
518

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

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

534 535
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
536

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

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

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

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

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

598
	return ret;
599 600
}

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

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

645
	/* Return probe must be on the head of a subprogram */
646 647
	if (retprobe) {
		if (eaddr != paddr) {
648 649 650 651
			pr_warning("Failed to find \"%s%%return\",\n"
				   " because %s is an inlined function and"
				   " has no return point.\n", function,
				   function);
652 653
			return -EINVAL;
		}
654
		tp->retprobe = true;
655 656
	}

657 658 659
	return 0;
}

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

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

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

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

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

	return ret;
716 717
}

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

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

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

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

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

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

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

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

823
	while ((len = getline(&line, &line_len, fp)) > 0) {
824

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

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

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

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

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

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

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

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

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

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

899
	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
900 901
}

902 903 904 905 906 907 908 909 910
static void skip_prologue(Dwarf_Die *sp_die, struct probe_finder *pf)
{
	struct perf_probe_point *pp = &pf->pev->point;

	/* Not uprobe? */
	if (!pf->pev->uprobes)
		return;

	/* Compiled with optimization? */
911
	if (die_is_optimized_target(&pf->cu_die))
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
		return;

	/* Don't know entrypc? */
	if (!pf->addr)
		return;

	/* Only FUNC and FUNC@SRC are eligible. */
	if (!pp->function || pp->line || pp->retprobe || pp->lazy_line ||
	    pp->offset || pp->abs_address)
		return;

	/* Not interested in func parameter? */
	if (!perf_probe_with_var(pf->pev))
		return;

	pr_info("Target program is compiled without optimization. Skipping prologue.\n"
		"Probe on address 0x%" PRIx64 " to force probing at the function entry.\n\n",
		pf->addr);

931
	die_skip_prologue(sp_die, &pf->cu_die, &pf->addr);
932 933
}

934 935
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
936
	struct probe_finder *pf = data;
937
	struct perf_probe_point *pp = &pf->pev->point;
938
	Dwarf_Addr addr;
939
	int ret;
940

941
	if (pp->lazy_line)
942
		ret = find_probe_point_lazy(in_die, pf);
943 944
	else {
		/* Get probe address */
945
		if (dwarf_entrypc(in_die, &addr) != 0) {
M
Masami Hiramatsu 已提交
946
			pr_warning("Failed to get entry address of %s.\n",
947
				   dwarf_diename(in_die));
948
			return -ENOENT;
949
		}
950 951 952 953 954
		if (addr == 0) {
			pr_debug("%s has no valid entry address. skipped.\n",
				 dwarf_diename(in_die));
			return -ENOENT;
		}
955
		pf->addr = addr;
956 957 958 959
		pf->addr += pp->offset;
		pr_debug("found inline addr: 0x%jx\n",
			 (uintmax_t)pf->addr);

960
		ret = call_probe_finder(in_die, pf);
961
	}
962

963
	return ret;
964
}
965

966 967 968 969 970 971
/* Callback parameter with return value for libdw */
struct dwarf_callback_param {
	void *data;
	int retval;
};

972
/* Search function from function name */
973
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
974
{
975 976
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
977
	struct perf_probe_point *pp = &pf->pev->point;
978

979
	/* Check tag and diename */
980
	if (!die_is_func_def(sp_die) ||
981
	    !die_match_name(sp_die, pp->function))
982
		return DWARF_CB_OK;
983

984 985 986 987
	/* Check declared file */
	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

988 989
	pr_debug("Matched function: %s [%lx]\n", dwarf_diename(sp_die),
		 (unsigned long)dwarf_dieoffset(sp_die));
990
	pf->fname = dwarf_decl_file(sp_die);
991 992 993
	if (pp->line) { /* Function relative line */
		dwarf_decl_line(sp_die, &pf->lno);
		pf->lno += pp->line;
994
		param->retval = find_probe_point_by_line(pf);
995 996 997
	} else if (die_is_func_instance(sp_die)) {
		/* Instances always have the entry address */
		dwarf_entrypc(sp_die, &pf->addr);
998 999 1000 1001 1002
		/* But in some case the entry address is 0 */
		if (pf->addr == 0) {
			pr_debug("%s has no entry PC. Skipped\n",
				 dwarf_diename(sp_die));
			param->retval = 0;
1003
		/* Real function */
1004
		} else if (pp->lazy_line)
1005
			param->retval = find_probe_point_lazy(sp_die, pf);
1006
		else {
1007
			skip_prologue(sp_die, pf);
1008 1009
			pf->addr += pp->offset;
			/* TODO: Check the address in this function */
1010
			param->retval = call_probe_finder(sp_die, pf);
1011
		}
1012
	} else if (!probe_conf.no_inlines) {
1013
		/* Inlined function: search instances */
1014 1015
		param->retval = die_walk_instances(sp_die,
					probe_point_inline_cb, (void *)pf);
1016
		/* This could be a non-existed inline definition */
1017
		if (param->retval == -ENOENT)
1018 1019 1020 1021 1022 1023 1024 1025
			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;
	}
1026

1027
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
1028 1029
}

1030
static int find_probe_point_by_func(struct probe_finder *pf)
1031
{
1032 1033 1034 1035
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
1036 1037
}

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
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;

1054
		if (die_match_name(param->sp_die, param->function)) {
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
			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;
}

1070
static int debuginfo__find_probe_location(struct debuginfo *dbg,
1071
				  struct probe_finder *pf)
1072
{
1073
	struct perf_probe_point *pp = &pf->pev->point;
1074 1075 1076
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1077
	int ret = 0;
1078 1079

	off = 0;
1080 1081 1082
	pf->lcache = intlist__new(NULL);
	if (!pf->lcache)
		return -ENOMEM;
1083 1084

	/* Fastpath: lookup by function name from .debug_pubnames section */
1085
	if (pp->function && !strisglob(pp->function)) {
1086 1087 1088 1089 1090
		struct pubname_callback_param pubname_param = {
			.function = pp->function,
			.file	  = pp->file,
			.cu_die	  = &pf->cu_die,
			.sp_die	  = &pf->sp_die,
1091
			.found	  = 0,
1092 1093 1094 1095 1096
		};
		struct dwarf_callback_param probe_param = {
			.data = pf,
		};

1097
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1098
				  &pubname_param, 0);
1099 1100 1101 1102 1103 1104 1105
		if (pubname_param.found) {
			ret = probe_point_search_cb(&pf->sp_die, &probe_param);
			if (ret)
				goto found;
		}
	}

1106
	/* Loop on CUs (Compilation Unit) */
1107
	while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1108
		/* Get the DIE(Debugging Information Entry) of this CU */
1109
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1110 1111
		if (!diep)
			continue;
1112 1113 1114

		/* Check if target file is included. */
		if (pp->file)
1115
			pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1116
		else
1117
			pf->fname = NULL;
1118

1119
		if (!pp->file || pf->fname) {
1120
			if (pp->function)
1121
				ret = find_probe_point_by_func(pf);
1122
			else if (pp->lazy_line)
1123
				ret = find_probe_point_lazy(&pf->cu_die, pf);
1124
			else {
1125 1126
				pf->lno = pp->line;
				ret = find_probe_point_by_line(pf);
1127
			}
1128
			if (ret < 0)
1129
				break;
1130
		}
1131
		off = noff;
1132
	}
1133 1134

found:
1135 1136
	intlist__delete(pf->lcache);
	pf->lcache = NULL;
1137

1138 1139 1140
	return ret;
}

1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
/* Find probe points from debuginfo */
static int debuginfo__find_probes(struct debuginfo *dbg,
				  struct probe_finder *pf)
{
	int ret = 0;
	Elf *elf;
	GElf_Ehdr ehdr;

	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;

1160 1161 1162 1163 1164 1165 1166 1167 1168
	pf->machine = ehdr.e_machine;

#if _ELFUTILS_PREREQ(0, 142)
	do {
		GElf_Shdr shdr;

		if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
		    shdr.sh_type == SHT_PROGBITS)
			pf->cfi_eh = dwarf_getcfi_elf(elf);
1169

1170 1171
		pf->cfi_dbg = dwarf_getcfi(dbg->dbg);
	} while (0);
1172 1173 1174 1175 1176 1177
#endif

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

1178 1179 1180
struct local_vars_finder {
	struct probe_finder *pf;
	struct perf_probe_arg *args;
1181
	bool vars;
1182 1183 1184 1185 1186 1187 1188 1189 1190
	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;
1191
	struct probe_finder *pf = vf->pf;
1192 1193 1194 1195
	int tag;

	tag = dwarf_tag(die_mem);
	if (tag == DW_TAG_formal_parameter ||
1196
	    (tag == DW_TAG_variable && vf->vars)) {
1197
		if (convert_variable_location(die_mem, vf->pf->addr,
1198
					      vf->pf->fb_ops, &pf->sp_die,
1199
					      pf->machine, NULL) == 0) {
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
			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;
1222
	struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1223 1224 1225 1226
				.max_args = MAX_PROBE_ARGS, .ret = 0};

	for (i = 0; i < pf->pev->nargs; i++) {
		/* var never be NULL */
1227 1228 1229
		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) {
1230 1231 1232
			/* Copy normal argument */
			args[n] = pf->pev->args[i];
			n++;
1233
			continue;
1234
		}
1235 1236 1237 1238 1239 1240 1241 1242 1243
		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;
1244 1245 1246 1247
	}
	return n;
}

1248
/* Add a found probe point into trace event list */
1249
static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1250 1251 1252
{
	struct trace_event_finder *tf =
			container_of(pf, struct trace_event_finder, pf);
1253
	struct perf_probe_point *pp = &pf->pev->point;
1254
	struct probe_trace_event *tev;
1255
	struct perf_probe_arg *args = NULL;
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
	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++];

1266
	/* Trace point should be converted from subprogram DIE */
1267
	ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1268
				     pp->retprobe, pp->function, &tev->point);
1269
	if (ret < 0)
1270
		goto end;
1271

1272
	tev->point.realname = strdup(dwarf_diename(sc_die));
1273 1274 1275 1276
	if (!tev->point.realname) {
		ret = -ENOMEM;
		goto end;
	}
1277

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

1281 1282
	/* Expand special probe argument if exist */
	args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1283 1284 1285 1286
	if (args == NULL) {
		ret = -ENOMEM;
		goto end;
	}
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301

	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];
1302
		pf->tvar = &tev->args[i];
1303 1304
		/* Variable should be found from scope DIE */
		ret = find_variable(sc_die, pf);
1305
		if (ret != 0)
1306
			break;
1307 1308
	}

1309
end:
1310 1311 1312 1313
	if (ret) {
		clear_probe_trace_event(tev);
		tf->ntevs--;
	}
1314 1315
	free(args);
	return ret;
1316 1317 1318
}

/* Find probe_trace_events specified by perf_probe_event from debuginfo */
1319
int debuginfo__find_trace_events(struct debuginfo *dbg,
1320
				 struct perf_probe_event *pev,
1321
				 struct probe_trace_event **tevs)
1322 1323 1324
{
	struct trace_event_finder tf = {
			.pf = {.pev = pev, .callback = add_probe_trace_event},
1325
			.max_tevs = probe_conf.max_probes, .mod = dbg->mod};
1326
	int ret, i;
1327 1328

	/* Allocate result tevs array */
1329
	*tevs = zalloc(sizeof(struct probe_trace_event) * tf.max_tevs);
1330 1331 1332 1333 1334 1335
	if (*tevs == NULL)
		return -ENOMEM;

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

1336
	ret = debuginfo__find_probes(dbg, &tf.pf);
1337
	if (ret < 0) {
1338 1339
		for (i = 0; i < tf.ntevs; i++)
			clear_probe_trace_event(&tf.tevs[i]);
1340
		zfree(tevs);
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
		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;
1352
	struct strbuf buf = STRBUF_INIT;
1353 1354 1355 1356 1357 1358 1359 1360
	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,
1361
						af->pf.fb_ops, &af->pf.sp_die,
1362
						af->pf.machine, NULL);
1363 1364 1365
		if (ret == 0 || ret == -ERANGE) {
			int ret2;
			bool externs = !af->child;
1366

1367 1368
			if (strbuf_init(&buf, 64) < 0)
				goto error;
1369 1370

			if (probe_conf.show_location_range) {
1371 1372 1373 1374 1375 1376 1377
				if (!externs)
					ret2 = strbuf_add(&buf,
						ret ? "[INV]\t" : "[VAL]\t", 6);
				else
					ret2 = strbuf_add(&buf, "[EXT]\t", 6);
				if (ret2)
					goto error;
1378 1379 1380 1381 1382 1383
			}

			ret2 = die_get_varname(die_mem, &buf);

			if (!ret2 && probe_conf.show_location_range &&
				!externs) {
1384 1385
				if (strbuf_addch(&buf, '\t') < 0)
					goto error;
1386 1387 1388 1389 1390 1391
				ret2 = die_get_var_range(&af->pf.sp_die,
							die_mem, &buf);
			}

			pr_debug("Add new var: %s\n", buf.buf);
			if (ret2 == 0) {
1392 1393
				strlist__add(vl->vars,
					strbuf_detach(&buf, NULL));
1394 1395
			}
			strbuf_release(&buf);
1396 1397 1398
		}
	}

1399
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1400 1401 1402
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
1403 1404 1405 1406
error:
	strbuf_release(&buf);
	pr_debug("Error in strbuf\n");
	return DIE_FIND_CB_END;
1407 1408 1409
}

/* Add a found vars into available variables list */
1410
static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1411 1412 1413
{
	struct available_var_finder *af =
			container_of(pf, struct available_var_finder, pf);
1414
	struct perf_probe_point *pp = &pf->pev->point;
1415
	struct variable_list *vl;
1416 1417
	Dwarf_Die die_mem;
	int ret;
1418 1419 1420 1421 1422 1423 1424 1425

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

1426
	/* Trace point should be converted from subprogram DIE */
1427
	ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1428
				     pp->retprobe, pp->function, &vl->point);
1429 1430 1431 1432 1433 1434 1435
	if (ret < 0)
		return ret;

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

	/* Find local variables */
1436
	vl->vars = strlist__new(NULL, NULL);
1437 1438
	if (vl->vars == NULL)
		return -ENOMEM;
1439
	af->child = true;
1440
	die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1441

1442
	/* Find external variables */
1443
	if (!probe_conf.show_ext_vars)
1444
		goto out;
1445
	/* Don't need to search child DIE for external vars. */
1446
	af->child = false;
1447
	die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1448 1449

out:
1450 1451 1452 1453 1454 1455 1456 1457
	if (strlist__empty(vl->vars)) {
		strlist__delete(vl->vars);
		vl->vars = NULL;
	}

	return ret;
}

1458 1459 1460 1461 1462
/*
 * 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.
 */
1463
int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1464
				      struct perf_probe_event *pev,
1465
				      struct variable_list **vls)
1466 1467 1468
{
	struct available_var_finder af = {
			.pf = {.pev = pev, .callback = add_available_vars},
1469
			.mod = dbg->mod,
1470
			.max_vls = probe_conf.max_probes};
1471 1472 1473
	int ret;

	/* Allocate result vls array */
1474
	*vls = zalloc(sizeof(struct variable_list) * af.max_vls);
1475 1476 1477 1478 1479 1480
	if (*vls == NULL)
		return -ENOMEM;

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

1481
	ret = debuginfo__find_probes(dbg, &af.pf);
1482 1483 1484
	if (ret < 0) {
		/* Free vlist for error */
		while (af.nvls--) {
1485
			zfree(&af.vls[af.nvls].point.symbol);
1486
			strlist__delete(af.vls[af.nvls].vars);
1487
		}
1488
		zfree(vls);
1489 1490 1491 1492
		return ret;
	}

	return (ret < 0) ? ret : af.nvls;
1493 1494
}

1495
/* For the kernel module, we need a special code to get a DIE */
1496 1497
int debuginfo__get_text_offset(struct debuginfo *dbg, Dwarf_Addr *offs,
				bool adjust_offset)
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
{
	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;
1526 1527
			if (adjust_offset)
				*offs -= shdr->sh_offset;
1528 1529 1530 1531 1532
		}
	}
	return 0;
}

1533
/* Reverse search */
1534
int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1535
				struct perf_probe_point *ppt)
1536 1537
{
	Dwarf_Die cudie, spdie, indie;
1538 1539
	Dwarf_Addr _addr = 0, baseaddr = 0;
	const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1540
	int baseline = 0, lineno = 0, ret = 0;
1541

1542
	/* We always need to relocate the address for aranges */
1543
	if (debuginfo__get_text_offset(dbg, &baseaddr, false) == 0)
1544
		addr += baseaddr;
1545
	/* Find cu die */
1546
	if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
M
Masami Hiramatsu 已提交
1547 1548
		pr_warning("Failed to find debug information for address %lx\n",
			   addr);
1549 1550 1551
		ret = -EINVAL;
		goto end;
	}
1552

1553 1554 1555
	/* Find a corresponding line (filename and lineno) */
	cu_find_lineinfo(&cudie, addr, &fname, &lineno);
	/* Don't care whether it failed or not */
1556

1557
	/* Find a corresponding function (name, baseline and baseaddr) */
1558
	if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1559
		/* Get function entry information */
1560 1561
		func = basefunc = dwarf_diename(&spdie);
		if (!func ||
1562
		    dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1563 1564
		    dwarf_decl_line(&spdie, &baseline) != 0) {
			lineno = 0;
1565
			goto post;
1566
		}
1567

1568
		fname = dwarf_decl_file(&spdie);
1569
		if (addr == (unsigned long)baseaddr) {
1570 1571
			/* Function entry - Relative line number is 0 */
			lineno = baseline;
1572 1573 1574 1575 1576 1577 1578
			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 */
1579
			if (dwarf_entrypc(&indie, &_addr) == 0 &&
1580
			    _addr == addr) {
1581 1582 1583
				/*
				 * addr is at an inline function entry.
				 * In this case, lineno should be the call-site
1584
				 * line number. (overwrite lineinfo)
1585 1586
				 */
				lineno = die_get_call_lineno(&indie);
1587 1588 1589
				fname = die_get_call_file(&indie);
				break;
			} else {
1590 1591 1592 1593 1594 1595
				/*
				 * 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.
				 */
1596
				tmp = dwarf_diename(&indie);
1597 1598 1599 1600 1601
				if (!tmp ||
				    dwarf_decl_line(&indie, &baseline) != 0)
					break;
				func = tmp;
				spdie = indie;
1602
			}
1603
		}
1604 1605 1606 1607
		/* Verify the lineno and baseline are in a same file */
		tmp = dwarf_decl_file(&spdie);
		if (!tmp || strcmp(tmp, fname) != 0)
			lineno = 0;
1608 1609 1610 1611 1612 1613
	}

post:
	/* Make a relative line number or an offset */
	if (lineno)
		ppt->line = lineno - baseline;
1614
	else if (basefunc) {
1615
		ppt->offset = addr - (unsigned long)baseaddr;
1616 1617
		func = basefunc;
	}
1618 1619 1620 1621

	/* Duplicate strings */
	if (func) {
		ppt->function = strdup(func);
1622 1623 1624 1625
		if (ppt->function == NULL) {
			ret = -ENOMEM;
			goto end;
		}
1626
	}
1627 1628 1629
	if (fname) {
		ppt->file = strdup(fname);
		if (ppt->file == NULL) {
1630
			zfree(&ppt->function);
1631 1632 1633 1634
			ret = -ENOMEM;
			goto end;
		}
	}
1635
end:
1636 1637
	if (ret == 0 && (fname || func))
		ret = 1;	/* Found a point */
1638 1639 1640
	return ret;
}

1641 1642 1643 1644
/* Add a line and store the src path */
static int line_range_add_line(const char *src, unsigned int lineno,
			       struct line_range *lr)
{
1645
	/* Copy source path */
1646
	if (!lr->path) {
1647 1648 1649
		lr->path = strdup(src);
		if (lr->path == NULL)
			return -ENOMEM;
1650
	}
1651
	return intlist__add(lr->line_list, lineno);
1652 1653
}

1654
static int line_range_walk_cb(const char *fname, int lineno,
1655
			      Dwarf_Addr addr __maybe_unused,
1656
			      void *data)
1657
{
1658
	struct line_finder *lf = data;
1659
	int err;
1660

1661
	if ((strtailcmp(fname, lf->fname) != 0) ||
1662
	    (lf->lno_s > lineno || lf->lno_e < lineno))
1663
		return 0;
1664

1665 1666 1667
	err = line_range_add_line(fname, lineno, lf->lr);
	if (err < 0 && err != -EEXIST)
		return err;
1668

1669
	return 0;
1670
}
1671

1672
/* Find line range from its line number */
1673
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1674
{
1675
	int ret;
1676

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

1679
	/* Update status */
1680
	if (ret >= 0)
1681
		if (!intlist__empty(lf->lr->line_list))
1682 1683 1684
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1685
	else {
1686
		zfree(&lf->lr->path);
1687
	}
1688
	return ret;
1689 1690
}

1691 1692
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1693
	int ret = find_line_range_by_line(in_die, data);
1694 1695 1696 1697

	/*
	 * We have to check all instances of inlined function, because
	 * some execution paths can be optimized out depends on the
1698 1699
	 * function argument of instances. However, if an error occurs,
	 * it should be handled by the caller.
1700
	 */
1701
	return ret < 0 ? ret : 0;
1702 1703
}

1704
/* Search function definition from function name */
1705
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1706
{
1707 1708
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1709 1710
	struct line_range *lr = lf->lr;

1711 1712 1713 1714
	/* Check declared file */
	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

1715
	if (die_is_func_def(sp_die) &&
1716
	    die_match_name(sp_die, lr->function)) {
1717 1718
		lf->fname = dwarf_decl_file(sp_die);
		dwarf_decl_line(sp_die, &lr->offset);
1719
		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1720
		lf->lno_s = lr->offset + lr->start;
1721 1722 1723 1724
		if (lf->lno_s < 0)	/* Overflow */
			lf->lno_s = INT_MAX;
		lf->lno_e = lr->offset + lr->end;
		if (lf->lno_e < 0)	/* Overflow */
1725
			lf->lno_e = INT_MAX;
1726
		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1727 1728
		lr->start = lf->lno_s;
		lr->end = lf->lno_e;
1729
		if (!die_is_func_instance(sp_die))
1730 1731 1732
			param->retval = die_walk_instances(sp_die,
						line_range_inline_cb, lf);
		else
1733 1734
			param->retval = find_line_range_by_line(sp_die, lf);
		return DWARF_CB_ABORT;
1735
	}
1736
	return DWARF_CB_OK;
1737 1738
}

1739
static int find_line_range_by_func(struct line_finder *lf)
1740
{
1741 1742 1743
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1744 1745
}

1746
int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1747
{
1748
	struct line_finder lf = {.lr = lr, .found = 0};
1749
	int ret = 0;
1750 1751 1752
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1753
	const char *comp_dir;
1754

1755 1756 1757 1758 1759 1760 1761 1762
	/* 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};

1763
		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1764
				  &pubname_param, 0);
1765 1766 1767 1768 1769 1770 1771
		if (pubname_param.found) {
			line_range_search_cb(&lf.sp_die, &line_range_param);
			if (lf.found)
				goto found;
		}
	}

1772
	/* Loop on CUs (Compilation Unit) */
1773
	while (!lf.found && ret >= 0) {
1774
		if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1775
				 NULL, NULL, NULL) != 0)
1776 1777 1778
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1779
		diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1780 1781
		if (!diep)
			continue;
1782 1783 1784

		/* Check if target file is included. */
		if (lr->file)
1785
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1786
		else
1787
			lf.fname = 0;
1788

1789
		if (!lr->file || lf.fname) {
1790
			if (lr->function)
1791
				ret = find_line_range_by_func(&lf);
1792 1793
			else {
				lf.lno_s = lr->start;
1794
				lf.lno_e = lr->end;
1795
				ret = find_line_range_by_line(NULL, &lf);
1796 1797
			}
		}
1798
		off = noff;
1799
	}
1800

1801
found:
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
	/* 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;
		}
	}

1812
	pr_debug("path: %s\n", lr->path);
1813
	return (ret < 0) ? ret : lf.found;
1814 1815
}

1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873
/*
 * 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;
		}
	}
}