probe-finder.c 31.8 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 "string.h"
37 38
#include "event.h"
#include "debug.h"
39
#include "util.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 119 120 121 122
{
	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);
	}
}

/* Dwarf wrappers */

/* Find the realpath of the target file. */
static const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
123
{
124 125
	Dwarf_Files *files;
	size_t nfiles, i;
126
	const char *src = NULL;
127 128 129
	int ret;

	if (!fname)
130
		return NULL;
131

132
	ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
133 134 135 136 137 138 139
	if (ret != 0)
		return NULL;

	for (i = 0; i < nfiles; i++) {
		src = dwarf_filesrc(files, i, NULL, NULL);
		if (strtailcmp(src, fname) == 0)
			break;
140
	}
141 142
	if (i == nfiles)
		return NULL;
143
	return src;
144 145
}

146 147 148 149 150
/* Compare diename and tname */
static bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
{
	const char *name;
	name = dwarf_diename(dw_die);
151
	return name ? strcmp(tname, name) : -1;
152 153
}

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/* Get type die, but skip qualifiers and typedef */
static Dwarf_Die *die_get_real_type(Dwarf_Die *vr_die, Dwarf_Die *die_mem)
{
	Dwarf_Attribute attr;
	int tag;

	do {
		if (dwarf_attr(vr_die, DW_AT_type, &attr) == NULL ||
		    dwarf_formref_die(&attr, die_mem) == NULL)
			return NULL;

		tag = dwarf_tag(die_mem);
		vr_die = die_mem;
	} while (tag == DW_TAG_const_type ||
		 tag == DW_TAG_restrict_type ||
		 tag == DW_TAG_volatile_type ||
		 tag == DW_TAG_shared_type ||
		 tag == DW_TAG_typedef);

	return die_mem;
}

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

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
/* 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;
}

228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
/* 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;
}

264 265 266 267 268 269
struct __addr_die_search_param {
	Dwarf_Addr	addr;
	Dwarf_Die	*die_mem;
};

static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
270
{
271
	struct __addr_die_search_param *ad = data;
272

273 274 275 276 277 278 279
	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;
}
280

281
/* Search a real subprogram including this line, */
282 283
static Dwarf_Die *die_find_real_subprogram(Dwarf_Die *cu_die, Dwarf_Addr addr,
					   Dwarf_Die *die_mem)
284 285 286 287 288 289 290 291 292
{
	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;
293 294
}

295 296
/* die_find callback for inline function search */
static int __die_find_inline_cb(Dwarf_Die *die_mem, void *data)
297
{
298
	Dwarf_Addr *addr = data;
299

300 301 302
	if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
	    dwarf_haspc(die_mem, *addr))
		return DIE_FIND_CB_FOUND;
303

304
	return DIE_FIND_CB_CONTINUE;
305 306
}

307 308 309
/* 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)
310
{
311
	return die_find_child(sp_die, __die_find_inline_cb, &addr, die_mem);
312 313
}

314
static int __die_find_variable_cb(Dwarf_Die *die_mem, void *data)
315
{
316 317
	const char *name = data;
	int tag;
318

319 320 321 322 323 324 325
	tag = dwarf_tag(die_mem);
	if ((tag == DW_TAG_formal_parameter ||
	     tag == DW_TAG_variable) &&
	    (die_compare_name(die_mem, name) == 0))
		return DIE_FIND_CB_FOUND;

	return DIE_FIND_CB_CONTINUE;
326 327
}

328
/* Find a variable called 'name' */
329 330
static Dwarf_Die *die_find_variable(Dwarf_Die *sp_die, const char *name,
				    Dwarf_Die *die_mem)
331
{
332 333
	return die_find_child(sp_die, __die_find_variable_cb, (void *)name,
			      die_mem);
334 335
}

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
static int __die_find_member_cb(Dwarf_Die *die_mem, void *data)
{
	const char *name = data;

	if ((dwarf_tag(die_mem) == DW_TAG_member) &&
	    (die_compare_name(die_mem, name) == 0))
		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);
}

355 356 357 358 359
/*
 * Probe finder related functions
 */

