xref: /linux/tools/perf/util/probe-finder.c (revision 827634added7f38b7d724cab1dccdb2b004c13c3)
1 /*
2  * probe-finder.c : C expression to kprobe event converter
3  *
4  * Written by Masami Hiramatsu <mhiramat@redhat.com>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  *
20  */
21 
22 #include <sys/utsname.h>
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #include <fcntl.h>
26 #include <errno.h>
27 #include <stdio.h>
28 #include <unistd.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <stdarg.h>
32 #include <dwarf-regs.h>
33 
34 #include <linux/bitops.h>
35 #include "event.h"
36 #include "dso.h"
37 #include "debug.h"
38 #include "intlist.h"
39 #include "util.h"
40 #include "symbol.h"
41 #include "probe-finder.h"
42 
43 /* Kprobe tracer basic type is up to u64 */
44 #define MAX_BASIC_TYPE_BITS	64
45 
46 /* Dwarf FL wrappers */
47 static char *debuginfo_path;	/* Currently dummy */
48 
49 static const Dwfl_Callbacks offline_callbacks = {
50 	.find_debuginfo = dwfl_standard_find_debuginfo,
51 	.debuginfo_path = &debuginfo_path,
52 
53 	.section_address = dwfl_offline_section_address,
54 
55 	/* We use this table for core files too.  */
56 	.find_elf = dwfl_build_id_find_elf,
57 };
58 
59 /* Get a Dwarf from offline image */
60 static int debuginfo__init_offline_dwarf(struct debuginfo *dbg,
61 					 const char *path)
62 {
63 	int fd;
64 
65 	fd = open(path, O_RDONLY);
66 	if (fd < 0)
67 		return fd;
68 
69 	dbg->dwfl = dwfl_begin(&offline_callbacks);
70 	if (!dbg->dwfl)
71 		goto error;
72 
73 	dbg->mod = dwfl_report_offline(dbg->dwfl, "", "", fd);
74 	if (!dbg->mod)
75 		goto error;
76 
77 	dbg->dbg = dwfl_module_getdwarf(dbg->mod, &dbg->bias);
78 	if (!dbg->dbg)
79 		goto error;
80 
81 	return 0;
82 error:
83 	if (dbg->dwfl)
84 		dwfl_end(dbg->dwfl);
85 	else
86 		close(fd);
87 	memset(dbg, 0, sizeof(*dbg));
88 
89 	return -ENOENT;
90 }
91 
92 static struct debuginfo *__debuginfo__new(const char *path)
93 {
94 	struct debuginfo *dbg = zalloc(sizeof(*dbg));
95 	if (!dbg)
96 		return NULL;
97 
98 	if (debuginfo__init_offline_dwarf(dbg, path) < 0)
99 		zfree(&dbg);
100 	if (dbg)
101 		pr_debug("Open Debuginfo file: %s\n", path);
102 	return dbg;
103 }
104 
105 enum dso_binary_type distro_dwarf_types[] = {
106 	DSO_BINARY_TYPE__FEDORA_DEBUGINFO,
107 	DSO_BINARY_TYPE__UBUNTU_DEBUGINFO,
108 	DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO,
109 	DSO_BINARY_TYPE__BUILDID_DEBUGINFO,
110 	DSO_BINARY_TYPE__NOT_FOUND,
111 };
112 
113 struct debuginfo *debuginfo__new(const char *path)
114 {
115 	enum dso_binary_type *type;
116 	char buf[PATH_MAX], nil = '\0';
117 	struct dso *dso;
118 	struct debuginfo *dinfo = NULL;
119 
120 	/* Try to open distro debuginfo files */
121 	dso = dso__new(path);
122 	if (!dso)
123 		goto out;
124 
125 	for (type = distro_dwarf_types;
126 	     !dinfo && *type != DSO_BINARY_TYPE__NOT_FOUND;
127 	     type++) {
128 		if (dso__read_binary_type_filename(dso, *type, &nil,
129 						   buf, PATH_MAX) < 0)
130 			continue;
131 		dinfo = __debuginfo__new(buf);
132 	}
133 	dso__delete(dso);
134 
135 out:
136 	/* if failed to open all distro debuginfo, open given binary */
137 	return dinfo ? : __debuginfo__new(path);
138 }
139 
140 void debuginfo__delete(struct debuginfo *dbg)
141 {
142 	if (dbg) {
143 		if (dbg->dwfl)
144 			dwfl_end(dbg->dwfl);
145 		free(dbg);
146 	}
147 }
148 
149 /*
150  * Probe finder related functions
151  */
152 
153 static struct probe_trace_arg_ref *alloc_trace_arg_ref(long offs)
154 {
155 	struct probe_trace_arg_ref *ref;
156 	ref = zalloc(sizeof(struct probe_trace_arg_ref));
157 	if (ref != NULL)
158 		ref->offset = offs;
159 	return ref;
160 }
161 
162 /*
163  * Convert a location into trace_arg.
164  * If tvar == NULL, this just checks variable can be converted.
165  * If fentry == true and vr_die is a parameter, do huristic search
166  * for the location fuzzed by function entry mcount.
167  */
168 static int convert_variable_location(Dwarf_Die *vr_die, Dwarf_Addr addr,
169 				     Dwarf_Op *fb_ops, Dwarf_Die *sp_die,
170 				     struct probe_trace_arg *tvar)
171 {
172 	Dwarf_Attribute attr;
173 	Dwarf_Addr tmp = 0;
174 	Dwarf_Op *op;
175 	size_t nops;
176 	unsigned int regn;
177 	Dwarf_Word offs = 0;
178 	bool ref = false;
179 	const char *regs;
180 	int ret;
181 
182 	if (dwarf_attr(vr_die, DW_AT_external, &attr) != NULL)
183 		goto static_var;
184 
185 	/* TODO: handle more than 1 exprs */
186 	if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
187 		return -EINVAL;	/* Broken DIE ? */
188 	if (dwarf_getlocation_addr(&attr, addr, &op, &nops, 1) <= 0) {
189 		ret = dwarf_entrypc(sp_die, &tmp);
190 		if (ret || addr != tmp ||
191 		    dwarf_tag(vr_die) != DW_TAG_formal_parameter ||
192 		    dwarf_highpc(sp_die, &tmp))
193 			return -ENOENT;
194 		/*
195 		 * This is fuzzed by fentry mcount. We try to find the
196 		 * parameter location at the earliest address.
197 		 */
198 		for (addr += 1; addr <= tmp; addr++) {
199 			if (dwarf_getlocation_addr(&attr, addr, &op,
200 						   &nops, 1) > 0)
201 				goto found;
202 		}
203 		return -ENOENT;
204 	}
205 found:
206 	if (nops == 0)
207 		/* TODO: Support const_value */
208 		return -ENOENT;
209 
210 	if (op->atom == DW_OP_addr) {
211 static_var:
212 		if (!tvar)
213 			return 0;
214 		/* Static variables on memory (not stack), make @varname */
215 		ret = strlen(dwarf_diename(vr_die));
216 		tvar->value = zalloc(ret + 2);
217 		if (tvar->value == NULL)
218 			return -ENOMEM;
219 		snprintf(tvar->value, ret + 2, "@%s", dwarf_diename(vr_die));
220 		tvar->ref = alloc_trace_arg_ref((long)offs);
221 		if (tvar->ref == NULL)
222 			return -ENOMEM;
223 		return 0;
224 	}
225 
226 	/* If this is based on frame buffer, set the offset */
227 	if (op->atom == DW_OP_fbreg) {
228 		if (fb_ops == NULL)
229 			return -ENOTSUP;
230 		ref = true;
231 		offs = op->number;
232 		op = &fb_ops[0];
233 	}
234 
235 	if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
236 		regn = op->atom - DW_OP_breg0;
237 		offs += op->number;
238 		ref = true;
239 	} else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
240 		regn = op->atom - DW_OP_reg0;
241 	} else if (op->atom == DW_OP_bregx) {
242 		regn = op->number;
243 		offs += op->number2;
244 		ref = true;
245 	} else if (op->atom == DW_OP_regx) {
246 		regn = op->number;
247 	} else {
248 		pr_debug("DW_OP %x is not supported.\n", op->atom);
249 		return -ENOTSUP;
250 	}
251 
252 	if (!tvar)
253 		return 0;
254 
255 	regs = get_arch_regstr(regn);
256 	if (!regs) {
257 		/* This should be a bug in DWARF or this tool */
258 		pr_warning("Mapping for the register number %u "
259 			   "missing on this architecture.\n", regn);
260 		return -ERANGE;
261 	}
262 
263 	tvar->value = strdup(regs);
264 	if (tvar->value == NULL)
265 		return -ENOMEM;
266 
267 	if (ref) {
268 		tvar->ref = alloc_trace_arg_ref((long)offs);
269 		if (tvar->ref == NULL)
270 			return -ENOMEM;
271 	}
272 	return 0;
273 }
274 
275 #define BYTES_TO_BITS(nb)	((nb) * BITS_PER_LONG / sizeof(long))
276 
277 static int convert_variable_type(Dwarf_Die *vr_die,
278 				 struct probe_trace_arg *tvar,
279 				 const char *cast)
280 {
281 	struct probe_trace_arg_ref **ref_ptr = &tvar->ref;
282 	Dwarf_Die type;
283 	char buf[16];
284 	char sbuf[STRERR_BUFSIZE];
285 	int bsize, boffs, total;
286 	int ret;
287 
288 	/* TODO: check all types */
289 	if (cast && strcmp(cast, "string") != 0) {
290 		/* Non string type is OK */
291 		tvar->type = strdup(cast);
292 		return (tvar->type == NULL) ? -ENOMEM : 0;
293 	}
294 
295 	bsize = dwarf_bitsize(vr_die);
296 	if (bsize > 0) {
297 		/* This is a bitfield */
298 		boffs = dwarf_bitoffset(vr_die);
299 		total = dwarf_bytesize(vr_die);
300 		if (boffs < 0 || total < 0)
301 			return -ENOENT;
302 		ret = snprintf(buf, 16, "b%d@%d/%zd", bsize, boffs,
303 				BYTES_TO_BITS(total));
304 		goto formatted;
305 	}
306 
307 	if (die_get_real_type(vr_die, &type) == NULL) {
308 		pr_warning("Failed to get a type information of %s.\n",
309 			   dwarf_diename(vr_die));
310 		return -ENOENT;
311 	}
312 
313 	pr_debug("%s type is %s.\n",
314 		 dwarf_diename(vr_die), dwarf_diename(&type));
315 
316 	if (cast && strcmp(cast, "string") == 0) {	/* String type */
317 		ret = dwarf_tag(&type);
318 		if (ret != DW_TAG_pointer_type &&
319 		    ret != DW_TAG_array_type) {
320 			pr_warning("Failed to cast into string: "
321 				   "%s(%s) is not a pointer nor array.\n",
322 				   dwarf_diename(vr_die), dwarf_diename(&type));
323 			return -EINVAL;
324 		}
325 		if (die_get_real_type(&type, &type) == NULL) {
326 			pr_warning("Failed to get a type"
327 				   " information.\n");
328 			return -ENOENT;
329 		}
330 		if (ret == DW_TAG_pointer_type) {
331 			while (*ref_ptr)
332 				ref_ptr = &(*ref_ptr)->next;
333 			/* Add new reference with offset +0 */
334 			*ref_ptr = zalloc(sizeof(struct probe_trace_arg_ref));
335 			if (*ref_ptr == NULL) {
336 				pr_warning("Out of memory error\n");
337 				return -ENOMEM;
338 			}
339 		}
340 		if (!die_compare_name(&type, "char") &&
341 		    !die_compare_name(&type, "unsigned char")) {
342 			pr_warning("Failed to cast into string: "
343 				   "%s is not (unsigned) char *.\n",
344 				   dwarf_diename(vr_die));
345 			return -EINVAL;
346 		}
347 		tvar->type = strdup(cast);
348 		return (tvar->type == NULL) ? -ENOMEM : 0;
349 	}
350 
351 	ret = dwarf_bytesize(&type);
352 	if (ret <= 0)
353 		/* No size ... try to use default type */
354 		return 0;
355 	ret = BYTES_TO_BITS(ret);
356 
357 	/* Check the bitwidth */
358 	if (ret > MAX_BASIC_TYPE_BITS) {
359 		pr_info("%s exceeds max-bitwidth. Cut down to %d bits.\n",
360 			dwarf_diename(&type), MAX_BASIC_TYPE_BITS);
361 		ret = MAX_BASIC_TYPE_BITS;
362 	}
363 	ret = snprintf(buf, 16, "%c%d",
364 		       die_is_signed_type(&type) ? 's' : 'u', ret);
365 
366 formatted:
367 	if (ret < 0 || ret >= 16) {
368 		if (ret >= 16)
369 			ret = -E2BIG;
370 		pr_warning("Failed to convert variable type: %s\n",
371 			   strerror_r(-ret, sbuf, sizeof(sbuf)));
372 		return ret;
373 	}
374 	tvar->type = strdup(buf);
375 	if (tvar->type == NULL)
376 		return -ENOMEM;
377 	return 0;
378 }
379 
380 static int convert_variable_fields(Dwarf_Die *vr_die, const char *varname,
381 				    struct perf_probe_arg_field *field,
382 				    struct probe_trace_arg_ref **ref_ptr,
383 				    Dwarf_Die *die_mem)
384 {
385 	struct probe_trace_arg_ref *ref = *ref_ptr;
386 	Dwarf_Die type;
387 	Dwarf_Word offs;
388 	int ret, tag;
389 
390 	pr_debug("converting %s in %s\n", field->name, varname);
391 	if (die_get_real_type(vr_die, &type) == NULL) {
392 		pr_warning("Failed to get the type of %s.\n", varname);
393 		return -ENOENT;
394 	}
395 	pr_debug2("Var real type: (%x)\n", (unsigned)dwarf_dieoffset(&type));
396 	tag = dwarf_tag(&type);
397 
398 	if (field->name[0] == '[' &&
399 	    (tag == DW_TAG_array_type || tag == DW_TAG_pointer_type)) {
400 		if (field->next)
401 			/* Save original type for next field */
402 			memcpy(die_mem, &type, sizeof(*die_mem));
403 		/* Get the type of this array */
404 		if (die_get_real_type(&type, &type) == NULL) {
405 			pr_warning("Failed to get the type of %s.\n", varname);
406 			return -ENOENT;
407 		}
408 		pr_debug2("Array real type: (%x)\n",
409 			 (unsigned)dwarf_dieoffset(&type));
410 		if (tag == DW_TAG_pointer_type) {
411 			ref = zalloc(sizeof(struct probe_trace_arg_ref));
412 			if (ref == NULL)
413 				return -ENOMEM;
414 			if (*ref_ptr)
415 				(*ref_ptr)->next = ref;
416 			else
417 				*ref_ptr = ref;
418 		}
419 		ref->offset += dwarf_bytesize(&type) * field->index;
420 		if (!field->next)
421 			/* Save vr_die for converting types */
422 			memcpy(die_mem, vr_die, sizeof(*die_mem));
423 		goto next;
424 	} else if (tag == DW_TAG_pointer_type) {
425 		/* Check the pointer and dereference */
426 		if (!field->ref) {
427 			pr_err("Semantic error: %s must be referred by '->'\n",
428 			       field->name);
429 			return -EINVAL;
430 		}
431 		/* Get the type pointed by this pointer */
432 		if (die_get_real_type(&type, &type) == NULL) {
433 			pr_warning("Failed to get the type of %s.\n", varname);
434 			return -ENOENT;
435 		}
436 		/* Verify it is a data structure  */
437 		tag = dwarf_tag(&type);
438 		if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
439 			pr_warning("%s is not a data structure nor an union.\n",
440 				   varname);
441 			return -EINVAL;
442 		}
443 
444 		ref = zalloc(sizeof(struct probe_trace_arg_ref));
445 		if (ref == NULL)
446 			return -ENOMEM;
447 		if (*ref_ptr)
448 			(*ref_ptr)->next = ref;
449 		else
450 			*ref_ptr = ref;
451 	} else {
452 		/* Verify it is a data structure  */
453 		if (tag != DW_TAG_structure_type && tag != DW_TAG_union_type) {
454 			pr_warning("%s is not a data structure nor an union.\n",
455 				   varname);
456 			return -EINVAL;
457 		}
458 		if (field->name[0] == '[') {
459 			pr_err("Semantic error: %s is not a pointer"
460 			       " nor array.\n", varname);
461 			return -EINVAL;
462 		}
463 		/* While prcessing unnamed field, we don't care about this */
464 		if (field->ref && dwarf_diename(vr_die)) {
465 			pr_err("Semantic error: %s must be referred by '.'\n",
466 			       field->name);
467 			return -EINVAL;
468 		}
469 		if (!ref) {
470 			pr_warning("Structure on a register is not "
471 				   "supported yet.\n");
472 			return -ENOTSUP;
473 		}
474 	}
475 
476 	if (die_find_member(&type, field->name, die_mem) == NULL) {
477 		pr_warning("%s(type:%s) has no member %s.\n", varname,
478 			   dwarf_diename(&type), field->name);
479 		return -EINVAL;
480 	}
481 
482 	/* Get the offset of the field */
483 	if (tag == DW_TAG_union_type) {
484 		offs = 0;
485 	} else {
486 		ret = die_get_data_member_location(die_mem, &offs);
487 		if (ret < 0) {
488 			pr_warning("Failed to get the offset of %s.\n",
489 				   field->name);
490 			return ret;
491 		}
492 	}
493 	ref->offset += (long)offs;
494 
495 	/* If this member is unnamed, we need to reuse this field */
496 	if (!dwarf_diename(die_mem))
497 		return convert_variable_fields(die_mem, varname, field,
498 						&ref, die_mem);
499 
500 next:
501 	/* Converting next field */
502 	if (field->next)
503 		return convert_variable_fields(die_mem, field->name,
504 					field->next, &ref, die_mem);
505 	else
506 		return 0;
507 }
508 
509 /* Show a variables in kprobe event format */
510 static int convert_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
511 {
512 	Dwarf_Die die_mem;
513 	int ret;
514 
515 	pr_debug("Converting variable %s into trace event.\n",
516 		 dwarf_diename(vr_die));
517 
518 	ret = convert_variable_location(vr_die, pf->addr, pf->fb_ops,
519 					&pf->sp_die, pf->tvar);
520 	if (ret == -ENOENT || ret == -EINVAL)
521 		pr_err("Failed to find the location of %s at this address.\n"
522 		       " Perhaps, it has been optimized out.\n", pf->pvar->var);
523 	else if (ret == -ENOTSUP)
524 		pr_err("Sorry, we don't support this variable location yet.\n");
525 	else if (ret == 0 && pf->pvar->field) {
526 		ret = convert_variable_fields(vr_die, pf->pvar->var,
527 					      pf->pvar->field, &pf->tvar->ref,
528 					      &die_mem);
529 		vr_die = &die_mem;
530 	}
531 	if (ret == 0)
532 		ret = convert_variable_type(vr_die, pf->tvar, pf->pvar->type);
533 	/* *expr will be cached in libdw. Don't free it. */
534 	return ret;
535 }
536 
537 /* Find a variable in a scope DIE */
538 static int find_variable(Dwarf_Die *sc_die, struct probe_finder *pf)
539 {
540 	Dwarf_Die vr_die;
541 	char buf[32], *ptr;
542 	int ret = 0;
543 
544 	if (!is_c_varname(pf->pvar->var)) {
545 		/* Copy raw parameters */
546 		pf->tvar->value = strdup(pf->pvar->var);
547 		if (pf->tvar->value == NULL)
548 			return -ENOMEM;
549 		if (pf->pvar->type) {
550 			pf->tvar->type = strdup(pf->pvar->type);
551 			if (pf->tvar->type == NULL)
552 				return -ENOMEM;
553 		}
554 		if (pf->pvar->name) {
555 			pf->tvar->name = strdup(pf->pvar->name);
556 			if (pf->tvar->name == NULL)
557 				return -ENOMEM;
558 		} else
559 			pf->tvar->name = NULL;
560 		return 0;
561 	}
562 
563 	if (pf->pvar->name)
564 		pf->tvar->name = strdup(pf->pvar->name);
565 	else {
566 		ret = synthesize_perf_probe_arg(pf->pvar, buf, 32);
567 		if (ret < 0)
568 			return ret;
569 		ptr = strchr(buf, ':');	/* Change type separator to _ */
570 		if (ptr)
571 			*ptr = '_';
572 		pf->tvar->name = strdup(buf);
573 	}
574 	if (pf->tvar->name == NULL)
575 		return -ENOMEM;
576 
577 	pr_debug("Searching '%s' variable in context.\n", pf->pvar->var);
578 	/* Search child die for local variables and parameters. */
579 	if (!die_find_variable_at(sc_die, pf->pvar->var, pf->addr, &vr_die)) {
580 		/* Search again in global variables */
581 		if (!die_find_variable_at(&pf->cu_die, pf->pvar->var, 0, &vr_die))
582 			pr_warning("Failed to find '%s' in this function.\n",
583 				   pf->pvar->var);
584 			ret = -ENOENT;
585 	}
586 	if (ret >= 0)
587 		ret = convert_variable(&vr_die, pf);
588 
589 	return ret;
590 }
591 
592 /* Convert subprogram DIE to trace point */
593 static int convert_to_trace_point(Dwarf_Die *sp_die, Dwfl_Module *mod,
594 				  Dwarf_Addr paddr, bool retprobe,
595 				  struct probe_trace_point *tp)
596 {
597 	Dwarf_Addr eaddr, highaddr;
598 	GElf_Sym sym;
599 	const char *symbol;
600 
601 	/* Verify the address is correct */
602 	if (dwarf_entrypc(sp_die, &eaddr) != 0) {
603 		pr_warning("Failed to get entry address of %s\n",
604 			   dwarf_diename(sp_die));
605 		return -ENOENT;
606 	}
607 	if (dwarf_highpc(sp_die, &highaddr) != 0) {
608 		pr_warning("Failed to get end address of %s\n",
609 			   dwarf_diename(sp_die));
610 		return -ENOENT;
611 	}
612 	if (paddr > highaddr) {
613 		pr_warning("Offset specified is greater than size of %s\n",
614 			   dwarf_diename(sp_die));
615 		return -EINVAL;
616 	}
617 
618 	symbol = dwarf_diename(sp_die);
619 	if (!symbol) {
620 		/* Try to get the symbol name from symtab */
621 		symbol = dwfl_module_addrsym(mod, paddr, &sym, NULL);
622 		if (!symbol) {
623 			pr_warning("Failed to find symbol at 0x%lx\n",
624 				   (unsigned long)paddr);
625 			return -ENOENT;
626 		}
627 		eaddr = sym.st_value;
628 	}
629 	tp->offset = (unsigned long)(paddr - eaddr);
630 	tp->address = (unsigned long)paddr;
631 	tp->symbol = strdup(symbol);
632 	if (!tp->symbol)
633 		return -ENOMEM;
634 
635 	/* Return probe must be on the head of a subprogram */
636 	if (retprobe) {
637 		if (eaddr != paddr) {
638 			pr_warning("Return probe must be on the head of"
639 				   " a real function.\n");
640 			return -EINVAL;
641 		}
642 		tp->retprobe = true;
643 	}
644 
645 	return 0;
646 }
647 
648 /* Call probe_finder callback with scope DIE */
649 static int call_probe_finder(Dwarf_Die *sc_die, struct probe_finder *pf)
650 {
651 	Dwarf_Attribute fb_attr;
652 	size_t nops;
653 	int ret;
654 
655 	if (!sc_die) {
656 		pr_err("Caller must pass a scope DIE. Program error.\n");
657 		return -EINVAL;
658 	}
659 
660 	/* If not a real subprogram, find a real one */
661 	if (!die_is_func_def(sc_die)) {
662 		if (!die_find_realfunc(&pf->cu_die, pf->addr, &pf->sp_die)) {
663 			pr_warning("Failed to find probe point in any "
664 				   "functions.\n");
665 			return -ENOENT;
666 		}
667 	} else
668 		memcpy(&pf->sp_die, sc_die, sizeof(Dwarf_Die));
669 
670 	/* Get the frame base attribute/ops from subprogram */
671 	dwarf_attr(&pf->sp_die, DW_AT_frame_base, &fb_attr);
672 	ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
673 	if (ret <= 0 || nops == 0) {
674 		pf->fb_ops = NULL;
675 #if _ELFUTILS_PREREQ(0, 142)
676 	} else if (nops == 1 && pf->fb_ops[0].atom == DW_OP_call_frame_cfa &&
677 		   pf->cfi != NULL) {
678 		Dwarf_Frame *frame;
679 		if (dwarf_cfi_addrframe(pf->cfi, pf->addr, &frame) != 0 ||
680 		    dwarf_frame_cfa(frame, &pf->fb_ops, &nops) != 0) {
681 			pr_warning("Failed to get call frame on 0x%jx\n",
682 				   (uintmax_t)pf->addr);
683 			return -ENOENT;
684 		}
685 #endif
686 	}
687 
688 	/* Call finder's callback handler */
689 	ret = pf->callback(sc_die, pf);
690 
691 	/* *pf->fb_ops will be cached in libdw. Don't free it. */
692 	pf->fb_ops = NULL;
693 
694 	return ret;
695 }
696 
697 struct find_scope_param {
698 	const char *function;
699 	const char *file;
700 	int line;
701 	int diff;
702 	Dwarf_Die *die_mem;
703 	bool found;
704 };
705 
706 static int find_best_scope_cb(Dwarf_Die *fn_die, void *data)
707 {
708 	struct find_scope_param *fsp = data;
709 	const char *file;
710 	int lno;
711 
712 	/* Skip if declared file name does not match */
713 	if (fsp->file) {
714 		file = dwarf_decl_file(fn_die);
715 		if (!file || strcmp(fsp->file, file) != 0)
716 			return 0;
717 	}
718 	/* If the function name is given, that's what user expects */
719 	if (fsp->function) {
720 		if (die_compare_name(fn_die, fsp->function)) {
721 			memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
722 			fsp->found = true;
723 			return 1;
724 		}
725 	} else {
726 		/* With the line number, find the nearest declared DIE */
727 		dwarf_decl_line(fn_die, &lno);
728 		if (lno < fsp->line && fsp->diff > fsp->line - lno) {
729 			/* Keep a candidate and continue */
730 			fsp->diff = fsp->line - lno;
731 			memcpy(fsp->die_mem, fn_die, sizeof(Dwarf_Die));
732 			fsp->found = true;
733 		}
734 	}
735 	return 0;
736 }
737 
738 /* Find an appropriate scope fits to given conditions */
739 static Dwarf_Die *find_best_scope(struct probe_finder *pf, Dwarf_Die *die_mem)
740 {
741 	struct find_scope_param fsp = {
742 		.function = pf->pev->point.function,
743 		.file = pf->fname,
744 		.line = pf->lno,
745 		.diff = INT_MAX,
746 		.die_mem = die_mem,
747 		.found = false,
748 	};
749 
750 	cu_walk_functions_at(&pf->cu_die, pf->addr, find_best_scope_cb, &fsp);
751 
752 	return fsp.found ? die_mem : NULL;
753 }
754 
755 static int probe_point_line_walker(const char *fname, int lineno,
756 				   Dwarf_Addr addr, void *data)
757 {
758 	struct probe_finder *pf = data;
759 	Dwarf_Die *sc_die, die_mem;
760 	int ret;
761 
762 	if (lineno != pf->lno || strtailcmp(fname, pf->fname) != 0)
763 		return 0;
764 
765 	pf->addr = addr;
766 	sc_die = find_best_scope(pf, &die_mem);
767 	if (!sc_die) {
768 		pr_warning("Failed to find scope of probe point.\n");
769 		return -ENOENT;
770 	}
771 
772 	ret = call_probe_finder(sc_die, pf);
773 
774 	/* Continue if no error, because the line will be in inline function */
775 	return ret < 0 ? ret : 0;
776 }
777 
778 /* Find probe point from its line number */
779 static int find_probe_point_by_line(struct probe_finder *pf)
780 {
781 	return die_walk_lines(&pf->cu_die, probe_point_line_walker, pf);
782 }
783 
784 /* Find lines which match lazy pattern */
785 static int find_lazy_match_lines(struct intlist *list,
786 				 const char *fname, const char *pat)
787 {
788 	FILE *fp;
789 	char *line = NULL;
790 	size_t line_len;
791 	ssize_t len;
792 	int count = 0, linenum = 1;
793 	char sbuf[STRERR_BUFSIZE];
794 
795 	fp = fopen(fname, "r");
796 	if (!fp) {
797 		pr_warning("Failed to open %s: %s\n", fname,
798 			   strerror_r(errno, sbuf, sizeof(sbuf)));
799 		return -errno;
800 	}
801 
802 	while ((len = getline(&line, &line_len, fp)) > 0) {
803 
804 		if (line[len - 1] == '\n')
805 			line[len - 1] = '\0';
806 
807 		if (strlazymatch(line, pat)) {
808 			intlist__add(list, linenum);
809 			count++;
810 		}
811 		linenum++;
812 	}
813 
814 	if (ferror(fp))
815 		count = -errno;
816 	free(line);
817 	fclose(fp);
818 
819 	if (count == 0)
820 		pr_debug("No matched lines found in %s.\n", fname);
821 	return count;
822 }
823 
824 static int probe_point_lazy_walker(const char *fname, int lineno,
825 				   Dwarf_Addr addr, void *data)
826 {
827 	struct probe_finder *pf = data;
828 	Dwarf_Die *sc_die, die_mem;
829 	int ret;
830 
831 	if (!intlist__has_entry(pf->lcache, lineno) ||
832 	    strtailcmp(fname, pf->fname) != 0)
833 		return 0;
834 
835 	pr_debug("Probe line found: line:%d addr:0x%llx\n",
836 		 lineno, (unsigned long long)addr);
837 	pf->addr = addr;
838 	pf->lno = lineno;
839 	sc_die = find_best_scope(pf, &die_mem);
840 	if (!sc_die) {
841 		pr_warning("Failed to find scope of probe point.\n");
842 		return -ENOENT;
843 	}
844 
845 	ret = call_probe_finder(sc_die, pf);
846 
847 	/*
848 	 * Continue if no error, because the lazy pattern will match
849 	 * to other lines
850 	 */
851 	return ret < 0 ? ret : 0;
852 }
853 
854 /* Find probe points from lazy pattern  */
855 static int find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
856 {
857 	int ret = 0;
858 	char *fpath;
859 
860 	if (intlist__empty(pf->lcache)) {
861 		const char *comp_dir;
862 
863 		comp_dir = cu_get_comp_dir(&pf->cu_die);
864 		ret = get_real_path(pf->fname, comp_dir, &fpath);
865 		if (ret < 0) {
866 			pr_warning("Failed to find source file path.\n");
867 			return ret;
868 		}
869 
870 		/* Matching lazy line pattern */
871 		ret = find_lazy_match_lines(pf->lcache, fpath,
872 					    pf->pev->point.lazy_line);
873 		free(fpath);
874 		if (ret <= 0)
875 			return ret;
876 	}
877 
878 	return die_walk_lines(sp_die, probe_point_lazy_walker, pf);
879 }
880 
881 static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
882 {
883 	struct probe_finder *pf = data;
884 	struct perf_probe_point *pp = &pf->pev->point;
885 	Dwarf_Addr addr;
886 	int ret;
887 
888 	if (pp->lazy_line)
889 		ret = find_probe_point_lazy(in_die, pf);
890 	else {
891 		/* Get probe address */
892 		if (dwarf_entrypc(in_die, &addr) != 0) {
893 			pr_warning("Failed to get entry address of %s.\n",
894 				   dwarf_diename(in_die));
895 			return -ENOENT;
896 		}
897 		pf->addr = addr;
898 		pf->addr += pp->offset;
899 		pr_debug("found inline addr: 0x%jx\n",
900 			 (uintmax_t)pf->addr);
901 
902 		ret = call_probe_finder(in_die, pf);
903 	}
904 
905 	return ret;
906 }
907 
908 /* Callback parameter with return value for libdw */
909 struct dwarf_callback_param {
910 	void *data;
911 	int retval;
912 };
913 
914 /* Search function from function name */
915 static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
916 {
917 	struct dwarf_callback_param *param = data;
918 	struct probe_finder *pf = param->data;
919 	struct perf_probe_point *pp = &pf->pev->point;
920 
921 	/* Check tag and diename */
922 	if (!die_is_func_def(sp_die) ||
923 	    !die_compare_name(sp_die, pp->function))
924 		return DWARF_CB_OK;
925 
926 	/* Check declared file */
927 	if (pp->file && strtailcmp(pp->file, dwarf_decl_file(sp_die)))
928 		return DWARF_CB_OK;
929 
930 	pf->fname = dwarf_decl_file(sp_die);
931 	if (pp->line) { /* Function relative line */
932 		dwarf_decl_line(sp_die, &pf->lno);
933 		pf->lno += pp->line;
934 		param->retval = find_probe_point_by_line(pf);
935 	} else if (die_is_func_instance(sp_die)) {
936 		/* Instances always have the entry address */
937 		dwarf_entrypc(sp_die, &pf->addr);
938 		/* Real function */
939 		if (pp->lazy_line)
940 			param->retval = find_probe_point_lazy(sp_die, pf);
941 		else {
942 			pf->addr += pp->offset;
943 			/* TODO: Check the address in this function */
944 			param->retval = call_probe_finder(sp_die, pf);
945 		}
946 	} else
947 		/* Inlined function: search instances */
948 		param->retval = die_walk_instances(sp_die,
949 					probe_point_inline_cb, (void *)pf);
950 
951 	return DWARF_CB_ABORT; /* Exit; no same symbol in this CU. */
952 }
953 
954 static int find_probe_point_by_func(struct probe_finder *pf)
955 {
956 	struct dwarf_callback_param _param = {.data = (void *)pf,
957 					      .retval = 0};
958 	dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, &_param, 0);
959 	return _param.retval;
960 }
961 
962 struct pubname_callback_param {
963 	char *function;
964 	char *file;
965 	Dwarf_Die *cu_die;
966 	Dwarf_Die *sp_die;
967 	int found;
968 };
969 
970 static int pubname_search_cb(Dwarf *dbg, Dwarf_Global *gl, void *data)
971 {
972 	struct pubname_callback_param *param = data;
973 
974 	if (dwarf_offdie(dbg, gl->die_offset, param->sp_die)) {
975 		if (dwarf_tag(param->sp_die) != DW_TAG_subprogram)
976 			return DWARF_CB_OK;
977 
978 		if (die_compare_name(param->sp_die, param->function)) {
979 			if (!dwarf_offdie(dbg, gl->cu_offset, param->cu_die))
980 				return DWARF_CB_OK;
981 
982 			if (param->file &&
983 			    strtailcmp(param->file, dwarf_decl_file(param->sp_die)))
984 				return DWARF_CB_OK;
985 
986 			param->found = 1;
987 			return DWARF_CB_ABORT;
988 		}
989 	}
990 
991 	return DWARF_CB_OK;
992 }
993 
994 /* Find probe points from debuginfo */
995 static int debuginfo__find_probes(struct debuginfo *dbg,
996 				  struct probe_finder *pf)
997 {
998 	struct perf_probe_point *pp = &pf->pev->point;
999 	Dwarf_Off off, noff;
1000 	size_t cuhl;
1001 	Dwarf_Die *diep;
1002 	int ret = 0;
1003 
1004 #if _ELFUTILS_PREREQ(0, 142)
1005 	Elf *elf;
1006 	GElf_Ehdr ehdr;
1007 	GElf_Shdr shdr;
1008 
1009 	/* Get the call frame information from this dwarf */
1010 	elf = dwarf_getelf(dbg->dbg);
1011 	if (elf == NULL)
1012 		return -EINVAL;
1013 
1014 	if (gelf_getehdr(elf, &ehdr) == NULL)
1015 		return -EINVAL;
1016 
1017 	if (elf_section_by_name(elf, &ehdr, &shdr, ".eh_frame", NULL) &&
1018 	    shdr.sh_type == SHT_PROGBITS) {
1019 		pf->cfi = dwarf_getcfi_elf(elf);
1020 	} else {
1021 		pf->cfi = dwarf_getcfi(dbg->dbg);
1022 	}
1023 #endif
1024 
1025 	off = 0;
1026 	pf->lcache = intlist__new(NULL);
1027 	if (!pf->lcache)
1028 		return -ENOMEM;
1029 
1030 	/* Fastpath: lookup by function name from .debug_pubnames section */
1031 	if (pp->function) {
1032 		struct pubname_callback_param pubname_param = {
1033 			.function = pp->function,
1034 			.file	  = pp->file,
1035 			.cu_die	  = &pf->cu_die,
1036 			.sp_die	  = &pf->sp_die,
1037 			.found	  = 0,
1038 		};
1039 		struct dwarf_callback_param probe_param = {
1040 			.data = pf,
1041 		};
1042 
1043 		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1044 				  &pubname_param, 0);
1045 		if (pubname_param.found) {
1046 			ret = probe_point_search_cb(&pf->sp_die, &probe_param);
1047 			if (ret)
1048 				goto found;
1049 		}
1050 	}
1051 
1052 	/* Loop on CUs (Compilation Unit) */
1053 	while (!dwarf_nextcu(dbg->dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
1054 		/* Get the DIE(Debugging Information Entry) of this CU */
1055 		diep = dwarf_offdie(dbg->dbg, off + cuhl, &pf->cu_die);
1056 		if (!diep)
1057 			continue;
1058 
1059 		/* Check if target file is included. */
1060 		if (pp->file)
1061 			pf->fname = cu_find_realpath(&pf->cu_die, pp->file);
1062 		else
1063 			pf->fname = NULL;
1064 
1065 		if (!pp->file || pf->fname) {
1066 			if (pp->function)
1067 				ret = find_probe_point_by_func(pf);
1068 			else if (pp->lazy_line)
1069 				ret = find_probe_point_lazy(&pf->cu_die, pf);
1070 			else {
1071 				pf->lno = pp->line;
1072 				ret = find_probe_point_by_line(pf);
1073 			}
1074 			if (ret < 0)
1075 				break;
1076 		}
1077 		off = noff;
1078 	}
1079 
1080 found:
1081 	intlist__delete(pf->lcache);
1082 	pf->lcache = NULL;
1083 
1084 	return ret;
1085 }
1086 
1087 struct local_vars_finder {
1088 	struct probe_finder *pf;
1089 	struct perf_probe_arg *args;
1090 	bool vars;
1091 	int max_args;
1092 	int nargs;
1093 	int ret;
1094 };
1095 
1096 /* Collect available variables in this scope */
1097 static int copy_variables_cb(Dwarf_Die *die_mem, void *data)
1098 {
1099 	struct local_vars_finder *vf = data;
1100 	struct probe_finder *pf = vf->pf;
1101 	int tag;
1102 
1103 	tag = dwarf_tag(die_mem);
1104 	if (tag == DW_TAG_formal_parameter ||
1105 	    (tag == DW_TAG_variable && vf->vars)) {
1106 		if (convert_variable_location(die_mem, vf->pf->addr,
1107 					      vf->pf->fb_ops, &pf->sp_die,
1108 					      NULL) == 0) {
1109 			vf->args[vf->nargs].var = (char *)dwarf_diename(die_mem);
1110 			if (vf->args[vf->nargs].var == NULL) {
1111 				vf->ret = -ENOMEM;
1112 				return DIE_FIND_CB_END;
1113 			}
1114 			pr_debug(" %s", vf->args[vf->nargs].var);
1115 			vf->nargs++;
1116 		}
1117 	}
1118 
1119 	if (dwarf_haspc(die_mem, vf->pf->addr))
1120 		return DIE_FIND_CB_CONTINUE;
1121 	else
1122 		return DIE_FIND_CB_SIBLING;
1123 }
1124 
1125 static int expand_probe_args(Dwarf_Die *sc_die, struct probe_finder *pf,
1126 			     struct perf_probe_arg *args)
1127 {
1128 	Dwarf_Die die_mem;
1129 	int i;
1130 	int n = 0;
1131 	struct local_vars_finder vf = {.pf = pf, .args = args, .vars = false,
1132 				.max_args = MAX_PROBE_ARGS, .ret = 0};
1133 
1134 	for (i = 0; i < pf->pev->nargs; i++) {
1135 		/* var never be NULL */
1136 		if (strcmp(pf->pev->args[i].var, PROBE_ARG_VARS) == 0)
1137 			vf.vars = true;
1138 		else if (strcmp(pf->pev->args[i].var, PROBE_ARG_PARAMS) != 0) {
1139 			/* Copy normal argument */
1140 			args[n] = pf->pev->args[i];
1141 			n++;
1142 			continue;
1143 		}
1144 		pr_debug("Expanding %s into:", pf->pev->args[i].var);
1145 		vf.nargs = n;
1146 		/* Special local variables */
1147 		die_find_child(sc_die, copy_variables_cb, (void *)&vf,
1148 			       &die_mem);
1149 		pr_debug(" (%d)\n", vf.nargs - n);
1150 		if (vf.ret < 0)
1151 			return vf.ret;
1152 		n = vf.nargs;
1153 	}
1154 	return n;
1155 }
1156 
1157 /* Add a found probe point into trace event list */
1158 static int add_probe_trace_event(Dwarf_Die *sc_die, struct probe_finder *pf)
1159 {
1160 	struct trace_event_finder *tf =
1161 			container_of(pf, struct trace_event_finder, pf);
1162 	struct probe_trace_event *tev;
1163 	struct perf_probe_arg *args;
1164 	int ret, i;
1165 
1166 	/* Check number of tevs */
1167 	if (tf->ntevs == tf->max_tevs) {
1168 		pr_warning("Too many( > %d) probe point found.\n",
1169 			   tf->max_tevs);
1170 		return -ERANGE;
1171 	}
1172 	tev = &tf->tevs[tf->ntevs++];
1173 
1174 	/* Trace point should be converted from subprogram DIE */
1175 	ret = convert_to_trace_point(&pf->sp_die, tf->mod, pf->addr,
1176 				     pf->pev->point.retprobe, &tev->point);
1177 	if (ret < 0)
1178 		return ret;
1179 
1180 	pr_debug("Probe point found: %s+%lu\n", tev->point.symbol,
1181 		 tev->point.offset);
1182 
1183 	/* Expand special probe argument if exist */
1184 	args = zalloc(sizeof(struct perf_probe_arg) * MAX_PROBE_ARGS);
1185 	if (args == NULL)
1186 		return -ENOMEM;
1187 
1188 	ret = expand_probe_args(sc_die, pf, args);
1189 	if (ret < 0)
1190 		goto end;
1191 
1192 	tev->nargs = ret;
1193 	tev->args = zalloc(sizeof(struct probe_trace_arg) * tev->nargs);
1194 	if (tev->args == NULL) {
1195 		ret = -ENOMEM;
1196 		goto end;
1197 	}
1198 
1199 	/* Find each argument */
1200 	for (i = 0; i < tev->nargs; i++) {
1201 		pf->pvar = &args[i];
1202 		pf->tvar = &tev->args[i];
1203 		/* Variable should be found from scope DIE */
1204 		ret = find_variable(sc_die, pf);
1205 		if (ret != 0)
1206 			break;
1207 	}
1208 
1209 end:
1210 	free(args);
1211 	return ret;
1212 }
1213 
1214 /* Find probe_trace_events specified by perf_probe_event from debuginfo */
1215 int debuginfo__find_trace_events(struct debuginfo *dbg,
1216 				 struct perf_probe_event *pev,
1217 				 struct probe_trace_event **tevs, int max_tevs)
1218 {
1219 	struct trace_event_finder tf = {
1220 			.pf = {.pev = pev, .callback = add_probe_trace_event},
1221 			.mod = dbg->mod, .max_tevs = max_tevs};
1222 	int ret;
1223 
1224 	/* Allocate result tevs array */
1225 	*tevs = zalloc(sizeof(struct probe_trace_event) * max_tevs);
1226 	if (*tevs == NULL)
1227 		return -ENOMEM;
1228 
1229 	tf.tevs = *tevs;
1230 	tf.ntevs = 0;
1231 
1232 	ret = debuginfo__find_probes(dbg, &tf.pf);
1233 	if (ret < 0) {
1234 		zfree(tevs);
1235 		return ret;
1236 	}
1237 
1238 	return (ret < 0) ? ret : tf.ntevs;
1239 }
1240 
1241 #define MAX_VAR_LEN 64
1242 
1243 /* Collect available variables in this scope */
1244 static int collect_variables_cb(Dwarf_Die *die_mem, void *data)
1245 {
1246 	struct available_var_finder *af = data;
1247 	struct variable_list *vl;
1248 	char buf[MAX_VAR_LEN];
1249 	int tag, ret;
1250 
1251 	vl = &af->vls[af->nvls - 1];
1252 
1253 	tag = dwarf_tag(die_mem);
1254 	if (tag == DW_TAG_formal_parameter ||
1255 	    tag == DW_TAG_variable) {
1256 		ret = convert_variable_location(die_mem, af->pf.addr,
1257 						af->pf.fb_ops, &af->pf.sp_die,
1258 						NULL);
1259 		if (ret == 0) {
1260 			ret = die_get_varname(die_mem, buf, MAX_VAR_LEN);
1261 			pr_debug2("Add new var: %s\n", buf);
1262 			if (ret > 0)
1263 				strlist__add(vl->vars, buf);
1264 		}
1265 	}
1266 
1267 	if (af->child && dwarf_haspc(die_mem, af->pf.addr))
1268 		return DIE_FIND_CB_CONTINUE;
1269 	else
1270 		return DIE_FIND_CB_SIBLING;
1271 }
1272 
1273 /* Add a found vars into available variables list */
1274 static int add_available_vars(Dwarf_Die *sc_die, struct probe_finder *pf)
1275 {
1276 	struct available_var_finder *af =
1277 			container_of(pf, struct available_var_finder, pf);
1278 	struct variable_list *vl;
1279 	Dwarf_Die die_mem;
1280 	int ret;
1281 
1282 	/* Check number of tevs */
1283 	if (af->nvls == af->max_vls) {
1284 		pr_warning("Too many( > %d) probe point found.\n", af->max_vls);
1285 		return -ERANGE;
1286 	}
1287 	vl = &af->vls[af->nvls++];
1288 
1289 	/* Trace point should be converted from subprogram DIE */
1290 	ret = convert_to_trace_point(&pf->sp_die, af->mod, pf->addr,
1291 				     pf->pev->point.retprobe, &vl->point);
1292 	if (ret < 0)
1293 		return ret;
1294 
1295 	pr_debug("Probe point found: %s+%lu\n", vl->point.symbol,
1296 		 vl->point.offset);
1297 
1298 	/* Find local variables */
1299 	vl->vars = strlist__new(true, NULL);
1300 	if (vl->vars == NULL)
1301 		return -ENOMEM;
1302 	af->child = true;
1303 	die_find_child(sc_die, collect_variables_cb, (void *)af, &die_mem);
1304 
1305 	/* Find external variables */
1306 	if (!af->externs)
1307 		goto out;
1308 	/* Don't need to search child DIE for externs. */
1309 	af->child = false;
1310 	die_find_child(&pf->cu_die, collect_variables_cb, (void *)af, &die_mem);
1311 
1312 out:
1313 	if (strlist__empty(vl->vars)) {
1314 		strlist__delete(vl->vars);
1315 		vl->vars = NULL;
1316 	}
1317 
1318 	return ret;
1319 }
1320 
1321 /*
1322  * Find available variables at given probe point
1323  * Return the number of found probe points. Return 0 if there is no
1324  * matched probe point. Return <0 if an error occurs.
1325  */
1326 int debuginfo__find_available_vars_at(struct debuginfo *dbg,
1327 				      struct perf_probe_event *pev,
1328 				      struct variable_list **vls,
1329 				      int max_vls, bool externs)
1330 {
1331 	struct available_var_finder af = {
1332 			.pf = {.pev = pev, .callback = add_available_vars},
1333 			.mod = dbg->mod,
1334 			.max_vls = max_vls, .externs = externs};
1335 	int ret;
1336 
1337 	/* Allocate result vls array */
1338 	*vls = zalloc(sizeof(struct variable_list) * max_vls);
1339 	if (*vls == NULL)
1340 		return -ENOMEM;
1341 
1342 	af.vls = *vls;
1343 	af.nvls = 0;
1344 
1345 	ret = debuginfo__find_probes(dbg, &af.pf);
1346 	if (ret < 0) {
1347 		/* Free vlist for error */
1348 		while (af.nvls--) {
1349 			zfree(&af.vls[af.nvls].point.symbol);
1350 			strlist__delete(af.vls[af.nvls].vars);
1351 		}
1352 		zfree(vls);
1353 		return ret;
1354 	}
1355 
1356 	return (ret < 0) ? ret : af.nvls;
1357 }
1358 
1359 /* Reverse search */
1360 int debuginfo__find_probe_point(struct debuginfo *dbg, unsigned long addr,
1361 				struct perf_probe_point *ppt)
1362 {
1363 	Dwarf_Die cudie, spdie, indie;
1364 	Dwarf_Addr _addr = 0, baseaddr = 0;
1365 	const char *fname = NULL, *func = NULL, *basefunc = NULL, *tmp;
1366 	int baseline = 0, lineno = 0, ret = 0;
1367 
1368 	/* Find cu die */
1369 	if (!dwarf_addrdie(dbg->dbg, (Dwarf_Addr)addr, &cudie)) {
1370 		pr_warning("Failed to find debug information for address %lx\n",
1371 			   addr);
1372 		ret = -EINVAL;
1373 		goto end;
1374 	}
1375 
1376 	/* Find a corresponding line (filename and lineno) */
1377 	cu_find_lineinfo(&cudie, addr, &fname, &lineno);
1378 	/* Don't care whether it failed or not */
1379 
1380 	/* Find a corresponding function (name, baseline and baseaddr) */
1381 	if (die_find_realfunc(&cudie, (Dwarf_Addr)addr, &spdie)) {
1382 		/* Get function entry information */
1383 		func = basefunc = dwarf_diename(&spdie);
1384 		if (!func ||
1385 		    dwarf_entrypc(&spdie, &baseaddr) != 0 ||
1386 		    dwarf_decl_line(&spdie, &baseline) != 0) {
1387 			lineno = 0;
1388 			goto post;
1389 		}
1390 
1391 		fname = dwarf_decl_file(&spdie);
1392 		if (addr == (unsigned long)baseaddr) {
1393 			/* Function entry - Relative line number is 0 */
1394 			lineno = baseline;
1395 			goto post;
1396 		}
1397 
1398 		/* Track down the inline functions step by step */
1399 		while (die_find_top_inlinefunc(&spdie, (Dwarf_Addr)addr,
1400 						&indie)) {
1401 			/* There is an inline function */
1402 			if (dwarf_entrypc(&indie, &_addr) == 0 &&
1403 			    _addr == addr) {
1404 				/*
1405 				 * addr is at an inline function entry.
1406 				 * In this case, lineno should be the call-site
1407 				 * line number. (overwrite lineinfo)
1408 				 */
1409 				lineno = die_get_call_lineno(&indie);
1410 				fname = die_get_call_file(&indie);
1411 				break;
1412 			} else {
1413 				/*
1414 				 * addr is in an inline function body.
1415 				 * Since lineno points one of the lines
1416 				 * of the inline function, baseline should
1417 				 * be the entry line of the inline function.
1418 				 */
1419 				tmp = dwarf_diename(&indie);
1420 				if (!tmp ||
1421 				    dwarf_decl_line(&indie, &baseline) != 0)
1422 					break;
1423 				func = tmp;
1424 				spdie = indie;
1425 			}
1426 		}
1427 		/* Verify the lineno and baseline are in a same file */
1428 		tmp = dwarf_decl_file(&spdie);
1429 		if (!tmp || strcmp(tmp, fname) != 0)
1430 			lineno = 0;
1431 	}
1432 
1433 post:
1434 	/* Make a relative line number or an offset */
1435 	if (lineno)
1436 		ppt->line = lineno - baseline;
1437 	else if (basefunc) {
1438 		ppt->offset = addr - (unsigned long)baseaddr;
1439 		func = basefunc;
1440 	}
1441 
1442 	/* Duplicate strings */
1443 	if (func) {
1444 		ppt->function = strdup(func);
1445 		if (ppt->function == NULL) {
1446 			ret = -ENOMEM;
1447 			goto end;
1448 		}
1449 	}
1450 	if (fname) {
1451 		ppt->file = strdup(fname);
1452 		if (ppt->file == NULL) {
1453 			zfree(&ppt->function);
1454 			ret = -ENOMEM;
1455 			goto end;
1456 		}
1457 	}
1458 end:
1459 	if (ret == 0 && (fname || func))
1460 		ret = 1;	/* Found a point */
1461 	return ret;
1462 }
1463 
1464 /* Add a line and store the src path */
1465 static int line_range_add_line(const char *src, unsigned int lineno,
1466 			       struct line_range *lr)
1467 {
1468 	/* Copy source path */
1469 	if (!lr->path) {
1470 		lr->path = strdup(src);
1471 		if (lr->path == NULL)
1472 			return -ENOMEM;
1473 	}
1474 	return intlist__add(lr->line_list, lineno);
1475 }
1476 
1477 static int line_range_walk_cb(const char *fname, int lineno,
1478 			      Dwarf_Addr addr __maybe_unused,
1479 			      void *data)
1480 {
1481 	struct line_finder *lf = data;
1482 	int err;
1483 
1484 	if ((strtailcmp(fname, lf->fname) != 0) ||
1485 	    (lf->lno_s > lineno || lf->lno_e < lineno))
1486 		return 0;
1487 
1488 	err = line_range_add_line(fname, lineno, lf->lr);
1489 	if (err < 0 && err != -EEXIST)
1490 		return err;
1491 
1492 	return 0;
1493 }
1494 
1495 /* Find line range from its line number */
1496 static int find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
1497 {
1498 	int ret;
1499 
1500 	ret = die_walk_lines(sp_die ?: &lf->cu_die, line_range_walk_cb, lf);
1501 
1502 	/* Update status */
1503 	if (ret >= 0)
1504 		if (!intlist__empty(lf->lr->line_list))
1505 			ret = lf->found = 1;
1506 		else
1507 			ret = 0;	/* Lines are not found */
1508 	else {
1509 		zfree(&lf->lr->path);
1510 	}
1511 	return ret;
1512 }
1513 
1514 static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
1515 {
1516 	int ret = find_line_range_by_line(in_die, data);
1517 
1518 	/*
1519 	 * We have to check all instances of inlined function, because
1520 	 * some execution paths can be optimized out depends on the
1521 	 * function argument of instances. However, if an error occurs,
1522 	 * it should be handled by the caller.
1523 	 */
1524 	return ret < 0 ? ret : 0;
1525 }
1526 
1527 /* Search function definition from function name */
1528 static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
1529 {
1530 	struct dwarf_callback_param *param = data;
1531 	struct line_finder *lf = param->data;
1532 	struct line_range *lr = lf->lr;
1533 
1534 	/* Check declared file */
1535 	if (lr->file && strtailcmp(lr->file, dwarf_decl_file(sp_die)))
1536 		return DWARF_CB_OK;
1537 
1538 	if (die_is_func_def(sp_die) &&
1539 	    die_compare_name(sp_die, lr->function)) {
1540 		lf->fname = dwarf_decl_file(sp_die);
1541 		dwarf_decl_line(sp_die, &lr->offset);
1542 		pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
1543 		lf->lno_s = lr->offset + lr->start;
1544 		if (lf->lno_s < 0)	/* Overflow */
1545 			lf->lno_s = INT_MAX;
1546 		lf->lno_e = lr->offset + lr->end;
1547 		if (lf->lno_e < 0)	/* Overflow */
1548 			lf->lno_e = INT_MAX;
1549 		pr_debug("New line range: %d to %d\n", lf->lno_s, lf->lno_e);
1550 		lr->start = lf->lno_s;
1551 		lr->end = lf->lno_e;
1552 		if (!die_is_func_instance(sp_die))
1553 			param->retval = die_walk_instances(sp_die,
1554 						line_range_inline_cb, lf);
1555 		else
1556 			param->retval = find_line_range_by_line(sp_die, lf);
1557 		return DWARF_CB_ABORT;
1558 	}
1559 	return DWARF_CB_OK;
1560 }
1561 
1562 static int find_line_range_by_func(struct line_finder *lf)
1563 {
1564 	struct dwarf_callback_param param = {.data = (void *)lf, .retval = 0};
1565 	dwarf_getfuncs(&lf->cu_die, line_range_search_cb, &param, 0);
1566 	return param.retval;
1567 }
1568 
1569 int debuginfo__find_line_range(struct debuginfo *dbg, struct line_range *lr)
1570 {
1571 	struct line_finder lf = {.lr = lr, .found = 0};
1572 	int ret = 0;
1573 	Dwarf_Off off = 0, noff;
1574 	size_t cuhl;
1575 	Dwarf_Die *diep;
1576 	const char *comp_dir;
1577 
1578 	/* Fastpath: lookup by function name from .debug_pubnames section */
1579 	if (lr->function) {
1580 		struct pubname_callback_param pubname_param = {
1581 			.function = lr->function, .file = lr->file,
1582 			.cu_die = &lf.cu_die, .sp_die = &lf.sp_die, .found = 0};
1583 		struct dwarf_callback_param line_range_param = {
1584 			.data = (void *)&lf, .retval = 0};
1585 
1586 		dwarf_getpubnames(dbg->dbg, pubname_search_cb,
1587 				  &pubname_param, 0);
1588 		if (pubname_param.found) {
1589 			line_range_search_cb(&lf.sp_die, &line_range_param);
1590 			if (lf.found)
1591 				goto found;
1592 		}
1593 	}
1594 
1595 	/* Loop on CUs (Compilation Unit) */
1596 	while (!lf.found && ret >= 0) {
1597 		if (dwarf_nextcu(dbg->dbg, off, &noff, &cuhl,
1598 				 NULL, NULL, NULL) != 0)
1599 			break;
1600 
1601 		/* Get the DIE(Debugging Information Entry) of this CU */
1602 		diep = dwarf_offdie(dbg->dbg, off + cuhl, &lf.cu_die);
1603 		if (!diep)
1604 			continue;
1605 
1606 		/* Check if target file is included. */
1607 		if (lr->file)
1608 			lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
1609 		else
1610 			lf.fname = 0;
1611 
1612 		if (!lr->file || lf.fname) {
1613 			if (lr->function)
1614 				ret = find_line_range_by_func(&lf);
1615 			else {
1616 				lf.lno_s = lr->start;
1617 				lf.lno_e = lr->end;
1618 				ret = find_line_range_by_line(NULL, &lf);
1619 			}
1620 		}
1621 		off = noff;
1622 	}
1623 
1624 found:
1625 	/* Store comp_dir */
1626 	if (lf.found) {
1627 		comp_dir = cu_get_comp_dir(&lf.cu_die);
1628 		if (comp_dir) {
1629 			lr->comp_dir = strdup(comp_dir);
1630 			if (!lr->comp_dir)
1631 				ret = -ENOMEM;
1632 		}
1633 	}
1634 
1635 	pr_debug("path: %s\n", lr->path);
1636 	return (ret < 0) ? ret : lf.found;
1637 }
1638 
1639 /*
1640  * Find a src file from a DWARF tag path. Prepend optional source path prefix
1641  * and chop off leading directories that do not exist. Result is passed back as
1642  * a newly allocated path on success.
1643  * Return 0 if file was found and readable, -errno otherwise.
1644  */
1645 int get_real_path(const char *raw_path, const char *comp_dir,
1646 			 char **new_path)
1647 {
1648 	const char *prefix = symbol_conf.source_prefix;
1649 
1650 	if (!prefix) {
1651 		if (raw_path[0] != '/' && comp_dir)
1652 			/* If not an absolute path, try to use comp_dir */
1653 			prefix = comp_dir;
1654 		else {
1655 			if (access(raw_path, R_OK) == 0) {
1656 				*new_path = strdup(raw_path);
1657 				return *new_path ? 0 : -ENOMEM;
1658 			} else
1659 				return -errno;
1660 		}
1661 	}
1662 
1663 	*new_path = malloc((strlen(prefix) + strlen(raw_path) + 2));
1664 	if (!*new_path)
1665 		return -ENOMEM;
1666 
1667 	for (;;) {
1668 		sprintf(*new_path, "%s/%s", prefix, raw_path);
1669 
1670 		if (access(*new_path, R_OK) == 0)
1671 			return 0;
1672 
1673 		if (!symbol_conf.source_prefix) {
1674 			/* In case of searching comp_dir, don't retry */
1675 			zfree(new_path);
1676 			return -errno;
1677 		}
1678 
1679 		switch (errno) {
1680 		case ENAMETOOLONG:
1681 		case ENOENT:
1682 		case EROFS:
1683 		case EFAULT:
1684 			raw_path = strchr(++raw_path, '/');
1685 			if (!raw_path) {
1686 				zfree(new_path);
1687 				return -ENOENT;
1688 			}
1689 			continue;
1690 
1691 		default:
1692 			zfree(new_path);
1693 			return -errno;
1694 		}
1695 	}
1696 }
1697