blob: e77dc886760e5350ea56d1043d400e914678b817 [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);
128 ln = zalloc(sizeof(struct line_node));
129 DIE_IF(ln == NULL);
130 ln->line = line;
131 INIT_LIST_HEAD(&ln->list);
132 list_add(&ln->list, p);
133}
134
135/* Check if the line in line number list */
136static int line_list__has_line(struct list_head *head, unsigned int line)
137{
138 struct line_node *ln;
139
140 /* Reverse search, because new line will be the last one */
141 list_for_each_entry(ln, head, list)
142 if (ln->line == line)
143 return 1;
144
145 return 0;
146}
147
148/* Init line number list */
149static void line_list__init(struct list_head *head)
150{
151 INIT_LIST_HEAD(head);
152}
153
154/* Free line number list */
155static void line_list__free(struct list_head *head)
156{
157 struct line_node *ln;
158 while (!list_empty(head)) {
159 ln = list_first_entry(head, struct line_node, list);
160 list_del(&ln->list);
161 free(ln);
162 }
163}
164
165/* Dwarf wrappers */
166
167/* Find the realpath of the target file. */
168static const char *cu_find_realpath(Dwarf_Die *cu_die, const char *fname)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400169{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500170 Dwarf_Files *files;
171 size_t nfiles, i;
172 const char *src;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400173 int ret;
174
175 if (!fname)
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500176 return NULL;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500177
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500178 ret = dwarf_getsrcfiles(cu_die, &files, &nfiles);
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500179 if (ret != 0)
180 return NULL;
181
182 for (i = 0; i < nfiles; i++) {
183 src = dwarf_filesrc(files, i, NULL, NULL);
184 if (strtailcmp(src, fname) == 0)
185 break;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500186 }
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500187 return src;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500188}
189
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500190struct __addr_die_search_param {
191 Dwarf_Addr addr;
192 Dwarf_Die *die_mem;
193};
194
195static int __die_search_func_cb(Dwarf_Die *fn_die, void *data)
196{
197 struct __addr_die_search_param *ad = data;
198
199 if (dwarf_tag(fn_die) == DW_TAG_subprogram &&
200 dwarf_haspc(fn_die, ad->addr)) {
201 memcpy(ad->die_mem, fn_die, sizeof(Dwarf_Die));
202 return DWARF_CB_ABORT;
203 }
204 return DWARF_CB_OK;
205}
206
207/* Search a real subprogram including this line, */
208static Dwarf_Die *die_get_real_subprogram(Dwarf_Die *cu_die, Dwarf_Addr addr,
209 Dwarf_Die *die_mem)
210{
211 struct __addr_die_search_param ad;
212 ad.addr = addr;
213 ad.die_mem = die_mem;
214 /* dwarf_getscopes can't find subprogram. */
215 if (!dwarf_getfuncs(cu_die, __die_search_func_cb, &ad, 0))
216 return NULL;
217 else
218 return die_mem;
219}
220
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500221/* Similar to dwarf_getfuncs, but returns inlined_subroutine if exists. */
222static Dwarf_Die *die_get_inlinefunc(Dwarf_Die *sp_die, Dwarf_Addr addr,
223 Dwarf_Die *die_mem)
224{
225 Dwarf_Die child_die;
226 int ret;
227
228 ret = dwarf_child(sp_die, die_mem);
229 if (ret != 0)
230 return NULL;
231
232 do {
233 if (dwarf_tag(die_mem) == DW_TAG_inlined_subroutine &&
234 dwarf_haspc(die_mem, addr))
235 return die_mem;
236
237 if (die_get_inlinefunc(die_mem, addr, &child_die)) {
238 memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
239 return die_mem;
240 }
241 } while (dwarf_siblingof(die_mem, die_mem) == 0);
242
243 return NULL;
244}
245
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400246/* Compare diename and tname */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500247static bool die_compare_name(Dwarf_Die *dw_die, const char *tname)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400248{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500249 const char *name;
250 name = dwarf_diename(dw_die);
251 DIE_IF(name == NULL);
252 return strcmp(tname, name);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400253}
254
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400255/* Get entry pc(or low pc, 1st entry of ranges) of the die */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500256static Dwarf_Addr die_get_entrypc(Dwarf_Die *dw_die)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400257{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500258 Dwarf_Addr epc;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400259 int ret;
260
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500261 ret = dwarf_entrypc(dw_die, &epc);
262 DIE_IF(ret == -1);
263 return epc;
264}
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400265
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500266/* Get a variable die */
267static Dwarf_Die *die_find_variable(Dwarf_Die *sp_die, const char *name,
268 Dwarf_Die *die_mem)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500269{
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500270 Dwarf_Die child_die;
271 int tag;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400272 int ret;
273
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500274 ret = dwarf_child(sp_die, die_mem);
275 if (ret != 0)
276 return NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400277
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500278 do {
279 tag = dwarf_tag(die_mem);
280 if ((tag == DW_TAG_formal_parameter ||
281 tag == DW_TAG_variable) &&
282 (die_compare_name(die_mem, name) == 0))
283 return die_mem;
284
285 if (die_find_variable(die_mem, name, &child_die)) {
286 memcpy(die_mem, &child_die, sizeof(Dwarf_Die));
287 return die_mem;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400288 }
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500289 } while (dwarf_siblingof(die_mem, die_mem) == 0);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400290
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500291 return NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400292}
293
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400294/*
295 * Probe finder related functions
296 */
297
298/* Show a location */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500299static void show_location(Dwarf_Op *op, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400300{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500301 unsigned int regn;
302 Dwarf_Word offs = 0;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400303 int deref = 0, ret;
304 const char *regs;
305
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500306 /* TODO: support CFA */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400307 /* If this is based on frame buffer, set the offset */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500308 if (op->atom == DW_OP_fbreg) {
309 if (pf->fb_ops == NULL)
310 die("The attribute of frame base is not supported.\n");
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400311 deref = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500312 offs = op->number;
313 op = &pf->fb_ops[0];
314 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400315
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500316 if (op->atom >= DW_OP_breg0 && op->atom <= DW_OP_breg31) {
317 regn = op->atom - DW_OP_breg0;
318 offs += op->number;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400319 deref = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500320 } else if (op->atom >= DW_OP_reg0 && op->atom <= DW_OP_reg31) {
321 regn = op->atom - DW_OP_reg0;
322 } else if (op->atom == DW_OP_bregx) {
323 regn = op->number;
324 offs += op->number2;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400325 deref = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500326 } else if (op->atom == DW_OP_regx) {
327 regn = op->number;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400328 } else
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500329 die("DW_OP %d is not supported.", op->atom);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400330
331 regs = get_arch_regstr(regn);
332 if (!regs)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500333 die("%u exceeds max register number.", regn);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400334
335 if (deref)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500336 ret = snprintf(pf->buf, pf->len, " %s=+%ju(%s)",
337 pf->var, (uintmax_t)offs, regs);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400338 else
339 ret = snprintf(pf->buf, pf->len, " %s=%s", pf->var, regs);
Masami Hiramatsu97698332009-10-16 20:08:18 -0400340 DIE_IF(ret < 0);
341 DIE_IF(ret >= pf->len);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400342}
343
344/* Show a variables in kprobe event format */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500345static void show_variable(Dwarf_Die *vr_die, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400346{
347 Dwarf_Attribute attr;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500348 Dwarf_Op *expr;
349 size_t nexpr;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400350 int ret;
351
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500352 if (dwarf_attr(vr_die, DW_AT_location, &attr) == NULL)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400353 goto error;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500354 /* TODO: handle more than 1 exprs */
355 ret = dwarf_getlocation_addr(&attr, (pf->addr - pf->cu_base),
356 &expr, &nexpr, 1);
357 if (ret <= 0 || nexpr == 0)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400358 goto error;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500359
360 show_location(expr, pf);
361 /* *expr will be cached in libdw. Don't free it. */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400362 return ;
363error:
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500364 /* TODO: Support const_value */
Masami Hiramatsu074fc0e2009-10-16 20:08:01 -0400365 die("Failed to find the location of %s at this address.\n"
Masami Hiramatsubbaa46f2010-01-05 17:47:03 -0500366 " Perhaps, it has been optimized out.", pf->var);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400367}
368
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400369/* Find a variable in a subprogram die */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500370static void find_variable(Dwarf_Die *sp_die, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400371{
372 int ret;
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500373 Dwarf_Die vr_die;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400374
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500375 /* TODO: Support struct members and arrays */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400376 if (!is_c_varname(pf->var)) {
377 /* Output raw parameters */
378 ret = snprintf(pf->buf, pf->len, " %s", pf->var);
Masami Hiramatsu97698332009-10-16 20:08:18 -0400379 DIE_IF(ret < 0);
380 DIE_IF(ret >= pf->len);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400381 return ;
382 }
383
Arnaldo Carvalho de Melob7cb10e2009-10-21 17:34:06 -0200384 pr_debug("Searching '%s' variable in context.\n", pf->var);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400385 /* Search child die for local variables and parameters. */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500386 if (!die_find_variable(sp_die, pf->var, &vr_die))
Masami Hiramatsubbaa46f2010-01-05 17:47:03 -0500387 die("Failed to find '%s' in this function.", pf->var);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500388
389 show_variable(&vr_die, pf);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400390}
391
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400392/* Show a probe point to output buffer */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500393static void show_probe_point(Dwarf_Die *sp_die, struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400394{
395 struct probe_point *pp = pf->pp;
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500396 Dwarf_Addr eaddr;
397 Dwarf_Die die_mem;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500398 const char *name;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400399 char tmp[MAX_PROBE_BUFFER];
400 int ret, i, len;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500401 Dwarf_Attribute fb_attr;
402 size_t nops;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400403
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500404 /* If no real subprogram, find a real one */
405 if (!sp_die || dwarf_tag(sp_die) != DW_TAG_subprogram) {
406 sp_die = die_get_real_subprogram(&pf->cu_die,
407 pf->addr, &die_mem);
408 if (!sp_die)
409 die("Probe point is not found in subprograms.");
410 }
411
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400412 /* Output name of probe point */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500413 name = dwarf_diename(sp_die);
414 if (name) {
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500415 dwarf_entrypc(sp_die, &eaddr);
416 ret = snprintf(tmp, MAX_PROBE_BUFFER, "%s+%lu", name,
417 (unsigned long)(pf->addr - eaddr));
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400418 /* Copy the function name if possible */
419 if (!pp->function) {
420 pp->function = strdup(name);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500421 pp->offset = (size_t)(pf->addr - eaddr);
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400422 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400423 } else {
424 /* This function has no name. */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500425 ret = snprintf(tmp, MAX_PROBE_BUFFER, "0x%jx",
426 (uintmax_t)pf->addr);
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400427 if (!pp->function) {
428 /* TODO: Use _stext */
429 pp->function = strdup("");
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500430 pp->offset = (size_t)pf->addr;
Masami Hiramatsu253977b2009-10-27 16:43:10 -0400431 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400432 }
Masami Hiramatsu97698332009-10-16 20:08:18 -0400433 DIE_IF(ret < 0);
434 DIE_IF(ret >= MAX_PROBE_BUFFER);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400435 len = ret;
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400436 pr_debug("Probe point found: %s\n", tmp);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400437
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500438 /* Get the frame base attribute/ops */
439 dwarf_attr(sp_die, DW_AT_frame_base, &fb_attr);
440 ret = dwarf_getlocation_addr(&fb_attr, (pf->addr - pf->cu_base),
441 &pf->fb_ops, &nops, 1);
442 if (ret <= 0 || nops == 0)
443 pf->fb_ops = NULL;
444
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400445 /* Find each argument */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500446 /* TODO: use dwarf_cfi_addrframe */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400447 for (i = 0; i < pp->nr_args; i++) {
448 pf->var = pp->args[i];
449 pf->buf = &tmp[len];
450 pf->len = MAX_PROBE_BUFFER - len;
451 find_variable(sp_die, pf);
452 len += strlen(pf->buf);
453 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500454
455 /* *pf->fb_ops will be cached in libdw. Don't free it. */
456 pf->fb_ops = NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400457
458 pp->probes[pp->found] = strdup(tmp);
459 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);
508 fbuf = malloc(st.st_size + 2);
509 DIE_IF(fbuf == NULL);
510 DIE_IF(read(fd, fbuf, st.st_size) < 0);
511 close(fd);
512 fbuf[st.st_size] = '\n'; /* Dummy line */
513 fbuf[st.st_size + 1] = '\0';
514 p1 = fbuf;
515 line = 1;
516 while ((p2 = strchr(p1, '\n')) != NULL) {
517 *p2 = '\0';
518 if (strlazymatch(p1, pat)) {
519 line_list__add_line(head, line);
520 nlines++;
521 }
522 line++;
523 p1 = p2 + 1;
524 }
525 free(fbuf);
526 return nlines;
527}
528
529/* Find probe points from lazy pattern */
530static void find_probe_point_lazy(Dwarf_Die *sp_die, struct probe_finder *pf)
531{
532 Dwarf_Lines *lines;
533 Dwarf_Line *line;
534 size_t nlines, i;
535 Dwarf_Addr addr;
536 Dwarf_Die die_mem;
537 int lineno;
538 int ret;
539
540 if (list_empty(&pf->lcache)) {
541 /* Matching lazy line pattern */
542 ret = find_lazy_match_lines(&pf->lcache, pf->fname,
543 pf->pp->lazy_line);
544 if (ret <= 0)
545 die("No matched lines found in %s.", pf->fname);
546 }
547
548 ret = dwarf_getsrclines(&pf->cu_die, &lines, &nlines);
549 DIE_IF(ret != 0);
550 for (i = 0; i < nlines; i++) {
551 line = dwarf_onesrcline(lines, i);
552
553 dwarf_lineno(line, &lineno);
554 if (!line_list__has_line(&pf->lcache, lineno))
555 continue;
556
557 /* TODO: Get fileno from line, but how? */
558 if (strtailcmp(dwarf_linesrc(line, NULL, NULL), pf->fname) != 0)
559 continue;
560
561 ret = dwarf_lineaddr(line, &addr);
562 DIE_IF(ret != 0);
563 if (sp_die) {
564 /* Address filtering 1: does sp_die include addr? */
565 if (!dwarf_haspc(sp_die, addr))
566 continue;
567 /* Address filtering 2: No child include addr? */
568 if (die_get_inlinefunc(sp_die, addr, &die_mem))
569 continue;
570 }
571
572 pr_debug("Probe line found: line[%d]:%d addr:0x%llx\n",
573 (int)i, lineno, (unsigned long long)addr);
574 pf->addr = addr;
575
576 show_probe_point(sp_die, pf);
577 /* Continuing, because target line might be inlined. */
578 }
579 /* TODO: deallocate lines, but how? */
580}
581
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500582static int probe_point_inline_cb(Dwarf_Die *in_die, void *data)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400583{
584 struct probe_finder *pf = (struct probe_finder *)data;
585 struct probe_point *pp = pf->pp;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400586
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500587 if (pp->lazy_line)
588 find_probe_point_lazy(in_die, pf);
589 else {
590 /* Get probe address */
591 pf->addr = die_get_entrypc(in_die);
592 pf->addr += pp->offset;
593 pr_debug("found inline addr: 0x%jx\n",
594 (uintmax_t)pf->addr);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500595
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500596 show_probe_point(in_die, pf);
597 }
598
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500599 return DWARF_CB_OK;
600}
601
602/* Search function from function name */
603static int probe_point_search_cb(Dwarf_Die *sp_die, void *data)
604{
605 struct probe_finder *pf = (struct probe_finder *)data;
606 struct probe_point *pp = pf->pp;
607
608 /* Check tag and diename */
609 if (dwarf_tag(sp_die) != DW_TAG_subprogram ||
610 die_compare_name(sp_die, pp->function) != 0)
611 return 0;
612
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500613 pf->fname = dwarf_decl_file(sp_die);
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500614 if (pp->line) { /* Function relative line */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500615 dwarf_decl_line(sp_die, &pf->lno);
616 pf->lno += pp->line;
617 find_probe_point_by_line(pf);
618 } else if (!dwarf_func_inline(sp_die)) {
619 /* Real function */
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500620 if (pp->lazy_line)
621 find_probe_point_lazy(sp_die, pf);
622 else {
623 pf->addr = die_get_entrypc(sp_die);
624 pf->addr += pp->offset;
625 /* TODO: Check the address in this function */
626 show_probe_point(sp_die, pf);
627 }
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500628 } else
629 /* Inlined function: search instances */
630 dwarf_func_inline_instances(sp_die, probe_point_inline_cb, pf);
631
632 return 1; /* Exit; no same symbol in this CU. */
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400633}
634
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500635static void find_probe_point_by_func(struct probe_finder *pf)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400636{
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500637 dwarf_getfuncs(&pf->cu_die, probe_point_search_cb, pf, 0);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400638}
639
640/* Find a probe point */
Masami Hiramatsu81cb8aa2010-02-25 08:35:34 -0500641int find_probe_point(int fd, struct probe_point *pp)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400642{
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400643 struct probe_finder pf = {.pp = pp};
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500644 int ret;
645 Dwarf_Off off, noff;
646 size_t cuhl;
647 Dwarf_Die *diep;
648 Dwarf *dbg;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400649
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500650 dbg = dwarf_begin(fd, DWARF_C_READ);
651 if (!dbg)
Masami Hiramatsua225a1d2009-11-03 19:12:30 -0500652 return -ENOENT;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400653
654 pp->found = 0;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500655 off = 0;
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500656 line_list__init(&pf.lcache);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500657 /* Loop on CUs (Compilation Unit) */
658 while (!dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL)) {
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400659 /* Get the DIE(Debugging Information Entry) of this CU */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500660 diep = dwarf_offdie(dbg, off + cuhl, &pf.cu_die);
661 if (!diep)
662 continue;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400663
664 /* Check if target file is included. */
665 if (pp->file)
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500666 pf.fname = cu_find_realpath(&pf.cu_die, pp->file);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500667 else
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500668 pf.fname = NULL;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400669
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500670 if (!pp->file || pf.fname) {
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400671 /* Save CU base address (for frame_base) */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500672 ret = dwarf_lowpc(&pf.cu_die, &pf.cu_base);
673 if (ret != 0)
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400674 pf.cu_base = 0;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400675 if (pp->function)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500676 find_probe_point_by_func(&pf);
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500677 else if (pp->lazy_line)
678 find_probe_point_lazy(NULL, &pf);
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400679 else {
680 pf.lno = pp->line;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500681 find_probe_point_by_line(&pf);
Masami Hiramatsub0ef0732009-10-27 16:43:19 -0400682 }
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400683 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500684 off = noff;
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400685 }
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500686 line_list__free(&pf.lcache);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500687 dwarf_end(dbg);
Masami Hiramatsu4ea42b12009-10-08 17:17:38 -0400688
689 return pp->found;
690}
691
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500692/* Find line range from its line number */
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500693static void find_line_range_by_line(Dwarf_Die *sp_die, struct line_finder *lf)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500694{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500695 Dwarf_Lines *lines;
696 Dwarf_Line *line;
697 size_t nlines, i;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500698 Dwarf_Addr addr;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500699 int lineno;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500700 int ret;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500701 const char *src;
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500702 Dwarf_Die die_mem;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500703
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500704 line_list__init(&lf->lr->line_list);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500705 ret = dwarf_getsrclines(&lf->cu_die, &lines, &nlines);
706 DIE_IF(ret != 0);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500707
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500708 for (i = 0; i < nlines; i++) {
709 line = dwarf_onesrcline(lines, i);
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500710 ret = dwarf_lineno(line, &lineno);
711 DIE_IF(ret != 0);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500712 if (lf->lno_s > lineno || lf->lno_e < lineno)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500713 continue;
714
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500715 if (sp_die) {
716 /* Address filtering 1: does sp_die include addr? */
717 ret = dwarf_lineaddr(line, &addr);
718 DIE_IF(ret != 0);
719 if (!dwarf_haspc(sp_die, addr))
720 continue;
721
722 /* Address filtering 2: No child include addr? */
723 if (die_get_inlinefunc(sp_die, addr, &die_mem))
724 continue;
725 }
726
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500727 /* TODO: Get fileno from line, but how? */
728 src = dwarf_linesrc(line, NULL, NULL);
729 if (strtailcmp(src, lf->fname) != 0)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500730 continue;
731
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500732 /* Copy real path */
733 if (!lf->lr->path)
734 lf->lr->path = strdup(src);
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500735 line_list__add_line(&lf->lr->line_list, (unsigned int)lineno);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500736 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500737 /* Update status */
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500738 if (!list_empty(&lf->lr->line_list))
739 lf->found = 1;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500740 else {
741 free(lf->lr->path);
742 lf->lr->path = NULL;
743 }
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500744}
745
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500746static int line_range_inline_cb(Dwarf_Die *in_die, void *data)
747{
748 find_line_range_by_line(in_die, (struct line_finder *)data);
749 return DWARF_CB_ABORT; /* No need to find other instances */
750}
751
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500752/* Search function from function name */
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500753static int line_range_search_cb(Dwarf_Die *sp_die, void *data)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500754{
755 struct line_finder *lf = (struct line_finder *)data;
756 struct line_range *lr = lf->lr;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500757
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500758 if (dwarf_tag(sp_die) == DW_TAG_subprogram &&
759 die_compare_name(sp_die, lr->function) == 0) {
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500760 lf->fname = dwarf_decl_file(sp_die);
761 dwarf_decl_line(sp_die, &lr->offset);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500762 pr_debug("fname: %s, lineno:%d\n", lf->fname, lr->offset);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500763 lf->lno_s = lr->offset + lr->start;
764 if (!lr->end)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500765 lf->lno_e = INT_MAX;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500766 else
767 lf->lno_e = lr->offset + lr->end;
768 lr->start = lf->lno_s;
769 lr->end = lf->lno_e;
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500770 if (dwarf_func_inline(sp_die))
771 dwarf_func_inline_instances(sp_die,
772 line_range_inline_cb, lf);
773 else
774 find_line_range_by_line(sp_die, lf);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500775 return 1;
776 }
777 return 0;
778}
779
780static void find_line_range_by_func(struct line_finder *lf)
781{
Masami Hiramatsue92b85e2010-02-25 08:35:50 -0500782 dwarf_getfuncs(&lf->cu_die, line_range_search_cb, lf, 0);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500783}
784
785int find_line_range(int fd, struct line_range *lr)
786{
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500787 struct line_finder lf = {.lr = lr, .found = 0};
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500788 int ret;
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500789 Dwarf_Off off = 0, noff;
790 size_t cuhl;
791 Dwarf_Die *diep;
792 Dwarf *dbg;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500793
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500794 dbg = dwarf_begin(fd, DWARF_C_READ);
795 if (!dbg)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500796 return -ENOENT;
797
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500798 /* Loop on CUs (Compilation Unit) */
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500799 while (!lf.found) {
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500800 ret = dwarf_nextcu(dbg, off, &noff, &cuhl, NULL, NULL, NULL);
801 if (ret != 0)
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500802 break;
803
804 /* Get the DIE(Debugging Information Entry) of this CU */
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500805 diep = dwarf_offdie(dbg, off + cuhl, &lf.cu_die);
806 if (!diep)
807 continue;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500808
809 /* Check if target file is included. */
810 if (lr->file)
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500811 lf.fname = cu_find_realpath(&lf.cu_die, lr->file);
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500812 else
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500813 lf.fname = 0;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500814
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500815 if (!lr->file || lf.fname) {
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500816 if (lr->function)
817 find_line_range_by_func(&lf);
818 else {
819 lf.lno_s = lr->start;
820 if (!lr->end)
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500821 lf.lno_e = INT_MAX;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500822 else
823 lf.lno_e = lr->end;
Masami Hiramatsu161a26b2010-02-25 08:35:57 -0500824 find_line_range_by_line(NULL, &lf);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500825 }
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500826 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500827 off = noff;
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500828 }
Masami Hiramatsu804b3602010-02-25 08:35:42 -0500829 pr_debug("path: %lx\n", (unsigned long)lr->path);
830 dwarf_end(dbg);
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500831 return lf.found;
832}
833