/* Show a location */
360
static int convert_location(Dwarf_Op *op, struct probe_finder *pf)
361
{
362 363
	unsigned int regn;
	Dwarf_Word offs = 0;
364
	bool ref = false;
365
	const char *regs;
366
	struct kprobe_trace_arg *tvar = pf->tvar;
367 368

	/* If this is based on frame buffer, set the offset */
369
	if (op->atom == DW_OP_fbreg) {
370 371 372 373 374
		if (pf->fb_ops == NULL) {
			pr_warning("The attribute of frame base is not "
				   "supported.\n");
			return -ENOTSUP;
		}
375
		ref = true;
376 377 378
		offs = op->number;
		op = &pf->fb_ops[0];
	}
379

380 381 382
	if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
		regn = op->atom - DW_OP_breg0;
		offs += op->number;
383
		ref = true;
384 385 386 387 388
	} 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;
389
		ref = true;
390 391
	} else if (op->atom == DW_OP_regx) {
		regn = op->number;
392 393 394 395
	} else {
		pr_warning("DW_OP %x is not supported.\n", op->atom);
		return -ENOTSUP;
	}
396 397

	regs = get_arch_regstr(regn);
398
	if (!regs) {
399
		pr_warning("Mapping for DWARF register number %u missing on this architecture.", regn);
400 401
		return -ERANGE;
	}
402

403 404 405 406
	tvar->value = strdup(regs);
	if (tvar->value == NULL)
		return -ENOMEM;

407
	if (ref) {
408 409 410
		tvar->ref = zalloc(sizeof(struct kprobe_trace_arg_ref));
		if (tvar->ref == NULL)
			return -ENOMEM;
411 412
		tvar->ref->offset = (long)offs;
	}
413
	return 0;
414 415
}

416 417
static int convert_variable_type(Dwarf_Die *vr_die,
				 struct kprobe_trace_arg *targ)
418 419 420 421 422
{
	Dwarf_Die type;
	char buf[16];
	int ret;

423 424 425 426 427
	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;
	}
428 429 430 431 432

	ret = die_get_byte_size(&type) * 8;
	if (ret) {
		/* Check the bitwidth */
		if (ret > MAX_BASIC_TYPE_BITS) {
433 434 435
			pr_info("%s exceeds max-bitwidth."
				" Cut down to %d bits.\n",
				dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
436 437 438 439 440
			ret = MAX_BASIC_TYPE_BITS;
		}

		ret = snprintf(buf, 16, "%c%d",
			       die_is_signed_type(&type) ? 's' : 'u', ret);
441 442 443 444 445 446 447
		if (ret < 0 || ret >= 16) {
			if (ret >= 16)
				ret = -E2BIG;
			pr_warning("Failed to convert variable type: %s\n",
				   strerror(-ret));
			return ret;
		}
448 449 450
		targ->type = strdup(buf);
		if (targ->type == NULL)
			return -ENOMEM;
451
	}
452
	return 0;
453 454
}

455
static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
456
				    struct perf_probe_arg_field *field,
457 458
				    struct kprobe_trace_arg_ref **ref_ptr,
				    Dwarf_Die *die_mem)
459 460 461 462
{
	struct kprobe_trace_arg_ref *ref = *ref_ptr;
	Dwarf_Die type;
	Dwarf_Word offs;
463
	int ret;
464 465

	pr_debug("converting %s in %s\n", field->name, varname);
466 467 468 469
	if (die_get_real_type(vr_die, &type) == NULL) {
		pr_warning("Failed to get the type of %s.\n", varname);
		return -ENOENT;
	}
470 471 472

	/* Check the pointer and dereference */
	if (dwarf_tag(&type) == DW_TAG_pointer_type) {
473 474 475 476 477
		if (!field->ref) {
			pr_err("Semantic error: %s must be referred by '->'\n",
			       field->name);
			return -EINVAL;
		}
478
		/* Get the type pointed by this pointer */
479 480 481 482
		if (die_get_real_type(&type, &type) == NULL) {
			pr_warning("Failed to get the type of %s.\n", varname);
			return -ENOENT;
		}
483
		/* Verify it is a data structure  */
484 485 486 487
		if (dwarf_tag(&type) != DW_TAG_structure_type) {
			pr_warning("%s is not a data structure.\n", varname);
			return -EINVAL;
		}
488

489 490 491
		ref = zalloc(sizeof(struct kprobe_trace_arg_ref));
		if (ref == NULL)
			return -ENOMEM;
492 493 494 495 496
		if (*ref_ptr)
			(*ref_ptr)->next = ref;
		else
			*ref_ptr = ref;
	} else {
497
		/* Verify it is a data structure  */
498 499 500 501 502 503 504 505 506 507 508 509 510 511
		if (dwarf_tag(&type) != DW_TAG_structure_type) {
			pr_warning("%s is not a data structure.\n", varname);
			return -EINVAL;
		}
		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;
		}
512 513
	}

