probe-finder.c 44.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 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 37
#include "event.h"
#include "debug.h"
38
#include "util.h"
39
#include "symbol.h"
40 41
#include "probe-finder.h"

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

45 46 47 48 49 50 51 52
/*
 * 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);
53
	while (--i1 >= 0 && --i2 >= 0) {
54 55 56 57 58 59
		if (s1[i1] != s2[i2])
			return s1[i1] - s2[i2];
	}
	return 0;
}

60 61 62
/* Line number list operations */

/* Add a line to line number list */
63
static int line_list__add_line(struct list_head *head, int line)
64 65 66 67 68 69 70 71 72 73
{
	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 */
74
			return 1;
75 76 77 78 79
	}
	/* List is empty, or the smallest entry */
	p = head;
found:
	pr_debug("line list: add a line %u\n", line);
80 81 82
	ln = zalloc(sizeof(struct line_node));
	if (ln == NULL)
		return -ENOMEM;
83 84 85
	ln->line = line;
	INIT_LIST_HEAD(&ln->list);
	list_add(&ln->list, p);
86
	return 0;
87 88 89
}

/* Check if the line in line number list */
90
static int line_list__has_line(struct list_head *head, int line)
91 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
{
	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);
	}
}

119 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 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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/* Dwarf FL wrappers */

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);

	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 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,
};

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,
};

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

/* 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) {
		dwfl_end(*dwflp);
		*dwflp = NULL;
	}
	return dbg;
}

214 215 216 217
/* Dwarf wrappers */

/* Find the realpath of the target file. */
static const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
218
{
219 220
	Dwarf_Files *files;
	size_t nfiles, i;
221
	const char *src = NULL;
222 223 224
	int ret;

	if (!fname)
225
		return NULL;
226

227
	ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
228 229 230 231 232 233 234
	if (ret != 0)
		return NULL;

	for (i = 0; i < nfiles; i++) {
		src = dwarf_filesrc(files, i, NULL, NULL);
		if (strtailcmp(src, fname) == 0)
			break;
235
	}
236 237
	if (i == nfiles)
		return NULL;
238
	return src;
239 240
}

241 242 243 244 245 246 247 248 249
/* 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);
}

250 251 252 253 254
/* Compare diename and tname */
static bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
{
	const char *name;
	name = dwarf_diename(dw_die);
255
	return name ? (strcmp(tname, name) == 0) : false;
256 257
}

M
Masami Hiramatsu 已提交
258 259 260 261 262 263 264 265 266 267 268 269
/* 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;
}

270 271
/* Get a type die, but skip qualifiers */
static Dwarf_Die *__die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
272 273 274 275
{
	int tag;

	do {
M
Masami Hiramatsu 已提交
276 277 278 279
		vr_die = die_get_type(vr_die, die_mem);
		if (!vr_die)
			break;
		tag = dwarf_tag(vr_die);
280 281 282
	} while (tag == DW_TAG_const_type ||
		 tag == DW_TAG_restrict_type ||
		 tag == DW_TAG_volatile_type ||
283 284 285 286 287 288 289 290 291 292 293
		 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);
294

M
Masami Hiramatsu 已提交
295
	return vr_die;
296 297
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
static bool die_is_signed_type(Dwarf_Die *tp_die)
{
	Dwarf_Attribute attr;
	Dwarf_Word ret;

	if (dwarf_attr(tp_die, DW_AT_encoding, &attr) == NULL ||
	    dwarf_formudata(&attr, &ret) != 0)
		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_Attribute attr;
	Dwarf_Word ret;

	if (dwarf_attr(tp_die, DW_AT_byte_size, &attr) == NULL ||
	    dwarf_formudata(&attr, &ret) != 0)
		return 0;

	return (int)ret;
}

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
/* 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;
}

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
/* 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;
}

386 387 388 389 390 391
struct __addr_die_search_param {
	Dwarf_Addr	addr;
	Dwarf_Die	*die_mem;
};

static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
392
{
393
	struct __addr_die_search_param *ad = data;
394

395 396 397 398 399 400 401
	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;
}
402

403
/* Search a real subprogram including this line, */
404 405
static Dwarf_Die *die_find_real_subprogram(Dwarf_Die *cu_die, Dwarf_Addr addr,
					   Dwarf_Die *die_mem)
406 407 408 409 410 411 412 413 414
{
	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;
415 416
}

417 418
/* die_find callback for inline function search */
static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
419
{
420
	Dwarf_Addr *addr = data;
421

422 423 424
	if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
	    dwarf_haspc(die_mem, *addr))
		return DIE_FIND_CB_FOUND;
425

426
	return DIE_FIND_CB_CONTINUE;
427 428
}

