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);
68 static void mi_on_normal_stop (struct bpstats
*bs
);
70 static void mi_new_thread (struct thread_info
*t
);
71 static void mi_thread_exit (struct thread_info
*t
);
74 mi_interpreter_init (int top_level
)
76 struct mi_interp
*mi
= XMALLOC (struct mi_interp
);
78 /* HACK: We need to force stdout/stderr to point at the console. This avoids
79 any potential side effects caused by legacy code that is still
80 using the TUI / fputs_unfiltered_hook. So we set up output channels for
81 this now, and swap them in when we are run. */
83 raw_stdout
= stdio_fileopen (stdout
);
85 /* Create MI channels */
86 mi
->out
= mi_console_file_new (raw_stdout
, "~", '"');
87 mi
->err
= mi_console_file_new (raw_stdout
, "&", '"');
89 mi
->targ
= mi_console_file_new (raw_stdout
, "@", '"');
90 mi
->event_channel
= mi_console_file_new (raw_stdout
, "=", 0);
94 observer_attach_new_thread (mi_new_thread
);
95 observer_attach_thread_exit (mi_thread_exit
);
96 observer_attach_normal_stop (mi_on_normal_stop
);
103 mi_interpreter_resume (void *data
)
105 struct mi_interp
*mi
= data
;
106 /* As per hack note in mi_interpreter_init, swap in the output channels... */
108 gdb_setup_readline ();
110 /* These overwrite some of the initialization done in
111 _intialize_event_loop. */
112 call_readline
= gdb_readline2
;
113 input_handler
= mi_execute_command_wrapper
;
114 add_file_handler (input_fd
, stdin_event_handler
, 0);
115 async_command_editing_p
= 0;
116 /* FIXME: This is a total hack for now. PB's use of the MI
117 implicitly relies on a bug in the async support which allows
118 asynchronous commands to leak through the commmand loop. The bug
119 involves (but is not limited to) the fact that sync_execution was
120 erroneously initialized to 0. Duplicate by initializing it thus
124 gdb_stdout
= mi
->out
;
125 /* Route error and log output through the MI */
126 gdb_stderr
= mi
->err
;
127 gdb_stdlog
= mi
->log
;
128 /* Route target output through the MI. */
129 gdb_stdtarg
= mi
->targ
;
130 /* Route target error through the MI as well. */
131 gdb_stdtargerr
= mi
->targ
;
133 /* Replace all the hooks that we know about. There really needs to
134 be a better way of doing this... */
135 clear_interpreter_hooks ();
137 deprecated_show_load_progress
= mi_load_progress
;
139 /* If we're _the_ interpreter, take control. */
140 if (current_interp_named_p (INTERP_MI1
))
141 deprecated_command_loop_hook
= mi1_command_loop
;
142 else if (current_interp_named_p (INTERP_MI2
))
143 deprecated_command_loop_hook
= mi2_command_loop
;
144 else if (current_interp_named_p (INTERP_MI3
))
145 deprecated_command_loop_hook
= mi3_command_loop
;
147 deprecated_command_loop_hook
= mi2_command_loop
;
153 mi_interpreter_suspend (void *data
)
155 gdb_disable_readline ();
159 static struct gdb_exception
160 mi_interpreter_exec (void *data
, const char *command
)
162 static struct gdb_exception ok
;
163 char *tmp
= alloca (strlen (command
) + 1);
164 strcpy (tmp
, command
);
165 mi_execute_command_wrapper (tmp
);
166 return exception_none
;
169 /* Never display the default gdb prompt in mi case. */
171 mi_interpreter_prompt_p (void *data
)
177 mi_cmd_interpreter_exec (char *command
, char **argv
, int argc
)
179 struct interp
*interp_to_use
;
181 struct interp_procs
*procs
;
182 char *mi_error_message
= NULL
;
183 struct cleanup
*old_chain
;
186 error ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
188 interp_to_use
= interp_lookup (argv
[0]);
189 if (interp_to_use
== NULL
)
190 error ("mi_cmd_interpreter_exec: could not find interpreter \"%s\"", argv
[0]);
192 if (!interp_exec_p (interp_to_use
))
193 error ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
196 /* Insert the MI out hooks, making sure to also call the interpreter's hooks
198 /* KRS: We shouldn't need this... Events should be installed and they should
199 just ALWAYS fire something out down the MI channel... */
200 mi_insert_notify_hooks ();
202 /* Now run the code... */
204 old_chain
= make_cleanup (null_cleanup
, 0);
205 for (i
= 1; i
< argc
; i
++)
207 struct gdb_exception e
= interp_exec (interp_to_use
, argv
[i
]);
210 mi_error_message
= xstrdup (e
.message
);
211 make_cleanup (xfree
, mi_error_message
);
216 mi_remove_notify_hooks ();
218 /* Okay, now let's see if the command set the inferior going...
219 Tricky point - have to do this AFTER resetting the interpreter, since
220 changing the interpreter will clear out all the continuations for
221 that interpreter... */
223 if (target_can_async_p () && target_executing
)
225 fputs_unfiltered ("^running\n", raw_stdout
);
228 if (mi_error_message
!= NULL
)
229 error ("%s", mi_error_message
);
230 do_cleanups (old_chain
);
235 * mi_insert_notify_hooks - This inserts a number of hooks that are meant to produce
236 * async-notify ("=") MI messages while running commands in another interpreter
237 * using mi_interpreter_exec. The canonical use for this is to allow access to
238 * the gdb CLI interpreter from within the MI, while still producing MI style output
239 * when actions in the CLI command change gdb's state.
243 mi_insert_notify_hooks (void)
245 deprecated_query_hook
= mi_interp_query_hook
;
249 mi_remove_notify_hooks (void)
251 deprecated_query_hook
= NULL
;
255 mi_interp_query_hook (const char *ctlstr
, va_list ap
)
261 mi_execute_command_wrapper (char *cmd
)
263 mi_execute_command (cmd
, stdin
== instream
);
267 mi1_command_loop (void)
273 mi2_command_loop (void)
279 mi3_command_loop (void)
285 mi_command_loop (int mi_version
)
287 /* Turn off 8 bit strings in quoted output. Any character with the
288 high bit set is printed using C's octal format. */
289 sevenbit_strings
= 1;
290 /* Tell the world that we're alive */
291 fputs_unfiltered ("(gdb) \n", raw_stdout
);
292 gdb_flush (raw_stdout
);
297 mi_new_thread (struct thread_info
*t
)
299 struct mi_interp
*mi
= top_level_interpreter_data ();
301 fprintf_unfiltered (mi
->event_channel
, "thread-created,id=\"%d\"", t
->num
);
302 gdb_flush (mi
->event_channel
);
306 mi_thread_exit (struct thread_info
*t
)
308 struct mi_interp
*mi
= top_level_interpreter_data ();
309 target_terminal_ours ();
310 fprintf_unfiltered (mi
->event_channel
, "thread-exited,id=\"%d\"", t
->num
);
311 gdb_flush (mi
->event_channel
);
315 mi_on_normal_stop (struct bpstats
*bs
)
317 /* Since this can be called when CLI command is executing,
318 using cli interpreter, be sure to use MI uiout for output,
319 not the current one. */
320 struct ui_out
*uiout
= interp_ui_out (top_level_interpreter ());
321 struct mi_interp
*mi
= top_level_interpreter_data ();
323 fputs_unfiltered ("*stopped", raw_stdout
);
324 mi_out_put (uiout
, raw_stdout
);
325 mi_out_rewind (uiout
);
326 fputs_unfiltered ("\n", raw_stdout
);
327 gdb_flush (raw_stdout
);
330 extern initialize_file_ftype _initialize_mi_interp
; /* -Wmissing-prototypes */
333 _initialize_mi_interp (void)
335 static const struct interp_procs procs
=
337 mi_interpreter_init
, /* init_proc */
338 mi_interpreter_resume
, /* resume_proc */
339 mi_interpreter_suspend
, /* suspend_proc */
340 mi_interpreter_exec
, /* exec_proc */
341 mi_interpreter_prompt_p
/* prompt_proc_p */
344 /* The various interpreter levels. */
345 interp_add (interp_new (INTERP_MI1
, NULL
, mi_out_new (1), &procs
));
346 interp_add (interp_new (INTERP_MI2
, NULL
, mi_out_new (2), &procs
));
347 interp_add (interp_new (INTERP_MI3
, NULL
, mi_out_new (3), &procs
));
349 /* "mi" selects the most recent released version. "mi2" was
350 released as part of GDB 6.0. */
351 interp_add (interp_new (INTERP_MI
, NULL
, mi_out_new (2), &procs
));