514 515 516 517 518
	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;
	}
519 520

	/* Get the offset of the field */
521 522
	ret = die_get_data_member_location(die_mem, &offs);
	if (ret < 0) {
523
		pr_warning("Failed to get the offset of %s.\n", field->name);
524
		return ret;
525
	}
526 527 528 529
	ref->offset += (long)offs;

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

536
/* Show a variables in kprobe event format */
537
static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
538 539
{
	Dwarf_Attribute attr;
540
	Dwarf_Die die_mem;
541 542
	Dwarf_Op *expr;
	size_t nexpr;
543 544
	int ret;

545
	if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
546
		goto error;
547
	/* TODO: handle more than 1 exprs */
548
	ret = dwarf_getlocation_addr(&attr, pf->addr, &expr, &nexpr, 1);
549
	if (ret <= 0 || nexpr == 0)
550
		goto error;
551

552 553 554 555 556
	ret = convert_location(expr, pf);
	if (ret == 0 && pf->pvar->field) {
		ret = convert_variable_fields(vr_die, pf->pvar->var,
					      pf->pvar->field, &pf->tvar->ref,
					      &die_mem);
557 558
		vr_die = &die_mem;
	}
559
	if (ret == 0) {
560 561 562 563 564
		if (pf->pvar->type) {
			pf->tvar->type = strdup(pf->pvar->type);
			if (pf->tvar->type == NULL)
				ret = -ENOMEM;
		} else
565 566
			ret = convert_variable_type(vr_die, pf->tvar);
	}
567
	/* *expr will be cached in libdw. Don't free it. */
568
	return ret;
569
error:
570
	/* TODO: Support const_value */
571 572 573
	pr_err("Failed to find the location of %s at this address.\n"
	       " Perhaps, it has been optimized out.\n", pf->pvar->var);
	return -ENOENT;
574 575 576
}

/* Find a variable in a subprogram die */
577
static int find_variable(Dwarf_Die *sp_die, struct probe_finder *pf)
578
{
579
	Dwarf_Die vr_die;
580
	char buf[32], *ptr;
581
	int ret;
582

583 584
	/* TODO: Support arrays */
	if (pf->pvar->name)
585
		pf->tvar->name = strdup(pf->pvar->name);
586
	else {
587 588 589
		ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
		if (ret < 0)
			return ret;
590 591 592
		ptr = strchr(buf, ':');	/* Change type separator to _ */
		if (ptr)
			*ptr = '_';
593
		pf->tvar->name = strdup(buf);
594
	}
595 596
	if (pf->tvar->name == NULL)
		return -ENOMEM;
597 598

	if (!is_c_varname(pf->pvar->var)) {
599
		/* Copy raw parameters */
600 601 602 603 604
		pf->tvar->value = strdup(pf->pvar->var);
		if (pf->tvar->value == NULL)
			return -ENOMEM;
		else
			return 0;
605
	}
606 607 608 609 610 611 612 613 614 615

	pr_debug("Searching '%s' variable in context.\n",
		 pf->pvar->var);
	/* Search child die for local variables and parameters. */
	if (!die_find_variable(sp_die, pf->pvar->var, &vr_die)) {
		pr_warning("Failed to find '%s' in this function.\n",
			   pf->pvar->var);
		return -ENOENT;
	}
	return convert_variable(&vr_die, pf);
616 617 618
}

