probe-finder.c 47.6 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 32 33
/*
 * 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 <getopt.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <ctype.h>
34
#include <dwarf-regs.h>
35

36
#include <linux/bitops.h>
37 38
#include "event.h"
#include "debug.h"
39
#include "util.h"
40
#include "symbol.h"
41 42
#include "probe-finder.h"

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

46 47 48 49 50 51 52 53
/*
 * Compare the tail of two strings.
 * Return 0 if whole of either string is same as another's tail part.
 */
static int strtailcmp(const char *s1, const char *s2)
{
	int i1 = strlen(s1);
	int i2 = strlen(s2);
54
	while (--i1 >= 0 && --i2 >= 0) {
55 56 57 58 59 60
		if (s1[i1] != s2[i2])
			return s1[i1] - s2[i2];
	}
	return 0;
}

61 62 63
/* Line number list operations */

/* Add a line to line number list */
64
static int line_list__add_line(struct list_head *head, int line)
65 66 67 68 69 70 71 72 73 74
{
	struct line_node *ln;
	struct list_head *p;

	/* Reverse search, because new line will be the last one */
	list_for_each_entry_reverse(ln, head, list) {
		if (ln->line < line) {
			p = &ln->list;
			goto found;
		} else if (ln->line == line)	/* Already exist */
75
			return 1;
76 77 78 79 80
	}
	/* List is empty, or the smallest entry */
	p = head;
found:
	pr_debug("line list: add a line %u\n", line);
81 82 83
	ln = zalloc(sizeof(struct line_node));
	if (ln == NULL)
		return -ENOMEM;
84 85 86
	ln->line = line;
	INIT_LIST_HEAD(&ln->list);
	list_add(&ln->list, p);
87
	return 0;
88 89 90
}

/* Check if the line in line number list */
91
static int line_list__has_line(struct list_head *head, int line)
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
{
	struct line_node *ln;

	/* Reverse search, because new line will be the last one */
	list_for_each_entry(ln, head, list)
		if (ln->line == line)
			return 1;

	return 0;
}

/* Init line number list */
static void line_list__init(struct list_head *head)
{
	INIT_LIST_HEAD(head);
}

/* Free line number list */
static void line_list__free(struct list_head *head)
{
	struct line_node *ln;
	while (!list_empty(head)) {
		ln = list_first_entry(head, struct line_node, list);
		list_del(&ln->list);
		free(ln);
	}
}

120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
/* 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 */
static Dwarf *dwfl_init_offline_dwarf(int fd, Dwfl **dwflp, Dwarf_Addr *bias)
{
	Dwfl_Module *mod;
	Dwarf *dbg = NULL;

	if (!dwflp)
		return NULL;

	*dwflp = dwfl_begin(&offline_callbacks);
	if (!*dwflp)
		return NULL;

	mod = dwfl_report_offline(*dwflp, "", "", fd);
	if (!mod)
		goto error;

	dbg = dwfl_module_getdwarf(mod, bias);
	if (!dbg) {
error:
		dwfl_end(*dwflp);
		*dwflp = NULL;
	}
	return dbg;
}

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
#if _ELFUTILS_PREREQ(0, 148)
/* This method is buggy if elfutils is older than 0.148 */
static int __linux_kernel_find_elf(Dwfl_Module *mod,
				   void **userdata,
				   const char *module_name,
				   Dwarf_Addr base,
				   char **file_name, Elf **elfp)
{
	int fd;
	const char *path = kernel_get_module_path(module_name);

	pr_debug2("Use file %s for %s\n", path, module_name);
	if (path) {
		fd = open(path, O_RDONLY);
		if (fd >= 0) {
			*file_name = strdup(path);
			return fd;
		}
	}
	/* If failed, try to call standard method */
	return dwfl_linux_kernel_find_elf(mod, userdata, module_name, base,
					  file_name, elfp);
}

static const Dwfl_Callbacks kernel_callbacks = {
	.find_debuginfo = dwfl_standard_find_debuginfo,
	.debuginfo_path = &debuginfo_path,

	.find_elf = __linux_kernel_find_elf,
	.section_address = dwfl_linux_kernel_module_section_address,
};

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
/* Get a Dwarf from live kernel image */
static Dwarf *dwfl_init_live_kernel_dwarf(Dwarf_Addr addr, Dwfl **dwflp,
					  Dwarf_Addr *bias)
{
	Dwarf *dbg;

	if (!dwflp)
		return NULL;

	*dwflp = dwfl_begin(&kernel_callbacks);
	if (!*dwflp)
		return NULL;

	/* Load the kernel dwarves: Don't care the result here */
	dwfl_linux_kernel_report_kernel(*dwflp);
	dwfl_linux_kernel_report_modules(*dwflp);

	dbg = dwfl_addrdwarf(*dwflp, addr, bias);
	/* Here, check whether we could get a real dwarf */
	if (!dbg) {
211 212
		pr_debug("Failed to find kernel dwarf at %lx\n",
			 (unsigned long)addr);
213 214 215 216 217
		dwfl_end(*dwflp);
		*dwflp = NULL;
	}
	return dbg;
}
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
#else
/* With older elfutils, this just support kernel module... */
static Dwarf *dwfl_init_live_kernel_dwarf(Dwarf_Addr addr __used, Dwfl **dwflp,
					  Dwarf_Addr *bias)
{
	int fd;
	const char *path = kernel_get_module_path("kernel");

	if (!path) {
		pr_err("Failed to find vmlinux path\n");
		return NULL;
	}

	pr_debug2("Use file %s for debuginfo\n", path);
	fd = open(path, O_RDONLY);
	if (fd < 0)
		return NULL;

	return dwfl_init_offline_dwarf(fd, dwflp, bias);
}
#endif
239

240 241 242 243
/* Dwarf wrappers */

/* Find the realpath of the target file. */
static const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
244
{
245 246
	Dwarf_Files *files;
	size_t nfiles, i;
247
	const char *src = NULL;
248 249 250
	int ret;

	if (!fname)
251
		return NULL;
252

253
	ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
254 255 256 257 258 259 260
	if (ret != 0)
		return NULL;

	for (i = 0; i < nfiles; i++) {
		src = dwarf_filesrc(files, i, NULL, NULL);
		if (strtailcmp(src, fname) == 0)
			break;
261
	}
262 263
	if (i == nfiles)
		return NULL;
264
	return src;
265 266
}

267 268 269 270 271 272 273 274 275
/* Get DW_AT_comp_dir (should be NULL with older gcc) */
static const char *cu_get_comp_dir(Dwarf_Die *cu_die)
{
	Dwarf_Attribute attr;
	if (dwarf_attr(cu_die, DW_AT_comp_dir, &attr) == NULL)
		return NULL;
	return dwarf_formstring(&attr);
}

276 277 278 279 280
/* Compare diename and tname */
static bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
{
	const char *name;
	name = dwarf_diename(dw_die);
281
	return name ? (strcmp(tname, name) == 0) : false;
282 283
}

284 285 286 287 288 289 290 291 292 293 294 295 296
/* Get callsite line number of inline-function instance */
static int die_get_call_lineno(Dwarf_Die *in_die)
{
	Dwarf_Attribute attr;
	Dwarf_Word ret;

	if (!dwarf_attr(in_die, DW_AT_call_line, &attr))
		return -ENOENT;

	dwarf_formudata(&attr, &ret);
	return (int)ret;
}