429 430 431
/* 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)
432
{
433
	return die_find_child(sp_die, __die_find_inline_cb, &addr, die_mem);
434 435
}

436 437 438 439 440
struct __find_variable_param {
	const char *name;
	Dwarf_Addr addr;
};

441
static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
442
{
443
	struct __find_variable_param *fvp = data;
444
	int tag;
445

446 447 448
	tag = dwarf_tag(die_mem);
	if ((tag == DW_TAG_formal_parameter ||
	     tag == DW_TAG_variable) &&
449
	    die_compare_name(die_mem, fvp->name))
450 451
		return DIE_FIND_CB_FOUND;

452 453 454 455
	if (dwarf_haspc(die_mem, fvp->addr))
		return DIE_FIND_CB_CONTINUE;
	else
		return DIE_FIND_CB_SIBLING;
456 457
}

458 459 460
/* 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)
461
{
462 463 464
	struct __find_variable_param fvp = { .name = name, .addr = addr};

	return die_find_child(sp_die, __die_find_variable_cb, (void *)&fvp,
465
			      die_mem);
466 467
}

468 469 470 471 472
static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
{
	const char *name = data;

	if ((dwarf_tag(die_mem) == DW_TAG_member) &&
473
	    die_compare_name(die_mem, name))
474 475 476 477 478 479 480 481 482 483 484 485 486
		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);
}

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
/* 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;
}

541 542 543 544
/*
 * Probe finder related functions
 */

545
static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
546
{
547 548
	struct probe_trace_arg_ref *ref;
	ref = zalloc(sizeof(struct probe_trace_arg_ref));
549 550 551 552 553
	if (ref != NULL)
		ref->offset = offs;
	return ref;
}

554 555 556 557 558 559 560
/*
 * 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)
561
{
562 563 564
	Dwarf_Attribute attr;
	Dwarf_Op *op;
	size_t nops;
565 566
	unsigned int regn;
	Dwarf_Word offs = 0;
567
	bool ref = false;
568
	const char *regs;
569 570
	int ret;

571 572 573
	if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
		goto static_var;

574 575
	/* TODO: handle more than 1 exprs */
	if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL ||
576
	    dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0 ||
577 578 579 580 581 582
	    nops == 0) {
		/* TODO: Support const_value */
		return -ENOENT;
	}

	if (op->atom == DW_OP_addr) {
583
static_var:
584 585
		if (!tvar)
			return 0;
586 587 588 589 590 591 592 593 594 595 596
		/* 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;
	}
597 598

	/* If this is based on frame buffer, set the offset */
599
	if (op->atom == DW_OP_fbreg) {
600
		if (fb_ops == NULL)
601
			return -ENOTSUP;
602
		ref = true;
603
		offs = op->number;
604
		op = &fb_ops[0];
605
	}
606

607 608 609
	if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
		regn = op->atom - DW_OP_breg0;
		offs += op->number;
610
		ref = true;
611 612 613 614 615
	} 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;
616
		ref = true;
617 618
	} else if (op->atom == DW_OP_regx) {
		regn = op->number;
619
	} else {
620
		pr_debug("DW_OP %x is not supported.\n", op->atom);
621 622
		return -ENOTSUP;
	}
623

624 625 626
	if (!tvar)
		return 0;

627
	regs = get_arch_regstr(regn);
628
	if (!regs) {
629 630 631
		/* This should be a bug in DWARF or this tool */
		pr_warning("Mapping for DWARF register number %u "
			   "missing on this architecture.", regn);
632 633
		return -ERANGE;
	}
634

635 636 637 638
	tvar->value = strdup(regs);
	if (tvar->value == NULL)
		return -ENOMEM;

639
	if (ref) {
640
		tvar->ref = alloc_trace_arg_ref((long)offs);
641 642
		if (tvar->ref == NULL)
			return -ENOMEM;
643
	}
644
	return 0;
645 646
}

647
static int convert_variable_type(Dwarf_Die *vr_die,
648
				 struct probe_trace_arg *tvar,
649
				 const char *cast)
650
{
651
	struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
652 653 654 655
	Dwarf_Die type;
	char buf[16];
	int ret;

656 657 658 659 660 661 662
	/* 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;
	}

663 664 665 666 667
	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;
	}
668

669 670 671
	pr_debug("%s type is %s.\n",
		 dwarf_diename(vr_die), dwarf_diename(&type));

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
	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: "
				   "%s(%s) is not a pointer nor array.",
				   dwarf_diename(vr_die), dwarf_diename(&type));
			return -EINVAL;
		}
		if (ret == DW_TAG_pointer_type) {
			if (die_get_real_type(&type, &type) == NULL) {
				pr_warning("Failed to get a type information.");
				return -ENOENT;
			}
			while (*ref_ptr)
				ref_ptr = &(*ref_ptr)->next;
			/* Add new reference with offset +0 */
689
			*ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
690 691 692 693 694
			if (*ref_ptr == NULL) {
				pr_warning("Out of memory error\n");
				return -ENOMEM;
			}
		}
695 696
		if (!die_compare_name(&type, "char") &&
		    !die_compare_name(&type, "unsigned char")) {
697 698 699 700 701 702 703 704 705
			pr_warning("Failed to cast into string: "
				   "%s is not (unsigned) char *.",
				   dwarf_diename(vr_die));
			return -EINVAL;
		}
		tvar->type = strdup(cast);
		return (tvar->type == NULL) ? -ENOMEM : 0;
	}