/* Show a probe point to output buffer */
619
static int convert_probe_point(Dwarf_Die *sp_die, struct probe_finder *pf)
620
{
621
	struct kprobe_trace_event *tev;
622 623
	Dwarf_Addr eaddr;
	Dwarf_Die die_mem;
624
	const char *name;
625
	int ret, i;
626 627
	Dwarf_Attribute fb_attr;
	size_t nops;
628

629 630 631
	if (pf->ntevs == pf->max_tevs) {
		pr_warning("Too many( > %d) probe point found.\n",
			   pf->max_tevs);
632 633
		return -ERANGE;
	}
634 635
	tev = &pf->tevs[pf->ntevs++];

636 637
	/* If no real subprogram, find a real one */
	if (!sp_die || dwarf_tag(sp_die) != DW_TAG_subprogram) {
638
		sp_die = die_find_real_subprogram(&pf->cu_die,
639
						 pf->addr, &die_mem);
640 641 642 643 644
		if (!sp_die) {
			pr_warning("Failed to find probe point in any "
				   "functions.\n");
			return -ENOENT;
		}
645 646
	}

647
	/* Copy the name of probe point */
648 649
	name = dwarf_diename(sp_die);
	if (name) {
650 651 652 653 654
		if (dwarf_entrypc(sp_die, &eaddr) != 0) {
			pr_warning("Failed to get entry pc of %s\n",
				   dwarf_diename(sp_die));
			return -ENOENT;
		}
655 656 657
		tev->point.symbol = strdup(name);
		if (tev->point.symbol == NULL)
			return -ENOMEM;
658 659
		tev->point.offset = (unsigned long)(pf->addr - eaddr);
	} else
660
		/* This function has no name. */
661 662 663 664
		tev->point.offset = (unsigned long)pf->addr;

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

666 667
	/* Get the frame base attribute/ops */
	dwarf_attr(sp_die, DW_AT_frame_base, &fb_attr);
668
	ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
669
	if (ret <= 0 || nops == 0) {
670
		pf->fb_ops = NULL;
671
#if _ELFUTILS_PREREQ(0, 142)
672 673 674
	} else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
		   pf->cfi != NULL) {
		Dwarf_Frame *frame;
675 676 677 678 679 680
		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;
		}
681
#endif
682
	}
683

684
	/* Find each argument */
685
	tev->nargs = pf->pev->nargs;
686 687 688
	tev->args = zalloc(sizeof(struct kprobe_trace_arg) * tev->nargs);
	if (tev->args == NULL)
		return -ENOMEM;
689 690 691
	for (i = 0; i < pf->pev->nargs; i++) {
		pf->pvar = &pf->pev->args[i];
		pf->tvar = &tev->args[i];
692 693 694
		ret = find_variable(sp_die, pf);
		if (ret != 0)
			return ret;
695
	}
696 697 698

	/* *pf->fb_ops will be cached in libdw. Don't free it. */
	pf->fb_ops = NULL;
699
	return 0;
700 701 702
}

/* Find probe point from its line number */
703
static int find_probe_point_by_line(struct probe_finder *pf)
704
{
705 706 707
	Dwarf_Lines *lines;
	Dwarf_Line *line;
	size_t nlines, i;
708
	Dwarf_Addr addr;
709
	int lineno;
710
	int ret = 0;
711

712 713 714 715
	if (dwarf_getsrclines(&pf->cu_die, &lines, &nlines) != 0) {
		pr_warning("No source lines found in this CU.\n");
		return -ENOENT;
	}
716

717
	for (i = 0; i < nlines && ret == 0; i++) {
718
		line = dwarf_onesrcline(lines, i);
719 720
		if (dwarf_lineno(line, &lineno) != 0 ||
		    lineno != pf->lno)
721 722
			continue;

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

727 728 729 730
		if (dwarf_lineaddr(line, &addr) != 0) {
			pr_warning("Failed to get the address of the line.\n");
			return -ENOENT;
		}
731 732
		pr_debug("Probe line found: line[%d]:%d addr:0x%jx\n",
			 (int)i, lineno, (uintmax_t)addr);
733
		pf->addr = addr;
734

735
		ret = convert_probe_point(NULL, pf);
736 737
		/* Continuing, because target line might be inlined. */
	}
738
	return ret;
739 740
}

