3 /* ex - Exception Handling (modified to fit into SimGrid from OSSP version) */
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. */
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. */
17 #include "portable.h" /* execinfo when available */
19 #include "xbt/module.h" /* xbt_binary_name */
20 #include "xbt/ex_interface.h"
22 #include "gras/Virtu/virtu_interface.h" /* gras_os_myname */
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex,xbt,"Exception mecanism");
27 /* default __ex_ctx callback function */
28 ex_ctx_t *__xbt_ex_ctx_default(void) {
29 static ex_ctx_t ctx = XBT_CTX_INITIALIZER;
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)
41 e.used = backtrace((void**)e.bt,XBT_BACKTRACE_SIZE);
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]);
51 ERROR0("No backtrace on this arch");
56 void xbt_ex_setup_backtrace(xbt_ex_t *e) {
57 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
59 /* to get the backtrace from the libc */
60 char **backtrace = backtrace_symbols (e->bt, e->used);
62 /* To build the commandline of addr2line */
63 char *cmd = xbt_new(char,strlen(ADDR2LINE)+25+strlen(xbt_binary_name)+32*e->used);
66 /* to extract the addresses from the backtrace */
67 char **addrs=xbt_new(char*,e->used);
70 /* To read the output of addr2line */
72 char line_func[1024],line_pos[1024];
74 /* size (in char) of pointers on this arch */
77 /* Some arches only have stubs of backtrace, no implementation (hppa comes to mind) */
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);
89 if (strcmp(buff,"(nil)"))
90 addrs[i]=bprintf("%s", buff);
92 addrs[i]=bprintf("0x0");
93 DEBUG3("Set up a new address: %d, '%s'(%p)", i, addrs[i], addrs[i]);
95 /* Add it to the command line args */
96 curr+=sprintf(curr,"%s ",addrs[i]);
98 addr_len = strlen(addrs[0]);
100 /* parse the output and build a new backtrace */
101 e->bt_strings = xbt_new(char*,e->used);
103 VERB1("Fire a first command: '%s'", cmd);
104 pipe = popen(cmd, "r");
106 CRITICAL0("Cannot fork addr2line to display the backtrace");
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';
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);
121 /* Damn. The symbol is in a dynamic library. Let's get wild */
126 long int addr,offset=0;
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");
137 sscanf(addrs[i],"%lx",&addr);
138 sprintf(maps_buff,"%#lx",addr);
140 if (strcmp(addrs[i],maps_buff)) {
141 CRITICAL2("Cannot parse backtrace address '%s' (addr=%#lx)",
144 DEBUG2("addr=%s (as string) =%#lx (as number)",addrs[i],addr);
147 long int first, last;
148 if (fgets(maps_buff,512,maps) == NULL)
151 maps_buff[strlen(maps_buff) -1]='\0';
152 DEBUG1("map line: %s", maps_buff);
154 sscanf(maps_buff,"%lx",&first);
155 p=strchr(maps_buff,'-')+1;
156 sscanf(p,"%lx",&last);
157 if (first < addr && addr < last) {
161 DEBUG4("%#lx %s [%#lx-%#lx]",
162 addr, found? "in":"out of",first,last);
168 VERB0("Problem while reading the maps file. Following backtrace will be mangled.");
169 DEBUG1("No dynamic. Static symbol: %s", backtrace[i]);
170 e->bt_strings[i] = bprintf("** In ?? (%s)", backtrace[i]);
174 /* Ok, Found the offset of the maps line containing the searched symbol.
175 We now need to substract this from the address we got from backtrace.
179 addrs[i] = bprintf("0x%0*lx",addr_len-2,addr-offset);
180 DEBUG2("offset=%#lx new addr=%s",offset,addrs[i]);
182 /* Got it. We have our new address. Let's get the library path and we
184 p = xbt_strdup(backtrace[i]);
190 /* Here we go, fire an addr2line up */
191 subcmd = bprintf("%s -f -e %s %s",ADDR2LINE,p, addrs[i]);
193 VERB1("Fire a new command: '%s'",subcmd);
194 subpipe = popen(subcmd,"r");
196 CRITICAL0("Cannot fork addr2line to display the backtrace");
199 fgets(line_func,1024,subpipe);
200 line_func[strlen(line_func)-1]='\0';
201 fgets(line_pos,1024,subpipe);
202 line_pos[strlen(line_pos)-1]='\0';
206 /* check whether the trick worked */
207 if (strcmp("??",line_func)) {
208 DEBUG2("Found dynamic symbol %s() at %s", line_func, line_pos);
209 e->bt_strings[i] = bprintf("** In %s() at %s", line_func,line_pos);
211 /* damn, nothing to do here. Let's print the raw address */
212 DEBUG1("Dynamic symbol not found. Raw address = %s", backtrace[i]);
213 e->bt_strings[i] = bprintf("** In ?? (%s)", backtrace[i]);
219 /* Mask the bottom of the stack */
220 if (!strncmp("main",line_func,strlen("main"))) {
222 for (j=i+1; j<e->used; j++)
227 if (!strncmp("__context_wrapper",line_func,strlen("__context_wrapper"))) {
229 for (j=i+1; j<e->used; j++)
243 /** @brief shows an exception content and the associated stack if available */
244 void xbt_ex_display(xbt_ex_t *e) {
248 bprintf(" on host %s(%ld)",e->host,e->pid);
251 "** SimGrid: UNCAUGHT EXCEPTION received on %s(%ld): category: %s; value: %d\n"
253 "** Thrown by %s()%s\n",
254 gras_os_myname(),gras_os_getpid(),
255 xbt_ex_catname(e->category), e->value, e->msg,
256 e->procname,thrower?thrower:" in this process");
257 CRITICAL1("%s",e->msg);
262 if (!e->remote && !e->bt_strings)
263 xbt_ex_setup_backtrace(e);
265 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
266 /* We have everything to build neat backtraces */
270 fprintf(stderr,"\n");
271 for (i=0; i<e->used; i++)
272 fprintf(stderr,"%s\n",e->bt_strings[i]);
276 fprintf(stderr," at %s:%d:%s (no backtrace available on that arch)\n",
277 e->file,e->line,e->func);
283 /* default __ex_terminate callback function */
284 void __xbt_ex_terminate_default(xbt_ex_t *e) {
290 /* the externally visible API */
291 XBT_PUBLIC_DATA(ex_ctx_cb_t) __xbt_ex_ctx = &__xbt_ex_ctx_default;
292 XBT_PUBLIC_DATA(ex_term_cb_t) __xbt_ex_terminate = &__xbt_ex_terminate_default;
295 void xbt_ex_free(xbt_ex_t e) {
298 if (e.msg) free(e.msg);
307 for (i=0; i<e.used; i++)
308 free((char*)e.bt_strings[i]);
309 free((char **)e.bt_strings);
311 /* memset(e,0,sizeof(xbt_ex_t)); */
314 /** \brief returns a short name for the given exception category */
315 const char * xbt_ex_catname(xbt_errcat_t cat) {
317 case unknown_error: return "unknown_err";
318 case arg_error: return "invalid_arg";
319 case mismatch_error: return "mismatch";
320 case not_found_error: return "not found";
321 case system_error: return "system_err";
322 case network_error: return "network_err";
323 case timeout_error: return "timeout";
324 case thread_error: return "thread_err";
325 default: return "INVALID_ERR";
329 #ifndef HAVE_EXECINFO_H
330 /* dummy implementation. We won't use the result, but ex.h needs it to be defined */
331 int backtrace (void **__array, int __size) {
341 XBT_TEST_SUITE("xbt_ex","Exception Handling");
343 XBT_TEST_UNIT("controlflow",test_controlflow, "basic nested control flow") {
347 xbt_test_add0("basic nested control flow");
351 xbt_test_fail1("M1: n=%d (!= 1)", n);
355 xbt_test_fail1("M2: n=%d (!= 2)", n);
357 THROW0(unknown_error,0,"something");
360 xbt_test_fail1("M3: n=%d (!= 3)", n);
367 xbt_test_fail1("M2: n=%d (!= 5)", n);
369 THROW0(unknown_error,0,"something");
372 xbt_test_fail1("M3: n=%d (!= 6)", n);
377 xbt_test_fail1("MX: n=%d (shouldn't reach this point)", n);
381 xbt_test_fail1("M4: n=%d (!= 7)", n);
386 xbt_test_fail1("M5: n=%d (!= 8)", n);
389 XBT_TEST_UNIT("value",test_value,"exception value passing") {
393 THROW0(unknown_error, 2, "toto");
395 xbt_test_add0("exception value passing");
396 if (ex.category != unknown_error)
397 xbt_test_fail1("category=%d (!= 1)", ex.category);
399 xbt_test_fail1("value=%d (!= 2)", ex.value);
400 if (strcmp(ex.msg,"toto"))
401 xbt_test_fail1("message=%s (!= toto)", ex.msg);
406 XBT_TEST_UNIT("variables",test_variables,"variable value preservation") {
411 r1 = r2 = v1 = v2 = 1234;
415 THROW0(unknown_error, 0, "toto");
417 xbt_test_add0("variable preservation");
419 xbt_test_fail1("r1=%d (!= 1234)", r1);
421 xbt_test_fail1("v1=%d (!= 1234)", v1);
422 /* r2 is allowed to be destroyed because not volatile */
424 xbt_test_fail1("v2=%d (!= 5678)", v2);
429 XBT_TEST_UNIT("cleanup",test_cleanup,"cleanup handling") {
434 xbt_test_add0("cleanup handling");
440 THROW0(1, 2, "blah");
443 xbt_test_fail1("v1 = %d (!= 5678)", v1);
447 xbt_test_fail1("v1 = %d (!= 5678)", v1);
448 if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.msg,"blah")))
449 xbt_test_fail0("unexpected exception contents");
453 xbt_test_fail0("xbt_ex_free not executed");
458 * The following is the example included in the documentation. It's a good
459 * idea to check its syntax even if we don't try to run it.
460 * And actually, it allows to put comments in the code despite doxygen.
462 static char *mallocex(int size) {
465 #define SMALLAMOUNT 10
466 #define TOOBIG 100000000
468 #if 0 /* this contains syntax errors, actually */
469 static void bad_example(void) {
470 struct {char*first;} *globalcontext;
475 char *cp1, *cp2, *cp3;
477 cp1 = mallocex(SMALLAMOUNT);
478 globalcontext->first = cp1;
479 cp2 = mallocex(TOOBIG);
480 cp3 = mallocex(SMALLAMOUNT);
484 if (cp3 != NULL) free(cp3);
485 if (cp2 != NULL) free(cp2);
486 if (cp1 != NULL) free(cp1);
488 printf("cp3=%s", cp3);
491 /* end_of_bad_example */
494 typedef struct {char *first;} global_context_t;
496 static void good_example(void) {
497 global_context_t *global_context=malloc(sizeof(global_context_t));
502 char * volatile /*03*/ cp1 = NULL /*02*/;
503 char * volatile /*03*/ cp2 = NULL /*02*/;
504 char * volatile /*03*/ cp3 = NULL /*02*/;
506 cp1 = mallocex(SMALLAMOUNT);
507 global_context->first = cp1;
508 cp1 = NULL /*05 give away*/;
509 cp2 = mallocex(TOOBIG);
510 cp3 = mallocex(SMALLAMOUNT);
514 printf("cp3=%s", cp3 == NULL /*02*/ ? "" : cp3);
519 /*05 cp1 was given away */
521 /*05 global context untouched */
525 /* end_of_good_example */
527 #endif /* SIMGRID_TEST */