M
Masami Hiramatsu 已提交
297 298 299 300 301 302 303 304 305 306 307 308
/* Get type die */
static Dwarf_Die *die_get_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
{
	Dwarf_Attribute attr;

	if (dwarf_attr_integrate(vr_die, DW_AT_type, &attr) &&
	    dwarf_formref_die(&attr, die_mem))
		return die_mem;
	else
		return NULL;
}

309 310
/* Get a type die, but skip qualifiers */
static Dwarf_Die *__die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
311 312 313 314
{
	int tag;

	do {
M
Masami Hiramatsu 已提交
315 316 317 318
		vr_die = die_get_type(vr_die, die_mem);
		if (!vr_die)
			break;
		tag = dwarf_tag(vr_die);
319 320 321
	} while (tag == DW_TAG_const_type ||
		 tag == DW_TAG_restrict_type ||
		 tag == DW_TAG_volatile_type ||
322 323 324 325 326 327 328 329 330 331 332
		 tag == DW_TAG_shared_type);

	return vr_die;
}

/* Get a type die, but skip qualifiers and typedef */
static Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
{
	do {
		vr_die = __die_get_real_type(vr_die, die_mem);
	} while (vr_die && dwarf_tag(vr_die) == DW_TAG_typedef);
333

M
Masami Hiramatsu 已提交
334
	return vr_die;
335 336
}

337 338
static int die_get_attr_udata(Dwarf_Die *tp_die, unsigned int attr_name,
			      Dwarf_Word *result)
339 340
{
	Dwarf_Attribute attr;
341 342 343 344 345 346 347 348 349 350

	if (dwarf_attr(tp_die, attr_name, &attr) == NULL ||
	    dwarf_formudata(&attr, result) != 0)
		return -ENOENT;

	return 0;
}

static bool die_is_signed_type(Dwarf_Die *tp_die)
{
351 352
	Dwarf_Word ret;

353
	if (die_get_attr_udata(tp_die, DW_AT_encoding, &ret))
354 355 356 357 358 359 360 361 362 363
		return false;

	return (ret == DW_ATE_signed_char || ret == DW_ATE_signed ||
		ret == DW_ATE_signed_fixed);
}

static int die_get_byte_size(Dwarf_Die *tp_die)
{
	Dwarf_Word ret;

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
	if (die_get_attr_udata(tp_die, DW_AT_byte_size, &ret))
		return 0;

	return (int)ret;
}

static int die_get_bit_size(Dwarf_Die *tp_die)
{
	Dwarf_Word ret;

	if (die_get_attr_udata(tp_die, DW_AT_bit_size, &ret))
		return 0;

	return (int)ret;
}

static int die_get_bit_offset(Dwarf_Die *tp_die)
{
	Dwarf_Word ret;

	if (die_get_attr_udata(tp_die, DW_AT_bit_offset, &ret))
385 386 387 388 389
		return 0;

	return (int)ret;
}

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
/* Get data_member_location offset */
static int die_get_data_member_location(Dwarf_Die *mb_die, Dwarf_Word *offs)
{
	Dwarf_Attribute attr;
	Dwarf_Op *expr;
	size_t nexpr;
	int ret;

	if (dwarf_attr(mb_die, DW_AT_data_member_location, &attr) == NULL)
		return -ENOENT;

	if (dwarf_formudata(&attr, offs) != 0) {
		/* DW_AT_data_member_location should be DW_OP_plus_uconst */
		ret = dwarf_getlocation(&attr, &expr, &nexpr);
		if (ret < 0 || nexpr == 0)
			return -ENOENT;

		if (expr[0].atom != DW_OP_plus_uconst || nexpr != 1) {
			pr_debug("Unable to get offset:Unexpected OP %x (%zd)\n",
				 expr[0].atom, nexpr);
			return -ENOTSUP;
		}
		*offs = (Dwarf_Word)expr[0].number;
	}
	return 0;
}

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
/* Return values for die_find callbacks */
enum {
	DIE_FIND_CB_FOUND = 0,		/* End of Search */
	DIE_FIND_CB_CHILD = 1,		/* Search only children */
	DIE_FIND_CB_SIBLING = 2,	/* Search only siblings */
	DIE_FIND_CB_CONTINUE = 3,	/* Search children and siblings */
};

/* Search a child die */
static Dwarf_Die *die_find_child(Dwarf_Die *rt_die,
				 int (*callback)(Dwarf_Die *, void *),
				 void *data, Dwarf_Die *die_mem)
{
	Dwarf_Die child_die;
	int ret;

	ret = dwarf_child(rt_die, die_mem);
	if (ret != 0)
		return NULL;

	do {
		ret = callback(die_mem, data);
		if (ret == DIE_FIND_CB_FOUND)
			return die_mem;

		if ((ret & DIE_FIND_CB_CHILD) &&
		    die_find_child(die_mem, callback, data, &child_die)) {
			memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
			return die_mem;
		}
	} while ((ret & DIE_FIND_CB_SIBLING) &&
		 dwarf_siblingof(die_mem, die_mem) == 0);

	return NULL;
}

453 454 455 456 457 458
struct __addr_die_search_param {
	Dwarf_Addr	addr;
	Dwarf_Die	*die_mem;
};

static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
459
{
460
	struct __addr_die_search_param *ad = data;
461

462 463 464 465 466 467 468
	if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
	    dwarf_haspc(fn_die, ad->addr)) {
		memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
		return DWARF_CB_ABORT;
	}
	return DWARF_CB_OK;
}
469

470
/* Search a real subprogram including this line, */
471 472
static Dwarf_Die *die_find_real_subprogram(Dwarf_Die *cu_die, Dwarf_Addr addr,
					   Dwarf_Die *die_mem)
473 474 475 476 477 478 479 480 481
{
	struct __addr_die_search_param ad;
	ad.addr = addr;
	ad.die_mem = die_mem;
	/* dwarf_getscopes can't find subprogram. */
	if (!dwarf_getfuncs(cu_die, __die_search_func_cb, &ad, 0))
		return NULL;
	else
		return die_mem;
482 483
}

484 485
/* die_find callback for inline function search */
static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
486
{
487
	Dwarf_Addr *addr = data;
488

489 490 491
	if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
	    dwarf_haspc(die_mem, *addr))
		return DIE_FIND_CB_FOUND;
492

493
	return DIE_FIND_CB_CONTINUE;
494 495
}

496 497 498
/* Similar to dwarf_getfuncs, but returns inlined_subroutine if exists. */
static Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
				      Dwarf_Die *die_mem)
499
{
500 501 502 503 504 505 506 507 508 509 510 511 512 513
	Dwarf_Die tmp_die;

	sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr, &tmp_die);
	if (!sp_die)
		return NULL;

	/* Inlined function could be recursive. Trace it until fail */
	while (sp_die) {
		memcpy(die_mem, sp_die, sizeof(Dwarf_Die));
		sp_die = die_find_child(sp_die, __die_find_inline_cb, &addr,
					&tmp_die);
	}

	return die_mem;
514 515
}

516 517 518 519 520
/* Walker on lines (Note: line number will not be sorted) */
typedef int (* line_walk_handler_t) (const char *fname, int lineno,
				     Dwarf_Addr addr, void *data);