741 742 743 744 745
/* 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;
746
	int fd, ret, line, nlines = 0;
747 748 749
	struct stat st;

	fd = open(fname, O_RDONLY);
750 751 752 753 754 755 756 757 758 759 760
	if (fd < 0) {
		pr_warning("Failed to open %s: %s\n", fname, strerror(-fd));
		return fd;
	}

	ret = fstat(fd, &st);
	if (ret < 0) {
		pr_warning("Failed to get the size of %s: %s\n",
			   fname, strerror(errno));
		return ret;
	}
761
	fbuf = xmalloc(st.st_size + 2);
762 763 764 765 766
	ret = read(fd, fbuf, st.st_size);
	if (ret < 0) {
		pr_warning("Failed to read %s: %s\n", fname, strerror(errno));
		return ret;
	}
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
	close(fd);
	fbuf[st.st_size] = '\n';	/* Dummy line */
	fbuf[st.st_size + 1] = '\0';
	p1 = fbuf;
	line = 1;
	while ((p2 = strchr(p1, '\n')) != NULL) {
		*p2 = '\0';
		if (strlazymatch(p1, pat)) {
			line_list__add_line(head, line);
			nlines++;
		}
		line++;
		p1 = p2 + 1;
	}
	free(fbuf);
	return nlines;
}

/* Find probe points from lazy pattern  */
786
static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
787 788 789 790 791 792 793
{
	Dwarf_Lines *lines;
	Dwarf_Line *line;
	size_t nlines, i;
	Dwarf_Addr addr;
	Dwarf_Die die_mem;
	int lineno;
794
	int ret = 0;
795 796 797 798

	if (list_empty(&pf->lcache)) {
		/* Matching lazy line pattern */
		ret = find_lazy_match_lines(&pf->lcache, pf->fname,
799
					    pf->pev->point.lazy_line);
800 801 802 803 804
		if (ret == 0) {
			pr_debug("No matched lines found in %s.\n", pf->fname);
			return 0;
		} else if (ret < 0)
			return ret;
805 806
	}

807 808 809 810 811 812
	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++) {
813 814
		line = dwarf_onesrcline(lines, i);

815 816
		if (dwarf_lineno(line, &lineno) != 0 ||
		    !line_list__has_line(&pf->lcache, lineno))
817 818 819 820 821 822
			continue;

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

823 824 825 826 827
		if (dwarf_lineaddr(line, &addr) != 0) {
			pr_debug("Failed to get the address of line %d.\n",
				 lineno);
			continue;
		}
828 829 830 831 832
		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? */
833
			if (die_find_inlinefunc(sp_die, addr, &die_mem))
834 835 836 837 838 839 840
				continue;
		}

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

841
		ret = convert_probe_point(sp_die, pf);
842 843 844
		/* Continuing, because target line might be inlined. */
	}
	/* TODO: deallocate lines, but how? */
845
	return ret;
846 847
}

848 849 850 851 852 853
/* Callback parameter with return value */
struct dwarf_callback_param {
	void *data;
	int retval;
};

854 855
static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
{
856 857
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
858
	struct perf_probe_point *pp = &pf->pev->point;
859
	Dwarf_Addr addr;
860

861
	if (pp->lazy_line)
862
		param->retval = find_probe_point_lazy(in_die, pf);
863 864
	else {
		/* Get probe address */
865 866 867 868 869 870 871
		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;
872 873 874 875
		pf->addr += pp->offset;
		pr_debug("found inline addr: 0x%jx\n",
			 (uintmax_t)pf->addr);

876
		param->retval = convert_probe_point(in_die, pf);
877 878
		if (param->retval < 0)
			return DWARF_CB_ABORT;
879
	}
880 881 882

	return DWARF_CB_OK;
}
883

