Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
I think I just killed a simcall
[simgrid.git] / src / xbt / ex.cpp
1 /* ex - Exception Handling                                                  */
2
3 /* Copyright (c) 2005-2017. The SimGrid Team. All rights reserved.          */
4
5 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
6 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
7 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
8 /*  All rights reserved.                                                    */
9
10 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
11 /* It was heavily modified to fit the SimGrid framework.                    */
12
13 /* The OSSP version has the following copyright notice:
14 **  OSSP ex - Exception Handling
15 **  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
16 **  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
17 **  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
18 **
19 **  This file is part of OSSP ex, an exception handling library
20 **  which can be found at http://www.ossp.org/pkg/lib/ex/.
21 **
22 **  Permission to use, copy, modify, and distribute this software for
23 **  any purpose with or without fee is hereby granted, provided that
24 **  the above copyright notice and this permission notice appear in all
25 **  copies.
26 **
27 **  THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
28 **  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
29 **  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30 **  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
31 **  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 **  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 **  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
34 **  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35 **  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36 **  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
37 **  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 **  SUCH DAMAGE.
39  */
40
41 /* The extensions made for the SimGrid project can either be distributed    */
42 /* under the same license, or under the LGPL v2.1                           */
43
44 #include <stdio.h>
45 #include <stdlib.h>
46
47 #include <xbt/backtrace.hpp>
48 #include "src/internal_config.h"           /* execinfo when available */
49 #include "xbt/ex.h"
50 #include <xbt/ex.hpp>
51 #include "xbt/log.h"
52 #include "xbt/log.hpp"
53 #include "xbt/backtrace.h"
54 #include "xbt/backtrace.hpp"
55 #include "xbt/str.h"
56 #include "src/xbt_modinter.h"       /* backtrace initialization headers */
57
58 #include "simgrid/sg_config.h"  /* Configuration mechanism of SimGrid */
59
60 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_ex, xbt, "Exception mechanism");
61
62 xbt_ex::~xbt_ex() {}
63
64 void _xbt_throw(
65   char* message, xbt_errcat_t errcat, int value, 
66   const char* file, int line, const char* func)
67 {
68   xbt_ex e(simgrid::xbt::ThrowPoint(file, line, func), message);
69   free(message);
70   e.category = errcat;
71   e.value = value;
72   throw e;
73 }
74
75 /** @brief shows an exception content and the associated stack if available */
76 void xbt_ex_display(xbt_ex_t * e)
77 {
78   simgrid::xbt::logException(xbt_log_priority_critical, "UNCAUGHT EXCEPTION", *e);
79 }
80
81 /** \brief returns a short name for the given exception category */
82 const char *xbt_ex_catname(xbt_errcat_t cat)
83 {
84   switch (cat) {
85   case unknown_error:
86     return "unknown error";
87   case arg_error:
88     return "invalid argument";
89   case bound_error:
90     return "out of bounds";
91   case mismatch_error:
92     return "mismatch";
93   case not_found_error:
94     return "not found";
95   case system_error:
96     return "system error";
97   case network_error:
98     return "network error";
99   case timeout_error:
100     return "timeout";
101   case cancel_error:
102     return "action canceled";
103   case thread_error:
104     return "thread error";
105   case host_error:
106     return "host failed";
107   case tracing_error:
108     return "tracing error";
109   case io_error:
110     return "io error";
111   case vm_error:
112     return "vm error";
113   }
114   return "INVALID ERROR";
115 }
116
117 #ifdef SIMGRID_TEST
118 #include <stdio.h>
119 #include "xbt/ex.h"
120 #include <xbt/ex.hpp>
121
122 XBT_TEST_SUITE("xbt_ex", "Exception Handling");
123
124 XBT_TEST_UNIT("controlflow", test_controlflow, "basic nested control flow")
125 {
126   xbt_ex_t ex;
127   int n = 1;
128
129   xbt_test_add("basic nested control flow");
130
131   try {
132     if (n != 1)
133       xbt_test_fail("M1: n=%d (!= 1)", n);
134     n++;
135     try {
136       if (n != 2)
137         xbt_test_fail("M2: n=%d (!= 2)", n);
138       n++;
139       THROWF(unknown_error, 0, "something");
140     }
141     catch (xbt_ex& ex) {
142       if (n != 3)
143         xbt_test_fail("M3: n=%d (!= 3)", n);
144       n++;
145     }
146     n++;
147     try {
148       if (n != 5)
149         xbt_test_fail("M2: n=%d (!= 5)", n);
150       n++;
151       THROWF(unknown_error, 0, "something");
152     }
153     catch(xbt_ex& ex){
154       if (n != 6)
155         xbt_test_fail("M3: n=%d (!= 6)", n);
156       n++;
157       throw;
158       n++;
159     }
160     xbt_test_fail("MX: n=%d (shouldn't reach this point)", n);
161   }
162   catch(xbt_ex& e) {
163     if (n != 7)
164       xbt_test_fail("M4: n=%d (!= 7)", n);
165     n++;
166   }
167   if (n != 8)
168     xbt_test_fail("M5: n=%d (!= 8)", n);
169 }
170
171 XBT_TEST_UNIT("value", test_value, "exception value passing")
172 {
173   try {
174     THROWF(unknown_error, 2, "toto");
175   }
176   catch (xbt_ex& ex) {
177     xbt_test_add("exception value passing");
178     if (ex.category != unknown_error)
179       xbt_test_fail("category=%d (!= 1)", (int)ex.category);
180     if (ex.value != 2)
181       xbt_test_fail("value=%d (!= 2)", ex.value);
182     if (strcmp(ex.what(), "toto"))
183       xbt_test_fail("message=%s (!= toto)", ex.what());
184   }
185 }
186
187 XBT_TEST_UNIT("variables", test_variables, "variable value preservation")
188 {
189   xbt_ex_t ex;
190   int r1;
191   int XBT_ATTRIB_UNUSED r2;
192   int v1;
193   int v2;
194
195   r1 = r2 = v1 = v2 = 1234;
196   try {
197     r2 = 5678;
198     v2 = 5678;
199     THROWF(unknown_error, 0, "toto");
200   }
201   catch(xbt_ex& e) {
202     xbt_test_add("variable preservation");
203     if (r1 != 1234)
204       xbt_test_fail("r1=%d (!= 1234)", r1);
205     if (v1 != 1234)
206       xbt_test_fail("v1=%d (!= 1234)", v1);
207     /* r2 is allowed to be destroyed because not volatile */
208     if (v2 != 5678)
209       xbt_test_fail("v2=%d (!= 5678)", v2);
210   }
211 }
212
213 XBT_TEST_UNIT("cleanup", test_cleanup, "cleanup handling")
214 {
215   int v1;
216   int c;
217
218   xbt_test_add("cleanup handling");
219
220   v1 = 1234;
221   c = 0;
222   try {
223     v1 = 5678;
224     THROWF(1, 2, "blah");
225   }
226   catch (xbt_ex& ex) {
227     if (v1 != 5678)
228       xbt_test_fail("v1 = %d (!= 5678)", v1);
229     c = 1;
230     if (v1 != 5678)
231       xbt_test_fail("v1 = %d (!= 5678)", v1);
232     if (!(ex.category == 1 && ex.value == 2 && !strcmp(ex.what(), "blah")))
233       xbt_test_fail("unexpected exception contents");
234   }
235   if (!c)
236     xbt_test_fail("xbt_ex_free not executed");
237 }
238 #endif                          /* SIMGRID_TEST */