struct __line_walk_param {
521
	const char *fname;
522 523 524 525 526
	line_walk_handler_t handler;
	void *data;
	int retval;
};

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
static int __die_walk_funclines_cb(Dwarf_Die *in_die, void *data)
{
	struct __line_walk_param *lw = data;
	Dwarf_Addr addr;
	int lineno;

	if (dwarf_tag(in_die) == DW_TAG_inlined_subroutine) {
		lineno = die_get_call_lineno(in_die);
		if (lineno > 0 && dwarf_entrypc(in_die, &addr) == 0) {
			lw->retval = lw->handler(lw->fname, lineno, addr,
						 lw->data);
			if (lw->retval != 0)
				return DIE_FIND_CB_FOUND;
		}
	}
	return DIE_FIND_CB_SIBLING;
}

/* Walk on lines of blocks included in given DIE */
546 547 548
static int __die_walk_funclines(Dwarf_Die *sp_die,
				line_walk_handler_t handler, void *data)
{
549 550 551 552 553 554
	struct __line_walk_param lw = {
		.handler = handler,
		.data = data,
		.retval = 0,
	};
	Dwarf_Die die_mem;
555
	Dwarf_Addr addr;
556
	int lineno;
557 558

	/* Handle function declaration line */
559 560
	lw.fname = dwarf_decl_file(sp_die);
	if (lw.fname && dwarf_decl_line(sp_die, &lineno) == 0 &&
561
	    dwarf_entrypc(sp_die, &addr) == 0) {
562 563 564
		lw.retval = handler(lw.fname, lineno, addr, data);
		if (lw.retval != 0)
			goto done;
565
	}
566 567 568
	die_find_child(sp_die, __die_walk_funclines_cb, &lw, &die_mem);
done:
	return lw.retval;
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
}

static int __die_walk_culines_cb(Dwarf_Die *sp_die, void *data)
{
	struct __line_walk_param *lw = data;

	lw->retval = __die_walk_funclines(sp_die, lw->handler, lw->data);
	if (lw->retval != 0)
		return DWARF_CB_ABORT;

	return DWARF_CB_OK;
}

/*
 * Walk on lines inside given PDIE. If the PDIE is subprogram, walk only on
 * the lines inside the subprogram, otherwise PDIE must be a CU DIE.
 */
static int die_walk_lines(Dwarf_Die *pdie, line_walk_handler_t handler,
			  void *data)
{
	Dwarf_Lines *lines;
	Dwarf_Line *line;
	Dwarf_Addr addr;
	const char *fname;
	int lineno, ret = 0;
	Dwarf_Die die_mem, *cu_die;
	size_t nlines, i;

	/* Get the CU die */
	if (dwarf_tag(pdie) == DW_TAG_subprogram)
		cu_die = dwarf_diecu(pdie, &die_mem, NULL, NULL);
	else
		cu_die = pdie;
	if (!cu_die) {
		pr_debug2("Failed to get CU from subprogram\n");
		return -EINVAL;
	}

	/* Get lines list in the CU */
	if (dwarf_getsrclines(cu_die, &lines, &nlines) != 0) {
		pr_debug2("Failed to get source lines on this CU.\n");
		return -ENOENT;
	}
	pr_debug2("Get %zd lines from this CU\n", nlines);

	/* Walk on the lines on lines list */
	for (i = 0; i < nlines; i++) {
		line = dwarf_onesrcline(lines, i);
		if (line == NULL ||
		    dwarf_lineno(line, &lineno) != 0 ||
		    dwarf_lineaddr(line, &addr) != 0) {
			pr_debug2("Failed to get line info. "
				  "Possible error in debuginfo.\n");
			continue;
		}
		/* Filter lines based on address */
		if (pdie != cu_die)
			/*
			 * Address filtering
			 * The line is included in given function, and
			 * no inline block includes it.
			 */
			if (!dwarf_haspc(pdie, addr) ||
			    die_find_inlinefunc(pdie, addr, &die_mem))
				continue;
		/* Get source line */
		fname = dwarf_linesrc(line, NULL, NULL);

		ret = handler(fname, lineno, addr, data);
		if (ret != 0)
			return ret;
	}

	/*
	 * Dwarf lines doesn't include function declarations and inlined
	 * subroutines. We have to check functions list or given function.
	 */
	if (pdie != cu_die)
		ret = __die_walk_funclines(pdie, handler, data);
	else {
		struct __line_walk_param param = {
			.handler = handler,
			.data = data,
			.retval = 0,
		};
		dwarf_getfuncs(cu_die, __die_walk_culines_cb, &param, 0);
		ret = param.retval;
	}

	return ret;
}

661 662 663 664 665
struct __find_variable_param {
	const char *name;
	Dwarf_Addr addr;
};

666
static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
667
{
668
	struct __find_variable_param *fvp = data;
669
	int tag;
670

671 672 673
	tag = dwarf_tag(die_mem);
	if ((tag == DW_TAG_formal_parameter ||
	     tag == DW_TAG_variable) &&
674
	    die_compare_name(die_mem, fvp->name))
675 676
		return DIE_FIND_CB_FOUND;

677 678 679 680
	if (dwarf_haspc(die_mem, fvp->addr))
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
681 682
}

683 684 685
/* Find a variable called 'name' at given address */
static Dwarf_Die *die_find_variable_at(Dwarf_Die *sp_die, const char *name,
				       Dwarf_Addr addr, Dwarf_Die *die_mem)
686
{
687 688 689
	struct __find_variable_param fvp = { .name = name, .addr = addr};

	return die_find_child(sp_die, __die_find_variable_cb, (void *)&fvp,
690
			      die_mem);
691 692
}

693 694 695 696 697
static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
{
	const char *name = data;

	if ((dwarf_tag(die_mem) == DW_TAG_member) &&
698
	    die_compare_name(die_mem, name))
699 700 701 702 703 704 705 706 707 708 709 710 711
		return DIE_FIND_CB_FOUND;

	return DIE_FIND_CB_SIBLING;
}

/* Find a member called 'name' */
static Dwarf_Die *die_find_member(Dwarf_Die *st_die, const char *name,
				  Dwarf_Die *die_mem)
{
	return die_find_child(st_die, __die_find_member_cb, (void *)name,
			      die_mem);
}

712 713 714 715 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 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
/* Get the name of given variable DIE */
static int die_get_typename(Dwarf_Die *vr_die, char *buf, int len)
{
	Dwarf_Die type;
	int tag, ret, ret2;
	const char *tmp = "";

	if (__die_get_real_type(vr_die, &type) == NULL)
		return -ENOENT;

	tag = dwarf_tag(&type);
	if (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)
		tmp = "*";
	else if (tag == DW_TAG_subroutine_type) {
		/* Function pointer */
		ret = snprintf(buf, len, "(function_type)");
		return (ret >= len) ? -E2BIG : ret;
	} else {
		if (!dwarf_diename(&type))
			return -ENOENT;
		if (tag == DW_TAG_union_type)
			tmp = "union ";
		else if (tag == DW_TAG_structure_type)
			tmp = "struct ";
		/* Write a base name */
		ret = snprintf(buf, len, "%s%s", tmp, dwarf_diename(&type));
		return (ret >= len) ? -E2BIG : ret;
	}
	ret = die_get_typename(&type, buf, len);
	if (ret > 0) {
		ret2 = snprintf(buf + ret, len - ret, "%s", tmp);
		ret = (ret2 >= len - ret) ? -E2BIG : ret2 + ret;
	}
	return ret;
}

/* Get the name and type of given variable DIE, stored as "type\tname" */
static int die_get_varname(Dwarf_Die *vr_die, char *buf, int len)
{
	int ret, ret2;

	ret = die_get_typename(vr_die, buf, len);
	if (ret < 0) {
		pr_debug("Failed to get type, make it unknown.\n");
		ret = snprintf(buf, len, "(unknown_type)");
	}
	if (ret > 0) {
		ret2 = snprintf(buf + ret, len - ret, "\t%s",
				dwarf_diename(vr_die));
		ret = (ret2 >= len - ret) ? -E2BIG : ret2 + ret;
	}
	return ret;
}

