Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cleanups: macro renaming, improve documentation
[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     addrs[i]=bprintf("%s", buff);
90     DEBUG3("Set up a new address: %d, '%s'(%p)", i, addrs[i], addrs[i]);
91      
92     /* Add it to the command line args */
93     curr+=sprintf(curr,"%s ",addrs[i]);
94   }      
95   addr_len = strlen(addrs[0]);
96
97   /* parse the output and build a new backtrace */
98   e->bt_strings = xbt_new(char*,e->used);
99   
100   VERB1("Fire a first command: '%s'", cmd);
101   pipe = popen(cmd, "r");
102   if (!pipe) {
103     CRITICAL0("Cannot fork addr2line to display the backtrace");
104     abort();
105   }
106
107   for (i=0; i<e->used; i++) {
108     DEBUG2("Looking for symbol %d, addr = '%s'", i, addrs[i]); 
109     fgets(line_func,1024,pipe);
110     line_func[strlen(line_func)-1]='\0';
111     fgets(line_pos,1024,pipe);
112     line_pos[strlen(line_pos)-1]='\0';
113
114     if (strcmp("??",line_func)) {
115        DEBUG2("Found static symbol %s() at %s", line_func, line_pos);
116       e->bt_strings[i] = bprintf("**   In %s() at %s (static symbol)", line_func,line_pos);
117     } else {
118       /* Damn. The symbol is in a dynamic library. Let's get wild */
119       char *maps_name;
120       FILE *maps;
121       char maps_buff[512];
122
123       long int addr,offset=0;
124       char *p,*p2;
125
126       char *subcmd;
127       FILE *subpipe;
128       int found=0;
129
130       /* let's look for the offset of this library in our addressing space */
131       maps_name=bprintf("/proc/%d/maps",(int)getpid());
132       maps=fopen(maps_name,"r");
133
134       sscanf(addrs[i],"%lx",&addr);
135       sprintf(maps_buff,"%#lx",addr);
136       
137       if (strcmp(addrs[i],maps_buff)) {
138         CRITICAL2("Cannot parse backtrace address '%s' (addr=%#lx)",
139                   addrs[i], addr);
140       }
141       DEBUG2("addr=%s (as string) =%#lx (as number)",addrs[i],addr);
142
143       while (!found) {
144         long int first, last;
145         if (fgets(maps_buff,512,maps) == NULL) 
146           break;
147         if (i==0) {
148           maps_buff[strlen(maps_buff) -1]='\0';
149           DEBUG1("map line: %s", maps_buff);
150         }
151         sscanf(maps_buff,"%lx",&first);
152         p=strchr(maps_buff,'-')+1;
153         sscanf(p,"%lx",&last);
154         if (first < addr && addr < last) {
155           offset = first;
156           found=1;
157         }
158         DEBUG4("%#lx %s [%#lx-%#lx]",
159                addr, found? "in":"out of",first,last);
160       }
161       fclose(maps);
162       free(maps_name);
163
164       if (!found) {
165         VERB0("Problem while reading the maps file. Following backtrace will be mangled.");
166         DEBUG1("No dynamic. Static symbol: %s", backtrace[i]);
167         e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace[i]);
168         continue;
169       }
170
171       /* Ok, Found the offset of the maps line containing the searched symbol. 
172          We now need to substract this from the address we got from backtrace.
173       */
174       
175       free(addrs[i]);
176       addrs[i] = bprintf("0x%0*lx",addr_len-2,addr-offset);
177       DEBUG2("offset=%#lx new addr=%s",offset,addrs[i]);
178
179       /* Got it. We have our new address. Let's get the library path and we 
180          are set */ 
181       p  = xbt_strdup(backtrace[i]);
182       p2 = strrchr(p,'(');
183       if (p2) *p2= '\0';
184       p2 = strrchr(p,' ');
185       if(p2) *p2= '\0';
186       
187       /* Here we go, fire an addr2line up */
188       subcmd = bprintf("%s -f -e %s %s",ADDR2LINE,p, addrs[i]);
189       free(p);
190       VERB1("Fire a new command: '%s'",subcmd);
191       subpipe = popen(subcmd,"r");
192       if (!subpipe) {
193         CRITICAL0("Cannot fork addr2line to display the backtrace");
194         abort();
195       }
196       fgets(line_func,1024,subpipe);
197       line_func[strlen(line_func)-1]='\0';
198       fgets(line_pos,1024,subpipe);
199       line_pos[strlen(line_pos)-1]='\0';
200       pclose(subpipe);
201       free(subcmd);
202
203       /* check whether the trick worked */
204       if (strcmp("??",line_func)) {
205         DEBUG2("Found dynamic symbol %s() at %s", line_func, line_pos);
206         e->bt_strings[i] = bprintf("**   In %s() at %s (dynamic symbol)", line_func,line_pos);
207       } else {
208         /* damn, nothing to do here. Let's print the raw address */
209         DEBUG1("Dynamic symbol not found. Raw address = %s", backtrace[i]);
210         e->bt_strings[i] = bprintf("**   In ?? (%s)", backtrace[i]);
211       }
212     }
213     free(addrs[i]);
214   }
215   pclose(pipe);
216   free(addrs);
217   free(backtrace);
218   free(cmd);
219 #endif
220 }    
221
222 /** @brief shows an exception content and the associated stack if available */
223 void xbt_ex_display(xbt_ex_t *e)  {
224   char *thrower=NULL;
225
226   if (e->remote)
227     bprintf(" on host %s(%ld)",e->host,e->pid);
228
229   CRITICAL1("%s",e->msg);
230   fprintf(stderr,
231           "** SimGrid: UNCAUGHT EXCEPTION received on %s(%ld): category: %s; value: %d\n"
232           "** %s\n"
233           "** Thrown by %s()%s\n",
234           gras_os_myname(),gras_os_getpid(),
235           xbt_ex_catname(e->category), e->value, e->msg,
236           e->procname,thrower?thrower:" in this process");
237
238   if (thrower)
239     free(thrower);
240
241   if (!e->remote && !e->bt_strings)
242     xbt_ex_setup_backtrace(e);
243
244 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
245   /* We have everything to build neat backtraces */
246   {
247     int i;
248     
249     fprintf(stderr,"\n");
250     for (i=0; i<e->used; i++)
251       fprintf(stderr,"%s\n",e->bt_strings[i]);
252     
253   }
254 #else
255   fprintf(stderr," at %s:%d:%s (no backtrace available on that arch)\n",  
256           e->file,e->line,e->func);
257 #endif
258   xbt_ex_free(*e);
259 }
260
261
262 /* default __ex_terminate callback function */
263 void __xbt_ex_terminate_default(xbt_ex_t *e)  {
264   xbt_ex_display(e);
265
266   abort();
267 }
268
269 /* the externally visible API */
270 XBT_EXPORT_NO_IMPORT(ex_ctx_cb_t)  __xbt_ex_ctx       = &__xbt_ex_ctx_default;
271 XBT_EXPORT_NO_IMPORT(ex_term_cb_t) __xbt_ex_terminate = &__xbt_ex_terminate_default;
272
273 void xbt_ex_free(xbt_ex_t e) {
274   int i;
275
276   if (e.msg) free(e.msg);
277   if (e.remote) {
278     free(e.procname);
279     free(e.file);
280     free(e.func);
281     free(e.host);
282   }
283
284   if (e.bt_strings) {   
285      for (i=0; i<e.used; i++) 
286        free((char*)e.bt_strings[i]);
287      free((char **)e.bt_strings);
288   }
289   /* memset(e,0,sizeof(xbt_ex_t)); */
290 }
291
292 /** \brief returns a short name for the given exception category */
293 const char * xbt_ex_catname(xbt_errcat_t cat) {
294   switch (cat) {
295   case unknown_error:   return  "unknown_err";
296   case arg_error:       return "invalid_arg";
297   case mismatch_error:  return "mismatch";
298   case not_found_error: return "not found";
299   case system_error:    return "system_err";
300   case network_error:   return "network_err";
301   case timeout_error:   return "timeout";
302   case thread_error:    return "thread_err";
303   default:              return "INVALID_ERR";
304   }
305 }
306
307 #ifndef HAVE_EXECINFO_H
308 /* dummy implementation. We won't use the result, but ex.h needs it to be defined */
309 int backtrace (void **__array, int __size) {
310   return 0;
311 }
312
313 #endif
314
315 #ifdef SIMGRID_TEST
316 #include "xbt/ex.h"
317
318 XBT_TEST_SUITE("xbt_ex","Exception Handling");
319
320 XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") {
321     xbt_ex_t ex;
322     volatile int n=1;
323
324     xbt_test_add0("basic nested control flow");
325
326     TRY {
327         if (n != 1)
328             xbt_test_fail1("M1: n=%d (!= 1)", n);
329         n++;
330         TRY {
331             if (n != 2)
332                 xbt_test_fail1("M2: n=%d (!= 2)", n);
333             n++;
334             THROW0(unknown_error,0,"something");
335         } CATCH (ex) {
336             if (n != 3)
337                 xbt_test_fail1("M3: n=%d (!= 3)", n);
338             n++;
339             xbt_ex_free(ex);
340         }
341         n++;
342         TRY {
343             if (n != 5)
344                 xbt_test_fail1("M2: n=%d (!= 5)", n);
345             n++;
346             THROW0(unknown_error,0,"something");
347         } CATCH (ex) {
348             if (n != 6)
349                 xbt_test_fail1("M3: n=%d (!= 6)", n);
350             n++;
351             RETHROW;
352             n++;
353         }
354         xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n);
355     }
356     CATCH(ex) {
357         if (n != 7)
358             xbt_test_fail1("M4: n=%d (!= 7)", n);
359         n++;
360         xbt_ex_free(ex);
361     }
362     if (n != 8)
363         xbt_test_fail1("M5: n=%d (!= 8)", n);
364 }
365
366 XBT_TEST_UNIT("value",test_value,"exception value passing") {
367     xbt_ex_t ex;
368
369     TRY {
370         THROW0(unknown_error, 2, "toto");
371     } CATCH(ex) {
372         xbt_test_add0("exception value passing");
373         if (ex.category != unknown_error)
374             xbt_test_fail1("category=%d (!= 1)", ex.category);
375         if (ex.value != 2)
376             xbt_test_fail1("value=%d (!= 2)", ex.value);
377         if (strcmp(ex.msg,"toto"))
378             xbt_test_fail1("message=%s (!= toto)", ex.msg);
379         xbt_ex_free(ex);
380     }
381 }
382
383 XBT_TEST_UNIT("variables",test_variables,"variable value preservation") {
384     xbt_ex_t ex;
385     int r1, r2;
386     volatile int v1, v2;
387
388     r1 = r2 = v1 = v2 = 1234;
389     TRY {
390         r2 = 5678;
391         v2 = 5678;
392         THROW0(unknown_error, 0, "toto");
393     } CATCH(ex) {
394         xbt_test_add0("variable preservation");
395         if (r1 != 1234)
396             xbt_test_fail1("r1=%d (!= 1234)", r1);
397         if (v1 != 1234)
398             xbt_test_fail1("v1=%d (!= 1234)", v1);
399         /* r2 is allowed to be destroyed because not volatile */
400         if (v2 != 5678)
401             xbt_test_fail1("v2=%d (!= 5678)", v2);
402         xbt_ex_free(ex);
403     }
404 }
405
406 XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") {
407     xbt_ex_t ex;
408     volatile int v1;
409     int c;
410
411     xbt_test_add0("cleanup handling");
412
413     v1 = 1234;
414     c = 0;
415     TRY {
416         v1 = 5678;
417         THROW0(1, 2, "blah");
418     } CLEANUP {
419         if (v1 != 5678)
420             xbt_test_fail1("v1 = %d (!= 5678)", v1);
421         c = 1;
422     } CATCH(ex) {
423         if (v1 != 5678)
424             xbt_test_fail1("v1 = %d (!= 5678)", v1);
425         if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg,"blah")))
426             xbt_test_fail0("unexpected exception contents");
427         xbt_ex_free(ex);
428     }
429     if (!c)
430         xbt_test_fail0("xbt_ex_free not executed");
431 }
432
433
434 /*
435  * The following is the example included in the documentation. It's a good 
436  * idea to check its syntax even if we don't try to run it.
437  * And actually, it allows to put comments in the code despite doxygen.
438  */ 
439 static char *mallocex(int size) {
440   return NULL;
441 }
442 #define SMALLAMOUNT 10
443 #define TOOBIG 100000000
444
445 #if 0 /* this contains syntax errors, actually */
446 static void bad_example(void) {
447   struct {char*first;} *globalcontext;
448   ex_t ex;
449
450   /* BAD_EXAMPLE */
451   TRY {
452     char *cp1, *cp2, *cp3;
453     
454     cp1 = mallocex(SMALLAMOUNT);
455     globalcontext->first = cp1;
456     cp2 = mallocex(TOOBIG);
457     cp3 = mallocex(SMALLAMOUNT);
458     strcpy(cp1, "foo");
459     strcpy(cp2, "bar");
460   } CLEANUP {
461     if (cp3 != NULL) free(cp3);
462     if (cp2 != NULL) free(cp2);
463     if (cp1 != NULL) free(cp1);
464   } CATCH(ex) {
465     printf("cp3=%s", cp3);
466     RETHROW;
467   }
468   /* end_of_bad_example */
469 }
470 #endif
471 typedef struct {char *first;} global_context_t;
472    
473 static void good_example(void) {
474   global_context_t *global_context=malloc(sizeof(global_context_t));
475   xbt_ex_t ex;
476
477   /* GOOD_EXAMPLE */
478   { /*01*/
479     char * volatile /*03*/ cp1 = NULL /*02*/;
480     char * volatile /*03*/ cp2 = NULL /*02*/;
481     char * volatile /*03*/ cp3 = NULL /*02*/;
482     TRY {
483       cp1 = mallocex(SMALLAMOUNT);
484       global_context->first = cp1;
485       cp1 = NULL /*05 give away*/;
486       cp2 = mallocex(TOOBIG);
487       cp3 = mallocex(SMALLAMOUNT);
488       strcpy(cp1, "foo");
489       strcpy(cp2, "bar");
490     } CLEANUP { /*04*/
491       printf("cp3=%s", cp3 == NULL /*02*/ ? "" : cp3);
492       if (cp3 != NULL)
493         free(cp3);
494       if (cp2 != NULL)
495         free(cp2);
496       /*05 cp1 was given away */
497     } CATCH(ex) {
498       /*05 global context untouched */
499       RETHROW;
500     }
501   }
502   /* end_of_good_example */
503 }
504 #endif /* SIMGRID_TEST */