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 static void mi_on_resume (ptid_t ptid);
  73
  74 static void *
  75 mi_interpreter_init (int top_level)
  76 {
  77   struct mi_interp *mi = XMALLOC (struct mi_interp);
  78
  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. */
  83
  84   raw_stdout = stdio_fileopen (stdout);
  85
  86   /* Create MI channels */
  87   mi->out = mi_console_file_new (raw_stdout, "~", '"');
  88   mi->err = mi_console_file_new (raw_stdout, "&", '"');
  89   mi->log = mi->err;
  90   mi->targ = mi_console_file_new (raw_stdout, "@", '"');
  91   mi->event_channel = mi_console_file_new (raw_stdout, "=", 0);
  92
  93   if (top_level)
  94     {
  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);
  99     }
 100
 101   return mi;
 102 }
 103
 104 static int
 105 mi_interpreter_resume (void *data)
 106 {
 107   struct mi_interp *mi = data;
 108   /* As per hack note in mi_interpreter_init, swap in the output channels... */
 109
 110   gdb_setup_readline ();
 111
 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
 123      here...  */
 124   sync_execution = 0;
 125
 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;
 134
 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 ();
 138
 139   deprecated_show_load_progress = mi_load_progress;
 140
 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;
 148   else
 149     deprecated_command_loop_hook = mi2_command_loop;
 150
 151   return 1;
 152 }
 153
 154 static int
 155 mi_interpreter_suspend (void *data)
 156 {
 157   gdb_disable_readline ();
 158   return 1;
 159 }
 160
 161 static struct gdb_exception
 162 mi_interpreter_exec (void *data, const char *command)
 163 {
 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;
 169 }
 170
 171 /* Never display the default gdb prompt in mi case.  */
 172 static int
 173 mi_interpreter_prompt_p (void *data)
 174 {
 175   return 0;
 176 }
 177
 178 enum mi_cmd_result
 179 mi_cmd_interpreter_exec (char *command, char **argv, int argc)
 180 {
 181   struct interp *interp_to_use;
 182   int i;
 183   struct interp_procs *procs;
 184   char *mi_error_message = NULL;
 185   struct cleanup *old_chain;
 186
 187   if (argc < 2)
 188     error ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
 189
 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]);
 193
 194   if (!interp_exec_p (interp_to_use))
 195     error ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
 196               argv[0]);
 197
 198   /* Insert the MI out hooks, making sure to also call the interpreter's hooks
 199      if it has any. */
 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 ();
 203
 204   /* Now run the code... */
 205
 206   old_chain = make_cleanup (null_cleanup, 0);
 207   for (i = 1; i < argc; i++)
 208     {
 209       struct gdb_exception e = interp_exec (interp_to_use, argv[i]);
 210       if (e.reason < 0)
 211         {
 212           mi_error_message = xstrdup (e.message);
 213           make_cleanup (xfree, mi_error_message);
 214           break;
 215         }
 216     }
 217
 218   mi_remove_notify_hooks ();
 219
 220   /* Okay, now let's see if the command set the inferior going...
 221      Tricky point - have to do this AFTER resetting the interpreter, since
 222      changing the interpreter will clear out all the continuations for
 223      that interpreter... */
 224
 225   if (target_can_async_p () && target_executing)
 226     {
 227       fputs_unfiltered ("^running\n", raw_stdout);
 228     }
 229
 230   if (mi_error_message != NULL)
 231     error ("%s", mi_error_message);
 232   do_cleanups (old_chain);
 233   return MI_CMD_DONE;
 234 }
 235
 236 /*
 237  * mi_insert_notify_hooks - This inserts a number of hooks that are meant to produce
 238  * async-notify ("=") MI messages while running commands in another interpreter
 239  * using mi_interpreter_exec.  The canonical use for this is to allow access to
 240  * the gdb CLI interpreter from within the MI, while still producing MI style output
 241  * when actions in the CLI command change gdb's state.
 242 */
 243
 244 static void
 245 mi_insert_notify_hooks (void)
 246 {
 247   deprecated_query_hook = mi_interp_query_hook;
 248 }
 249
 250 static void
 251 mi_remove_notify_hooks (void)
 252 {
 253   deprecated_query_hook = NULL;
 254 }
 255
 256 static int
 257 mi_interp_query_hook (const char *ctlstr, va_list ap)
 258 {
 259   return 1;
 260 }
 261
 262 static void
 263 mi_execute_command_wrapper (char *cmd)
 264 {
 265   mi_execute_command (cmd, stdin == instream);
 266 }
 267
 268 static void
 269 mi1_command_loop (void)
 270 {
 271   mi_command_loop (1);
 272 }
 273
 274 static void
 275 mi2_command_loop (void)
 276 {
 277   mi_command_loop (2);
 278 }
 279
 280 static void
 281 mi3_command_loop (void)
 282 {
 283   mi_command_loop (3);
 284 }
 285
 286 static void
 287 mi_command_loop (int mi_version)
 288 {
 289   /* Turn off 8 bit strings in quoted output.  Any character with the
 290      high bit set is printed using C's octal format. */
 291   sevenbit_strings = 1;
 292   /* Tell the world that we're alive */
 293   fputs_unfiltered ("(gdb) \n", raw_stdout);
 294   gdb_flush (raw_stdout);
 295   start_event_loop ();
 296 }
 297
 298 static void
 299 mi_new_thread (struct thread_info *t)
 300 {
 301   struct mi_interp *mi = top_level_interpreter_data ();
 302
 303   fprintf_unfiltered (mi->event_channel, "thread-created,id=\"%d\"", t->num);
 304   gdb_flush (mi->event_channel);
 305 }
 306
 307 static void
 308 mi_thread_exit (struct thread_info *t)
 309 {
 310   struct mi_interp *mi = top_level_interpreter_data ();
 311   target_terminal_ours ();
 312   fprintf_unfiltered (mi->event_channel, "thread-exited,id=\"%d\"", t->num);
 313   gdb_flush (mi->event_channel);
 314 }
 315
 316 static void
 317 mi_on_normal_stop (struct bpstats *bs)
 318 {
 319   /* Since this can be called when CLI command is executing,
 320      using cli interpreter, be sure to use MI uiout for output,
 321      not the current one.  */
 322   struct ui_out *uiout = interp_ui_out (top_level_interpreter ());
 323   struct mi_interp *mi = top_level_interpreter_data ();
 324
 325   fputs_unfiltered ("*stopped", raw_stdout);
 326   mi_out_put (uiout, raw_stdout);
 327   mi_out_rewind (uiout);
 328   fputs_unfiltered ("\n", raw_stdout);
 329   gdb_flush (raw_stdout);
 330 }
 331
 332 static void
 333 mi_on_resume (ptid_t ptid)
 334 {
 335   if (PIDGET (ptid) == -1)
 336     fprintf_unfiltered (raw_stdout, "*running,thread-id=\"all\"\n");
 337   else
 338     {
 339       struct thread_info *ti = find_thread_pid (ptid);
 340       gdb_assert (ti);
 341       fprintf_unfiltered (raw_stdout, "*running,thread-id=\"%d\"\n", ti->num);
 342     }
 343 }
 344
 345 extern initialize_file_ftype _initialize_mi_interp; /* -Wmissing-prototypes */
 346
 347 void
 348 _initialize_mi_interp (void)
 349 {
 350   static const struct interp_procs procs =
 351   {
 352     mi_interpreter_init,        /* init_proc */
 353     mi_interpreter_resume,      /* resume_proc */
 354     mi_interpreter_suspend,     /* suspend_proc */
 355     mi_interpreter_exec,        /* exec_proc */
 356     mi_interpreter_prompt_p     /* prompt_proc_p */
 357   };
 358
 359   /* The various interpreter levels.  */
 360   interp_add (interp_new (INTERP_MI1, NULL, mi_out_new (1), &procs));
 361   interp_add (interp_new (INTERP_MI2, NULL, mi_out_new (2), &procs));
 362   interp_add (interp_new (INTERP_MI3, NULL, mi_out_new (3), &procs));
 363
 364   /* "mi" selects the most recent released version.  "mi2" was
 365      released as part of GDB 6.0.  */
 366   interp_add (interp_new (INTERP_MI, NULL, mi_out_new (2), &procs));
 367 }