766 767 768 769
/*
 * Probe finder related functions
 */

770
static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
771
{
772 773
	struct probe_trace_arg_ref *ref;
	ref = zalloc(sizeof(struct probe_trace_arg_ref));
774 775 776 777 778
	if (ref != NULL)
		ref->offset = offs;
	return ref;
}

779 780 781 782 783 784 785
/*
 * Convert a location into trace_arg.
 * If tvar == NULL, this just checks variable can be converted.
 */
static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
				     Dwarf_Op *fb_ops,
				     struct probe_trace_arg *tvar)
786
{
787 788 789
	Dwarf_Attribute attr;
	Dwarf_Op *op;
	size_t nops;
790 791
	unsigned int regn;
	Dwarf_Word offs = 0;
792
	bool ref = false;
793
	const char *regs;
794 795
	int ret;

796 797 798
	if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
		goto static_var;

799 800
	/* TODO: handle more than 1 exprs */
	if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL ||
801
	    dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0 ||
802 803 804 805 806 807
	    nops == 0) {
		/* TODO: Support const_value */
		return -ENOENT;
	}

	if (op->atom == DW_OP_addr) {
808
static_var:
809 810
		if (!tvar)
			return 0;
811 812 813 814 815 816 817 818 819 820 821
		/* Static variables on memory (not stack), make @varname */
		ret = strlen(dwarf_diename(vr_die));
		tvar->value = zalloc(ret + 2);
		if (tvar->value == NULL)
			return -ENOMEM;
		snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
		tvar->ref = alloc_trace_arg_ref((long)offs);
		if (tvar->ref == NULL)
			return -ENOMEM;
		return 0;
	}
822 823

	/* If this is based on frame buffer, set the offset */
824
	if (op->atom == DW_OP_fbreg) {
825
		if (fb_ops == NULL)
826
			return -ENOTSUP;
827
		ref = true;
828
		offs = op->number;
829
		op = &fb_ops[0];
830
	}
831

832 833 834
	if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
		regn = op->atom - DW_OP_breg0;
		offs += op->number;
835
		ref = true;
836 837 838 839 840
	} 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;
841
		ref = true;
842 843
	} else if (op->atom == DW_OP_regx) {
		regn = op->number;
844
	} else {
845
		pr_debug("DW_OP %x is not supported.\n", op->atom);
846 847
		return -ENOTSUP;
	}
848

849 850 851
	if (!tvar)
		return 0;

852
	regs = get_arch_regstr(regn);
853
	if (!regs) {
854
		/* This should be a bug in DWARF or this tool */
M
Masami Hiramatsu 已提交
855 856
		pr_warning("Mapping for the register number %u "
			   "missing on this architecture.\n", regn);
857 858
		return -ERANGE;
	}
859

860 861 862 863
	tvar->value = strdup(regs);
	if (tvar->value == NULL)
		return -ENOMEM;

864
	if (ref) {
865
		tvar->ref = alloc_trace_arg_ref((long)offs);
866 867
		if (tvar->ref == NULL)
			return -ENOMEM;
868
	}
869
	return 0;
870 871
}

872 873
#define BYTES_TO_BITS(nb)	((nb) * BITS_PER_LONG / sizeof(long))

874
static int convert_variable_type(Dwarf_Die *vr_die,
875
				 struct probe_trace_arg *tvar,
876
				 const char *cast)
877
{
878
	struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
879 880 881 882
	Dwarf_Die type;
	char buf[16];
	int ret;

883 884 885 886 887 888 889
	/* TODO: check all types */
	if (cast && strcmp(cast, "string") != 0) {
		/* Non string type is OK */
		tvar->type = strdup(cast);
		return (tvar->type == NULL) ? -ENOMEM : 0;
	}

890 891 892 893 894 895 896 897
	if (die_get_bit_size(vr_die) != 0) {
		/* This is a bitfield */
		ret = snprintf(buf, 16, "b%d@%d/%zd", die_get_bit_size(vr_die),
				die_get_bit_offset(vr_die),
				BYTES_TO_BITS(die_get_byte_size(vr_die)));
		goto formatted;
	}

898 899 900 901 902
	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;
	}
903

904 905 906
	pr_debug("%s type is %s.\n",
		 dwarf_diename(vr_die), dwarf_diename(&type));

907 908 909 910 911
	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 已提交
912
				   "%s(%s) is not a pointer nor array.\n",
913 914 915 916 917
				   dwarf_diename(vr_die), dwarf_diename(&type));
			return -EINVAL;
		}
		if (ret == DW_TAG_pointer_type) {
			if (die_get_real_type(&type, &type) == NULL) {
M
Masami Hiramatsu 已提交
918 919
				pr_warning("Failed to get a type"
					   " information.\n");
920 921 922 923 924
				return -ENOENT;
			}
			while (*ref_ptr)
				ref_ptr = &(*ref_ptr)->next;
			/* Add new reference with offset +0 */
925
			*ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
926 927 928 929 930
			if (*ref_ptr == NULL) {
				pr_warning("Out of memory error\n");
				return -ENOMEM;
			}
		}
931 932
		if (!die_compare_name(&type, "char") &&
		    !die_compare_name(&type, "unsigned char")) {
933
			pr_warning("Failed to cast into string: "
M
Masami Hiramatsu 已提交
934
				   "%s is not (unsigned) char *.\n",
935 936 937 938 939 940 941
				   dwarf_diename(vr_die));
			return -EINVAL;
		}
		tvar->type = strdup(cast);
		return (tvar->type == NULL) ? -ENOMEM : 0;
	}

942 943 944 945
	ret = BYTES_TO_BITS(die_get_byte_size(&type));
	if (!ret)
		/* No size ... try to use default type */
		return 0;
946

947 948 949 950 951
	/* 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;
952
	}
953 954 955 956 957 958 959 960 961 962 963 964 965 966
	ret = snprintf(buf, 16, "%c%d",
		       die_is_signed_type(&type) ? 's' : 'u', ret);

formatted:
	if (ret < 0 || ret >= 16) {
		if (ret >= 16)
			ret = -E2BIG;
		pr_warning("Failed to convert variable type: %s\n",
			   strerror(-ret));
		return ret;
	}
	tvar->type = strdup(buf);
	if (tvar->type == NULL)
		return -ENOMEM;
967
	return 0;
968 969
}

970
static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
971
				    struct perf_probe_arg_field *field,
972
				    struct probe_trace_arg_ref **ref_ptr,
973
				    Dwarf_Die *die_mem)
974
{
975
	struct probe_trace_arg_ref *ref = *ref_ptr;
976 977
	Dwarf_Die type;
	Dwarf_Word offs;
978
	int ret, tag;
979 980

	pr_debug("converting %s in %s\n", field->name, varname);
981 982 983 984
	if (die_get_real_type(vr_die, &type) == NULL) {
		pr_warning("Failed to get the type of %s.\n", varname);
		return -ENOENT;
	}
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
	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) {
1001
			ref = zalloc(sizeof(struct probe_trace_arg_ref));
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
			if (ref == NULL)
				return -ENOMEM;
			if (*ref_ptr)
				(*ref_ptr)->next = ref;
			else
				*ref_ptr = ref;
		}
		ref->offset += die_get_byte_size(&type) * field->index;
		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 */