706 707 708 709
	ret = die_get_byte_size(&type) * 8;
	if (ret) {
		/* Check the bitwidth */
		if (ret > MAX_BASIC_TYPE_BITS) {
710 711 712
			pr_info("%s exceeds max-bitwidth."
				" Cut down to %d bits.\n",
				dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
713 714 715 716 717
			ret = MAX_BASIC_TYPE_BITS;
		}

		ret = snprintf(buf, 16, "%c%d",
			       die_is_signed_type(&type) ? 's' : 'u', ret);
718 719 720 721 722 723 724
		if (ret < 0 || ret >= 16) {
			if (ret >= 16)
				ret = -E2BIG;
			pr_warning("Failed to convert variable type: %s\n",
				   strerror(-ret));
			return ret;
		}
725 726
		tvar->type = strdup(buf);
		if (tvar->type == NULL)
727
			return -ENOMEM;
728
	}
729
	return 0;
730 731
}

732
static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
733
				    struct perf_probe_arg_field *field,
734
				    struct probe_trace_arg_ref **ref_ptr,
735
				    Dwarf_Die *die_mem)
736
{
737
	struct probe_trace_arg_ref *ref = *ref_ptr;
738 739
	Dwarf_Die type;
	Dwarf_Word offs;
740
	int ret, tag;
741 742

	pr_debug("converting %s in %s\n", field->name, varname);
743 744 745 746
	if (die_get_real_type(vr_die, &type) == NULL) {
		pr_warning("Failed to get the type of %s.\n", varname);
		return -ENOENT;
	}
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
	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) {
763
			ref = zalloc(sizeof(struct probe_trace_arg_ref));
764 765 766 767 768 769 770 771 772 773 774 775 776 777
			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 */
778 779 780 781 782
		if (!field->ref) {
			pr_err("Semantic error: %s must be referred by '->'\n",
			       field->name);
			return -EINVAL;
		}
783
		/* Get the type pointed by this pointer */
784 785 786 787
		if (die_get_real_type(&type, &type) == NULL) {
			pr_warning("Failed to get the type of %s.\n", varname);
			return -ENOENT;
		}
788
		/* Verify it is a data structure  */
789 790 791 792
		if (dwarf_tag(&type) != DW_TAG_structure_type) {
			pr_warning("%s is not a data structure.\n", varname);
			return -EINVAL;
		}
793

794
		ref = zalloc(sizeof(struct probe_trace_arg_ref));
795 796
		if (ref == NULL)
			return -ENOMEM;
797 798 799 800 801
		if (*ref_ptr)
			(*ref_ptr)->next = ref;
		else
			*ref_ptr = ref;
	} else {
802
		/* Verify it is a data structure  */
803
		if (tag != DW_TAG_structure_type) {
804 805 806
			pr_warning("%s is not a data structure.\n", varname);
			return -EINVAL;
		}
807 808 809 810 811
		if (field->name[0] == '[') {
			pr_err("Semantic error: %s is not a pointor nor array.",
			       varname);
			return -EINVAL;
		}
812 813 814 815 816 817 818 819 820 821
		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;
		}
822 823
	}

824 825 826 827 828
	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;
	}
829 830

	/* Get the offset of the field */
831 832
	ret = die_get_data_member_location(die_mem, &offs);
	if (ret < 0) {
833
		pr_warning("Failed to get the offset of %s.\n", field->name);
834
		return ret;
835
	}
836 837
	ref->offset += (long)offs;

838
next:
839 840
	/* Converting next field */
	if (field->next)
841
		return convert_variable_fields(die_mem, field->name,
842
					field->next, &ref, die_mem);
843 844
	else
		return 0;
845 846
}

847
/* Show a variables in kprobe event format */
848
static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
849
{
850
	Dwarf_Die die_mem;
851 852
	int ret;

853 854
	pr_debug("Converting variable %s into trace event.\n",
		 dwarf_diename(vr_die));
855

856 857 858 859 860 861 862 863
	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) {
864 865 866
		ret = convert_variable_fields(vr_die, pf->pvar->var,
					      pf->pvar->field, &pf->tvar->ref,
					      &die_mem);
867 868
		vr_die = &die_mem;
	}
869 870
	if (ret == 0)
		ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
871
	/* *expr will be cached in libdw. Don't free it. */
872
	return ret;
873 874 875
}

/* Find a variable in a subprogram die */
876
static int find_variable(Dwarf_Die *sp_die, struct probe_finder *pf)
877
{
878
	Dwarf_Die vr_die, *scopes;
879
	char buf[32], *ptr;
880
	int ret, nscopes;
881

882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
	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;
	}

901
	if (pf->pvar->name)
902
		pf->tvar->name = strdup(pf->pvar->name);
903
	else {
904 905 906
		ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
		if (ret < 0)
			return ret;
907 908 909
		ptr = strchr(buf, ':');	/* Change type separator to _ */
		if (ptr)
			*ptr = '_';
910
		pf->tvar->name = strdup(buf);
911
	}
