blob: c91a9605c162fb2486a5a8566651de3694eb970f [file] [log] [blame]
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -04001/*
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 <getopt.h>
30#include <stdlib.h>
31#include <string.h>
32#include <stdarg.h>
33#include <ctype.h>
Masami Hiramatsu074fc0e2009-10-16 20:08:01 -040034
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -050035#include "string.h"
Masami Hiramatsu89c69c02009-10-16 20:08:10 -040036#include "event.h"
37#include "debug.h"
Masami Hiramatsu074fc0e2009-10-16 20:08:01 -040038#include "util.h"
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040039#include "probe-finder.h"
40
41
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -040042/*
43 * Generic dwarf analysis helpers
44 */
45
46#define X86_32_MAX_REGS 8
47const char *x86_32_regs_table[X86_32_MAX_REGS] = {
48 "%ax",
49 "%cx",
50 "%dx",
51 "%bx",
52 "$stack", /* Stack address instead of %sp */
53 "%bp",
54 "%si",
55 "%di",
56};
57
58#define X86_64_MAX_REGS 16
59const char *x86_64_regs_table[X86_64_MAX_REGS] = {
60 "%ax",
61 "%dx",
62 "%cx",
63 "%bx",
64 "%si",
65 "%di",
66 "%bp",
67 "%sp",
68 "%r8",
69 "%r9",
70 "%r10",
71 "%r11",
72 "%r12",
73 "%r13",
74 "%r14",
75 "%r15",
76};
77
78/* TODO: switching by dwarf address size */
79#ifdef __x86_64__
80#define ARCH_MAX_REGS X86_64_MAX_REGS
81#define arch_regs_table x86_64_regs_table
82#else
83#define ARCH_MAX_REGS X86_32_MAX_REGS
84#define arch_regs_table x86_32_regs_table
85#endif
86
87/* Return architecture dependent register string (for kprobe-tracer) */
88static const char *get_arch_regstr(unsigned int n)
89{
90 return (n <= ARCH_MAX_REGS) ? arch_regs_table[n] : NULL;
91}
92
93/*
94 * Compare the tail of two strings.
95 * Return 0 if whole of either string is same as another's tail part.
96 */
97static int strtailcmp(const char *s1, const char *s2)
98{
99 int i1 = strlen(s1);
100 int i2 = strlen(s2);
Juha Leppanend56728b2009-12-07 12:00:40 -0500101 while (--i1 >= 0 && --i2 >= 0) {
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400102 if (s1[i1] != s2[i2])
103 return s1[i1] - s2[i2];
104 }
105 return 0;
106}
107
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500108/* Line number list operations */
109
110/* Add a line to line number list */
111static void line_list__add_line(struct list_head *head, unsigned int line)
112{
113 struct line_node *ln;
114 struct list_head *p;
115
116 /* Reverse search, because new line will be the last one */
117 list_for_each_entry_reverse(ln, head, list) {
118 if (ln->line < line) {
119 p = &ln->list;
120 goto found;
121 } else if (ln->line == line) /* Already exist */
122 return ;
123 }
124 /* List is empty, or the smallest entry */
125 p = head;
126found:
127 pr_debug("line list: add a line %u\n", line);
Masami Hiramatsu31facc52010-03-16 18:05:30 -0400128 ln = xzalloc(sizeof(struct line_node));
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500129 ln->line = line;
130 INIT_LIST_HEAD(&ln->list);
131 list_add(&ln->list, p);
132}
133
134/* Check if the line in line number list */
135static int line_list__has_line(struct list_head *head, unsigned int line)
136{
137 struct line_node *ln;
138
139 /* Reverse search, because new line will be the last one */
140 list_for_each_entry(ln, head, list)
141 if (ln->line == line)
142 return 1;
143
144 return 0;
145}
146
147/* Init line number list */
148static void line_list__init(struct list_head *head)
149{
150 INIT_LIST_HEAD(head);
151}
152
153/* Free line number list */
154static void line_list__free(struct list_head *head)
155{
156 struct line_node *ln;
157 while (!list_empty(head)) {
158 ln = list_first_entry(head, struct line_node, list);
159 list_del(&ln->list);
160 free(ln);
161 }
162}
163
164/* Dwarf wrappers */
165
166/* Find the realpath of the target file. */
167static const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400168{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500169 Dwarf_Files *files;
170 size_t nfiles, i;
Arnaldo Carvalho de Meloaccd3cc2010-03-05 12:51:04 -0300171 const char *src = NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400172 int ret;
173
174 if (!fname)
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500175 return NULL;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500176
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500177 ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500178 if (ret != 0)
179 return NULL;
180
181 for (i = 0; i < nfiles; i++) {
182 src = dwarf_filesrc(files, i, NULL, NULL);
183 if (strtailcmp(src, fname) == 0)
184 break;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500185 }
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500186 return src;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500187}
188
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500189struct __addr_die_search_param {
190 Dwarf_Addr addr;
191 Dwarf_Die *die_mem;
192};
193
194static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
195{
196 struct __addr_die_search_param *ad = data;
197
198 if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
199 dwarf_haspc(fn_die, ad->addr)) {
200 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
201 return DWARF_CB_ABORT;
202 }
203 return DWARF_CB_OK;
204}
205
206/* Search a real subprogram including this line, */
Masami Hiramatsu95a3e4c2010-03-16 18:05:51 -0400207static Dwarf_Die *die_find_real_subprogram(Dwarf_Die *cu_die, Dwarf_Addr addr,
208 Dwarf_Die *die_mem)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500209{
210 struct __addr_die_search_param ad;
211 ad.addr = addr;
212 ad.die_mem = die_mem;
213 /* dwarf_getscopes can't find subprogram. */
214 if (!dwarf_getfuncs(cu_die, __die_search_func_cb, &ad, 0))
215 return NULL;
216 else
217 return die_mem;
218}
219
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500220/* Similar to dwarf_getfuncs, but returns inlined_subroutine if exists. */
Masami Hiramatsu95a3e4c2010-03-16 18:05:51 -0400221static Dwarf_Die *die_find_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
222 Dwarf_Die *die_mem)
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500223{
224 Dwarf_Die child_die;
225 int ret;
226
227 ret = dwarf_child(sp_die, die_mem);
228 if (ret != 0)
229 return NULL;
230
231 do {
232 if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
233 dwarf_haspc(die_mem, addr))
234 return die_mem;
235
Masami Hiramatsu95a3e4c2010-03-16 18:05:51 -0400236 if (die_find_inlinefunc(die_mem, addr, &child_die)) {
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500237 memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
238 return die_mem;
239 }
240 } while (dwarf_siblingof(die_mem, die_mem) == 0);
241
242 return NULL;
243}
244
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400245/* Compare diename and tname */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500246static bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400247{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500248 const char *name;
249 name = dwarf_diename(dw_die);
250 DIE_IF(name == NULL);
251 return strcmp(tname, name);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400252}
253
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400254/* Get entry pc(or low pc, 1st entry of ranges) of the die */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500255static Dwarf_Addr die_get_entrypc(Dwarf_Die *dw_die)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400256{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500257 Dwarf_Addr epc;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400258 int ret;
259
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500260 ret = dwarf_entrypc(dw_die, &epc);
261 DIE_IF(ret == -1);
262 return epc;
263}
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400264
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500265/* Get a variable die */
266static Dwarf_Die *die_find_variable(Dwarf_Die *sp_die, const char *name,
267 Dwarf_Die *die_mem)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500268{
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500269 Dwarf_Die child_die;
270 int tag;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400271 int ret;
272
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500273 ret = dwarf_child(sp_die, die_mem);
274 if (ret != 0)
275 return NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400276
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500277 do {
278 tag = dwarf_tag(die_mem);
279 if ((tag == DW_TAG_formal_parameter ||
280 tag == DW_TAG_variable) &&
281 (die_compare_name(die_mem, name) == 0))
282 return die_mem;
283
284 if (die_find_variable(die_mem, name, &child_die)) {
285 memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
286 return die_mem;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400287 }
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500288 } while (dwarf_siblingof(die_mem, die_mem) == 0);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400289
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500290 return NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400291}
292
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400293/*
294 * Probe finder related functions
295 */
296
297/* Show a location */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500298static void show_location(Dwarf_Op *op, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400299{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500300 unsigned int regn;
301 Dwarf_Word offs = 0;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400302 int deref = 0, ret;
303 const char *regs;
304
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500305 /* TODO: support CFA */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400306 /* If this is based on frame buffer, set the offset */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500307 if (op->atom == DW_OP_fbreg) {
308 if (pf->fb_ops == NULL)
309 die("The attribute of frame base is not supported.\n");
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400310 deref = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500311 offs = op->number;
312 op = &pf->fb_ops[0];
313 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400314
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500315 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
316 regn = op->atom - DW_OP_breg0;
317 offs += op->number;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400318 deref = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500319 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
320 regn = op->atom - DW_OP_reg0;
321 } else if (op->atom == DW_OP_bregx) {
322 regn = op->number;
323 offs += op->number2;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400324 deref = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500325 } else if (op->atom == DW_OP_regx) {
326 regn = op->number;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400327 } else
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500328 die("DW_OP %d is not supported.", op->atom);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400329
330 regs = get_arch_regstr(regn);
331 if (!regs)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500332 die("%u exceeds max register number.", regn);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400333
334 if (deref)
Masami Hiramatsu67c7ff72010-03-15 13:02:28 -0400335 ret = snprintf(pf->buf, pf->len, " %s=%+jd(%s)",
336 pf->var, (intmax_t)offs, regs);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400337 else
338 ret = snprintf(pf->buf, pf->len, " %s=%s", pf->var, regs);
Masami Hiramatsu97698332009-10-16 20:08:18 -0400339 DIE_IF(ret < 0);
340 DIE_IF(ret >= pf->len);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400341}
342
343/* Show a variables in kprobe event format */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500344static void show_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400345{
346 Dwarf_Attribute attr;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500347 Dwarf_Op *expr;
348 size_t nexpr;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400349 int ret;
350
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500351 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400352 goto error;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500353 /* TODO: handle more than 1 exprs */
Masami Hiramatsud0cb4260f2010-03-15 13:02:35 -0400354 ret = dwarf_getlocation_addr(&attr, pf->addr, &expr, &nexpr, 1);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500355 if (ret <= 0 || nexpr == 0)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400356 goto error;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500357
358 show_location(expr, pf);
359 /* *expr will be cached in libdw. Don't free it. */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400360 return ;
361error:
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500362 /* TODO: Support const_value */
Masami Hiramatsu074fc0e2009-10-16 20:08:01 -0400363 die("Failed to find the location of %s at this address.\n"
Masami Hiramatsubbaa46f2010-01-05 17:47:03 -0500364 " Perhaps, it has been optimized out.", pf->var);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400365}
366
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400367/* Find a variable in a subprogram die */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500368static void find_variable(Dwarf_Die *sp_die, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400369{
370 int ret;
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500371 Dwarf_Die vr_die;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400372
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500373 /* TODO: Support struct members and arrays */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400374 if (!is_c_varname(pf->var)) {
375 /* Output raw parameters */
376 ret = snprintf(pf->buf, pf->len, " %s", pf->var);
Masami Hiramatsu97698332009-10-16 20:08:18 -0400377 DIE_IF(ret < 0);
378 DIE_IF(ret >= pf->len);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400379 return ;
380 }
381
Arnaldo Carvalho de Melob7cb10e2009-10-21 17:34:06 -0200382 pr_debug("Searching '%s' variable in context.\n", pf->var);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400383 /* Search child die for local variables and parameters. */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500384 if (!die_find_variable(sp_die, pf->var, &vr_die))
Masami Hiramatsubbaa46f2010-01-05 17:47:03 -0500385 die("Failed to find '%s' in this function.", pf->var);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500386
387 show_variable(&vr_die, pf);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400388}
389
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400390/* Show a probe point to output buffer */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500391static void show_probe_point(Dwarf_Die *sp_die, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400392{
393 struct probe_point *pp = pf->pp;
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500394 Dwarf_Addr eaddr;
395 Dwarf_Die die_mem;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500396 const char *name;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400397 char tmp[MAX_PROBE_BUFFER];
398 int ret, i, len;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500399 Dwarf_Attribute fb_attr;
400 size_t nops;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400401
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500402 /* If no real subprogram, find a real one */
403 if (!sp_die || dwarf_tag(sp_die) != DW_TAG_subprogram) {
Masami Hiramatsu95a3e4c2010-03-16 18:05:51 -0400404 sp_die = die_find_real_subprogram(&pf->cu_die,
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500405 pf->addr, &die_mem);
406 if (!sp_die)
407 die("Probe point is not found in subprograms.");
408 }
409
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400410 /* Output name of probe point */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500411 name = dwarf_diename(sp_die);
412 if (name) {
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500413 dwarf_entrypc(sp_die, &eaddr);
414 ret = snprintf(tmp, MAX_PROBE_BUFFER, "%s+%lu", name,
415 (unsigned long)(pf->addr - eaddr));
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400416 /* Copy the function name if possible */
417 if (!pp->function) {
Masami Hiramatsu31facc52010-03-16 18:05:30 -0400418 pp->function = xstrdup(name);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500419 pp->offset = (size_t)(pf->addr - eaddr);
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400420 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400421 } else {
422 /* This function has no name. */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500423 ret = snprintf(tmp, MAX_PROBE_BUFFER, "0x%jx",
424 (uintmax_t)pf->addr);
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400425 if (!pp->function) {
426 /* TODO: Use _stext */
Masami Hiramatsu31facc52010-03-16 18:05:30 -0400427 pp->function = xstrdup("");
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500428 pp->offset = (size_t)pf->addr;
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400429 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400430 }
Masami Hiramatsu97698332009-10-16 20:08:18 -0400431 DIE_IF(ret < 0);
432 DIE_IF(ret >= MAX_PROBE_BUFFER);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400433 len = ret;
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400434 pr_debug("Probe point found: %s\n", tmp);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400435
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500436 /* Get the frame base attribute/ops */
437 dwarf_attr(sp_die, DW_AT_frame_base, &fb_attr);
Masami Hiramatsud0cb4260f2010-03-15 13:02:35 -0400438 ret = dwarf_getlocation_addr(&fb_attr, pf->addr, &pf->fb_ops, &nops, 1);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500439 if (ret <= 0 || nops == 0)
440 pf->fb_ops = NULL;
441
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400442 /* Find each argument */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500443 /* TODO: use dwarf_cfi_addrframe */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400444 for (i = 0; i < pp->nr_args; i++) {
445 pf->var = pp->args[i];
446 pf->buf = &tmp[len];
447 pf->len = MAX_PROBE_BUFFER - len;
448 find_variable(sp_die, pf);
449 len += strlen(pf->buf);
450 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500451
452 /* *pf->fb_ops will be cached in libdw. Don't free it. */
453 pf->fb_ops = NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400454
Masami Hiramatsu594087a2010-03-12 18:22:17 -0500455 if (pp->found == MAX_PROBES)
456 die("Too many( > %d) probe point found.\n", MAX_PROBES);
457
Masami Hiramatsu31facc52010-03-16 18:05:30 -0400458 pp->probes[pp->found] = xstrdup(tmp);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400459 pp->found++;
460}
461
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400462/* Find probe point from its line number */
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500463static void find_probe_point_by_line(struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400464{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500465 Dwarf_Lines *lines;
466 Dwarf_Line *line;
467 size_t nlines, i;
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500468 Dwarf_Addr addr;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500469 int lineno;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400470 int ret;
471
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500472 ret = dwarf_getsrclines(&pf->cu_die, &lines, &nlines);
473 DIE_IF(ret != 0);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400474
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500475 for (i = 0; i < nlines; i++) {
476 line = dwarf_onesrcline(lines, i);
477 dwarf_lineno(line, &lineno);
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400478 if (lineno != pf->lno)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400479 continue;
480
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500481 /* TODO: Get fileno from line, but how? */
482 if (strtailcmp(dwarf_linesrc(line, NULL, NULL), pf->fname) != 0)
483 continue;
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400484
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500485 ret = dwarf_lineaddr(line, &addr);
486 DIE_IF(ret != 0);
487 pr_debug("Probe line found: line[%d]:%d addr:0x%jx\n",
488 (int)i, lineno, (uintmax_t)addr);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400489 pf->addr = addr;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500490
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500491 show_probe_point(NULL, pf);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400492 /* Continuing, because target line might be inlined. */
493 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400494}
495
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500496/* Find lines which match lazy pattern */
497static int find_lazy_match_lines(struct list_head *head,
498 const char *fname, const char *pat)
499{
500 char *fbuf, *p1, *p2;
501 int fd, line, nlines = 0;
502 struct stat st;
503
504 fd = open(fname, O_RDONLY);
505 if (fd < 0)
506 die("failed to open %s", fname);
507 DIE_IF(fstat(fd, &st) < 0);
Masami Hiramatsu31facc52010-03-16 18:05:30 -0400508 fbuf = xmalloc(st.st_size + 2);
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500509 DIE_IF(read(fd, fbuf, st.st_size) < 0);
510 close(fd);
511 fbuf[st.st_size] = '\n'; /* Dummy line */
512 fbuf[st.st_size + 1] = '\0';
513 p1 = fbuf;
514 line = 1;
515 while ((p2 = strchr(p1, '\n')) != NULL) {
516 *p2 = '\0';
517 if (strlazymatch(p1, pat)) {
518 line_list__add_line(head, line);
519 nlines++;
520 }
521 line++;
522 p1 = p2 + 1;
523 }
524 free(fbuf);
525 return nlines;
526}
527
528/* Find probe points from lazy pattern */
529static void find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
530{
531 Dwarf_Lines *lines;
532 Dwarf_Line *line;
533 size_t nlines, i;
534 Dwarf_Addr addr;
535 Dwarf_Die die_mem;
536 int lineno;
537 int ret;
538
539 if (list_empty(&pf->lcache)) {
540 /* Matching lazy line pattern */
541 ret = find_lazy_match_lines(&pf->lcache, pf->fname,
542 pf->pp->lazy_line);
543 if (ret <= 0)
544 die("No matched lines found in %s.", pf->fname);
545 }
546
547 ret = dwarf_getsrclines(&pf->cu_die, &lines, &nlines);
548 DIE_IF(ret != 0);
549 for (i = 0; i < nlines; i++) {
550 line = dwarf_onesrcline(lines, i);
551
552 dwarf_lineno(line, &lineno);
553 if (!line_list__has_line(&pf->lcache, lineno))
554 continue;
555
556 /* TODO: Get fileno from line, but how? */
557 if (strtailcmp(dwarf_linesrc(line, NULL, NULL), pf->fname) != 0)
558 continue;
559
560 ret = dwarf_lineaddr(line, &addr);
561 DIE_IF(ret != 0);
562 if (sp_die) {
563 /* Address filtering 1: does sp_die include addr? */
564 if (!dwarf_haspc(sp_die, addr))
565 continue;
566 /* Address filtering 2: No child include addr? */
Masami Hiramatsu95a3e4c2010-03-16 18:05:51 -0400567 if (die_find_inlinefunc(sp_die, addr, &die_mem))
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500568 continue;
569 }
570
571 pr_debug("Probe line found: line[%d]:%d addr:0x%llx\n",
572 (int)i, lineno, (unsigned long long)addr);
573 pf->addr = addr;
574
575 show_probe_point(sp_die, pf);
576 /* Continuing, because target line might be inlined. */
577 }
578 /* TODO: deallocate lines, but how? */
579}
580
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500581static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400582{
583 struct probe_finder *pf = (struct probe_finder *)data;
584 struct probe_point *pp = pf->pp;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400585
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500586 if (pp->lazy_line)
587 find_probe_point_lazy(in_die, pf);
588 else {
589 /* Get probe address */
590 pf->addr = die_get_entrypc(in_die);
591 pf->addr += pp->offset;
592 pr_debug("found inline addr: 0x%jx\n",
593 (uintmax_t)pf->addr);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500594
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500595 show_probe_point(in_die, pf);
596 }
597
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500598 return DWARF_CB_OK;
599}
600
601/* Search function from function name */
602static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
603{
604 struct probe_finder *pf = (struct probe_finder *)data;
605 struct probe_point *pp = pf->pp;
606
607 /* Check tag and diename */
608 if (dwarf_tag(sp_die) != DW_TAG_subprogram ||
609 die_compare_name(sp_die, pp->function) != 0)
610 return 0;
611
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500612 pf->fname = dwarf_decl_file(sp_die);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500613 if (pp->line) { /* Function relative line */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500614 dwarf_decl_line(sp_die, &pf->lno);
615 pf->lno += pp->line;
616 find_probe_point_by_line(pf);
617 } else if (!dwarf_func_inline(sp_die)) {
618 /* Real function */
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500619 if (pp->lazy_line)
620 find_probe_point_lazy(sp_die, pf);
621 else {
622 pf->addr = die_get_entrypc(sp_die);
623 pf->addr += pp->offset;
624 /* TODO: Check the address in this function */
625 show_probe_point(sp_die, pf);
626 }
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500627 } else
628 /* Inlined function: search instances */
629 dwarf_func_inline_instances(sp_die, probe_point_inline_cb, pf);
630
631 return 1; /* Exit; no same symbol in this CU. */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400632}
633
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500634static void find_probe_point_by_func(struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400635{
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500636 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, pf, 0);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400637}
638
639/* Find a probe point */
Masami Hiramatsu81cb8aa2010-02-25 08:35:34 -0500640int find_probe_point(int fd, struct probe_point *pp)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400641{
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400642 struct probe_finder pf = {.pp = pp};
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500643 Dwarf_Off off, noff;
644 size_t cuhl;
645 Dwarf_Die *diep;
646 Dwarf *dbg;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400647
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500648 dbg = dwarf_begin(fd, DWARF_C_READ);
649 if (!dbg)
Masami Hiramatsua225a1d2009-11-03 19:12:30 -0500650 return -ENOENT;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400651
652 pp->found = 0;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500653 off = 0;
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500654 line_list__init(&pf.lcache);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500655 /* Loop on CUs (Compilation Unit) */
656 while (!dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400657 /* Get the DIE(Debugging Information Entry) of this CU */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500658 diep = dwarf_offdie(dbg, off + cuhl, &pf.cu_die);
659 if (!diep)
660 continue;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400661
662 /* Check if target file is included. */
663 if (pp->file)
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500664 pf.fname = cu_find_realpath(&pf.cu_die, pp->file);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500665 else
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500666 pf.fname = NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400667
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500668 if (!pp->file || pf.fname) {
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400669 if (pp->function)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500670 find_probe_point_by_func(&pf);
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500671 else if (pp->lazy_line)
672 find_probe_point_lazy(NULL, &pf);
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400673 else {
674 pf.lno = pp->line;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500675 find_probe_point_by_line(&pf);
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400676 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400677 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500678 off = noff;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400679 }
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500680 line_list__free(&pf.lcache);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500681 dwarf_end(dbg);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400682
683 return pp->found;
684}
685
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500686/* Find line range from its line number */
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500687static void find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500688{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500689 Dwarf_Lines *lines;
690 Dwarf_Line *line;
691 size_t nlines, i;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500692 Dwarf_Addr addr;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500693 int lineno;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500694 int ret;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500695 const char *src;
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500696 Dwarf_Die die_mem;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500697
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500698 line_list__init(&lf->lr->line_list);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500699 ret = dwarf_getsrclines(&lf->cu_die, &lines, &nlines);
700 DIE_IF(ret != 0);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500701
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500702 for (i = 0; i < nlines; i++) {
703 line = dwarf_onesrcline(lines, i);
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500704 ret = dwarf_lineno(line, &lineno);
705 DIE_IF(ret != 0);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500706 if (lf->lno_s > lineno || lf->lno_e < lineno)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500707 continue;
708
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500709 if (sp_die) {
710 /* Address filtering 1: does sp_die include addr? */
711 ret = dwarf_lineaddr(line, &addr);
712 DIE_IF(ret != 0);
713 if (!dwarf_haspc(sp_die, addr))
714 continue;
715
716 /* Address filtering 2: No child include addr? */
Masami Hiramatsu95a3e4c2010-03-16 18:05:51 -0400717 if (die_find_inlinefunc(sp_die, addr, &die_mem))
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500718 continue;
719 }
720
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500721 /* TODO: Get fileno from line, but how? */
722 src = dwarf_linesrc(line, NULL, NULL);
723 if (strtailcmp(src, lf->fname) != 0)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500724 continue;
725
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500726 /* Copy real path */
727 if (!lf->lr->path)
Masami Hiramatsu31facc52010-03-16 18:05:30 -0400728 lf->lr->path = xstrdup(src);
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500729 line_list__add_line(&lf->lr->line_list, (unsigned int)lineno);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500730 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500731 /* Update status */
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500732 if (!list_empty(&lf->lr->line_list))
733 lf->found = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500734 else {
735 free(lf->lr->path);
736 lf->lr->path = NULL;
737 }
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500738}
739
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500740static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
741{
742 find_line_range_by_line(in_die, (struct line_finder *)data);
743 return DWARF_CB_ABORT; /* No need to find other instances */
744}
745
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500746/* Search function from function name */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500747static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500748{
749 struct line_finder *lf = (struct line_finder *)data;
750 struct line_range *lr = lf->lr;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500751
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500752 if (dwarf_tag(sp_die) == DW_TAG_subprogram &&
753 die_compare_name(sp_die, lr->function) == 0) {
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500754 lf->fname = dwarf_decl_file(sp_die);
755 dwarf_decl_line(sp_die, &lr->offset);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500756 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500757 lf->lno_s = lr->offset + lr->start;
758 if (!lr->end)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500759 lf->lno_e = INT_MAX;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500760 else
761 lf->lno_e = lr->offset + lr->end;
762 lr->start = lf->lno_s;
763 lr->end = lf->lno_e;
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500764 if (dwarf_func_inline(sp_die))
765 dwarf_func_inline_instances(sp_die,
766 line_range_inline_cb, lf);
767 else
768 find_line_range_by_line(sp_die, lf);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500769 return 1;
770 }
771 return 0;
772}
773
774static void find_line_range_by_func(struct line_finder *lf)
775{
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500776 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, lf, 0);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500777}
778
779int find_line_range(int fd, struct line_range *lr)
780{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500781 struct line_finder lf = {.lr = lr, .found = 0};
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500782 int ret;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500783 Dwarf_Off off = 0, noff;
784 size_t cuhl;
785 Dwarf_Die *diep;
786 Dwarf *dbg;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500787
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500788 dbg = dwarf_begin(fd, DWARF_C_READ);
789 if (!dbg)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500790 return -ENOENT;
791
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500792 /* Loop on CUs (Compilation Unit) */
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500793 while (!lf.found) {
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500794 ret = dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL);
795 if (ret != 0)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500796 break;
797
798 /* Get the DIE(Debugging Information Entry) of this CU */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500799 diep = dwarf_offdie(dbg, off + cuhl, &lf.cu_die);
800 if (!diep)
801 continue;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500802
803 /* Check if target file is included. */
804 if (lr->file)
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500805 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500806 else
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500807 lf.fname = 0;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500808
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500809 if (!lr->file || lf.fname) {
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500810 if (lr->function)
811 find_line_range_by_func(&lf);
812 else {
813 lf.lno_s = lr->start;
814 if (!lr->end)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500815 lf.lno_e = INT_MAX;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500816 else
817 lf.lno_e = lr->end;
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500818 find_line_range_by_line(NULL, &lf);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500819 }
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500820 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500821 off = noff;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500822 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500823 pr_debug("path: %lx\n", (unsigned long)lr->path);
824 dwarf_end(dbg);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500825 return lf.found;
826}
827