1016 1017 1018 1019 1020
		if (!field->ref) {
			pr_err("Semantic error: %s must be referred by '->'\n",
			       field->name);
			return -EINVAL;
		}
1021
		/* Get the type pointed by this pointer */
1022 1023 1024 1025
		if (die_get_real_type(&type, &type) == NULL) {
			pr_warning("Failed to get the type of %s.\n", varname);
			return -ENOENT;
		}
1026
		/* Verify it is a data structure  */
1027 1028 1029 1030
		if (dwarf_tag(&type) != DW_TAG_structure_type) {
			pr_warning("%s is not a data structure.\n", varname);
			return -EINVAL;
		}
1031

1032
		ref = zalloc(sizeof(struct probe_trace_arg_ref));
1033 1034
		if (ref == NULL)
			return -ENOMEM;
1035 1036 1037 1038 1039
		if (*ref_ptr)
			(*ref_ptr)->next = ref;
		else
			*ref_ptr = ref;
	} else {
1040
		/* Verify it is a data structure  */
1041
		if (tag != DW_TAG_structure_type) {
1042 1043 1044
			pr_warning("%s is not a data structure.\n", varname);
			return -EINVAL;
		}
1045
		if (field->name[0] == '[') {
M
Masami Hiramatsu 已提交
1046 1047
			pr_err("Semantic error: %s is not a pointor"
			       " nor array.\n", varname);
1048 1049
			return -EINVAL;
		}
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
		if (field->ref) {
			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;
		}
1060 1061
	}

1062 1063 1064 1065 1066
	if (die_find_member(&type, field->name, die_mem) == NULL) {
		pr_warning("%s(tyep:%s) has no member %s.\n", varname,
			   dwarf_diename(&type), field->name);
		return -EINVAL;
	}
1067 1068

	/* Get the offset of the field */
1069 1070
	ret = die_get_data_member_location(die_mem, &offs);
	if (ret < 0) {
1071
		pr_warning("Failed to get the offset of %s.\n", field->name);
1072
		return ret;
1073
	}
1074 1075
	ref->offset += (long)offs;

1076
next:
1077 1078
	/* Converting next field */
	if (field->next)
1079
		return convert_variable_fields(die_mem, field->name,
1080
					field->next, &ref, die_mem);
1081 1082
	else
		return 0;
1083 1084
}

1085
/* Show a variables in kprobe event format */
1086
static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
1087
{
1088
	Dwarf_Die die_mem;
1089 1090
	int ret;

1091 1092
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
1093

1094 1095 1096 1097 1098 1099 1100 1101
	ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
					pf->tvar);
	if (ret == -ENOENT)
		pr_err("Failed to find the location of %s at this address.\n"
		       " Perhaps, it has been optimized out.\n", pf->pvar->var);
	else if (ret == -ENOTSUP)
		pr_err("Sorry, we don't support this variable location yet.\n");
	else if (pf->pvar->field) {
1102 1103 1104
		ret = convert_variable_fields(vr_die, pf->pvar->var,
					      pf->pvar->field, &pf->tvar->ref,
					      &die_mem);
1105 1106
		vr_die = &die_mem;
	}
1107 1108
	if (ret == 0)
		ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
1109
	/* *expr will be cached in libdw. Don't free it. */
1110
	return ret;
1111 1112 1113
}

/* Find a variable in a subprogram die */
1114
static int find_variable(Dwarf_Die *sp_die, struct probe_finder *pf)
1115
{
1116
	Dwarf_Die vr_die, *scopes;
1117
	char buf[32], *ptr;
1118
	int ret, nscopes;
1119

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
	if (!is_c_varname(pf->pvar->var)) {
		/* Copy raw parameters */
		pf->tvar->value = strdup(pf->pvar->var);
		if (pf->tvar->value == NULL)
			return -ENOMEM;
		if (pf->pvar->type) {
			pf->tvar->type = strdup(pf->pvar->type);
			if (pf->tvar->type == NULL)
				return -ENOMEM;
		}
		if (pf->pvar->name) {
			pf->tvar->name = strdup(pf->pvar->name);
			if (pf->tvar->name == NULL)
				return -ENOMEM;
		} else
			pf->tvar->name = NULL;
		return 0;
	}

1139
	if (pf->pvar->name)
1140
		pf->tvar->name = strdup(pf->pvar->name);
1141
	else {
1142 1143 1144
		ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
		if (ret < 0)
			return ret;
1145 1146 1147
		ptr = strchr(buf, ':');	/* Change type separator to _ */
		if (ptr)
			*ptr = '_';
1148
		pf->tvar->name = strdup(buf);
1149
	}
1150 1151
	if (pf->tvar->name == NULL)
		return -ENOMEM;
1152

1153 1154 1155
	pr_debug("Searching '%s' variable in context.\n",
		 pf->pvar->var);
	/* Search child die for local variables and parameters. */
1156
	if (die_find_variable_at(sp_die, pf->pvar->var, pf->addr, &vr_die))
1157 1158 1159 1160
		ret = convert_variable(&vr_die, pf);
	else {
		/* Search upper class */
		nscopes = dwarf_getscopes_die(sp_die, &scopes);
1161 1162 1163 1164 1165 1166 1167
		while (nscopes-- > 1) {
			pr_debug("Searching variables in %s\n",
				 dwarf_diename(&scopes[nscopes]));
			/* We should check this scope, so give dummy address */
			if (die_find_variable_at(&scopes[nscopes],
						 pf->pvar->var, 0,
						 &vr_die)) {
1168
				ret = convert_variable(&vr_die, pf);
1169 1170 1171 1172
				goto found;
			}
		}
		if (scopes)
1173
			free(scopes);
1174
		ret = -ENOENT;
1175
	}
1176
found:
1177
	if (ret < 0)
1178 1179
		pr_warning("Failed to find '%s' in this function.\n",
			   pf->pvar->var);
1180
	return ret;
1181 1182
}

1183 1184 1185
/* Convert subprogram DIE to trace point */
static int convert_to_trace_point(Dwarf_Die *sp_die, Dwarf_Addr paddr,
				  bool retprobe, struct probe_trace_point *tp)
1186
{
1187
	Dwarf_Addr eaddr;
1188
	const char *name;
1189

1190
	/* Copy the name of probe point */
1191 1192
	name = dwarf_diename(sp_die);
	if (name) {
1193
		if (dwarf_entrypc(sp_die, &eaddr) != 0) {
M
Masami Hiramatsu 已提交
1194
			pr_warning("Failed to get entry address of %s\n",
1195 1196 1197
				   dwarf_diename(sp_die));
			return -ENOENT;
		}
1198 1199
		tp->symbol = strdup(name);
		if (tp->symbol == NULL)
1200
			return -ENOMEM;
1201
		tp->offset = (unsigned long)(paddr - eaddr);
1202
	} else
1203
		/* This function has no name. */
1204
		tp->offset = (unsigned long)paddr;
1205

1206
	/* Return probe must be on the head of a subprogram */
1207 1208
	if (retprobe) {
		if (eaddr != paddr) {
1209
			pr_warning("Return probe must be on the head of"
M
Masami Hiramatsu 已提交
1210
				   " a real function.\n");
1211 1212
			return -EINVAL;
		}
1213
		tp->retprobe = true;
1214 1215
	}

1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
	return 0;
}