912 913
	if (pf->tvar->name == NULL)
		return -ENOMEM;
914

915 916 917
	pr_debug("Searching '%s' variable in context.\n",
		 pf->pvar->var);
	/* Search child die for local variables and parameters. */
918
	if (die_find_variable_at(sp_die, pf->pvar->var, pf->addr, &vr_die))
919 920 921 922
		ret = convert_variable(&vr_die, pf);
	else {
		/* Search upper class */
		nscopes = dwarf_getscopes_die(sp_die, &scopes);
923 924 925 926 927 928 929
		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)) {
930
				ret = convert_variable(&vr_die, pf);
931 932 933 934
				goto found;
			}
		}
		if (scopes)
935
			free(scopes);
936
		ret = -ENOENT;
937
	}
938
found:
939
	if (ret < 0)
940 941
		pr_warning("Failed to find '%s' in this function.\n",
			   pf->pvar->var);
942
	return ret;
943 944
}

945 946 947
/* 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)
948
{
949
	Dwarf_Addr eaddr;
950
	const char *name;
951

952
	/* Copy the name of probe point */
953 954
	name = dwarf_diename(sp_die);
	if (name) {
955 956 957 958 959
		if (dwarf_entrypc(sp_die, &eaddr) != 0) {
			pr_warning("Failed to get entry pc of %s\n",
				   dwarf_diename(sp_die));
			return -ENOENT;
		}
960 961
		tp->symbol = strdup(name);
		if (tp->symbol == NULL)
962
			return -ENOMEM;
963
		tp->offset = (unsigned long)(paddr - eaddr);
964
	} else
965
		/* This function has no name. */
966
		tp->offset = (unsigned long)paddr;
967

968
	/* Return probe must be on the head of a subprogram */
969 970
	if (retprobe) {
		if (eaddr != paddr) {
971 972 973 974
			pr_warning("Return probe must be on the head of"
				   " a real function\n");
			return -EINVAL;
		}
975
		tp->retprobe = true;
976 977
	}

978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
	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;
		}
	}
999

1000 1001
	/* Get the frame base attribute/ops */
	dwarf_attr(sp_die, DW_AT_frame_base, &fb_attr);
1002
	ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
1003
	if (ret <= 0 || nops == 0) {
1004
		pf->fb_ops = NULL;
1005
#if _ELFUTILS_PREREQ(0, 142)
1006 1007 1008
	} else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
		   pf->cfi != NULL) {
		Dwarf_Frame *frame;
1009 1010 1011 1012 1013 1014
		if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
		    dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
			pr_warning("Failed to get CFA on 0x%jx\n",
				   (uintmax_t)pf->addr);
			return -ENOENT;
		}
1015
#endif
1016
	}
1017

1018 1019
	/* Call finder's callback handler */
	ret = pf->callback(sp_die, pf);
1020 1021 1022

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

	return ret;
1025 1026 1027
}

/* Find probe point from its line number */
1028
static int find_probe_point_by_line(struct probe_finder *pf)
1029
{
1030 1031 1032
	Dwarf_Lines *lines;
	Dwarf_Line *line;
	size_t nlines, i;
1033
	Dwarf_Addr addr;
1034
	int lineno;
1035
	int ret = 0;
1036

1037 1038 1039 1040
	if (dwarf_getsrclines(&pf->cu_die, &lines, &nlines) != 0) {
		pr_warning("No source lines found in this CU.\n");
		return -ENOENT;
	}
1041

1042
	for (i = 0; i < nlines && ret == 0; i++) {
1043
		line = dwarf_onesrcline(lines, i);
1044 1045
		if (dwarf_lineno(line, &lineno) != 0 ||
		    lineno != pf->lno)
1046 1047
			continue;

1048 1049 1050
		/* TODO: Get fileno from line, but how? */
		if (strtailcmp(dwarf_linesrc(line, NULL, NULL), pf->fname) != 0)
			continue;
1051

1052 1053 1054 1055
		if (dwarf_lineaddr(line, &addr) != 0) {
			pr_warning("Failed to get the address of the line.\n");
			return -ENOENT;
		}
1056 1057
		pr_debug("Probe line found: line[%d]:%d addr:0x%jx\n",
			 (int)i, lineno, (uintmax_t)addr);
1058
		pf->addr = addr;
1059

1060
		ret = call_probe_finder(NULL, pf);
1061 1062
		/* Continuing, because target line might be inlined. */
	}
1063
	return ret;
1064 1065
}

