1 /* MI Interpreter Definitions and Commands for GDB, the GNU debugger.
3 Copyright (C) 2002-2005, 2007-2012 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "gdb_string.h"
23 #include "event-top.h"
24 #include "event-loop.h"
28 #include "exceptions.h"
32 #include "mi-console.h"
33 #include "mi-common.h"
35 #include "gdbthread.h"
39 /* These are the interpreter setup, etc. functions for the MI
42 static void mi_execute_command_wrapper (char *cmd);
43 static void mi_execute_command_input_handler (char *cmd);
44 static void mi_command_loop (int mi_version);
46 /* These are hooks that we put in place while doing interpreter_exec
47 so we can report interesting things that happened "behind the MI's
48 back" in this command. */
50 static int mi_interp_query_hook (const char *ctlstr, va_list ap)
51 ATTRIBUTE_PRINTF (1, 0);
53 static void mi3_command_loop (void);
54 static void mi2_command_loop (void);
55 static void mi1_command_loop (void);
57 static void mi_insert_notify_hooks (void);
58 static void mi_remove_notify_hooks (void);
59 static void mi_on_normal_stop (struct bpstats *bs, int print_frame);
61 static void mi_new_thread (struct thread_info *t);
62 static void mi_thread_exit (struct thread_info *t, int silent);
63 static void mi_inferior_added (struct inferior *inf);
64 static void mi_inferior_appeared (struct inferior *inf);
65 static void mi_inferior_exit (struct inferior *inf);
66 static void mi_inferior_removed (struct inferior *inf);
67 static void mi_on_resume (ptid_t ptid);
68 static void mi_solib_loaded (struct so_list *solib);
69 static void mi_solib_unloaded (struct so_list *solib);
70 static void mi_about_to_proceed (void);
71 static void mi_breakpoint_created (struct breakpoint *b);
72 static void mi_breakpoint_deleted (struct breakpoint *b);
73 static void mi_breakpoint_modified (struct breakpoint *b);
75 static int report_initial_inferior (struct inferior *inf, void *closure);
78 mi_interpreter_init (struct interp *interp, int top_level)
80 struct mi_interp *mi = XMALLOC (struct mi_interp);
84 /* HACK: We need to force stdout/stderr to point at the console.
85 This avoids any potential side effects caused by legacy code that
86 is still using the TUI / fputs_unfiltered_hook. So we set up
87 output channels for this now, and swap them in when we are
90 raw_stdout = stdio_fileopen (stdout);
92 /* Create MI console channels, each with a different prefix so they
93 can be distinguished. */
94 mi->out = mi_console_file_new (raw_stdout, "~", '"');
95 mi->err = mi_console_file_new (raw_stdout, "&", '"');
97 mi->targ = mi_console_file_new (raw_stdout, "@", '"');
98 mi->event_channel = mi_console_file_new (raw_stdout, "=", 0);
100 name = interp_name (interp);
101 /* INTERP_MI selects the most recent released version. "mi2" was
102 released as part of GDB 6.0. */
103 if (strcmp (name, INTERP_MI) == 0)
105 else if (strcmp (name, INTERP_MI1) == 0)
107 else if (strcmp (name, INTERP_MI2) == 0)
109 else if (strcmp (name, INTERP_MI3) == 0)
112 gdb_assert_not_reached ("unhandled MI version");
114 mi->uiout = mi_out_new (mi_version);
118 observer_attach_new_thread (mi_new_thread);
119 observer_attach_thread_exit (mi_thread_exit);
120 observer_attach_inferior_added (mi_inferior_added);
121 observer_attach_inferior_appeared (mi_inferior_appeared);
122 observer_attach_inferior_exit (mi_inferior_exit);
123 observer_attach_inferior_removed (mi_inferior_removed);
124 observer_attach_normal_stop (mi_on_normal_stop);
125 observer_attach_target_resumed (mi_on_resume);
126 observer_attach_solib_loaded (mi_solib_loaded);
127 observer_attach_solib_unloaded (mi_solib_unloaded);
128 observer_attach_about_to_proceed (mi_about_to_proceed);
129 observer_attach_breakpoint_created (mi_breakpoint_created);
130 observer_attach_breakpoint_deleted (mi_breakpoint_deleted);
131 observer_attach_breakpoint_modified (mi_breakpoint_modified);
133 /* The initial inferior is created before this function is
134 called, so we need to report it explicitly. Use iteration in
135 case future version of GDB creates more than one inferior
137 iterate_over_inferiors (report_initial_inferior, mi);
144 mi_interpreter_resume (void *data)
146 struct mi_interp *mi = data;
148 /* As per hack note in mi_interpreter_init, swap in the output
150 gdb_setup_readline ();
152 /* These overwrite some of the initialization done in
153 _intialize_event_loop. */
154 call_readline = gdb_readline2;
155 input_handler = mi_execute_command_input_handler;
156 add_file_handler (input_fd, stdin_event_handler, 0);
157 async_command_editing_p = 0;
158 /* FIXME: This is a total hack for now. PB's use of the MI
159 implicitly relies on a bug in the async support which allows
160 asynchronous commands to leak through the commmand loop. The bug
161 involves (but is not limited to) the fact that sync_execution was
162 erroneously initialized to 0. Duplicate by initializing it thus
166 gdb_stdout = mi->out;
167 /* Route error and log output through the MI. */
168 gdb_stderr = mi->err;
169 gdb_stdlog = mi->log;
170 /* Route target output through the MI. */
171 gdb_stdtarg = mi->targ;
172 /* Route target error through the MI as well. */
173 gdb_stdtargerr = mi->targ;
175 /* Replace all the hooks that we know about. There really needs to
176 be a better way of doing this... */
177 clear_interpreter_hooks ();
179 deprecated_show_load_progress = mi_load_progress;
181 /* If we're _the_ interpreter, take control. */
182 if (current_interp_named_p (INTERP_MI1))
183 deprecated_command_loop_hook = mi1_command_loop;
184 else if (current_interp_named_p (INTERP_MI2))
185 deprecated_command_loop_hook = mi2_command_loop;
186 else if (current_interp_named_p (INTERP_MI3))
187 deprecated_command_loop_hook = mi3_command_loop;
189 deprecated_command_loop_hook = mi2_command_loop;
195 mi_interpreter_suspend (void *data)
197 gdb_disable_readline ();
201 static struct gdb_exception
202 mi_interpreter_exec (void *data, const char *command)
204 char *tmp = alloca (strlen (command) + 1);
206 strcpy (tmp, command);
207 mi_execute_command_wrapper (tmp);
208 return exception_none;
211 /* Never display the default GDB prompt in MI case. */
214 mi_interpreter_prompt_p (void *data)
220 mi_cmd_interpreter_exec (char *command, char **argv, int argc)
222 struct interp *interp_to_use;
224 char *mi_error_message = NULL;
225 struct cleanup *old_chain;
228 error (_("-interpreter-exec: "
229 "Usage: -interpreter-exec interp command"));
231 interp_to_use = interp_lookup (argv[0]);
232 if (interp_to_use == NULL)
233 error (_("-interpreter-exec: could not find interpreter \"%s\""),
236 if (!interp_exec_p (interp_to_use))
237 error (_("-interpreter-exec: interpreter \"%s\" "
238 "does not support command execution"),
241 /* Insert the MI out hooks, making sure to also call the
242 interpreter's hooks if it has any. */
243 /* KRS: We shouldn't need this... Events should be installed and
244 they should just ALWAYS fire something out down the MI
246 mi_insert_notify_hooks ();
248 /* Now run the code. */
250 old_chain = make_cleanup (null_cleanup, 0);
251 for (i = 1; i < argc; i++)
253 struct gdb_exception e = interp_exec (interp_to_use, argv[i]);
257 mi_error_message = xstrdup (e.message);
258 make_cleanup (xfree, mi_error_message);
263 mi_remove_notify_hooks ();
265 if (mi_error_message != NULL)
266 error ("%s", mi_error_message);
267 do_cleanups (old_chain);
270 /* This inserts a number of hooks that are meant to produce
271 async-notify ("=") MI messages while running commands in another
272 interpreter using mi_interpreter_exec. The canonical use for this
273 is to allow access to the gdb CLI interpreter from within the MI,
274 while still producing MI style output when actions in the CLI
275 command change GDB's state. */
278 mi_insert_notify_hooks (void)
280 deprecated_query_hook = mi_interp_query_hook;
284 mi_remove_notify_hooks (void)
286 deprecated_query_hook = NULL;
290 mi_interp_query_hook (const char *ctlstr, va_list ap)
296 mi_execute_command_wrapper (char *cmd)
298 mi_execute_command (cmd, stdin == instream);
301 /* mi_execute_command_wrapper wrapper suitable for INPUT_HANDLER. */
304 mi_execute_command_input_handler (char *cmd)
306 mi_execute_command_wrapper (cmd);
308 fputs_unfiltered ("(gdb) \n", raw_stdout);
309 gdb_flush (raw_stdout);
313 mi1_command_loop (void)
319 mi2_command_loop (void)
325 mi3_command_loop (void)
331 mi_command_loop (int mi_version)
333 /* Turn off 8 bit strings in quoted output. Any character with the
334 high bit set is printed using C's octal format. */
335 sevenbit_strings = 1;
337 /* Tell the world that we're alive. */
338 fputs_unfiltered ("(gdb) \n", raw_stdout);
339 gdb_flush (raw_stdout);
345 mi_new_thread (struct thread_info *t)
347 struct mi_interp *mi = top_level_interpreter_data ();
348 struct inferior *inf = find_inferior_pid (ptid_get_pid (t->ptid));
352 fprintf_unfiltered (mi->event_channel,
353 "thread-created,id=\"%d\",group-id=\"i%d\"",
355 gdb_flush (mi->event_channel);
359 mi_thread_exit (struct thread_info *t, int silent)
361 struct mi_interp *mi;
362 struct inferior *inf;
367 inf = find_inferior_pid (ptid_get_pid (t->ptid));
369 mi = top_level_interpreter_data ();
370 target_terminal_ours ();
371 fprintf_unfiltered (mi->event_channel,
372 "thread-exited,id=\"%d\",group-id=\"i%d\"",
374 gdb_flush (mi->event_channel);
378 mi_inferior_added (struct inferior *inf)
380 struct mi_interp *mi = top_level_interpreter_data ();
382 target_terminal_ours ();
383 fprintf_unfiltered (mi->event_channel,
384 "thread-group-added,id=\"i%d\"",
386 gdb_flush (mi->event_channel);
390 mi_inferior_appeared (struct inferior *inf)
392 struct mi_interp *mi = top_level_interpreter_data ();
394 target_terminal_ours ();
395 fprintf_unfiltered (mi->event_channel,
396 "thread-group-started,id=\"i%d\",pid=\"%d\"",
398 gdb_flush (mi->event_channel);
402 mi_inferior_exit (struct inferior *inf)
404 struct mi_interp *mi = top_level_interpreter_data ();
406 target_terminal_ours ();
407 if (inf->has_exit_code)
408 fprintf_unfiltered (mi->event_channel,
409 "thread-group-exited,id=\"i%d\",exit-code=\"%s\"",
410 inf->num, int_string (inf->exit_code, 8, 0, 0, 1));
412 fprintf_unfiltered (mi->event_channel,
413 "thread-group-exited,id=\"i%d\"", inf->num);
415 gdb_flush (mi->event_channel);
419 mi_inferior_removed (struct inferior *inf)
421 struct mi_interp *mi = top_level_interpreter_data ();
423 target_terminal_ours ();
424 fprintf_unfiltered (mi->event_channel,
425 "thread-group-removed,id=\"i%d\"",
427 gdb_flush (mi->event_channel);
431 mi_on_normal_stop (struct bpstats *bs, int print_frame)
433 /* Since this can be called when CLI command is executing,
434 using cli interpreter, be sure to use MI uiout for output,
435 not the current one. */
436 struct ui_out *mi_uiout = interp_ui_out (top_level_interpreter ());
442 if (current_uiout != mi_uiout)
444 /* The normal_stop function has printed frame information
445 into CLI uiout, or some other non-MI uiout. There's no
446 way we can extract proper fields from random uiout
447 object, so we print the frame again. In practice, this
448 can only happen when running a CLI command in MI. */
449 struct ui_out *saved_uiout = current_uiout;
450 struct target_waitstatus last;
453 current_uiout = mi_uiout;
455 get_last_target_status (&last_ptid, &last);
456 bpstat_print (bs, last.kind);
458 print_stack_frame (get_selected_frame (NULL), 0, SRC_AND_LOC);
459 current_uiout = saved_uiout;
462 ui_out_field_int (mi_uiout, "thread-id",
463 pid_to_thread_id (inferior_ptid));
466 struct cleanup *back_to = make_cleanup_ui_out_list_begin_end
467 (mi_uiout, "stopped-threads");
469 ui_out_field_int (mi_uiout, NULL,
470 pid_to_thread_id (inferior_ptid));
471 do_cleanups (back_to);
474 ui_out_field_string (mi_uiout, "stopped-threads", "all");
476 core = target_core_of_thread (inferior_ptid);
478 ui_out_field_int (mi_uiout, "core", core);
481 fputs_unfiltered ("*stopped", raw_stdout);
482 mi_out_put (mi_uiout, raw_stdout);
483 mi_out_rewind (mi_uiout);
484 mi_print_timing_maybe ();
485 fputs_unfiltered ("\n", raw_stdout);
486 gdb_flush (raw_stdout);
490 mi_about_to_proceed (void)
492 /* Suppress output while calling an inferior function. */
494 if (!ptid_equal (inferior_ptid, null_ptid))
496 struct thread_info *tp = inferior_thread ();
498 if (tp->control.in_infcall)
505 /* When non-zero, no MI notifications will be emitted in
506 response to breakpoint change observers. */
508 int mi_suppress_breakpoint_notifications = 0;
510 /* Emit notification about a created breakpoint. */
513 mi_breakpoint_created (struct breakpoint *b)
515 struct mi_interp *mi = top_level_interpreter_data ();
516 struct ui_out *mi_uiout = interp_ui_out (top_level_interpreter ());
517 volatile struct gdb_exception e;
519 if (mi_suppress_breakpoint_notifications)
525 target_terminal_ours ();
526 fprintf_unfiltered (mi->event_channel,
527 "breakpoint-created");
528 /* We want the output from gdb_breakpoint_query to go to
529 mi->event_channel. One approach would be to just call
530 gdb_breakpoint_query, and then use mi_out_put to send the current
531 content of mi_outout into mi->event_channel. However, that will
532 break if anything is output to mi_uiout prior to calling the
533 breakpoint_created notifications. So, we use
535 ui_out_redirect (mi_uiout, mi->event_channel);
536 TRY_CATCH (e, RETURN_MASK_ERROR)
537 gdb_breakpoint_query (mi_uiout, b->number, NULL);
538 ui_out_redirect (mi_uiout, NULL);
540 gdb_flush (mi->event_channel);
543 /* Emit notification about deleted breakpoint. */
546 mi_breakpoint_deleted (struct breakpoint *b)
548 struct mi_interp *mi = top_level_interpreter_data ();
550 if (mi_suppress_breakpoint_notifications)
556 target_terminal_ours ();
558 fprintf_unfiltered (mi->event_channel, "breakpoint-deleted,id=\"%d\"",
561 gdb_flush (mi->event_channel);
564 /* Emit notification about modified breakpoint. */
567 mi_breakpoint_modified (struct breakpoint *b)
569 struct mi_interp *mi = top_level_interpreter_data ();
570 struct ui_out *mi_uiout = interp_ui_out (top_level_interpreter ());
571 volatile struct gdb_exception e;
573 if (mi_suppress_breakpoint_notifications)
579 target_terminal_ours ();
580 fprintf_unfiltered (mi->event_channel,
581 "breakpoint-modified");
582 /* We want the output from gdb_breakpoint_query to go to
583 mi->event_channel. One approach would be to just call
584 gdb_breakpoint_query, and then use mi_out_put to send the current
585 content of mi_outout into mi->event_channel. However, that will
586 break if anything is output to mi_uiout prior to calling the
587 breakpoint_created notifications. So, we use
589 ui_out_redirect (mi_uiout, mi->event_channel);
590 TRY_CATCH (e, RETURN_MASK_ERROR)
591 gdb_breakpoint_query (mi_uiout, b->number, NULL);
592 ui_out_redirect (mi_uiout, NULL);
594 gdb_flush (mi->event_channel);
598 mi_output_running_pid (struct thread_info *info, void *arg)
602 if (ptid_get_pid (*ptid) == ptid_get_pid (info->ptid))
603 fprintf_unfiltered (raw_stdout,
604 "*running,thread-id=\"%d\"\n",
611 mi_inferior_count (struct inferior *inf, void *arg)
623 mi_on_resume (ptid_t ptid)
625 struct thread_info *tp = NULL;
627 if (ptid_equal (ptid, minus_one_ptid) || ptid_is_pid (ptid))
628 tp = inferior_thread ();
630 tp = find_thread_ptid (ptid);
632 /* Suppress output while calling an inferior function. */
633 if (tp->control.in_infcall)
636 /* To cater for older frontends, emit ^running, but do it only once
637 per each command. We do it here, since at this point we know
638 that the target was successfully resumed, and in non-async mode,
639 we won't return back to MI interpreter code until the target
640 is done running, so delaying the output of "^running" until then
641 will make it impossible for frontend to know what's going on.
643 In future (MI3), we'll be outputting "^done" here. */
644 if (!running_result_record_printed && mi_proceeded)
646 fprintf_unfiltered (raw_stdout, "%s^running\n",
647 current_token ? current_token : "");
650 if (PIDGET (ptid) == -1)
651 fprintf_unfiltered (raw_stdout, "*running,thread-id=\"all\"\n");
652 else if (ptid_is_pid (ptid))
656 /* Backwards compatibility. If there's only one inferior,
657 output "all", otherwise, output each resumed thread
659 iterate_over_inferiors (mi_inferior_count, &count);
662 fprintf_unfiltered (raw_stdout, "*running,thread-id=\"all\"\n");
664 iterate_over_threads (mi_output_running_pid, &ptid);
668 struct thread_info *ti = find_thread_ptid (ptid);
671 fprintf_unfiltered (raw_stdout, "*running,thread-id=\"%d\"\n", ti->num);
674 if (!running_result_record_printed && mi_proceeded)
676 running_result_record_printed = 1;
677 /* This is what gdb used to do historically -- printing prompt even if
678 it cannot actually accept any input. This will be surely removed
679 for MI3, and may be removed even earler. */
680 /* FIXME: review the use of target_is_async_p here -- is that
682 if (!target_is_async_p ())
683 fputs_unfiltered ("(gdb) \n", raw_stdout);
685 gdb_flush (raw_stdout);
689 mi_solib_loaded (struct so_list *solib)
691 struct mi_interp *mi = top_level_interpreter_data ();
693 target_terminal_ours ();
694 if (gdbarch_has_global_solist (target_gdbarch))
695 fprintf_unfiltered (mi->event_channel,
696 "library-loaded,id=\"%s\",target-name=\"%s\","
697 "host-name=\"%s\",symbols-loaded=\"%d\"",
698 solib->so_original_name, solib->so_original_name,
699 solib->so_name, solib->symbols_loaded);
701 fprintf_unfiltered (mi->event_channel,
702 "library-loaded,id=\"%s\",target-name=\"%s\","
703 "host-name=\"%s\",symbols-loaded=\"%d\","
704 "thread-group=\"i%d\"",
705 solib->so_original_name, solib->so_original_name,
706 solib->so_name, solib->symbols_loaded,
707 current_inferior ()->num);
709 gdb_flush (mi->event_channel);
713 mi_solib_unloaded (struct so_list *solib)
715 struct mi_interp *mi = top_level_interpreter_data ();
717 target_terminal_ours ();
718 if (gdbarch_has_global_solist (target_gdbarch))
719 fprintf_unfiltered (mi->event_channel,
720 "library-unloaded,id=\"%s\",target-name=\"%s\","
722 solib->so_original_name, solib->so_original_name,
725 fprintf_unfiltered (mi->event_channel,
726 "library-unloaded,id=\"%s\",target-name=\"%s\","
727 "host-name=\"%s\",thread-group=\"i%d\"",
728 solib->so_original_name, solib->so_original_name,
729 solib->so_name, current_inferior ()->num);
731 gdb_flush (mi->event_channel);
735 report_initial_inferior (struct inferior *inf, void *closure)
737 /* This function is called from mi_intepreter_init, and since
738 mi_inferior_added assumes that inferior is fully initialized
739 and top_level_interpreter_data is set, we cannot call
741 struct mi_interp *mi = closure;
743 target_terminal_ours ();
744 fprintf_unfiltered (mi->event_channel,
745 "thread-group-added,id=\"i%d\"",
747 gdb_flush (mi->event_channel);
751 static struct ui_out *
752 mi_ui_out (struct interp *interp)
754 struct mi_interp *mi = interp_data (interp);
759 extern initialize_file_ftype _initialize_mi_interp; /* -Wmissing-prototypes */
762 _initialize_mi_interp (void)
764 static const struct interp_procs procs =
766 mi_interpreter_init, /* init_proc */
767 mi_interpreter_resume, /* resume_proc */
768 mi_interpreter_suspend, /* suspend_proc */
769 mi_interpreter_exec, /* exec_proc */
770 mi_interpreter_prompt_p, /* prompt_proc_p */
771 mi_ui_out /* ui_out_proc */
774 /* The various interpreter levels. */
775 interp_add (interp_new (INTERP_MI1, &procs));
776 interp_add (interp_new (INTERP_MI2, &procs));
777 interp_add (interp_new (INTERP_MI3, &procs));
778 interp_add (interp_new (INTERP_MI, &procs));