1 /* MI Interpreter Definitions and Commands for GDB, the GNU debugger.
3 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "gdb_string.h"
24 #include "event-top.h"
25 #include "event-loop.h"
29 #include "exceptions.h"
33 #include "mi-console.h"
35 #include "gdbthread.h"
39 /* MI's output channels */
44 struct ui_file *event_channel;
46 /* This is the interpreter for the mi... */
47 struct interp *mi2_interp;
48 struct interp *mi1_interp;
49 struct interp *mi_interp;
52 /* These are the interpreter setup, etc. functions for the MI interpreter */
53 static void mi_execute_command_wrapper (char *cmd);
54 static void mi_command_loop (int mi_version);
56 /* These are hooks that we put in place while doing interpreter_exec
57 so we can report interesting things that happened "behind the mi's
58 back" in this command */
59 static int mi_interp_query_hook (const char *ctlstr, va_list ap)
60 ATTR_FORMAT (printf, 1, 0);
62 static void mi3_command_loop (void);
63 static void mi2_command_loop (void);
64 static void mi1_command_loop (void);
66 static void mi_insert_notify_hooks (void);
67 static void mi_remove_notify_hooks (void);
69 static void mi_new_thread (struct thread_info *t);
72 mi_interpreter_init (int top_level)
74 struct mi_interp *mi = XMALLOC (struct mi_interp);
76 /* HACK: We need to force stdout/stderr to point at the console. This avoids
77 any potential side effects caused by legacy code that is still
78 using the TUI / fputs_unfiltered_hook. So we set up output channels for
79 this now, and swap them in when we are run. */
81 raw_stdout = stdio_fileopen (stdout);
83 /* Create MI channels */
84 mi->out = mi_console_file_new (raw_stdout, "~", '"');
85 mi->err = mi_console_file_new (raw_stdout, "&", '"');
87 mi->targ = mi_console_file_new (raw_stdout, "@", '"');
88 mi->event_channel = mi_console_file_new (raw_stdout, "=", 0);
91 observer_attach_new_thread (mi_new_thread);
97 mi_interpreter_resume (void *data)
99 struct mi_interp *mi = data;
100 /* As per hack note in mi_interpreter_init, swap in the output channels... */
102 gdb_setup_readline ();
104 /* These overwrite some of the initialization done in
105 _intialize_event_loop. */
106 call_readline = gdb_readline2;
107 input_handler = mi_execute_command_wrapper;
108 add_file_handler (input_fd, stdin_event_handler, 0);
109 async_command_editing_p = 0;
110 /* FIXME: This is a total hack for now. PB's use of the MI
111 implicitly relies on a bug in the async support which allows
112 asynchronous commands to leak through the commmand loop. The bug
113 involves (but is not limited to) the fact that sync_execution was
114 erroneously initialized to 0. Duplicate by initializing it thus
118 gdb_stdout = mi->out;
119 /* Route error and log output through the MI */
120 gdb_stderr = mi->err;
121 gdb_stdlog = mi->log;
122 /* Route target output through the MI. */
123 gdb_stdtarg = mi->targ;
124 /* Route target error through the MI as well. */
125 gdb_stdtargerr = mi->targ;
127 /* Replace all the hooks that we know about. There really needs to
128 be a better way of doing this... */
129 clear_interpreter_hooks ();
131 deprecated_show_load_progress = mi_load_progress;
133 /* If we're _the_ interpreter, take control. */
134 if (current_interp_named_p (INTERP_MI1))
135 deprecated_command_loop_hook = mi1_command_loop;
136 else if (current_interp_named_p (INTERP_MI2))
137 deprecated_command_loop_hook = mi2_command_loop;
138 else if (current_interp_named_p (INTERP_MI3))
139 deprecated_command_loop_hook = mi3_command_loop;
141 deprecated_command_loop_hook = mi2_command_loop;
147 mi_interpreter_suspend (void *data)
149 gdb_disable_readline ();
153 static struct gdb_exception
154 mi_interpreter_exec (void *data, const char *command)
156 static struct gdb_exception ok;
157 char *tmp = alloca (strlen (command) + 1);
158 strcpy (tmp, command);
159 mi_execute_command_wrapper (tmp);
160 return exception_none;
163 /* Never display the default gdb prompt in mi case. */
165 mi_interpreter_prompt_p (void *data)
171 mi_interpreter_exec_continuation (struct continuation_arg *arg, int error_p)
173 bpstat_do_actions (&stop_bpstat);
174 /* It's not clear what to do in the case of errror -- should we assume that
175 the target is stopped, or that it still runs? */
176 if (!target_executing)
178 fputs_unfiltered ("*stopped", raw_stdout);
179 mi_out_put (uiout, raw_stdout);
180 fputs_unfiltered ("\n", raw_stdout);
181 fputs_unfiltered ("(gdb) \n", raw_stdout);
182 gdb_flush (raw_stdout);
184 else if (target_can_async_p ())
186 add_continuation (mi_interpreter_exec_continuation, NULL);
191 mi_cmd_interpreter_exec (char *command, char **argv, int argc)
193 struct interp *interp_to_use;
195 struct interp_procs *procs;
196 char *mi_error_message = NULL;
197 struct cleanup *old_chain;
200 error ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
202 interp_to_use = interp_lookup (argv[0]);
203 if (interp_to_use == NULL)
204 error ("mi_cmd_interpreter_exec: could not find interpreter \"%s\"", argv[0]);
206 if (!interp_exec_p (interp_to_use))
207 error ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
210 /* Insert the MI out hooks, making sure to also call the interpreter's hooks
212 /* KRS: We shouldn't need this... Events should be installed and they should
213 just ALWAYS fire something out down the MI channel... */
214 mi_insert_notify_hooks ();
216 /* Now run the code... */
218 old_chain = make_cleanup (null_cleanup, 0);
219 for (i = 1; i < argc; i++)
221 struct gdb_exception e = interp_exec (interp_to_use, argv[i]);
224 mi_error_message = xstrdup (e.message);
225 make_cleanup (xfree, mi_error_message);
230 mi_remove_notify_hooks ();
232 /* Okay, now let's see if the command set the inferior going...
233 Tricky point - have to do this AFTER resetting the interpreter, since
234 changing the interpreter will clear out all the continuations for
235 that interpreter... */
237 if (target_can_async_p () && target_executing)
239 fputs_unfiltered ("^running\n", raw_stdout);
240 add_continuation (mi_interpreter_exec_continuation, NULL);
243 if (mi_error_message != NULL)
244 error ("%s", mi_error_message);
245 do_cleanups (old_chain);
250 * mi_insert_notify_hooks - This inserts a number of hooks that are meant to produce
251 * async-notify ("=") MI messages while running commands in another interpreter
252 * using mi_interpreter_exec. The canonical use for this is to allow access to
253 * the gdb CLI interpreter from within the MI, while still producing MI style output
254 * when actions in the CLI command change gdb's state.
258 mi_insert_notify_hooks (void)
260 deprecated_query_hook = mi_interp_query_hook;
264 mi_remove_notify_hooks (void)
266 deprecated_query_hook = NULL;
270 mi_interp_query_hook (const char *ctlstr, va_list ap)
276 mi_execute_command_wrapper (char *cmd)
278 mi_execute_command (cmd, stdin == instream);
282 mi1_command_loop (void)
288 mi2_command_loop (void)
294 mi3_command_loop (void)
300 mi_command_loop (int mi_version)
302 /* Turn off 8 bit strings in quoted output. Any character with the
303 high bit set is printed using C's octal format. */
304 sevenbit_strings = 1;
305 /* Tell the world that we're alive */
306 fputs_unfiltered ("(gdb) \n", raw_stdout);
307 gdb_flush (raw_stdout);
312 mi_new_thread (struct thread_info *t)
314 struct mi_interp *mi = top_level_interpreter_data ();
316 fprintf_unfiltered (mi->event_channel, "thread-created,id=%d", t->num);
317 gdb_flush (mi->event_channel);
320 extern initialize_file_ftype _initialize_mi_interp; /* -Wmissing-prototypes */
323 _initialize_mi_interp (void)
325 static const struct interp_procs procs =
327 mi_interpreter_init, /* init_proc */
328 mi_interpreter_resume, /* resume_proc */
329 mi_interpreter_suspend, /* suspend_proc */
330 mi_interpreter_exec, /* exec_proc */
331 mi_interpreter_prompt_p /* prompt_proc_p */
334 /* The various interpreter levels. */
335 interp_add (interp_new (INTERP_MI1, NULL, mi_out_new (1), &procs));
336 interp_add (interp_new (INTERP_MI2, NULL, mi_out_new (2), &procs));
337 interp_add (interp_new (INTERP_MI3, NULL, mi_out_new (3), &procs));
339 /* "mi" selects the most recent released version. "mi2" was
340 released as part of GDB 6.0. */
341 interp_add (interp_new (INTERP_MI, NULL, mi_out_new (2), &procs));