Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
9b0c66b6f25022bf6aaced375911520b6f6b9669
[simgrid.git] / src / xbt / ex.c
1 /* $Id$ */
2
3 /* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
4
5 /*  Copyright (c) 2005-2006 Martin Quinson                                  */
6 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
7 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
8 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
9 /*  All rights reserved.                                                    */
10
11 /* This program is free software; you can redistribute it and/or modify it
12  * under the terms of the license (GNU LGPL) which comes with this package. */
13
14 #include <stdio.h>
15 #include <stdlib.h>
16
17 #include "portable.h" /* execinfo when available */
18 #include "xbt/ex.h"
19 #include "xbt/module.h" /* xbt_binary_name */
20 #include "xbt/ex_interface.h"
21
22 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
23
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex,xbt,"Exception mecanism");
25
26
27 /* default __ex_ctx callback function */
28 ex_ctx_t *__xbt_ex_ctx_default(void) {
29     static ex_ctx_t ctx = XBT_CTX_INITIALIZER;
30
31     return &ctx;
32 }
33
34
35 /** \brief show the backtrace of the current point (lovely while debuging) */
36 void xbt_backtrace_display(void) {
37 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
38   xbt_ex_t e;
39   int i;
40
41   e.used     = backtrace((void**)e.bt,XBT_BACKTRACE_SIZE);
42   e.bt_strings = NULL;
43   xbt_ex_setup_backtrace(&e);
44   for (i=1; i<e.used; i++) /* no need to display "xbt_display_backtrace" */
45     fprintf(stderr,"%s\n",e.bt_strings[i]);
46
47   e.msg=NULL;
48   e.remote=0;
49   xbt_ex_free(e);
50 #else 
51   ERROR0("No backtrace on this arch");
52 #endif
53 }
54
55
56 void xbt_ex_setup_backtrace(xbt_ex_t *e)  {
57 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
58   int i;
59   /* to get the backtrace from the libc */
60   char **backtrace = backtrace_symbols (e->bt, e->used);
61   
62   /* To build the commandline of addr2line */
63   char *cmd = xbt_new(char,strlen(ADDR2LINE)+25+strlen(xbt_binary_name)+32*e->used);
64   char *curr=cmd;
65   
66   /* to extract the addresses from the backtrace */
67   char **addrs=xbt_new(char*,e->used);
68   char buff[256],*p;
69   
70   /* To read the output of addr2line */
71   FILE *pipe;
72   char line_func[1024],line_pos[1024];
73
74   /* size (in char) of pointers on this arch */
75   int addr_len=0;
76
77   /* Some arches only have stubs of backtrace, no implementation (hppa comes to mind) */
78   if (!e->used)
79      return;
80    
81   /* build the commandline */
82   curr += sprintf(curr,"%s -f -e %s ",ADDR2LINE,xbt_binary_name);
83   for (i=0; i<e->used;i++) {
84     /* retrieve this address */
85     DEBUG2("Retrieving address number %d from '%s'", i, backtrace[i]);
86     snprintf(buff,256,"%s",strchr(backtrace[i],'[')+1);
87     p=strchr(buff,']');
88     *p='\0';
89     if (strcmp(buff,"(nil)"))
90        addrs[i]=bprintf("%s", buff);
91     else
92        addrs[i]=bprintf("0x0");
93     DEBUG3("Set up a new address: %d, '%s'(%p)", i, addrs[i], addrs[i]);
94      
95     /* Add it to the command line args */
96     curr+=sprintf(curr,"%s ",addrs[i]);
97   }      
98   addr_len = strlen(addrs[0]);
99
100   /* parse the output and build a new backtrace */
101   e->bt_strings = xbt_new(char*,e->used);
102   
103   VERB1("Fire a first command: '%s'", cmd);
104   pipe = popen(cmd, "r");
105   if (!pipe) {
106     CRITICAL0("Cannot fork addr2line to display the backtrace");
107     abort();
108   }
109
110   for (i=0; i<e->used; i++) {
111     DEBUG2("Looking for symbol %d, addr = '%s'", i, addrs[i]); 
112     fgets(line_func,1024,pipe);
113     line_func[strlen(line_func)-1]='\0';
114     fgets(line_pos,1024,pipe);
115     line_pos[strlen(line_pos)-1]='\0';
116
117     if (strcmp("??",line_func)) {
118       DEBUG2("Found static symbol %s() at %s", line_func, line_pos);
119       e->bt_strings[i] = bprintf("**   In %s() at %s", line_func,line_pos);
120     } else {
121       /* Damn. The symbol is in a dynamic library. Let's get wild */
122       char *maps_name;
123       FILE *maps;
124       char maps_buff[512];
125
126       long int addr,offset=0;
127       char *p,*p2;
128
129       char *subcmd;
130       FILE *subpipe;
131       int found=0;
132
133       /* let's look for the offset of this library in our addressing space */
134       maps_name=bprintf("/proc/%d/maps",(int)getpid());
135       maps=fopen(maps_name,"r");
136
137       sscanf(addrs[i],"%lx",&addr);
138       sprintf(maps_buff,"%#lx",addr);
139       
140       if (strcmp(addrs[i],maps_buff)) {
141         CRITICAL2("Cannot parse backtrace address '%s' (addr=%#lx)",
142                   addrs[i], addr);
143       }
144       DEBUG2("addr=%s (as string) =%#lx (as number)",addrs[i],addr);
145
146       while (!found) {
147         long int first, last;
148         if (fgets(maps_buff,512,maps) == NULL) 
149           break;
150         if (i==0) {
151           maps_buff[strlen(maps_buff) -1]='\0';
152           DEBUG1("map line: %s", maps_buff);
153         }
154         sscanf(maps_buff,"%lx",&first);
155         p=strchr(maps_buff,'-')+1;
156         sscanf(p,"%lx",&last);
157         if (first < addr && addr < last) {
158           offset = first;
159           found=1;
160         }
161         if (found) {          
162            DEBUG3("%#lx in [%#lx-%#lx]", addr, first,last);
163            DEBUG0("Symbol found, map lines not further displayed (even if looking for next ones)");
164       }
165       fclose(maps);
166       free(maps_name);
167
168       if (!found) {
169         VERB0("Problem while reading the maps file. Following backtrace will be mangled.");
170         DEBUG1("No dynamic. Static symbol: %s", backtrace[i]);
171         e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace[i]);
172         continue;
173       }
174
175       /* Ok, Found the offset of the maps line containing the searched symbol. 
176          We now need to substract this from the address we got from backtrace.
177       */
178       
179       free(addrs[i]);
180       addrs[i] = bprintf("0x%0*lx",addr_len-2,addr-offset);
181       DEBUG2("offset=%#lx new addr=%s",offset,addrs[i]);
182
183       /* Got it. We have our new address. Let's get the library path and we 
184          are set */ 
185       p  = xbt_strdup(backtrace[i]);
186       if (p[0]=='[') {
187          /* library path not displayed in the map file either... */
188          free(p);
189          sprintf(line_func,"??");
190       } else {
191          p2 = strrchr(p,'(');
192          if (p2) *p2= '\0';
193          p2 = strrchr(p,' ');
194          if(p2) *p2= '\0';
195       
196          /* Here we go, fire an addr2line up */
197          subcmd = bprintf("%s -f -e %s %s",ADDR2LINE,p, addrs[i]);
198          free(p);
199          VERB1("Fire a new command: '%s'",subcmd);
200          subpipe = popen(subcmd,"r");
201          if (!subpipe) {
202             CRITICAL0("Cannot fork addr2line to display the backtrace");
203             abort();
204          }
205          fgets(line_func,1024,subpipe);
206          line_func[strlen(line_func)-1]='\0';
207          fgets(line_pos,1024,subpipe);
208          line_pos[strlen(line_pos)-1]='\0';
209          pclose(subpipe);
210          free(subcmd);
211       }
212
213       /* check whether the trick worked */
214       if (strcmp("??",line_func)) {
215         DEBUG2("Found dynamic symbol %s() at %s", line_func, line_pos);
216         e->bt_strings[i] = bprintf("**   In %s() at %s", line_func,line_pos);
217       } else {
218         /* damn, nothing to do here. Let's print the raw address */
219         DEBUG1("Dynamic symbol not found. Raw address = %s", backtrace[i]);
220         e->bt_strings[i] = bprintf("**   In ?? at %s", backtrace[i]);
221       }
222       
223     }
224     free(addrs[i]);
225      
226     /* Mask the bottom of the stack */    
227     if (!strncmp("main",line_func,strlen("main"))) {
228        int j;
229        for (j=i+1; j<e->used; j++)
230          free(addrs[j]);
231        e->used = i+1;
232     }
233      
234     if (!strncmp("__context_wrapper",line_func,strlen("__context_wrapper"))) {
235        int j;
236        for (j=i+1; j<e->used; j++)
237          free(addrs[j]);
238        e->used = i;
239     }
240    
241     
242   }
243   pclose(pipe);
244   free(addrs);
245   free(backtrace);
246   free(cmd);
247 #endif
248 }    
249
250 /** @brief shows an exception content and the associated stack if available */
251 void xbt_ex_display(xbt_ex_t *e)  {
252   char *thrower=NULL;
253
254   if (e->remote)
255     bprintf(" on host %s(%d)",e->host,e->pid);
256
257   fprintf(stderr,
258           "** SimGrid: UNCAUGHT EXCEPTION received on %s(%d): category: %s; value: %d\n"
259           "** %s\n"
260           "** Thrown by %s()%s\n",
261           gras_os_myname(),(*xbt_getpid)(),
262           xbt_ex_catname(e->category), e->value, e->msg,
263           e->procname,thrower?thrower:" in this process");
264   CRITICAL1("%s",e->msg);
265
266   if (thrower)
267     free(thrower);
268
269   if (!e->remote && !e->bt_strings)
270     xbt_ex_setup_backtrace(e);
271
272 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
273   /* We have everything to build neat backtraces */
274   {
275     int i;
276     
277     fprintf(stderr,"\n");
278     for (i=0; i<e->used; i++)
279       fprintf(stderr,"%s\n",e->bt_strings[i]);
280     
281   }
282 #else
283   fprintf(stderr," at %s:%d:%s (no backtrace available on that arch)\n",  
284           e->file,e->line,e->func);
285 #endif
286   xbt_ex_free(*e);
287 }
288
289
290 /* default __ex_terminate callback function */
291 void __xbt_ex_terminate_default(xbt_ex_t *e)  {
292   xbt_ex_display(e);
293
294   abort();
295 }
296
297 /* the externally visible API */
298 XBT_PUBLIC_DATA(ex_ctx_cb_t)  __xbt_ex_ctx       = &__xbt_ex_ctx_default;
299 XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate = &__xbt_ex_terminate_default;
300
301
302 void xbt_ex_free(xbt_ex_t e) {
303   int i;
304
305   if (e.msg) free(e.msg);
306   if (e.remote) {
307     free(e.procname);
308     free(e.file);
309     free(e.func);
310     free(e.host);
311   }
312
313   if (e.bt_strings) {   
314      for (i=0; i<e.used; i++) 
315        free((char*)e.bt_strings[i]);
316      free((char **)e.bt_strings);
317   }
318   /* memset(e,0,sizeof(xbt_ex_t)); */
319 }
320
321 /** \brief returns a short name for the given exception category */
322 const char * xbt_ex_catname(xbt_errcat_t cat) {
323   switch (cat) {
324   case unknown_error:   return  "unknown_err";
325   case arg_error:       return "invalid_arg";
326   case mismatch_error:  return "mismatch";
327   case not_found_error: return "not found";
328   case system_error:    return "system_err";
329   case network_error:   return "network_err";
330   case timeout_error:   return "timeout";
331   case thread_error:    return "thread_err";
332   default:              return "INVALID_ERR";
333   }
334 }
335
336 #ifndef HAVE_EXECINFO_H
337 /* dummy implementation. We won't use the result, but ex.h needs it to be defined */
338 int backtrace (void **__array, int __size) {
339   return 0;
340 }
341
342 #endif
343
344 #ifdef SIMGRID_TEST
345 #include <stdio.h>
346 #include "xbt/ex.h"
347
348 XBT_TEST_SUITE("xbt_ex","Exception Handling");
349
350 XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") {
351     xbt_ex_t ex;
352     volatile int n=1;
353
354     xbt_test_add0("basic nested control flow");
355
356     TRY {
357         if (n != 1)
358             xbt_test_fail1("M1: n=%d (!= 1)", n);
359         n++;
360         TRY {
361             if (n != 2)
362                 xbt_test_fail1("M2: n=%d (!= 2)", n);
363             n++;
364             THROW0(unknown_error,0,"something");
365         } CATCH (ex) {
366             if (n != 3)
367                 xbt_test_fail1("M3: n=%d (!= 3)", n);
368             n++;
369             xbt_ex_free(ex);
370         }
371         n++;
372         TRY {
373             if (n != 5)
374                 xbt_test_fail1("M2: n=%d (!= 5)", n);
375             n++;
376             THROW0(unknown_error,0,"something");
377         } CATCH (ex) {
378             if (n != 6)
379                 xbt_test_fail1("M3: n=%d (!= 6)", n);
380             n++;
381             RETHROW;
382             n++;
383         }
384         xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n);
385     }
386     CATCH(ex) {
387         if (n != 7)
388             xbt_test_fail1("M4: n=%d (!= 7)", n);
389         n++;
390         xbt_ex_free(ex);
391     }
392     if (n != 8)
393         xbt_test_fail1("M5: n=%d (!= 8)", n);
394 }
395
396 XBT_TEST_UNIT("value",test_value,"exception value passing") {
397     xbt_ex_t ex;
398
399     TRY {
400         THROW0(unknown_error, 2, "toto");
401     } CATCH(ex) {
402         xbt_test_add0("exception value passing");
403         if (ex.category != unknown_error)
404             xbt_test_fail1("category=%d (!= 1)", ex.category);
405         if (ex.value != 2)
406             xbt_test_fail1("value=%d (!= 2)", ex.value);
407         if (strcmp(ex.msg,"toto"))
408             xbt_test_fail1("message=%s (!= toto)", ex.msg);
409         xbt_ex_free(ex);
410     }
411 }
412
413 XBT_TEST_UNIT("variables",test_variables,"variable value preservation") {
414     xbt_ex_t ex;
415     int r1, r2;
416     volatile int v1, v2;
417
418     r1 = r2 = v1 = v2 = 1234;
419     TRY {
420         r2 = 5678;
421         v2 = 5678;
422         THROW0(unknown_error, 0, "toto");
423     } CATCH(ex) {
424         xbt_test_add0("variable preservation");
425         if (r1 != 1234)
426             xbt_test_fail1("r1=%d (!= 1234)", r1);
427         if (v1 != 1234)
428             xbt_test_fail1("v1=%d (!= 1234)", v1);
429         /* r2 is allowed to be destroyed because not volatile */
430         if (v2 != 5678)
431             xbt_test_fail1("v2=%d (!= 5678)", v2);
432         xbt_ex_free(ex);
433     }
434 }
435
436 XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") {
437     xbt_ex_t ex;
438     volatile int v1;
439     int c;
440
441     xbt_test_add0("cleanup handling");
442
443     v1 = 1234;
444     c = 0;
445     TRY {
446         v1 = 5678;
447         THROW0(1, 2, "blah");
448     } CLEANUP {
449         if (v1 != 5678)
450             xbt_test_fail1("v1 = %d (!= 5678)", v1);
451         c = 1;
452     } CATCH(ex) {
453         if (v1 != 5678)
454             xbt_test_fail1("v1 = %d (!= 5678)", v1);
455         if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg,"blah")))
456             xbt_test_fail0("unexpected exception contents");
457         xbt_ex_free(ex);
458     }
459     if (!c)
460         xbt_test_fail0("xbt_ex_free not executed");
461 }
462
463
464 /*
465  * The following is the example included in the documentation. It's a good 
466  * idea to check its syntax even if we don't try to run it.
467  * And actually, it allows to put comments in the code despite doxygen.
468  */ 
469 static char *mallocex(int size) {
470   return NULL;
471 }
472 #define SMALLAMOUNT 10
473 #define TOOBIG 100000000
474
475 #if 0 /* this contains syntax errors, actually */
476 static void bad_example(void) {
477   struct {char*first;} *globalcontext;
478   ex_t ex;
479
480   /* BAD_EXAMPLE */
481   TRY {
482     char *cp1, *cp2, *cp3;
483     
484     cp1 = mallocex(SMALLAMOUNT);
485     globalcontext->first = cp1;
486     cp2 = mallocex(TOOBIG);
487     cp3 = mallocex(SMALLAMOUNT);
488     strcpy(cp1, "foo");
489     strcpy(cp2, "bar");
490   } CLEANUP {
491     if (cp3 != NULL) free(cp3);
492     if (cp2 != NULL) free(cp2);
493     if (cp1 != NULL) free(cp1);
494   } CATCH(ex) {
495     printf("cp3=%s", cp3);
496     RETHROW;
497   }
498   /* end_of_bad_example */
499 }
500 #endif
501 typedef struct {char *first;} global_context_t;
502    
503 static void good_example(void) {
504   global_context_t *global_context=malloc(sizeof(global_context_t));
505   xbt_ex_t ex;
506
507   /* GOOD_EXAMPLE */
508   { /*01*/
509     char * volatile /*03*/ cp1 = NULL /*02*/;
510     char * volatile /*03*/ cp2 = NULL /*02*/;
511     char * volatile /*03*/ cp3 = NULL /*02*/;
512     TRY {
513       cp1 = mallocex(SMALLAMOUNT);
514       global_context->first = cp1;
515       cp1 = NULL /*05 give away*/;
516       cp2 = mallocex(TOOBIG);
517       cp3 = mallocex(SMALLAMOUNT);
518       strcpy(cp1, "foo");
519       strcpy(cp2, "bar");
520     } CLEANUP { /*04*/
521       printf("cp3=%s", cp3 == NULL /*02*/ ? "" : cp3);
522       if (cp3 != NULL)
523         free(cp3);
524       if (cp2 != NULL)
525         free(cp2);
526       /*05 cp1 was given away */
527     } CATCH(ex) {
528       /*05 global context untouched */
529       RETHROW;
530     }
531   }
532   /* end_of_good_example */
533 }
534 #endif /* SIMGRID_TEST */