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
);
72 static void mi_on_resume (ptid_t ptid
);
75 mi_interpreter_init (int top_level
)
77 struct mi_interp
*mi
= XMALLOC (struct mi_interp
);
79 /* HACK: We need to force stdout/stderr to point at the console. This avoids
80 any potential side effects caused by legacy code that is still
81 using the TUI / fputs_unfiltered_hook. So we set up output channels for
82 this now, and swap them in when we are run. */
84 raw_stdout
= stdio_fileopen (stdout
);
86 /* Create MI channels */
87 mi
->out
= mi_console_file_new (raw_stdout
, "~", '"');
88 mi
->err
= mi_console_file_new (raw_stdout
, "&", '"');
90 mi
->targ
= mi_console_file_new (raw_stdout
, "@", '"');
91 mi
->event_channel
= mi_console_file_new (raw_stdout
, "=", 0);
95 observer_attach_new_thread (mi_new_thread
);
96 observer_attach_thread_exit (mi_thread_exit
);
97 observer_attach_normal_stop (mi_on_normal_stop
);
98 observer_attach_target_resumed (mi_on_resume
);
105 mi_interpreter_resume (void *data
)
107 struct mi_interp
*mi
= data
;
108 /* As per hack note in mi_interpreter_init, swap in the output channels... */
110 gdb_setup_readline ();
112 /* These overwrite some of the initialization done in
113 _intialize_event_loop. */
114 call_readline
= gdb_readline2
;
115 input_handler
= mi_execute_command_wrapper
;
116 add_file_handler (input_fd
, stdin_event_handler
, 0);
117 async_command_editing_p
= 0;
118 /* FIXME: This is a total hack for now. PB's use of the MI
119 implicitly relies on a bug in the async support which allows
120 asynchronous commands to leak through the commmand loop. The bug
121 involves (but is not limited to) the fact that sync_execution was
122 erroneously initialized to 0. Duplicate by initializing it thus
126 gdb_stdout
= mi
->out
;
127 /* Route error and log output through the MI */
128 gdb_stderr
= mi
->err
;
129 gdb_stdlog
= mi
->log
;
130 /* Route target output through the MI. */
131 gdb_stdtarg
= mi
->targ
;
132 /* Route target error through the MI as well. */
133 gdb_stdtargerr
= mi
->targ
;
135 /* Replace all the hooks that we know about. There really needs to
136 be a better way of doing this... */
137 clear_interpreter_hooks ();
139 deprecated_show_load_progress
= mi_load_progress
;
141 /* If we're _the_ interpreter, take control. */
142 if (current_interp_named_p (INTERP_MI1
))
143 deprecated_command_loop_hook
= mi1_command_loop
;
144 else if (current_interp_named_p (INTERP_MI2
))
145 deprecated_command_loop_hook
= mi2_command_loop
;
146 else if (current_interp_named_p (INTERP_MI3
))
147 deprecated_command_loop_hook
= mi3_command_loop
;
149 deprecated_command_loop_hook
= mi2_command_loop
;
155 mi_interpreter_suspend (void *data
)
157 gdb_disable_readline ();
161 static struct gdb_exception
162 mi_interpreter_exec (void *data
, const char *command
)
164 static struct gdb_exception ok
;
165 char *tmp
= alloca (strlen (command
) + 1);
166 strcpy (tmp
, command
);
167 mi_execute_command_wrapper (tmp
);
168 return exception_none
;
171 /* Never display the default gdb prompt in mi case. */
173 mi_interpreter_prompt_p (void *data
)
179 mi_cmd_interpreter_exec (char *command
, char **argv
, int argc
)
181 struct interp
*interp_to_use
;
183 struct interp_procs
*procs
;
184 char *mi_error_message
= NULL
;
185 struct cleanup
*old_chain
;
188 error ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
190 interp_to_use
= interp_lookup (argv
[0]);
191 if (interp_to_use
== NULL
)
192 error ("mi_cmd_interpreter_exec: could not find interpreter \"%s\"", argv
[0]);
194 if (!interp_exec_p (interp_to_use
))
195 error ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
198 /* Insert the MI out hooks, making sure to also call the interpreter's hooks
200 /* KRS: We shouldn't need this... Events should be installed and they should
201 just ALWAYS fire something out down the MI channel... */
202 mi_insert_notify_hooks ();
204 /* Now run the code... */
206 old_chain
= make_cleanup (null_cleanup
, 0);
207 for (i
= 1; i
< argc
; i
++)
209 struct gdb_exception e
= interp_exec (interp_to_use
, argv
[i
]);
212 mi_error_message
= xstrdup (e
.message
);
213 make_cleanup (xfree
, mi_error_message
);
218 mi_remove_notify_hooks ();
220 if (mi_error_message
!= NULL
)
221 error ("%s", mi_error_message
);
222 do_cleanups (old_chain
);
227 * mi_insert_notify_hooks - This inserts a number of hooks that are meant to produce
228 * async-notify ("=") MI messages while running commands in another interpreter
229 * using mi_interpreter_exec. The canonical use for this is to allow access to
230 * the gdb CLI interpreter from within the MI, while still producing MI style output
231 * when actions in the CLI command change gdb's state.
235 mi_insert_notify_hooks (void)
237 deprecated_query_hook
= mi_interp_query_hook
;
241 mi_remove_notify_hooks (void)
243 deprecated_query_hook
= NULL
;
247 mi_interp_query_hook (const char *ctlstr
, va_list ap
)
253 mi_execute_command_wrapper (char *cmd
)
255 mi_execute_command (cmd
, stdin
== instream
);
259 mi1_command_loop (void)
265 mi2_command_loop (void)
271 mi3_command_loop (void)
277 mi_command_loop (int mi_version
)
279 /* Turn off 8 bit strings in quoted output. Any character with the
280 high bit set is printed using C's octal format. */
281 sevenbit_strings
= 1;
282 /* Tell the world that we're alive */
283 fputs_unfiltered ("(gdb) \n", raw_stdout
);
284 gdb_flush (raw_stdout
);
289 mi_new_thread (struct thread_info
*t
)
291 struct mi_interp
*mi
= top_level_interpreter_data ();
293 fprintf_unfiltered (mi
->event_channel
, "thread-created,id=\"%d\"", t
->num
);
294 gdb_flush (mi
->event_channel
);
298 mi_thread_exit (struct thread_info
*t
)
300 struct mi_interp
*mi
= top_level_interpreter_data ();
301 target_terminal_ours ();
302 fprintf_unfiltered (mi
->event_channel
, "thread-exited,id=\"%d\"", t
->num
);
303 gdb_flush (mi
->event_channel
);
307 mi_on_normal_stop (struct bpstats
*bs
)
309 /* Since this can be called when CLI command is executing,
310 using cli interpreter, be sure to use MI uiout for output,
311 not the current one. */
312 struct ui_out
*uiout
= interp_ui_out (top_level_interpreter ());
313 struct mi_interp
*mi
= top_level_interpreter_data ();
315 fputs_unfiltered ("*stopped", raw_stdout
);
316 mi_out_put (uiout
, raw_stdout
);
317 mi_out_rewind (uiout
);
318 fputs_unfiltered ("\n", raw_stdout
);
319 gdb_flush (raw_stdout
);
323 mi_on_resume (ptid_t ptid
)
325 /* To cater for older frontends, emit ^running, but do it only once
326 per each command. We do it here, since at this point we know
327 that the target was successfully resumed, and in non-async mode,
328 we won't return back to MI interpreter code until the target
329 is done running, so delaying the output of "^running" until then
330 will make it impossible for frontend to know what's going on.
332 In future (MI3), we'll be outputting "^done" here. */
333 if (!running_result_record_printed
)
336 fputs_unfiltered (current_token
, raw_stdout
);
337 fputs_unfiltered ("^running\n", raw_stdout
);
340 if (PIDGET (ptid
) == -1)
341 fprintf_unfiltered (raw_stdout
, "*running,thread-id=\"all\"\n");
344 struct thread_info
*ti
= find_thread_pid (ptid
);
346 fprintf_unfiltered (raw_stdout
, "*running,thread-id=\"%d\"\n", ti
->num
);
349 if (!running_result_record_printed
)
351 running_result_record_printed
= 1;
352 /* This is what gdb used to do historically -- printing prompt even if
353 it cannot actually accept any input. This will be surely removed
354 for MI3, and may be removed even earler. */
355 /* FIXME: review the use of target_is_async_p here -- is that
357 if (!target_is_async_p ())
358 fputs_unfiltered ("(gdb) \n", raw_stdout
);
362 extern initialize_file_ftype _initialize_mi_interp
; /* -Wmissing-prototypes */
365 _initialize_mi_interp (void)
367 static const struct interp_procs procs
=
369 mi_interpreter_init
, /* init_proc */
370 mi_interpreter_resume
, /* resume_proc */
371 mi_interpreter_suspend
, /* suspend_proc */
372 mi_interpreter_exec
, /* exec_proc */
373 mi_interpreter_prompt_p
/* prompt_proc_p */
376 /* The various interpreter levels. */
377 interp_add (interp_new (INTERP_MI1
, NULL
, mi_out_new (1), &procs
));
378 interp_add (interp_new (INTERP_MI2
, NULL
, mi_out_new (2), &procs
));
379 interp_add (interp_new (INTERP_MI3
, NULL
, mi_out_new (3), &procs
));
381 /* "mi" selects the most recent released version. "mi2" was
382 released as part of GDB 6.0. */
383 interp_add (interp_new (INTERP_MI
, NULL
, mi_out_new (2), &procs
));