/* Call probe_finder callback with real subprogram DIE */
static int call_probe_finder(Dwarf_Die *sp_die, struct probe_finder *pf)
{
	Dwarf_Die die_mem;
	Dwarf_Attribute fb_attr;
	size_t nops;
	int ret;

	/* If no real subprogram, find a real one */
	if (!sp_die || dwarf_tag(sp_die) != DW_TAG_subprogram) {
		sp_die = die_find_real_subprogram(&pf->cu_die,
						  pf->addr, &die_mem);
		if (!sp_die) {
			pr_warning("Failed to find probe point in any "
				   "functions.\n");
			return -ENOENT;
		}
	}
1237

1238 1239
	/* Get the frame base attribute/ops */
	dwarf_attr(sp_die, DW_AT_frame_base, &fb_attr);
1240
	ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
1241
	if (ret <= 0 || nops == 0) {
1242
		pf->fb_ops = NULL;
1243
#if _ELFUTILS_PREREQ(0, 142)
1244 1245 1246
	} else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
		   pf->cfi != NULL) {
		Dwarf_Frame *frame;
1247 1248
		if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
		    dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
M
Masami Hiramatsu 已提交
1249
			pr_warning("Failed to get call frame on 0x%jx\n",
1250 1251 1252
				   (uintmax_t)pf->addr);
			return -ENOENT;
		}
1253
#endif
1254
	}
1255

1256 1257
	/* Call finder's callback handler */
	ret = pf->callback(sp_die, pf);
1258 1259 1260

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

	return ret;
1263 1264
}

1265 1266
static int probe_point_line_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
1267
{
1268 1269
	struct probe_finder *pf = data;
	int ret;
1270

1271 1272
	if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
		return 0;
1273

1274 1275
	pf->addr = addr;
	ret = call_probe_finder(NULL, pf);
1276

1277
	/* Continue if no error, because the line will be in inline function */
1278
	return ret < 0 ? ret : 0;
1279
}
1280

