gdb/mi/mi-interp.c

   1 /* MI Interpreter Definitions and Commands for GDB, the GNU debugger.
   2
   3    Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   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.
  12
  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.
  17
  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/>.  */
  20
  21 #include "defs.h"
  22 #include "gdb_string.h"
  23 #include "interps.h"
  24 #include "event-top.h"
  25 #include "event-loop.h"
  26 #include "inferior.h"
  27 #include "ui-out.h"
  28 #include "top.h"
  29 #include "exceptions.h"
  30 #include "mi-main.h"
  31 #include "mi-cmds.h"
  32 #include "mi-out.h"
  33 #include "mi-console.h"
  34 #include "observer.h"
  35 #include "gdbthread.h"
  36
  37 struct mi_interp
  38 {
  39   /* MI's output channels */
  40   struct ui_file *out;
  41   struct ui_file *err;
  42   struct ui_file *log;
  43   struct ui_file *targ;
  44   struct ui_file *event_channel;
  45
  46   /* This is the interpreter for the mi... */
  47   struct interp *mi2_interp;
  48   struct interp *mi1_interp;
  49   struct interp *mi_interp;
  50 };
  51
  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);
  55
  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);
  61
  62 static void mi3_command_loop (void);
  63 static void mi2_command_loop (void);
  64 static void mi1_command_loop (void);
  65
  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);
  69
  70 static void mi_new_thread (struct thread_info *t);
  71 static void mi_thread_exit (struct thread_info *t);
  72
  73 static void *
  74 mi_interpreter_init (int top_level)
  75 {
  76   struct mi_interp *mi = XMALLOC (struct mi_interp);
  77
  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. */
  82
  83   raw_stdout = stdio_fileopen (stdout);
  84
  85   /* Create MI channels */
  86   mi->out = mi_console_file_new (raw_stdout, "~", '"');
  87   mi->err = mi_console_file_new (raw_stdout, "&", '"');
  88   mi->log = mi->err;
  89   mi->targ = mi_console_file_new (raw_stdout, "@", '"');
  90   mi->event_channel = mi_console_file_new (raw_stdout, "=", 0);
  91
  92   if (top_level)
  93     {
  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);
  97     }
  98
  99   return mi;
 100 }
 101
 102 static int
 103 mi_interpreter_resume (void *data)
 104 {
 105   struct mi_interp *mi = data;
 106   /* As per hack note in mi_interpreter_init, swap in the output channels... */
 107
 108   gdb_setup_readline ();
 109
 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
 121      here...  */
 122   sync_execution = 0;
 123
 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;
 132
 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 ();
 136
 137   deprecated_show_load_progress = mi_load_progress;
 138
 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;
 146   else
 147     deprecated_command_loop_hook = mi2_command_loop;
 148
 149   return 1;
 150 }
 151
 152 static int
 153 mi_interpreter_suspend (void *data)
 154 {
 155   gdb_disable_readline ();
 156   return 1;
 157 }
 158
 159 static struct gdb_exception
 160 mi_interpreter_exec (void *data, const char *command)
 161 {
 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;
 167 }
 168
 169 /* Never display the default gdb prompt in mi case.  */
 170 static int
 171 mi_interpreter_prompt_p (void *data)
 172 {
 173   return 0;
 174 }
 175
 176 enum mi_cmd_result
 177 mi_cmd_interpreter_exec (char *command, char **argv, int argc)
 178 {
 179   struct interp *interp_to_use;
 180   int i;
 181   struct interp_procs *procs;
 182   char *mi_error_message = NULL;
 183   struct cleanup *old_chain;
 184
 185   if (argc < 2)
 186     error ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
 187
 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]);
 191
 192   if (!interp_exec_p (interp_to_use))
 193     error ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
 194               argv[0]);
 195
 196   /* Insert the MI out hooks, making sure to also call the interpreter's hooks
 197      if it has any. */
 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 ();
 201
 202   /* Now run the code... */
 203
 204   old_chain = make_cleanup (null_cleanup, 0);
 205   for (i = 1; i < argc; i++)
 206     {
 207       struct gdb_exception e = interp_exec (interp_to_use, argv[i]);
 208       if (e.reason < 0)
 209         {
 210           mi_error_message = xstrdup (e.message);
 211           make_cleanup (xfree, mi_error_message);
 212           break;
 213         }
 214     }
 215
 216   mi_remove_notify_hooks ();
 217
 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... */
 222
 223   if (target_can_async_p () && target_executing)
 224     {
 225       fputs_unfiltered ("^running\n", raw_stdout);
 226     }
 227
 228   if (mi_error_message != NULL)
 229     error ("%s", mi_error_message);
 230   do_cleanups (old_chain);
 231   return MI_CMD_DONE;
 232 }
 233
 234 /*
 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.
 240 */
 241
 242 static void
 243 mi_insert_notify_hooks (void)
 244 {
 245   deprecated_query_hook = mi_interp_query_hook;
 246 }
 247
 248 static void
 249 mi_remove_notify_hooks (void)
 250 {
 251   deprecated_query_hook = NULL;
 252 }
 253
 254 static int
 255 mi_interp_query_hook (const char *ctlstr, va_list ap)
 256 {
 257   return 1;
 258 }
 259
 260 static void
 261 mi_execute_command_wrapper (char *cmd)
 262 {
 263   mi_execute_command (cmd, stdin == instream);
 264 }
 265
 266 static void
 267 mi1_command_loop (void)
 268 {
 269   mi_command_loop (1);
 270 }
 271
 272 static void
 273 mi2_command_loop (void)
 274 {
 275   mi_command_loop (2);
 276 }
 277
 278 static void
 279 mi3_command_loop (void)
 280 {
 281   mi_command_loop (3);
 282 }
 283
 284 static void
 285 mi_command_loop (int mi_version)
 286 {
 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);
 293   start_event_loop ();
 294 }
 295
 296 static void
 297 mi_new_thread (struct thread_info *t)
 298 {
 299   struct mi_interp *mi = top_level_interpreter_data ();
 300
 301   fprintf_unfiltered (mi->event_channel, "thread-created,id=\"%d\"", t->num);
 302   gdb_flush (mi->event_channel);
 303 }
 304
 305 static void
 306 mi_thread_exit (struct thread_info *t)
 307 {
 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);
 312 }
 313
 314 static void
 315 mi_on_normal_stop (struct bpstats *bs)
 316 {
 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 ();
 322
 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);
 328 }
 329
 330 extern initialize_file_ftype _initialize_mi_interp; /* -Wmissing-prototypes */
 331
 332 void
 333 _initialize_mi_interp (void)
 334 {
 335   static const struct interp_procs procs =
 336   {
 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 */
 342   };
 343
 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));
 348
 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));
 352 }