3 Copyright (C) 2000-2014 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 "exceptions.h"
22 #include "arch-utils.h"
23 #include "dyn-string.h"
24 #include "readline/readline.h"
25 #include "readline/tilde.h"
26 #include "completer.h"
27 #include "target.h" /* For baud_rate, remote_debug and remote_timeout. */
28 #include "gdb_wait.h" /* For shell escape implementation. */
29 #include "gdb_regex.h" /* Used by apropos_command. */
31 #include "gdb_vfork.h"
33 #include "expression.h"
37 #include "filenames.h" /* For DOSish file names. */
41 #include "tracepoint.h"
42 #include "filestuff.h"
47 #include "cli/cli-decode.h"
48 #include "cli/cli-script.h"
49 #include "cli/cli-setshow.h"
50 #include "cli/cli-cmds.h"
51 #include "cli/cli-utils.h"
53 #include "python/python.h"
56 #include "tui/tui.h" /* For tui_active et.al. */
61 /* Prototypes for local command functions */
63 static void complete_command (char *, int);
65 static void echo_command (char *, int);
67 static void pwd_command (char *, int);
69 static void show_version (char *, int);
71 static void help_command (char *, int);
73 static void show_command (char *, int);
75 static void info_command (char *, int);
77 static void show_debug (char *, int);
79 static void set_debug (char *, int);
81 static void show_user (char *, int);
83 static void make_command (char *, int);
85 static void shell_escape (char *, int);
87 static void edit_command (char *, int);
89 static void list_command (char *, int);
91 /* Prototypes for local utility functions */
93 static void ambiguous_line_spec (struct symtabs_and_lines *);
95 static void filter_sals (struct symtabs_and_lines *);
98 /* Limit the call depth of user-defined commands */
99 unsigned int max_user_call_depth;
101 /* Define all cmd_list_elements. */
103 /* Chain containing all defined commands. */
105 struct cmd_list_element *cmdlist;
107 /* Chain containing all defined info subcommands. */
109 struct cmd_list_element *infolist;
111 /* Chain containing all defined enable subcommands. */
113 struct cmd_list_element *enablelist;
115 /* Chain containing all defined disable subcommands. */
117 struct cmd_list_element *disablelist;
119 /* Chain containing all defined stop subcommands. */
121 struct cmd_list_element *stoplist;
123 /* Chain containing all defined delete subcommands. */
125 struct cmd_list_element *deletelist;
127 /* Chain containing all defined detach subcommands. */
129 struct cmd_list_element *detachlist;
131 /* Chain containing all defined kill subcommands. */
133 struct cmd_list_element *killlist;
135 /* Chain containing all defined set subcommands */
137 struct cmd_list_element *setlist;
139 /* Chain containing all defined unset subcommands */
141 struct cmd_list_element *unsetlist;
143 /* Chain containing all defined show subcommands. */
145 struct cmd_list_element *showlist;
147 /* Chain containing all defined \"set history\". */
149 struct cmd_list_element *sethistlist;
151 /* Chain containing all defined \"show history\". */
153 struct cmd_list_element *showhistlist;
155 /* Chain containing all defined \"unset history\". */
157 struct cmd_list_element *unsethistlist;
159 /* Chain containing all defined maintenance subcommands. */
161 struct cmd_list_element *maintenancelist;
163 /* Chain containing all defined "maintenance info" subcommands. */
165 struct cmd_list_element *maintenanceinfolist;
167 /* Chain containing all defined "maintenance print" subcommands. */
169 struct cmd_list_element *maintenanceprintlist;
171 struct cmd_list_element *setprintlist;
173 struct cmd_list_element *showprintlist;
175 struct cmd_list_element *setdebuglist;
177 struct cmd_list_element *showdebuglist;
179 struct cmd_list_element *setchecklist;
181 struct cmd_list_element *showchecklist;
183 /* Command tracing state. */
185 int source_verbose = 0;
186 int trace_commands = 0;
188 /* 'script-extension' option support. */
190 static const char script_ext_off[] = "off";
191 static const char script_ext_soft[] = "soft";
192 static const char script_ext_strict[] = "strict";
194 static const char *const script_ext_enums[] = {
201 static const char *script_ext_mode = script_ext_soft;
203 /* Utility used everywhere when at least one argument is needed and
207 error_no_arg (char *why)
209 error (_("Argument required (%s)."), why);
212 /* The "info" command is defined as a prefix, with allow_unknown = 0.
213 Therefore, its own definition is called only for "info" with no
217 info_command (char *arg, int from_tty)
219 printf_unfiltered (_("\"info\" must be followed by "
220 "the name of an info command.\n"));
221 help_list (infolist, "info ", -1, gdb_stdout);
224 /* The "show" command with no arguments shows all the settings. */
227 show_command (char *arg, int from_tty)
229 cmd_show_list (showlist, from_tty, "");
232 /* Provide documentation on command or list given by COMMAND. FROM_TTY
236 help_command (char *command, int from_tty)
238 help_cmd (command, gdb_stdout);
241 /* The "complete" command is used by Emacs to implement completion. */
244 complete_command (char *arg, int from_tty)
247 char *point, *arg_prefix;
248 VEC (char_ptr) *completions;
254 argpoint = strlen (arg);
256 /* complete_line assumes that its first argument is somewhere
257 within, and except for filenames at the beginning of, the word to
258 be completed. The following crude imitation of readline's
259 word-breaking tries to accomodate this. */
260 point = arg + argpoint;
263 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
268 arg_prefix = alloca (point - arg + 1);
269 memcpy (arg_prefix, arg, point - arg);
270 arg_prefix[point - arg] = 0;
272 completions = complete_line (point, arg, argpoint);
276 int ix, size = VEC_length (char_ptr, completions);
277 char *item, *prev = NULL;
279 qsort (VEC_address (char_ptr, completions), size,
280 sizeof (char *), compare_strings);
282 /* We do extra processing here since we only want to print each
284 for (ix = 0; VEC_iterate (char_ptr, completions, ix, item); ++ix)
286 if (prev == NULL || strcmp (item, prev) != 0)
288 printf_unfiltered ("%s%s\n", arg_prefix, item);
297 VEC_free (char_ptr, completions);
302 is_complete_command (struct cmd_list_element *c)
304 return cmd_cfunc_eq (c, complete_command);
308 show_version (char *args, int from_tty)
310 print_gdb_version (gdb_stdout);
311 printf_filtered ("\n");
315 show_configuration (char *args, int from_tty)
317 print_gdb_configuration (gdb_stdout);
320 /* Handle the quit command. */
323 quit_command (char *args, int from_tty)
325 if (!quit_confirm ())
326 error (_("Not confirmed."));
328 query_if_trace_running (from_tty);
330 quit_force (args, from_tty);
334 pwd_command (char *args, int from_tty)
337 error (_("The \"pwd\" command does not take an argument: %s"), args);
338 if (! getcwd (gdb_dirbuf, sizeof (gdb_dirbuf)))
339 error (_("Error finding name of working directory: %s"),
340 safe_strerror (errno));
342 if (strcmp (gdb_dirbuf, current_directory) != 0)
343 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
344 current_directory, gdb_dirbuf);
346 printf_unfiltered (_("Working directory %s.\n"), current_directory);
350 cd_command (char *dir, int from_tty)
353 /* Found something other than leading repetitions of "/..". */
356 struct cleanup *cleanup;
358 /* If the new directory is absolute, repeat is a no-op; if relative,
359 repeat might be useful but is more likely to be a mistake. */
365 dir = tilde_expand (dir);
366 cleanup = make_cleanup (xfree, dir);
369 perror_with_name (dir);
371 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
372 /* There's too much mess with DOSish names like "d:", "d:.",
373 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
374 simply get the canonicalized name of the current directory. */
375 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
379 if (IS_DIR_SEPARATOR (dir[len - 1]))
381 /* Remove the trailing slash unless this is a root directory
382 (including a drive letter on non-Unix systems). */
383 if (!(len == 1) /* "/" */
384 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
385 && !(len == 3 && dir[1] == ':') /* "d:/" */
391 dir = savestring (dir, len);
392 if (IS_ABSOLUTE_PATH (dir))
393 current_directory = dir;
396 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
397 current_directory = concat (current_directory, dir, (char *)NULL);
399 current_directory = concat (current_directory, SLASH_STRING,
404 /* Now simplify any occurrences of `.' and `..' in the pathname. */
407 for (p = current_directory; *p;)
409 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
410 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
411 memmove (p, p + 2, strlen (p + 2) + 1);
412 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
413 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
417 /* Search backwards for the directory just before the "/.."
418 and obliterate it and the "/..". */
421 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
424 if (q == current_directory)
425 /* current_directory is
426 a relative pathname ("can't happen"--leave it alone). */
430 memmove (q - 1, p + 3, strlen (p + 3) + 1);
435 /* We are dealing with leading repetitions of "/..", for
436 example "/../..", which is the Mach super-root. */
446 forget_cached_source_info ();
449 pwd_command ((char *) 0, 1);
451 do_cleanups (cleanup);
454 /* Show the current value of the 'script-extension' option. */
457 show_script_ext_mode (struct ui_file *file, int from_tty,
458 struct cmd_list_element *c, const char *value)
460 fprintf_filtered (file,
461 _("Script filename extension recognition is \"%s\".\n"),
465 /* Try to open SCRIPT_FILE.
466 If successful, the full path name is stored in *FULL_PATHP,
467 the stream is stored in *STREAMP, and return 1.
468 The caller is responsible for freeing *FULL_PATHP.
469 If not successful, return 0; errno is set for the last file
472 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
473 search for it in the source search path. */
476 find_and_open_script (const char *script_file, int search_path,
477 FILE **streamp, char **full_pathp)
481 struct cleanup *old_cleanups;
482 int search_flags = OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH;
484 file = tilde_expand (script_file);
485 old_cleanups = make_cleanup (xfree, file);
488 search_flags |= OPF_SEARCH_IN_PATH;
490 /* Search for and open 'file' on the search path used for source
491 files. Put the full location in *FULL_PATHP. */
492 fd = openp (source_path, search_flags,
493 file, O_RDONLY, full_pathp);
497 int save_errno = errno;
498 do_cleanups (old_cleanups);
503 do_cleanups (old_cleanups);
505 *streamp = fdopen (fd, FOPEN_RT);
506 if (*streamp == NULL)
508 int save_errno = errno;
520 /* Load script FILE, which has already been opened as STREAM. */
523 source_script_from_stream (FILE *stream, const char *file)
525 if (script_ext_mode != script_ext_off
526 && strlen (file) > 3 && !strcmp (&file[strlen (file) - 3], ".py"))
529 source_python_script (stream, file);
530 else if (script_ext_mode == script_ext_soft)
532 /* Fallback to GDB script mode. */
533 script_from_file (stream, file);
536 error (_("Python scripting is not supported in this copy of GDB."));
539 script_from_file (stream, file);
542 /* Worker to perform the "source" command.
544 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
545 search for it in the source search path. */
548 source_script_with_search (const char *file, int from_tty, int search_path)
552 struct cleanup *old_cleanups;
554 if (file == NULL || *file == 0)
555 error (_("source command requires file name of file to source."));
557 if (!find_and_open_script (file, search_path, &stream, &full_path))
559 /* The script wasn't found, or was otherwise inaccessible.
560 If the source command was invoked interactively, throw an
561 error. Otherwise (e.g. if it was invoked by a script),
562 just emit a warning, rather than cause an error. */
564 perror_with_name (file);
567 perror_warning_with_name (file);
572 old_cleanups = make_cleanup (xfree, full_path);
573 make_cleanup_fclose (stream);
574 /* The python support reopens the file, so we need to pass full_path here
575 in case the file was found on the search path. It's useful to do this
576 anyway so that error messages show the actual file used. But only do
577 this if we (may have) used search_path, as printing the full path in
578 errors for the non-search case can be more noise than signal. */
579 source_script_from_stream (stream, search_path ? full_path : file);
580 do_cleanups (old_cleanups);
583 /* Wrapper around source_script_with_search to export it to main.c
584 for use in loading .gdbinit scripts. */
587 source_script (const char *file, int from_tty)
589 source_script_with_search (file, from_tty, 0);
592 /* Return the source_verbose global variable to its previous state
593 on exit from the source command, by whatever means. */
595 source_verbose_cleanup (void *old_value)
597 source_verbose = *(int *)old_value;
602 source_command (char *args, int from_tty)
604 struct cleanup *old_cleanups;
606 int *old_source_verbose = xmalloc (sizeof(int));
609 *old_source_verbose = source_verbose;
610 old_cleanups = make_cleanup (source_verbose_cleanup,
613 /* -v causes the source command to run in verbose mode.
614 -s causes the file to be searched in the source search path,
615 even if the file name contains a '/'.
616 We still have to be able to handle filenames with spaces in a
617 backward compatible way, so buildargv is not appropriate. */
621 while (args[0] != '\0')
623 /* Make sure leading white space does not break the
625 args = skip_spaces (args);
630 if (args[1] == 'v' && isspace (args[2]))
634 /* Skip passed -v. */
637 else if (args[1] == 's' && isspace (args[2]))
641 /* Skip passed -s. */
648 file = skip_spaces (args);
651 source_script_with_search (file, from_tty, search_path);
653 do_cleanups (old_cleanups);
658 echo_command (char *text, int from_tty)
660 const char *p = text;
664 while ((c = *p++) != '\0')
668 /* \ at end of argument is used after spaces
669 so they won't be lost. */
673 c = parse_escape (get_current_arch (), &p);
675 printf_filtered ("%c", c);
678 printf_filtered ("%c", c);
681 /* Force this output to appear now. */
683 gdb_flush (gdb_stdout);
687 shell_escape (char *arg, int from_tty)
689 #if defined(CANT_FORK) || \
690 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
691 /* If ARG is NULL, they want an inferior shell, but `system' just
692 reports if the shell is available when passed a NULL arg. */
693 int rc = system (arg ? arg : "");
696 arg = "inferior shell";
700 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
701 safe_strerror (errno));
702 gdb_flush (gdb_stderr);
706 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
707 gdb_flush (gdb_stderr);
710 /* Make sure to return to the directory GDB thinks it is, in case
711 the shell command we just ran changed it. */
712 chdir (current_directory);
714 #else /* Can fork. */
717 if ((pid = vfork ()) == 0)
719 const char *p, *user_shell;
723 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
724 user_shell = "/bin/sh";
726 /* Get the name of the shell for arg0. */
727 p = lbasename (user_shell);
730 execl (user_shell, p, (char *) 0);
732 execl (user_shell, p, "-c", arg, (char *) 0);
734 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
735 safe_strerror (errno));
736 gdb_flush (gdb_stderr);
741 waitpid (pid, &status, 0);
743 error (_("Fork failed"));
744 #endif /* Can fork. */
748 edit_command (char *arg, int from_tty)
750 struct symtabs_and_lines sals;
751 struct symtab_and_line sal;
758 /* Pull in the current default source line if necessary. */
761 set_default_source_symtab_and_line ();
762 sal = get_current_source_symtab_and_line ();
765 /* Bare "edit" edits file with present line. */
770 error (_("No default source file yet."));
771 sal.line += get_lines_to_list () / 2;
775 /* Now should only be one argument -- decode it in SAL. */
778 sals = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE, 0, 0);
788 ambiguous_line_spec (&sals);
797 error (_("Junk at end of line specification."));
799 /* If line was specified by address, first print exactly which
800 line, and which file. In this case, sal.symtab == 0 means
801 address is outside of all known source files, not that user
802 failed to give a filename. */
805 struct gdbarch *gdbarch;
808 error (_("No source file for address %s."),
809 paddress (get_current_arch (), sal.pc));
811 gdbarch = get_objfile_arch (sal.symtab->objfile);
812 sym = find_pc_function (sal.pc);
814 printf_filtered ("%s is in %s (%s:%d).\n",
815 paddress (gdbarch, sal.pc),
816 SYMBOL_PRINT_NAME (sym),
817 symtab_to_filename_for_display (sal.symtab),
820 printf_filtered ("%s is at %s:%d.\n",
821 paddress (gdbarch, sal.pc),
822 symtab_to_filename_for_display (sal.symtab),
826 /* If what was given does not imply a symtab, it must be an
827 undebuggable symbol which means no source code. */
830 error (_("No line number known for %s."), arg);
833 if ((editor = (char *) getenv ("EDITOR")) == NULL)
836 fn = symtab_to_fullname (sal.symtab);
838 /* Quote the file name, in case it has whitespace or other special
840 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
841 shell_escape (p, from_tty);
846 list_command (char *arg, int from_tty)
848 struct symtabs_and_lines sals, sals_end;
849 struct symtab_and_line sal = { 0 };
850 struct symtab_and_line sal_end = { 0 };
851 struct symtab_and_line cursal = { 0 };
860 /* Pull in the current default source line if necessary. */
861 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
863 set_default_source_symtab_and_line ();
864 cursal = get_current_source_symtab_and_line ();
867 /* "l" or "l +" lists next ten lines. */
869 if (arg == 0 || strcmp (arg, "+") == 0)
871 print_source_lines (cursal.symtab, cursal.line,
872 cursal.line + get_lines_to_list (), 0);
876 /* "l -" lists previous ten lines, the ones before the ten just
878 if (strcmp (arg, "-") == 0)
880 print_source_lines (cursal.symtab,
881 max (get_first_line_listed ()
882 - get_lines_to_list (), 1),
883 get_first_line_listed (), 0);
887 /* Now if there is only one argument, decode it in SAL
889 If there are two arguments, decode them in SAL and SAL_END
890 and clear NO_END; however, if one of the arguments is blank,
891 set DUMMY_BEG or DUMMY_END to record that fact. */
893 if (!have_full_symbols () && !have_partial_symbols ())
894 error (_("No symbol table is loaded. Use the \"file\" command."));
901 sals = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE, 0, 0);
908 ambiguous_line_spec (&sals);
917 /* Record whether the BEG arg is all digits. */
919 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
920 linenum_beg = (p == arg1);
922 while (*arg1 == ' ' || *arg1 == '\t')
928 while (*arg1 == ' ' || *arg1 == '\t')
935 sals_end = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE, 0, 0);
937 sals_end = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE,
938 sal.symtab, sal.line);
939 filter_sals (&sals_end);
940 if (sals_end.nelts == 0)
942 if (sals_end.nelts > 1)
944 ambiguous_line_spec (&sals_end);
945 xfree (sals_end.sals);
948 sal_end = sals_end.sals[0];
949 xfree (sals_end.sals);
954 error (_("Junk at end of line specification."));
956 if (!no_end && !dummy_beg && !dummy_end
957 && sal.symtab != sal_end.symtab)
958 error (_("Specified start and end are in different files."));
959 if (dummy_beg && dummy_end)
960 error (_("Two empty args do not say what lines to list."));
962 /* If line was specified by address,
963 first print exactly which line, and which file.
965 In this case, sal.symtab == 0 means address is outside of all
966 known source files, not that user failed to give a filename. */
969 struct gdbarch *gdbarch;
972 error (_("No source file for address %s."),
973 paddress (get_current_arch (), sal.pc));
975 gdbarch = get_objfile_arch (sal.symtab->objfile);
976 sym = find_pc_function (sal.pc);
978 printf_filtered ("%s is in %s (%s:%d).\n",
979 paddress (gdbarch, sal.pc),
980 SYMBOL_PRINT_NAME (sym),
981 symtab_to_filename_for_display (sal.symtab), sal.line);
983 printf_filtered ("%s is at %s:%d.\n",
984 paddress (gdbarch, sal.pc),
985 symtab_to_filename_for_display (sal.symtab), sal.line);
988 /* If line was not specified by just a line number, and it does not
989 imply a symtab, it must be an undebuggable symbol which means no
992 if (!linenum_beg && sal.symtab == 0)
993 error (_("No line number known for %s."), arg);
995 /* If this command is repeated with RET,
996 turn it into the no-arg variant. */
1001 if (dummy_beg && sal_end.symtab == 0)
1002 error (_("No default source file yet. Do \"help list\"."));
1004 print_source_lines (sal_end.symtab,
1005 max (sal_end.line - (get_lines_to_list () - 1), 1),
1006 sal_end.line + 1, 0);
1007 else if (sal.symtab == 0)
1008 error (_("No default source file yet. Do \"help list\"."));
1011 int first_line = sal.line - get_lines_to_list () / 2;
1013 if (first_line < 1) first_line = 1;
1015 print_source_lines (sal.symtab,
1017 first_line + get_lines_to_list (),
1021 print_source_lines (sal.symtab, sal.line,
1023 ? sal.line + get_lines_to_list ()
1024 : sal_end.line + 1),
1028 /* Subroutine of disassemble_command to simplify it.
1029 Perform the disassembly.
1030 NAME is the name of the function if known, or NULL.
1031 [LOW,HIGH) are the range of addresses to disassemble.
1032 MIXED is non-zero to print source with the assembler. */
1035 print_disassembly (struct gdbarch *gdbarch, const char *name,
1036 CORE_ADDR low, CORE_ADDR high, int flags)
1039 if (!tui_is_window_visible (DISASSEM_WIN))
1042 printf_filtered ("Dump of assembler code ");
1044 printf_filtered ("for function %s:\n", name);
1046 printf_filtered ("from %s to %s:\n",
1047 paddress (gdbarch, low), paddress (gdbarch, high));
1049 /* Dump the specified range. */
1050 gdb_disassembly (gdbarch, current_uiout, 0, flags, -1, low, high);
1052 printf_filtered ("End of assembler dump.\n");
1053 gdb_flush (gdb_stdout);
1058 tui_show_assembly (gdbarch, low);
1063 /* Subroutine of disassemble_command to simplify it.
1064 Print a disassembly of the current function according to FLAGS. */
1067 disassemble_current_function (int flags)
1069 struct frame_info *frame;
1070 struct gdbarch *gdbarch;
1071 CORE_ADDR low, high, pc;
1074 frame = get_selected_frame (_("No frame selected."));
1075 gdbarch = get_frame_arch (frame);
1076 pc = get_frame_address_in_block (frame);
1077 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1078 error (_("No function contains program counter for selected frame."));
1080 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1083 /* FIXME: cagney/2004-02-07: This should be an observer. */
1084 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1086 low += gdbarch_deprecated_function_start_offset (gdbarch);
1088 print_disassembly (gdbarch, name, low, high, flags);
1091 /* Dump a specified section of assembly code.
1095 - dump the assembly code for the function of the current pc
1096 disassemble [/mr] addr
1097 - dump the assembly code for the function at ADDR
1098 disassemble [/mr] low,high
1099 disassemble [/mr] low,+length
1100 - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1102 A /m modifier will include source code with the assembly.
1103 A /r modifier will include raw instructions in hex with the assembly. */
1106 disassemble_command (char *arg, int from_tty)
1108 struct gdbarch *gdbarch = get_current_arch ();
1109 CORE_ADDR low, high;
1124 error (_("Missing modifier."));
1126 while (*p && ! isspace (*p))
1131 flags |= DISASSEMBLY_SOURCE;
1134 flags |= DISASSEMBLY_RAW_INSN;
1137 error (_("Invalid disassembly modifier."));
1141 p = skip_spaces_const (p);
1146 flags |= DISASSEMBLY_OMIT_FNAME;
1147 disassemble_current_function (flags);
1151 pc = value_as_address (parse_to_comma_and_eval (&p));
1157 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1158 error (_("No function contains specified address."));
1160 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1163 /* FIXME: cagney/2004-02-07: This should be an observer. */
1164 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1166 low += gdbarch_deprecated_function_start_offset (gdbarch);
1167 flags |= DISASSEMBLY_OMIT_FNAME;
1171 /* Two arguments. */
1174 p = skip_spaces_const (p);
1180 high = parse_and_eval_address (p);
1185 print_disassembly (gdbarch, name, low, high, flags);
1189 make_command (char *arg, int from_tty)
1197 p = xmalloc (sizeof ("make ") + strlen (arg));
1198 strcpy (p, "make ");
1199 strcpy (p + sizeof ("make ") - 1, arg);
1202 shell_escape (p, from_tty);
1206 show_user (char *args, int from_tty)
1208 struct cmd_list_element *c;
1209 extern struct cmd_list_element *cmdlist;
1213 const char *comname = args;
1215 c = lookup_cmd (&comname, cmdlist, "", 0, 1);
1216 /* c->user_commands would be NULL if it's a python command. */
1217 if (c->class != class_user || !c->user_commands)
1218 error (_("Not a user command."));
1219 show_user_1 (c, "", args, gdb_stdout);
1223 for (c = cmdlist; c; c = c->next)
1225 if (c->class == class_user || c->prefixlist != NULL)
1226 show_user_1 (c, "", c->name, gdb_stdout);
1231 /* Search through names of commands and documentations for a certain
1232 regular expression. */
1235 apropos_command (char *searchstr, int from_tty)
1240 if (searchstr == NULL)
1241 error (_("REGEXP string is empty"));
1243 code = regcomp (&pattern, searchstr, REG_ICASE);
1246 struct cleanup *cleanups;
1248 cleanups = make_regfree_cleanup (&pattern);
1249 apropos_cmd (gdb_stdout, cmdlist, &pattern, "");
1250 do_cleanups (cleanups);
1254 char *err = get_regcomp_error (code, &pattern);
1256 make_cleanup (xfree, err);
1257 error (_("Error in regular expression: %s"), err);
1261 /* Subroutine of alias_command to simplify it.
1262 Return the first N elements of ARGV flattened back to a string
1263 with a space separating each element.
1264 ARGV may not be NULL.
1265 This does not take care of quoting elements in case they contain spaces
1269 argv_to_dyn_string (char **argv, int n)
1272 dyn_string_t result = dyn_string_new (10);
1274 gdb_assert (argv != NULL);
1275 gdb_assert (n >= 0 && n <= countargv (argv));
1277 for (i = 0; i < n; ++i)
1280 dyn_string_append_char (result, ' ');
1281 dyn_string_append_cstr (result, argv[i]);
1287 /* Subroutine of alias_command to simplify it.
1288 Return TRUE if COMMAND exists, unambiguously. Otherwise FALSE. */
1291 valid_command_p (const char *command)
1293 struct cmd_list_element *c;
1295 c = lookup_cmd_1 (& command, cmdlist, NULL, 1);
1297 if (c == NULL || c == (struct cmd_list_element *) -1)
1300 /* This is the slightly tricky part.
1301 lookup_cmd_1 will return a pointer to the last part of COMMAND
1302 to match, leaving COMMAND pointing at the remainder. */
1303 while (*command == ' ' || *command == '\t')
1305 return *command == '\0';
1308 /* Make an alias of an existing command. */
1311 alias_command (char *args, int from_tty)
1313 int i, alias_argc, command_argc;
1314 int abbrev_flag = 0;
1315 char *args2, *equals, *alias, *command;
1316 char **alias_argv, **command_argv;
1317 dyn_string_t alias_dyn_string, command_dyn_string;
1318 struct cleanup *cleanup;
1319 static const char usage[] = N_("Usage: alias [-a] [--] ALIAS = COMMAND");
1321 if (args == NULL || strchr (args, '=') == NULL)
1324 args2 = xstrdup (args);
1325 cleanup = make_cleanup (xfree, args2);
1326 equals = strchr (args2, '=');
1328 alias_argv = gdb_buildargv (args2);
1329 make_cleanup_freeargv (alias_argv);
1330 command_argv = gdb_buildargv (equals + 1);
1331 make_cleanup_freeargv (command_argv);
1333 for (i = 0; alias_argv[i] != NULL; )
1335 if (strcmp (alias_argv[i], "-a") == 0)
1340 else if (strcmp (alias_argv[i], "--") == 0)
1349 if (alias_argv[0] == NULL || command_argv[0] == NULL
1350 || *alias_argv[0] == '\0' || *command_argv[0] == '\0')
1353 for (i = 0; alias_argv[i] != NULL; ++i)
1355 if (! valid_user_defined_cmd_name_p (alias_argv[i]))
1358 error (_("Invalid command name: %s"), alias_argv[i]);
1360 error (_("Invalid command element name: %s"), alias_argv[i]);
1364 alias_argc = countargv (alias_argv);
1365 command_argc = countargv (command_argv);
1367 /* COMMAND must exist.
1368 Reconstruct the command to remove any extraneous spaces,
1369 for better error messages. */
1370 command_dyn_string = argv_to_dyn_string (command_argv, command_argc);
1371 make_cleanup_dyn_string_delete (command_dyn_string);
1372 command = dyn_string_buf (command_dyn_string);
1373 if (! valid_command_p (command))
1374 error (_("Invalid command to alias to: %s"), command);
1376 /* ALIAS must not exist. */
1377 alias_dyn_string = argv_to_dyn_string (alias_argv, alias_argc);
1378 make_cleanup_dyn_string_delete (alias_dyn_string);
1379 alias = dyn_string_buf (alias_dyn_string);
1380 if (valid_command_p (alias))
1381 error (_("Alias already exists: %s"), alias);
1383 /* If ALIAS is one word, it is an alias for the entire COMMAND.
1384 Example: alias spe = set print elements
1386 Otherwise ALIAS and COMMAND must have the same number of words,
1387 and every word except the last must match; and the last word of
1388 ALIAS is made an alias of the last word of COMMAND.
1389 Example: alias set print elms = set pr elem
1390 Note that unambiguous abbreviations are allowed. */
1392 if (alias_argc == 1)
1394 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
1395 add_com_alias (xstrdup (alias_argv[0]), command, class_alias,
1400 dyn_string_t alias_prefix_dyn_string, command_prefix_dyn_string;
1401 const char *alias_prefix, *command_prefix;
1402 struct cmd_list_element *c_alias, *c_command;
1404 if (alias_argc != command_argc)
1405 error (_("Mismatched command length between ALIAS and COMMAND."));
1407 /* Create copies of ALIAS and COMMAND without the last word,
1408 and use that to verify the leading elements match. */
1409 alias_prefix_dyn_string =
1410 argv_to_dyn_string (alias_argv, alias_argc - 1);
1411 make_cleanup_dyn_string_delete (alias_prefix_dyn_string);
1412 command_prefix_dyn_string =
1413 argv_to_dyn_string (alias_argv, command_argc - 1);
1414 make_cleanup_dyn_string_delete (command_prefix_dyn_string);
1415 alias_prefix = dyn_string_buf (alias_prefix_dyn_string);
1416 command_prefix = dyn_string_buf (command_prefix_dyn_string);
1418 c_command = lookup_cmd_1 (& command_prefix, cmdlist, NULL, 1);
1419 /* We've already tried to look up COMMAND. */
1420 gdb_assert (c_command != NULL
1421 && c_command != (struct cmd_list_element *) -1);
1422 gdb_assert (c_command->prefixlist != NULL);
1423 c_alias = lookup_cmd_1 (& alias_prefix, cmdlist, NULL, 1);
1424 if (c_alias != c_command)
1425 error (_("ALIAS and COMMAND prefixes do not match."));
1427 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
1428 add_alias_cmd (xstrdup (alias_argv[alias_argc - 1]),
1429 command_argv[command_argc - 1],
1430 class_alias, abbrev_flag, c_command->prefixlist);
1433 do_cleanups (cleanup);
1436 /* Print a list of files and line numbers which a user may choose from
1437 in order to list a function which was specified ambiguously (as
1438 with `list classname::overloadedfuncname', for example). The
1439 vector in SALS provides the filenames and line numbers. */
1442 ambiguous_line_spec (struct symtabs_and_lines *sals)
1446 for (i = 0; i < sals->nelts; ++i)
1447 printf_filtered (_("file: \"%s\", line number: %d\n"),
1448 symtab_to_filename_for_display (sals->sals[i].symtab),
1449 sals->sals[i].line);
1452 /* Sort function for filter_sals. */
1455 compare_symtabs (const void *a, const void *b)
1457 const struct symtab_and_line *sala = a;
1458 const struct symtab_and_line *salb = b;
1461 if (!sala->symtab->dirname)
1463 if (salb->symtab->dirname)
1466 else if (!salb->symtab->dirname)
1468 if (sala->symtab->dirname)
1473 r = filename_cmp (sala->symtab->dirname, salb->symtab->dirname);
1478 r = filename_cmp (sala->symtab->filename, salb->symtab->filename);
1482 if (sala->line < salb->line)
1484 return sala->line == salb->line ? 0 : 1;
1487 /* Remove any SALs that do not match the current program space, or
1488 which appear to be "file:line" duplicates. */
1491 filter_sals (struct symtabs_and_lines *sals)
1496 for (i = 0; i < sals->nelts; ++i)
1498 if (sals->sals[i].pspace == current_program_space
1499 && sals->sals[i].symtab != NULL)
1501 sals->sals[out] = sals->sals[i];
1507 qsort (sals->sals, sals->nelts, sizeof (struct symtab_and_line),
1512 for (i = 1; i < sals->nelts; ++i)
1514 if (compare_symtabs (&sals->sals[prev], &sals->sals[i]))
1516 /* Symtabs differ. */
1517 sals->sals[out] = sals->sals[i];
1523 if (sals->nelts == 0)
1533 set_debug (char *arg, int from_tty)
1535 printf_unfiltered (_("\"set debug\" must be followed by "
1536 "the name of a debug subcommand.\n"));
1537 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1541 show_debug (char *args, int from_tty)
1543 cmd_show_list (showdebuglist, from_tty, "");
1547 init_cmd_lists (void)
1549 max_user_call_depth = 1024;
1553 show_info_verbose (struct ui_file *file, int from_tty,
1554 struct cmd_list_element *c,
1558 fprintf_filtered (file,
1559 _("Verbose printing of informational messages is %s.\n"),
1562 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1566 show_history_expansion_p (struct ui_file *file, int from_tty,
1567 struct cmd_list_element *c, const char *value)
1569 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1574 show_remote_debug (struct ui_file *file, int from_tty,
1575 struct cmd_list_element *c, const char *value)
1577 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1582 show_remote_timeout (struct ui_file *file, int from_tty,
1583 struct cmd_list_element *c, const char *value)
1585 fprintf_filtered (file,
1586 _("Timeout limit to wait for target to respond is %s.\n"),
1591 show_max_user_call_depth (struct ui_file *file, int from_tty,
1592 struct cmd_list_element *c, const char *value)
1594 fprintf_filtered (file,
1595 _("The max call depth for user-defined commands is %s.\n"),
1601 initialize_file_ftype _initialize_cli_cmds;
1604 _initialize_cli_cmds (void)
1606 struct cmd_list_element *c;
1608 /* Define the classes of commands.
1609 They will appear in the help list in alphabetical order. */
1611 add_cmd ("internals", class_maintenance, NULL, _("\
1612 Maintenance commands.\n\
1613 Some gdb commands are provided just for use by gdb maintainers.\n\
1614 These commands are subject to frequent change, and may not be as\n\
1615 well documented as user commands."),
1617 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1618 add_cmd ("aliases", class_alias, NULL,
1619 _("Aliases of other commands."), &cmdlist);
1620 add_cmd ("user-defined", class_user, NULL, _("\
1621 User-defined commands.\n\
1622 The commands in this class are those defined by the user.\n\
1623 Use the \"define\" command to define a command."), &cmdlist);
1624 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1626 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1627 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1629 add_cmd ("breakpoints", class_breakpoint, NULL,
1630 _("Making program stop at certain points."), &cmdlist);
1631 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1632 add_cmd ("stack", class_stack, NULL, _("\
1633 Examining the stack.\n\
1634 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1635 counting from zero for the innermost (currently executing) frame.\n\n\
1636 At any time gdb identifies one frame as the \"selected\" frame.\n\
1637 Variable lookups are done with respect to the selected frame.\n\
1638 When the program being debugged stops, gdb selects the innermost frame.\n\
1639 The commands below can be used to select other frames by number or address."),
1641 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1643 /* Define general commands. */
1645 add_com ("pwd", class_files, pwd_command, _("\
1646 Print working directory. This is used for your program as well."));
1648 c = add_cmd ("cd", class_files, cd_command, _("\
1649 Set working directory to DIR for debugger and program being debugged.\n\
1650 The change does not take effect for the program being debugged\n\
1651 until the next time it is started."), &cmdlist);
1652 set_cmd_completer (c, filename_completer);
1654 add_com ("echo", class_support, echo_command, _("\
1655 Print a constant string. Give string as argument.\n\
1656 C escape sequences may be used in the argument.\n\
1657 No newline is added at the end of the argument;\n\
1658 use \"\\n\" if you want a newline to be printed.\n\
1659 Since leading and trailing whitespace are ignored in command arguments,\n\
1660 if you want to print some you must use \"\\\" before leading whitespace\n\
1661 to be printed or after trailing whitespace."));
1663 add_setshow_enum_cmd ("script-extension", class_support,
1664 script_ext_enums, &script_ext_mode, _("\
1665 Set mode for script filename extension recognition."), _("\
1666 Show mode for script filename extension recognition."), _("\
1667 off == no filename extension recognition (all sourced files are GDB scripts)\n\
1668 soft == evaluate script according to filename extension, fallback to GDB script"
1670 strict == evaluate script according to filename extension, error if not supported"
1673 show_script_ext_mode,
1674 &setlist, &showlist);
1676 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1677 c = add_com ("help", class_support, help_command,
1678 _("Print list of commands."));
1679 set_cmd_completer (c, command_completer);
1680 add_com_alias ("q", "quit", class_support, 1);
1681 add_com_alias ("h", "help", class_support, 1);
1683 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1684 Set verbosity."), _("\
1685 Show verbosity."), NULL,
1688 &setlist, &showlist);
1690 add_prefix_cmd ("history", class_support, set_history,
1691 _("Generic command for setting command history parameters."),
1692 &sethistlist, "set history ", 0, &setlist);
1693 add_prefix_cmd ("history", class_support, show_history,
1694 _("Generic command for showing command history parameters."),
1695 &showhistlist, "show history ", 0, &showlist);
1697 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1698 Set history expansion on command input."), _("\
1699 Show history expansion on command input."), _("\
1700 Without an argument, history expansion is enabled."),
1702 show_history_expansion_p,
1703 &sethistlist, &showhistlist);
1705 add_prefix_cmd ("info", class_info, info_command, _("\
1706 Generic command for showing things about the program being debugged."),
1707 &infolist, "info ", 0, &cmdlist);
1708 add_com_alias ("i", "info", class_info, 1);
1709 add_com_alias ("inf", "info", class_info, 1);
1711 add_com ("complete", class_obscure, complete_command,
1712 _("List the completions for the rest of the line as a command."));
1714 add_prefix_cmd ("show", class_info, show_command, _("\
1715 Generic command for showing things about the debugger."),
1716 &showlist, "show ", 0, &cmdlist);
1717 /* Another way to get at the same thing. */
1718 add_info ("set", show_command, _("Show all GDB settings."));
1720 add_cmd ("commands", no_set_class, show_commands, _("\
1721 Show the history of commands you typed.\n\
1722 You can supply a command number to start with, or a `+' to start after\n\
1723 the previous command number shown."),
1726 add_cmd ("version", no_set_class, show_version,
1727 _("Show what version of GDB this is."), &showlist);
1729 add_cmd ("configuration", no_set_class, show_configuration,
1730 _("Show how GDB was configured at build time."), &showlist);
1732 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1733 Set debugging of remote protocol."), _("\
1734 Show debugging of remote protocol."), _("\
1735 When enabled, each packet sent or received with the remote target\n\
1739 &setdebuglist, &showdebuglist);
1741 add_setshow_zuinteger_unlimited_cmd ("remotetimeout", no_class,
1742 &remote_timeout, _("\
1743 Set timeout limit to wait for target to respond."), _("\
1744 Show timeout limit to wait for target to respond."), _("\
1745 This value is used to set the time limit for gdb to wait for a response\n\
1748 show_remote_timeout,
1749 &setlist, &showlist);
1751 add_prefix_cmd ("debug", no_class, set_debug,
1752 _("Generic command for setting gdb debugging flags"),
1753 &setdebuglist, "set debug ", 0, &setlist);
1755 add_prefix_cmd ("debug", no_class, show_debug,
1756 _("Generic command for showing gdb debugging flags"),
1757 &showdebuglist, "show debug ", 0, &showlist);
1759 c = add_com ("shell", class_support, shell_escape, _("\
1760 Execute the rest of the line as a shell command.\n\
1761 With no arguments, run an inferior shell."));
1762 set_cmd_completer (c, filename_completer);
1764 c = add_com ("edit", class_files, edit_command, _("\
1765 Edit specified file or function.\n\
1766 With no argument, edits file containing most recent line listed.\n\
1767 Editing targets can be specified in these ways:\n\
1768 FILE:LINENUM, to edit at that line in that file,\n\
1769 FUNCTION, to edit at the beginning of that function,\n\
1770 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1771 *ADDRESS, to edit at the line containing that address.\n\
1772 Uses EDITOR environment variable contents as editor (or ex as default)."));
1774 c->completer = location_completer;
1776 add_com ("list", class_files, list_command, _("\
1777 List specified function or line.\n\
1778 With no argument, lists ten more lines after or around previous listing.\n\
1779 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1780 One argument specifies a line, and ten lines are listed around that line.\n\
1781 Two arguments with comma between specify starting and ending lines to list.\n\
1782 Lines can be specified in these ways:\n\
1783 LINENUM, to list around that line in current file,\n\
1784 FILE:LINENUM, to list around that line in that file,\n\
1785 FUNCTION, to list around beginning of that function,\n\
1786 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1787 *ADDRESS, to list around the line containing that address.\n\
1788 With two args if one is empty it stands for ten lines away from \
1792 add_com_alias ("l", "list", class_files, 1);
1794 add_com_alias ("v", "list", class_files, 1);
1797 add_com_alias ("file", "list", class_files, 1);
1799 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1800 Disassemble a specified section of memory.\n\
1801 Default is the function surrounding the pc of the selected frame.\n\
1802 With a /m modifier, source lines are included (if available).\n\
1803 With a /r modifier, raw instructions in hex are included.\n\
1804 With a single argument, the function surrounding that address is dumped.\n\
1805 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
1806 in the form of \"start,end\", or \"start,+length\".\n\
1808 Note that the address is interpreted as an expression, not as a location\n\
1809 like in the \"break\" command.\n\
1810 So, for example, if you want to disassemble function bar in file foo.c\n\
1811 you must type \"disassemble 'foo.c'::bar\" and not \"disassemble foo.c:bar\"."));
1812 set_cmd_completer (c, location_completer);
1814 add_com_alias ("va", "disassemble", class_xdb, 0);
1816 add_com_alias ("!", "shell", class_support, 0);
1818 c = add_com ("make", class_support, make_command, _("\
1819 Run the ``make'' program using the rest of the line as arguments."));
1820 set_cmd_completer (c, filename_completer);
1821 add_cmd ("user", no_class, show_user, _("\
1822 Show definitions of non-python user defined commands.\n\
1823 Argument is the name of the user defined command.\n\
1824 With no argument, show definitions of all user defined commands."), &showlist);
1825 add_com ("apropos", class_support, apropos_command,
1826 _("Search for commands matching a REGEXP"));
1828 add_setshow_uinteger_cmd ("max-user-call-depth", no_class,
1829 &max_user_call_depth, _("\
1830 Set the max call depth for non-python user-defined commands."), _("\
1831 Show the max call depth for non-python user-defined commands."), NULL,
1833 show_max_user_call_depth,
1834 &setlist, &showlist);
1836 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1837 Set tracing of GDB CLI commands."), _("\
1838 Show state of GDB CLI command tracing."), _("\
1839 When 'on', each command is displayed as it is executed."),
1842 &setlist, &showlist);
1844 c = add_com ("alias", class_support, alias_command, _("\
1845 Define a new command that is an alias of an existing command.\n\
1846 Usage: alias [-a] [--] ALIAS = COMMAND\n\
1847 ALIAS is the name of the alias command to create.\n\
1848 COMMAND is the command being aliased to.\n\
1849 If \"-a\" is specified, the command is an abbreviation,\n\
1850 and will not appear in help command list output.\n\
1853 Make \"spe\" an alias of \"set print elements\":\n\
1854 alias spe = set print elements\n\
1855 Make \"elms\" an alias of \"elements\" in the \"set print\" command:\n\
1856 alias -a set print elms = set print elements"));
1860 init_cli_cmds (void)
1862 struct cmd_list_element *c;
1863 char *source_help_text;
1865 source_help_text = xstrprintf (_("\
1866 Read commands from a file named FILE.\n\
1868 Usage: source [-s] [-v] FILE\n\
1869 -s: search for the script in the source search path,\n\
1870 even if FILE contains directories.\n\
1871 -v: each command in FILE is echoed as it is executed.\n\
1873 Note that the file \"%s\" is read automatically in this way\n\
1874 when GDB is started."), gdbinit);
1875 c = add_cmd ("source", class_support, source_command,
1876 source_help_text, &cmdlist);
1877 set_cmd_completer (c, filename_completer);