884
/* Search function from function name */
885
static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
886
{
887 888
	struct dwarf_callback_param *param = data;
	struct probe_finder *pf = param->data;
889
	struct perf_probe_point *pp = &pf->pev->point;
890

891 892 893
	/* Check tag and diename */
	if (dwarf_tag(sp_die) != DW_TAG_subprogram ||
	    die_compare_name(sp_die, pp->function) != 0)
894
		return DWARF_CB_OK;
895

896
	pf->fname = dwarf_decl_file(sp_die);
897 898 899
	if (pp->line) { /* Function relative line */
		dwarf_decl_line(sp_die, &pf->lno);
		pf->lno += pp->line;
900
		param->retval = find_probe_point_by_line(pf);
901 902
	} else if (!dwarf_func_inline(sp_die)) {
		/* Real function */
903
		if (pp->lazy_line)
904
			param->retval = find_probe_point_lazy(sp_die, pf);
905
		else {
906 907 908 909 910 911
			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;
			}
912 913
			pf->addr += pp->offset;
			/* TODO: Check the address in this function */
914
			param->retval = convert_probe_point(sp_die, pf);
915
		}
916 917 918
	} else {
		struct dwarf_callback_param _param = {.data = (void *)pf,
						      .retval = 0};
919
		/* Inlined function: search instances */
920 921 922 923
		dwarf_func_inline_instances(sp_die, probe_point_inline_cb,
					    &_param);
		param->retval = _param.retval;
	}
924

925
	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
926 927
}

928
static int find_probe_point_by_func(struct probe_finder *pf)
929
{
930 931 932 933
	struct dwarf_callback_param _param = {.data = (void *)pf,
					      .retval = 0};
	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
	return _param.retval;
934 935
}

936 937
/* Find kprobe_trace_events specified by perf_probe_event from debuginfo */
int find_kprobe_trace_events(int fd, struct perf_probe_event *pev,
938
			     struct kprobe_trace_event **tevs, int max_tevs)
939
{
940
	struct probe_finder pf = {.pev = pev, .max_tevs = max_tevs};
941
	struct perf_probe_point *pp = &pev->point;
942 943 944 945
	Dwarf_Off off, noff;
	size_t cuhl;
	Dwarf_Die *diep;
	Dwarf *dbg;
946
	int ret = 0;
947

948
	pf.tevs = zalloc(sizeof(struct kprobe_trace_event) * max_tevs);
949 950
	if (pf.tevs == NULL)
		return -ENOMEM;
951 952 953
	*tevs = pf.tevs;
	pf.ntevs = 0;

954
	dbg = dwarf_begin(fd, DWARF_C_READ);
955 956 957 958 959
	if (!dbg) {
		pr_warning("No dwarf info found in the vmlinux - "
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
		return -EBADF;
	}
960

961
#if _ELFUTILS_PREREQ(0, 142)
962 963
	/* Get the call frame information from this dwarf */
	pf.cfi = dwarf_getcfi(dbg);
964
#endif
965

966
	off = 0;
967
	line_list__init(&pf.lcache);
968
	/* Loop on CUs (Compilation Unit) */
969 970
	while (!dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL) &&
	       ret >= 0) {
971
		/* Get the DIE(Debugging Information Entry) of this CU */
972 973 974
		diep = dwarf_offdie(dbg, off + cuhl, &pf.cu_die);
		if (!diep)
			continue;
975 976 977

		/* Check if target file is included. */
		if (pp->file)
978
			pf.fname = cu_find_realpath(&pf.cu_die, pp->file);
979
		else
980
			pf.fname = NULL;
981

982
		if (!pp->file || pf.fname) {
983
			if (pp->function)
984
				ret = find_probe_point_by_func(&pf);
985
			else if (pp->lazy_line)
986
				ret = find_probe_point_lazy(NULL, &pf);
987 988
			else {
				pf.lno = pp->line;
989
				ret = find_probe_point_by_line(&pf);
990
			}
991
		}
992
		off = noff;
993
	}
994
	line_list__free(&pf.lcache);
995
	dwarf_end(dbg);
996

997
	return (ret < 0) ? ret : pf.ntevs;
998 999
}

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
/* Reverse search */
int find_perf_probe_point(int fd, unsigned long addr,
			  struct perf_probe_point *ppt)
{
	Dwarf_Die cudie, spdie, indie;
	Dwarf *dbg;
	Dwarf_Line *line;
	Dwarf_Addr laddr, eaddr;
	const char *tmp;
	int lineno, ret = 0;
1010
	bool found = false;
1011 1012 1013

