/* Exception (throw catch) mechanism, for GDB, the GNU debugger.
Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
- 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
- Foundation, Inc.
+ 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free
+ Software Foundation, Inc.
This file is part of GDB.
#include "defs.h"
#include "exceptions.h"
-#include <setjmp.h>
#include "breakpoint.h"
#include "target.h"
#include "inferior.h"
#include "annotate.h"
#include "ui-out.h"
#include "gdb_assert.h"
+#include "gdb_string.h"
+#include "serial.h"
+
+const struct exception exception_none = { 0, NO_ERROR, NULL };
+
+/* Possible catcher states. */
+enum catcher_state {
+ /* Initial state, a new catcher has just been created. */
+ CATCHER_CREATED,
+ /* The catch code is running. */
+ CATCHER_RUNNING,
+ CATCHER_RUNNING_1,
+ /* The catch code threw an exception. */
+ CATCHER_ABORTING
+};
-/* One should use catch_errors rather than manipulating these
- directly. */
-#if defined(HAVE_SIGSETJMP)
-#define SIGJMP_BUF sigjmp_buf
-#define SIGSETJMP(buf) sigsetjmp((buf), 1)
-#define SIGLONGJMP(buf,val) siglongjmp((buf), (val))
-#else
-#define SIGJMP_BUF jmp_buf
-#define SIGSETJMP(buf) setjmp(buf)
-#define SIGLONGJMP(buf,val) longjmp((buf), (val))
-#endif
+/* Possible catcher actions. */
+enum catcher_action {
+ CATCH_ITER,
+ CATCH_ITER_1,
+ CATCH_THROWING
+};
+
+struct catcher
+{
+ enum catcher_state state;
+ /* Jump buffer pointing back at the exception handler. */
+ EXCEPTIONS_SIGJMP_BUF buf;
+ /* Status buffer belonging to the exception handler. */
+ volatile struct exception *exception;
+ /* Saved/current state. */
+ int mask;
+ struct ui_out *saved_uiout;
+ struct cleanup *saved_cleanup_chain;
+ /* Back link. */
+ struct catcher *prev;
+};
/* Where to go for throw_exception(). */
-static SIGJMP_BUF *catch_return;
+static struct catcher *current_catcher;
+
+EXCEPTIONS_SIGJMP_BUF *
+exceptions_state_mc_init (struct ui_out *func_uiout,
+ volatile struct exception *exception,
+ return_mask mask)
+{
+ struct catcher *new_catcher = XZALLOC (struct catcher);
+
+ /* Start with no exception, save it's address. */
+ exception->reason = 0;
+ exception->error = NO_ERROR;
+ exception->message = NULL;
+ new_catcher->exception = exception;
+
+ new_catcher->mask = mask;
-/* Return for reason REASON to the nearest containing catch_errors(). */
+ /* Override the global ``struct ui_out'' builder. */
+ new_catcher->saved_uiout = uiout;
+ uiout = func_uiout;
+
+ /* Prevent error/quit during FUNC from calling cleanups established
+ prior to here. */
+ new_catcher->saved_cleanup_chain = save_cleanups ();
+
+ /* Push this new catcher on the top. */
+ new_catcher->prev = current_catcher;
+ current_catcher = new_catcher;
+ new_catcher->state = CATCHER_CREATED;
+
+ return &new_catcher->buf;
+}
+
+static void
+catcher_pop (void)
+{
+ struct catcher *old_catcher = current_catcher;
+ current_catcher = old_catcher->prev;
+
+ /* Restore the cleanup chain, the error/quit messages, and the uiout
+ builder, to their original states. */
+
+ restore_cleanups (old_catcher->saved_cleanup_chain);
+
+ uiout = old_catcher->saved_uiout;
+
+ xfree (old_catcher);
+}
+
+/* Catcher state machine. Returns non-zero if the m/c should be run
+ again, zero if it should abort. */
+
+static int
+exceptions_state_mc (enum catcher_action action)
+{
+ switch (current_catcher->state)
+ {
+ case CATCHER_CREATED:
+ switch (action)
+ {
+ case CATCH_ITER:
+ /* Allow the code to run the catcher. */
+ current_catcher->state = CATCHER_RUNNING;
+ return 1;
+ default:
+ internal_error (__FILE__, __LINE__, _("bad state"));
+ }
+ case CATCHER_RUNNING:
+ switch (action)
+ {
+ case CATCH_ITER:
+ /* No error/quit has occured. Just clean up. */
+ catcher_pop ();
+ return 0;
+ case CATCH_ITER_1:
+ current_catcher->state = CATCHER_RUNNING_1;
+ return 1;
+ case CATCH_THROWING:
+ current_catcher->state = CATCHER_ABORTING;
+ /* See also throw_exception. */
+ return 1;
+ default:
+ internal_error (__FILE__, __LINE__, _("bad switch"));
+ }
+ case CATCHER_RUNNING_1:
+ switch (action)
+ {
+ case CATCH_ITER:
+ /* The did a "break" from the inner while loop. */
+ catcher_pop ();
+ return 0;
+ case CATCH_ITER_1:
+ current_catcher->state = CATCHER_RUNNING;
+ return 0;
+ case CATCH_THROWING:
+ current_catcher->state = CATCHER_ABORTING;
+ /* See also throw_exception. */
+ return 1;
+ default:
+ internal_error (__FILE__, __LINE__, _("bad switch"));
+ }
+ case CATCHER_ABORTING:
+ switch (action)
+ {
+ case CATCH_ITER:
+ {
+ struct exception exception = *current_catcher->exception;
+ if (current_catcher->mask & RETURN_MASK (exception.reason))
+ {
+ /* Exit normally if this catcher can handle this
+ exception. The caller analyses the func return
+ values. */
+ catcher_pop ();
+ return 0;
+ }
+ /* The caller didn't request that the event be caught,
+ relay the event to the next containing
+ catch_errors(). */
+ catcher_pop ();
+ throw_exception (exception);
+ }
+ default:
+ internal_error (__FILE__, __LINE__, _("bad state"));
+ }
+ default:
+ internal_error (__FILE__, __LINE__, _("bad switch"));
+ }
+}
+
+int
+exceptions_state_mc_action_iter (void)
+{
+ return exceptions_state_mc (CATCH_ITER);
+}
+
+int
+exceptions_state_mc_action_iter_1 (void)
+{
+ return exceptions_state_mc (CATCH_ITER_1);
+}
+
+/* Return EXCEPTION to the nearest containing catch_errors(). */
NORETURN void
-throw_exception (enum return_reason reason)
+throw_exception (struct exception exception)
{
quit_flag = 0;
immediate_quit = 0;
if (sync_execution)
do_exec_error_cleanups (ALL_CLEANUPS);
- if (annotation_level > 1)
- switch (reason)
- {
- case RETURN_QUIT:
- annotate_quit ();
- break;
- case RETURN_ERROR:
- annotate_error ();
- break;
- }
-
/* Jump to the containing catch_errors() call, communicating REASON
to that call via setjmp's return value. Note that REASON can't
be zero, by definition in defs.h. */
+ exceptions_state_mc (CATCH_THROWING);
+ *current_catcher->exception = exception;
+ EXCEPTIONS_SIGLONGJMP (current_catcher->buf, exception.reason);
+}
+
+static char *last_message;
+
+NORETURN void
+deprecated_throw_reason (enum return_reason reason)
+{
+ struct exception exception;
+ memset (&exception, 0, sizeof exception);
+
+ exception.reason = reason;
+ switch (reason)
+ {
+ case RETURN_QUIT:
+ break;
+ case RETURN_ERROR:
+ exception.error = GENERIC_ERROR;
+ break;
+ default:
+ internal_error (__FILE__, __LINE__, _("bad switch"));
+ }
+
+ throw_exception (exception);
+}
+
+static void
+print_flush (void)
+{
+ struct serial *gdb_stdout_serial;
+
+ if (deprecated_error_begin_hook)
+ deprecated_error_begin_hook ();
+ target_terminal_ours ();
+
+ /* We want all output to appear now, before we print the error. We
+ have 3 levels of buffering we have to flush (it's possible that
+ some of these should be changed to flush the lower-level ones
+ too): */
+
+ /* 1. The _filtered buffer. */
+ wrap_here ("");
+
+ /* 2. The stdio buffer. */
+ gdb_flush (gdb_stdout);
+ gdb_flush (gdb_stderr);
+
+ /* 3. The system-level buffer. */
+ gdb_stdout_serial = serial_fdopen (1);
+ serial_drain_output (gdb_stdout_serial);
+ serial_un_fdopen (gdb_stdout_serial);
+
+ annotate_error_begin ();
+}
+
+static void
+print_exception (struct ui_file *file, struct exception e)
+{
+ /* KLUGE: cagney/2005-01-13: Write the string out one line at a time
+ as that way the MI's behavior is preserved. */
+ const char *start;
+ const char *end;
+ for (start = e.message; start != NULL; start = end)
+ {
+ end = strchr (start, '\n');
+ if (end == NULL)
+ fputs_filtered (start, file);
+ else
+ {
+ end++;
+ ui_file_write (file, start, end - start);
+ }
+ }
+ fprintf_filtered (file, "\n");
+
+ /* Now append the annotation. */
+ switch (e.reason)
+ {
+ case RETURN_QUIT:
+ annotate_quit ();
+ break;
+ case RETURN_ERROR:
+ /* Assume that these are all errors. */
+ annotate_error ();
+ break;
+ default:
+ internal_error (__FILE__, __LINE__, _("Bad switch."));
+ }
+}
+
+void
+exception_print (struct ui_file *file, struct exception e)
+{
+ if (e.reason < 0 && e.message != NULL)
+ {
+ print_flush ();
+ print_exception (file, e);
+ }
+}
+
+void
+exception_fprintf (struct ui_file *file, struct exception e,
+ const char *prefix, ...)
+{
+ if (e.reason < 0 && e.message != NULL)
+ {
+ va_list args;
+
+ print_flush ();
+
+ /* Print the prefix. */
+ va_start (args, prefix);
+ vfprintf_filtered (file, prefix, args);
+ va_end (args);
+
+ print_exception (file, e);
+ }
+}
- (NORETURN void) SIGLONGJMP (*catch_return, (int) reason);
+void
+print_any_exception (struct ui_file *file, const char *prefix,
+ struct exception e)
+{
+ if (e.reason < 0 && e.message != NULL)
+ {
+ target_terminal_ours ();
+ wrap_here (""); /* Force out any buffered output */
+ gdb_flush (gdb_stdout);
+ annotate_error_begin ();
+
+ /* Print the prefix. */
+ if (prefix != NULL && prefix[0] != '\0')
+ fputs_filtered (prefix, file);
+ print_exception (file, e);
+ }
+}
+
+NORETURN static void
+throw_it (enum return_reason reason, enum errors error, const char *fmt,
+ va_list ap) ATTR_NORETURN;
+NORETURN static void
+throw_it (enum return_reason reason, enum errors error, const char *fmt,
+ va_list ap)
+{
+ struct exception e;
+ char *new_message;
+
+ /* Save the message. Create the new message before deleting the
+ old, the new message may include the old message text. */
+ new_message = xstrvprintf (fmt, ap);
+ xfree (last_message);
+ last_message = new_message;
+
+ /* Create the exception. */
+ e.reason = reason;
+ e.error = error;
+ e.message = last_message;
+
+ /* Throw the exception. */
+ throw_exception (e);
+}
+
+NORETURN void
+throw_verror (enum errors error, const char *fmt, va_list ap)
+{
+ throw_it (RETURN_ERROR, error, fmt, ap);
+}
+
+NORETURN void
+throw_vfatal (const char *fmt, va_list ap)
+{
+ throw_it (RETURN_QUIT, NO_ERROR, fmt, ap);
+}
+
+NORETURN void
+throw_error (enum errors error, const char *fmt, ...)
+{
+ va_list args;
+ va_start (args, fmt);
+ throw_it (RETURN_ERROR, error, fmt, args);
+ va_end (args);
}
/* Call FUNC() with args FUNC_UIOUT and FUNC_ARGS, catching any
be consolidated into a single file instead of being distributed
between utils.c and top.c? */
-static void
-catcher (catch_exceptions_ftype *func,
- struct ui_out *func_uiout,
- void *func_args,
- int *func_val,
- enum return_reason *func_caught,
- char *errstring,
- char **gdberrmsg,
- return_mask mask)
-{
- SIGJMP_BUF *saved_catch;
- SIGJMP_BUF catch;
- struct cleanup *saved_cleanup_chain;
- char *saved_error_pre_print;
- char *saved_quit_pre_print;
- struct ui_out *saved_uiout;
-
- /* Return value from SIGSETJMP(): enum return_reason if error or
- quit caught, 0 otherwise. */
- int caught;
-
- /* Return value from FUNC(): Hopefully non-zero. Explicitly set to
- zero if an error quit was caught. */
- int val;
-
- /* Override error/quit messages during FUNC. */
-
- saved_error_pre_print = error_pre_print;
- saved_quit_pre_print = quit_pre_print;
-
- if (mask & RETURN_MASK_ERROR)
- error_pre_print = errstring;
- if (mask & RETURN_MASK_QUIT)
- quit_pre_print = errstring;
-
- /* Override the global ``struct ui_out'' builder. */
-
- saved_uiout = uiout;
- uiout = func_uiout;
-
- /* Prevent error/quit during FUNC from calling cleanups established
- prior to here. */
-
- saved_cleanup_chain = save_cleanups ();
-
- /* Call FUNC, catching error/quit events. */
-
- saved_catch = catch_return;
- catch_return = &catch;
- caught = SIGSETJMP (catch);
- if (!caught)
- val = (*func) (func_uiout, func_args);
- else
- {
- val = 0;
- /* If caller wants a copy of the low-level error message, make one.
- This is used in the case of a silent error whereby the caller
- may optionally want to issue the message. */
- if (gdberrmsg)
- *gdberrmsg = error_last_message ();
- }
- catch_return = saved_catch;
-
- /* FIXME: cagney/1999-11-05: A correct FUNC implementation will
- clean things up (restoring the cleanup chain) to the state they
- were just prior to the call. Unfortunately, many FUNC's are not
- that well behaved. This could be fixed by adding either a
- do_cleanups call (to cover the problem) or an assertion check to
- detect bad FUNCs code. */
-
- /* Restore the cleanup chain, the error/quit messages, and the uiout
- builder, to their original states. */
-
- restore_cleanups (saved_cleanup_chain);
-
- uiout = saved_uiout;
-
- if (mask & RETURN_MASK_QUIT)
- quit_pre_print = saved_quit_pre_print;
- if (mask & RETURN_MASK_ERROR)
- error_pre_print = saved_error_pre_print;
-
- /* Return normally if no error/quit event occurred or this catcher
- can handle this exception. The caller analyses the func return
- values. */
-
- if (!caught || (mask & RETURN_MASK (caught)))
- {
- *func_val = val;
- *func_caught = caught;
- return;
- }
-
- /* The caller didn't request that the event be caught, relay the
- event to the next containing catch_errors(). */
-
- throw_exception (caught);
-}
-
int
catch_exceptions (struct ui_out *uiout,
catch_exceptions_ftype *func,
void *func_args,
- char *errstring,
return_mask mask)
{
- int val;
- enum return_reason caught;
- catcher (func, uiout, func_args, &val, &caught, errstring, NULL, mask);
- gdb_assert (val >= 0);
- gdb_assert (caught <= 0);
- if (caught < 0)
- return caught;
- return val;
+ return catch_exceptions_with_msg (uiout, func, func_args, NULL, mask);
+}
+
+struct exception
+catch_exception (struct ui_out *uiout,
+ catch_exception_ftype *func,
+ void *func_args,
+ return_mask mask)
+{
+ volatile struct exception exception;
+ TRY_CATCH (exception, mask)
+ {
+ (*func) (uiout, func_args);
+ }
+ return exception;
}
int
catch_exceptions_with_msg (struct ui_out *uiout,
catch_exceptions_ftype *func,
void *func_args,
- char *errstring,
char **gdberrmsg,
return_mask mask)
{
- int val;
- enum return_reason caught;
- catcher (func, uiout, func_args, &val, &caught, errstring, gdberrmsg, mask);
+ volatile struct exception exception;
+ volatile int val = 0;
+ TRY_CATCH (exception, mask)
+ {
+ val = (*func) (uiout, func_args);
+ }
+ print_any_exception (gdb_stderr, NULL, exception);
gdb_assert (val >= 0);
- gdb_assert (caught <= 0);
- if (caught < 0)
- return caught;
+ gdb_assert (exception.reason <= 0);
+ if (exception.reason < 0)
+ {
+ /* If caller wants a copy of the low-level error message, make
+ one. This is used in the case of a silent error whereby the
+ caller may optionally want to issue the message. */
+ if (gdberrmsg != NULL)
+ {
+ if (exception.message != NULL)
+ *gdberrmsg = xstrdup (exception.message);
+ else
+ *gdberrmsg = NULL;
+ }
+ return exception.reason;
+ }
return val;
}
-struct catch_errors_args
-{
- catch_errors_ftype *func;
- void *func_args;
-};
-
-static int
-do_catch_errors (struct ui_out *uiout, void *data)
-{
- struct catch_errors_args *args = data;
- return args->func (args->func_args);
-}
-
int
catch_errors (catch_errors_ftype *func, void *func_args, char *errstring,
return_mask mask)
{
- int val;
- enum return_reason caught;
- struct catch_errors_args args;
- args.func = func;
- args.func_args = func_args;
- catcher (do_catch_errors, uiout, &args, &val, &caught, errstring,
- NULL, mask);
- if (caught != 0)
+ volatile int val = 0;
+ volatile struct exception exception;
+ TRY_CATCH (exception, mask)
+ {
+ val = func (func_args);
+ }
+ print_any_exception (gdb_stderr, errstring, exception);
+ if (exception.reason != 0)
return 0;
return val;
}
-struct captured_command_args
- {
- catch_command_errors_ftype *command;
- char *arg;
- int from_tty;
- };
-
-static int
-do_captured_command (void *data)
-{
- struct captured_command_args *context = data;
- context->command (context->arg, context->from_tty);
- /* FIXME: cagney/1999-11-07: Technically this do_cleanups() call
- isn't needed. Instead an assertion check could be made that
- simply confirmed that the called function correctly cleaned up
- after itself. Unfortunately, old code (prior to 1999-11-04) in
- main.c was calling SET_TOP_LEVEL(), calling the command function,
- and then *always* calling do_cleanups(). For the moment we
- remain ``bug compatible'' with that old code.. */
- do_cleanups (ALL_CLEANUPS);
- return 1;
-}
-
int
catch_command_errors (catch_command_errors_ftype * command,
char *arg, int from_tty, return_mask mask)
{
- struct captured_command_args args;
- args.command = command;
- args.arg = arg;
- args.from_tty = from_tty;
- return catch_errors (do_captured_command, &args, "", mask);
+ volatile struct exception e;
+ TRY_CATCH (e, mask)
+ {
+ command (arg, from_tty);
+ }
+ print_any_exception (gdb_stderr, NULL, e);
+ if (e.reason < 0)
+ return 0;
+ return 1;
}
projects / deliverable / binutils-gdb.git / blobdiff