1281 1282 1283 1284
/* 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);
1285 1286
}

1287 1288 1289 1290
/* Find lines which match lazy pattern */
static int find_lazy_match_lines(struct list_head *head,
				 const char *fname, const char *pat)
{
1291 1292 1293 1294 1295 1296 1297 1298 1299
	FILE *fp;
	char *line = NULL;
	size_t line_len;
	ssize_t len;
	int count = 0, linenum = 1;

	fp = fopen(fname, "r");
	if (!fp) {
		pr_warning("Failed to open %s: %s\n", fname, strerror(errno));
1300
		return -errno;
1301 1302
	}

1303
	while ((len = getline(&line, &line_len, fp)) > 0) {
1304

1305 1306 1307 1308 1309 1310
		if (line[len - 1] == '\n')
			line[len - 1] = '\0';

		if (strlazymatch(line, pat)) {
			line_list__add_line(head, linenum);
			count++;
1311
		}
1312
		linenum++;
1313
	}
1314 1315 1316 1317 1318 1319 1320 1321 1322

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

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

1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
static int probe_point_lazy_walker(const char *fname, int lineno,
				   Dwarf_Addr addr, void *data)
{
	struct probe_finder *pf = data;
	int ret;

	if (!line_list__has_line(&pf->lcache, lineno) ||
	    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;
	ret = call_probe_finder(NULL, pf);

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

1347
/* Find probe points from lazy pattern  */
1348
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
1349
{
1350
	int ret = 0;
1351 1352 1353 1354

	if (list_empty(&pf->lcache)) {
		/* Matching lazy line pattern */
		ret = find_lazy_match_lines(&pf->lcache, pf->fname,
1355
					    pf->pev->point.lazy_line);
1356
		if (ret <= 0)
1357
			return ret;
1358 1359
	}

1360
	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
1361 1362
}

1363 1364 1365 1366 1367 1368
/* Callback parameter with return value */
struct dwarf_callback_param {
	void *data;
	int retval;
};

1369 1370
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
1371 1372
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
1373
	struct perf_probe_point *pp = &pf->pev->point;
1374
	Dwarf_Addr addr;
1375

1376
	if (pp->lazy_line)
1377
		param->retval = find_probe_point_lazy(in_die, pf);
1378 1379
	else {
		/* Get probe address */
1380
		if (dwarf_entrypc(in_die, &addr) != 0) {
M
Masami Hiramatsu 已提交
1381
			pr_warning("Failed to get entry address of %s.\n",
1382 1383 1384 1385 1386
				   dwarf_diename(in_die));
			param->retval = -ENOENT;
			return DWARF_CB_ABORT;
		}
		pf->addr = addr;
1387 1388 1389 1390
		pf->addr += pp->offset;
		pr_debug("found inline addr: 0x%jx\n",
			 (uintmax_t)pf->addr);

1391
		param->retval = call_probe_finder(in_die, pf);
1392 1393
		if (param->retval < 0)
			return DWARF_CB_ABORT;
1394
	}
1395 1396 1397

	return DWARF_CB_OK;
}
1398

1399
/* Search function from function name */
1400
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
1401
{
1402 1403
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
1404
	struct perf_probe_point *pp = &pf->pev->point;
1405

1406 1407
	/* Check tag and diename */
	if (dwarf_tag(sp_die) != DW_TAG_subprogram ||
1408
	    !die_compare_name(sp_die, pp->function))
1409
		return DWARF_CB_OK;
1410

1411 1412 1413 1414
	/* Check declared file */
	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

1415
	pf->fname = dwarf_decl_file(sp_die);
1416 1417 1418
	if (pp->line) { /* Function relative line */
		dwarf_decl_line(sp_die, &pf->lno);
		pf->lno += pp->line;
1419
		param->retval = find_probe_point_by_line(pf);
1420 1421
	} else if (!dwarf_func_inline(sp_die)) {
		/* Real function */
1422
		if (pp->lazy_line)
1423
			param->retval = find_probe_point_lazy(sp_die, pf);
1424
		else {
1425
			if (dwarf_entrypc(sp_die, &pf->addr) != 0) {
M
Masami Hiramatsu 已提交
1426 1427
				pr_warning("Failed to get entry address of "
					   "%s.\n", dwarf_diename(sp_die));
1428 1429 1430
				param->retval = -ENOENT;
				return DWARF_CB_ABORT;
			}
1431 1432
			pf->addr += pp->offset;
			/* TODO: Check the address in this function */
1433
			param->retval = call_probe_finder(sp_die, pf);
1434
		}
1435 1436 1437
	} else {
		struct dwarf_callback_param _param = {.data = (void *)pf,
						      .retval = 0};
1438
		/* Inlined function: search instances */
1439 1440 1441 1442
		dwarf_func_inline_instances(sp_die, probe_point_inline_cb,
					    &_param);
		param->retval = _param.retval;
	}
1443

1444
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
1445 1446
}

1447
static int find_probe_point_by_func(struct probe_finder *pf)
1448
{
1449 1450 1451 1452
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
1453 1454
}

1455 1456
/* Find probe points from debuginfo */
static int find_probes(int fd, struct probe_finder *pf)
1457
{
1458
	struct perf_probe_point *pp = &pf->pev->point;
1459 1460 1461
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1462 1463 1464
	Dwarf *dbg = NULL;
	Dwfl *dwfl;
	Dwarf_Addr bias;	/* Currently ignored */
1465
	int ret = 0;
1466

1467
	dbg = dwfl_init_offline_dwarf(fd, &dwfl, &bias);
1468
	if (!dbg) {
M
Masami Hiramatsu 已提交
1469
		pr_warning("No debug information found in the vmlinux - "
1470
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
1471
		close(fd);	/* Without dwfl_end(), fd isn't closed. */
1472 1473
		return -EBADF;
	}
1474

1475
#if _ELFUTILS_PREREQ(0, 142)
1476
	/* Get the call frame information from this dwarf */
1477
	pf->cfi = dwarf_getcfi(dbg);
1478
#endif
1479

1480
	off = 0;
1481
	line_list__init(&pf->lcache);
1482
	/* Loop on CUs (Compilation Unit) */
1483
	while (!dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1484
		/* Get the DIE(Debugging Information Entry) of this CU */
1485
		diep = dwarf_offdie(dbg, off + cuhl, &pf->cu_die);
1486 1487
		if (!diep)
			continue;
1488 1489 1490

		/* Check if target file is included. */
		if (pp->file)
1491
			pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1492
		else
1493
			pf->fname = NULL;
1494

1495
		if (!pp->file || pf->fname) {
1496
			if (pp->function)
1497
				ret = find_probe_point_by_func(pf);
1498
			else if (pp->lazy_line)
1499
				ret = find_probe_point_lazy(NULL, pf);
1500
			else {
1501 1502
				pf->lno = pp->line;
				ret = find_probe_point_by_line(pf);
1503
			}
1504
			if (ret < 0)
1505
				break;
1506
		}
1507
		off = noff;
1508
	}
1509
	line_list__free(&pf->lcache);
1510 1511
	if (dwfl)
		dwfl_end(dwfl);
1512

1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
	return ret;
}

/* Add a found probe point into trace event list */
static int add_probe_trace_event(Dwarf_Die *sp_die, struct probe_finder *pf)
{
	struct trace_event_finder *tf =
			container_of(pf, struct trace_event_finder, pf);
	struct probe_trace_event *tev;
	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++];

	ret = convert_to_trace_point(sp_die, pf->addr, pf->pev->point.retprobe,
				     &tev->point);
	if (ret < 0)
		return ret;

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

	/* Find each argument */
	tev->nargs = pf->pev->nargs;
	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
	if (tev->args == NULL)
		return -ENOMEM;
	for (i = 0; i < pf->pev->nargs; i++) {
		pf->pvar = &pf->pev->args[i];
		pf->tvar = &tev->args[i];
		ret = find_variable(sp_die, pf);
		if (ret != 0)
			return ret;
	}

	return 0;
}

/* Find probe_trace_events specified by perf_probe_event from debuginfo */
int find_probe_trace_events(int fd, struct perf_probe_event *pev,
			    struct probe_trace_event **tevs, int max_tevs)
{
	struct trace_event_finder tf = {
			.pf = {.pev = pev, .callback = add_probe_trace_event},
			.max_tevs = max_tevs};
	int ret;

	/* Allocate result tevs array */
	*tevs = zalloc(sizeof(struct probe_trace_event) * max_tevs);
	if (*tevs == NULL)
		return -ENOMEM;

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

	ret = find_probes(fd, &tf.pf);
	if (ret < 0) {
		free(*tevs);
		*tevs = NULL;
		return ret;
	}

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

#define MAX_VAR_LEN 64

/* Collect available variables in this scope */
static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
{
	struct available_var_finder *af = data;
	struct variable_list *vl;
	char buf[MAX_VAR_LEN];
	int tag, ret;

	vl = &af->vls[af->nvls - 1];

	tag = dwarf_tag(die_mem);
	if (tag == DW_TAG_formal_parameter ||
	    tag == DW_TAG_variable) {
		ret = convert_variable_location(die_mem, af->pf.addr,
						af->pf.fb_ops, NULL);
		if (ret == 0) {
			ret = die_get_varname(die_mem, buf, MAX_VAR_LEN);
1602
			pr_debug2("Add new var: %s\n", buf);
1603 1604 1605 1606 1607
			if (ret > 0)
				strlist__add(vl->vars, buf);
		}
	}

1608
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
}

/* Add a found vars into available variables list */
static int add_available_vars(Dwarf_Die *sp_die, struct probe_finder *pf)
{
	struct available_var_finder *af =
			container_of(pf, struct available_var_finder, pf);
	struct variable_list *vl;
1620 1621
	Dwarf_Die die_mem, *scopes = NULL;
	int ret, nscopes;
1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641

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

	ret = convert_to_trace_point(sp_die, pf->addr, pf->pev->point.retprobe,
				     &vl->point);
	if (ret < 0)
		return ret;

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

	/* Find local variables */
	vl->vars = strlist__new(true, NULL);
	if (vl->vars == NULL)
		return -ENOMEM;
1642
	af->child = true;
1643 1644
	die_find_child(sp_die, collect_variables_cb, (void *)af, &die_mem);

1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
	/* Find external variables */
	if (!af->externs)
		goto out;
	/* Don't need to search child DIE for externs. */
	af->child = false;
	nscopes = dwarf_getscopes_die(sp_die, &scopes);
	while (nscopes-- > 1)
		die_find_child(&scopes[nscopes], collect_variables_cb,
			       (void *)af, &die_mem);
	if (scopes)
		free(scopes);

out:
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
	if (strlist__empty(vl->vars)) {
		strlist__delete(vl->vars);
		vl->vars = NULL;
	}

	return ret;
}

/* Find available variables at given probe point */
int find_available_vars_at(int fd, struct perf_probe_event *pev,
1668 1669
			   struct variable_list **vls, int max_vls,
			   bool externs)
1670 1671 1672
{
	struct available_var_finder af = {
			.pf = {.pev = pev, .callback = add_available_vars},
1673
			.max_vls = max_vls, .externs = externs};
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
	int ret;

	/* Allocate result vls array */
	*vls = zalloc(sizeof(struct variable_list) * max_vls);
	if (*vls == NULL)
		return -ENOMEM;

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

	ret = find_probes(fd, &af.pf);
	if (ret < 0) {
		/* Free vlist for error */
		while (af.nvls--) {
			if (af.vls[af.nvls].point.symbol)
				free(af.vls[af.nvls].point.symbol);
			if (af.vls[af.nvls].vars)
				strlist__delete(af.vls[af.nvls].vars);
		}
		free(af.vls);
		*vls = NULL;
		return ret;
	}

	return (ret < 0) ? ret : af.nvls;
1699 1700
}

1701
/* Reverse search */
1702
int find_perf_probe_point(unsigned long addr, struct perf_probe_point *ppt)
1703 1704
{
	Dwarf_Die cudie, spdie, indie;
1705 1706
	Dwarf *dbg = NULL;
	Dwfl *dwfl = NULL;
1707
	Dwarf_Line *line;
1708
	Dwarf_Addr laddr, eaddr, bias = 0;
1709 1710
	const char *tmp;
	int lineno, ret = 0;
1711
	bool found = false;
1712

1713 1714 1715
	/* Open the live linux kernel */
	dbg = dwfl_init_live_kernel_dwarf(addr, &dwfl, &bias);
	if (!dbg) {
M
Masami Hiramatsu 已提交
1716
		pr_warning("No debug information found in the vmlinux - "
1717 1718 1719 1720
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
		ret = -EINVAL;
		goto end;
	}
1721

1722 1723
	/* Adjust address with bias */
	addr += bias;
1724
	/* Find cu die */
1725
	if (!dwarf_addrdie(dbg, (Dwarf_Addr)addr - bias, &cudie)) {
M
Masami Hiramatsu 已提交
1726 1727
		pr_warning("Failed to find debug information for address %lx\n",
			   addr);
1728 1729 1730
		ret = -EINVAL;
		goto end;
	}
1731 1732 1733 1734

	/* Find a corresponding line */
	line = dwarf_getsrc_die(&cudie, (Dwarf_Addr)addr);
	if (line) {
1735 1736 1737
		if (dwarf_lineaddr(line, &laddr) == 0 &&
		    (Dwarf_Addr)addr == laddr &&
		    dwarf_lineno(line, &lineno) == 0) {
1738
			tmp = dwarf_linesrc(line, NULL, NULL);
1739 1740
			if (tmp) {
				ppt->line = lineno;
1741 1742 1743 1744 1745
				ppt->file = strdup(tmp);
				if (ppt->file == NULL) {
					ret = -ENOMEM;
					goto end;
				}
1746 1747
				found = true;
			}
1748 1749 1750 1751 1752 1753
		}
	}

	/* Find a corresponding function */
	if (die_find_real_subprogram(&cudie, (Dwarf_Addr)addr, &spdie)) {
		tmp = dwarf_diename(&spdie);
1754
		if (!tmp || dwarf_entrypc(&spdie, &eaddr) != 0)
1755 1756
			goto end;

1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
		if (ppt->line) {
			if (die_find_inlinefunc(&spdie, (Dwarf_Addr)addr,
						&indie)) {
				/* addr in an inline function */
				tmp = dwarf_diename(&indie);
				if (!tmp)
					goto end;
				ret = dwarf_decl_line(&indie, &lineno);
			} else {
				if (eaddr == addr) {	/* Function entry */
					lineno = ppt->line;
					ret = 0;
				} else
					ret = dwarf_decl_line(&spdie, &lineno);
			}
			if (ret == 0) {
				/* Make a relative line number */
				ppt->line -= lineno;
				goto found;
			}
1777
		}
1778 1779 1780
		/* We don't have a line number, let's use offset */
		ppt->offset = addr - (unsigned long)eaddr;
found:
1781 1782 1783 1784 1785
		ppt->function = strdup(tmp);
		if (ppt->function == NULL) {
			ret = -ENOMEM;
			goto end;
		}
1786
		found = true;
1787 1788 1789
	}

end:
1790 1791
	if (dwfl)
		dwfl_end(dwfl);
1792 1793
	if (ret >= 0)
		ret = found ? 1 : 0;
1794 1795 1796
	return ret;
}

1797 1798 1799 1800
/* Add a line and store the src path */
static int line_range_add_line(const char *src, unsigned int lineno,
			       struct line_range *lr)
{
1801
	/* Copy source path */
1802
	if (!lr->path) {
1803 1804 1805
		lr->path = strdup(src);
		if (lr->path == NULL)
			return -ENOMEM;
1806 1807 1808 1809
	}
	return line_list__add_line(&lr->line_list, lineno);
}

1810 1811 1812
static int line_range_walk_cb(const char *fname, int lineno,
			      Dwarf_Addr addr __used,
			      void *data)
1813
{
1814
	struct line_finder *lf = data;
1815

1816
	if ((strtailcmp(fname, lf->fname) != 0) ||
1817
	    (lf->lno_s > lineno || lf->lno_e < lineno))
1818
		return 0;
1819

1820 1821
	if (line_range_add_line(fname, lineno, lf->lr) < 0)
		return -EINVAL;
1822

1823
	return 0;
1824
}
1825

1826
/* Find line range from its line number */
1827
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1828
{
1829
	int ret;
1830

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

1833
	/* Update status */
1834 1835 1836 1837 1838
	if (ret >= 0)
		if (!list_empty(&lf->lr->line_list))
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1839 1840 1841 1842
	else {
		free(lf->lr->path);
		lf->lr->path = NULL;
	}
1843
	return ret;
1844 1845
}

1846 1847
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1848 1849 1850
	struct dwarf_callback_param *param = data;

	param->retval = find_line_range_by_line(in_die, param->data);
1851 1852 1853
	return DWARF_CB_ABORT;	/* No need to find other instances */
}

1854
/* Search function from function name */
1855
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1856
{
1857 1858
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1859 1860
	struct line_range *lr = lf->lr;

1861 1862 1863 1864
	/* Check declared file */
	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
		return DWARF_CB_OK;

1865
	if (dwarf_tag(sp_die) == DW_TAG_subprogram &&
1866
	    die_compare_name(sp_die, lr->function)) {
1867 1868
		lf->fname = dwarf_decl_file(sp_die);
		dwarf_decl_line(sp_die, &lr->offset);
1869
		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1870
		lf->lno_s = lr->offset + lr->start;
1871 1872 1873 1874
		if (lf->lno_s < 0)	/* Overflow */
			lf->lno_s = INT_MAX;
		lf->lno_e = lr->offset + lr->end;
		if (lf->lno_e < 0)	/* Overflow */
1875
			lf->lno_e = INT_MAX;
1876
		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1877 1878
		lr->start = lf->lno_s;
		lr->end = lf->lno_e;
1879 1880 1881 1882
		if (dwarf_func_inline(sp_die)) {
			struct dwarf_callback_param _param;
			_param.data = (void *)lf;
			_param.retval = 0;
1883
			dwarf_func_inline_instances(sp_die,
1884 1885 1886 1887 1888 1889
						    line_range_inline_cb,
						    &_param);
			param->retval = _param.retval;
		} else
			param->retval = find_line_range_by_line(sp_die, lf);
		return DWARF_CB_ABORT;
1890
	}
1891
	return DWARF_CB_OK;
1892 1893
}

1894
static int find_line_range_by_func(struct line_finder *lf)
1895
{
1896 1897 1898
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1899 1900 1901 1902
}

int find_line_range(int fd, struct line_range *lr)
{
1903
	struct line_finder lf = {.lr = lr, .found = 0};
1904
	int ret = 0;
1905 1906 1907
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1908 1909 1910
	Dwarf *dbg = NULL;
	Dwfl *dwfl;
	Dwarf_Addr bias;	/* Currently ignored */
1911
	const char *comp_dir;
1912

1913
	dbg = dwfl_init_offline_dwarf(fd, &dwfl, &bias);
1914
	if (!dbg) {
M
Masami Hiramatsu 已提交
1915
		pr_warning("No debug information found in the vmlinux - "
1916
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
1917
		close(fd);	/* Without dwfl_end(), fd isn't closed. */
1918 1919
		return -EBADF;
	}
1920

1921
	/* Loop on CUs (Compilation Unit) */
1922 1923
	while (!lf.found && ret >= 0) {
		if (dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL) != 0)
1924 1925 1926
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1927 1928 1929
		diep = dwarf_offdie(dbg, off + cuhl, &lf.cu_die);
		if (!diep)
			continue;
1930 1931 1932

		/* Check if target file is included. */
		if (lr->file)
1933
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1934
		else
1935
			lf.fname = 0;
1936

1937
		if (!lr->file || lf.fname) {
1938
			if (lr->function)
1939
				ret = find_line_range_by_func(&lf);
1940 1941
			else {
				lf.lno_s = lr->start;
1942
				lf.lno_e = lr->end;
1943
				ret = find_line_range_by_line(NULL, &lf);
1944 1945
			}
		}
1946
		off = noff;
1947
	}
1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958

	/* 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;
		}
	}

1959
	pr_debug("path: %s\n", lr->path);
1960
	dwfl_end(dwfl);
1961
	return (ret < 0) ? ret : lf.found;
1962 1963
}