	dbg = dwarf_begin(fd, DWARF_C_READ);
	if (!dbg)
1014
		return -EBADF;
1015 1016

	/* Find cu die */
1017 1018 1019 1020
	if (!dwarf_addrdie(dbg, (Dwarf_Addr)addr, &cudie)) {
		ret = -EINVAL;
		goto end;
	}
1021 1022 1023 1024

	/* Find a corresponding line */
	line = dwarf_getsrc_die(&cudie, (Dwarf_Addr)addr);
	if (line) {
1025 1026 1027
		if (dwarf_lineaddr(line, &laddr) == 0 &&
		    (Dwarf_Addr)addr == laddr &&
		    dwarf_lineno(line, &lineno) == 0) {
1028
			tmp = dwarf_linesrc(line, NULL, NULL);
1029 1030
			if (tmp) {
				ppt->line = lineno;
1031 1032 1033 1034 1035
				ppt->file = strdup(tmp);
				if (ppt->file == NULL) {
					ret = -ENOMEM;
					goto end;
				}
1036 1037
				found = true;
			}
1038 1039 1040 1041 1042 1043
		}
	}

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

1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
		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;
			}
1067
		}
1068 1069 1070
		/* We don't have a line number, let's use offset */
		ppt->offset = addr - (unsigned long)eaddr;
found:
1071 1072 1073 1074 1075
		ppt->function = strdup(tmp);
		if (ppt->function == NULL) {
			ret = -ENOMEM;
			goto end;
		}
1076
		found = true;
1077 1078 1079 1080
	}

end:
	dwarf_end(dbg);
1081 1082
	if (ret >= 0)
		ret = found ? 1 : 0;
1083 1084 1085
	return ret;
}

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
/* Add a line and store the src path */
static int line_range_add_line(const char *src, unsigned int lineno,
			       struct line_range *lr)
{
	/* Copy real path */
	if (!lr->path) {
		lr->path = strdup(src);
		if (lr->path == NULL)
			return -ENOMEM;
	}
	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);
1116 1117
	if (param->retval < 0)
		return DWARF_CB_ABORT;
1118 1119 1120 1121 1122 1123 1124 1125 1126
	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;
}
1127

1128
/* Find line range from its line number */
1129
static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1130
{
1131 1132 1133
	Dwarf_Lines *lines;
	Dwarf_Line *line;
	size_t nlines, i;
1134
	Dwarf_Addr addr;
1135
	int lineno, ret = 0;
1136
	const char *src;
1137
	Dwarf_Die die_mem;
1138

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

1145
	/* Search probable lines on lines list */
1146 1147
	for (i = 0; i < nlines; i++) {
		line = dwarf_onesrcline(lines, i);
1148 1149
		if (dwarf_lineno(line, &lineno) != 0 ||
		    (lf->lno_s > lineno || lf->lno_e < lineno))
1150 1151
			continue;

1152 1153
		if (sp_die) {
			/* Address filtering 1: does sp_die include addr? */
1154 1155
			if (dwarf_lineaddr(line, &addr) != 0 ||
			    !dwarf_haspc(sp_die, addr))
1156 1157 1158
				continue;

			/* Address filtering 2: No child include addr? */
1159
			if (die_find_inlinefunc(sp_die, addr, &die_mem))
1160 1161 1162
				continue;
		}

1163 1164 1165
		/* TODO: Get fileno from line, but how? */
		src = dwarf_linesrc(line, NULL, NULL);
		if (strtailcmp(src, lf->fname) != 0)
1166 1167
			continue;

1168 1169 1170
		ret = line_range_add_line(src, lineno, lf->lr);
		if (ret < 0)
			return ret;
1171
	}
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184

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

1185
	/* Update status */
1186 1187 1188 1189 1190
	if (ret >= 0)
		if (!list_empty(&lf->lr->line_list))
			ret = lf->found = 1;
		else
			ret = 0;	/* Lines are not found */
1191 1192 1193 1194
	else {
		free(lf->lr->path);
		lf->lr->path = NULL;
	}
1195
	return ret;
1196 1197
}