1066 1067 1068 1069 1070
/* Find lines which match lazy pattern */
static int find_lazy_match_lines(struct list_head *head,
				 const char *fname, const char *pat)
{
	char *fbuf, *p1, *p2;
1071
	int fd, line, nlines = -1;
1072 1073 1074
	struct stat st;

	fd = open(fname, O_RDONLY);
1075 1076
	if (fd < 0) {
		pr_warning("Failed to open %s: %s\n", fname, strerror(-fd));
1077
		return -errno;
1078 1079
	}

1080
	if (fstat(fd, &st) < 0) {
1081 1082
		pr_warning("Failed to get the size of %s: %s\n",
			   fname, strerror(errno));
1083 1084
		nlines = -errno;
		goto out_close;
1085
	}
1086 1087 1088 1089 1090 1091

	nlines = -ENOMEM;
	fbuf = malloc(st.st_size + 2);
	if (fbuf == NULL)
		goto out_close;
	if (read(fd, fbuf, st.st_size) < 0) {
1092
		pr_warning("Failed to read %s: %s\n", fname, strerror(errno));
1093 1094
		nlines = -errno;
		goto out_free_fbuf;
1095
	}
1096 1097 1098 1099
	fbuf[st.st_size] = '\n';	/* Dummy line */
	fbuf[st.st_size + 1] = '\0';
	p1 = fbuf;
	line = 1;
1100
	nlines = 0;
1101 1102 1103 1104 1105 1106 1107 1108 1109
	while ((p2 = strchr(p1, '\n')) != NULL) {
		*p2 = '\0';
		if (strlazymatch(p1, pat)) {
			line_list__add_line(head, line);
			nlines++;
		}
		line++;
		p1 = p2 + 1;
	}
1110
out_free_fbuf:
1111
	free(fbuf);
1112 1113
out_close:
	close(fd);
1114 1115 1116 1117
	return nlines;
}

/* Find probe points from lazy pattern  */
1118
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
1119 1120 1121 1122 1123 1124 1125
{
	Dwarf_Lines *lines;
	Dwarf_Line *line;
	size_t nlines, i;
	Dwarf_Addr addr;
	Dwarf_Die die_mem;
	int lineno;
1126
	int ret = 0;
1127 1128 1129 1130

	if (list_empty(&pf->lcache)) {
		/* Matching lazy line pattern */
		ret = find_lazy_match_lines(&pf->lcache, pf->fname,
1131
					    pf->pev->point.lazy_line);
1132 1133 1134 1135 1136
		if (ret == 0) {
			pr_debug("No matched lines found in %s.\n", pf->fname);
			return 0;
		} else if (ret < 0)
			return ret;
1137 1138
	}

1139 1140 1141 1142 1143 1144
	if (dwarf_getsrclines(&pf->cu_die, &lines, &nlines) != 0) {
		pr_warning("No source lines found in this CU.\n");
		return -ENOENT;
	}

	for (i = 0; i < nlines && ret >= 0; i++) {
1145 1146
		line = dwarf_onesrcline(lines, i);

1147 1148
		if (dwarf_lineno(line, &lineno) != 0 ||
		    !line_list__has_line(&pf->lcache, lineno))
1149 1150 1151 1152 1153 1154
			continue;

		/* TODO: Get fileno from line, but how? */
		if (strtailcmp(dwarf_linesrc(line, NULL, NULL), pf->fname) != 0)
			continue;

1155 1156 1157 1158 1159
		if (dwarf_lineaddr(line, &addr) != 0) {
			pr_debug("Failed to get the address of line %d.\n",
				 lineno);
			continue;
		}
1160 1161 1162 1163 1164
		if (sp_die) {
			/* Address filtering 1: does sp_die include addr? */
			if (!dwarf_haspc(sp_die, addr))
				continue;
			/* Address filtering 2: No child include addr? */
1165
			if (die_find_inlinefunc(sp_die, addr, &die_mem))
1166 1167 1168 1169 1170 1171 1172
				continue;
		}

		pr_debug("Probe line found: line[%d]:%d addr:0x%llx\n",
			 (int)i, lineno, (unsigned long long)addr);
		pf->addr = addr;

1173
		ret = call_probe_finder(sp_die, pf);
1174 1175 1176
		/* Continuing, because target line might be inlined. */
	}
	/* TODO: deallocate lines, but how? */
1177
	return ret;
1178 1179
}

1180 1181 1182 1183 1184 1185
/* Callback parameter with return value */
struct dwarf_callback_param {
	void *data;
	int retval;
};

1186 1187
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
1188 1189
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
1190
	struct perf_probe_point *pp = &pf->pev->point;
1191
	Dwarf_Addr addr;
1192

1193
	if (pp->lazy_line)
1194
		param->retval = find_probe_point_lazy(in_die, pf);
1195 1196
	else {
		/* Get probe address */
1197 1198 1199 1200 1201 1202 1203
		if (dwarf_entrypc(in_die, &addr) != 0) {
			pr_warning("Failed to get entry pc of %s.\n",
				   dwarf_diename(in_die));
			param->retval = -ENOENT;
			return DWARF_CB_ABORT;
		}
		pf->addr = addr;
1204 1205 1206 1207
		pf->addr += pp->offset;
		pr_debug("found inline addr: 0x%jx\n",
			 (uintmax_t)pf->addr);

1208
		param->retval = call_probe_finder(in_die, pf);
1209 1210
		if (param->retval < 0)
			return DWARF_CB_ABORT;
1211
	}
