3 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008
4 Free Software Foundation, Inc.
6 Contributed by Cygnus Solutions (a Red Hat company).
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 /* Work in progress. */
28 #include "gdb_string.h"
29 #include "exceptions.h"
31 #include "gdbthread.h"
34 #include "mi-getopt.h"
35 #include "mi-console.h"
39 #include "event-loop.h"
40 #include "event-top.h"
41 #include "gdbcore.h" /* For write_memory(). */
51 #if defined HAVE_SYS_RESOURCE_H
52 #include <sys/resource.h>
64 /* Enumerations of the actions that may result from calling
65 captured_mi_execute_command. */
67 enum captured_mi_execute_command_actions
69 EXECUTE_COMMAND_DISPLAY_PROMPT,
70 EXECUTE_COMMAND_SUPRESS_PROMPT
73 /* This structure is used to pass information from captured_mi_execute_command
74 to mi_execute_command. */
75 struct captured_mi_execute_command_args
77 /* This return result of the MI command (output). */
78 enum mi_cmd_result rc;
80 /* What action to perform when the call is finished (output). */
81 enum captured_mi_execute_command_actions action;
83 /* The command context to be executed (input). */
84 struct mi_parse *command;
88 struct ui_file *raw_stdout;
90 /* This is used to pass the current command timestamp
91 down to continuation routines. */
92 static struct mi_timestamp *current_command_ts;
94 static int do_timings = 0;
96 /* The token of the last asynchronous command. */
97 static char *last_async_command;
98 static char *previous_async_command;
99 char *mi_error_message;
101 extern void _initialize_mi_main (void);
102 static enum mi_cmd_result mi_cmd_execute (struct mi_parse *parse);
104 static void mi_execute_cli_command (const char *cmd, int args_p,
106 static enum mi_cmd_result mi_execute_async_cli_command (char *mi, char *args, int from_tty);
108 static void mi_exec_async_cli_cmd_continuation (struct continuation_arg *arg);
110 static int register_changed_p (int regnum, struct regcache *,
112 static int get_register (int regnum, int format);
114 /* Command implementations. FIXME: Is this libgdb? No. This is the MI
115 layer that calls libgdb. Any operation used in the below should be
118 static void timestamp (struct mi_timestamp *tv);
120 static void print_diff_now (struct mi_timestamp *start);
121 static void print_diff (struct mi_timestamp *start, struct mi_timestamp *end);
124 mi_cmd_gdb_exit (char *command, char **argv, int argc)
126 /* We have to print everything right here because we never return. */
127 if (last_async_command)
128 fputs_unfiltered (last_async_command, raw_stdout);
129 fputs_unfiltered ("^exit\n", raw_stdout);
130 mi_out_put (uiout, raw_stdout);
131 /* FIXME: The function called is not yet a formal libgdb function. */
132 quit_force (NULL, FROM_TTY);
137 mi_cmd_exec_run (char *args, int from_tty)
139 /* FIXME: Should call a libgdb function, not a cli wrapper. */
140 return mi_execute_async_cli_command ("run", args, from_tty);
144 mi_cmd_exec_next (char *args, int from_tty)
146 /* FIXME: Should call a libgdb function, not a cli wrapper. */
147 return mi_execute_async_cli_command ("next", args, from_tty);
151 mi_cmd_exec_next_instruction (char *args, int from_tty)
153 /* FIXME: Should call a libgdb function, not a cli wrapper. */
154 return mi_execute_async_cli_command ("nexti", args, from_tty);
158 mi_cmd_exec_step (char *args, int from_tty)
160 /* FIXME: Should call a libgdb function, not a cli wrapper. */
161 return mi_execute_async_cli_command ("step", args, from_tty);
165 mi_cmd_exec_step_instruction (char *args, int from_tty)
167 /* FIXME: Should call a libgdb function, not a cli wrapper. */
168 return mi_execute_async_cli_command ("stepi", args, from_tty);
172 mi_cmd_exec_finish (char *args, int from_tty)
174 /* FIXME: Should call a libgdb function, not a cli wrapper. */
175 return mi_execute_async_cli_command ("finish", args, from_tty);
179 mi_cmd_exec_until (char *args, int from_tty)
181 /* FIXME: Should call a libgdb function, not a cli wrapper. */
182 return mi_execute_async_cli_command ("until", args, from_tty);
186 mi_cmd_exec_return (char *args, int from_tty)
188 /* This command doesn't really execute the target, it just pops the
189 specified number of frames. */
191 /* Call return_command with from_tty argument equal to 0 so as to
192 avoid being queried. */
193 return_command (args, 0);
195 /* Call return_command with from_tty argument equal to 0 so as to
196 avoid being queried. */
197 return_command (NULL, 0);
199 /* Because we have called return_command with from_tty = 0, we need
200 to print the frame here. */
201 print_stack_frame (get_selected_frame (NULL), 1, LOC_AND_ADDRESS);
207 mi_cmd_exec_continue (char *args, int from_tty)
209 /* FIXME: Should call a libgdb function, not a cli wrapper. */
210 return mi_execute_async_cli_command ("continue", args, from_tty);
213 /* Interrupt the execution of the target. Note how we must play around
214 with the token variables, in order to display the current token in
215 the result of the interrupt command, and the previous execution
216 token when the target finally stops. See comments in
219 mi_cmd_exec_interrupt (char *args, int from_tty)
221 if (!target_executing)
223 mi_error_message = xstrprintf ("mi_cmd_exec_interrupt: Inferior not executing.");
226 interrupt_target_command (args, from_tty);
227 if (last_async_command)
228 fputs_unfiltered (last_async_command, raw_stdout);
229 fputs_unfiltered ("^done", raw_stdout);
230 xfree (last_async_command);
231 if (previous_async_command)
232 last_async_command = xstrdup (previous_async_command);
233 xfree (previous_async_command);
234 previous_async_command = NULL;
235 mi_out_put (uiout, raw_stdout);
236 mi_out_rewind (uiout);
237 fputs_unfiltered ("\n", raw_stdout);
242 mi_cmd_thread_select (char *command, char **argv, int argc)
248 mi_error_message = xstrprintf ("mi_cmd_thread_select: USAGE: threadnum.");
252 rc = gdb_thread_select (uiout, argv[0], &mi_error_message);
254 if (rc == GDB_RC_FAIL)
261 mi_cmd_thread_list_ids (char *command, char **argv, int argc)
267 mi_error_message = xstrprintf ("mi_cmd_thread_list_ids: No arguments required.");
271 rc = gdb_list_thread_ids (uiout, &mi_error_message);
273 if (rc == GDB_RC_FAIL)
280 mi_cmd_data_list_register_names (char *command, char **argv, int argc)
284 struct cleanup *cleanup;
286 /* Note that the test for a valid register must include checking the
287 gdbarch_register_name because gdbarch_num_regs may be allocated for
288 the union of the register sets within a family of related processors.
289 In this case, some entries of gdbarch_register_name will change depending
290 upon the particular processor being debugged. */
292 numregs = gdbarch_num_regs (current_gdbarch)
293 + gdbarch_num_pseudo_regs (current_gdbarch);
295 cleanup = make_cleanup_ui_out_list_begin_end (uiout, "register-names");
297 if (argc == 0) /* No args, just do all the regs. */
303 if (gdbarch_register_name (current_gdbarch, regnum) == NULL
304 || *(gdbarch_register_name (current_gdbarch, regnum)) == '\0')
305 ui_out_field_string (uiout, NULL, "");
307 ui_out_field_string (uiout, NULL,
308 gdbarch_register_name
309 (current_gdbarch, regnum));
313 /* Else, list of register #s, just do listed regs. */
314 for (i = 0; i < argc; i++)
316 regnum = atoi (argv[i]);
317 if (regnum < 0 || regnum >= numregs)
319 do_cleanups (cleanup);
320 mi_error_message = xstrprintf ("bad register number");
323 if (gdbarch_register_name (current_gdbarch, regnum) == NULL
324 || *(gdbarch_register_name (current_gdbarch, regnum)) == '\0')
325 ui_out_field_string (uiout, NULL, "");
327 ui_out_field_string (uiout, NULL,
328 gdbarch_register_name (current_gdbarch, regnum));
330 do_cleanups (cleanup);
335 mi_cmd_data_list_changed_registers (char *command, char **argv, int argc)
337 static struct regcache *this_regs = NULL;
338 struct regcache *prev_regs;
339 int regnum, numregs, changed;
341 struct cleanup *cleanup;
343 /* The last time we visited this function, the current frame's register
344 contents were saved in THIS_REGS. Move THIS_REGS over to PREV_REGS,
345 and refresh THIS_REGS with the now-current register contents. */
347 prev_regs = this_regs;
348 this_regs = frame_save_as_regcache (get_selected_frame (NULL));
349 cleanup = make_cleanup_regcache_xfree (prev_regs);
351 /* Note that the test for a valid register must include checking the
352 gdbarch_register_name because gdbarch_num_regs may be allocated for
353 the union of the register sets within a family of related processors.
354 In this case, some entries of gdbarch_register_name will change depending
355 upon the particular processor being debugged. */
357 numregs = gdbarch_num_regs (current_gdbarch)
358 + gdbarch_num_pseudo_regs (current_gdbarch);
360 make_cleanup_ui_out_list_begin_end (uiout, "changed-registers");
362 if (argc == 0) /* No args, just do all the regs. */
368 if (gdbarch_register_name (current_gdbarch, regnum) == NULL
369 || *(gdbarch_register_name (current_gdbarch, regnum)) == '\0')
371 changed = register_changed_p (regnum, prev_regs, this_regs);
374 do_cleanups (cleanup);
375 mi_error_message = xstrprintf ("mi_cmd_data_list_changed_registers: Unable to read register contents.");
379 ui_out_field_int (uiout, NULL, regnum);
383 /* Else, list of register #s, just do listed regs. */
384 for (i = 0; i < argc; i++)
386 regnum = atoi (argv[i]);
390 && gdbarch_register_name (current_gdbarch, regnum) != NULL
391 && *gdbarch_register_name (current_gdbarch, regnum) != '\000')
393 changed = register_changed_p (regnum, prev_regs, this_regs);
396 do_cleanups (cleanup);
397 mi_error_message = xstrprintf ("mi_cmd_data_list_register_change: Unable to read register contents.");
401 ui_out_field_int (uiout, NULL, regnum);
405 do_cleanups (cleanup);
406 mi_error_message = xstrprintf ("bad register number");
410 do_cleanups (cleanup);
415 register_changed_p (int regnum, struct regcache *prev_regs,
416 struct regcache *this_regs)
418 struct gdbarch *gdbarch = get_regcache_arch (this_regs);
419 gdb_byte prev_buffer[MAX_REGISTER_SIZE];
420 gdb_byte this_buffer[MAX_REGISTER_SIZE];
422 /* Registers not valid in this frame return count as unchanged. */
423 if (!regcache_valid_p (this_regs, regnum))
426 /* First time through or after gdbarch change consider all registers as
427 changed. Same for registers not valid in the previous frame. */
428 if (!prev_regs || get_regcache_arch (prev_regs) != gdbarch
429 || !regcache_valid_p (prev_regs, regnum))
432 /* Get register contents and compare. */
433 regcache_cooked_read (prev_regs, regnum, prev_buffer);
434 regcache_cooked_read (this_regs, regnum, this_buffer);
436 return memcmp (prev_buffer, this_buffer,
437 register_size (gdbarch, regnum)) != 0;
440 /* Return a list of register number and value pairs. The valid
441 arguments expected are: a letter indicating the format in which to
442 display the registers contents. This can be one of: x (hexadecimal), d
443 (decimal), N (natural), t (binary), o (octal), r (raw). After the
444 format argumetn there can be a sequence of numbers, indicating which
445 registers to fetch the content of. If the format is the only argument,
446 a list of all the registers with their values is returned. */
448 mi_cmd_data_list_register_values (char *command, char **argv, int argc)
450 int regnum, numregs, format, result;
452 struct cleanup *list_cleanup, *tuple_cleanup;
454 /* Note that the test for a valid register must include checking the
455 gdbarch_register_name because gdbarch_num_regs may be allocated for
456 the union of the register sets within a family of related processors.
457 In this case, some entries of gdbarch_register_name will change depending
458 upon the particular processor being debugged. */
460 numregs = gdbarch_num_regs (current_gdbarch)
461 + gdbarch_num_pseudo_regs (current_gdbarch);
465 mi_error_message = xstrprintf ("mi_cmd_data_list_register_values: Usage: -data-list-register-values <format> [<regnum1>...<regnumN>]");
469 format = (int) argv[0][0];
471 list_cleanup = make_cleanup_ui_out_list_begin_end (uiout, "register-values");
473 if (argc == 1) /* No args, beside the format: do all the regs. */
479 if (gdbarch_register_name (current_gdbarch, regnum) == NULL
480 || *(gdbarch_register_name (current_gdbarch, regnum)) == '\0')
482 tuple_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
483 ui_out_field_int (uiout, "number", regnum);
484 result = get_register (regnum, format);
487 do_cleanups (list_cleanup);
490 do_cleanups (tuple_cleanup);
494 /* Else, list of register #s, just do listed regs. */
495 for (i = 1; i < argc; i++)
497 regnum = atoi (argv[i]);
501 && gdbarch_register_name (current_gdbarch, regnum) != NULL
502 && *gdbarch_register_name (current_gdbarch, regnum) != '\000')
504 tuple_cleanup = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
505 ui_out_field_int (uiout, "number", regnum);
506 result = get_register (regnum, format);
509 do_cleanups (list_cleanup);
512 do_cleanups (tuple_cleanup);
516 do_cleanups (list_cleanup);
517 mi_error_message = xstrprintf ("bad register number");
521 do_cleanups (list_cleanup);
525 /* Output one register's contents in the desired format. */
527 get_register (int regnum, int format)
529 gdb_byte buffer[MAX_REGISTER_SIZE];
534 static struct ui_stream *stb = NULL;
536 stb = ui_out_stream_new (uiout);
541 frame_register (get_selected_frame (NULL), regnum, &optim, &lval, &addr,
546 mi_error_message = xstrprintf ("Optimized out");
553 char *ptr, buf[1024];
557 for (j = 0; j < register_size (current_gdbarch, regnum); j++)
559 int idx = gdbarch_byte_order (current_gdbarch) == BFD_ENDIAN_BIG ? j
560 : register_size (current_gdbarch, regnum) - 1 - j;
561 sprintf (ptr, "%02x", (unsigned char) buffer[idx]);
564 ui_out_field_string (uiout, "value", buf);
565 /*fputs_filtered (buf, gdb_stdout); */
569 val_print (register_type (current_gdbarch, regnum), buffer, 0, 0,
570 stb->stream, format, 1, 0, Val_pretty_default);
571 ui_out_field_stream (uiout, "value", stb);
572 ui_out_stream_delete (stb);
577 /* Write given values into registers. The registers and values are
578 given as pairs. The corresponding MI command is
579 -data-write-register-values <format> [<regnum1> <value1>...<regnumN> <valueN>]*/
581 mi_cmd_data_write_register_values (char *command, char **argv, int argc)
586 /* Note that the test for a valid register must include checking the
587 gdbarch_register_name because gdbarch_num_regs may be allocated for
588 the union of the register sets within a family of related processors.
589 In this case, some entries of gdbarch_register_name will change depending
590 upon the particular processor being debugged. */
592 numregs = gdbarch_num_regs (current_gdbarch)
593 + gdbarch_num_pseudo_regs (current_gdbarch);
597 mi_error_message = xstrprintf ("mi_cmd_data_write_register_values: Usage: -data-write-register-values <format> [<regnum1> <value1>...<regnumN> <valueN>]");
601 format = (int) argv[0][0];
603 if (!target_has_registers)
605 mi_error_message = xstrprintf ("mi_cmd_data_write_register_values: No registers.");
611 mi_error_message = xstrprintf ("mi_cmd_data_write_register_values: No regs and values specified.");
617 mi_error_message = xstrprintf ("mi_cmd_data_write_register_values: Regs and vals are not in pairs.");
621 for (i = 1; i < argc; i = i + 2)
623 int regnum = atoi (argv[i]);
625 if (regnum >= 0 && regnum < numregs
626 && gdbarch_register_name (current_gdbarch, regnum)
627 && *gdbarch_register_name (current_gdbarch, regnum))
631 /* Get the value as a number. */
632 value = parse_and_eval_address (argv[i + 1]);
635 regcache_cooked_write_signed (get_current_regcache (), regnum, value);
639 mi_error_message = xstrprintf ("bad register number");
646 /* Evaluate the value of the argument. The argument is an
647 expression. If the expression contains spaces it needs to be
648 included in double quotes. */
650 mi_cmd_data_evaluate_expression (char *command, char **argv, int argc)
652 struct expression *expr;
653 struct cleanup *old_chain = NULL;
655 struct ui_stream *stb = NULL;
657 stb = ui_out_stream_new (uiout);
661 mi_error_message = xstrprintf ("mi_cmd_data_evaluate_expression: Usage: -data-evaluate-expression expression");
662 ui_out_stream_delete (stb);
666 expr = parse_expression (argv[0]);
668 old_chain = make_cleanup (free_current_contents, &expr);
670 val = evaluate_expression (expr);
672 /* Print the result of the expression evaluation. */
673 val_print (value_type (val), value_contents (val),
674 value_embedded_offset (val), VALUE_ADDRESS (val),
675 stb->stream, 0, 0, 0, 0);
677 ui_out_field_stream (uiout, "value", stb);
678 ui_out_stream_delete (stb);
680 do_cleanups (old_chain);
686 mi_cmd_target_download (char *args, int from_tty)
689 struct cleanup *old_cleanups = NULL;
691 run = xstrprintf ("load %s", args);
692 old_cleanups = make_cleanup (xfree, run);
693 execute_command (run, from_tty);
695 do_cleanups (old_cleanups);
699 /* Connect to the remote target. */
701 mi_cmd_target_select (char *args, int from_tty)
704 struct cleanup *old_cleanups = NULL;
706 run = xstrprintf ("target %s", args);
707 old_cleanups = make_cleanup (xfree, run);
709 /* target-select is always synchronous. Once the call has returned
710 we know that we are connected. */
711 /* NOTE: At present all targets that are connected are also
712 (implicitly) talking to a halted target. In the future this may
714 execute_command (run, from_tty);
716 do_cleanups (old_cleanups);
718 /* Issue the completion message here. */
719 if (last_async_command)
720 fputs_unfiltered (last_async_command, raw_stdout);
721 fputs_unfiltered ("^connected", raw_stdout);
722 mi_out_put (uiout, raw_stdout);
723 mi_out_rewind (uiout);
724 fputs_unfiltered ("\n", raw_stdout);
725 do_exec_cleanups (ALL_CLEANUPS);
731 ADDR: start address of data to be dumped.
732 WORD-FORMAT: a char indicating format for the ``word''. See
734 WORD-SIZE: size of each ``word''; 1,2,4, or 8 bytes.
735 NR_ROW: Number of rows.
736 NR_COL: The number of colums (words per row).
737 ASCHAR: (OPTIONAL) Append an ascii character dump to each row. Use
738 ASCHAR for unprintable characters.
740 Reads SIZE*NR_ROW*NR_COL bytes starting at ADDR from memory and
741 displayes them. Returns:
743 {addr="...",rowN={wordN="..." ,... [,ascii="..."]}, ...}
746 The number of bytes read is SIZE*ROW*COL. */
749 mi_cmd_data_read_memory (char *command, char **argv, int argc)
751 struct cleanup *cleanups = make_cleanup (null_cleanup, NULL);
757 struct type *word_type;
770 static struct mi_opt opts[] =
772 {"o", OFFSET_OPT, 1},
778 int opt = mi_getopt ("mi_cmd_data_read_memory", argc, argv, opts,
782 switch ((enum opt) opt)
785 offset = atol (optarg);
792 if (argc < 5 || argc > 6)
794 mi_error_message = xstrprintf ("mi_cmd_data_read_memory: Usage: ADDR WORD-FORMAT WORD-SIZE NR-ROWS NR-COLS [ASCHAR].");
798 /* Extract all the arguments. */
800 /* Start address of the memory dump. */
801 addr = parse_and_eval_address (argv[0]) + offset;
802 /* The format character to use when displaying a memory word. See
803 the ``x'' command. */
804 word_format = argv[1][0];
805 /* The size of the memory word. */
806 word_size = atol (argv[2]);
810 word_type = builtin_type_int8;
814 word_type = builtin_type_int16;
818 word_type = builtin_type_int32;
822 word_type = builtin_type_int64;
826 word_type = builtin_type_int8;
829 /* The number of rows. */
830 nr_rows = atol (argv[3]);
833 mi_error_message = xstrprintf ("mi_cmd_data_read_memory: invalid number of rows.");
836 /* Number of bytes per row. */
837 nr_cols = atol (argv[4]);
840 mi_error_message = xstrprintf ("mi_cmd_data_read_memory: invalid number of columns.");
843 /* The un-printable character when printing ascii. */
849 /* Create a buffer and read it in. */
850 total_bytes = word_size * nr_rows * nr_cols;
851 mbuf = xcalloc (total_bytes, 1);
852 make_cleanup (xfree, mbuf);
854 nr_bytes = target_read (¤t_target, TARGET_OBJECT_MEMORY, NULL,
855 mbuf, addr, total_bytes);
858 do_cleanups (cleanups);
859 mi_error_message = xstrdup ("Unable to read memory.");
863 /* Output the header information. */
864 ui_out_field_core_addr (uiout, "addr", addr);
865 ui_out_field_int (uiout, "nr-bytes", nr_bytes);
866 ui_out_field_int (uiout, "total-bytes", total_bytes);
867 ui_out_field_core_addr (uiout, "next-row", addr + word_size * nr_cols);
868 ui_out_field_core_addr (uiout, "prev-row", addr - word_size * nr_cols);
869 ui_out_field_core_addr (uiout, "next-page", addr + total_bytes);
870 ui_out_field_core_addr (uiout, "prev-page", addr - total_bytes);
872 /* Build the result as a two dimentional table. */
874 struct ui_stream *stream = ui_out_stream_new (uiout);
875 struct cleanup *cleanup_list_memory;
878 cleanup_list_memory = make_cleanup_ui_out_list_begin_end (uiout, "memory");
879 for (row = 0, row_byte = 0;
881 row++, row_byte += nr_cols * word_size)
885 struct cleanup *cleanup_tuple;
886 struct cleanup *cleanup_list_data;
887 cleanup_tuple = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
888 ui_out_field_core_addr (uiout, "addr", addr + row_byte);
889 /* ui_out_field_core_addr_symbolic (uiout, "saddr", addr + row_byte); */
890 cleanup_list_data = make_cleanup_ui_out_list_begin_end (uiout, "data");
891 for (col = 0, col_byte = row_byte;
893 col++, col_byte += word_size)
895 if (col_byte + word_size > nr_bytes)
897 ui_out_field_string (uiout, NULL, "N/A");
901 ui_file_rewind (stream->stream);
902 print_scalar_formatted (mbuf + col_byte, word_type, word_format,
903 word_asize, stream->stream);
904 ui_out_field_stream (uiout, NULL, stream);
907 do_cleanups (cleanup_list_data);
911 ui_file_rewind (stream->stream);
912 for (byte = row_byte; byte < row_byte + word_size * nr_cols; byte++)
914 if (byte >= nr_bytes)
916 fputc_unfiltered ('X', stream->stream);
918 else if (mbuf[byte] < 32 || mbuf[byte] > 126)
920 fputc_unfiltered (aschar, stream->stream);
923 fputc_unfiltered (mbuf[byte], stream->stream);
925 ui_out_field_stream (uiout, "ascii", stream);
927 do_cleanups (cleanup_tuple);
929 ui_out_stream_delete (stream);
930 do_cleanups (cleanup_list_memory);
932 do_cleanups (cleanups);
936 /* DATA-MEMORY-WRITE:
938 COLUMN_OFFSET: optional argument. Must be preceeded by '-o'. The
939 offset from the beginning of the memory grid row where the cell to
941 ADDR: start address of the row in the memory grid where the memory
942 cell is, if OFFSET_COLUMN is specified. Otherwise, the address of
943 the location to write to.
944 FORMAT: a char indicating format for the ``word''. See
946 WORD_SIZE: size of each ``word''; 1,2,4, or 8 bytes
947 VALUE: value to be written into the memory address.
949 Writes VALUE into ADDR + (COLUMN_OFFSET * WORD_SIZE).
953 mi_cmd_data_write_memory (char *command, char **argv, int argc)
958 /* FIXME: ezannoni 2000-02-17 LONGEST could possibly not be big
959 enough when using a compiler other than GCC. */
962 struct cleanup *old_chain;
970 static struct mi_opt opts[] =
972 {"o", OFFSET_OPT, 1},
978 int opt = mi_getopt ("mi_cmd_data_write_memory", argc, argv, opts,
982 switch ((enum opt) opt)
985 offset = atol (optarg);
994 mi_error_message = xstrprintf ("mi_cmd_data_write_memory: Usage: [-o COLUMN_OFFSET] ADDR FORMAT WORD-SIZE VALUE.");
998 /* Extract all the arguments. */
999 /* Start address of the memory dump. */
1000 addr = parse_and_eval_address (argv[0]);
1001 /* The format character to use when displaying a memory word. See
1002 the ``x'' command. */
1003 word_format = argv[1][0];
1004 /* The size of the memory word. */
1005 word_size = atol (argv[2]);
1007 /* Calculate the real address of the write destination. */
1008 addr += (offset * word_size);
1010 /* Get the value as a number. */
1011 value = parse_and_eval_address (argv[3]);
1012 /* Get the value into an array. */
1013 buffer = xmalloc (word_size);
1014 old_chain = make_cleanup (xfree, buffer);
1015 store_signed_integer (buffer, word_size, value);
1016 /* Write it down to memory. */
1017 write_memory (addr, buffer, word_size);
1018 /* Free the buffer. */
1019 do_cleanups (old_chain);
1025 mi_cmd_enable_timings (char *command, char **argv, int argc)
1031 if (strcmp (argv[0], "yes") == 0)
1033 else if (strcmp (argv[0], "no") == 0)
1044 error ("mi_cmd_enable_timings: Usage: %s {yes|no}", command);
1045 return MI_CMD_ERROR;
1049 mi_cmd_list_features (char *command, char **argv, int argc)
1053 struct cleanup *cleanup = NULL;
1054 cleanup = make_cleanup_ui_out_list_begin_end (uiout, "features");
1056 ui_out_field_string (uiout, NULL, "frozen-varobjs");
1057 ui_out_field_string (uiout, NULL, "pending-breakpoints");
1059 do_cleanups (cleanup);
1064 error ("-list-features should be passed no arguments");
1065 return MI_CMD_ERROR;
1068 /* Execute a command within a safe environment.
1069 Return <0 for error; >=0 for ok.
1071 args->action will tell mi_execute_command what action
1072 to perfrom after the given command has executed (display/supress
1073 prompt, display error). */
1076 captured_mi_execute_command (struct ui_out *uiout, void *data)
1078 struct captured_mi_execute_command_args *args =
1079 (struct captured_mi_execute_command_args *) data;
1080 struct mi_parse *context = args->command;
1082 struct mi_timestamp cmd_finished;
1084 switch (context->op)
1088 /* A MI command was read from the input stream. */
1090 /* FIXME: gdb_???? */
1091 fprintf_unfiltered (raw_stdout, " token=`%s' command=`%s' args=`%s'\n",
1092 context->token, context->command, context->args);
1093 /* FIXME: cagney/1999-09-25: Rather than this convoluted
1094 condition expression, each function should return an
1095 indication of what action is required and then switch on
1097 args->action = EXECUTE_COMMAND_DISPLAY_PROMPT;
1100 current_command_ts = context->cmd_start;
1102 args->rc = mi_cmd_execute (context);
1105 timestamp (&cmd_finished);
1107 if (!target_can_async_p () || !target_executing)
1109 /* Print the result if there were no errors.
1111 Remember that on the way out of executing a command, you have
1112 to directly use the mi_interp's uiout, since the command could
1113 have reset the interpreter, in which case the current uiout
1114 will most likely crash in the mi_out_* routines. */
1115 if (args->rc == MI_CMD_DONE)
1117 fputs_unfiltered (context->token, raw_stdout);
1118 fputs_unfiltered ("^done", raw_stdout);
1119 mi_out_put (uiout, raw_stdout);
1120 mi_out_rewind (uiout);
1121 /* Have to check cmd_start, since the command could be
1123 if (do_timings && context->cmd_start)
1124 print_diff (context->cmd_start, &cmd_finished);
1125 fputs_unfiltered ("\n", raw_stdout);
1127 else if (args->rc == MI_CMD_ERROR)
1129 if (mi_error_message)
1131 fputs_unfiltered (context->token, raw_stdout);
1132 fputs_unfiltered ("^error,msg=\"", raw_stdout);
1133 fputstr_unfiltered (mi_error_message, '"', raw_stdout);
1134 xfree (mi_error_message);
1135 mi_error_message = NULL;
1136 fputs_unfiltered ("\"\n", raw_stdout);
1138 mi_out_rewind (uiout);
1141 mi_out_rewind (uiout);
1143 else if (sync_execution)
1145 /* Don't print the prompt. We are executing the target in
1146 synchronous mode. */
1147 args->action = EXECUTE_COMMAND_SUPRESS_PROMPT;
1155 /* A CLI command was read from the input stream. */
1156 /* This "feature" will be removed as soon as we have a
1157 complete set of mi commands. */
1158 /* Echo the command on the console. */
1159 fprintf_unfiltered (gdb_stdlog, "%s\n", context->command);
1160 /* Call the "console" interpreter. */
1161 argv[0] = "console";
1162 argv[1] = context->command;
1163 args->rc = mi_cmd_interpreter_exec ("-interpreter-exec", argv, 2);
1165 /* If we changed interpreters, DON'T print out anything. */
1166 if (current_interp_named_p (INTERP_MI)
1167 || current_interp_named_p (INTERP_MI1)
1168 || current_interp_named_p (INTERP_MI2)
1169 || current_interp_named_p (INTERP_MI3))
1171 if (args->rc == MI_CMD_DONE)
1173 fputs_unfiltered (context->token, raw_stdout);
1174 fputs_unfiltered ("^done", raw_stdout);
1175 mi_out_put (uiout, raw_stdout);
1176 mi_out_rewind (uiout);
1177 fputs_unfiltered ("\n", raw_stdout);
1178 args->action = EXECUTE_COMMAND_DISPLAY_PROMPT;
1180 else if (args->rc == MI_CMD_ERROR)
1182 if (mi_error_message)
1184 fputs_unfiltered (context->token, raw_stdout);
1185 fputs_unfiltered ("^error,msg=\"", raw_stdout);
1186 fputstr_unfiltered (mi_error_message, '"', raw_stdout);
1187 xfree (mi_error_message);
1188 mi_error_message = NULL;
1189 fputs_unfiltered ("\"\n", raw_stdout);
1191 mi_out_rewind (uiout);
1194 mi_out_rewind (uiout);
1206 mi_execute_command (char *cmd, int from_tty)
1208 struct mi_parse *command;
1209 struct captured_mi_execute_command_args args;
1210 struct ui_out *saved_uiout = uiout;
1212 /* This is to handle EOF (^D). We just quit gdb. */
1213 /* FIXME: we should call some API function here. */
1215 quit_force (NULL, from_tty);
1217 command = mi_parse (cmd);
1219 if (command != NULL)
1221 struct gdb_exception result;
1225 command->cmd_start = (struct mi_timestamp *)
1226 xmalloc (sizeof (struct mi_timestamp));
1227 timestamp (command->cmd_start);
1230 /* FIXME: cagney/1999-11-04: Can this use of catch_exceptions either
1231 be pushed even further down or even eliminated? */
1232 args.command = command;
1233 result = catch_exception (uiout, captured_mi_execute_command, &args,
1235 exception_print (gdb_stderr, result);
1237 if (args.action == EXECUTE_COMMAND_SUPRESS_PROMPT)
1239 /* The command is executing synchronously. Bail out early
1240 suppressing the finished prompt. */
1241 mi_parse_free (command);
1244 if (result.reason < 0)
1246 /* The command execution failed and error() was called
1248 fputs_unfiltered (command->token, raw_stdout);
1249 fputs_unfiltered ("^error,msg=\"", raw_stdout);
1250 if (result.message == NULL)
1251 fputs_unfiltered ("unknown error", raw_stdout);
1253 fputstr_unfiltered (result.message, '"', raw_stdout);
1254 fputs_unfiltered ("\"\n", raw_stdout);
1255 mi_out_rewind (uiout);
1257 mi_parse_free (command);
1260 fputs_unfiltered ("(gdb) \n", raw_stdout);
1261 gdb_flush (raw_stdout);
1262 /* Print any buffered hook code. */
1266 static enum mi_cmd_result
1267 mi_cmd_execute (struct mi_parse *parse)
1271 if (parse->cmd->argv_func != NULL
1272 || parse->cmd->args_func != NULL)
1274 /* FIXME: We need to save the token because the command executed
1275 may be asynchronous and need to print the token again.
1276 In the future we can pass the token down to the func
1277 and get rid of the last_async_command. */
1278 /* The problem here is to keep the token around when we launch
1279 the target, and we want to interrupt it later on. The
1280 interrupt command will have its own token, but when the
1281 target stops, we must display the token corresponding to the
1282 last execution command given. So we have another string where
1283 we copy the token (previous_async_command), if this was
1284 indeed the token of an execution command, and when we stop we
1285 print that one. This is possible because the interrupt
1286 command, when over, will copy that token back into the
1287 default token string (last_async_command). */
1289 if (target_executing)
1291 if (!previous_async_command)
1292 previous_async_command = xstrdup (last_async_command);
1293 if (strcmp (parse->command, "exec-interrupt"))
1295 fputs_unfiltered (parse->token, raw_stdout);
1296 fputs_unfiltered ("^error,msg=\"", raw_stdout);
1297 fputs_unfiltered ("Cannot execute command ", raw_stdout);
1298 fputstr_unfiltered (parse->command, '"', raw_stdout);
1299 fputs_unfiltered (" while target running", raw_stdout);
1300 fputs_unfiltered ("\"\n", raw_stdout);
1301 return MI_CMD_ERROR;
1304 last_async_command = xstrdup (parse->token);
1305 make_exec_cleanup (free_current_contents, &last_async_command);
1306 /* FIXME: DELETE THIS! */
1307 if (parse->cmd->args_func != NULL)
1308 return parse->cmd->args_func (parse->args, 0 /*from_tty */ );
1309 return parse->cmd->argv_func (parse->command, parse->argv, parse->argc);
1311 else if (parse->cmd->cli.cmd != 0)
1313 /* FIXME: DELETE THIS. */
1314 /* The operation is still implemented by a cli command. */
1315 /* Must be a synchronous one. */
1316 mi_execute_cli_command (parse->cmd->cli.cmd, parse->cmd->cli.args_p,
1322 /* FIXME: DELETE THIS. */
1323 fputs_unfiltered (parse->token, raw_stdout);
1324 fputs_unfiltered ("^error,msg=\"", raw_stdout);
1325 fputs_unfiltered ("Undefined mi command: ", raw_stdout);
1326 fputstr_unfiltered (parse->command, '"', raw_stdout);
1327 fputs_unfiltered (" (missing implementation)", raw_stdout);
1328 fputs_unfiltered ("\"\n", raw_stdout);
1329 return MI_CMD_ERROR;
1333 /* FIXME: This is just a hack so we can get some extra commands going.
1334 We don't want to channel things through the CLI, but call libgdb directly.
1335 Use only for synchronous commands. */
1338 mi_execute_cli_command (const char *cmd, int args_p, const char *args)
1342 struct cleanup *old_cleanups;
1345 run = xstrprintf ("%s %s", cmd, args);
1347 run = xstrdup (cmd);
1349 /* FIXME: gdb_???? */
1350 fprintf_unfiltered (gdb_stdout, "cli=%s run=%s\n",
1352 old_cleanups = make_cleanup (xfree, run);
1353 execute_command ( /*ui */ run, 0 /*from_tty */ );
1354 do_cleanups (old_cleanups);
1360 mi_execute_async_cli_command (char *mi, char *args, int from_tty)
1362 struct cleanup *old_cleanups;
1366 if (target_can_async_p ())
1368 async_args = (char *) xmalloc (strlen (args) + 2);
1369 make_exec_cleanup (free, async_args);
1370 strcpy (async_args, args);
1371 strcat (async_args, "&");
1372 run = xstrprintf ("%s %s", mi, async_args);
1373 make_exec_cleanup (free, run);
1374 add_continuation (mi_exec_async_cli_cmd_continuation, NULL);
1375 old_cleanups = NULL;
1379 run = xstrprintf ("%s %s", mi, args);
1380 old_cleanups = make_cleanup (xfree, run);
1383 if (!target_can_async_p ())
1385 /* NOTE: For synchronous targets asynchronous behavour is faked by
1386 printing out the GDB prompt before we even try to execute the
1388 if (last_async_command)
1389 fputs_unfiltered (last_async_command, raw_stdout);
1390 fputs_unfiltered ("^running\n", raw_stdout);
1391 fputs_unfiltered ("(gdb) \n", raw_stdout);
1392 gdb_flush (raw_stdout);
1396 /* FIXME: cagney/1999-11-29: Printing this message before
1397 calling execute_command is wrong. It should only be printed
1398 once gdb has confirmed that it really has managed to send a
1399 run command to the target. */
1400 if (last_async_command)
1401 fputs_unfiltered (last_async_command, raw_stdout);
1402 fputs_unfiltered ("^running\n", raw_stdout);
1405 execute_command ( /*ui */ run, 0 /*from_tty */ );
1407 if (!target_can_async_p ())
1409 /* Do this before doing any printing. It would appear that some
1410 print code leaves garbage around in the buffer. */
1411 do_cleanups (old_cleanups);
1412 /* If the target was doing the operation synchronously we fake
1413 the stopped message. */
1414 if (last_async_command)
1415 fputs_unfiltered (last_async_command, raw_stdout);
1416 fputs_unfiltered ("*stopped", raw_stdout);
1417 mi_out_put (uiout, raw_stdout);
1418 mi_out_rewind (uiout);
1420 print_diff_now (current_command_ts);
1421 fputs_unfiltered ("\n", raw_stdout);
1422 return MI_CMD_QUIET;
1428 mi_exec_async_cli_cmd_continuation (struct continuation_arg *arg)
1430 if (last_async_command)
1431 fputs_unfiltered (last_async_command, raw_stdout);
1432 fputs_unfiltered ("*stopped", raw_stdout);
1433 mi_out_put (uiout, raw_stdout);
1434 fputs_unfiltered ("\n", raw_stdout);
1435 fputs_unfiltered ("(gdb) \n", raw_stdout);
1436 gdb_flush (raw_stdout);
1437 do_exec_cleanups (ALL_CLEANUPS);
1441 mi_load_progress (const char *section_name,
1442 unsigned long sent_so_far,
1443 unsigned long total_section,
1444 unsigned long total_sent,
1445 unsigned long grand_total)
1447 struct timeval time_now, delta, update_threshold;
1448 static struct timeval last_update;
1449 static char *previous_sect_name = NULL;
1451 struct ui_out *saved_uiout;
1453 /* This function is called through deprecated_show_load_progress
1454 which means uiout may not be correct. Fix it for the duration
1455 of this function. */
1456 saved_uiout = uiout;
1458 if (current_interp_named_p (INTERP_MI)
1459 || current_interp_named_p (INTERP_MI2))
1460 uiout = mi_out_new (2);
1461 else if (current_interp_named_p (INTERP_MI1))
1462 uiout = mi_out_new (1);
1463 else if (current_interp_named_p (INTERP_MI3))
1464 uiout = mi_out_new (3);
1468 update_threshold.tv_sec = 0;
1469 update_threshold.tv_usec = 500000;
1470 gettimeofday (&time_now, NULL);
1472 delta.tv_usec = time_now.tv_usec - last_update.tv_usec;
1473 delta.tv_sec = time_now.tv_sec - last_update.tv_sec;
1475 if (delta.tv_usec < 0)
1478 delta.tv_usec += 1000000L;
1481 new_section = (previous_sect_name ?
1482 strcmp (previous_sect_name, section_name) : 1);
1485 struct cleanup *cleanup_tuple;
1486 xfree (previous_sect_name);
1487 previous_sect_name = xstrdup (section_name);
1489 if (last_async_command)
1490 fputs_unfiltered (last_async_command, raw_stdout);
1491 fputs_unfiltered ("+download", raw_stdout);
1492 cleanup_tuple = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
1493 ui_out_field_string (uiout, "section", section_name);
1494 ui_out_field_int (uiout, "section-size", total_section);
1495 ui_out_field_int (uiout, "total-size", grand_total);
1496 do_cleanups (cleanup_tuple);
1497 mi_out_put (uiout, raw_stdout);
1498 fputs_unfiltered ("\n", raw_stdout);
1499 gdb_flush (raw_stdout);
1502 if (delta.tv_sec >= update_threshold.tv_sec &&
1503 delta.tv_usec >= update_threshold.tv_usec)
1505 struct cleanup *cleanup_tuple;
1506 last_update.tv_sec = time_now.tv_sec;
1507 last_update.tv_usec = time_now.tv_usec;
1508 if (last_async_command)
1509 fputs_unfiltered (last_async_command, raw_stdout);
1510 fputs_unfiltered ("+download", raw_stdout);
1511 cleanup_tuple = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
1512 ui_out_field_string (uiout, "section", section_name);
1513 ui_out_field_int (uiout, "section-sent", sent_so_far);
1514 ui_out_field_int (uiout, "section-size", total_section);
1515 ui_out_field_int (uiout, "total-sent", total_sent);
1516 ui_out_field_int (uiout, "total-size", grand_total);
1517 do_cleanups (cleanup_tuple);
1518 mi_out_put (uiout, raw_stdout);
1519 fputs_unfiltered ("\n", raw_stdout);
1520 gdb_flush (raw_stdout);
1524 uiout = saved_uiout;
1528 timestamp (struct mi_timestamp *tv)
1531 gettimeofday (&tv->wallclock, NULL);
1532 #ifdef HAVE_GETRUSAGE
1533 getrusage (RUSAGE_SELF, &rusage);
1534 tv->utime.tv_sec = rusage.ru_utime.tv_sec;
1535 tv->utime.tv_usec = rusage.ru_utime.tv_usec;
1536 tv->stime.tv_sec = rusage.ru_stime.tv_sec;
1537 tv->stime.tv_usec = rusage.ru_stime.tv_usec;
1539 usec = get_run_time ();
1540 tv->utime.tv_sec = usec/1000000L;
1541 tv->utime.tv_usec = usec - 1000000L*tv->utime.tv_sec;
1542 tv->stime.tv_sec = 0;
1543 tv->stime.tv_usec = 0;
1548 print_diff_now (struct mi_timestamp *start)
1550 struct mi_timestamp now;
1552 print_diff (start, &now);
1556 timeval_diff (struct timeval start, struct timeval end)
1558 return ((end.tv_sec - start.tv_sec) * 1000000L)
1559 + (end.tv_usec - start.tv_usec);
1563 print_diff (struct mi_timestamp *start, struct mi_timestamp *end)
1567 ",time={wallclock=\"%0.5f\",user=\"%0.5f\",system=\"%0.5f\"}",
1568 timeval_diff (start->wallclock, end->wallclock) / 1000000.0,
1569 timeval_diff (start->utime, end->utime) / 1000000.0,
1570 timeval_diff (start->stime, end->stime) / 1000000.0);