1198 1199
static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
{
1200 1201 1202
	struct dwarf_callback_param *param = data;

	param->retval = find_line_range_by_line(in_die, param->data);
1203 1204 1205
	return DWARF_CB_ABORT;	/* No need to find other instances */
}

1206
/* Search function from function name */
1207
static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1208
{
1209 1210
	struct dwarf_callback_param *param = data;
	struct line_finder *lf = param->data;
1211 1212
	struct line_range *lr = lf->lr;

1213 1214 1215 1216
	if (dwarf_tag(sp_die) == DW_TAG_subprogram &&
	    die_compare_name(sp_die, lr->function) == 0) {
		lf->fname = dwarf_decl_file(sp_die);
		dwarf_decl_line(sp_die, &lr->offset);
1217
		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1218
		lf->lno_s = lr->offset + lr->start;
1219 1220 1221 1222
		if (lf->lno_s < 0)	/* Overflow */
			lf->lno_s = INT_MAX;
		lf->lno_e = lr->offset + lr->end;
		if (lf->lno_e < 0)	/* Overflow */
1223
			lf->lno_e = INT_MAX;
1224
		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1225 1226
		lr->start = lf->lno_s;
		lr->end = lf->lno_e;
1227 1228 1229 1230
		if (dwarf_func_inline(sp_die)) {
			struct dwarf_callback_param _param;
			_param.data = (void *)lf;
			_param.retval = 0;
1231
			dwarf_func_inline_instances(sp_die,
1232 1233 1234 1235 1236 1237
						    line_range_inline_cb,
						    &_param);
			param->retval = _param.retval;
		} else
			param->retval = find_line_range_by_line(sp_die, lf);
		return DWARF_CB_ABORT;
1238
	}
1239
	return DWARF_CB_OK;
1240 1241
}

1242
static int find_line_range_by_func(struct line_finder *lf)
1243
{
1244 1245 1246
	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
	return param.retval;
1247 1248 1249 1250
}

int find_line_range(int fd, struct line_range *lr)
{
1251
	struct line_finder lf = {.lr = lr, .found = 0};
1252
	int ret = 0;
1253 1254 1255 1256 1257 1258
	Dwarf_Off off = 0, noff;
	size_t cuhl;
	Dwarf_Die *diep;
	Dwarf *dbg;

	dbg = dwarf_begin(fd, DWARF_C_READ);
1259 1260 1261 1262 1263
	if (!dbg) {
		pr_warning("No dwarf info found in the vmlinux - "
			"please rebuild with CONFIG_DEBUG_INFO=y.\n");
		return -EBADF;
	}
1264

1265
	/* Loop on CUs (Compilation Unit) */
1266 1267
	while (!lf.found && ret >= 0) {
		if (dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL) != 0)
1268 1269 1270
			break;

		/* Get the DIE(Debugging Information Entry) of this CU */
1271 1272 1273
		diep = dwarf_offdie(dbg, off + cuhl, &lf.cu_die);
		if (!diep)
			continue;
1274 1275 1276

		/* Check if target file is included. */
		if (lr->file)
1277
			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1278
		else
1279
			lf.fname = 0;
1280

1281
		if (!lr->file || lf.fname) {
1282
			if (lr->function)
1283
				ret = find_line_range_by_func(&lf);
1284 1285
			else {
				lf.lno_s = lr->start;
1286
				lf.lno_e = lr->end;
1287
				ret = find_line_range_by_line(NULL, &lf);
1288 1289
			}
		}
1290
		off = noff;
1291
	}
1292 1293
	pr_debug("path: %lx\n", (unsigned long)lr->path);
	dwarf_end(dbg);
1294 1295

	return (ret < 0) ? ret : lf.found;
1296 1297
}