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 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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 2 of the License, or
  10    (at your option) any later version.
  11
  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.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20    Boston, MA 02110-1301, USA.  */
  21
  22 #include "defs.h"
  23 #include "gdb_string.h"
  24 #include "interps.h"
  25 #include "event-top.h"
  26 #include "event-loop.h"
  27 #include "inferior.h"
  28 #include "ui-out.h"
  29 #include "top.h"
  30 #include "exceptions.h"
  31 #include "mi-main.h"
  32 #include "mi-cmds.h"
  33 #include "mi-out.h"
  34 #include "mi-console.h"
  35
  36 struct mi_interp
  37 {
  38   /* MI's output channels */
  39   struct ui_file *out;
  40   struct ui_file *err;
  41   struct ui_file *log;
  42   struct ui_file *targ;
  43   struct ui_file *event_channel;
  44
  45   /* This is the interpreter for the mi... */
  46   struct interp *mi2_interp;
  47   struct interp *mi1_interp;
  48   struct interp *mi_interp;
  49 };
  50
  51 /* These are the interpreter setup, etc. functions for the MI interpreter */
  52 static void mi_execute_command_wrapper (char *cmd);
  53 static void mi_command_loop (int mi_version);
  54
  55 /* These are hooks that we put in place while doing interpreter_exec
  56    so we can report interesting things that happened "behind the mi's
  57    back" in this command */
  58 static int mi_interp_query_hook (const char *ctlstr, va_list ap)
  59      ATTR_FORMAT (printf, 1, 0);
  60
  61 static void mi3_command_loop (void);
  62 static void mi2_command_loop (void);
  63 static void mi1_command_loop (void);
  64
  65 static void mi_insert_notify_hooks (void);
  66 static void mi_remove_notify_hooks (void);
  67
  68 static void *
  69 mi_interpreter_init (void)
  70 {
  71   struct mi_interp *mi = XMALLOC (struct mi_interp);
  72
  73   /* HACK: We need to force stdout/stderr to point at the console.  This avoids
  74      any potential side effects caused by legacy code that is still
  75      using the TUI / fputs_unfiltered_hook.  So we set up output channels for
  76      this now, and swap them in when we are run. */
  77
  78   raw_stdout = stdio_fileopen (stdout);
  79
  80   /* Create MI channels */
  81   mi->out = mi_console_file_new (raw_stdout, "~", '"');
  82   mi->err = mi_console_file_new (raw_stdout, "&", '"');
  83   mi->log = mi->err;
  84   mi->targ = mi_console_file_new (raw_stdout, "@", '"');
  85   mi->event_channel = mi_console_file_new (raw_stdout, "=", 0);
  86
  87   return mi;
  88 }
  89
  90 static int
  91 mi_interpreter_resume (void *data)
  92 {
  93   struct mi_interp *mi = data;
  94   /* As per hack note in mi_interpreter_init, swap in the output channels... */
  95
  96   gdb_setup_readline ();
  97
  98   /* These overwrite some of the initialization done in
  99      _intialize_event_loop.  */
 100   call_readline = gdb_readline2;
 101   input_handler = mi_execute_command_wrapper;
 102   add_file_handler (input_fd, stdin_event_handler, 0);
 103   async_command_editing_p = 0;
 104   /* FIXME: This is a total hack for now.  PB's use of the MI
 105      implicitly relies on a bug in the async support which allows
 106      asynchronous commands to leak through the commmand loop.  The bug
 107      involves (but is not limited to) the fact that sync_execution was
 108      erroneously initialized to 0.  Duplicate by initializing it thus
 109      here...  */
 110   sync_execution = 0;
 111
 112   gdb_stdout = mi->out;
 113   /* Route error and log output through the MI */
 114   gdb_stderr = mi->err;
 115   gdb_stdlog = mi->log;
 116   /* Route target output through the MI. */
 117   gdb_stdtarg = mi->targ;
 118   /* Route target error through the MI as well. */
 119   gdb_stdtargerr = mi->targ;
 120
 121   /* Replace all the hooks that we know about.  There really needs to
 122      be a better way of doing this... */
 123   clear_interpreter_hooks ();
 124
 125   deprecated_show_load_progress = mi_load_progress;
 126
 127   /* If we're _the_ interpreter, take control. */
 128   if (current_interp_named_p (INTERP_MI1))
 129     deprecated_command_loop_hook = mi1_command_loop;
 130   else if (current_interp_named_p (INTERP_MI2))
 131     deprecated_command_loop_hook = mi2_command_loop;
 132   else if (current_interp_named_p (INTERP_MI3))
 133     deprecated_command_loop_hook = mi3_command_loop;
 134   else
 135     deprecated_command_loop_hook = mi2_command_loop;
 136
 137   return 1;
 138 }
 139
 140 static int
 141 mi_interpreter_suspend (void *data)
 142 {
 143   gdb_disable_readline ();
 144   return 1;
 145 }
 146
 147 static struct gdb_exception
 148 mi_interpreter_exec (void *data, const char *command)
 149 {
 150   static struct gdb_exception ok;
 151   char *tmp = alloca (strlen (command) + 1);
 152   strcpy (tmp, command);
 153   mi_execute_command_wrapper (tmp);
 154   return exception_none;
 155 }
 156
 157 /* Never display the default gdb prompt in mi case.  */
 158 static int
 159 mi_interpreter_prompt_p (void *data)
 160 {
 161   return 0;
 162 }
 163
 164 static void
 165 mi_interpreter_exec_continuation (struct continuation_arg *arg)
 166 {
 167   bpstat_do_actions (&stop_bpstat);
 168   if (!target_executing)
 169     {
 170       fputs_unfiltered ("*stopped", raw_stdout);
 171       mi_out_put (uiout, raw_stdout);
 172       fputs_unfiltered ("\n", raw_stdout);
 173       fputs_unfiltered ("(gdb) \n", raw_stdout);
 174       gdb_flush (raw_stdout);
 175       do_exec_cleanups (ALL_CLEANUPS);
 176     }
 177   else if (target_can_async_p ())
 178     {
 179       add_continuation (mi_interpreter_exec_continuation, NULL);
 180     }
 181 }
 182
 183 enum mi_cmd_result
 184 mi_cmd_interpreter_exec (char *command, char **argv, int argc)
 185 {
 186   struct interp *interp_to_use;
 187   enum mi_cmd_result result = MI_CMD_DONE;
 188   int i;
 189   struct interp_procs *procs;
 190
 191   if (argc < 2)
 192     {
 193       mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
 194       return MI_CMD_ERROR;
 195     }
 196
 197   interp_to_use = interp_lookup (argv[0]);
 198   if (interp_to_use == NULL)
 199     {
 200       mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: could not find interpreter \"%s\"", argv[0]);
 201       return MI_CMD_ERROR;
 202     }
 203
 204   if (!interp_exec_p (interp_to_use))
 205     {
 206       mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
 207                                      argv[0]);
 208       return MI_CMD_ERROR;
 209     }
 210
 211   /* Insert the MI out hooks, making sure to also call the interpreter's hooks
 212      if it has any. */
 213   /* KRS: We shouldn't need this... Events should be installed and they should
 214      just ALWAYS fire something out down the MI channel... */
 215   mi_insert_notify_hooks ();
 216
 217   /* Now run the code... */
 218
 219   for (i = 1; i < argc; i++)
 220     {
 221       char *buff = NULL;
 222       /* Do this in a cleaner way...  We want to force execution to be
 223          asynchronous for commands that run the target.  */
 224       if (target_can_async_p () && (strcmp (argv[0], "console") == 0))
 225         {
 226           int len = strlen (argv[i]);
 227           buff = xmalloc (len + 2);
 228           memcpy (buff, argv[i], len);
 229           buff[len] = '&';
 230           buff[len + 1] = '\0';
 231         }
 232
 233       /* We had to set sync_execution = 0 for the mi (well really for Project
 234          Builder's use of the mi - particularly so interrupting would work.
 235          But for console commands to work, we need to initialize it to 1 -
 236          since that is what the cli expects - before running the command,
 237          and then set it back to 0 when we are done. */
 238       sync_execution = 1;
 239       {
 240         struct gdb_exception e = interp_exec (interp_to_use, argv[i]);
 241         if (e.reason < 0)
 242           {
 243             mi_error_message = xstrdup (e.message);
 244             result = MI_CMD_ERROR;
 245             break;
 246           }
 247       }
 248       xfree (buff);
 249       do_exec_error_cleanups (ALL_CLEANUPS);
 250       sync_execution = 0;
 251     }
 252
 253   mi_remove_notify_hooks ();
 254
 255   /* Okay, now let's see if the command set the inferior going...
 256      Tricky point - have to do this AFTER resetting the interpreter, since
 257      changing the interpreter will clear out all the continuations for
 258      that interpreter... */
 259
 260   if (target_can_async_p () && target_executing)
 261     {
 262       fputs_unfiltered ("^running\n", raw_stdout);
 263       add_continuation (mi_interpreter_exec_continuation, NULL);
 264     }
 265
 266   return result;
 267 }
 268
 269 /*
 270  * mi_insert_notify_hooks - This inserts a number of hooks that are meant to produce
 271  * async-notify ("=") MI messages while running commands in another interpreter
 272  * using mi_interpreter_exec.  The canonical use for this is to allow access to
 273  * the gdb CLI interpreter from within the MI, while still producing MI style output
 274  * when actions in the CLI command change gdb's state.
 275 */
 276
 277 static void
 278 mi_insert_notify_hooks (void)
 279 {
 280   deprecated_query_hook = mi_interp_query_hook;
 281 }
 282
 283 static void
 284 mi_remove_notify_hooks (void)
 285 {
 286   deprecated_query_hook = NULL;
 287 }
 288
 289 static int
 290 mi_interp_query_hook (const char *ctlstr, va_list ap)
 291 {
 292   return 1;
 293 }
 294
 295 static void
 296 mi_execute_command_wrapper (char *cmd)
 297 {
 298   mi_execute_command (cmd, stdin == instream);
 299 }
 300
 301 static void
 302 mi1_command_loop (void)
 303 {
 304   mi_command_loop (1);
 305 }
 306
 307 static void
 308 mi2_command_loop (void)
 309 {
 310   mi_command_loop (2);
 311 }
 312
 313 static void
 314 mi3_command_loop (void)
 315 {
 316   mi_command_loop (3);
 317 }
 318
 319 static void
 320 mi_command_loop (int mi_version)
 321 {
 322 #if 0
 323   /* HACK: Force stdout/stderr to point at the console.  This avoids
 324      any potential side effects caused by legacy code that is still
 325      using the TUI / fputs_unfiltered_hook */
 326   raw_stdout = stdio_fileopen (stdout);
 327   /* Route normal output through the MIx */
 328   gdb_stdout = mi_console_file_new (raw_stdout, "~", '"');
 329   /* Route error and log output through the MI */
 330   gdb_stderr = mi_console_file_new (raw_stdout, "&", '"');
 331   gdb_stdlog = gdb_stderr;
 332   /* Route target output through the MI. */
 333   gdb_stdtarg = mi_console_file_new (raw_stdout, "@", '"');
 334   /* HACK: Poke the ui_out table directly.  Should we be creating a
 335      mi_out object wired up to the above gdb_stdout / gdb_stderr? */
 336   uiout = mi_out_new (mi_version);
 337   /* HACK: Override any other interpreter hooks.  We need to create a
 338      real event table and pass in that. */
 339   deprecated_init_ui_hook = 0;
 340   /* deprecated_command_loop_hook = 0; */
 341   deprecated_print_frame_info_listing_hook = 0;
 342   deprecated_query_hook = 0;
 343   deprecated_warning_hook = 0;
 344   deprecated_create_breakpoint_hook = 0;
 345   deprecated_delete_breakpoint_hook = 0;
 346   deprecated_modify_breakpoint_hook = 0;
 347   deprecated_interactive_hook = 0;
 348   deprecated_readline_begin_hook = 0;
 349   deprecated_readline_hook = 0;
 350   deprecated_readline_end_hook = 0;
 351   deprecated_register_changed_hook = 0;
 352   deprecated_memory_changed_hook = 0;
 353   deprecated_context_hook = 0;
 354   deprecated_target_wait_hook = 0;
 355   deprecated_call_command_hook = 0;
 356   deprecated_error_hook = 0;
 357   deprecated_error_begin_hook = 0;
 358   deprecated_show_load_progress = mi_load_progress;
 359 #endif
 360   /* Turn off 8 bit strings in quoted output.  Any character with the
 361      high bit set is printed using C's octal format. */
 362   sevenbit_strings = 1;
 363   /* Tell the world that we're alive */
 364   fputs_unfiltered ("(gdb) \n", raw_stdout);
 365   gdb_flush (raw_stdout);
 366   start_event_loop ();
 367 }
 368
 369 extern initialize_file_ftype _initialize_mi_interp; /* -Wmissing-prototypes */
 370
 371 void
 372 _initialize_mi_interp (void)
 373 {
 374   static const struct interp_procs procs =
 375   {
 376     mi_interpreter_init,        /* init_proc */
 377     mi_interpreter_resume,      /* resume_proc */
 378     mi_interpreter_suspend,     /* suspend_proc */
 379     mi_interpreter_exec,        /* exec_proc */
 380     mi_interpreter_prompt_p     /* prompt_proc_p */
 381   };
 382
 383   /* The various interpreter levels.  */
 384   interp_add (interp_new (INTERP_MI1, NULL, mi_out_new (1), &procs));
 385   interp_add (interp_new (INTERP_MI2, NULL, mi_out_new (2), &procs));
 386   interp_add (interp_new (INTERP_MI3, NULL, mi_out_new (3), &procs));
 387
 388   /* "mi" selects the most recent released version.  "mi2" was
 389      released as part of GDB 6.0.  */
 390   interp_add (interp_new (INTERP_MI, NULL, mi_out_new (2), &procs));
 391 }