Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use strtol instead of sscanf+sprintf for parsing and error checking.
[simgrid.git] / src / xbt / backtrace_linux.c
1 /* backtrace_linux - backtrace displaying on linux platform                 */
2 /* This file is included by ex.c on need (have execinfo.h, popen & addrline)*/
3
4 /* Copyright (c) 2008, 2009, 2010. The SimGrid Team.
5  * All rights reserved.                                                     */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 /* This file is to be included in ex.c, so the following headers are not mandatory, but it's to make sure that eclipse see them too */
11 #include "xbt/ex.h"
12 #include "xbt/str.h"
13 #include "xbt/module.h"         /* xbt_binary_name */
14 #include "xbt_modinter.h"       /* backtrace initialization headers */
15 /* end of "useless" inclusions */
16
17 extern char **environ;          /* the environment, as specified by the opengroup */
18
19 /* Module creation/destruction: nothing to do on linux */
20 void xbt_backtrace_preinit(void)
21 {
22 }
23
24 void xbt_backtrace_postexit(void)
25 {
26 }
27
28 void xbt_backtrace_current(xbt_ex_t * e)
29 {
30   e->used = backtrace((void **) e->bt, XBT_BACKTRACE_SIZE);
31 }
32
33
34 void xbt_ex_setup_backtrace(xbt_ex_t * e)
35 {
36   int i;
37
38   /* to get the backtrace from the libc */
39   char **backtrace_syms;
40
41   /* To build the commandline of addr2line */
42   char *cmd, *curr;
43
44   /* to extract the addresses from the backtrace */
45   char **addrs;
46   char buff[256], *p;
47
48   /* To read the output of addr2line */
49   FILE *pipe;
50   char line_func[1024], line_pos[1024];
51
52   /* size (in char) of pointers on this arch */
53   int addr_len = 0;
54
55   /* To search for the right executable path when not trivial */
56   struct stat stat_buf;
57   char *binary_name = NULL;
58
59   xbt_assert(e
60               && e->used,
61               "Backtrace not setup yet, cannot set it up for display");
62
63   if (!xbt_binary_name) /* no binary name, nothing to do */
64     return;
65
66   backtrace_syms = backtrace_symbols(e->bt, e->used);
67   /* ignore first one, which is this xbt_backtrace_current() */
68   e->used--;
69   memmove(backtrace_syms, backtrace_syms + 1, sizeof(char *) * e->used);
70
71   e->bt_strings = NULL;
72
73   /* Some arches only have stubs of backtrace, no implementation (hppa comes to mind) */
74   if (!e->used)
75     return;
76
77   /* build the commandline */
78   if (stat(xbt_binary_name, &stat_buf)) {
79     /* Damn. binary not in current dir. We'll have to dig the PATH to find it */
80     int i;
81
82     for (i = 0; environ[i]; i++) {
83       if (!strncmp("PATH=", environ[i], 5)) {
84         xbt_dynar_t path = xbt_str_split(environ[i] + 5, ":");
85         unsigned int cpt;
86         char *data;
87
88         xbt_dynar_foreach(path, cpt, data) {
89           if (binary_name)
90             free(binary_name);
91           binary_name = bprintf("%s/%s", data, xbt_binary_name);
92           if (!stat(binary_name, &stat_buf)) {
93             /* Found. */
94             XBT_DEBUG("Looked in the PATH for the binary. Found %s",
95                    binary_name);
96             break;
97           }
98         }
99         xbt_dynar_free(&path);
100         if (stat(binary_name, &stat_buf)) {
101           /* not found */
102           e->used = 1;
103           e->bt_strings = xbt_new(char *, 1);
104
105           e->bt_strings[0] =
106               bprintf("(binary '%s' not found the path)", xbt_binary_name);
107           free(backtrace_syms);
108           return;
109         }
110         break;
111       }
112     }
113   } else {
114     binary_name = xbt_strdup(xbt_binary_name);
115   }
116   cmd = curr =
117       xbt_new(char,
118               strlen(ADDR2LINE) + 25 + strlen(binary_name) + 32 * e->used);
119
120   curr += sprintf(curr, "%s -f -e %s ", ADDR2LINE, binary_name);
121   free(binary_name);
122
123   addrs = xbt_new(char *, e->used);
124   for (i = 0; i < e->used; i++) {
125     /* retrieve this address */
126     XBT_DEBUG("Retrieving address number %d from '%s'", i, backtrace_syms[i]);
127     snprintf(buff, 256, "%s", strchr(backtrace_syms[i], '[') + 1);
128     p = strchr(buff, ']');
129     *p = '\0';
130     if (strcmp(buff, "(nil)"))
131       addrs[i] = xbt_strdup(buff);
132     else
133       addrs[i] = xbt_strdup("0x0");
134     XBT_DEBUG("Set up a new address: %d, '%s'(%p)", i, addrs[i], addrs[i]);
135
136     /* Add it to the command line args */
137     curr += sprintf(curr, "%s ", addrs[i]);
138   }
139   addr_len = strlen(addrs[0]);
140
141   /* parse the output and build a new backtrace */
142   e->bt_strings = xbt_new(char *, e->used);
143
144   XBT_VERB("Fire a first command: '%s'", cmd);
145   pipe = popen(cmd, "r");
146   if (!pipe) {
147     XBT_CRITICAL("Cannot fork addr2line to display the backtrace");
148     abort();
149   }
150
151   for (i = 0; i < e->used; i++) {
152     char *fgets_res;
153     XBT_DEBUG("Looking for symbol %d, addr = '%s'", i, addrs[i]);
154     fgets_res = fgets(line_func, 1024, pipe);
155     if (fgets_res == NULL)
156       THROWF(system_error, 0,
157              "Cannot run fgets to look for symbol %d, addr %s", i,
158              addrs[i]);
159     line_func[strlen(line_func) - 1] = '\0';
160     fgets_res = fgets(line_pos, 1024, pipe);
161     if (fgets_res == NULL)
162       THROWF(system_error, 0,
163              "Cannot run fgets to look for symbol %d, addr %s", i,
164              addrs[i]);
165     line_pos[strlen(line_pos) - 1] = '\0';
166
167     if (strcmp("??", line_func)) {
168       XBT_DEBUG("Found static symbol %s() at %s", line_func, line_pos);
169       e->bt_strings[i] =
170           bprintf("**   In %s() at %s", line_func, line_pos);
171     } else {
172       /* Damn. The symbol is in a dynamic library. Let's get wild */
173       char *maps_name;
174       FILE *maps;
175       char maps_buff[512];
176
177       long int addr, offset = 0;
178       char *p, *p2;
179
180       char *subcmd;
181       FILE *subpipe;
182       int found = 0;
183
184       /* let's look for the offset of this library in our addressing space */
185       maps_name = bprintf("/proc/%d/maps", (int) getpid());
186       maps = fopen(maps_name, "r");
187
188       addr = strtol(addrs[i], &p, 16);
189       if (*p != '\0') {
190         XBT_CRITICAL("Cannot parse backtrace address '%s' (addr=%#lx)",
191                   addrs[i], addr);
192       }
193       XBT_DEBUG("addr=%s (as string) =%#lx (as number)", addrs[i], addr);
194
195       while (!found) {
196         long int first, last;
197
198         if (fgets(maps_buff, 512, maps) == NULL)
199           break;
200         if (i == 0) {
201           maps_buff[strlen(maps_buff) - 1] = '\0';
202           XBT_DEBUG("map line: %s", maps_buff);
203         }
204         sscanf(maps_buff, "%lx", &first);
205         p = strchr(maps_buff, '-') + 1;
206         sscanf(p, "%lx", &last);
207         if (first < addr && addr < last) {
208           offset = first;
209           found = 1;
210         }
211         if (found) {
212           XBT_DEBUG("%#lx in [%#lx-%#lx]", addr, first, last);
213           XBT_DEBUG
214               ("Symbol found, map lines not further displayed (even if looking for next ones)");
215         }
216       }
217       fclose(maps);
218       free(maps_name);
219       free(addrs[i]);
220
221       if (!found) {
222         XBT_VERB
223             ("Problem while reading the maps file. Following backtrace will be mangled.");
224         XBT_DEBUG("No dynamic. Static symbol: %s", backtrace_syms[i]);
225         e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace_syms[i]);
226         continue;
227       }
228
229       /* Ok, Found the offset of the maps line containing the searched symbol.
230          We now need to substract this from the address we got from backtrace.
231        */
232
233       addrs[i] = bprintf("0x%0*lx", addr_len - 2, addr - offset);
234       XBT_DEBUG("offset=%#lx new addr=%s", offset, addrs[i]);
235
236       /* Got it. We have our new address. Let's get the library path and we
237          are set */
238       p = xbt_strdup(backtrace_syms[i]);
239       if (p[0] == '[') {
240         /* library path not displayed in the map file either... */
241         free(p);
242         sprintf(line_func, "??");
243       } else {
244         p2 = strrchr(p, '(');
245         if (p2)
246           *p2 = '\0';
247         p2 = strrchr(p, ' ');
248         if (p2)
249           *p2 = '\0';
250
251         /* Here we go, fire an addr2line up */
252         subcmd = bprintf("%s -f -e %s %s", ADDR2LINE, p, addrs[i]);
253         free(p);
254         XBT_VERB("Fire a new command: '%s'", subcmd);
255         subpipe = popen(subcmd, "r");
256         if (!subpipe) {
257           XBT_CRITICAL("Cannot fork addr2line to display the backtrace");
258           abort();
259         }
260         fgets_res = fgets(line_func, 1024, subpipe);
261         if (fgets_res == NULL)
262           THROWF(system_error, 0, "Cannot read result of subcommand %s",
263                  subcmd);
264         line_func[strlen(line_func) - 1] = '\0';
265         fgets_res = fgets(line_pos, 1024, subpipe);
266         if (fgets_res == NULL)
267           THROWF(system_error, 0, "Cannot read result of subcommand %s",
268                  subcmd);
269         line_pos[strlen(line_pos) - 1] = '\0';
270         pclose(subpipe);
271         free(subcmd);
272       }
273
274       /* check whether the trick worked */
275       if (strcmp("??", line_func)) {
276         XBT_DEBUG("Found dynamic symbol %s() at %s", line_func, line_pos);
277         e->bt_strings[i] =
278             bprintf("**   In %s() at %s", line_func, line_pos);
279       } else {
280         /* damn, nothing to do here. Let's print the raw address */
281         XBT_DEBUG("Dynamic symbol not found. Raw address = %s",
282                backtrace_syms[i]);
283         e->bt_strings[i] = bprintf("**   In ?? at %s", backtrace_syms[i]);
284       }
285
286     }
287     free(addrs[i]);
288
289     /* Mask the bottom of the stack */
290     if (!strncmp("main", line_func, strlen("main")) ||
291         !strncmp("xbt_thread_context_wrapper", line_func,
292                  strlen("xbt_thread_context_wrapper"))
293         || !strncmp("smx_ctx_sysv_wrapper", line_func,
294                     strlen("smx_ctx_sysv_wrapper"))) {
295       int j;
296
297       for (j = i + 1; j < e->used; j++)
298         free(addrs[j]);
299       e->used = i + 1;
300
301       if (!strncmp
302           ("xbt_thread_context_wrapper", line_func,
303            strlen("xbt_thread_context_wrapper"))) {
304         free(e->bt_strings[i]);
305         e->bt_strings[i] = xbt_strdup("**   (in a separate thread)");
306       }
307     }
308
309
310   }
311   pclose(pipe);
312   free(addrs);
313   free(backtrace_syms);
314   free(cmd);
315 }