1212 1213 1214

	return DWARF_CB_OK;
}
1215

1216
/* Search function from function name */
1217
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
1218
{
1219 1220
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
1221
	struct perf_probe_point *pp = &pf->pev->point;
1222

1223 1224
	/* Check tag and diename */
	if (dwarf_tag(sp_die) != DW_TAG_subprogram ||
1225
	    !die_compare_name(sp_die, pp->function))
1226
		return DWARF_CB_OK;
1227

1228
	pf->fname = dwarf_decl_file(sp_die);
1229 1230 1231
	if (pp->line) { /* Function relative line */
		dwarf_decl_line(sp_die, &pf->lno);
		pf->lno += pp->line;
1232
		param->retval = find_probe_point_by_line(pf);
1233 1234
	} else if (!dwarf_func_inline(sp_die)) {
		/* Real function */
1235
		if (pp->lazy_line)
1236
			param->retval = find_probe_point_lazy(sp_die, pf);
1237
		else {
1238 1239 1240 1241 1242 1243
			if (dwarf_entrypc(sp_die, &pf->addr) != 0) {
				pr_warning("Failed to get entry pc of %s.\n",
					   dwarf_diename(sp_die));
				param->retval = -ENOENT;
				return DWARF_CB_ABORT;
			}
1244 1245
			pf->addr += pp->offset;
			/* TODO: Check the address in this function */
1246
			param->retval = call_probe_finder(sp_die, pf);
1247
		}
1248 1249 1250
	} else {
		struct dwarf_callback_param _param = {.data = (void *)pf,
						      .retval = 0};
1251
		/* Inlined function: search instances */
1252 1253 1254 1255
		dwarf_func_inline_instances(sp_die, probe_point_inline_cb,
					    &_param);
		param->retval = _param.retval;
	}
1256

1257
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
1258 1259
}

1260
static int find_probe_point_by_func(struct probe_finder *pf)
1261
{
1262 1263 1264 1265
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
1266 1267
}

1268 1269
/* Find probe points from debuginfo */
static int find_probes(int fd, struct probe_finder *pf)
1270
{
1271
	struct perf_probe_point *pp = &pf->pev->point;
1272 1273 1274
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1275 1276 1277
	Dwarf *dbg = NULL;
	Dwfl *dwfl;
	Dwarf_Addr bias;	/* Currently ignored */
1278
	int ret = 0;
1279

1280
	dbg = dwfl_init_offline_dwarf(fd, &dwfl, &bias);
1281 1282 1283 1284 1285
	if (!dbg) {
		pr_warning("No dwarf info found in the vmlinux - "
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
		return -EBADF;
	}
1286

1287
#if _ELFUTILS_PREREQ(0, 142)
1288
	/* Get the call frame information from this dwarf */
1289
	pf->cfi = dwarf_getcfi(dbg);
1290
#endif
1291

1292
	off = 0;
1293
	line_list__init(&pf->lcache);
1294
	/* Loop on CUs (Compilation Unit) */
1295 1296
	while (!dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL) &&
	       ret >= 0) {
1297
		/* Get the DIE(Debugging Information Entry) of this CU */
1298
		diep = dwarf_offdie(dbg, off + cuhl, &pf->cu_die);
1299 1300
		if (!diep)
			continue;
1301 1302 1303

		/* Check if target file is included. */
		if (pp->file)
1304
			pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1305
		else
1306
			pf->fname = NULL;
1307

1308
		if (!pp->file || pf->fname) {
1309
			if (pp->function)
1310
				ret = find_probe_point_by_func(pf);
1311
			else if (pp->lazy_line)
1312
				ret = find_probe_point_lazy(NULL, pf);
1313
			else {
1314 1315
				pf->lno = pp->line;
				ret = find_probe_point_by_line(pf);
1316
			}
1317
		}
1318
		off = noff;
1319
	}
1320
	line_list__free(&pf->lcache);
1321 1322
	if (dwfl)
		dwfl_end(dwfl);
1323

1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
	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);
1413
			pr_debug2("Add new var: %s\n", buf);
1414 1415 1416 1417 1418
			if (ret > 0)
				strlist__add(vl->vars, buf);
		}
	}

1419
	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
		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;
1431 1432
	Dwarf_Die die_mem, *scopes = NULL;
	int ret, nscopes;
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452

	/* 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;
1453
	af->child = true;
1454 1455
	die_find_child(sp_die, collect_variables_cb, (void *)af, &die_mem);

1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
	/* 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:
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478
	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,
1479 1480
			   struct variable_list **vls, int max_vls,
			   bool externs)
1481 1482 1483
{
	struct available_var_finder af = {
			.pf = {.pev = pev, .callback = add_available_vars},
1484
			.max_vls = max_vls, .externs = externs};
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
	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;
1510 1511
}

1512
/* Reverse search */
1513
int find_perf_probe_point(unsigned long addr, struct perf_probe_point *ppt)
1514 1515
{
	Dwarf_Die cudie, spdie, indie;
1516 1517
	Dwarf *dbg = NULL;
	Dwfl *dwfl = NULL;
1518
	Dwarf_Line *line;
1519
	Dwarf_Addr laddr, eaddr, bias = 0;
1520 1521
	const char *tmp;
	int lineno, ret = 0;
1522
	bool found = false;
1523

1524 1525 1526 1527 1528 1529 1530 1531
	/* Open the live linux kernel */
	dbg = dwfl_init_live_kernel_dwarf(addr, &dwfl, &bias);
	if (!dbg) {
		pr_warning("No dwarf info found in the vmlinux - "
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
		ret = -EINVAL;
		goto end;
	}
1532

1533 1534
	/* Adjust address with bias */
	addr += bias;
1535
	/* Find cu die */
1536 1537
	if (!dwarf_addrdie(dbg, (Dwarf_Addr)addr - bias, &cudie)) {
		pr_warning("No CU DIE is found at %lx\n", addr);
1538 1539 1540
		ret = -EINVAL;
		goto end;
	}
1541 1542 1543 1544

	/* Find a corresponding line */
	line = dwarf_getsrc_die(&cudie, (Dwarf_Addr)addr);
	if (line) {
1545 1546 1547
		if (dwarf_lineaddr(line, &laddr) == 0 &&
		    (Dwarf_Addr)addr == laddr &&
		    dwarf_lineno(line, &lineno) == 0) {
1548
			tmp = dwarf_linesrc(line, NULL, NULL);
1549 1550
			if (tmp) {
				ppt->line = lineno;
1551 1552 1553 1554 1555
				ppt->file = strdup(tmp);
				if (ppt->file == NULL) {
					ret = -ENOMEM;
					goto end;
				}
1556 1557
				found = true;
			}
1558 1559 1560 1561 1562 1563
		}
	}

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

1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
		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;
			}
1587
		}
1588 1589 1590
		/* We don't have a line number, let's use offset */
		ppt->offset = addr - (unsigned long)eaddr;
found:
1591 1592 1593 1594 1595
		ppt->function = strdup(tmp);
		if (ppt->function == NULL) {
			ret = -ENOMEM;
			goto end;
		}
1596
		found = true;
1597 1598 1599
	}

end:
1600 1601
	if (dwfl)
		dwfl_end(dwfl);
1602 1603
	if (ret >= 0)
		ret = found ? 1 : 0;
1604 1605 1606
	return ret;
}

1607 1608 1609 1610
/* Add a line and store the src path */
static int line_range_add_line(const char *src, unsigned int lineno,
			       struct line_range *lr)
{
1611
	/* Copy source path */
1612
	if (!lr->path) {
1613 1614 1615
		lr->path = strdup(src);
		if (lr->path == NULL)
			return -ENOMEM;
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
	}
	return line_list__add_line(&lr->line_list, lineno);
}

/* Search function declaration lines */
static int line_range_funcdecl_cb(Dwarf_Die *sp_die, void *data)
{
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
	const char *src;
	int lineno;

	src = dwarf_decl_file(sp_die);
	if (src && strtailcmp(src, lf->fname) != 0)
		return DWARF_CB_OK;

	if (dwarf_decl_line(sp_die, &lineno) != 0 ||
	    (lf->lno_s > lineno || lf->lno_e < lineno))
		return DWARF_CB_OK;

	param->retval = line_range_add_line(src, lineno, lf->lr);
1637 1638
	if (param->retval < 0)
		return DWARF_CB_ABORT;
1639 1640 1641 1642 1643 1644 1645 1646 1647
	return DWARF_CB_OK;
}

static int find_line_range_func_decl_lines(struct line_finder *lf)
{
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_funcdecl_cb, &param, 0);
	return param.retval;
}
1648

1649
/* Find line range from its line number */
1650
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1651
{
1652 1653 1654
	Dwarf_Lines *lines;
	Dwarf_Line *line;
	size_t nlines, i;
1655
	Dwarf_Addr addr;
1656
	int lineno, ret = 0;
1657
	const char *src;
1658
	Dwarf_Die die_mem;
1659

1660
	line_list__init(&lf->lr->line_list);
1661 1662 1663 1664
	if (dwarf_getsrclines(&lf->cu_die, &lines, &nlines) != 0) {
		pr_warning("No source lines found in this CU.\n");
		return -ENOENT;
	}
1665

1666
	/* Search probable lines on lines list */
1667 1668
	for (i = 0; i < nlines; i++) {
		line = dwarf_onesrcline(lines, i);
1669 1670
		if (dwarf_lineno(line, &lineno) != 0 ||
		    (lf->lno_s > lineno || lf->lno_e < lineno))
1671 1672
			continue;

1673 1674
		if (sp_die) {
			/* Address filtering 1: does sp_die include addr? */
1675 1676
			if (dwarf_lineaddr(line, &addr) != 0 ||
			    !dwarf_haspc(sp_die, addr))
1677 1678 1679
				continue;

			/* Address filtering 2: No child include addr? */
1680
			if (die_find_inlinefunc(sp_die, addr, &die_mem))
1681 1682 1683
				continue;
		}

1684 1685 1686
		/* TODO: Get fileno from line, but how? */
		src = dwarf_linesrc(line, NULL, NULL);
		if (strtailcmp(src, lf->fname) != 0)
1687 1688
			continue;

1689 1690 1691
		ret = line_range_add_line(src, lineno, lf->lr);
		if (ret < 0)
			return ret;
1692
	}
1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705

	/*
	 * Dwarf lines doesn't include function declarations. We have to
	 * check functions list or given function.
	 */
	if (sp_die) {
		src = dwarf_decl_file(sp_die);
		if (src && dwarf_decl_line(sp_die, &lineno) == 0 &&
		    (lf->lno_s <= lineno && lf->lno_e >= lineno))
			ret = line_range_add_line(src, lineno, lf->lr);
	} else
		ret = find_line_range_func_decl_lines(lf);

1706
	/* Update status */
1707 1708 1709 1710 1711
	if (ret >= 0)
		if (!list_empty(&lf->lr->line_list))
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1712 1713 1714 1715
	else {
		free(lf->lr->path);
		lf->lr->path = NULL;
	}
1716
	return ret;
1717 1718
}

1719 1720
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1721 1722 1723
	struct dwarf_callback_param *param = data;

	param->retval = find_line_range_by_line(in_die, param->data);
1724 1725 1726
	return DWARF_CB_ABORT;	/* No need to find other instances */
}

1727
/* Search function from function name */
1728
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1729
{
1730 1731
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1732 1733
	struct line_range *lr = lf->lr;

1734 1735
	pr_debug("find (%llx) %s\n",
		 (unsigned long long)dwarf_dieoffset(sp_die),
1736
		 dwarf_diename(sp_die));
1737
	if (dwarf_tag(sp_die) == DW_TAG_subprogram &&
1738
	    die_compare_name(sp_die, lr->function)) {
1739 1740
		lf->fname = dwarf_decl_file(sp_die);
		dwarf_decl_line(sp_die, &lr->offset);
1741
		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1742
		lf->lno_s = lr->offset + lr->start;
1743 1744 1745 1746
		if (lf->lno_s < 0)	/* Overflow */
			lf->lno_s = INT_MAX;
		lf->lno_e = lr->offset + lr->end;
		if (lf->lno_e < 0)	/* Overflow */
1747
			lf->lno_e = INT_MAX;
1748
		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1749 1750
		lr->start = lf->lno_s;
		lr->end = lf->lno_e;
1751 1752 1753 1754
		if (dwarf_func_inline(sp_die)) {
			struct dwarf_callback_param _param;
			_param.data = (void *)lf;
			_param.retval = 0;
1755
			dwarf_func_inline_instances(sp_die,
1756 1757 1758 1759 1760 1761
						    line_range_inline_cb,
						    &_param);
			param->retval = _param.retval;
		} else
			param->retval = find_line_range_by_line(sp_die, lf);
		return DWARF_CB_ABORT;
1762
	}
1763
	return DWARF_CB_OK;
1764 1765
}

1766
static int find_line_range_by_func(struct line_finder *lf)
1767
{
1768 1769 1770
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1771 1772 1773 1774
}

int find_line_range(int fd, struct line_range *lr)
{
1775
	struct line_finder lf = {.lr = lr, .found = 0};
1776
	int ret = 0;
1777 1778 1779
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
1780 1781 1782
	Dwarf *dbg = NULL;
	Dwfl *dwfl;
	Dwarf_Addr bias;	/* Currently ignored */
1783
	const char *comp_dir;
1784

1785
	dbg = dwfl_init_offline_dwarf(fd, &dwfl, &bias);
1786 1787 1788 1789 1790
	if (!dbg) {
		pr_warning("No dwarf info found in the vmlinux - "
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
		return -EBADF;
	}
1791

1792
	/* Loop on CUs (Compilation Unit) */
1793 1794
	while (!lf.found && ret >= 0) {
		if (dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL) != 0)
1795 1796 1797
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1798 1799 1800
		diep = dwarf_offdie(dbg, off + cuhl, &lf.cu_die);
		if (!diep)
			continue;
1801 1802 1803

		/* Check if target file is included. */
		if (lr->file)
1804
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1805
		else
1806
			lf.fname = 0;
1807

1808
		if (!lr->file || lf.fname) {
1809
			if (lr->function)
1810
				ret = find_line_range_by_func(&lf);
1811 1812
			else {
				lf.lno_s = lr->start;
1813
				lf.lno_e = lr->end;
1814
				ret = find_line_range_by_line(NULL, &lf);
1815 1816
			}
		}
1817
		off = noff;
1818
	}
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829

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

1830
	pr_debug("path: %s\n", lr->path);
1831
	dwfl_end(dwfl);
1832
	return (ret < 0) ? ret : lf.found;
1833 1834
}